2
* WPA Supplicant - RSN PMKSA cache
3
* Copyright (c) 2004-2006, Jouni Malinen <j@w1.fi>
5
* This program is free software; you can redistribute it and/or modify
6
* it under the terms of the GNU General Public License version 2 as
7
* published by the Free Software Foundation.
9
* Alternatively, this software may be distributed under the terms of BSD
12
* See README and COPYING for more details.
22
#include "eapol_supp/eapol_supp_sm.h"
23
#include "pmksa_cache.h"
25
#if defined(IEEE8021X_EAPOL) && !defined(CONFIG_NO_WPA2)
27
static const int pmksa_cache_max_entries = 32;
29
struct rsn_pmksa_cache {
30
struct rsn_pmksa_cache_entry *pmksa; /* PMKSA cache */
31
int pmksa_count; /* number of entries in PMKSA cache */
32
struct wpa_sm *sm; /* TODO: get rid of this reference(?) */
34
void (*free_cb)(struct rsn_pmksa_cache_entry *entry, void *ctx,
41
* rsn_pmkid - Calculate PMK identifier
42
* @pmk: Pairwise master key
43
* @pmk_len: Length of pmk in bytes
44
* @aa: Authenticator address
45
* @spa: Supplicant address
47
* IEEE Std 802.11i-2004 - 8.5.1.2 Pairwise key hierarchy
48
* PMKID = HMAC-SHA1-128(PMK, "PMK Name" || AA || SPA)
50
void rsn_pmkid(const u8 *pmk, size_t pmk_len, const u8 *aa, const u8 *spa,
53
char *title = "PMK Name";
55
const size_t len[3] = { 8, ETH_ALEN, ETH_ALEN };
56
unsigned char hash[SHA1_MAC_LEN];
58
addr[0] = (u8 *) title;
62
hmac_sha1_vector(pmk, pmk_len, 3, addr, len, hash);
63
os_memcpy(pmkid, hash, PMKID_LEN);
67
static void pmksa_cache_set_expiration(struct rsn_pmksa_cache *pmksa);
70
static void _pmksa_cache_free_entry(struct rsn_pmksa_cache_entry *entry)
76
static void pmksa_cache_free_entry(struct rsn_pmksa_cache *pmksa,
77
struct rsn_pmksa_cache_entry *entry,
81
pmksa->free_cb(entry, pmksa->ctx, replace);
82
_pmksa_cache_free_entry(entry);
86
static void pmksa_cache_expire(void *eloop_ctx, void *timeout_ctx)
88
struct rsn_pmksa_cache *pmksa = eloop_ctx;
92
while (pmksa->pmksa && pmksa->pmksa->expiration <= now.sec) {
93
struct rsn_pmksa_cache_entry *entry = pmksa->pmksa;
94
pmksa->pmksa = entry->next;
95
wpa_printf(MSG_DEBUG, "RSN: expired PMKSA cache entry for "
96
MACSTR, MAC2STR(entry->aa));
97
pmksa_cache_free_entry(pmksa, entry, 0);
100
pmksa_cache_set_expiration(pmksa);
104
static void pmksa_cache_reauth(void *eloop_ctx, void *timeout_ctx)
106
struct rsn_pmksa_cache *pmksa = eloop_ctx;
107
pmksa->sm->cur_pmksa = NULL;
108
eapol_sm_request_reauth(pmksa->sm->eapol);
112
static void pmksa_cache_set_expiration(struct rsn_pmksa_cache *pmksa)
115
struct rsn_pmksa_cache_entry *entry;
118
eloop_cancel_timeout(pmksa_cache_expire, pmksa, NULL);
119
eloop_cancel_timeout(pmksa_cache_reauth, pmksa, NULL);
120
if (pmksa->pmksa == NULL)
123
sec = pmksa->pmksa->expiration - now.sec;
126
eloop_register_timeout(sec + 1, 0, pmksa_cache_expire, pmksa, NULL);
128
entry = pmksa->sm->cur_pmksa ? pmksa->sm->cur_pmksa :
129
pmksa_cache_get(pmksa, pmksa->sm->bssid, NULL);
131
sec = pmksa->pmksa->reauth_time - now.sec;
134
eloop_register_timeout(sec, 0, pmksa_cache_reauth, pmksa,
141
* pmksa_cache_add - Add a PMKSA cache entry
142
* @pmksa: Pointer to PMKSA cache data from pmksa_cache_init()
143
* @pmk: The new pairwise master key
144
* @pmk_len: PMK length in bytes, usually PMK_LEN (32)
145
* @aa: Authenticator address
146
* @spa: Supplicant address
147
* @network_ctx: Network configuration context for this PMK
148
* Returns: Pointer to the added PMKSA cache entry or %NULL on error
150
* This function create a PMKSA entry for a new PMK and adds it to the PMKSA
151
* cache. If an old entry is already in the cache for the same Authenticator,
152
* this entry will be replaced with the new entry. PMKID will be calculated
153
* based on the PMK and the driver interface is notified of the new PMKID.
155
struct rsn_pmksa_cache_entry *
156
pmksa_cache_add(struct rsn_pmksa_cache *pmksa, const u8 *pmk, size_t pmk_len,
157
const u8 *aa, const u8 *spa, void *network_ctx)
159
struct rsn_pmksa_cache_entry *entry, *pos, *prev;
162
if (pmksa->sm->proto != WPA_PROTO_RSN || pmk_len > PMK_LEN)
165
entry = os_zalloc(sizeof(*entry));
168
os_memcpy(entry->pmk, pmk, pmk_len);
169
entry->pmk_len = pmk_len;
170
rsn_pmkid(pmk, pmk_len, aa, spa, entry->pmkid);
172
entry->expiration = now.sec + pmksa->sm->dot11RSNAConfigPMKLifetime;
173
entry->reauth_time = now.sec + pmksa->sm->dot11RSNAConfigPMKLifetime *
174
pmksa->sm->dot11RSNAConfigPMKReauthThreshold / 100;
175
entry->akmp = WPA_KEY_MGMT_IEEE8021X;
176
os_memcpy(entry->aa, aa, ETH_ALEN);
177
entry->network_ctx = network_ctx;
179
/* Replace an old entry for the same Authenticator (if found) with the
184
if (os_memcmp(aa, pos->aa, ETH_ALEN) == 0) {
185
if (pos->pmk_len == pmk_len &&
186
os_memcmp(pos->pmk, pmk, pmk_len) == 0 &&
187
os_memcmp(pos->pmkid, entry->pmkid, PMKID_LEN) ==
189
wpa_printf(MSG_DEBUG, "WPA: reusing previous "
195
pmksa->pmksa = pos->next;
197
prev->next = pos->next;
198
if (pos == pmksa->sm->cur_pmksa) {
199
/* We are about to replace the current PMKSA
200
* cache entry. This happens when the PMKSA
201
* caching attempt fails, so we don't want to
202
* force pmksa_cache_free_entry() to disconnect
203
* at this point. Let's just make sure the old
204
* PMKSA cache entry will not be used in the
207
wpa_printf(MSG_DEBUG, "RSN: replacing current "
209
pmksa->sm->cur_pmksa = NULL;
211
wpa_printf(MSG_DEBUG, "RSN: Replace PMKSA entry for "
213
pmksa_cache_free_entry(pmksa, pos, 1);
220
if (pmksa->pmksa_count >= pmksa_cache_max_entries && pmksa->pmksa) {
221
/* Remove the oldest entry to make room for the new entry */
223
pmksa->pmksa = pos->next;
224
wpa_printf(MSG_DEBUG, "RSN: removed the oldest PMKSA cache "
225
"entry (for " MACSTR ") to make room for new one",
227
wpa_sm_remove_pmkid(pmksa->sm, pos->aa, pos->pmkid);
228
pmksa_cache_free_entry(pmksa, pos, 0);
231
/* Add the new entry; order by expiration time */
235
if (pos->expiration > entry->expiration)
241
entry->next = pmksa->pmksa;
242
pmksa->pmksa = entry;
243
pmksa_cache_set_expiration(pmksa);
245
entry->next = prev->next;
248
pmksa->pmksa_count++;
249
wpa_printf(MSG_DEBUG, "RSN: added PMKSA cache entry for " MACSTR,
251
wpa_sm_add_pmkid(pmksa->sm, entry->aa, entry->pmkid);
258
* pmksa_cache_deinit - Free all entries in PMKSA cache
259
* @pmksa: Pointer to PMKSA cache data from pmksa_cache_init()
261
void pmksa_cache_deinit(struct rsn_pmksa_cache *pmksa)
263
struct rsn_pmksa_cache_entry *entry, *prev;
268
entry = pmksa->pmksa;
275
pmksa_cache_set_expiration(pmksa);
281
* pmksa_cache_get - Fetch a PMKSA cache entry
282
* @pmksa: Pointer to PMKSA cache data from pmksa_cache_init()
283
* @aa: Authenticator address or %NULL to match any
284
* @pmkid: PMKID or %NULL to match any
285
* Returns: Pointer to PMKSA cache entry or %NULL if no match was found
287
struct rsn_pmksa_cache_entry * pmksa_cache_get(struct rsn_pmksa_cache *pmksa,
288
const u8 *aa, const u8 *pmkid)
290
struct rsn_pmksa_cache_entry *entry = pmksa->pmksa;
292
if ((aa == NULL || os_memcmp(entry->aa, aa, ETH_ALEN) == 0) &&
294
os_memcmp(entry->pmkid, pmkid, PMKID_LEN) == 0))
303
* pmksa_cache_notify_reconfig - Reconfiguration notification for PMKSA cache
304
* @pmksa: Pointer to PMKSA cache data from pmksa_cache_init()
306
* Clear references to old data structures when wpa_supplicant is reconfigured.
308
void pmksa_cache_notify_reconfig(struct rsn_pmksa_cache *pmksa)
310
struct rsn_pmksa_cache_entry *entry = pmksa->pmksa;
312
entry->network_ctx = NULL;
318
static struct rsn_pmksa_cache_entry *
319
pmksa_cache_clone_entry(struct rsn_pmksa_cache *pmksa,
320
const struct rsn_pmksa_cache_entry *old_entry,
323
struct rsn_pmksa_cache_entry *new_entry;
325
new_entry = pmksa_cache_add(pmksa, old_entry->pmk, old_entry->pmk_len,
326
aa, pmksa->sm->own_addr,
327
old_entry->network_ctx);
328
if (new_entry == NULL)
331
/* TODO: reorder entries based on expiration time? */
332
new_entry->expiration = old_entry->expiration;
333
new_entry->opportunistic = 1;
340
* pmksa_cache_get_opportunistic - Try to get an opportunistic PMKSA entry
341
* @pmksa: Pointer to PMKSA cache data from pmksa_cache_init()
342
* @network_ctx: Network configuration context
343
* @aa: Authenticator address for the new AP
344
* Returns: Pointer to a new PMKSA cache entry or %NULL if not available
346
* Try to create a new PMKSA cache entry opportunistically by guessing that the
347
* new AP is sharing the same PMK as another AP that has the same SSID and has
348
* already an entry in PMKSA cache.
350
struct rsn_pmksa_cache_entry *
351
pmksa_cache_get_opportunistic(struct rsn_pmksa_cache *pmksa, void *network_ctx,
354
struct rsn_pmksa_cache_entry *entry = pmksa->pmksa;
356
if (network_ctx == NULL)
359
if (entry->network_ctx == network_ctx) {
360
entry = pmksa_cache_clone_entry(pmksa, entry, aa);
362
wpa_printf(MSG_DEBUG, "RSN: added "
363
"opportunistic PMKSA cache entry "
364
"for " MACSTR, MAC2STR(aa));
375
* pmksa_cache_get_current - Get the current used PMKSA entry
376
* @sm: Pointer to WPA state machine data from wpa_sm_init()
377
* Returns: Pointer to the current PMKSA cache entry or %NULL if not available
379
struct rsn_pmksa_cache_entry * pmksa_cache_get_current(struct wpa_sm *sm)
383
return sm->cur_pmksa;
388
* pmksa_cache_clear_current - Clear the current PMKSA entry selection
389
* @sm: Pointer to WPA state machine data from wpa_sm_init()
391
void pmksa_cache_clear_current(struct wpa_sm *sm)
395
sm->cur_pmksa = NULL;
400
* pmksa_cache_set_current - Set the current PMKSA entry selection
401
* @sm: Pointer to WPA state machine data from wpa_sm_init()
402
* @pmkid: PMKID for selecting PMKSA or %NULL if not used
403
* @bssid: BSSID for PMKSA or %NULL if not used
404
* @network_ctx: Network configuration context
405
* @try_opportunistic: Whether to allow opportunistic PMKSA caching
406
* Returns: 0 if PMKSA was found or -1 if no matching entry was found
408
int pmksa_cache_set_current(struct wpa_sm *sm, const u8 *pmkid,
409
const u8 *bssid, void *network_ctx,
410
int try_opportunistic)
412
struct rsn_pmksa_cache *pmksa = sm->pmksa;
413
sm->cur_pmksa = NULL;
415
sm->cur_pmksa = pmksa_cache_get(pmksa, NULL, pmkid);
416
if (sm->cur_pmksa == NULL && bssid)
417
sm->cur_pmksa = pmksa_cache_get(pmksa, bssid, NULL);
418
if (sm->cur_pmksa == NULL && try_opportunistic && bssid)
419
sm->cur_pmksa = pmksa_cache_get_opportunistic(pmksa,
423
wpa_hexdump(MSG_DEBUG, "RSN: PMKID",
424
sm->cur_pmksa->pmkid, PMKID_LEN);
432
* pmksa_cache_list - Dump text list of entries in PMKSA cache
433
* @sm: Pointer to WPA state machine data from wpa_sm_init()
434
* @buf: Buffer for the list
435
* @len: Length of the buffer
436
* Returns: number of bytes written to buffer
438
* This function is used to generate a text format representation of the
439
* current PMKSA cache contents for the ctrl_iface PMKSA command.
441
int pmksa_cache_list(struct wpa_sm *sm, char *buf, size_t len)
445
struct rsn_pmksa_cache_entry *entry;
449
ret = os_snprintf(pos, buf + len - pos,
450
"Index / AA / PMKID / expiration (in seconds) / "
452
if (ret < 0 || ret >= buf + len - pos)
456
entry = sm->pmksa->pmksa;
459
ret = os_snprintf(pos, buf + len - pos, "%d " MACSTR " ",
460
i, MAC2STR(entry->aa));
461
if (ret < 0 || ret >= buf + len - pos)
464
pos += wpa_snprintf_hex(pos, buf + len - pos, entry->pmkid,
466
ret = os_snprintf(pos, buf + len - pos, " %d %d\n",
467
(int) (entry->expiration - now.sec),
468
entry->opportunistic);
469
if (ret < 0 || ret >= buf + len - pos)
479
* pmksa_cache_init - Initialize PMKSA cache
480
* @free_cb: Callback function to be called when a PMKSA cache entry is freed
481
* @ctx: Context pointer for free_cb function
482
* @sm: Pointer to WPA state machine data from wpa_sm_init()
483
* Returns: Pointer to PMKSA cache data or %NULL on failure
485
struct rsn_pmksa_cache *
486
pmksa_cache_init(void (*free_cb)(struct rsn_pmksa_cache_entry *entry,
487
void *ctx, int replace),
488
void *ctx, struct wpa_sm *sm)
490
struct rsn_pmksa_cache *pmksa;
492
pmksa = os_zalloc(sizeof(*pmksa));
494
pmksa->free_cb = free_cb;
502
#endif /* IEEE8021X_EAPOL and !CONFIG_NO_WPA2 */