xref: /freebsd/contrib/wpa/src/ap/pmksa_cache_auth.c (revision bdd1243df58e60e85101c09001d9812a789b6bc4)
1 /*
2  * hostapd - PMKSA cache for IEEE 802.11i RSN
3  * Copyright (c) 2004-2008, 2012-2015, 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 
9 #include "utils/includes.h"
10 
11 #include "utils/common.h"
12 #include "utils/eloop.h"
13 #include "eapol_auth/eapol_auth_sm.h"
14 #include "eapol_auth/eapol_auth_sm_i.h"
15 #include "radius/radius_das.h"
16 #include "sta_info.h"
17 #include "ap_config.h"
18 #include "pmksa_cache_auth.h"
19 
20 
21 static const int pmksa_cache_max_entries = 1024;
22 static const int dot11RSNAConfigPMKLifetime = 43200;
23 
24 struct rsn_pmksa_cache {
25 #define PMKID_HASH_SIZE 128
26 #define PMKID_HASH(pmkid) (unsigned int) ((pmkid)[0] & 0x7f)
27 	struct rsn_pmksa_cache_entry *pmkid[PMKID_HASH_SIZE];
28 	struct rsn_pmksa_cache_entry *pmksa;
29 	int pmksa_count;
30 
31 	void (*free_cb)(struct rsn_pmksa_cache_entry *entry, void *ctx);
32 	void *ctx;
33 };
34 
35 
36 static void pmksa_cache_set_expiration(struct rsn_pmksa_cache *pmksa);
37 
38 
39 static void _pmksa_cache_free_entry(struct rsn_pmksa_cache_entry *entry)
40 {
41 	os_free(entry->vlan_desc);
42 	os_free(entry->identity);
43 	wpabuf_free(entry->cui);
44 #ifndef CONFIG_NO_RADIUS
45 	radius_free_class(&entry->radius_class);
46 #endif /* CONFIG_NO_RADIUS */
47 	bin_clear_free(entry, sizeof(*entry));
48 }
49 
50 
51 void pmksa_cache_free_entry(struct rsn_pmksa_cache *pmksa,
52 			    struct rsn_pmksa_cache_entry *entry)
53 {
54 	struct rsn_pmksa_cache_entry *pos, *prev;
55 	unsigned int hash;
56 
57 	pmksa->pmksa_count--;
58 	pmksa->free_cb(entry, pmksa->ctx);
59 
60 	/* unlink from hash list */
61 	hash = PMKID_HASH(entry->pmkid);
62 	pos = pmksa->pmkid[hash];
63 	prev = NULL;
64 	while (pos) {
65 		if (pos == entry) {
66 			if (prev != NULL)
67 				prev->hnext = entry->hnext;
68 			else
69 				pmksa->pmkid[hash] = entry->hnext;
70 			break;
71 		}
72 		prev = pos;
73 		pos = pos->hnext;
74 	}
75 
76 	/* unlink from entry list */
77 	pos = pmksa->pmksa;
78 	prev = NULL;
79 	while (pos) {
80 		if (pos == entry) {
81 			if (prev != NULL)
82 				prev->next = entry->next;
83 			else
84 				pmksa->pmksa = entry->next;
85 			break;
86 		}
87 		prev = pos;
88 		pos = pos->next;
89 	}
90 
91 	_pmksa_cache_free_entry(entry);
92 }
93 
94 
95 /**
96  * pmksa_cache_auth_flush - Flush all PMKSA cache entries
97  * @pmksa: Pointer to PMKSA cache data from pmksa_cache_auth_init()
98  */
99 void pmksa_cache_auth_flush(struct rsn_pmksa_cache *pmksa)
100 {
101 	while (pmksa->pmksa) {
102 		wpa_printf(MSG_DEBUG, "RSN: Flush PMKSA cache entry for "
103 			   MACSTR, MAC2STR(pmksa->pmksa->spa));
104 		pmksa_cache_free_entry(pmksa, pmksa->pmksa);
105 	}
106 }
107 
108 
109 static void pmksa_cache_expire(void *eloop_ctx, void *timeout_ctx)
110 {
111 	struct rsn_pmksa_cache *pmksa = eloop_ctx;
112 	struct os_reltime now;
113 
114 	os_get_reltime(&now);
115 	while (pmksa->pmksa && pmksa->pmksa->expiration <= now.sec) {
116 		wpa_printf(MSG_DEBUG, "RSN: expired PMKSA cache entry for "
117 			   MACSTR, MAC2STR(pmksa->pmksa->spa));
118 		pmksa_cache_free_entry(pmksa, pmksa->pmksa);
119 	}
120 
121 	pmksa_cache_set_expiration(pmksa);
122 }
123 
124 
125 static void pmksa_cache_set_expiration(struct rsn_pmksa_cache *pmksa)
126 {
127 	int sec;
128 	struct os_reltime now;
129 
130 	eloop_cancel_timeout(pmksa_cache_expire, pmksa, NULL);
131 	if (pmksa->pmksa == NULL)
132 		return;
133 	os_get_reltime(&now);
134 	sec = pmksa->pmksa->expiration - now.sec;
135 	if (sec < 0)
136 		sec = 0;
137 	eloop_register_timeout(sec + 1, 0, pmksa_cache_expire, pmksa, NULL);
138 }
139 
140 
141 static void pmksa_cache_from_eapol_data(struct rsn_pmksa_cache_entry *entry,
142 					struct eapol_state_machine *eapol)
143 {
144 	struct vlan_description *vlan_desc;
145 
146 	if (eapol == NULL)
147 		return;
148 
149 	if (eapol->identity) {
150 		entry->identity = os_malloc(eapol->identity_len);
151 		if (entry->identity) {
152 			entry->identity_len = eapol->identity_len;
153 			os_memcpy(entry->identity, eapol->identity,
154 				  eapol->identity_len);
155 		}
156 	}
157 
158 	if (eapol->radius_cui)
159 		entry->cui = wpabuf_dup(eapol->radius_cui);
160 
161 #ifndef CONFIG_NO_RADIUS
162 	radius_copy_class(&entry->radius_class, &eapol->radius_class);
163 #endif /* CONFIG_NO_RADIUS */
164 
165 	entry->eap_type_authsrv = eapol->eap_type_authsrv;
166 
167 	vlan_desc = ((struct sta_info *) eapol->sta)->vlan_desc;
168 	if (vlan_desc && vlan_desc->notempty) {
169 		entry->vlan_desc = os_zalloc(sizeof(struct vlan_description));
170 		if (entry->vlan_desc)
171 			*entry->vlan_desc = *vlan_desc;
172 	} else {
173 		entry->vlan_desc = NULL;
174 	}
175 
176 	entry->acct_multi_session_id = eapol->acct_multi_session_id;
177 }
178 
179 
180 void pmksa_cache_to_eapol_data(struct hostapd_data *hapd,
181 			       struct rsn_pmksa_cache_entry *entry,
182 			       struct eapol_state_machine *eapol)
183 {
184 	if (entry == NULL || eapol == NULL)
185 		return;
186 
187 	if (entry->identity) {
188 		os_free(eapol->identity);
189 		eapol->identity = os_malloc(entry->identity_len);
190 		if (eapol->identity) {
191 			eapol->identity_len = entry->identity_len;
192 			os_memcpy(eapol->identity, entry->identity,
193 				  entry->identity_len);
194 		}
195 		wpa_hexdump_ascii(MSG_DEBUG, "STA identity from PMKSA",
196 				  eapol->identity, eapol->identity_len);
197 	}
198 
199 	if (entry->cui) {
200 		wpabuf_free(eapol->radius_cui);
201 		eapol->radius_cui = wpabuf_dup(entry->cui);
202 	}
203 
204 #ifndef CONFIG_NO_RADIUS
205 	radius_free_class(&eapol->radius_class);
206 	radius_copy_class(&eapol->radius_class, &entry->radius_class);
207 #endif /* CONFIG_NO_RADIUS */
208 	if (eapol->radius_class.attr) {
209 		wpa_printf(MSG_DEBUG, "Copied %lu Class attribute(s) from "
210 			   "PMKSA", (unsigned long) eapol->radius_class.count);
211 	}
212 
213 	eapol->eap_type_authsrv = entry->eap_type_authsrv;
214 #ifndef CONFIG_NO_VLAN
215 	ap_sta_set_vlan(hapd, eapol->sta, entry->vlan_desc);
216 #endif /* CONFIG_NO_VLAN */
217 
218 	eapol->acct_multi_session_id = entry->acct_multi_session_id;
219 }
220 
221 
222 static void pmksa_cache_link_entry(struct rsn_pmksa_cache *pmksa,
223 				   struct rsn_pmksa_cache_entry *entry)
224 {
225 	struct rsn_pmksa_cache_entry *pos, *prev;
226 	int hash;
227 
228 	/* Add the new entry; order by expiration time */
229 	pos = pmksa->pmksa;
230 	prev = NULL;
231 	while (pos) {
232 		if (pos->expiration > entry->expiration)
233 			break;
234 		prev = pos;
235 		pos = pos->next;
236 	}
237 	if (prev == NULL) {
238 		entry->next = pmksa->pmksa;
239 		pmksa->pmksa = entry;
240 	} else {
241 		entry->next = prev->next;
242 		prev->next = entry;
243 	}
244 
245 	hash = PMKID_HASH(entry->pmkid);
246 	entry->hnext = pmksa->pmkid[hash];
247 	pmksa->pmkid[hash] = entry;
248 
249 	pmksa->pmksa_count++;
250 	if (prev == NULL)
251 		pmksa_cache_set_expiration(pmksa);
252 	wpa_printf(MSG_DEBUG, "RSN: added PMKSA cache entry for " MACSTR,
253 		   MAC2STR(entry->spa));
254 	wpa_hexdump(MSG_DEBUG, "RSN: added PMKID", entry->pmkid, PMKID_LEN);
255 }
256 
257 
258 /**
259  * pmksa_cache_auth_add - Add a PMKSA cache entry
260  * @pmksa: Pointer to PMKSA cache data from pmksa_cache_auth_init()
261  * @pmk: The new pairwise master key
262  * @pmk_len: PMK length in bytes, usually PMK_LEN (32)
263  * @pmkid: Calculated PMKID
264  * @kck: Key confirmation key or %NULL if not yet derived
265  * @kck_len: KCK length in bytes
266  * @aa: Authenticator address
267  * @spa: Supplicant address
268  * @session_timeout: Session timeout
269  * @eapol: Pointer to EAPOL state machine data
270  * @akmp: WPA_KEY_MGMT_* used in key derivation
271  * Returns: Pointer to the added PMKSA cache entry or %NULL on error
272  *
273  * This function create a PMKSA entry for a new PMK and adds it to the PMKSA
274  * cache. If an old entry is already in the cache for the same Supplicant,
275  * this entry will be replaced with the new entry. PMKID will be calculated
276  * based on the PMK.
277  */
278 struct rsn_pmksa_cache_entry *
279 pmksa_cache_auth_add(struct rsn_pmksa_cache *pmksa,
280 		     const u8 *pmk, size_t pmk_len, const u8 *pmkid,
281 		     const u8 *kck, size_t kck_len,
282 		     const u8 *aa, const u8 *spa, int session_timeout,
283 		     struct eapol_state_machine *eapol, int akmp)
284 {
285 	struct rsn_pmksa_cache_entry *entry;
286 
287 	entry = pmksa_cache_auth_create_entry(pmk, pmk_len, pmkid, kck, kck_len,
288 					      aa, spa, session_timeout, eapol,
289 					      akmp);
290 
291 	if (pmksa_cache_auth_add_entry(pmksa, entry) < 0)
292 		return NULL;
293 
294 	return entry;
295 }
296 
297 
298 /**
299  * pmksa_cache_auth_create_entry - Create a PMKSA cache entry
300  * @pmk: The new pairwise master key
301  * @pmk_len: PMK length in bytes, usually PMK_LEN (32)
302  * @pmkid: Calculated PMKID
303  * @kck: Key confirmation key or %NULL if not yet derived
304  * @kck_len: KCK length in bytes
305  * @aa: Authenticator address
306  * @spa: Supplicant address
307  * @session_timeout: Session timeout
308  * @eapol: Pointer to EAPOL state machine data
309  * @akmp: WPA_KEY_MGMT_* used in key derivation
310  * Returns: Pointer to the added PMKSA cache entry or %NULL on error
311  *
312  * This function creates a PMKSA entry.
313  */
314 struct rsn_pmksa_cache_entry *
315 pmksa_cache_auth_create_entry(const u8 *pmk, size_t pmk_len, const u8 *pmkid,
316 			      const u8 *kck, size_t kck_len, const u8 *aa,
317 			      const u8 *spa, int session_timeout,
318 			      struct eapol_state_machine *eapol, int akmp)
319 {
320 	struct rsn_pmksa_cache_entry *entry;
321 	struct os_reltime now;
322 
323 	if (pmk_len > PMK_LEN_MAX)
324 		return NULL;
325 
326 	if (wpa_key_mgmt_suite_b(akmp) && !kck)
327 		return NULL;
328 
329 	entry = os_zalloc(sizeof(*entry));
330 	if (entry == NULL)
331 		return NULL;
332 	os_memcpy(entry->pmk, pmk, pmk_len);
333 	entry->pmk_len = pmk_len;
334 	if (pmkid)
335 		os_memcpy(entry->pmkid, pmkid, PMKID_LEN);
336 	else if (akmp == WPA_KEY_MGMT_IEEE8021X_SUITE_B_192)
337 		rsn_pmkid_suite_b_192(kck, kck_len, aa, spa, entry->pmkid);
338 	else if (wpa_key_mgmt_suite_b(akmp))
339 		rsn_pmkid_suite_b(kck, kck_len, aa, spa, entry->pmkid);
340 	else
341 		rsn_pmkid(pmk, pmk_len, aa, spa, entry->pmkid, akmp);
342 	os_get_reltime(&now);
343 	entry->expiration = now.sec;
344 	if (session_timeout > 0)
345 		entry->expiration += session_timeout;
346 	else
347 		entry->expiration += dot11RSNAConfigPMKLifetime;
348 	entry->akmp = akmp;
349 	os_memcpy(entry->spa, spa, ETH_ALEN);
350 	pmksa_cache_from_eapol_data(entry, eapol);
351 
352 	return entry;
353 }
354 
355 
356 /**
357  * pmksa_cache_auth_add_entry - Add a PMKSA cache entry
358  * @pmksa: Pointer to PMKSA cache data from pmksa_cache_auth_init()
359  * @entry: Pointer to PMKSA cache entry
360  *
361  * This function adds PMKSA cache entry to the PMKSA cache. If an old entry is
362  * already in the cache for the same Supplicant, this entry will be replaced
363  * with the new entry. PMKID will be calculated based on the PMK.
364  */
365 int pmksa_cache_auth_add_entry(struct rsn_pmksa_cache *pmksa,
366 			       struct rsn_pmksa_cache_entry *entry)
367 {
368 	struct rsn_pmksa_cache_entry *pos;
369 
370 	if (entry == NULL)
371 		return -1;
372 
373 	/* Replace an old entry for the same STA (if found) with the new entry
374 	 */
375 	pos = pmksa_cache_auth_get(pmksa, entry->spa, NULL);
376 	if (pos)
377 		pmksa_cache_free_entry(pmksa, pos);
378 
379 	if (pmksa->pmksa_count >= pmksa_cache_max_entries && pmksa->pmksa) {
380 		/* Remove the oldest entry to make room for the new entry */
381 		wpa_printf(MSG_DEBUG, "RSN: removed the oldest PMKSA cache "
382 			   "entry (for " MACSTR ") to make room for new one",
383 			   MAC2STR(pmksa->pmksa->spa));
384 		pmksa_cache_free_entry(pmksa, pmksa->pmksa);
385 	}
386 
387 	pmksa_cache_link_entry(pmksa, entry);
388 
389 	return 0;
390 }
391 
392 
393 struct rsn_pmksa_cache_entry *
394 pmksa_cache_add_okc(struct rsn_pmksa_cache *pmksa,
395 		    const struct rsn_pmksa_cache_entry *old_entry,
396 		    const u8 *aa, const u8 *pmkid)
397 {
398 	struct rsn_pmksa_cache_entry *entry;
399 
400 	entry = os_zalloc(sizeof(*entry));
401 	if (entry == NULL)
402 		return NULL;
403 	os_memcpy(entry->pmkid, pmkid, PMKID_LEN);
404 	os_memcpy(entry->pmk, old_entry->pmk, old_entry->pmk_len);
405 	entry->pmk_len = old_entry->pmk_len;
406 	entry->expiration = old_entry->expiration;
407 	entry->akmp = old_entry->akmp;
408 	os_memcpy(entry->spa, old_entry->spa, ETH_ALEN);
409 	entry->opportunistic = 1;
410 	if (old_entry->identity) {
411 		entry->identity = os_malloc(old_entry->identity_len);
412 		if (entry->identity) {
413 			entry->identity_len = old_entry->identity_len;
414 			os_memcpy(entry->identity, old_entry->identity,
415 				  old_entry->identity_len);
416 		}
417 	}
418 	if (old_entry->cui)
419 		entry->cui = wpabuf_dup(old_entry->cui);
420 #ifndef CONFIG_NO_RADIUS
421 	radius_copy_class(&entry->radius_class, &old_entry->radius_class);
422 #endif /* CONFIG_NO_RADIUS */
423 	entry->eap_type_authsrv = old_entry->eap_type_authsrv;
424 	if (old_entry->vlan_desc) {
425 		entry->vlan_desc = os_zalloc(sizeof(struct vlan_description));
426 		if (entry->vlan_desc)
427 			*entry->vlan_desc = *old_entry->vlan_desc;
428 	} else {
429 		entry->vlan_desc = NULL;
430 	}
431 	entry->opportunistic = 1;
432 
433 	pmksa_cache_link_entry(pmksa, entry);
434 
435 	return entry;
436 }
437 
438 
439 /**
440  * pmksa_cache_auth_deinit - Free all entries in PMKSA cache
441  * @pmksa: Pointer to PMKSA cache data from pmksa_cache_auth_init()
442  */
443 void pmksa_cache_auth_deinit(struct rsn_pmksa_cache *pmksa)
444 {
445 	struct rsn_pmksa_cache_entry *entry, *prev;
446 	int i;
447 
448 	if (pmksa == NULL)
449 		return;
450 
451 	entry = pmksa->pmksa;
452 	while (entry) {
453 		prev = entry;
454 		entry = entry->next;
455 		_pmksa_cache_free_entry(prev);
456 	}
457 	eloop_cancel_timeout(pmksa_cache_expire, pmksa, NULL);
458 	pmksa->pmksa_count = 0;
459 	pmksa->pmksa = NULL;
460 	for (i = 0; i < PMKID_HASH_SIZE; i++)
461 		pmksa->pmkid[i] = NULL;
462 	os_free(pmksa);
463 }
464 
465 
466 /**
467  * pmksa_cache_auth_get - Fetch a PMKSA cache entry
468  * @pmksa: Pointer to PMKSA cache data from pmksa_cache_auth_init()
469  * @spa: Supplicant address or %NULL to match any
470  * @pmkid: PMKID or %NULL to match any
471  * Returns: Pointer to PMKSA cache entry or %NULL if no match was found
472  */
473 struct rsn_pmksa_cache_entry *
474 pmksa_cache_auth_get(struct rsn_pmksa_cache *pmksa,
475 		     const u8 *spa, const u8 *pmkid)
476 {
477 	struct rsn_pmksa_cache_entry *entry;
478 
479 	if (pmkid) {
480 		for (entry = pmksa->pmkid[PMKID_HASH(pmkid)]; entry;
481 		     entry = entry->hnext) {
482 			if ((spa == NULL ||
483 			     os_memcmp(entry->spa, spa, ETH_ALEN) == 0) &&
484 			    os_memcmp(entry->pmkid, pmkid, PMKID_LEN) == 0)
485 				return entry;
486 		}
487 	} else {
488 		for (entry = pmksa->pmksa; entry; entry = entry->next) {
489 			if (spa == NULL ||
490 			    os_memcmp(entry->spa, spa, ETH_ALEN) == 0)
491 				return entry;
492 		}
493 	}
494 
495 	return NULL;
496 }
497 
498 
499 /**
500  * pmksa_cache_get_okc - Fetch a PMKSA cache entry using OKC
501  * @pmksa: Pointer to PMKSA cache data from pmksa_cache_auth_init()
502  * @aa: Authenticator address
503  * @spa: Supplicant address
504  * @pmkid: PMKID
505  * Returns: Pointer to PMKSA cache entry or %NULL if no match was found
506  *
507  * Use opportunistic key caching (OKC) to find a PMK for a supplicant.
508  */
509 struct rsn_pmksa_cache_entry * pmksa_cache_get_okc(
510 	struct rsn_pmksa_cache *pmksa, const u8 *aa, const u8 *spa,
511 	const u8 *pmkid)
512 {
513 	struct rsn_pmksa_cache_entry *entry;
514 	u8 new_pmkid[PMKID_LEN];
515 
516 	for (entry = pmksa->pmksa; entry; entry = entry->next) {
517 		if (os_memcmp(entry->spa, spa, ETH_ALEN) != 0)
518 			continue;
519 		if (wpa_key_mgmt_sae(entry->akmp) ||
520 		    wpa_key_mgmt_fils(entry->akmp)) {
521 			if (os_memcmp(entry->pmkid, pmkid, PMKID_LEN) == 0)
522 				return entry;
523 			continue;
524 		}
525 		rsn_pmkid(entry->pmk, entry->pmk_len, aa, spa, new_pmkid,
526 			  entry->akmp);
527 		if (os_memcmp(new_pmkid, pmkid, PMKID_LEN) == 0)
528 			return entry;
529 	}
530 	return NULL;
531 }
532 
533 
534 /**
535  * pmksa_cache_auth_init - Initialize PMKSA cache
536  * @free_cb: Callback function to be called when a PMKSA cache entry is freed
537  * @ctx: Context pointer for free_cb function
538  * Returns: Pointer to PMKSA cache data or %NULL on failure
539  */
540 struct rsn_pmksa_cache *
541 pmksa_cache_auth_init(void (*free_cb)(struct rsn_pmksa_cache_entry *entry,
542 				      void *ctx), void *ctx)
543 {
544 	struct rsn_pmksa_cache *pmksa;
545 
546 	pmksa = os_zalloc(sizeof(*pmksa));
547 	if (pmksa) {
548 		pmksa->free_cb = free_cb;
549 		pmksa->ctx = ctx;
550 	}
551 
552 	return pmksa;
553 }
554 
555 
556 static int das_attr_match(struct rsn_pmksa_cache_entry *entry,
557 			  struct radius_das_attrs *attr)
558 {
559 	int match = 0;
560 
561 	if (attr->sta_addr) {
562 		if (os_memcmp(attr->sta_addr, entry->spa, ETH_ALEN) != 0)
563 			return 0;
564 		match++;
565 	}
566 
567 	if (attr->acct_multi_session_id) {
568 		char buf[20];
569 
570 		if (attr->acct_multi_session_id_len != 16)
571 			return 0;
572 		os_snprintf(buf, sizeof(buf), "%016llX",
573 			    (unsigned long long) entry->acct_multi_session_id);
574 		if (os_memcmp(attr->acct_multi_session_id, buf, 16) != 0)
575 			return 0;
576 		match++;
577 	}
578 
579 	if (attr->cui) {
580 		if (!entry->cui ||
581 		    attr->cui_len != wpabuf_len(entry->cui) ||
582 		    os_memcmp(attr->cui, wpabuf_head(entry->cui),
583 			      attr->cui_len) != 0)
584 			return 0;
585 		match++;
586 	}
587 
588 	if (attr->user_name) {
589 		if (!entry->identity ||
590 		    attr->user_name_len != entry->identity_len ||
591 		    os_memcmp(attr->user_name, entry->identity,
592 			      attr->user_name_len) != 0)
593 			return 0;
594 		match++;
595 	}
596 
597 	return match;
598 }
599 
600 
601 int pmksa_cache_auth_radius_das_disconnect(struct rsn_pmksa_cache *pmksa,
602 					   struct radius_das_attrs *attr)
603 {
604 	int found = 0;
605 	struct rsn_pmksa_cache_entry *entry, *prev;
606 
607 	if (attr->acct_session_id)
608 		return -1;
609 
610 	entry = pmksa->pmksa;
611 	while (entry) {
612 		if (das_attr_match(entry, attr)) {
613 			found++;
614 			prev = entry;
615 			entry = entry->next;
616 			pmksa_cache_free_entry(pmksa, prev);
617 			continue;
618 		}
619 		entry = entry->next;
620 	}
621 
622 	return found ? 0 : -1;
623 }
624 
625 
626 /**
627  * pmksa_cache_auth_list - Dump text list of entries in PMKSA cache
628  * @pmksa: Pointer to PMKSA cache data from pmksa_cache_auth_init()
629  * @buf: Buffer for the list
630  * @len: Length of the buffer
631  * Returns: Number of bytes written to buffer
632  *
633  * This function is used to generate a text format representation of the
634  * current PMKSA cache contents for the ctrl_iface PMKSA command.
635  */
636 int pmksa_cache_auth_list(struct rsn_pmksa_cache *pmksa, char *buf, size_t len)
637 {
638 	int i, ret;
639 	char *pos = buf;
640 	struct rsn_pmksa_cache_entry *entry;
641 	struct os_reltime now;
642 
643 	os_get_reltime(&now);
644 	ret = os_snprintf(pos, buf + len - pos,
645 			  "Index / SPA / PMKID / expiration (in seconds) / opportunistic\n");
646 	if (os_snprintf_error(buf + len - pos, ret))
647 		return pos - buf;
648 	pos += ret;
649 	i = 0;
650 	entry = pmksa->pmksa;
651 	while (entry) {
652 		ret = os_snprintf(pos, buf + len - pos, "%d " MACSTR " ",
653 				  i, MAC2STR(entry->spa));
654 		if (os_snprintf_error(buf + len - pos, ret))
655 			return pos - buf;
656 		pos += ret;
657 		pos += wpa_snprintf_hex(pos, buf + len - pos, entry->pmkid,
658 					PMKID_LEN);
659 		ret = os_snprintf(pos, buf + len - pos, " %d %d\n",
660 				  (int) (entry->expiration - now.sec),
661 				  entry->opportunistic);
662 		if (os_snprintf_error(buf + len - pos, ret))
663 			return pos - buf;
664 		pos += ret;
665 		entry = entry->next;
666 	}
667 	return pos - buf;
668 }
669 
670 
671 #ifdef CONFIG_PMKSA_CACHE_EXTERNAL
672 #ifdef CONFIG_MESH
673 
674 /**
675  * pmksa_cache_auth_list_mesh - Dump text list of entries in PMKSA cache
676  * @pmksa: Pointer to PMKSA cache data from pmksa_cache_auth_init()
677  * @addr: MAC address of the peer (NULL means any)
678  * @buf: Buffer for the list
679  * @len: Length of the buffer
680  * Returns: Number of bytes written to buffer
681  *
682  * This function is used to generate a text format representation of the
683  * current PMKSA cache contents for the ctrl_iface PMKSA_GET command to store
684  * in external storage.
685  */
686 int pmksa_cache_auth_list_mesh(struct rsn_pmksa_cache *pmksa, const u8 *addr,
687 			       char *buf, size_t len)
688 {
689 	int ret;
690 	char *pos, *end;
691 	struct rsn_pmksa_cache_entry *entry;
692 	struct os_reltime now;
693 
694 	pos = buf;
695 	end = buf + len;
696 	os_get_reltime(&now);
697 
698 
699 	/*
700 	 * Entry format:
701 	 * <BSSID> <PMKID> <PMK> <expiration in seconds>
702 	 */
703 	for (entry = pmksa->pmksa; entry; entry = entry->next) {
704 		if (addr && os_memcmp(entry->spa, addr, ETH_ALEN) != 0)
705 			continue;
706 
707 		ret = os_snprintf(pos, end - pos, MACSTR " ",
708 				  MAC2STR(entry->spa));
709 		if (os_snprintf_error(end - pos, ret))
710 			return 0;
711 		pos += ret;
712 
713 		pos += wpa_snprintf_hex(pos, end - pos, entry->pmkid,
714 					PMKID_LEN);
715 
716 		ret = os_snprintf(pos, end - pos, " ");
717 		if (os_snprintf_error(end - pos, ret))
718 			return 0;
719 		pos += ret;
720 
721 		pos += wpa_snprintf_hex(pos, end - pos, entry->pmk,
722 					entry->pmk_len);
723 
724 		ret = os_snprintf(pos, end - pos, " %d\n",
725 				  (int) (entry->expiration - now.sec));
726 		if (os_snprintf_error(end - pos, ret))
727 			return 0;
728 		pos += ret;
729 	}
730 
731 	return pos - buf;
732 }
733 
734 #endif /* CONFIG_MESH */
735 #endif /* CONFIG_PMKSA_CACHE_EXTERNAL */
736