2 * hostapd / IEEE 802.11 authentication (ACL)
3 * Copyright (c) 2003-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.
8 * Access control list for IEEE 802.11 authentication can uses statically
9 * configured ACL from configuration files or an external RADIUS server.
10 * Results from external RADIUS queries are cached to allow faster
11 * authentication frame processing.
14 #include "utils/includes.h"
16 #include "utils/common.h"
17 #include "utils/eloop.h"
18 #include "radius/radius.h"
19 #include "radius/radius_client.h"
21 #include "ap_config.h"
22 #include "ap_drv_ops.h"
23 #include "ieee802_11.h"
24 #include "ieee802_1x.h"
25 #include "ieee802_11_auth.h"
27 #define RADIUS_ACL_TIMEOUT 30
30 struct hostapd_cached_radius_acl {
31 struct os_reltime timestamp;
33 int accepted; /* HOSTAPD_ACL_* */
34 struct hostapd_cached_radius_acl *next;
36 u32 acct_interim_interval;
37 struct vlan_description vlan_id;
38 struct hostapd_sta_wpa_psk_short *psk;
44 struct hostapd_acl_query_data {
45 struct os_reltime timestamp;
48 u8 *auth_msg; /* IEEE 802.11 authentication frame from station */
50 struct hostapd_acl_query_data *next;
54 #ifndef CONFIG_NO_RADIUS
55 static void hostapd_acl_cache_free_entry(struct hostapd_cached_radius_acl *e)
58 os_free(e->radius_cui);
59 hostapd_free_psk_list(e->psk);
64 static void hostapd_acl_cache_free(struct hostapd_cached_radius_acl *acl_cache)
66 struct hostapd_cached_radius_acl *prev;
70 acl_cache = acl_cache->next;
71 hostapd_acl_cache_free_entry(prev);
76 static void copy_psk_list(struct hostapd_sta_wpa_psk_short **psk,
77 struct hostapd_sta_wpa_psk_short *src)
89 static int hostapd_acl_cache_get(struct hostapd_data *hapd, const u8 *addr,
91 u32 *acct_interim_interval,
92 struct vlan_description *vlan_id,
93 struct hostapd_sta_wpa_psk_short **psk,
94 char **identity, char **radius_cui)
96 struct hostapd_cached_radius_acl *entry;
97 struct os_reltime now;
101 for (entry = hapd->acl_cache; entry; entry = entry->next) {
102 if (os_memcmp(entry->addr, addr, ETH_ALEN) != 0)
105 if (os_reltime_expired(&now, &entry->timestamp,
107 return -1; /* entry has expired */
108 if (entry->accepted == HOSTAPD_ACL_ACCEPT_TIMEOUT)
110 *session_timeout = entry->session_timeout;
111 if (acct_interim_interval)
112 *acct_interim_interval =
113 entry->acct_interim_interval;
115 *vlan_id = entry->vlan_id;
116 copy_psk_list(psk, entry->psk);
119 *identity = os_strdup(entry->identity);
124 if (entry->radius_cui)
125 *radius_cui = os_strdup(entry->radius_cui);
129 return entry->accepted;
134 #endif /* CONFIG_NO_RADIUS */
137 static void hostapd_acl_query_free(struct hostapd_acl_query_data *query)
141 os_free(query->auth_msg);
146 #ifndef CONFIG_NO_RADIUS
147 static int hostapd_radius_acl_query(struct hostapd_data *hapd, const u8 *addr,
148 struct hostapd_acl_query_data *query)
150 struct radius_msg *msg;
153 query->radius_id = radius_client_get_id(hapd->radius);
154 msg = radius_msg_new(RADIUS_CODE_ACCESS_REQUEST, query->radius_id);
158 if (radius_msg_make_authenticator(msg) < 0) {
159 wpa_printf(MSG_INFO, "Could not make Request Authenticator");
163 os_snprintf(buf, sizeof(buf), RADIUS_ADDR_FORMAT, MAC2STR(addr));
164 if (!radius_msg_add_attr(msg, RADIUS_ATTR_USER_NAME, (u8 *) buf,
166 wpa_printf(MSG_DEBUG, "Could not add User-Name");
170 if (!radius_msg_add_attr_user_password(
171 msg, (u8 *) buf, os_strlen(buf),
172 hapd->conf->radius->auth_server->shared_secret,
173 hapd->conf->radius->auth_server->shared_secret_len)) {
174 wpa_printf(MSG_DEBUG, "Could not add User-Password");
178 if (add_common_radius_attr(hapd, hapd->conf->radius_auth_req_attr,
182 os_snprintf(buf, sizeof(buf), RADIUS_802_1X_ADDR_FORMAT,
184 if (!radius_msg_add_attr(msg, RADIUS_ATTR_CALLING_STATION_ID,
185 (u8 *) buf, os_strlen(buf))) {
186 wpa_printf(MSG_DEBUG, "Could not add Calling-Station-Id");
190 os_snprintf(buf, sizeof(buf), "CONNECT 11Mbps 802.11b");
191 if (!radius_msg_add_attr(msg, RADIUS_ATTR_CONNECT_INFO,
192 (u8 *) buf, os_strlen(buf))) {
193 wpa_printf(MSG_DEBUG, "Could not add Connect-Info");
197 if (radius_client_send(hapd->radius, msg, RADIUS_AUTH, addr) < 0)
202 radius_msg_free(msg);
205 #endif /* CONFIG_NO_RADIUS */
209 * hostapd_check_acl - Check a specified STA against accept/deny ACLs
210 * @hapd: hostapd BSS data
211 * @addr: MAC address of the STA
212 * @vlan_id: Buffer for returning VLAN ID
213 * Returns: HOSTAPD_ACL_ACCEPT, HOSTAPD_ACL_REJECT, or HOSTAPD_ACL_PENDING
215 int hostapd_check_acl(struct hostapd_data *hapd, const u8 *addr,
216 struct vlan_description *vlan_id)
218 if (hostapd_maclist_found(hapd->conf->accept_mac,
219 hapd->conf->num_accept_mac, addr, vlan_id))
220 return HOSTAPD_ACL_ACCEPT;
222 if (hostapd_maclist_found(hapd->conf->deny_mac,
223 hapd->conf->num_deny_mac, addr, vlan_id))
224 return HOSTAPD_ACL_REJECT;
226 if (hapd->conf->macaddr_acl == ACCEPT_UNLESS_DENIED)
227 return HOSTAPD_ACL_ACCEPT;
228 if (hapd->conf->macaddr_acl == DENY_UNLESS_ACCEPTED)
229 return HOSTAPD_ACL_REJECT;
231 return HOSTAPD_ACL_PENDING;
236 * hostapd_allowed_address - Check whether a specified STA can be authenticated
237 * @hapd: hostapd BSS data
238 * @addr: MAC address of the STA
239 * @msg: Authentication message
240 * @len: Length of msg in octets
241 * @session_timeout: Buffer for returning session timeout (from RADIUS)
242 * @acct_interim_interval: Buffer for returning account interval (from RADIUS)
243 * @vlan_id: Buffer for returning VLAN ID
244 * @psk: Linked list buffer for returning WPA PSK
245 * @identity: Buffer for returning identity (from RADIUS)
246 * @radius_cui: Buffer for returning CUI (from RADIUS)
247 * @is_probe_req: Whether this query for a Probe Request frame
248 * Returns: HOSTAPD_ACL_ACCEPT, HOSTAPD_ACL_REJECT, or HOSTAPD_ACL_PENDING
250 * The caller is responsible for freeing the returned *identity and *radius_cui
251 * values with os_free().
253 int hostapd_allowed_address(struct hostapd_data *hapd, const u8 *addr,
254 const u8 *msg, size_t len, u32 *session_timeout,
255 u32 *acct_interim_interval,
256 struct vlan_description *vlan_id,
257 struct hostapd_sta_wpa_psk_short **psk,
258 char **identity, char **radius_cui,
264 *session_timeout = 0;
265 if (acct_interim_interval)
266 *acct_interim_interval = 0;
268 os_memset(vlan_id, 0, sizeof(*vlan_id));
276 res = hostapd_check_acl(hapd, addr, vlan_id);
277 if (res != HOSTAPD_ACL_PENDING)
280 if (hapd->conf->macaddr_acl == USE_EXTERNAL_RADIUS_AUTH) {
281 #ifdef CONFIG_NO_RADIUS
282 return HOSTAPD_ACL_REJECT;
283 #else /* CONFIG_NO_RADIUS */
284 struct hostapd_acl_query_data *query;
287 /* Skip RADIUS queries for Probe Request frames to avoid
288 * excessive load on the authentication server. */
289 return HOSTAPD_ACL_ACCEPT;
292 /* Check whether ACL cache has an entry for this station */
293 res = hostapd_acl_cache_get(hapd, addr, session_timeout,
294 acct_interim_interval, vlan_id, psk,
295 identity, radius_cui);
296 if (res == HOSTAPD_ACL_ACCEPT ||
297 res == HOSTAPD_ACL_ACCEPT_TIMEOUT)
299 if (res == HOSTAPD_ACL_REJECT)
300 return HOSTAPD_ACL_REJECT;
302 query = hapd->acl_queries;
304 if (os_memcmp(query->addr, addr, ETH_ALEN) == 0) {
305 /* pending query in RADIUS retransmit queue;
306 * do not generate a new one */
312 os_free(*radius_cui);
315 return HOSTAPD_ACL_PENDING;
320 if (!hapd->conf->radius->auth_server)
321 return HOSTAPD_ACL_REJECT;
323 /* No entry in the cache - query external RADIUS server */
324 query = os_zalloc(sizeof(*query));
326 wpa_printf(MSG_ERROR, "malloc for query data failed");
327 return HOSTAPD_ACL_REJECT;
329 os_get_reltime(&query->timestamp);
330 os_memcpy(query->addr, addr, ETH_ALEN);
331 if (hostapd_radius_acl_query(hapd, addr, query)) {
332 wpa_printf(MSG_DEBUG, "Failed to send Access-Request "
334 hostapd_acl_query_free(query);
335 return HOSTAPD_ACL_REJECT;
338 query->auth_msg = os_memdup(msg, len);
339 if (query->auth_msg == NULL) {
340 wpa_printf(MSG_ERROR, "Failed to allocate memory for "
342 hostapd_acl_query_free(query);
343 return HOSTAPD_ACL_REJECT;
345 query->auth_msg_len = len;
346 query->next = hapd->acl_queries;
347 hapd->acl_queries = query;
349 /* Queued data will be processed in hostapd_acl_recv_radius()
350 * when RADIUS server replies to the sent Access-Request. */
351 return HOSTAPD_ACL_PENDING;
352 #endif /* CONFIG_NO_RADIUS */
355 return HOSTAPD_ACL_REJECT;
359 #ifndef CONFIG_NO_RADIUS
360 static void hostapd_acl_expire_cache(struct hostapd_data *hapd,
361 struct os_reltime *now)
363 struct hostapd_cached_radius_acl *prev, *entry, *tmp;
366 entry = hapd->acl_cache;
369 if (os_reltime_expired(now, &entry->timestamp,
370 RADIUS_ACL_TIMEOUT)) {
371 wpa_printf(MSG_DEBUG, "Cached ACL entry for " MACSTR
372 " has expired.", MAC2STR(entry->addr));
374 prev->next = entry->next;
376 hapd->acl_cache = entry->next;
377 hostapd_drv_set_radius_acl_expire(hapd, entry->addr);
380 hostapd_acl_cache_free_entry(tmp);
390 static void hostapd_acl_expire_queries(struct hostapd_data *hapd,
391 struct os_reltime *now)
393 struct hostapd_acl_query_data *prev, *entry, *tmp;
396 entry = hapd->acl_queries;
399 if (os_reltime_expired(now, &entry->timestamp,
400 RADIUS_ACL_TIMEOUT)) {
401 wpa_printf(MSG_DEBUG, "ACL query for " MACSTR
402 " has expired.", MAC2STR(entry->addr));
404 prev->next = entry->next;
406 hapd->acl_queries = entry->next;
410 hostapd_acl_query_free(tmp);
421 * hostapd_acl_expire - ACL cache expiration callback
422 * @hapd: struct hostapd_data *
424 void hostapd_acl_expire(struct hostapd_data *hapd)
426 struct os_reltime now;
428 os_get_reltime(&now);
429 hostapd_acl_expire_cache(hapd, &now);
430 hostapd_acl_expire_queries(hapd, &now);
434 static void decode_tunnel_passwords(struct hostapd_data *hapd,
435 const u8 *shared_secret,
436 size_t shared_secret_len,
437 struct radius_msg *msg,
438 struct radius_msg *req,
439 struct hostapd_cached_radius_acl *cache)
444 struct hostapd_sta_wpa_psk_short *psk;
447 * Decode all tunnel passwords as PSK and save them into a linked list.
450 passphrase = radius_msg_get_tunnel_password(
451 msg, &passphraselen, shared_secret, shared_secret_len,
454 * Passphrase is NULL iff there is no i-th Tunnel-Password
457 if (passphrase == NULL)
461 * Passphase should be 8..63 chars (to be hashed with SSID)
462 * or 64 chars hex string (no separate hashing with SSID).
465 if (passphraselen < MIN_PASSPHRASE_LEN ||
466 passphraselen > MAX_PASSPHRASE_LEN + 1)
470 * passphrase does not contain the NULL termination.
471 * Add it here as pbkdf2_sha1() requires it.
473 psk = os_zalloc(sizeof(struct hostapd_sta_wpa_psk_short));
475 if ((passphraselen == MAX_PASSPHRASE_LEN + 1) &&
476 (hexstr2bin(passphrase, psk->psk, PMK_LEN) < 0)) {
477 hostapd_logger(hapd, cache->addr,
478 HOSTAPD_MODULE_RADIUS,
479 HOSTAPD_LEVEL_WARNING,
480 "invalid hex string (%d chars) in Tunnel-Password",
483 } else if (passphraselen <= MAX_PASSPHRASE_LEN) {
484 os_memcpy(psk->passphrase, passphrase,
486 psk->is_passphrase = 1;
488 psk->next = cache->psk;
501 * hostapd_acl_recv_radius - Process incoming RADIUS Authentication messages
502 * @msg: RADIUS response message
503 * @req: RADIUS request message
504 * @shared_secret: RADIUS shared secret
505 * @shared_secret_len: Length of shared_secret in octets
506 * @data: Context data (struct hostapd_data *)
507 * Returns: RADIUS_RX_PROCESSED if RADIUS message was a reply to ACL query (and
508 * was processed here) or RADIUS_RX_UNKNOWN if not.
510 static RadiusRxResult
511 hostapd_acl_recv_radius(struct radius_msg *msg, struct radius_msg *req,
512 const u8 *shared_secret, size_t shared_secret_len,
515 struct hostapd_data *hapd = data;
516 struct hostapd_acl_query_data *query, *prev;
517 struct hostapd_cached_radius_acl *cache;
518 struct radius_hdr *hdr = radius_msg_get_hdr(msg);
519 int *untagged, *tagged, *notempty;
521 query = hapd->acl_queries;
524 if (query->radius_id == hdr->identifier)
530 return RADIUS_RX_UNKNOWN;
532 wpa_printf(MSG_DEBUG, "Found matching Access-Request for RADIUS "
533 "message (id=%d)", query->radius_id);
535 if (radius_msg_verify(msg, shared_secret, shared_secret_len, req, 0)) {
536 wpa_printf(MSG_INFO, "Incoming RADIUS packet did not have "
537 "correct authenticator - dropped\n");
538 return RADIUS_RX_INVALID_AUTHENTICATOR;
541 if (hdr->code != RADIUS_CODE_ACCESS_ACCEPT &&
542 hdr->code != RADIUS_CODE_ACCESS_REJECT) {
543 wpa_printf(MSG_DEBUG, "Unknown RADIUS message code %d to ACL "
545 return RADIUS_RX_UNKNOWN;
548 /* Insert Accept/Reject info into ACL cache */
549 cache = os_zalloc(sizeof(*cache));
551 wpa_printf(MSG_DEBUG, "Failed to add ACL cache entry");
554 os_get_reltime(&cache->timestamp);
555 os_memcpy(cache->addr, query->addr, sizeof(cache->addr));
556 if (hdr->code == RADIUS_CODE_ACCESS_ACCEPT) {
560 if (radius_msg_get_attr_int32(msg, RADIUS_ATTR_SESSION_TIMEOUT,
561 &cache->session_timeout) == 0)
562 cache->accepted = HOSTAPD_ACL_ACCEPT_TIMEOUT;
564 cache->accepted = HOSTAPD_ACL_ACCEPT;
566 if (radius_msg_get_attr_int32(
567 msg, RADIUS_ATTR_ACCT_INTERIM_INTERVAL,
568 &cache->acct_interim_interval) == 0 &&
569 cache->acct_interim_interval < 60) {
570 wpa_printf(MSG_DEBUG, "Ignored too small "
571 "Acct-Interim-Interval %d for STA " MACSTR,
572 cache->acct_interim_interval,
573 MAC2STR(query->addr));
574 cache->acct_interim_interval = 0;
577 notempty = &cache->vlan_id.notempty;
578 untagged = &cache->vlan_id.untagged;
579 tagged = cache->vlan_id.tagged;
580 *notempty = !!radius_msg_get_vlanid(msg, untagged,
584 decode_tunnel_passwords(hapd, shared_secret, shared_secret_len,
587 if (radius_msg_get_attr_ptr(msg, RADIUS_ATTR_USER_NAME,
588 &buf, &len, NULL) == 0) {
589 cache->identity = os_zalloc(len + 1);
591 os_memcpy(cache->identity, buf, len);
593 if (radius_msg_get_attr_ptr(
594 msg, RADIUS_ATTR_CHARGEABLE_USER_IDENTITY,
595 &buf, &len, NULL) == 0) {
596 cache->radius_cui = os_zalloc(len + 1);
597 if (cache->radius_cui)
598 os_memcpy(cache->radius_cui, buf, len);
601 if (hapd->conf->wpa_psk_radius == PSK_RADIUS_REQUIRED &&
603 cache->accepted = HOSTAPD_ACL_REJECT;
605 if (cache->vlan_id.notempty &&
606 !hostapd_vlan_valid(hapd->conf->vlan, &cache->vlan_id)) {
607 hostapd_logger(hapd, query->addr,
608 HOSTAPD_MODULE_RADIUS,
610 "Invalid VLAN %d%s received from RADIUS server",
611 cache->vlan_id.untagged,
612 cache->vlan_id.tagged[0] ? "+" : "");
613 os_memset(&cache->vlan_id, 0, sizeof(cache->vlan_id));
615 if (hapd->conf->ssid.dynamic_vlan == DYNAMIC_VLAN_REQUIRED &&
616 !cache->vlan_id.notempty)
617 cache->accepted = HOSTAPD_ACL_REJECT;
619 cache->accepted = HOSTAPD_ACL_REJECT;
620 cache->next = hapd->acl_cache;
621 hapd->acl_cache = cache;
623 #ifdef CONFIG_DRIVER_RADIUS_ACL
624 hostapd_drv_set_radius_acl_auth(hapd, query->addr, cache->accepted,
625 cache->session_timeout);
626 #else /* CONFIG_DRIVER_RADIUS_ACL */
628 /* Re-send original authentication frame for 802.11 processing */
629 wpa_printf(MSG_DEBUG, "Re-sending authentication frame after "
630 "successful RADIUS ACL query");
631 ieee802_11_mgmt(hapd, query->auth_msg, query->auth_msg_len, NULL);
632 #endif /* NEED_AP_MLME */
633 #endif /* CONFIG_DRIVER_RADIUS_ACL */
637 hapd->acl_queries = query->next;
639 prev->next = query->next;
641 hostapd_acl_query_free(query);
643 return RADIUS_RX_PROCESSED;
645 #endif /* CONFIG_NO_RADIUS */
649 * hostapd_acl_init: Initialize IEEE 802.11 ACL
650 * @hapd: hostapd BSS data
651 * Returns: 0 on success, -1 on failure
653 int hostapd_acl_init(struct hostapd_data *hapd)
655 #ifndef CONFIG_NO_RADIUS
656 if (radius_client_register(hapd->radius, RADIUS_AUTH,
657 hostapd_acl_recv_radius, hapd))
659 #endif /* CONFIG_NO_RADIUS */
666 * hostapd_acl_deinit - Deinitialize IEEE 802.11 ACL
667 * @hapd: hostapd BSS data
669 void hostapd_acl_deinit(struct hostapd_data *hapd)
671 struct hostapd_acl_query_data *query, *prev;
673 #ifndef CONFIG_NO_RADIUS
674 hostapd_acl_cache_free(hapd->acl_cache);
675 hapd->acl_cache = NULL;
676 #endif /* CONFIG_NO_RADIUS */
678 query = hapd->acl_queries;
679 hapd->acl_queries = NULL;
683 hostapd_acl_query_free(prev);
688 void hostapd_free_psk_list(struct hostapd_sta_wpa_psk_short *psk)
690 if (psk && psk->ref) {
691 /* This will be freed when the last reference is dropped. */
697 struct hostapd_sta_wpa_psk_short *prev = psk;