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