2 * EAP peer method: EAP-FAST PAC file processing
3 * Copyright (c) 2004-2006, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
12 #include "eap_config.h"
14 #include "eap_fast_pac.h"
16 /* TODO: encrypt PAC-Key in the PAC file */
19 /* Text data format */
20 static const char *pac_file_hdr =
21 "wpa_supplicant EAP-FAST PAC file - version 1";
25 * 4-octet magic value: 6A E4 92 0C
26 * 2-octet version (big endian)
27 * <version specific data>
30 * Sequence of PAC entries:
31 * 2-octet PAC-Type (big endian)
33 * 2-octet PAC-Opaque length (big endian)
34 * <variable len> PAC-Opaque data (length bytes)
35 * 2-octet PAC-Info length (big endian)
36 * <variable len> PAC-Info data (length bytes)
39 #define EAP_FAST_PAC_BINARY_MAGIC 0x6ae4920c
40 #define EAP_FAST_PAC_BINARY_FORMAT_VERSION 0
44 * eap_fast_free_pac - Free PAC data
45 * @pac: Pointer to the PAC entry
47 * Note that the PAC entry must not be in a list since this function does not
48 * remove the list links.
50 void eap_fast_free_pac(struct eap_fast_pac *pac)
52 os_free(pac->pac_opaque);
53 os_free(pac->pac_info);
56 os_free(pac->a_id_info);
62 * eap_fast_get_pac - Get a PAC entry based on A-ID
63 * @pac_root: Pointer to root of the PAC list
64 * @a_id: A-ID to search for
65 * @a_id_len: Length of A-ID
66 * @pac_type: PAC-Type to search for
67 * Returns: Pointer to the PAC entry, or %NULL if A-ID not found
69 struct eap_fast_pac * eap_fast_get_pac(struct eap_fast_pac *pac_root,
70 const u8 *a_id, size_t a_id_len,
73 struct eap_fast_pac *pac = pac_root;
76 if (pac->pac_type == pac_type && pac->a_id_len == a_id_len &&
77 os_memcmp(pac->a_id, a_id, a_id_len) == 0) {
86 static void eap_fast_remove_pac(struct eap_fast_pac **pac_root,
87 struct eap_fast_pac **pac_current,
88 const u8 *a_id, size_t a_id_len, u16 pac_type)
90 struct eap_fast_pac *pac, *prev;
96 if (pac->pac_type == pac_type && pac->a_id_len == a_id_len &&
97 os_memcmp(pac->a_id, a_id, a_id_len) == 0) {
99 *pac_root = pac->next;
101 prev->next = pac->next;
102 if (*pac_current == pac)
104 eap_fast_free_pac(pac);
113 static int eap_fast_copy_buf(u8 **dst, size_t *dst_len,
114 const u8 *src, size_t src_len)
117 *dst = os_malloc(src_len);
120 os_memcpy(*dst, src, src_len);
128 * eap_fast_add_pac - Add a copy of a PAC entry to a list
129 * @pac_root: Pointer to PAC list root pointer
130 * @pac_current: Pointer to the current PAC pointer
131 * @entry: New entry to clone and add to the list
132 * Returns: 0 on success, -1 on failure
134 * This function makes a clone of the given PAC entry and adds this copied
135 * entry to the list (pac_root). If an old entry for the same A-ID is found,
136 * it will be removed from the PAC list and in this case, pac_current entry
137 * is set to %NULL if it was the removed entry.
139 int eap_fast_add_pac(struct eap_fast_pac **pac_root,
140 struct eap_fast_pac **pac_current,
141 struct eap_fast_pac *entry)
143 struct eap_fast_pac *pac;
145 if (entry == NULL || entry->a_id == NULL)
148 /* Remove a possible old entry for the matching A-ID. */
149 eap_fast_remove_pac(pac_root, pac_current,
150 entry->a_id, entry->a_id_len, entry->pac_type);
152 /* Allocate a new entry and add it to the list of PACs. */
153 pac = os_zalloc(sizeof(*pac));
157 pac->pac_type = entry->pac_type;
158 os_memcpy(pac->pac_key, entry->pac_key, EAP_FAST_PAC_KEY_LEN);
159 if (eap_fast_copy_buf(&pac->pac_opaque, &pac->pac_opaque_len,
160 entry->pac_opaque, entry->pac_opaque_len) < 0 ||
161 eap_fast_copy_buf(&pac->pac_info, &pac->pac_info_len,
162 entry->pac_info, entry->pac_info_len) < 0 ||
163 eap_fast_copy_buf(&pac->a_id, &pac->a_id_len,
164 entry->a_id, entry->a_id_len) < 0 ||
165 eap_fast_copy_buf(&pac->i_id, &pac->i_id_len,
166 entry->i_id, entry->i_id_len) < 0 ||
167 eap_fast_copy_buf(&pac->a_id_info, &pac->a_id_info_len,
168 entry->a_id_info, entry->a_id_info_len) < 0) {
169 eap_fast_free_pac(pac);
173 pac->next = *pac_root;
180 struct eap_fast_read_ctx {
189 static int eap_fast_read_line(struct eap_fast_read_ctx *rc, char **value)
195 if (fgets(rc->buf, rc->buf_len, rc->f) == NULL)
200 if (rc->pos >= rc->end)
203 while (l_end < rc->end && *l_end != '\n')
205 len = l_end - rc->pos;
206 if (len >= rc->buf_len)
207 len = rc->buf_len - 1;
208 os_memcpy(rc->buf, rc->pos, len);
213 rc->buf[rc->buf_len - 1] = '\0';
215 while (*pos != '\0') {
216 if (*pos == '\n' || *pos == '\r') {
223 pos = os_strchr(rc->buf, '=');
232 static u8 * eap_fast_parse_hex(const char *value, size_t *len)
239 hlen = os_strlen(value);
243 buf = os_malloc(*len);
246 if (hexstr2bin(value, buf, *len)) {
254 static int eap_fast_init_pac_data(struct eap_sm *sm, const char *pac_file,
255 struct eap_fast_read_ctx *rc)
257 os_memset(rc, 0, sizeof(*rc));
260 rc->buf = os_malloc(rc->buf_len);
264 if (os_strncmp(pac_file, "blob://", 7) == 0) {
265 const struct wpa_config_blob *blob;
266 blob = eap_get_config_blob(sm, pac_file + 7);
268 wpa_printf(MSG_INFO, "EAP-FAST: No PAC blob '%s' - "
269 "assume no PAC entries have been "
270 "provisioned", pac_file + 7);
274 rc->pos = (char *) blob->data;
275 rc->end = (char *) blob->data + blob->len;
277 rc->f = fopen(pac_file, "rb");
279 wpa_printf(MSG_INFO, "EAP-FAST: No PAC file '%s' - "
280 "assume no PAC entries have been "
281 "provisioned", pac_file);
291 static void eap_fast_deinit_pac_data(struct eap_fast_read_ctx *rc)
299 static const char * eap_fast_parse_start(struct eap_fast_pac **pac)
302 return "START line without END";
304 *pac = os_zalloc(sizeof(struct eap_fast_pac));
306 return "No memory for PAC entry";
307 (*pac)->pac_type = PAC_TYPE_TUNNEL_PAC;
312 static const char * eap_fast_parse_end(struct eap_fast_pac **pac_root,
313 struct eap_fast_pac **pac)
316 return "END line without START";
318 struct eap_fast_pac *end = *pac_root;
330 static const char * eap_fast_parse_pac_type(struct eap_fast_pac *pac,
333 pac->pac_type = atoi(pos);
334 if (pac->pac_type != PAC_TYPE_TUNNEL_PAC &&
335 pac->pac_type != PAC_TYPE_USER_AUTHORIZATION &&
336 pac->pac_type != PAC_TYPE_MACHINE_AUTHENTICATION)
337 return "Unrecognized PAC-Type";
343 static const char * eap_fast_parse_pac_key(struct eap_fast_pac *pac, char *pos)
348 key = eap_fast_parse_hex(pos, &key_len);
349 if (key == NULL || key_len != EAP_FAST_PAC_KEY_LEN) {
351 return "Invalid PAC-Key";
354 os_memcpy(pac->pac_key, key, EAP_FAST_PAC_KEY_LEN);
361 static const char * eap_fast_parse_pac_opaque(struct eap_fast_pac *pac,
364 os_free(pac->pac_opaque);
365 pac->pac_opaque = eap_fast_parse_hex(pos, &pac->pac_opaque_len);
366 if (pac->pac_opaque == NULL)
367 return "Invalid PAC-Opaque";
372 static const char * eap_fast_parse_a_id(struct eap_fast_pac *pac, char *pos)
375 pac->a_id = eap_fast_parse_hex(pos, &pac->a_id_len);
376 if (pac->a_id == NULL)
377 return "Invalid A-ID";
382 static const char * eap_fast_parse_i_id(struct eap_fast_pac *pac, char *pos)
385 pac->i_id = eap_fast_parse_hex(pos, &pac->i_id_len);
386 if (pac->i_id == NULL)
387 return "Invalid I-ID";
392 static const char * eap_fast_parse_a_id_info(struct eap_fast_pac *pac,
395 os_free(pac->a_id_info);
396 pac->a_id_info = eap_fast_parse_hex(pos, &pac->a_id_info_len);
397 if (pac->a_id_info == NULL)
398 return "Invalid A-ID-Info";
404 * eap_fast_load_pac - Load PAC entries (text format)
405 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
406 * @pac_root: Pointer to root of the PAC list (to be filled)
407 * @pac_file: Name of the PAC file/blob to load
408 * Returns: 0 on success, -1 on failure
410 int eap_fast_load_pac(struct eap_sm *sm, struct eap_fast_pac **pac_root,
411 const char *pac_file)
413 struct eap_fast_read_ctx rc;
414 struct eap_fast_pac *pac = NULL;
417 const char *err = NULL;
419 if (pac_file == NULL)
422 if (eap_fast_init_pac_data(sm, pac_file, &rc) < 0)
425 if (eap_fast_read_line(&rc, &pos) < 0) {
426 /* empty file - assume it is fine to overwrite */
427 eap_fast_deinit_pac_data(&rc);
430 if (os_strcmp(pac_file_hdr, rc.buf) != 0)
431 err = "Unrecognized header line";
433 while (!err && eap_fast_read_line(&rc, &pos) == 0) {
434 if (os_strcmp(rc.buf, "START") == 0)
435 err = eap_fast_parse_start(&pac);
436 else if (os_strcmp(rc.buf, "END") == 0) {
437 err = eap_fast_parse_end(pac_root, &pac);
440 err = "Unexpected line outside START/END block";
441 else if (os_strcmp(rc.buf, "PAC-Type") == 0)
442 err = eap_fast_parse_pac_type(pac, pos);
443 else if (os_strcmp(rc.buf, "PAC-Key") == 0)
444 err = eap_fast_parse_pac_key(pac, pos);
445 else if (os_strcmp(rc.buf, "PAC-Opaque") == 0)
446 err = eap_fast_parse_pac_opaque(pac, pos);
447 else if (os_strcmp(rc.buf, "A-ID") == 0)
448 err = eap_fast_parse_a_id(pac, pos);
449 else if (os_strcmp(rc.buf, "I-ID") == 0)
450 err = eap_fast_parse_i_id(pac, pos);
451 else if (os_strcmp(rc.buf, "A-ID-Info") == 0)
452 err = eap_fast_parse_a_id_info(pac, pos);
456 err = "PAC block not terminated with END";
457 eap_fast_free_pac(pac);
460 eap_fast_deinit_pac_data(&rc);
463 wpa_printf(MSG_INFO, "EAP-FAST: %s in '%s:%d'",
464 err, pac_file, rc.line);
468 wpa_printf(MSG_DEBUG, "EAP-FAST: Read %d PAC entries from '%s'",
475 static void eap_fast_write(char **buf, char **pos, size_t *buf_len,
476 const char *field, const u8 *data,
483 if (data == NULL || buf == NULL || *buf == NULL ||
484 pos == NULL || *pos == NULL || *pos < *buf)
487 need = os_strlen(field) + len * 2 + 30;
489 need += os_strlen(field) + len + 20;
491 if (*pos - *buf + need > *buf_len) {
492 char *nbuf = os_realloc(*buf, *buf_len + need);
498 *pos = nbuf + (*pos - *buf);
502 end = *buf + *buf_len;
504 ret = os_snprintf(*pos, end - *pos, "%s=", field);
505 if (ret < 0 || ret >= end - *pos)
508 *pos += wpa_snprintf_hex(*pos, end - *pos, data, len);
509 ret = os_snprintf(*pos, end - *pos, "\n");
510 if (ret < 0 || ret >= end - *pos)
515 ret = os_snprintf(*pos, end - *pos, "%s-txt=", field);
516 if (ret < 0 || ret >= end - *pos)
519 for (i = 0; i < len; i++) {
520 ret = os_snprintf(*pos, end - *pos, "%c", data[i]);
521 if (ret < 0 || ret >= end - *pos)
525 ret = os_snprintf(*pos, end - *pos, "\n");
526 if (ret < 0 || ret >= end - *pos)
533 static int eap_fast_write_pac(struct eap_sm *sm, const char *pac_file,
534 char *buf, size_t len)
536 if (os_strncmp(pac_file, "blob://", 7) == 0) {
537 struct wpa_config_blob *blob;
538 blob = os_zalloc(sizeof(*blob));
541 blob->data = (u8 *) buf;
544 blob->name = os_strdup(pac_file + 7);
545 if (blob->name == NULL) {
549 eap_set_config_blob(sm, blob);
552 f = fopen(pac_file, "wb");
554 wpa_printf(MSG_INFO, "EAP-FAST: Failed to open PAC "
555 "file '%s' for writing", pac_file);
558 if (fwrite(buf, 1, len, f) != len) {
559 wpa_printf(MSG_INFO, "EAP-FAST: Failed to write all "
560 "PACs into '%s'", pac_file);
572 static int eap_fast_add_pac_data(struct eap_fast_pac *pac, char **buf,
573 char **pos, size_t *buf_len)
577 ret = os_snprintf(*pos, *buf + *buf_len - *pos,
578 "START\nPAC-Type=%d\n", pac->pac_type);
579 if (ret < 0 || ret >= *buf + *buf_len - *pos)
583 eap_fast_write(buf, pos, buf_len, "PAC-Key",
584 pac->pac_key, EAP_FAST_PAC_KEY_LEN, 0);
585 eap_fast_write(buf, pos, buf_len, "PAC-Opaque",
586 pac->pac_opaque, pac->pac_opaque_len, 0);
587 eap_fast_write(buf, pos, buf_len, "PAC-Info",
588 pac->pac_info, pac->pac_info_len, 0);
589 eap_fast_write(buf, pos, buf_len, "A-ID",
590 pac->a_id, pac->a_id_len, 0);
591 eap_fast_write(buf, pos, buf_len, "I-ID",
592 pac->i_id, pac->i_id_len, 1);
593 eap_fast_write(buf, pos, buf_len, "A-ID-Info",
594 pac->a_id_info, pac->a_id_info_len, 1);
596 wpa_printf(MSG_DEBUG, "EAP-FAST: No memory for PAC "
600 ret = os_snprintf(*pos, *buf + *buf_len - *pos, "END\n");
601 if (ret < 0 || ret >= *buf + *buf_len - *pos)
610 * eap_fast_save_pac - Save PAC entries (text format)
611 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
612 * @pac_root: Root of the PAC list
613 * @pac_file: Name of the PAC file/blob
614 * Returns: 0 on success, -1 on failure
616 int eap_fast_save_pac(struct eap_sm *sm, struct eap_fast_pac *pac_root,
617 const char *pac_file)
619 struct eap_fast_pac *pac;
624 if (pac_file == NULL)
628 pos = buf = os_malloc(buf_len);
632 ret = os_snprintf(pos, buf + buf_len - pos, "%s\n", pac_file_hdr);
633 if (ret < 0 || ret >= buf + buf_len - pos) {
641 if (eap_fast_add_pac_data(pac, &buf, &pos, &buf_len)) {
649 if (eap_fast_write_pac(sm, pac_file, buf, pos - buf)) {
654 wpa_printf(MSG_DEBUG, "EAP-FAST: Wrote %d PAC entries into '%s'",
662 * eap_fast_pac_list_truncate - Truncate a PAC list to the given length
663 * @pac_root: Root of the PAC list
664 * @max_len: Maximum length of the list (>= 1)
665 * Returns: Number of PAC entries removed
667 size_t eap_fast_pac_list_truncate(struct eap_fast_pac *pac_root,
670 struct eap_fast_pac *pac, *prev;
685 if (count <= max_len || prev == NULL)
694 eap_fast_free_pac(prev);
702 static void eap_fast_pac_get_a_id(struct eap_fast_pac *pac)
708 end = pos + pac->pac_info_len;
710 while (pos + 4 < end) {
711 type = WPA_GET_BE16(pos);
713 len = WPA_GET_BE16(pos);
718 if (type == PAC_TYPE_A_ID) {
720 pac->a_id = os_malloc(len);
721 if (pac->a_id == NULL)
723 os_memcpy(pac->a_id, pos, len);
727 if (type == PAC_TYPE_A_ID_INFO) {
728 os_free(pac->a_id_info);
729 pac->a_id_info = os_malloc(len);
730 if (pac->a_id_info == NULL)
732 os_memcpy(pac->a_id_info, pos, len);
733 pac->a_id_info_len = len;
742 * eap_fast_load_pac_bin - Load PAC entries (binary format)
743 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
744 * @pac_root: Pointer to root of the PAC list (to be filled)
745 * @pac_file: Name of the PAC file/blob to load
746 * Returns: 0 on success, -1 on failure
748 int eap_fast_load_pac_bin(struct eap_sm *sm, struct eap_fast_pac **pac_root,
749 const char *pac_file)
751 const struct wpa_config_blob *blob = NULL;
753 size_t len, count = 0;
754 struct eap_fast_pac *pac, *prev;
758 if (pac_file == NULL)
761 if (os_strncmp(pac_file, "blob://", 7) == 0) {
762 blob = eap_get_config_blob(sm, pac_file + 7);
764 wpa_printf(MSG_INFO, "EAP-FAST: No PAC blob '%s' - "
765 "assume no PAC entries have been "
766 "provisioned", pac_file + 7);
772 buf = (u8 *) os_readfile(pac_file, &len);
774 wpa_printf(MSG_INFO, "EAP-FAST: No PAC file '%s' - "
775 "assume no PAC entries have been "
776 "provisioned", pac_file);
787 if (len < 6 || WPA_GET_BE32(buf) != EAP_FAST_PAC_BINARY_MAGIC ||
788 WPA_GET_BE16(buf + 4) != EAP_FAST_PAC_BINARY_FORMAT_VERSION) {
789 wpa_printf(MSG_INFO, "EAP-FAST: Invalid PAC file '%s' (bin)",
800 if (end - pos < 2 + 32 + 2 + 2)
803 pac = os_zalloc(sizeof(*pac));
807 pac->pac_type = WPA_GET_BE16(pos);
809 os_memcpy(pac->pac_key, pos, EAP_FAST_PAC_KEY_LEN);
810 pos += EAP_FAST_PAC_KEY_LEN;
811 pac->pac_opaque_len = WPA_GET_BE16(pos);
813 if (pos + pac->pac_opaque_len + 2 > end)
815 pac->pac_opaque = os_malloc(pac->pac_opaque_len);
816 if (pac->pac_opaque == NULL)
818 os_memcpy(pac->pac_opaque, pos, pac->pac_opaque_len);
819 pos += pac->pac_opaque_len;
820 pac->pac_info_len = WPA_GET_BE16(pos);
822 if (pos + pac->pac_info_len > end)
824 pac->pac_info = os_malloc(pac->pac_info_len);
825 if (pac->pac_info == NULL)
827 os_memcpy(pac->pac_info, pos, pac->pac_info_len);
828 pos += pac->pac_info_len;
829 eap_fast_pac_get_a_id(pac);
842 wpa_printf(MSG_DEBUG, "EAP-FAST: Read %lu PAC entries from '%s' (bin)",
843 (unsigned long) count, pac_file);
848 wpa_printf(MSG_INFO, "EAP-FAST: Failed to parse PAC file '%s' (bin)",
853 eap_fast_free_pac(pac);
859 * eap_fast_save_pac_bin - Save PAC entries (binary format)
860 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
861 * @pac_root: Root of the PAC list
862 * @pac_file: Name of the PAC file/blob
863 * Returns: 0 on success, -1 on failure
865 int eap_fast_save_pac_bin(struct eap_sm *sm, struct eap_fast_pac *pac_root,
866 const char *pac_file)
868 size_t len, count = 0;
869 struct eap_fast_pac *pac;
875 if (pac->pac_opaque_len > 65535 ||
876 pac->pac_info_len > 65535)
878 len += 2 + EAP_FAST_PAC_KEY_LEN + 2 + pac->pac_opaque_len +
879 2 + pac->pac_info_len;
883 buf = os_malloc(len);
888 WPA_PUT_BE32(pos, EAP_FAST_PAC_BINARY_MAGIC);
890 WPA_PUT_BE16(pos, EAP_FAST_PAC_BINARY_FORMAT_VERSION);
895 WPA_PUT_BE16(pos, pac->pac_type);
897 os_memcpy(pos, pac->pac_key, EAP_FAST_PAC_KEY_LEN);
898 pos += EAP_FAST_PAC_KEY_LEN;
899 WPA_PUT_BE16(pos, pac->pac_opaque_len);
901 os_memcpy(pos, pac->pac_opaque, pac->pac_opaque_len);
902 pos += pac->pac_opaque_len;
903 WPA_PUT_BE16(pos, pac->pac_info_len);
905 os_memcpy(pos, pac->pac_info, pac->pac_info_len);
906 pos += pac->pac_info_len;
912 if (eap_fast_write_pac(sm, pac_file, (char *) buf, len)) {
917 wpa_printf(MSG_DEBUG, "EAP-FAST: Wrote %lu PAC entries into '%s' "
918 "(bin)", (unsigned long) count, pac_file);