EAP-SIM DB: Add debug print for AKA reauth identity addition
[mech_eap.git] / src / eap_server / eap_sim_db.c
1 /*
2  * hostapd / EAP-SIM database/authenticator gateway
3  * Copyright (c) 2005-2010, 2012, Jouni Malinen <j@w1.fi>
4  *
5  * This software may be distributed under the terms of the BSD license.
6  * See README for more details.
7  *
8  * This is an example implementation of the EAP-SIM/AKA database/authentication
9  * gateway interface that is using an external program as an SS7 gateway to
10  * GSM/UMTS authentication center (HLR/AuC). hlr_auc_gw is an example
11  * implementation of such a gateway program. This eap_sim_db.c takes care of
12  * EAP-SIM/AKA pseudonyms and re-auth identities. It can be used with different
13  * gateway implementations for HLR/AuC access. Alternatively, it can also be
14  * completely replaced if the in-memory database of pseudonyms/re-auth
15  * identities is not suitable for some cases.
16  */
17
18 #include "includes.h"
19 #include <sys/un.h>
20 #ifdef CONFIG_SQLITE
21 #include <sqlite3.h>
22 #endif /* CONFIG_SQLITE */
23
24 #include "common.h"
25 #include "crypto/random.h"
26 #include "eap_common/eap_sim_common.h"
27 #include "eap_server/eap_sim_db.h"
28 #include "eloop.h"
29
30 struct eap_sim_pseudonym {
31         struct eap_sim_pseudonym *next;
32         char *permanent; /* permanent username */
33         char *pseudonym; /* pseudonym username */
34 };
35
36 struct eap_sim_db_pending {
37         struct eap_sim_db_pending *next;
38         char imsi[20];
39         enum { PENDING, SUCCESS, FAILURE } state;
40         void *cb_session_ctx;
41         struct os_time timestamp;
42         int aka;
43         union {
44                 struct {
45                         u8 kc[EAP_SIM_MAX_CHAL][EAP_SIM_KC_LEN];
46                         u8 sres[EAP_SIM_MAX_CHAL][EAP_SIM_SRES_LEN];
47                         u8 rand[EAP_SIM_MAX_CHAL][GSM_RAND_LEN];
48                         int num_chal;
49                 } sim;
50                 struct {
51                         u8 rand[EAP_AKA_RAND_LEN];
52                         u8 autn[EAP_AKA_AUTN_LEN];
53                         u8 ik[EAP_AKA_IK_LEN];
54                         u8 ck[EAP_AKA_CK_LEN];
55                         u8 res[EAP_AKA_RES_MAX_LEN];
56                         size_t res_len;
57                 } aka;
58         } u;
59 };
60
61 struct eap_sim_db_data {
62         int sock;
63         char *fname;
64         char *local_sock;
65         void (*get_complete_cb)(void *ctx, void *session_ctx);
66         void *ctx;
67         struct eap_sim_pseudonym *pseudonyms;
68         struct eap_sim_reauth *reauths;
69         struct eap_sim_db_pending *pending;
70 #ifdef CONFIG_SQLITE
71         sqlite3 *sqlite_db;
72         char db_tmp_identity[100];
73         char db_tmp_pseudonym_str[100];
74         struct eap_sim_pseudonym db_tmp_pseudonym;
75         struct eap_sim_reauth db_tmp_reauth;
76 #endif /* CONFIG_SQLITE */
77 };
78
79
80 #ifdef CONFIG_SQLITE
81
82 static int db_table_exists(sqlite3 *db, const char *name)
83 {
84         char cmd[128];
85         os_snprintf(cmd, sizeof(cmd), "SELECT 1 FROM %s;", name);
86         return sqlite3_exec(db, cmd, NULL, NULL, NULL) == SQLITE_OK;
87 }
88
89
90 static int db_table_create_pseudonym(sqlite3 *db)
91 {
92         char *err = NULL;
93         const char *sql =
94                 "CREATE TABLE pseudonyms("
95                 "  permanent CHAR(21) PRIMARY KEY,"
96                 "  pseudonym CHAR(21) NOT NULL"
97                 ");";
98
99         wpa_printf(MSG_DEBUG, "EAP-SIM DB: Adding database table for "
100                    "pseudonym information");
101         if (sqlite3_exec(db, sql, NULL, NULL, &err) != SQLITE_OK) {
102                 wpa_printf(MSG_ERROR, "EAP-SIM DB: SQLite error: %s", err);
103                 sqlite3_free(err);
104                 return -1;
105         }
106
107         return 0;
108 }
109
110
111 static int db_table_create_reauth(sqlite3 *db)
112 {
113         char *err = NULL;
114         const char *sql =
115                 "CREATE TABLE reauth("
116                 "  permanent CHAR(21) PRIMARY KEY,"
117                 "  reauth_id CHAR(21) NOT NULL,"
118                 "  counter INTEGER,"
119                 "  mk CHAR(40),"
120                 "  k_encr CHAR(32),"
121                 "  k_aut CHAR(64),"
122                 "  k_re CHAR(64)"
123                 ");";
124
125         wpa_printf(MSG_DEBUG, "EAP-SIM DB: Adding database table for "
126                    "reauth information");
127         if (sqlite3_exec(db, sql, NULL, NULL, &err) != SQLITE_OK) {
128                 wpa_printf(MSG_ERROR, "EAP-SIM DB: SQLite error: %s", err);
129                 sqlite3_free(err);
130                 return -1;
131         }
132
133         return 0;
134 }
135
136
137 static sqlite3 * db_open(const char *db_file)
138 {
139         sqlite3 *db;
140
141         if (sqlite3_open(db_file, &db)) {
142                 wpa_printf(MSG_ERROR, "EAP-SIM DB: Failed to open database "
143                            "%s: %s", db_file, sqlite3_errmsg(db));
144                 sqlite3_close(db);
145                 return NULL;
146         }
147
148         if (!db_table_exists(db, "pseudonyms") &&
149             db_table_create_pseudonym(db) < 0) {
150                 sqlite3_close(db);
151                 return NULL;
152         }
153
154         if (!db_table_exists(db, "reauth") &&
155             db_table_create_reauth(db) < 0) {
156                 sqlite3_close(db);
157                 return NULL;
158         }
159
160         return db;
161 }
162
163
164 static int valid_db_string(const char *str)
165 {
166         const char *pos = str;
167         while (*pos) {
168                 if ((*pos < '0' || *pos > '9') &&
169                     (*pos < 'a' || *pos > 'f'))
170                         return 0;
171                 pos++;
172         }
173         return 1;
174 }
175
176
177 static int db_add_pseudonym(struct eap_sim_db_data *data,
178                             const char *permanent, char *pseudonym)
179 {
180         char cmd[128];
181         char *err = NULL;
182
183         if (!valid_db_string(permanent) || !valid_db_string(pseudonym)) {
184                 os_free(pseudonym);
185                 return -1;
186         }
187
188         os_snprintf(cmd, sizeof(cmd), "INSERT OR REPLACE INTO pseudonyms "
189                     "(permanent, pseudonym) VALUES ('%s', '%s');",
190                     permanent, pseudonym);
191         os_free(pseudonym);
192         if (sqlite3_exec(data->sqlite_db, cmd, NULL, NULL, &err) != SQLITE_OK)
193         {
194                 wpa_printf(MSG_ERROR, "EAP-SIM DB: SQLite error: %s", err);
195                 sqlite3_free(err);
196                 return -1;
197         }
198
199         return 0;
200 }
201
202
203 static int get_pseudonym_cb(void *ctx, int argc, char *argv[], char *col[])
204 {
205         struct eap_sim_db_data *data = ctx;
206         int i;
207
208         for (i = 0; i < argc; i++) {
209                 if (os_strcmp(col[i], "permanent") == 0 && argv[i]) {
210                         os_strlcpy(data->db_tmp_identity, argv[i],
211                                    sizeof(data->db_tmp_identity));
212                 }
213         }
214
215         return 0;
216 }
217
218
219 static char *
220 db_get_pseudonym(struct eap_sim_db_data *data, const char *pseudonym)
221 {
222         char cmd[128];
223
224         if (!valid_db_string(pseudonym))
225                 return NULL;
226         os_memset(&data->db_tmp_identity, 0, sizeof(data->db_tmp_identity));
227         os_snprintf(cmd, sizeof(cmd),
228                     "SELECT permanent FROM pseudonyms WHERE pseudonym='%s';",
229                     pseudonym);
230         if (sqlite3_exec(data->sqlite_db, cmd, get_pseudonym_cb, data, NULL) !=
231             SQLITE_OK)
232                 return NULL;
233         if (data->db_tmp_identity[0] == '\0')
234                 return NULL;
235         return data->db_tmp_identity;
236 }
237
238
239 static int db_add_reauth(struct eap_sim_db_data *data, const char *permanent,
240                          char *reauth_id, u16 counter, const u8 *mk,
241                          const u8 *k_encr, const u8 *k_aut, const u8 *k_re)
242 {
243         char cmd[2000], *pos, *end;
244         char *err = NULL;
245
246         if (!valid_db_string(permanent) || !valid_db_string(reauth_id)) {
247                 os_free(reauth_id);
248                 return -1;
249         }
250
251         pos = cmd;
252         end = pos + sizeof(cmd);
253         pos += os_snprintf(pos, end - pos, "INSERT OR REPLACE INTO reauth "
254                            "(permanent, reauth_id, counter%s%s%s%s) "
255                            "VALUES ('%s', '%s', %u",
256                            mk ? ", mk" : "",
257                            k_encr ? ", k_encr" : "",
258                            k_aut ? ", k_aut" : "",
259                            k_re ? ", k_re" : "",
260                            permanent, reauth_id, counter);
261         os_free(reauth_id);
262
263         if (mk) {
264                 pos += os_snprintf(pos, end - pos, ", '");
265                 pos += wpa_snprintf_hex(pos, end - pos, mk, EAP_SIM_MK_LEN);
266                 pos += os_snprintf(pos, end - pos, "'");
267         }
268
269         if (k_encr) {
270                 pos += os_snprintf(pos, end - pos, ", '");
271                 pos += wpa_snprintf_hex(pos, end - pos, k_encr,
272                                         EAP_SIM_K_ENCR_LEN);
273                 pos += os_snprintf(pos, end - pos, "'");
274         }
275
276         if (k_aut) {
277                 pos += os_snprintf(pos, end - pos, ", '");
278                 pos += wpa_snprintf_hex(pos, end - pos, k_aut,
279                                         EAP_AKA_PRIME_K_AUT_LEN);
280                 pos += os_snprintf(pos, end - pos, "'");
281         }
282
283         if (k_re) {
284                 pos += os_snprintf(pos, end - pos, ", '");
285                 pos += wpa_snprintf_hex(pos, end - pos, k_re,
286                                         EAP_AKA_PRIME_K_RE_LEN);
287                 pos += os_snprintf(pos, end - pos, "'");
288         }
289
290         os_snprintf(pos, end - pos, ");");
291
292         if (sqlite3_exec(data->sqlite_db, cmd, NULL, NULL, &err) != SQLITE_OK)
293         {
294                 wpa_printf(MSG_ERROR, "EAP-SIM DB: SQLite error: %s", err);
295                 sqlite3_free(err);
296                 return -1;
297         }
298
299         return 0;
300 }
301
302
303 static int get_reauth_cb(void *ctx, int argc, char *argv[], char *col[])
304 {
305         struct eap_sim_db_data *data = ctx;
306         int i;
307         struct eap_sim_reauth *reauth = &data->db_tmp_reauth;
308
309         for (i = 0; i < argc; i++) {
310                 if (os_strcmp(col[i], "permanent") == 0 && argv[i]) {
311                         os_strlcpy(data->db_tmp_identity, argv[i],
312                                    sizeof(data->db_tmp_identity));
313                         reauth->permanent = data->db_tmp_identity;
314                 } else if (os_strcmp(col[i], "counter") == 0 && argv[i]) {
315                         reauth->counter = atoi(argv[i]);
316                 } else if (os_strcmp(col[i], "mk") == 0 && argv[i]) {
317                         hexstr2bin(argv[i], reauth->mk, sizeof(reauth->mk));
318                 } else if (os_strcmp(col[i], "k_encr") == 0 && argv[i]) {
319                         hexstr2bin(argv[i], reauth->k_encr,
320                                    sizeof(reauth->k_encr));
321                 } else if (os_strcmp(col[i], "k_aut") == 0 && argv[i]) {
322                         hexstr2bin(argv[i], reauth->k_aut,
323                                    sizeof(reauth->k_aut));
324                 } else if (os_strcmp(col[i], "k_re") == 0 && argv[i]) {
325                         hexstr2bin(argv[i], reauth->k_re,
326                                    sizeof(reauth->k_re));
327                 }
328         }
329
330         return 0;
331 }
332
333
334 static struct eap_sim_reauth *
335 db_get_reauth(struct eap_sim_db_data *data, const char *reauth_id)
336 {
337         char cmd[256];
338
339         if (!valid_db_string(reauth_id))
340                 return NULL;
341         os_memset(&data->db_tmp_reauth, 0, sizeof(data->db_tmp_reauth));
342         os_strlcpy(data->db_tmp_pseudonym_str, reauth_id,
343                    sizeof(data->db_tmp_pseudonym_str));
344         data->db_tmp_reauth.reauth_id = data->db_tmp_pseudonym_str;
345         os_snprintf(cmd, sizeof(cmd),
346                     "SELECT * FROM reauth WHERE reauth_id='%s';", reauth_id);
347         if (sqlite3_exec(data->sqlite_db, cmd, get_reauth_cb, data, NULL) !=
348             SQLITE_OK)
349                 return NULL;
350         if (data->db_tmp_reauth.permanent == NULL)
351                 return NULL;
352         return &data->db_tmp_reauth;
353 }
354
355
356 static void db_remove_reauth(struct eap_sim_db_data *data,
357                              struct eap_sim_reauth *reauth)
358 {
359         char cmd[256];
360
361         if (!valid_db_string(reauth->permanent))
362                 return;
363         os_snprintf(cmd, sizeof(cmd),
364                     "DELETE FROM reauth WHERE permanent='%s';",
365                     reauth->permanent);
366         sqlite3_exec(data->sqlite_db, cmd, NULL, NULL, NULL);
367 }
368
369 #endif /* CONFIG_SQLITE */
370
371
372 static struct eap_sim_db_pending *
373 eap_sim_db_get_pending(struct eap_sim_db_data *data, const char *imsi, int aka)
374 {
375         struct eap_sim_db_pending *entry, *prev = NULL;
376
377         entry = data->pending;
378         while (entry) {
379                 if (entry->aka == aka && os_strcmp(entry->imsi, imsi) == 0) {
380                         if (prev)
381                                 prev->next = entry->next;
382                         else
383                                 data->pending = entry->next;
384                         break;
385                 }
386                 prev = entry;
387                 entry = entry->next;
388         }
389         return entry;
390 }
391
392
393 static void eap_sim_db_add_pending(struct eap_sim_db_data *data,
394                                    struct eap_sim_db_pending *entry)
395 {
396         entry->next = data->pending;
397         data->pending = entry;
398 }
399
400
401 static void eap_sim_db_sim_resp_auth(struct eap_sim_db_data *data,
402                                      const char *imsi, char *buf)
403 {
404         char *start, *end, *pos;
405         struct eap_sim_db_pending *entry;
406         int num_chal;
407
408         /*
409          * SIM-RESP-AUTH <IMSI> Kc(i):SRES(i):RAND(i) ...
410          * SIM-RESP-AUTH <IMSI> FAILURE
411          * (IMSI = ASCII string, Kc/SRES/RAND = hex string)
412          */
413
414         entry = eap_sim_db_get_pending(data, imsi, 0);
415         if (entry == NULL) {
416                 wpa_printf(MSG_DEBUG, "EAP-SIM DB: No pending entry for the "
417                            "received message found");
418                 return;
419         }
420
421         start = buf;
422         if (os_strncmp(start, "FAILURE", 7) == 0) {
423                 wpa_printf(MSG_DEBUG, "EAP-SIM DB: External server reported "
424                            "failure");
425                 entry->state = FAILURE;
426                 eap_sim_db_add_pending(data, entry);
427                 data->get_complete_cb(data->ctx, entry->cb_session_ctx);
428                 return;
429         }
430
431         num_chal = 0;
432         while (num_chal < EAP_SIM_MAX_CHAL) {
433                 end = os_strchr(start, ' ');
434                 if (end)
435                         *end = '\0';
436
437                 pos = os_strchr(start, ':');
438                 if (pos == NULL)
439                         goto parse_fail;
440                 *pos = '\0';
441                 if (hexstr2bin(start, entry->u.sim.kc[num_chal],
442                                EAP_SIM_KC_LEN))
443                         goto parse_fail;
444
445                 start = pos + 1;
446                 pos = os_strchr(start, ':');
447                 if (pos == NULL)
448                         goto parse_fail;
449                 *pos = '\0';
450                 if (hexstr2bin(start, entry->u.sim.sres[num_chal],
451                                EAP_SIM_SRES_LEN))
452                         goto parse_fail;
453
454                 start = pos + 1;
455                 if (hexstr2bin(start, entry->u.sim.rand[num_chal],
456                                GSM_RAND_LEN))
457                         goto parse_fail;
458
459                 num_chal++;
460                 if (end == NULL)
461                         break;
462                 else
463                         start = end + 1;
464         }
465         entry->u.sim.num_chal = num_chal;
466
467         entry->state = SUCCESS;
468         wpa_printf(MSG_DEBUG, "EAP-SIM DB: Authentication data parsed "
469                    "successfully - callback");
470         eap_sim_db_add_pending(data, entry);
471         data->get_complete_cb(data->ctx, entry->cb_session_ctx);
472         return;
473
474 parse_fail:
475         wpa_printf(MSG_DEBUG, "EAP-SIM DB: Failed to parse response string");
476         os_free(entry);
477 }
478
479
480 static void eap_sim_db_aka_resp_auth(struct eap_sim_db_data *data,
481                                      const char *imsi, char *buf)
482 {
483         char *start, *end;
484         struct eap_sim_db_pending *entry;
485
486         /*
487          * AKA-RESP-AUTH <IMSI> <RAND> <AUTN> <IK> <CK> <RES>
488          * AKA-RESP-AUTH <IMSI> FAILURE
489          * (IMSI = ASCII string, RAND/AUTN/IK/CK/RES = hex string)
490          */
491
492         entry = eap_sim_db_get_pending(data, imsi, 1);
493         if (entry == NULL) {
494                 wpa_printf(MSG_DEBUG, "EAP-SIM DB: No pending entry for the "
495                            "received message found");
496                 return;
497         }
498
499         start = buf;
500         if (os_strncmp(start, "FAILURE", 7) == 0) {
501                 wpa_printf(MSG_DEBUG, "EAP-SIM DB: External server reported "
502                            "failure");
503                 entry->state = FAILURE;
504                 eap_sim_db_add_pending(data, entry);
505                 data->get_complete_cb(data->ctx, entry->cb_session_ctx);
506                 return;
507         }
508
509         end = os_strchr(start, ' ');
510         if (end == NULL)
511                 goto parse_fail;
512         *end = '\0';
513         if (hexstr2bin(start, entry->u.aka.rand, EAP_AKA_RAND_LEN))
514                 goto parse_fail;
515
516         start = end + 1;
517         end = os_strchr(start, ' ');
518         if (end == NULL)
519                 goto parse_fail;
520         *end = '\0';
521         if (hexstr2bin(start, entry->u.aka.autn, EAP_AKA_AUTN_LEN))
522                 goto parse_fail;
523
524         start = end + 1;
525         end = os_strchr(start, ' ');
526         if (end == NULL)
527                 goto parse_fail;
528         *end = '\0';
529         if (hexstr2bin(start, entry->u.aka.ik, EAP_AKA_IK_LEN))
530                 goto parse_fail;
531
532         start = end + 1;
533         end = os_strchr(start, ' ');
534         if (end == NULL)
535                 goto parse_fail;
536         *end = '\0';
537         if (hexstr2bin(start, entry->u.aka.ck, EAP_AKA_CK_LEN))
538                 goto parse_fail;
539
540         start = end + 1;
541         end = os_strchr(start, ' ');
542         if (end)
543                 *end = '\0';
544         else {
545                 end = start;
546                 while (*end)
547                         end++;
548         }
549         entry->u.aka.res_len = (end - start) / 2;
550         if (entry->u.aka.res_len > EAP_AKA_RES_MAX_LEN) {
551                 wpa_printf(MSG_DEBUG, "EAP-SIM DB: Too long RES");
552                 entry->u.aka.res_len = 0;
553                 goto parse_fail;
554         }
555         if (hexstr2bin(start, entry->u.aka.res, entry->u.aka.res_len))
556                 goto parse_fail;
557
558         entry->state = SUCCESS;
559         wpa_printf(MSG_DEBUG, "EAP-SIM DB: Authentication data parsed "
560                    "successfully - callback");
561         eap_sim_db_add_pending(data, entry);
562         data->get_complete_cb(data->ctx, entry->cb_session_ctx);
563         return;
564
565 parse_fail:
566         wpa_printf(MSG_DEBUG, "EAP-SIM DB: Failed to parse response string");
567         os_free(entry);
568 }
569
570
571 static void eap_sim_db_receive(int sock, void *eloop_ctx, void *sock_ctx)
572 {
573         struct eap_sim_db_data *data = eloop_ctx;
574         char buf[1000], *pos, *cmd, *imsi;
575         int res;
576
577         res = recv(sock, buf, sizeof(buf), 0);
578         if (res < 0)
579                 return;
580         wpa_hexdump_ascii_key(MSG_MSGDUMP, "EAP-SIM DB: Received from an "
581                               "external source", (u8 *) buf, res);
582         if (res == 0)
583                 return;
584         if (res >= (int) sizeof(buf))
585                 res = sizeof(buf) - 1;
586         buf[res] = '\0';
587
588         if (data->get_complete_cb == NULL) {
589                 wpa_printf(MSG_DEBUG, "EAP-SIM DB: No get_complete_cb "
590                            "registered");
591                 return;
592         }
593
594         /* <cmd> <IMSI> ... */
595
596         cmd = buf;
597         pos = os_strchr(cmd, ' ');
598         if (pos == NULL)
599                 goto parse_fail;
600         *pos = '\0';
601         imsi = pos + 1;
602         pos = os_strchr(imsi, ' ');
603         if (pos == NULL)
604                 goto parse_fail;
605         *pos = '\0';
606         wpa_printf(MSG_DEBUG, "EAP-SIM DB: External response=%s for IMSI %s",
607                    cmd, imsi);
608
609         if (os_strcmp(cmd, "SIM-RESP-AUTH") == 0)
610                 eap_sim_db_sim_resp_auth(data, imsi, pos + 1);
611         else if (os_strcmp(cmd, "AKA-RESP-AUTH") == 0)
612                 eap_sim_db_aka_resp_auth(data, imsi, pos + 1);
613         else
614                 wpa_printf(MSG_INFO, "EAP-SIM DB: Unknown external response "
615                            "'%s'", cmd);
616         return;
617
618 parse_fail:
619         wpa_printf(MSG_DEBUG, "EAP-SIM DB: Failed to parse response string");
620 }
621
622
623 static int eap_sim_db_open_socket(struct eap_sim_db_data *data)
624 {
625         struct sockaddr_un addr;
626         static int counter = 0;
627
628         if (os_strncmp(data->fname, "unix:", 5) != 0)
629                 return -1;
630
631         data->sock = socket(PF_UNIX, SOCK_DGRAM, 0);
632         if (data->sock < 0) {
633                 perror("socket(eap_sim_db)");
634                 return -1;
635         }
636
637         os_memset(&addr, 0, sizeof(addr));
638         addr.sun_family = AF_UNIX;
639         os_snprintf(addr.sun_path, sizeof(addr.sun_path),
640                     "/tmp/eap_sim_db_%d-%d", getpid(), counter++);
641         os_free(data->local_sock);
642         data->local_sock = os_strdup(addr.sun_path);
643         if (bind(data->sock, (struct sockaddr *) &addr, sizeof(addr)) < 0) {
644                 perror("bind(eap_sim_db)");
645                 close(data->sock);
646                 data->sock = -1;
647                 return -1;
648         }
649
650         os_memset(&addr, 0, sizeof(addr));
651         addr.sun_family = AF_UNIX;
652         os_strlcpy(addr.sun_path, data->fname + 5, sizeof(addr.sun_path));
653         if (connect(data->sock, (struct sockaddr *) &addr, sizeof(addr)) < 0) {
654                 perror("connect(eap_sim_db)");
655                 wpa_hexdump_ascii(MSG_INFO, "HLR/AuC GW socket",
656                                   (u8 *) addr.sun_path,
657                                   os_strlen(addr.sun_path));
658                 close(data->sock);
659                 data->sock = -1;
660                 return -1;
661         }
662
663         eloop_register_read_sock(data->sock, eap_sim_db_receive, data, NULL);
664
665         return 0;
666 }
667
668
669 static void eap_sim_db_close_socket(struct eap_sim_db_data *data)
670 {
671         if (data->sock >= 0) {
672                 eloop_unregister_read_sock(data->sock);
673                 close(data->sock);
674                 data->sock = -1;
675         }
676         if (data->local_sock) {
677                 unlink(data->local_sock);
678                 os_free(data->local_sock);
679                 data->local_sock = NULL;
680         }
681 }
682
683
684 /**
685  * eap_sim_db_init - Initialize EAP-SIM DB / authentication gateway interface
686  * @config: Configuration data (e.g., file name)
687  * @get_complete_cb: Callback function for reporting availability of triplets
688  * @ctx: Context pointer for get_complete_cb
689  * Returns: Pointer to a private data structure or %NULL on failure
690  */
691 void * eap_sim_db_init(const char *config,
692                        void (*get_complete_cb)(void *ctx, void *session_ctx),
693                        void *ctx)
694 {
695         struct eap_sim_db_data *data;
696         char *pos;
697
698         data = os_zalloc(sizeof(*data));
699         if (data == NULL)
700                 return NULL;
701
702         data->sock = -1;
703         data->get_complete_cb = get_complete_cb;
704         data->ctx = ctx;
705         data->fname = os_strdup(config);
706         if (data->fname == NULL)
707                 goto fail;
708         pos = os_strstr(data->fname, " db=");
709         if (pos) {
710                 *pos = '\0';
711 #ifdef CONFIG_SQLITE
712                 pos += 4;
713                 data->sqlite_db = db_open(pos);
714                 if (data->sqlite_db == NULL)
715                         goto fail;
716 #endif /* CONFIG_SQLITE */
717         }
718
719         if (os_strncmp(data->fname, "unix:", 5) == 0) {
720                 if (eap_sim_db_open_socket(data)) {
721                         wpa_printf(MSG_DEBUG, "EAP-SIM DB: External database "
722                                    "connection not available - will retry "
723                                    "later");
724                 }
725         }
726
727         return data;
728
729 fail:
730         eap_sim_db_close_socket(data);
731         os_free(data->fname);
732         os_free(data);
733         return NULL;
734 }
735
736
737 static void eap_sim_db_free_pseudonym(struct eap_sim_pseudonym *p)
738 {
739         os_free(p->permanent);
740         os_free(p->pseudonym);
741         os_free(p);
742 }
743
744
745 static void eap_sim_db_free_reauth(struct eap_sim_reauth *r)
746 {
747         os_free(r->permanent);
748         os_free(r->reauth_id);
749         os_free(r);
750 }
751
752
753 /**
754  * eap_sim_db_deinit - Deinitialize EAP-SIM DB/authentication gw interface
755  * @priv: Private data pointer from eap_sim_db_init()
756  */
757 void eap_sim_db_deinit(void *priv)
758 {
759         struct eap_sim_db_data *data = priv;
760         struct eap_sim_pseudonym *p, *prev;
761         struct eap_sim_reauth *r, *prevr;
762         struct eap_sim_db_pending *pending, *prev_pending;
763
764 #ifdef CONFIG_SQLITE
765         if (data->sqlite_db) {
766                 sqlite3_close(data->sqlite_db);
767                 data->sqlite_db = NULL;
768         }
769 #endif /* CONFIG_SQLITE */
770
771         eap_sim_db_close_socket(data);
772         os_free(data->fname);
773
774         p = data->pseudonyms;
775         while (p) {
776                 prev = p;
777                 p = p->next;
778                 eap_sim_db_free_pseudonym(prev);
779         }
780
781         r = data->reauths;
782         while (r) {
783                 prevr = r;
784                 r = r->next;
785                 eap_sim_db_free_reauth(prevr);
786         }
787
788         pending = data->pending;
789         while (pending) {
790                 prev_pending = pending;
791                 pending = pending->next;
792                 os_free(prev_pending);
793         }
794
795         os_free(data);
796 }
797
798
799 static int eap_sim_db_send(struct eap_sim_db_data *data, const char *msg,
800                            size_t len)
801 {
802         int _errno = 0;
803
804         if (send(data->sock, msg, len, 0) < 0) {
805                 _errno = errno;
806                 perror("send[EAP-SIM DB UNIX]");
807         }
808
809         if (_errno == ENOTCONN || _errno == EDESTADDRREQ || _errno == EINVAL ||
810             _errno == ECONNREFUSED) {
811                 /* Try to reconnect */
812                 eap_sim_db_close_socket(data);
813                 if (eap_sim_db_open_socket(data) < 0)
814                         return -1;
815                 wpa_printf(MSG_DEBUG, "EAP-SIM DB: Reconnected to the "
816                            "external server");
817                 if (send(data->sock, msg, len, 0) < 0) {
818                         perror("send[EAP-SIM DB UNIX]");
819                         return -1;
820                 }
821         }
822
823         return 0;
824 }
825
826
827 static void eap_sim_db_expire_pending(struct eap_sim_db_data *data)
828 {
829         /* TODO: add limit for maximum length for pending list; remove latest
830          * (i.e., last) entry from the list if the limit is reached; could also
831          * use timeout to expire pending entries */
832 }
833
834
835 /**
836  * eap_sim_db_get_gsm_triplets - Get GSM triplets
837  * @priv: Private data pointer from eap_sim_db_init()
838  * @username: Permanent username (prefix | IMSI)
839  * @max_chal: Maximum number of triplets
840  * @_rand: Buffer for RAND values
841  * @kc: Buffer for Kc values
842  * @sres: Buffer for SRES values
843  * @cb_session_ctx: Session callback context for get_complete_cb()
844  * Returns: Number of triplets received (has to be less than or equal to
845  * max_chal), -1 (EAP_SIM_DB_FAILURE) on error (e.g., user not found), or
846  * -2 (EAP_SIM_DB_PENDING) if results are not yet available. In this case, the
847  * callback function registered with eap_sim_db_init() will be called once the
848  * results become available.
849  *
850  * When using an external server for GSM triplets, this function can always
851  * start a request and return EAP_SIM_DB_PENDING immediately if authentication
852  * triplets are not available. Once the triplets are received, callback
853  * function registered with eap_sim_db_init() is called to notify EAP state
854  * machine to reprocess the message. This eap_sim_db_get_gsm_triplets()
855  * function will then be called again and the newly received triplets will then
856  * be given to the caller.
857  */
858 int eap_sim_db_get_gsm_triplets(void *priv, const char *username, int max_chal,
859                                 u8 *_rand, u8 *kc, u8 *sres,
860                                 void *cb_session_ctx)
861 {
862         struct eap_sim_db_data *data = priv;
863         struct eap_sim_db_pending *entry;
864         int len, ret;
865         char msg[40];
866         const char *imsi;
867         size_t imsi_len;
868
869         if (username == NULL || username[0] != EAP_SIM_PERMANENT_PREFIX ||
870             username[1] == '\0' || os_strlen(username) > sizeof(entry->imsi)) {
871                 wpa_printf(MSG_DEBUG, "EAP-SIM DB: unexpected username '%s'",
872                            username);
873                 return EAP_SIM_DB_FAILURE;
874         }
875         imsi = username + 1;
876         wpa_printf(MSG_DEBUG, "EAP-SIM DB: Get GSM triplets for IMSI '%s'",
877                    imsi);
878
879         entry = eap_sim_db_get_pending(data, imsi, 0);
880         if (entry) {
881                 int num_chal;
882                 if (entry->state == FAILURE) {
883                         wpa_printf(MSG_DEBUG, "EAP-SIM DB: Pending entry -> "
884                                    "failure");
885                         os_free(entry);
886                         return EAP_SIM_DB_FAILURE;
887                 }
888
889                 if (entry->state == PENDING) {
890                         wpa_printf(MSG_DEBUG, "EAP-SIM DB: Pending entry -> "
891                                    "still pending");
892                         eap_sim_db_add_pending(data, entry);
893                         return EAP_SIM_DB_PENDING;
894                 }
895
896                 wpa_printf(MSG_DEBUG, "EAP-SIM DB: Pending entry -> "
897                            "%d challenges", entry->u.sim.num_chal);
898                 num_chal = entry->u.sim.num_chal;
899                 if (num_chal > max_chal)
900                         num_chal = max_chal;
901                 os_memcpy(_rand, entry->u.sim.rand, num_chal * GSM_RAND_LEN);
902                 os_memcpy(sres, entry->u.sim.sres,
903                           num_chal * EAP_SIM_SRES_LEN);
904                 os_memcpy(kc, entry->u.sim.kc, num_chal * EAP_SIM_KC_LEN);
905                 os_free(entry);
906                 return num_chal;
907         }
908
909         if (data->sock < 0) {
910                 if (eap_sim_db_open_socket(data) < 0)
911                         return EAP_SIM_DB_FAILURE;
912         }
913
914         imsi_len = os_strlen(imsi);
915         len = os_snprintf(msg, sizeof(msg), "SIM-REQ-AUTH ");
916         if (len < 0 || len + imsi_len >= sizeof(msg))
917                 return EAP_SIM_DB_FAILURE;
918         os_memcpy(msg + len, imsi, imsi_len);
919         len += imsi_len;
920         ret = os_snprintf(msg + len, sizeof(msg) - len, " %d", max_chal);
921         if (ret < 0 || (size_t) ret >= sizeof(msg) - len)
922                 return EAP_SIM_DB_FAILURE;
923         len += ret;
924
925         wpa_printf(MSG_DEBUG, "EAP-SIM DB: requesting SIM authentication "
926                    "data for IMSI '%s'", imsi);
927         if (eap_sim_db_send(data, msg, len) < 0)
928                 return EAP_SIM_DB_FAILURE;
929
930         entry = os_zalloc(sizeof(*entry));
931         if (entry == NULL)
932                 return EAP_SIM_DB_FAILURE;
933
934         os_get_time(&entry->timestamp);
935         os_strlcpy(entry->imsi, imsi, sizeof(entry->imsi));
936         entry->cb_session_ctx = cb_session_ctx;
937         entry->state = PENDING;
938         eap_sim_db_add_pending(data, entry);
939         eap_sim_db_expire_pending(data);
940
941         return EAP_SIM_DB_PENDING;
942 }
943
944
945 static char * eap_sim_db_get_next(struct eap_sim_db_data *data, char prefix)
946 {
947         char *id, *pos, *end;
948         u8 buf[10];
949
950         if (random_get_bytes(buf, sizeof(buf)))
951                 return NULL;
952         id = os_malloc(sizeof(buf) * 2 + 2);
953         if (id == NULL)
954                 return NULL;
955
956         pos = id;
957         end = id + sizeof(buf) * 2 + 2;
958         *pos++ = prefix;
959         pos += wpa_snprintf_hex(pos, end - pos, buf, sizeof(buf));
960         
961         return id;
962 }
963
964
965 /**
966  * eap_sim_db_get_next_pseudonym - EAP-SIM DB: Get next pseudonym
967  * @priv: Private data pointer from eap_sim_db_init()
968  * @method: EAP method (SIM/AKA/AKA')
969  * Returns: Next pseudonym (allocated string) or %NULL on failure
970  *
971  * This function is used to generate a pseudonym for EAP-SIM. The returned
972  * pseudonym is not added to database at this point; it will need to be added
973  * with eap_sim_db_add_pseudonym() once the authentication has been completed
974  * successfully. Caller is responsible for freeing the returned buffer.
975  */
976 char * eap_sim_db_get_next_pseudonym(void *priv, enum eap_sim_db_method method)
977 {
978         struct eap_sim_db_data *data = priv;
979         char prefix = EAP_SIM_REAUTH_ID_PREFIX;
980
981         switch (method) {
982         case EAP_SIM_DB_SIM:
983                 prefix = EAP_SIM_PSEUDONYM_PREFIX;
984                 break;
985         case EAP_SIM_DB_AKA:
986                 prefix = EAP_AKA_PSEUDONYM_PREFIX;
987                 break;
988         case EAP_SIM_DB_AKA_PRIME:
989                 prefix = EAP_AKA_PRIME_PSEUDONYM_PREFIX;
990                 break;
991         }
992
993         return eap_sim_db_get_next(data, prefix);
994 }
995
996
997 /**
998  * eap_sim_db_get_next_reauth_id - EAP-SIM DB: Get next reauth_id
999  * @priv: Private data pointer from eap_sim_db_init()
1000  * @method: EAP method (SIM/AKA/AKA')
1001  * Returns: Next reauth_id (allocated string) or %NULL on failure
1002  *
1003  * This function is used to generate a fast re-authentication identity for
1004  * EAP-SIM. The returned reauth_id is not added to database at this point; it
1005  * will need to be added with eap_sim_db_add_reauth() once the authentication
1006  * has been completed successfully. Caller is responsible for freeing the
1007  * returned buffer.
1008  */
1009 char * eap_sim_db_get_next_reauth_id(void *priv, enum eap_sim_db_method method)
1010 {
1011         struct eap_sim_db_data *data = priv;
1012         char prefix = EAP_SIM_REAUTH_ID_PREFIX;
1013
1014         switch (method) {
1015         case EAP_SIM_DB_SIM:
1016                 prefix = EAP_SIM_REAUTH_ID_PREFIX;
1017                 break;
1018         case EAP_SIM_DB_AKA:
1019                 prefix = EAP_AKA_REAUTH_ID_PREFIX;
1020                 break;
1021         case EAP_SIM_DB_AKA_PRIME:
1022                 prefix = EAP_AKA_PRIME_REAUTH_ID_PREFIX;
1023                 break;
1024         }
1025
1026         return eap_sim_db_get_next(data, prefix);
1027 }
1028
1029
1030 /**
1031  * eap_sim_db_add_pseudonym - EAP-SIM DB: Add new pseudonym
1032  * @priv: Private data pointer from eap_sim_db_init()
1033  * @permanent: Permanent username
1034  * @pseudonym: Pseudonym for this user. This needs to be an allocated buffer,
1035  * e.g., return value from eap_sim_db_get_next_pseudonym(). Caller must not
1036  * free it.
1037  * Returns: 0 on success, -1 on failure
1038  *
1039  * This function adds a new pseudonym for EAP-SIM user. EAP-SIM DB is
1040  * responsible of freeing pseudonym buffer once it is not needed anymore.
1041  */
1042 int eap_sim_db_add_pseudonym(void *priv, const char *permanent,
1043                              char *pseudonym)
1044 {
1045         struct eap_sim_db_data *data = priv;
1046         struct eap_sim_pseudonym *p;
1047         wpa_printf(MSG_DEBUG, "EAP-SIM DB: Add pseudonym '%s' for permanent "
1048                    "username '%s'", pseudonym, permanent);
1049
1050         /* TODO: could store last two pseudonyms */
1051 #ifdef CONFIG_SQLITE
1052         if (data->sqlite_db)
1053                 return db_add_pseudonym(data, permanent, pseudonym);
1054 #endif /* CONFIG_SQLITE */
1055         for (p = data->pseudonyms; p; p = p->next) {
1056                 if (os_strcmp(permanent, p->permanent) == 0)
1057                         break;
1058         }
1059         if (p) {
1060                 wpa_printf(MSG_DEBUG, "EAP-SIM DB: Replacing previous "
1061                            "pseudonym: %s", p->pseudonym);
1062                 os_free(p->pseudonym);
1063                 p->pseudonym = pseudonym;
1064                 return 0;
1065         }
1066
1067         p = os_zalloc(sizeof(*p));
1068         if (p == NULL) {
1069                 os_free(pseudonym);
1070                 return -1;
1071         }
1072
1073         p->next = data->pseudonyms;
1074         p->permanent = os_strdup(permanent);
1075         if (p->permanent == NULL) {
1076                 os_free(p);
1077                 os_free(pseudonym);
1078                 return -1;
1079         }
1080         p->pseudonym = pseudonym;
1081         data->pseudonyms = p;
1082
1083         wpa_printf(MSG_DEBUG, "EAP-SIM DB: Added new pseudonym entry");
1084         return 0;
1085 }
1086
1087
1088 static struct eap_sim_reauth *
1089 eap_sim_db_add_reauth_data(struct eap_sim_db_data *data,
1090                            const char *permanent,
1091                            char *reauth_id, u16 counter)
1092 {
1093         struct eap_sim_reauth *r;
1094
1095         for (r = data->reauths; r; r = r->next) {
1096                 if (os_strcmp(r->permanent, permanent) == 0)
1097                         break;
1098         }
1099
1100         if (r) {
1101                 wpa_printf(MSG_DEBUG, "EAP-SIM DB: Replacing previous "
1102                            "reauth_id: %s", r->reauth_id);
1103                 os_free(r->reauth_id);
1104                 r->reauth_id = reauth_id;
1105         } else {
1106                 r = os_zalloc(sizeof(*r));
1107                 if (r == NULL) {
1108                         os_free(reauth_id);
1109                         return NULL;
1110                 }
1111
1112                 r->next = data->reauths;
1113                 r->permanent = os_strdup(permanent);
1114                 if (r->permanent == NULL) {
1115                         os_free(r);
1116                         os_free(reauth_id);
1117                         return NULL;
1118                 }
1119                 r->reauth_id = reauth_id;
1120                 data->reauths = r;
1121                 wpa_printf(MSG_DEBUG, "EAP-SIM DB: Added new reauth entry");
1122         }
1123
1124         r->counter = counter;
1125
1126         return r;
1127 }
1128
1129
1130 /**
1131  * eap_sim_db_add_reauth - EAP-SIM DB: Add new re-authentication entry
1132  * @priv: Private data pointer from eap_sim_db_init()
1133  * @permanent: Permanent username
1134  * @identity_len: Length of identity
1135  * @reauth_id: reauth_id for this user. This needs to be an allocated buffer,
1136  * e.g., return value from eap_sim_db_get_next_reauth_id(). Caller must not
1137  * free it.
1138  * @counter: AT_COUNTER value for fast re-authentication
1139  * @mk: 16-byte MK from the previous full authentication or %NULL
1140  * Returns: 0 on success, -1 on failure
1141  *
1142  * This function adds a new re-authentication entry for an EAP-SIM user.
1143  * EAP-SIM DB is responsible of freeing reauth_id buffer once it is not needed
1144  * anymore.
1145  */
1146 int eap_sim_db_add_reauth(void *priv, const char *permanent, char *reauth_id,
1147                           u16 counter, const u8 *mk)
1148 {
1149         struct eap_sim_db_data *data = priv;
1150         struct eap_sim_reauth *r;
1151
1152         wpa_printf(MSG_DEBUG, "EAP-SIM DB: Add reauth_id '%s' for permanent "
1153                    "identity '%s'", reauth_id, permanent);
1154
1155 #ifdef CONFIG_SQLITE
1156         if (data->sqlite_db)
1157                 return db_add_reauth(data, permanent, reauth_id, counter, mk,
1158                                      NULL, NULL, NULL);
1159 #endif /* CONFIG_SQLITE */
1160         r = eap_sim_db_add_reauth_data(data, permanent, reauth_id, counter);
1161         if (r == NULL)
1162                 return -1;
1163
1164         os_memcpy(r->mk, mk, EAP_SIM_MK_LEN);
1165
1166         return 0;
1167 }
1168
1169
1170 #ifdef EAP_SERVER_AKA_PRIME
1171 /**
1172  * eap_sim_db_add_reauth_prime - EAP-AKA' DB: Add new re-authentication entry
1173  * @priv: Private data pointer from eap_sim_db_init()
1174  * @permanent: Permanent username
1175  * @reauth_id: reauth_id for this user. This needs to be an allocated buffer,
1176  * e.g., return value from eap_sim_db_get_next_reauth_id(). Caller must not
1177  * free it.
1178  * @counter: AT_COUNTER value for fast re-authentication
1179  * @k_encr: K_encr from the previous full authentication
1180  * @k_aut: K_aut from the previous full authentication
1181  * @k_re: 32-byte K_re from the previous full authentication
1182  * Returns: 0 on success, -1 on failure
1183  *
1184  * This function adds a new re-authentication entry for an EAP-AKA' user.
1185  * EAP-SIM DB is responsible of freeing reauth_id buffer once it is not needed
1186  * anymore.
1187  */
1188 int eap_sim_db_add_reauth_prime(void *priv, const char *permanent,
1189                                 char *reauth_id, u16 counter, const u8 *k_encr,
1190                                 const u8 *k_aut, const u8 *k_re)
1191 {
1192         struct eap_sim_db_data *data = priv;
1193         struct eap_sim_reauth *r;
1194
1195         wpa_printf(MSG_DEBUG, "EAP-SIM DB: Add reauth_id '%s' for permanent "
1196                    "identity '%s'", reauth_id, permanent);
1197
1198 #ifdef CONFIG_SQLITE
1199         if (data->sqlite_db)
1200                 return db_add_reauth(data, permanent, reauth_id, counter, NULL,
1201                                      k_encr, k_aut, k_re);
1202 #endif /* CONFIG_SQLITE */
1203         r = eap_sim_db_add_reauth_data(data, permanent, reauth_id, counter);
1204         if (r == NULL)
1205                 return -1;
1206
1207         os_memcpy(r->k_encr, k_encr, EAP_SIM_K_ENCR_LEN);
1208         os_memcpy(r->k_aut, k_aut, EAP_AKA_PRIME_K_AUT_LEN);
1209         os_memcpy(r->k_re, k_re, EAP_AKA_PRIME_K_RE_LEN);
1210
1211         return 0;
1212 }
1213 #endif /* EAP_SERVER_AKA_PRIME */
1214
1215
1216 /**
1217  * eap_sim_db_get_permanent - EAP-SIM DB: Get permanent identity
1218  * @priv: Private data pointer from eap_sim_db_init()
1219  * @pseudonym: Pseudonym username
1220  * Returns: Pointer to permanent username or %NULL if not found
1221  */
1222 const char * eap_sim_db_get_permanent(void *priv, const char *pseudonym)
1223 {
1224         struct eap_sim_db_data *data = priv;
1225         struct eap_sim_pseudonym *p;
1226
1227         if (pseudonym[0] != EAP_SIM_PSEUDONYM_PREFIX &&
1228             pseudonym[0] != EAP_AKA_PSEUDONYM_PREFIX &&
1229             pseudonym[0] != EAP_AKA_PRIME_PSEUDONYM_PREFIX)
1230                 return NULL;
1231
1232 #ifdef CONFIG_SQLITE
1233         if (data->sqlite_db)
1234                 return db_get_pseudonym(data, pseudonym);
1235 #endif /* CONFIG_SQLITE */
1236
1237         p = data->pseudonyms;
1238         while (p) {
1239                 if (os_strcmp(p->pseudonym, pseudonym) == 0)
1240                         return p->permanent;
1241                 p = p->next;
1242         }
1243
1244         return NULL;
1245 }
1246
1247
1248 /**
1249  * eap_sim_db_get_reauth_entry - EAP-SIM DB: Get re-authentication entry
1250  * @priv: Private data pointer from eap_sim_db_init()
1251  * @reauth_id: Fast re-authentication username
1252  * Returns: Pointer to the re-auth entry, or %NULL if not found
1253  */
1254 struct eap_sim_reauth *
1255 eap_sim_db_get_reauth_entry(void *priv, const char *reauth_id)
1256 {
1257         struct eap_sim_db_data *data = priv;
1258         struct eap_sim_reauth *r;
1259
1260         if (reauth_id[0] != EAP_SIM_REAUTH_ID_PREFIX &&
1261             reauth_id[0] != EAP_AKA_REAUTH_ID_PREFIX &&
1262             reauth_id[0] != EAP_AKA_PRIME_REAUTH_ID_PREFIX)
1263                 return NULL;
1264
1265 #ifdef CONFIG_SQLITE
1266         if (data->sqlite_db)
1267                 return db_get_reauth(data, reauth_id);
1268 #endif /* CONFIG_SQLITE */
1269
1270         r = data->reauths;
1271         while (r) {
1272                 if (os_strcmp(r->reauth_id, reauth_id) == 0)
1273                         break;
1274                 r = r->next;
1275         }
1276
1277         return r;
1278 }
1279
1280
1281 /**
1282  * eap_sim_db_remove_reauth - EAP-SIM DB: Remove re-authentication entry
1283  * @priv: Private data pointer from eap_sim_db_init()
1284  * @reauth: Pointer to re-authentication entry from
1285  * eap_sim_db_get_reauth_entry()
1286  */
1287 void eap_sim_db_remove_reauth(void *priv, struct eap_sim_reauth *reauth)
1288 {
1289         struct eap_sim_db_data *data = priv;
1290         struct eap_sim_reauth *r, *prev = NULL;
1291 #ifdef CONFIG_SQLITE
1292         if (data->sqlite_db) {
1293                 db_remove_reauth(data, reauth);
1294                 return;
1295         }
1296 #endif /* CONFIG_SQLITE */
1297         r = data->reauths;
1298         while (r) {
1299                 if (r == reauth) {
1300                         if (prev)
1301                                 prev->next = r->next;
1302                         else
1303                                 data->reauths = r->next;
1304                         eap_sim_db_free_reauth(r);
1305                         return;
1306                 }
1307                 prev = r;
1308                 r = r->next;
1309         }
1310 }
1311
1312
1313 /**
1314  * eap_sim_db_get_aka_auth - Get AKA authentication values
1315  * @priv: Private data pointer from eap_sim_db_init()
1316  * @username: Permanent username (prefix | IMSI)
1317  * @_rand: Buffer for RAND value
1318  * @autn: Buffer for AUTN value
1319  * @ik: Buffer for IK value
1320  * @ck: Buffer for CK value
1321  * @res: Buffer for RES value
1322  * @res_len: Buffer for RES length
1323  * @cb_session_ctx: Session callback context for get_complete_cb()
1324  * Returns: 0 on success, -1 (EAP_SIM_DB_FAILURE) on error (e.g., user not
1325  * found), or -2 (EAP_SIM_DB_PENDING) if results are not yet available. In this
1326  * case, the callback function registered with eap_sim_db_init() will be
1327  * called once the results become available.
1328  *
1329  * When using an external server for AKA authentication, this function can
1330  * always start a request and return EAP_SIM_DB_PENDING immediately if
1331  * authentication triplets are not available. Once the authentication data are
1332  * received, callback function registered with eap_sim_db_init() is called to
1333  * notify EAP state machine to reprocess the message. This
1334  * eap_sim_db_get_aka_auth() function will then be called again and the newly
1335  * received triplets will then be given to the caller.
1336  */
1337 int eap_sim_db_get_aka_auth(void *priv, const char *username, u8 *_rand,
1338                             u8 *autn, u8 *ik, u8 *ck, u8 *res, size_t *res_len,
1339                             void *cb_session_ctx)
1340 {
1341         struct eap_sim_db_data *data = priv;
1342         struct eap_sim_db_pending *entry;
1343         int len;
1344         char msg[40];
1345         const char *imsi;
1346         size_t imsi_len;
1347
1348         if (username == NULL ||
1349             (username[0] != EAP_AKA_PERMANENT_PREFIX &&
1350              username[0] != EAP_AKA_PRIME_PERMANENT_PREFIX) ||
1351             username[1] == '\0' || os_strlen(username) > sizeof(entry->imsi)) {
1352                 wpa_printf(MSG_DEBUG, "EAP-SIM DB: unexpected username '%s'",
1353                            username);
1354                 return EAP_SIM_DB_FAILURE;
1355         }
1356         imsi = username + 1;
1357         wpa_printf(MSG_DEBUG, "EAP-SIM DB: Get AKA auth for IMSI '%s'",
1358                    imsi);
1359
1360         entry = eap_sim_db_get_pending(data, imsi, 1);
1361         if (entry) {
1362                 if (entry->state == FAILURE) {
1363                         os_free(entry);
1364                         wpa_printf(MSG_DEBUG, "EAP-SIM DB: Failure");
1365                         return EAP_SIM_DB_FAILURE;
1366                 }
1367
1368                 if (entry->state == PENDING) {
1369                         eap_sim_db_add_pending(data, entry);
1370                         wpa_printf(MSG_DEBUG, "EAP-SIM DB: Pending");
1371                         return EAP_SIM_DB_PENDING;
1372                 }
1373
1374                 wpa_printf(MSG_DEBUG, "EAP-SIM DB: Returning successfully "
1375                            "received authentication data");
1376                 os_memcpy(_rand, entry->u.aka.rand, EAP_AKA_RAND_LEN);
1377                 os_memcpy(autn, entry->u.aka.autn, EAP_AKA_AUTN_LEN);
1378                 os_memcpy(ik, entry->u.aka.ik, EAP_AKA_IK_LEN);
1379                 os_memcpy(ck, entry->u.aka.ck, EAP_AKA_CK_LEN);
1380                 os_memcpy(res, entry->u.aka.res, EAP_AKA_RES_MAX_LEN);
1381                 *res_len = entry->u.aka.res_len;
1382                 os_free(entry);
1383                 return 0;
1384         }
1385
1386         if (data->sock < 0) {
1387                 if (eap_sim_db_open_socket(data) < 0)
1388                         return EAP_SIM_DB_FAILURE;
1389         }
1390
1391         imsi_len = os_strlen(imsi);
1392         len = os_snprintf(msg, sizeof(msg), "AKA-REQ-AUTH ");
1393         if (len < 0 || len + imsi_len >= sizeof(msg))
1394                 return EAP_SIM_DB_FAILURE;
1395         os_memcpy(msg + len, imsi, imsi_len);
1396         len += imsi_len;
1397
1398         wpa_printf(MSG_DEBUG, "EAP-SIM DB: requesting AKA authentication "
1399                     "data for IMSI '%s'", imsi);
1400         if (eap_sim_db_send(data, msg, len) < 0)
1401                 return EAP_SIM_DB_FAILURE;
1402
1403         entry = os_zalloc(sizeof(*entry));
1404         if (entry == NULL)
1405                 return EAP_SIM_DB_FAILURE;
1406
1407         os_get_time(&entry->timestamp);
1408         entry->aka = 1;
1409         os_strlcpy(entry->imsi, imsi, sizeof(entry->imsi));
1410         entry->cb_session_ctx = cb_session_ctx;
1411         entry->state = PENDING;
1412         eap_sim_db_add_pending(data, entry);
1413         eap_sim_db_expire_pending(data);
1414
1415         return EAP_SIM_DB_PENDING;
1416 }
1417
1418
1419 /**
1420  * eap_sim_db_resynchronize - Resynchronize AKA AUTN
1421  * @priv: Private data pointer from eap_sim_db_init()
1422  * @username: Permanent username
1423  * @auts: AUTS value from the peer
1424  * @_rand: RAND value used in the rejected message
1425  * Returns: 0 on success, -1 on failure
1426  *
1427  * This function is called when the peer reports synchronization failure in the
1428  * AUTN value by sending AUTS. The AUTS and RAND values should be sent to
1429  * HLR/AuC to allow it to resynchronize with the peer. After this,
1430  * eap_sim_db_get_aka_auth() will be called again to to fetch updated
1431  * RAND/AUTN values for the next challenge.
1432  */
1433 int eap_sim_db_resynchronize(void *priv, const char *username,
1434                              const u8 *auts, const u8 *_rand)
1435 {
1436         struct eap_sim_db_data *data = priv;
1437         const char *imsi;
1438         size_t imsi_len;
1439
1440         if (username == NULL ||
1441             (username[0] != EAP_AKA_PERMANENT_PREFIX &&
1442              username[0] != EAP_AKA_PRIME_PERMANENT_PREFIX) ||
1443             username[1] == '\0' || os_strlen(username) > 20) {
1444                 wpa_printf(MSG_DEBUG, "EAP-SIM DB: unexpected username '%s'",
1445                            username);
1446                 return -1;
1447         }
1448         imsi = username + 1;
1449         wpa_printf(MSG_DEBUG, "EAP-SIM DB: Get AKA auth for IMSI '%s'",
1450                    imsi);
1451
1452         if (data->sock >= 0) {
1453                 char msg[100];
1454                 int len, ret;
1455
1456                 imsi_len = os_strlen(imsi);
1457                 len = os_snprintf(msg, sizeof(msg), "AKA-AUTS ");
1458                 if (len < 0 || len + imsi_len >= sizeof(msg))
1459                         return -1;
1460                 os_memcpy(msg + len, imsi, imsi_len);
1461                 len += imsi_len;
1462
1463                 ret = os_snprintf(msg + len, sizeof(msg) - len, " ");
1464                 if (ret < 0 || (size_t) ret >= sizeof(msg) - len)
1465                         return -1;
1466                 len += ret;
1467                 len += wpa_snprintf_hex(msg + len, sizeof(msg) - len,
1468                                         auts, EAP_AKA_AUTS_LEN);
1469                 ret = os_snprintf(msg + len, sizeof(msg) - len, " ");
1470                 if (ret < 0 || (size_t) ret >= sizeof(msg) - len)
1471                         return -1;
1472                 len += ret;
1473                 len += wpa_snprintf_hex(msg + len, sizeof(msg) - len,
1474                                         _rand, EAP_AKA_RAND_LEN);
1475                 wpa_printf(MSG_DEBUG, "EAP-SIM DB: reporting AKA AUTS for "
1476                            "IMSI '%s'", imsi);
1477                 if (eap_sim_db_send(data, msg, len) < 0)
1478                         return -1;
1479         }
1480
1481         return 0;
1482 }
1483
1484
1485 /**
1486  * sim_get_username - Extract username from SIM identity
1487  * @identity: Identity
1488  * @identity_len: Identity length
1489  * Returns: Allocated buffer with the username part of the identity
1490  *
1491  * Caller is responsible for freeing the returned buffer with os_free().
1492  */
1493 char * sim_get_username(const u8 *identity, size_t identity_len)
1494 {
1495         char *username;
1496         size_t pos;
1497
1498         for (pos = 0; pos < identity_len; pos++) {
1499                 if (identity[pos] == '@' || identity[pos] == '\0')
1500                         break;
1501         }
1502
1503         username = os_malloc(pos + 1);
1504         if (username == NULL)
1505                 return NULL;
1506         os_memcpy(username, identity, pos);
1507         username[pos] = '\0';
1508
1509         return username;
1510 }