2 * hostapd - PMKSA cache for IEEE 802.11i RSN
3 * Copyright (c) 2004-2008, 2012, 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"
16 #include "ap_config.h"
17 #include "pmksa_cache_auth.h"
20 static const int pmksa_cache_max_entries
= 1024;
21 static const int dot11RSNAConfigPMKLifetime
= 43200;
23 struct rsn_pmksa_cache
{
24 #define PMKID_HASH_SIZE 128
25 #define PMKID_HASH(pmkid) (unsigned int) ((pmkid)[0] & 0x7f)
26 struct rsn_pmksa_cache_entry
*pmkid
[PMKID_HASH_SIZE
];
27 struct rsn_pmksa_cache_entry
*pmksa
;
30 void (*free_cb
)(struct rsn_pmksa_cache_entry
*entry
, void *ctx
);
35 static void pmksa_cache_set_expiration(struct rsn_pmksa_cache
*pmksa
);
38 static void _pmksa_cache_free_entry(struct rsn_pmksa_cache_entry
*entry
)
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 */
51 static 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
;
57 pmksa
->free_cb(entry
, pmksa
->ctx
);
58 pos
= pmksa
->pmkid
[PMKID_HASH(entry
->pmkid
)];
63 prev
->hnext
= pos
->hnext
;
65 pmksa
->pmkid
[PMKID_HASH(entry
->pmkid
)] =
79 prev
->next
= pos
->next
;
81 pmksa
->pmksa
= pos
->next
;
87 _pmksa_cache_free_entry(entry
);
91 static void pmksa_cache_expire(void *eloop_ctx
, void *timeout_ctx
)
93 struct rsn_pmksa_cache
*pmksa
= eloop_ctx
;
97 while (pmksa
->pmksa
&& pmksa
->pmksa
->expiration
<= now
.sec
) {
98 wpa_printf(MSG_DEBUG
, "RSN: expired PMKSA cache entry for "
99 MACSTR
, MAC2STR(pmksa
->pmksa
->spa
));
100 pmksa_cache_free_entry(pmksa
, pmksa
->pmksa
);
103 pmksa_cache_set_expiration(pmksa
);
107 static void pmksa_cache_set_expiration(struct rsn_pmksa_cache
*pmksa
)
112 eloop_cancel_timeout(pmksa_cache_expire
, pmksa
, NULL
);
113 if (pmksa
->pmksa
== NULL
)
116 sec
= pmksa
->pmksa
->expiration
- now
.sec
;
119 eloop_register_timeout(sec
+ 1, 0, pmksa_cache_expire
, pmksa
, NULL
);
123 static void pmksa_cache_from_eapol_data(struct rsn_pmksa_cache_entry
*entry
,
124 struct eapol_state_machine
*eapol
)
129 if (eapol
->identity
) {
130 entry
->identity
= os_malloc(eapol
->identity_len
);
131 if (entry
->identity
) {
132 entry
->identity_len
= eapol
->identity_len
;
133 os_memcpy(entry
->identity
, eapol
->identity
,
134 eapol
->identity_len
);
138 if (eapol
->radius_cui
)
139 entry
->cui
= wpabuf_dup(eapol
->radius_cui
);
141 #ifndef CONFIG_NO_RADIUS
142 radius_copy_class(&entry
->radius_class
, &eapol
->radius_class
);
143 #endif /* CONFIG_NO_RADIUS */
145 entry
->eap_type_authsrv
= eapol
->eap_type_authsrv
;
146 entry
->vlan_id
= ((struct sta_info
*) eapol
->sta
)->vlan_id
;
150 void pmksa_cache_to_eapol_data(struct rsn_pmksa_cache_entry
*entry
,
151 struct eapol_state_machine
*eapol
)
153 if (entry
== NULL
|| eapol
== NULL
)
156 if (entry
->identity
) {
157 os_free(eapol
->identity
);
158 eapol
->identity
= os_malloc(entry
->identity_len
);
159 if (eapol
->identity
) {
160 eapol
->identity_len
= entry
->identity_len
;
161 os_memcpy(eapol
->identity
, entry
->identity
,
162 entry
->identity_len
);
164 wpa_hexdump_ascii(MSG_DEBUG
, "STA identity from PMKSA",
165 eapol
->identity
, eapol
->identity_len
);
169 wpabuf_free(eapol
->radius_cui
);
170 eapol
->radius_cui
= wpabuf_dup(entry
->cui
);
173 #ifndef CONFIG_NO_RADIUS
174 radius_free_class(&eapol
->radius_class
);
175 radius_copy_class(&eapol
->radius_class
, &entry
->radius_class
);
176 #endif /* CONFIG_NO_RADIUS */
177 if (eapol
->radius_class
.attr
) {
178 wpa_printf(MSG_DEBUG
, "Copied %lu Class attribute(s) from "
179 "PMKSA", (unsigned long) eapol
->radius_class
.count
);
182 eapol
->eap_type_authsrv
= entry
->eap_type_authsrv
;
183 ((struct sta_info
*) eapol
->sta
)->vlan_id
= entry
->vlan_id
;
187 static void pmksa_cache_link_entry(struct rsn_pmksa_cache
*pmksa
,
188 struct rsn_pmksa_cache_entry
*entry
)
190 struct rsn_pmksa_cache_entry
*pos
, *prev
;
192 /* Add the new entry; order by expiration time */
196 if (pos
->expiration
> entry
->expiration
)
202 entry
->next
= pmksa
->pmksa
;
203 pmksa
->pmksa
= entry
;
205 entry
->next
= prev
->next
;
208 entry
->hnext
= pmksa
->pmkid
[PMKID_HASH(entry
->pmkid
)];
209 pmksa
->pmkid
[PMKID_HASH(entry
->pmkid
)] = entry
;
211 pmksa
->pmksa_count
++;
212 wpa_printf(MSG_DEBUG
, "RSN: added PMKSA cache entry for " MACSTR
,
213 MAC2STR(entry
->spa
));
214 wpa_hexdump(MSG_DEBUG
, "RSN: added PMKID", entry
->pmkid
, PMKID_LEN
);
219 * pmksa_cache_auth_add - Add a PMKSA cache entry
220 * @pmksa: Pointer to PMKSA cache data from pmksa_cache_auth_init()
221 * @pmk: The new pairwise master key
222 * @pmk_len: PMK length in bytes, usually PMK_LEN (32)
223 * @aa: Authenticator address
224 * @spa: Supplicant address
225 * @session_timeout: Session timeout
226 * @eapol: Pointer to EAPOL state machine data
227 * @akmp: WPA_KEY_MGMT_* used in key derivation
228 * Returns: Pointer to the added PMKSA cache entry or %NULL on error
230 * This function create a PMKSA entry for a new PMK and adds it to the PMKSA
231 * cache. If an old entry is already in the cache for the same Supplicant,
232 * this entry will be replaced with the new entry. PMKID will be calculated
235 struct rsn_pmksa_cache_entry
*
236 pmksa_cache_auth_add(struct rsn_pmksa_cache
*pmksa
,
237 const u8
*pmk
, size_t pmk_len
,
238 const u8
*aa
, const u8
*spa
, int session_timeout
,
239 struct eapol_state_machine
*eapol
, int akmp
)
241 struct rsn_pmksa_cache_entry
*entry
, *pos
;
244 if (pmk_len
> PMK_LEN
)
247 entry
= os_zalloc(sizeof(*entry
));
250 os_memcpy(entry
->pmk
, pmk
, pmk_len
);
251 entry
->pmk_len
= pmk_len
;
252 rsn_pmkid(pmk
, pmk_len
, aa
, spa
, entry
->pmkid
,
253 wpa_key_mgmt_sha256(akmp
));
255 entry
->expiration
= now
.sec
;
256 if (session_timeout
> 0)
257 entry
->expiration
+= session_timeout
;
259 entry
->expiration
+= dot11RSNAConfigPMKLifetime
;
261 os_memcpy(entry
->spa
, spa
, ETH_ALEN
);
262 pmksa_cache_from_eapol_data(entry
, eapol
);
264 /* Replace an old entry for the same STA (if found) with the new entry
266 pos
= pmksa_cache_auth_get(pmksa
, spa
, NULL
);
268 pmksa_cache_free_entry(pmksa
, pos
);
270 if (pmksa
->pmksa_count
>= pmksa_cache_max_entries
&& pmksa
->pmksa
) {
271 /* Remove the oldest entry to make room for the new entry */
272 wpa_printf(MSG_DEBUG
, "RSN: removed the oldest PMKSA cache "
273 "entry (for " MACSTR
") to make room for new one",
274 MAC2STR(pmksa
->pmksa
->spa
));
275 pmksa_cache_free_entry(pmksa
, pmksa
->pmksa
);
278 pmksa_cache_link_entry(pmksa
, entry
);
284 struct rsn_pmksa_cache_entry
*
285 pmksa_cache_add_okc(struct rsn_pmksa_cache
*pmksa
,
286 const struct rsn_pmksa_cache_entry
*old_entry
,
287 const u8
*aa
, const u8
*pmkid
)
289 struct rsn_pmksa_cache_entry
*entry
;
291 entry
= os_zalloc(sizeof(*entry
));
294 os_memcpy(entry
->pmkid
, pmkid
, PMKID_LEN
);
295 os_memcpy(entry
->pmk
, old_entry
->pmk
, old_entry
->pmk_len
);
296 entry
->pmk_len
= old_entry
->pmk_len
;
297 entry
->expiration
= old_entry
->expiration
;
298 entry
->akmp
= old_entry
->akmp
;
299 os_memcpy(entry
->spa
, old_entry
->spa
, ETH_ALEN
);
300 entry
->opportunistic
= 1;
301 if (old_entry
->identity
) {
302 entry
->identity
= os_malloc(old_entry
->identity_len
);
303 if (entry
->identity
) {
304 entry
->identity_len
= old_entry
->identity_len
;
305 os_memcpy(entry
->identity
, old_entry
->identity
,
306 old_entry
->identity_len
);
310 entry
->cui
= wpabuf_dup(old_entry
->cui
);
311 #ifndef CONFIG_NO_RADIUS
312 radius_copy_class(&entry
->radius_class
, &old_entry
->radius_class
);
313 #endif /* CONFIG_NO_RADIUS */
314 entry
->eap_type_authsrv
= old_entry
->eap_type_authsrv
;
315 entry
->vlan_id
= old_entry
->vlan_id
;
316 entry
->opportunistic
= 1;
318 pmksa_cache_link_entry(pmksa
, entry
);
325 * pmksa_cache_auth_deinit - Free all entries in PMKSA cache
326 * @pmksa: Pointer to PMKSA cache data from pmksa_cache_auth_init()
328 void pmksa_cache_auth_deinit(struct rsn_pmksa_cache
*pmksa
)
330 struct rsn_pmksa_cache_entry
*entry
, *prev
;
336 entry
= pmksa
->pmksa
;
340 _pmksa_cache_free_entry(prev
);
342 eloop_cancel_timeout(pmksa_cache_expire
, pmksa
, NULL
);
343 for (i
= 0; i
< PMKID_HASH_SIZE
; i
++)
344 pmksa
->pmkid
[i
] = NULL
;
350 * pmksa_cache_auth_get - Fetch a PMKSA cache entry
351 * @pmksa: Pointer to PMKSA cache data from pmksa_cache_auth_init()
352 * @spa: Supplicant address or %NULL to match any
353 * @pmkid: PMKID or %NULL to match any
354 * Returns: Pointer to PMKSA cache entry or %NULL if no match was found
356 struct rsn_pmksa_cache_entry
*
357 pmksa_cache_auth_get(struct rsn_pmksa_cache
*pmksa
,
358 const u8
*spa
, const u8
*pmkid
)
360 struct rsn_pmksa_cache_entry
*entry
;
363 entry
= pmksa
->pmkid
[PMKID_HASH(pmkid
)];
365 entry
= pmksa
->pmksa
;
368 os_memcmp(entry
->spa
, spa
, ETH_ALEN
) == 0) &&
370 os_memcmp(entry
->pmkid
, pmkid
, PMKID_LEN
) == 0))
372 entry
= pmkid
? entry
->hnext
: entry
->next
;
379 * pmksa_cache_get_okc - Fetch a PMKSA cache entry using OKC
380 * @pmksa: Pointer to PMKSA cache data from pmksa_cache_auth_init()
381 * @aa: Authenticator address
382 * @spa: Supplicant address
384 * Returns: Pointer to PMKSA cache entry or %NULL if no match was found
386 * Use opportunistic key caching (OKC) to find a PMK for a supplicant.
388 struct rsn_pmksa_cache_entry
* pmksa_cache_get_okc(
389 struct rsn_pmksa_cache
*pmksa
, const u8
*aa
, const u8
*spa
,
392 struct rsn_pmksa_cache_entry
*entry
;
393 u8 new_pmkid
[PMKID_LEN
];
395 entry
= pmksa
->pmksa
;
397 if (os_memcmp(entry
->spa
, spa
, ETH_ALEN
) != 0)
399 rsn_pmkid(entry
->pmk
, entry
->pmk_len
, aa
, spa
, new_pmkid
,
400 wpa_key_mgmt_sha256(entry
->akmp
));
401 if (os_memcmp(new_pmkid
, pmkid
, PMKID_LEN
) == 0)
410 * pmksa_cache_auth_init - Initialize PMKSA cache
411 * @free_cb: Callback function to be called when a PMKSA cache entry is freed
412 * @ctx: Context pointer for free_cb function
413 * Returns: Pointer to PMKSA cache data or %NULL on failure
415 struct rsn_pmksa_cache
*
416 pmksa_cache_auth_init(void (*free_cb
)(struct rsn_pmksa_cache_entry
*entry
,
417 void *ctx
), void *ctx
)
419 struct rsn_pmksa_cache
*pmksa
;
421 pmksa
= os_zalloc(sizeof(*pmksa
));
423 pmksa
->free_cb
= free_cb
;