ap_config.h revision 303975
1/*
2 * hostapd / Configuration definitions and helpers functions
3 * Copyright (c) 2003-2015, 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_defs.h"
16#include "common/ieee802_11_common.h"
17#include "wps/wps.h"
18#include "fst/fst.h"
19
20/**
21 * mesh_conf - local MBSS state and settings
22 */
23struct mesh_conf {
24	u8 meshid[32];
25	u8 meshid_len;
26	/* Active Path Selection Protocol Identifier */
27	u8 mesh_pp_id;
28	/* Active Path Selection Metric Identifier */
29	u8 mesh_pm_id;
30	/* Congestion Control Mode Identifier */
31	u8 mesh_cc_id;
32	/* Synchronization Protocol Identifier */
33	u8 mesh_sp_id;
34	/* Authentication Protocol Identifier */
35	u8 mesh_auth_id;
36	u8 *rsn_ie;
37	int rsn_ie_len;
38#define MESH_CONF_SEC_NONE BIT(0)
39#define MESH_CONF_SEC_AUTH BIT(1)
40#define MESH_CONF_SEC_AMPE BIT(2)
41	unsigned int security;
42	int dot11MeshMaxRetries;
43	int dot11MeshRetryTimeout; /* msec */
44	int dot11MeshConfirmTimeout; /* msec */
45	int dot11MeshHoldingTimeout; /* msec */
46};
47
48#define MAX_STA_COUNT 2007
49#define MAX_VLAN_ID 4094
50
51typedef u8 macaddr[ETH_ALEN];
52
53struct mac_acl_entry {
54	macaddr addr;
55	int vlan_id;
56};
57
58struct hostapd_radius_servers;
59struct ft_remote_r0kh;
60struct ft_remote_r1kh;
61
62#define NUM_WEP_KEYS 4
63struct hostapd_wep_keys {
64	u8 idx;
65	u8 *key[NUM_WEP_KEYS];
66	size_t len[NUM_WEP_KEYS];
67	int keys_set;
68	size_t default_len; /* key length used for dynamic key generation */
69};
70
71typedef enum hostap_security_policy {
72	SECURITY_PLAINTEXT = 0,
73	SECURITY_STATIC_WEP = 1,
74	SECURITY_IEEE_802_1X = 2,
75	SECURITY_WPA_PSK = 3,
76	SECURITY_WPA = 4,
77	SECURITY_OSEN = 5
78} secpolicy;
79
80struct hostapd_ssid {
81	u8 ssid[SSID_MAX_LEN];
82	size_t ssid_len;
83	unsigned int ssid_set:1;
84	unsigned int utf8_ssid:1;
85	unsigned int wpa_passphrase_set:1;
86	unsigned int wpa_psk_set:1;
87
88	char vlan[IFNAMSIZ + 1];
89	secpolicy security_policy;
90
91	struct hostapd_wpa_psk *wpa_psk;
92	char *wpa_passphrase;
93	char *wpa_psk_file;
94
95	struct hostapd_wep_keys wep;
96
97#define DYNAMIC_VLAN_DISABLED 0
98#define DYNAMIC_VLAN_OPTIONAL 1
99#define DYNAMIC_VLAN_REQUIRED 2
100	int dynamic_vlan;
101#define DYNAMIC_VLAN_NAMING_WITHOUT_DEVICE 0
102#define DYNAMIC_VLAN_NAMING_WITH_DEVICE 1
103#define DYNAMIC_VLAN_NAMING_END 2
104	int vlan_naming;
105#ifdef CONFIG_FULL_DYNAMIC_VLAN
106	char *vlan_tagged_interface;
107#endif /* CONFIG_FULL_DYNAMIC_VLAN */
108};
109
110
111#define VLAN_ID_WILDCARD -1
112
113struct hostapd_vlan {
114	struct hostapd_vlan *next;
115	int vlan_id; /* VLAN ID or -1 (VLAN_ID_WILDCARD) for wildcard entry */
116	char ifname[IFNAMSIZ + 1];
117	int configured;
118	int dynamic_vlan;
119#ifdef CONFIG_FULL_DYNAMIC_VLAN
120
121#define DVLAN_CLEAN_WLAN_PORT	0x8
122	int clean;
123#endif /* CONFIG_FULL_DYNAMIC_VLAN */
124};
125
126#define PMK_LEN 32
127struct hostapd_sta_wpa_psk_short {
128	struct hostapd_sta_wpa_psk_short *next;
129	u8 psk[PMK_LEN];
130};
131
132struct hostapd_wpa_psk {
133	struct hostapd_wpa_psk *next;
134	int group;
135	u8 psk[PMK_LEN];
136	u8 addr[ETH_ALEN];
137	u8 p2p_dev_addr[ETH_ALEN];
138};
139
140struct hostapd_eap_user {
141	struct hostapd_eap_user *next;
142	u8 *identity;
143	size_t identity_len;
144	struct {
145		int vendor;
146		u32 method;
147	} methods[EAP_MAX_METHODS];
148	u8 *password;
149	size_t password_len;
150	int phase2;
151	int force_version;
152	unsigned int wildcard_prefix:1;
153	unsigned int password_hash:1; /* whether password is hashed with
154				       * nt_password_hash() */
155	unsigned int remediation:1;
156	unsigned int macacl:1;
157	int ttls_auth; /* EAP_TTLS_AUTH_* bitfield */
158	struct hostapd_radius_attr *accept_attr;
159};
160
161struct hostapd_radius_attr {
162	u8 type;
163	struct wpabuf *val;
164	struct hostapd_radius_attr *next;
165};
166
167
168#define NUM_TX_QUEUES 4
169
170struct hostapd_tx_queue_params {
171	int aifs;
172	int cwmin;
173	int cwmax;
174	int burst; /* maximum burst time in 0.1 ms, i.e., 10 = 1 ms */
175};
176
177
178#define MAX_ROAMING_CONSORTIUM_LEN 15
179
180struct hostapd_roaming_consortium {
181	u8 len;
182	u8 oi[MAX_ROAMING_CONSORTIUM_LEN];
183};
184
185struct hostapd_lang_string {
186	u8 lang[3];
187	u8 name_len;
188	u8 name[252];
189};
190
191#define MAX_NAI_REALMS 10
192#define MAX_NAI_REALMLEN 255
193#define MAX_NAI_EAP_METHODS 5
194#define MAX_NAI_AUTH_TYPES 4
195struct hostapd_nai_realm_data {
196	u8 encoding;
197	char realm_buf[MAX_NAI_REALMLEN + 1];
198	char *realm[MAX_NAI_REALMS];
199	u8 eap_method_count;
200	struct hostapd_nai_realm_eap {
201		u8 eap_method;
202		u8 num_auths;
203		u8 auth_id[MAX_NAI_AUTH_TYPES];
204		u8 auth_val[MAX_NAI_AUTH_TYPES];
205	} eap_method[MAX_NAI_EAP_METHODS];
206};
207
208/**
209 * struct hostapd_bss_config - Per-BSS configuration
210 */
211struct hostapd_bss_config {
212	char iface[IFNAMSIZ + 1];
213	char bridge[IFNAMSIZ + 1];
214	char vlan_bridge[IFNAMSIZ + 1];
215	char wds_bridge[IFNAMSIZ + 1];
216
217	enum hostapd_logger_level logger_syslog_level, logger_stdout_level;
218
219	unsigned int logger_syslog; /* module bitfield */
220	unsigned int logger_stdout; /* module bitfield */
221
222	int max_num_sta; /* maximum number of STAs in station table */
223
224	int dtim_period;
225	int bss_load_update_period;
226
227	int ieee802_1x; /* use IEEE 802.1X */
228	int eapol_version;
229	int eap_server; /* Use internal EAP server instead of external
230			 * RADIUS server */
231	struct hostapd_eap_user *eap_user;
232	char *eap_user_sqlite;
233	char *eap_sim_db;
234	int eap_server_erp; /* Whether ERP is enabled on internal EAP server */
235	struct hostapd_ip_addr own_ip_addr;
236	char *nas_identifier;
237	struct hostapd_radius_servers *radius;
238	int acct_interim_interval;
239	int radius_request_cui;
240	struct hostapd_radius_attr *radius_auth_req_attr;
241	struct hostapd_radius_attr *radius_acct_req_attr;
242	int radius_das_port;
243	unsigned int radius_das_time_window;
244	int radius_das_require_event_timestamp;
245	struct hostapd_ip_addr radius_das_client_addr;
246	u8 *radius_das_shared_secret;
247	size_t radius_das_shared_secret_len;
248
249	struct hostapd_ssid ssid;
250
251	char *eap_req_id_text; /* optional displayable message sent with
252				* EAP Request-Identity */
253	size_t eap_req_id_text_len;
254	int eapol_key_index_workaround;
255
256	size_t default_wep_key_len;
257	int individual_wep_key_len;
258	int wep_rekeying_period;
259	int broadcast_key_idx_min, broadcast_key_idx_max;
260	int eap_reauth_period;
261	int erp_send_reauth_start;
262	char *erp_domain;
263
264	int ieee802_11f; /* use IEEE 802.11f (IAPP) */
265	char iapp_iface[IFNAMSIZ + 1]; /* interface used with IAPP broadcast
266					* frames */
267
268	enum {
269		ACCEPT_UNLESS_DENIED = 0,
270		DENY_UNLESS_ACCEPTED = 1,
271		USE_EXTERNAL_RADIUS_AUTH = 2
272	} macaddr_acl;
273	struct mac_acl_entry *accept_mac;
274	int num_accept_mac;
275	struct mac_acl_entry *deny_mac;
276	int num_deny_mac;
277	int wds_sta;
278	int isolate;
279	int start_disabled;
280
281	int auth_algs; /* bitfield of allowed IEEE 802.11 authentication
282			* algorithms, WPA_AUTH_ALG_{OPEN,SHARED,LEAP} */
283
284	int wpa; /* bitfield of WPA_PROTO_WPA, WPA_PROTO_RSN */
285	int wpa_key_mgmt;
286#ifdef CONFIG_IEEE80211W
287	enum mfp_options ieee80211w;
288	int group_mgmt_cipher;
289	/* dot11AssociationSAQueryMaximumTimeout (in TUs) */
290	unsigned int assoc_sa_query_max_timeout;
291	/* dot11AssociationSAQueryRetryTimeout (in TUs) */
292	int assoc_sa_query_retry_timeout;
293#endif /* CONFIG_IEEE80211W */
294	enum {
295		PSK_RADIUS_IGNORED = 0,
296		PSK_RADIUS_ACCEPTED = 1,
297		PSK_RADIUS_REQUIRED = 2
298	} wpa_psk_radius;
299	int wpa_pairwise;
300	int wpa_group;
301	int wpa_group_rekey;
302	int wpa_strict_rekey;
303	int wpa_gmk_rekey;
304	int wpa_ptk_rekey;
305	int rsn_pairwise;
306	int rsn_preauth;
307	char *rsn_preauth_interfaces;
308	int peerkey;
309
310#ifdef CONFIG_IEEE80211R
311	/* IEEE 802.11r - Fast BSS Transition */
312	u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
313	u8 r1_key_holder[FT_R1KH_ID_LEN];
314	u32 r0_key_lifetime;
315	u32 reassociation_deadline;
316	struct ft_remote_r0kh *r0kh_list;
317	struct ft_remote_r1kh *r1kh_list;
318	int pmk_r1_push;
319	int ft_over_ds;
320#endif /* CONFIG_IEEE80211R */
321
322	char *ctrl_interface; /* directory for UNIX domain sockets */
323#ifndef CONFIG_NATIVE_WINDOWS
324	gid_t ctrl_interface_gid;
325#endif /* CONFIG_NATIVE_WINDOWS */
326	int ctrl_interface_gid_set;
327
328	char *ca_cert;
329	char *server_cert;
330	char *private_key;
331	char *private_key_passwd;
332	int check_crl;
333	unsigned int tls_session_lifetime;
334	char *ocsp_stapling_response;
335	char *dh_file;
336	char *openssl_ciphers;
337	u8 *pac_opaque_encr_key;
338	u8 *eap_fast_a_id;
339	size_t eap_fast_a_id_len;
340	char *eap_fast_a_id_info;
341	int eap_fast_prov;
342	int pac_key_lifetime;
343	int pac_key_refresh_time;
344	int eap_sim_aka_result_ind;
345	int tnc;
346	int fragment_size;
347	u16 pwd_group;
348
349	char *radius_server_clients;
350	int radius_server_auth_port;
351	int radius_server_acct_port;
352	int radius_server_ipv6;
353
354	int use_pae_group_addr; /* Whether to send EAPOL frames to PAE group
355				 * address instead of individual address
356				 * (for driver_wired.c).
357				 */
358
359	int ap_max_inactivity;
360	int ignore_broadcast_ssid;
361
362	int wmm_enabled;
363	int wmm_uapsd;
364
365	struct hostapd_vlan *vlan;
366
367	macaddr bssid;
368
369	/*
370	 * Maximum listen interval that STAs can use when associating with this
371	 * BSS. If a STA tries to use larger value, the association will be
372	 * denied with status code 51.
373	 */
374	u16 max_listen_interval;
375
376	int disable_pmksa_caching;
377	int okc; /* Opportunistic Key Caching */
378
379	int wps_state;
380#ifdef CONFIG_WPS
381	int wps_independent;
382	int ap_setup_locked;
383	u8 uuid[16];
384	char *wps_pin_requests;
385	char *device_name;
386	char *manufacturer;
387	char *model_name;
388	char *model_number;
389	char *serial_number;
390	u8 device_type[WPS_DEV_TYPE_LEN];
391	char *config_methods;
392	u8 os_version[4];
393	char *ap_pin;
394	int skip_cred_build;
395	u8 *extra_cred;
396	size_t extra_cred_len;
397	int wps_cred_processing;
398	int force_per_enrollee_psk;
399	u8 *ap_settings;
400	size_t ap_settings_len;
401	char *upnp_iface;
402	char *friendly_name;
403	char *manufacturer_url;
404	char *model_description;
405	char *model_url;
406	char *upc;
407	struct wpabuf *wps_vendor_ext[MAX_WPS_VENDOR_EXTENSIONS];
408	int wps_nfc_pw_from_config;
409	int wps_nfc_dev_pw_id;
410	struct wpabuf *wps_nfc_dh_pubkey;
411	struct wpabuf *wps_nfc_dh_privkey;
412	struct wpabuf *wps_nfc_dev_pw;
413#endif /* CONFIG_WPS */
414	int pbc_in_m1;
415	char *server_id;
416
417#define P2P_ENABLED BIT(0)
418#define P2P_GROUP_OWNER BIT(1)
419#define P2P_GROUP_FORMATION BIT(2)
420#define P2P_MANAGE BIT(3)
421#define P2P_ALLOW_CROSS_CONNECTION BIT(4)
422	int p2p;
423#ifdef CONFIG_P2P
424	u8 ip_addr_go[4];
425	u8 ip_addr_mask[4];
426	u8 ip_addr_start[4];
427	u8 ip_addr_end[4];
428#endif /* CONFIG_P2P */
429
430	int disassoc_low_ack;
431	int skip_inactivity_poll;
432
433#define TDLS_PROHIBIT BIT(0)
434#define TDLS_PROHIBIT_CHAN_SWITCH BIT(1)
435	int tdls;
436	int disable_11n;
437	int disable_11ac;
438
439	/* IEEE 802.11v */
440	int time_advertisement;
441	char *time_zone;
442	int wnm_sleep_mode;
443	int bss_transition;
444
445	/* IEEE 802.11u - Interworking */
446	int interworking;
447	int access_network_type;
448	int internet;
449	int asra;
450	int esr;
451	int uesa;
452	int venue_info_set;
453	u8 venue_group;
454	u8 venue_type;
455	u8 hessid[ETH_ALEN];
456
457	/* IEEE 802.11u - Roaming Consortium list */
458	unsigned int roaming_consortium_count;
459	struct hostapd_roaming_consortium *roaming_consortium;
460
461	/* IEEE 802.11u - Venue Name duples */
462	unsigned int venue_name_count;
463	struct hostapd_lang_string *venue_name;
464
465	/* IEEE 802.11u - Network Authentication Type */
466	u8 *network_auth_type;
467	size_t network_auth_type_len;
468
469	/* IEEE 802.11u - IP Address Type Availability */
470	u8 ipaddr_type_availability;
471	u8 ipaddr_type_configured;
472
473	/* IEEE 802.11u - 3GPP Cellular Network */
474	u8 *anqp_3gpp_cell_net;
475	size_t anqp_3gpp_cell_net_len;
476
477	/* IEEE 802.11u - Domain Name */
478	u8 *domain_name;
479	size_t domain_name_len;
480
481	unsigned int nai_realm_count;
482	struct hostapd_nai_realm_data *nai_realm_data;
483
484	u16 gas_comeback_delay;
485	int gas_frag_limit;
486
487	u8 qos_map_set[16 + 2 * 21];
488	unsigned int qos_map_set_len;
489
490	int osen;
491	int proxy_arp;
492	int na_mcast_to_ucast;
493#ifdef CONFIG_HS20
494	int hs20;
495	int disable_dgaf;
496	u16 anqp_domain_id;
497	unsigned int hs20_oper_friendly_name_count;
498	struct hostapd_lang_string *hs20_oper_friendly_name;
499	u8 *hs20_wan_metrics;
500	u8 *hs20_connection_capability;
501	size_t hs20_connection_capability_len;
502	u8 *hs20_operating_class;
503	u8 hs20_operating_class_len;
504	struct hs20_icon {
505		u16 width;
506		u16 height;
507		char language[3];
508		char type[256];
509		char name[256];
510		char file[256];
511	} *hs20_icons;
512	size_t hs20_icons_count;
513	u8 osu_ssid[SSID_MAX_LEN];
514	size_t osu_ssid_len;
515	struct hs20_osu_provider {
516		unsigned int friendly_name_count;
517		struct hostapd_lang_string *friendly_name;
518		char *server_uri;
519		int *method_list;
520		char **icons;
521		size_t icons_count;
522		char *osu_nai;
523		unsigned int service_desc_count;
524		struct hostapd_lang_string *service_desc;
525	} *hs20_osu_providers, *last_osu;
526	size_t hs20_osu_providers_count;
527	unsigned int hs20_deauth_req_timeout;
528	char *subscr_remediation_url;
529	u8 subscr_remediation_method;
530#endif /* CONFIG_HS20 */
531
532	u8 wps_rf_bands; /* RF bands for WPS (WPS_RF_*) */
533
534#ifdef CONFIG_RADIUS_TEST
535	char *dump_msk_file;
536#endif /* CONFIG_RADIUS_TEST */
537
538	struct wpabuf *vendor_elements;
539
540	unsigned int sae_anti_clogging_threshold;
541	int *sae_groups;
542
543	char *wowlan_triggers; /* Wake-on-WLAN triggers */
544
545#ifdef CONFIG_TESTING_OPTIONS
546	u8 bss_load_test[5];
547	u8 bss_load_test_set;
548	struct wpabuf *own_ie_override;
549#endif /* CONFIG_TESTING_OPTIONS */
550
551#define MESH_ENABLED BIT(0)
552	int mesh;
553
554	int radio_measurements;
555
556	int vendor_vht;
557
558	char *no_probe_resp_if_seen_on;
559	char *no_auth_if_seen_on;
560};
561
562
563/**
564 * struct hostapd_config - Per-radio interface configuration
565 */
566struct hostapd_config {
567	struct hostapd_bss_config **bss, *last_bss;
568	size_t num_bss;
569
570	u16 beacon_int;
571	int rts_threshold;
572	int fragm_threshold;
573	u8 send_probe_response;
574	u8 channel;
575	u8 acs;
576	struct wpa_freq_range_list acs_ch_list;
577	enum hostapd_hw_mode hw_mode; /* HOSTAPD_MODE_IEEE80211A, .. */
578	enum {
579		LONG_PREAMBLE = 0,
580		SHORT_PREAMBLE = 1
581	} preamble;
582
583	int *supported_rates;
584	int *basic_rates;
585
586	const struct wpa_driver_ops *driver;
587	char *driver_params;
588
589	int ap_table_max_size;
590	int ap_table_expiration_time;
591
592	unsigned int track_sta_max_num;
593	unsigned int track_sta_max_age;
594
595	char country[3]; /* first two octets: country code as described in
596			  * ISO/IEC 3166-1. Third octet:
597			  * ' ' (ascii 32): all environments
598			  * 'O': Outdoor environemnt only
599			  * 'I': Indoor environment only
600			  */
601
602	int ieee80211d;
603
604	int ieee80211h; /* DFS */
605
606	/*
607	 * Local power constraint is an octet encoded as an unsigned integer in
608	 * units of decibels. Invalid value -1 indicates that Power Constraint
609	 * element will not be added.
610	 */
611	int local_pwr_constraint;
612
613	/* Control Spectrum Management bit */
614	int spectrum_mgmt_required;
615
616	struct hostapd_tx_queue_params tx_queue[NUM_TX_QUEUES];
617
618	/*
619	 * WMM AC parameters, in same order as 802.1D, i.e.
620	 * 0 = BE (best effort)
621	 * 1 = BK (background)
622	 * 2 = VI (video)
623	 * 3 = VO (voice)
624	 */
625	struct hostapd_wmm_ac_params wmm_ac_params[4];
626
627	int ht_op_mode_fixed;
628	u16 ht_capab;
629	int ieee80211n;
630	int secondary_channel;
631	int no_pri_sec_switch;
632	int require_ht;
633	int obss_interval;
634	u32 vht_capab;
635	int ieee80211ac;
636	int require_vht;
637	u8 vht_oper_chwidth;
638	u8 vht_oper_centr_freq_seg0_idx;
639	u8 vht_oper_centr_freq_seg1_idx;
640
641#ifdef CONFIG_FST
642	struct fst_iface_cfg fst_cfg;
643#endif /* CONFIG_FST */
644
645#ifdef CONFIG_P2P
646	u8 p2p_go_ctwindow;
647#endif /* CONFIG_P2P */
648
649#ifdef CONFIG_TESTING_OPTIONS
650	double ignore_probe_probability;
651	double ignore_auth_probability;
652	double ignore_assoc_probability;
653	double ignore_reassoc_probability;
654	double corrupt_gtk_rekey_mic_probability;
655#endif /* CONFIG_TESTING_OPTIONS */
656
657#ifdef CONFIG_ACS
658	unsigned int acs_num_scans;
659	struct acs_bias {
660		int channel;
661		double bias;
662	} *acs_chan_bias;
663	unsigned int num_acs_chan_bias;
664#endif /* CONFIG_ACS */
665};
666
667
668int hostapd_mac_comp(const void *a, const void *b);
669int hostapd_mac_comp_empty(const void *a);
670struct hostapd_config * hostapd_config_defaults(void);
671void hostapd_config_defaults_bss(struct hostapd_bss_config *bss);
672void hostapd_config_free_eap_user(struct hostapd_eap_user *user);
673void hostapd_config_clear_wpa_psk(struct hostapd_wpa_psk **p);
674void hostapd_config_free_bss(struct hostapd_bss_config *conf);
675void hostapd_config_free(struct hostapd_config *conf);
676int hostapd_maclist_found(struct mac_acl_entry *list, int num_entries,
677			  const u8 *addr, int *vlan_id);
678int hostapd_rate_found(int *list, int rate);
679const u8 * hostapd_get_psk(const struct hostapd_bss_config *conf,
680			   const u8 *addr, const u8 *p2p_dev_addr,
681			   const u8 *prev_psk);
682int hostapd_setup_wpa_psk(struct hostapd_bss_config *conf);
683int hostapd_vlan_id_valid(struct hostapd_vlan *vlan, int vlan_id);
684const char * hostapd_get_vlan_id_ifname(struct hostapd_vlan *vlan,
685					int vlan_id);
686struct hostapd_radius_attr *
687hostapd_config_get_radius_attr(struct hostapd_radius_attr *attr, u8 type);
688int hostapd_config_check(struct hostapd_config *conf, int full_config);
689void hostapd_set_security_params(struct hostapd_bss_config *bss,
690				 int full_config);
691
692#endif /* HOSTAPD_CONFIG_H */
693