2 * hostapd - PMKSA cache for IEEE 802.11i RSN
3 * Copyright (c) 2004-2008, 2012-2015, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
9 #include "utils/includes.h"
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"
17 #include "ap_config.h"
18 #include "pmksa_cache_auth.h"
21 static const int pmksa_cache_max_entries = 1024;
22 static const int dot11RSNAConfigPMKLifetime = 43200;
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;
31 void (*free_cb)(struct rsn_pmksa_cache_entry *entry, void *ctx);
36 static void pmksa_cache_set_expiration(struct rsn_pmksa_cache *pmksa);
39 static void _pmksa_cache_free_entry(struct rsn_pmksa_cache_entry *entry)
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));
51 void pmksa_cache_free_entry(struct rsn_pmksa_cache *pmksa,
52 struct rsn_pmksa_cache_entry *entry)
54 struct rsn_pmksa_cache_entry *pos, *prev;
58 pmksa->free_cb(entry, pmksa->ctx);
60 /* unlink from hash list */
61 hash = PMKID_HASH(entry->pmkid);
62 pos = pmksa->pmkid[hash];
67 prev->hnext = entry->hnext;
69 pmksa->pmkid[hash] = entry->hnext;
76 /* unlink from entry list */
82 prev->next = entry->next;
84 pmksa->pmksa = entry->next;
91 _pmksa_cache_free_entry(entry);
96 * pmksa_cache_auth_flush - Flush all PMKSA cache entries
97 * @pmksa: Pointer to PMKSA cache data from pmksa_cache_auth_init()
99 void pmksa_cache_auth_flush(struct rsn_pmksa_cache *pmksa)
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);
109 static void pmksa_cache_expire(void *eloop_ctx, void *timeout_ctx)
111 struct rsn_pmksa_cache *pmksa = eloop_ctx;
112 struct os_reltime now;
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);
121 pmksa_cache_set_expiration(pmksa);
125 static void pmksa_cache_set_expiration(struct rsn_pmksa_cache *pmksa)
128 struct os_reltime now;
130 eloop_cancel_timeout(pmksa_cache_expire, pmksa, NULL);
131 if (pmksa->pmksa == NULL)
133 os_get_reltime(&now);
134 sec = pmksa->pmksa->expiration - now.sec;
137 eloop_register_timeout(sec + 1, 0, pmksa_cache_expire, pmksa, NULL);
141 static void pmksa_cache_from_eapol_data(struct rsn_pmksa_cache_entry *entry,
142 struct eapol_state_machine *eapol)
144 struct vlan_description *vlan_desc;
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);
158 if (eapol->radius_cui)
159 entry->cui = wpabuf_dup(eapol->radius_cui);
161 #ifndef CONFIG_NO_RADIUS
162 radius_copy_class(&entry->radius_class, &eapol->radius_class);
163 #endif /* CONFIG_NO_RADIUS */
165 entry->eap_type_authsrv = eapol->eap_type_authsrv;
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;
173 entry->vlan_desc = NULL;
176 entry->acct_multi_session_id = eapol->acct_multi_session_id;
180 void pmksa_cache_to_eapol_data(struct hostapd_data *hapd,
181 struct rsn_pmksa_cache_entry *entry,
182 struct eapol_state_machine *eapol)
184 if (entry == NULL || eapol == NULL)
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);
195 wpa_hexdump_ascii(MSG_DEBUG, "STA identity from PMKSA",
196 eapol->identity, eapol->identity_len);
200 wpabuf_free(eapol->radius_cui);
201 eapol->radius_cui = wpabuf_dup(entry->cui);
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);
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 */
218 eapol->acct_multi_session_id = entry->acct_multi_session_id;
222 static void pmksa_cache_link_entry(struct rsn_pmksa_cache *pmksa,
223 struct rsn_pmksa_cache_entry *entry)
225 struct rsn_pmksa_cache_entry *pos, *prev;
228 /* Add the new entry; order by expiration time */
232 if (pos->expiration > entry->expiration)
238 entry->next = pmksa->pmksa;
239 pmksa->pmksa = entry;
241 entry->next = prev->next;
245 hash = PMKID_HASH(entry->pmkid);
246 entry->hnext = pmksa->pmkid[hash];
247 pmksa->pmkid[hash] = entry;
249 pmksa->pmksa_count++;
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);
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
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
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)
285 struct rsn_pmksa_cache_entry *entry;
287 entry = pmksa_cache_auth_create_entry(pmk, pmk_len, pmkid, kck, kck_len,
288 aa, spa, session_timeout, eapol,
291 if (pmksa_cache_auth_add_entry(pmksa, entry) < 0)
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
312 * This function creates a PMKSA entry.
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)
320 struct rsn_pmksa_cache_entry *entry;
321 struct os_reltime now;
323 if (pmk_len > PMK_LEN_MAX)
326 if (wpa_key_mgmt_suite_b(akmp) && !kck)
329 entry = os_zalloc(sizeof(*entry));
332 os_memcpy(entry->pmk, pmk, pmk_len);
333 entry->pmk_len = pmk_len;
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);
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;
347 entry->expiration += dot11RSNAConfigPMKLifetime;
349 os_memcpy(entry->spa, spa, ETH_ALEN);
350 pmksa_cache_from_eapol_data(entry, eapol);
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
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.
365 int pmksa_cache_auth_add_entry(struct rsn_pmksa_cache *pmksa,
366 struct rsn_pmksa_cache_entry *entry)
368 struct rsn_pmksa_cache_entry *pos;
373 /* Replace an old entry for the same STA (if found) with the new entry
375 pos = pmksa_cache_auth_get(pmksa, entry->spa, NULL);
377 pmksa_cache_free_entry(pmksa, pos);
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);
387 pmksa_cache_link_entry(pmksa, entry);
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)
398 struct rsn_pmksa_cache_entry *entry;
400 entry = os_zalloc(sizeof(*entry));
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);
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;
429 entry->vlan_desc = NULL;
431 entry->opportunistic = 1;
433 pmksa_cache_link_entry(pmksa, entry);
440 * pmksa_cache_auth_deinit - Free all entries in PMKSA cache
441 * @pmksa: Pointer to PMKSA cache data from pmksa_cache_auth_init()
443 void pmksa_cache_auth_deinit(struct rsn_pmksa_cache *pmksa)
445 struct rsn_pmksa_cache_entry *entry, *prev;
451 entry = pmksa->pmksa;
455 _pmksa_cache_free_entry(prev);
457 eloop_cancel_timeout(pmksa_cache_expire, pmksa, NULL);
458 pmksa->pmksa_count = 0;
460 for (i = 0; i < PMKID_HASH_SIZE; i++)
461 pmksa->pmkid[i] = NULL;
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
473 struct rsn_pmksa_cache_entry *
474 pmksa_cache_auth_get(struct rsn_pmksa_cache *pmksa,
475 const u8 *spa, const u8 *pmkid)
477 struct rsn_pmksa_cache_entry *entry;
480 for (entry = pmksa->pmkid[PMKID_HASH(pmkid)]; entry;
481 entry = entry->hnext) {
483 os_memcmp(entry->spa, spa, ETH_ALEN) == 0) &&
484 os_memcmp(entry->pmkid, pmkid, PMKID_LEN) == 0)
488 for (entry = pmksa->pmksa; entry; entry = entry->next) {
490 os_memcmp(entry->spa, spa, ETH_ALEN) == 0)
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
505 * Returns: Pointer to PMKSA cache entry or %NULL if no match was found
507 * Use opportunistic key caching (OKC) to find a PMK for a supplicant.
509 struct rsn_pmksa_cache_entry * pmksa_cache_get_okc(
510 struct rsn_pmksa_cache *pmksa, const u8 *aa, const u8 *spa,
513 struct rsn_pmksa_cache_entry *entry;
514 u8 new_pmkid[PMKID_LEN];
516 for (entry = pmksa->pmksa; entry; entry = entry->next) {
517 if (os_memcmp(entry->spa, spa, ETH_ALEN) != 0)
519 rsn_pmkid(entry->pmk, entry->pmk_len, aa, spa, new_pmkid,
521 if (os_memcmp(new_pmkid, pmkid, PMKID_LEN) == 0)
529 * pmksa_cache_auth_init - Initialize PMKSA cache
530 * @free_cb: Callback function to be called when a PMKSA cache entry is freed
531 * @ctx: Context pointer for free_cb function
532 * Returns: Pointer to PMKSA cache data or %NULL on failure
534 struct rsn_pmksa_cache *
535 pmksa_cache_auth_init(void (*free_cb)(struct rsn_pmksa_cache_entry *entry,
536 void *ctx), void *ctx)
538 struct rsn_pmksa_cache *pmksa;
540 pmksa = os_zalloc(sizeof(*pmksa));
542 pmksa->free_cb = free_cb;
550 static int das_attr_match(struct rsn_pmksa_cache_entry *entry,
551 struct radius_das_attrs *attr)
555 if (attr->sta_addr) {
556 if (os_memcmp(attr->sta_addr, entry->spa, ETH_ALEN) != 0)
561 if (attr->acct_multi_session_id) {
564 if (attr->acct_multi_session_id_len != 16)
566 os_snprintf(buf, sizeof(buf), "%016llX",
567 (unsigned long long) entry->acct_multi_session_id);
568 if (os_memcmp(attr->acct_multi_session_id, buf, 16) != 0)
575 attr->cui_len != wpabuf_len(entry->cui) ||
576 os_memcmp(attr->cui, wpabuf_head(entry->cui),
582 if (attr->user_name) {
583 if (!entry->identity ||
584 attr->user_name_len != entry->identity_len ||
585 os_memcmp(attr->user_name, entry->identity,
586 attr->user_name_len) != 0)
595 int pmksa_cache_auth_radius_das_disconnect(struct rsn_pmksa_cache *pmksa,
596 struct radius_das_attrs *attr)
599 struct rsn_pmksa_cache_entry *entry, *prev;
601 if (attr->acct_session_id)
604 entry = pmksa->pmksa;
606 if (das_attr_match(entry, attr)) {
610 pmksa_cache_free_entry(pmksa, prev);
616 return found ? 0 : -1;
621 * pmksa_cache_auth_list - Dump text list of entries in PMKSA cache
622 * @pmksa: Pointer to PMKSA cache data from pmksa_cache_auth_init()
623 * @buf: Buffer for the list
624 * @len: Length of the buffer
625 * Returns: Number of bytes written to buffer
627 * This function is used to generate a text format representation of the
628 * current PMKSA cache contents for the ctrl_iface PMKSA command.
630 int pmksa_cache_auth_list(struct rsn_pmksa_cache *pmksa, char *buf, size_t len)
634 struct rsn_pmksa_cache_entry *entry;
635 struct os_reltime now;
637 os_get_reltime(&now);
638 ret = os_snprintf(pos, buf + len - pos,
639 "Index / SPA / PMKID / expiration (in seconds) / opportunistic\n");
640 if (os_snprintf_error(buf + len - pos, ret))
644 entry = pmksa->pmksa;
646 ret = os_snprintf(pos, buf + len - pos, "%d " MACSTR " ",
647 i, MAC2STR(entry->spa));
648 if (os_snprintf_error(buf + len - pos, ret))
651 pos += wpa_snprintf_hex(pos, buf + len - pos, entry->pmkid,
653 ret = os_snprintf(pos, buf + len - pos, " %d %d\n",
654 (int) (entry->expiration - now.sec),
655 entry->opportunistic);
656 if (os_snprintf_error(buf + len - pos, ret))
665 #ifdef CONFIG_PMKSA_CACHE_EXTERNAL
669 * pmksa_cache_auth_list_mesh - Dump text list of entries in PMKSA cache
670 * @pmksa: Pointer to PMKSA cache data from pmksa_cache_auth_init()
671 * @addr: MAC address of the peer (NULL means any)
672 * @buf: Buffer for the list
673 * @len: Length of the buffer
674 * Returns: Number of bytes written to buffer
676 * This function is used to generate a text format representation of the
677 * current PMKSA cache contents for the ctrl_iface PMKSA_GET command to store
678 * in external storage.
680 int pmksa_cache_auth_list_mesh(struct rsn_pmksa_cache *pmksa, const u8 *addr,
681 char *buf, size_t len)
685 struct rsn_pmksa_cache_entry *entry;
686 struct os_reltime now;
690 os_get_reltime(&now);
695 * <BSSID> <PMKID> <PMK> <expiration in seconds>
697 for (entry = pmksa->pmksa; entry; entry = entry->next) {
698 if (addr && os_memcmp(entry->spa, addr, ETH_ALEN) != 0)
701 ret = os_snprintf(pos, end - pos, MACSTR " ",
702 MAC2STR(entry->spa));
703 if (os_snprintf_error(end - pos, ret))
707 pos += wpa_snprintf_hex(pos, end - pos, entry->pmkid,
710 ret = os_snprintf(pos, end - pos, " ");
711 if (os_snprintf_error(end - pos, ret))
715 pos += wpa_snprintf_hex(pos, end - pos, entry->pmk,
718 ret = os_snprintf(pos, end - pos, " %d\n",
719 (int) (entry->expiration - now.sec));
720 if (os_snprintf_error(end - pos, ret))
728 #endif /* CONFIG_MESH */
729 #endif /* CONFIG_PMKSA_CACHE_EXTERNAL */