hostapd: Add Automatic Channel Selection (ACS) support
[mech_eap.git] / src / ap / ap_config.h
1 /*
2  * hostapd / Configuration definitions and helpers functions
3  * Copyright (c) 2003-2012, 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 #ifndef HOSTAPD_CONFIG_H
10 #define HOSTAPD_CONFIG_H
11
12 #include "common/defs.h"
13 #include "ip_addr.h"
14 #include "common/wpa_common.h"
15 #include "common/ieee802_11_common.h"
16 #include "wps/wps.h"
17
18 #define MAX_STA_COUNT 2007
19 #define MAX_VLAN_ID 4094
20
21 typedef u8 macaddr[ETH_ALEN];
22
23 struct mac_acl_entry {
24         macaddr addr;
25         int vlan_id;
26 };
27
28 struct hostapd_radius_servers;
29 struct ft_remote_r0kh;
30 struct ft_remote_r1kh;
31
32 #define HOSTAPD_MAX_SSID_LEN 32
33
34 #define NUM_WEP_KEYS 4
35 struct hostapd_wep_keys {
36         u8 idx;
37         u8 *key[NUM_WEP_KEYS];
38         size_t len[NUM_WEP_KEYS];
39         int keys_set;
40         size_t default_len; /* key length used for dynamic key generation */
41 };
42
43 typedef enum hostap_security_policy {
44         SECURITY_PLAINTEXT = 0,
45         SECURITY_STATIC_WEP = 1,
46         SECURITY_IEEE_802_1X = 2,
47         SECURITY_WPA_PSK = 3,
48         SECURITY_WPA = 4
49 } secpolicy;
50
51 struct hostapd_ssid {
52         u8 ssid[HOSTAPD_MAX_SSID_LEN];
53         size_t ssid_len;
54         unsigned int ssid_set:1;
55         unsigned int utf8_ssid:1;
56
57         char vlan[IFNAMSIZ + 1];
58         secpolicy security_policy;
59
60         struct hostapd_wpa_psk *wpa_psk;
61         char *wpa_passphrase;
62         char *wpa_psk_file;
63
64         struct hostapd_wep_keys wep;
65
66 #define DYNAMIC_VLAN_DISABLED 0
67 #define DYNAMIC_VLAN_OPTIONAL 1
68 #define DYNAMIC_VLAN_REQUIRED 2
69         int dynamic_vlan;
70 #define DYNAMIC_VLAN_NAMING_WITHOUT_DEVICE 0
71 #define DYNAMIC_VLAN_NAMING_WITH_DEVICE 1
72 #define DYNAMIC_VLAN_NAMING_END 2
73         int vlan_naming;
74 #ifdef CONFIG_FULL_DYNAMIC_VLAN
75         char *vlan_tagged_interface;
76 #endif /* CONFIG_FULL_DYNAMIC_VLAN */
77 };
78
79
80 #define VLAN_ID_WILDCARD -1
81
82 struct hostapd_vlan {
83         struct hostapd_vlan *next;
84         int vlan_id; /* VLAN ID or -1 (VLAN_ID_WILDCARD) for wildcard entry */
85         char ifname[IFNAMSIZ + 1];
86         int dynamic_vlan;
87 #ifdef CONFIG_FULL_DYNAMIC_VLAN
88
89 #define DVLAN_CLEAN_BR  0x1
90 #define DVLAN_CLEAN_VLAN        0x2
91 #define DVLAN_CLEAN_VLAN_PORT   0x4
92 #define DVLAN_CLEAN_WLAN_PORT   0x8
93         int clean;
94 #endif /* CONFIG_FULL_DYNAMIC_VLAN */
95 };
96
97 #define PMK_LEN 32
98 struct hostapd_sta_wpa_psk_short {
99         struct hostapd_sta_wpa_psk_short *next;
100         u8 psk[PMK_LEN];
101 };
102
103 struct hostapd_wpa_psk {
104         struct hostapd_wpa_psk *next;
105         int group;
106         u8 psk[PMK_LEN];
107         u8 addr[ETH_ALEN];
108 };
109
110 struct hostapd_eap_user {
111         struct hostapd_eap_user *next;
112         u8 *identity;
113         size_t identity_len;
114         struct {
115                 int vendor;
116                 u32 method;
117         } methods[EAP_MAX_METHODS];
118         u8 *password;
119         size_t password_len;
120         int phase2;
121         int force_version;
122         unsigned int wildcard_prefix:1;
123         unsigned int password_hash:1; /* whether password is hashed with
124                                        * nt_password_hash() */
125         int ttls_auth; /* EAP_TTLS_AUTH_* bitfield */
126 };
127
128 struct hostapd_radius_attr {
129         u8 type;
130         struct wpabuf *val;
131         struct hostapd_radius_attr *next;
132 };
133
134
135 #define NUM_TX_QUEUES 4
136
137 struct hostapd_tx_queue_params {
138         int aifs;
139         int cwmin;
140         int cwmax;
141         int burst; /* maximum burst time in 0.1 ms, i.e., 10 = 1 ms */
142 };
143
144
145 #define MAX_ROAMING_CONSORTIUM_LEN 15
146
147 struct hostapd_roaming_consortium {
148         u8 len;
149         u8 oi[MAX_ROAMING_CONSORTIUM_LEN];
150 };
151
152 struct hostapd_lang_string {
153         u8 lang[3];
154         u8 name_len;
155         u8 name[252];
156 };
157
158 #define MAX_NAI_REALMS 10
159 #define MAX_NAI_REALMLEN 255
160 #define MAX_NAI_EAP_METHODS 5
161 #define MAX_NAI_AUTH_TYPES 4
162 struct hostapd_nai_realm_data {
163         u8 encoding;
164         char realm_buf[MAX_NAI_REALMLEN + 1];
165         char *realm[MAX_NAI_REALMS];
166         u8 eap_method_count;
167         struct hostapd_nai_realm_eap {
168                 u8 eap_method;
169                 u8 num_auths;
170                 u8 auth_id[MAX_NAI_AUTH_TYPES];
171                 u8 auth_val[MAX_NAI_AUTH_TYPES];
172         } eap_method[MAX_NAI_EAP_METHODS];
173 };
174
175 /**
176  * struct hostapd_bss_config - Per-BSS configuration
177  */
178 struct hostapd_bss_config {
179         char iface[IFNAMSIZ + 1];
180         char bridge[IFNAMSIZ + 1];
181         char vlan_bridge[IFNAMSIZ + 1];
182         char wds_bridge[IFNAMSIZ + 1];
183
184         enum hostapd_logger_level logger_syslog_level, logger_stdout_level;
185
186         unsigned int logger_syslog; /* module bitfield */
187         unsigned int logger_stdout; /* module bitfield */
188
189         char *dump_log_name; /* file name for state dump (SIGUSR1) */
190
191         int max_num_sta; /* maximum number of STAs in station table */
192
193         int dtim_period;
194
195         int ieee802_1x; /* use IEEE 802.1X */
196         int eapol_version;
197         int eap_server; /* Use internal EAP server instead of external
198                          * RADIUS server */
199         struct hostapd_eap_user *eap_user;
200         char *eap_user_sqlite;
201         char *eap_sim_db;
202         struct hostapd_ip_addr own_ip_addr;
203         char *nas_identifier;
204         struct hostapd_radius_servers *radius;
205         int acct_interim_interval;
206         int radius_request_cui;
207         struct hostapd_radius_attr *radius_auth_req_attr;
208         struct hostapd_radius_attr *radius_acct_req_attr;
209         int radius_das_port;
210         unsigned int radius_das_time_window;
211         int radius_das_require_event_timestamp;
212         struct hostapd_ip_addr radius_das_client_addr;
213         u8 *radius_das_shared_secret;
214         size_t radius_das_shared_secret_len;
215
216         struct hostapd_ssid ssid;
217
218         char *eap_req_id_text; /* optional displayable message sent with
219                                 * EAP Request-Identity */
220         size_t eap_req_id_text_len;
221         int eapol_key_index_workaround;
222
223         size_t default_wep_key_len;
224         int individual_wep_key_len;
225         int wep_rekeying_period;
226         int broadcast_key_idx_min, broadcast_key_idx_max;
227         int eap_reauth_period;
228
229         int ieee802_11f; /* use IEEE 802.11f (IAPP) */
230         char iapp_iface[IFNAMSIZ + 1]; /* interface used with IAPP broadcast
231                                         * frames */
232
233         enum {
234                 ACCEPT_UNLESS_DENIED = 0,
235                 DENY_UNLESS_ACCEPTED = 1,
236                 USE_EXTERNAL_RADIUS_AUTH = 2
237         } macaddr_acl;
238         struct mac_acl_entry *accept_mac;
239         int num_accept_mac;
240         struct mac_acl_entry *deny_mac;
241         int num_deny_mac;
242         int wds_sta;
243         int isolate;
244         int start_disabled;
245
246         int auth_algs; /* bitfield of allowed IEEE 802.11 authentication
247                         * algorithms, WPA_AUTH_ALG_{OPEN,SHARED,LEAP} */
248
249         int wpa; /* bitfield of WPA_PROTO_WPA, WPA_PROTO_RSN */
250         int wpa_key_mgmt;
251 #ifdef CONFIG_IEEE80211W
252         enum mfp_options ieee80211w;
253         /* dot11AssociationSAQueryMaximumTimeout (in TUs) */
254         unsigned int assoc_sa_query_max_timeout;
255         /* dot11AssociationSAQueryRetryTimeout (in TUs) */
256         int assoc_sa_query_retry_timeout;
257 #endif /* CONFIG_IEEE80211W */
258         enum {
259                 PSK_RADIUS_IGNORED = 0,
260                 PSK_RADIUS_ACCEPTED = 1,
261                 PSK_RADIUS_REQUIRED = 2
262         } wpa_psk_radius;
263         int wpa_pairwise;
264         int wpa_group;
265         int wpa_group_rekey;
266         int wpa_strict_rekey;
267         int wpa_gmk_rekey;
268         int wpa_ptk_rekey;
269         int rsn_pairwise;
270         int rsn_preauth;
271         char *rsn_preauth_interfaces;
272         int peerkey;
273
274 #ifdef CONFIG_IEEE80211R
275         /* IEEE 802.11r - Fast BSS Transition */
276         u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
277         u8 r1_key_holder[FT_R1KH_ID_LEN];
278         u32 r0_key_lifetime;
279         u32 reassociation_deadline;
280         struct ft_remote_r0kh *r0kh_list;
281         struct ft_remote_r1kh *r1kh_list;
282         int pmk_r1_push;
283         int ft_over_ds;
284 #endif /* CONFIG_IEEE80211R */
285
286         char *ctrl_interface; /* directory for UNIX domain sockets */
287 #ifndef CONFIG_NATIVE_WINDOWS
288         gid_t ctrl_interface_gid;
289 #endif /* CONFIG_NATIVE_WINDOWS */
290         int ctrl_interface_gid_set;
291
292         char *ca_cert;
293         char *server_cert;
294         char *private_key;
295         char *private_key_passwd;
296         int check_crl;
297         char *ocsp_stapling_response;
298         char *dh_file;
299         u8 *pac_opaque_encr_key;
300         u8 *eap_fast_a_id;
301         size_t eap_fast_a_id_len;
302         char *eap_fast_a_id_info;
303         int eap_fast_prov;
304         int pac_key_lifetime;
305         int pac_key_refresh_time;
306         int eap_sim_aka_result_ind;
307         int tnc;
308         int fragment_size;
309         u16 pwd_group;
310
311         char *radius_server_clients;
312         int radius_server_auth_port;
313         int radius_server_ipv6;
314
315         char *test_socket; /* UNIX domain socket path for driver_test */
316
317         int use_pae_group_addr; /* Whether to send EAPOL frames to PAE group
318                                  * address instead of individual address
319                                  * (for driver_wired.c).
320                                  */
321
322         int ap_max_inactivity;
323         int ignore_broadcast_ssid;
324
325         int wmm_enabled;
326         int wmm_uapsd;
327
328         struct hostapd_vlan *vlan;
329
330         macaddr bssid;
331
332         /*
333          * Maximum listen interval that STAs can use when associating with this
334          * BSS. If a STA tries to use larger value, the association will be
335          * denied with status code 51.
336          */
337         u16 max_listen_interval;
338
339         int disable_pmksa_caching;
340         int okc; /* Opportunistic Key Caching */
341
342         int wps_state;
343 #ifdef CONFIG_WPS
344         int wps_independent;
345         int ap_setup_locked;
346         u8 uuid[16];
347         char *wps_pin_requests;
348         char *device_name;
349         char *manufacturer;
350         char *model_name;
351         char *model_number;
352         char *serial_number;
353         u8 device_type[WPS_DEV_TYPE_LEN];
354         char *config_methods;
355         u8 os_version[4];
356         char *ap_pin;
357         int skip_cred_build;
358         u8 *extra_cred;
359         size_t extra_cred_len;
360         int wps_cred_processing;
361         u8 *ap_settings;
362         size_t ap_settings_len;
363         char *upnp_iface;
364         char *friendly_name;
365         char *manufacturer_url;
366         char *model_description;
367         char *model_url;
368         char *upc;
369         struct wpabuf *wps_vendor_ext[MAX_WPS_VENDOR_EXTENSIONS];
370         int wps_nfc_pw_from_config;
371         int wps_nfc_dev_pw_id;
372         struct wpabuf *wps_nfc_dh_pubkey;
373         struct wpabuf *wps_nfc_dh_privkey;
374         struct wpabuf *wps_nfc_dev_pw;
375 #endif /* CONFIG_WPS */
376         int pbc_in_m1;
377         char *server_id;
378
379 #define P2P_ENABLED BIT(0)
380 #define P2P_GROUP_OWNER BIT(1)
381 #define P2P_GROUP_FORMATION BIT(2)
382 #define P2P_MANAGE BIT(3)
383 #define P2P_ALLOW_CROSS_CONNECTION BIT(4)
384         int p2p;
385
386         int disassoc_low_ack;
387         int skip_inactivity_poll;
388
389 #define TDLS_PROHIBIT BIT(0)
390 #define TDLS_PROHIBIT_CHAN_SWITCH BIT(1)
391         int tdls;
392         int disable_11n;
393         int disable_11ac;
394
395         /* IEEE 802.11v */
396         int time_advertisement;
397         char *time_zone;
398         int wnm_sleep_mode;
399         int bss_transition;
400
401         /* IEEE 802.11u - Interworking */
402         int interworking;
403         int access_network_type;
404         int internet;
405         int asra;
406         int esr;
407         int uesa;
408         int venue_info_set;
409         u8 venue_group;
410         u8 venue_type;
411         u8 hessid[ETH_ALEN];
412
413         /* IEEE 802.11u - Roaming Consortium list */
414         unsigned int roaming_consortium_count;
415         struct hostapd_roaming_consortium *roaming_consortium;
416
417         /* IEEE 802.11u - Venue Name duples */
418         unsigned int venue_name_count;
419         struct hostapd_lang_string *venue_name;
420
421         /* IEEE 802.11u - Network Authentication Type */
422         u8 *network_auth_type;
423         size_t network_auth_type_len;
424
425         /* IEEE 802.11u - IP Address Type Availability */
426         u8 ipaddr_type_availability;
427         u8 ipaddr_type_configured;
428
429         /* IEEE 802.11u - 3GPP Cellular Network */
430         u8 *anqp_3gpp_cell_net;
431         size_t anqp_3gpp_cell_net_len;
432
433         /* IEEE 802.11u - Domain Name */
434         u8 *domain_name;
435         size_t domain_name_len;
436
437         unsigned int nai_realm_count;
438         struct hostapd_nai_realm_data *nai_realm_data;
439
440         u16 gas_comeback_delay;
441         int gas_frag_limit;
442
443 #ifdef CONFIG_HS20
444         int hs20;
445         int disable_dgaf;
446         unsigned int hs20_oper_friendly_name_count;
447         struct hostapd_lang_string *hs20_oper_friendly_name;
448         u8 *hs20_wan_metrics;
449         u8 *hs20_connection_capability;
450         size_t hs20_connection_capability_len;
451         u8 *hs20_operating_class;
452         u8 hs20_operating_class_len;
453 #endif /* CONFIG_HS20 */
454
455         u8 wps_rf_bands; /* RF bands for WPS (WPS_RF_*) */
456
457 #ifdef CONFIG_RADIUS_TEST
458         char *dump_msk_file;
459 #endif /* CONFIG_RADIUS_TEST */
460
461         struct wpabuf *vendor_elements;
462
463         unsigned int sae_anti_clogging_threshold;
464         int *sae_groups;
465 };
466
467
468 /**
469  * struct hostapd_config - Per-radio interface configuration
470  */
471 struct hostapd_config {
472         struct hostapd_bss_config *bss, *last_bss;
473         size_t num_bss;
474
475         u16 beacon_int;
476         int rts_threshold;
477         int fragm_threshold;
478         u8 send_probe_response;
479         u8 channel;
480         enum hostapd_hw_mode hw_mode; /* HOSTAPD_MODE_IEEE80211A, .. */
481         enum {
482                 LONG_PREAMBLE = 0,
483                 SHORT_PREAMBLE = 1
484         } preamble;
485
486         int *supported_rates;
487         int *basic_rates;
488
489         const struct wpa_driver_ops *driver;
490
491         int ap_table_max_size;
492         int ap_table_expiration_time;
493
494         char country[3]; /* first two octets: country code as described in
495                           * ISO/IEC 3166-1. Third octet:
496                           * ' ' (ascii 32): all environments
497                           * 'O': Outdoor environemnt only
498                           * 'I': Indoor environment only
499                           */
500
501         int ieee80211d;
502
503         int ieee80211h; /* DFS */
504
505         struct hostapd_tx_queue_params tx_queue[NUM_TX_QUEUES];
506
507         /*
508          * WMM AC parameters, in same order as 802.1D, i.e.
509          * 0 = BE (best effort)
510          * 1 = BK (background)
511          * 2 = VI (video)
512          * 3 = VO (voice)
513          */
514         struct hostapd_wmm_ac_params wmm_ac_params[4];
515
516         int ht_op_mode_fixed;
517         u16 ht_capab;
518         int ieee80211n;
519         int secondary_channel;
520         int require_ht;
521         u32 vht_capab;
522         int ieee80211ac;
523         int require_vht;
524         u8 vht_oper_chwidth;
525         u8 vht_oper_centr_freq_seg0_idx;
526         u8 vht_oper_centr_freq_seg1_idx;
527
528 #ifdef CONFIG_TESTING_OPTIONS
529         double ignore_probe_probability;
530         double ignore_auth_probability;
531         double ignore_assoc_probability;
532         double ignore_reassoc_probability;
533         double corrupt_gtk_rekey_mic_probability;
534 #endif /* CONFIG_TESTING_OPTIONS */
535
536 #ifdef CONFIG_ACS
537         unsigned int acs_num_scans;
538 #endif /* CONFIG_ACS */
539 };
540
541
542 int hostapd_mac_comp(const void *a, const void *b);
543 int hostapd_mac_comp_empty(const void *a);
544 struct hostapd_config * hostapd_config_defaults(void);
545 void hostapd_config_defaults_bss(struct hostapd_bss_config *bss);
546 void hostapd_config_free(struct hostapd_config *conf);
547 int hostapd_maclist_found(struct mac_acl_entry *list, int num_entries,
548                           const u8 *addr, int *vlan_id);
549 int hostapd_rate_found(int *list, int rate);
550 int hostapd_wep_key_cmp(struct hostapd_wep_keys *a,
551                         struct hostapd_wep_keys *b);
552 const u8 * hostapd_get_psk(const struct hostapd_bss_config *conf,
553                            const u8 *addr, const u8 *prev_psk);
554 int hostapd_setup_wpa_psk(struct hostapd_bss_config *conf);
555 int hostapd_vlan_id_valid(struct hostapd_vlan *vlan, int vlan_id);
556 const char * hostapd_get_vlan_id_ifname(struct hostapd_vlan *vlan,
557                                         int vlan_id);
558 struct hostapd_radius_attr *
559 hostapd_config_get_radius_attr(struct hostapd_radius_attr *attr, u8 type);
560
561 #endif /* HOSTAPD_CONFIG_H */