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