xref: /freebsd/contrib/wpa/src/ap/ap_config.h (revision bb15ca603fa442c72dde3f3cb8b46db6970e3950)
1 /*
2  * hostapd / Configuration definitions and helpers functions
3  * Copyright (c) 2003-2009, Jouni Malinen <j@w1.fi>
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation.
8  *
9  * Alternatively, this software may be distributed under the terms of BSD
10  * license.
11  *
12  * See README and COPYING for more details.
13  */
14 
15 #ifndef HOSTAPD_CONFIG_H
16 #define HOSTAPD_CONFIG_H
17 
18 #include "common/defs.h"
19 #include "ip_addr.h"
20 #include "common/wpa_common.h"
21 
22 #define MAX_STA_COUNT 2007
23 #define MAX_VLAN_ID 4094
24 
25 typedef u8 macaddr[ETH_ALEN];
26 
27 struct mac_acl_entry {
28 	macaddr addr;
29 	int vlan_id;
30 };
31 
32 struct hostapd_radius_servers;
33 struct ft_remote_r0kh;
34 struct ft_remote_r1kh;
35 
36 #define HOSTAPD_MAX_SSID_LEN 32
37 
38 #define NUM_WEP_KEYS 4
39 struct hostapd_wep_keys {
40 	u8 idx;
41 	u8 *key[NUM_WEP_KEYS];
42 	size_t len[NUM_WEP_KEYS];
43 	int keys_set;
44 	size_t default_len; /* key length used for dynamic key generation */
45 };
46 
47 typedef enum hostap_security_policy {
48 	SECURITY_PLAINTEXT = 0,
49 	SECURITY_STATIC_WEP = 1,
50 	SECURITY_IEEE_802_1X = 2,
51 	SECURITY_WPA_PSK = 3,
52 	SECURITY_WPA = 4
53 } secpolicy;
54 
55 struct hostapd_ssid {
56 	char ssid[HOSTAPD_MAX_SSID_LEN + 1];
57 	size_t ssid_len;
58 	int ssid_set;
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 #ifdef CONFIG_FULL_DYNAMIC_VLAN
74 	char *vlan_tagged_interface;
75 #endif /* CONFIG_FULL_DYNAMIC_VLAN */
76 	struct hostapd_wep_keys **dyn_vlan_keys;
77 	size_t max_dyn_vlan_keys;
78 };
79 
80 
81 #define VLAN_ID_WILDCARD -1
82 
83 struct hostapd_vlan {
84 	struct hostapd_vlan *next;
85 	int vlan_id; /* VLAN ID or -1 (VLAN_ID_WILDCARD) for wildcard entry */
86 	char ifname[IFNAMSIZ + 1];
87 	int dynamic_vlan;
88 #ifdef CONFIG_FULL_DYNAMIC_VLAN
89 
90 #define DVLAN_CLEAN_BR 	0x1
91 #define DVLAN_CLEAN_VLAN	0x2
92 #define DVLAN_CLEAN_VLAN_PORT	0x4
93 #define DVLAN_CLEAN_WLAN_PORT	0x8
94 	int clean;
95 #endif /* CONFIG_FULL_DYNAMIC_VLAN */
96 };
97 
98 #define PMK_LEN 32
99 struct hostapd_wpa_psk {
100 	struct hostapd_wpa_psk *next;
101 	int group;
102 	u8 psk[PMK_LEN];
103 	u8 addr[ETH_ALEN];
104 };
105 
106 #define EAP_USER_MAX_METHODS 8
107 struct hostapd_eap_user {
108 	struct hostapd_eap_user *next;
109 	u8 *identity;
110 	size_t identity_len;
111 	struct {
112 		int vendor;
113 		u32 method;
114 	} methods[EAP_USER_MAX_METHODS];
115 	u8 *password;
116 	size_t password_len;
117 	int phase2;
118 	int force_version;
119 	unsigned int wildcard_prefix:1;
120 	unsigned int password_hash:1; /* whether password is hashed with
121 				       * nt_password_hash() */
122 	int ttls_auth; /* EAP_TTLS_AUTH_* bitfield */
123 };
124 
125 
126 #define NUM_TX_QUEUES 8
127 
128 struct hostapd_tx_queue_params {
129 	int aifs;
130 	int cwmin;
131 	int cwmax;
132 	int burst; /* maximum burst time in 0.1 ms, i.e., 10 = 1 ms */
133 	int configured;
134 };
135 
136 struct hostapd_wmm_ac_params {
137 	int cwmin;
138 	int cwmax;
139 	int aifs;
140 	int txop_limit; /* in units of 32us */
141 	int admission_control_mandatory;
142 };
143 
144 
145 /**
146  * struct hostapd_bss_config - Per-BSS configuration
147  */
148 struct hostapd_bss_config {
149 	char iface[IFNAMSIZ + 1];
150 	char bridge[IFNAMSIZ + 1];
151 
152 	enum hostapd_logger_level logger_syslog_level, logger_stdout_level;
153 
154 	unsigned int logger_syslog; /* module bitfield */
155 	unsigned int logger_stdout; /* module bitfield */
156 
157 	char *dump_log_name; /* file name for state dump (SIGUSR1) */
158 
159 	int max_num_sta; /* maximum number of STAs in station table */
160 
161 	int dtim_period;
162 
163 	int ieee802_1x; /* use IEEE 802.1X */
164 	int eapol_version;
165 	int eap_server; /* Use internal EAP server instead of external
166 			 * RADIUS server */
167 	struct hostapd_eap_user *eap_user;
168 	char *eap_sim_db;
169 	struct hostapd_ip_addr own_ip_addr;
170 	char *nas_identifier;
171 	struct hostapd_radius_servers *radius;
172 	int acct_interim_interval;
173 
174 	struct hostapd_ssid ssid;
175 
176 	char *eap_req_id_text; /* optional displayable message sent with
177 				* EAP Request-Identity */
178 	size_t eap_req_id_text_len;
179 	int eapol_key_index_workaround;
180 
181 	size_t default_wep_key_len;
182 	int individual_wep_key_len;
183 	int wep_rekeying_period;
184 	int broadcast_key_idx_min, broadcast_key_idx_max;
185 	int eap_reauth_period;
186 
187 	int ieee802_11f; /* use IEEE 802.11f (IAPP) */
188 	char iapp_iface[IFNAMSIZ + 1]; /* interface used with IAPP broadcast
189 					* frames */
190 
191 	enum {
192 		ACCEPT_UNLESS_DENIED = 0,
193 		DENY_UNLESS_ACCEPTED = 1,
194 		USE_EXTERNAL_RADIUS_AUTH = 2
195 	} macaddr_acl;
196 	struct mac_acl_entry *accept_mac;
197 	int num_accept_mac;
198 	struct mac_acl_entry *deny_mac;
199 	int num_deny_mac;
200 	int wds_sta;
201 
202 	int auth_algs; /* bitfield of allowed IEEE 802.11 authentication
203 			* algorithms, WPA_AUTH_ALG_{OPEN,SHARED,LEAP} */
204 
205 	int wpa; /* bitfield of WPA_PROTO_WPA, WPA_PROTO_RSN */
206 	int wpa_key_mgmt;
207 #ifdef CONFIG_IEEE80211W
208 	enum mfp_options ieee80211w;
209 	/* dot11AssociationSAQueryMaximumTimeout (in TUs) */
210 	unsigned int assoc_sa_query_max_timeout;
211 	/* dot11AssociationSAQueryRetryTimeout (in TUs) */
212 	int assoc_sa_query_retry_timeout;
213 #endif /* CONFIG_IEEE80211W */
214 	int wpa_pairwise;
215 	int wpa_group;
216 	int wpa_group_rekey;
217 	int wpa_strict_rekey;
218 	int wpa_gmk_rekey;
219 	int wpa_ptk_rekey;
220 	int rsn_pairwise;
221 	int rsn_preauth;
222 	char *rsn_preauth_interfaces;
223 	int peerkey;
224 
225 #ifdef CONFIG_IEEE80211R
226 	/* IEEE 802.11r - Fast BSS Transition */
227 	u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
228 	u8 r1_key_holder[FT_R1KH_ID_LEN];
229 	u32 r0_key_lifetime;
230 	u32 reassociation_deadline;
231 	struct ft_remote_r0kh *r0kh_list;
232 	struct ft_remote_r1kh *r1kh_list;
233 	int pmk_r1_push;
234 #endif /* CONFIG_IEEE80211R */
235 
236 	char *ctrl_interface; /* directory for UNIX domain sockets */
237 #ifndef CONFIG_NATIVE_WINDOWS
238 	gid_t ctrl_interface_gid;
239 #endif /* CONFIG_NATIVE_WINDOWS */
240 	int ctrl_interface_gid_set;
241 
242 	char *ca_cert;
243 	char *server_cert;
244 	char *private_key;
245 	char *private_key_passwd;
246 	int check_crl;
247 	char *dh_file;
248 	u8 *pac_opaque_encr_key;
249 	u8 *eap_fast_a_id;
250 	size_t eap_fast_a_id_len;
251 	char *eap_fast_a_id_info;
252 	int eap_fast_prov;
253 	int pac_key_lifetime;
254 	int pac_key_refresh_time;
255 	int eap_sim_aka_result_ind;
256 	int tnc;
257 
258 	char *radius_server_clients;
259 	int radius_server_auth_port;
260 	int radius_server_ipv6;
261 
262 	char *test_socket; /* UNIX domain socket path for driver_test */
263 
264 	int use_pae_group_addr; /* Whether to send EAPOL frames to PAE group
265 				 * address instead of individual address
266 				 * (for driver_wired.c).
267 				 */
268 
269 	int ap_max_inactivity;
270 	int ignore_broadcast_ssid;
271 
272 	int wmm_enabled;
273 	int wmm_uapsd;
274 
275 	struct hostapd_vlan *vlan, *vlan_tail;
276 
277 	macaddr bssid;
278 
279 	/*
280 	 * Maximum listen interval that STAs can use when associating with this
281 	 * BSS. If a STA tries to use larger value, the association will be
282 	 * denied with status code 51.
283 	 */
284 	u16 max_listen_interval;
285 
286 	int okc; /* Opportunistic Key Caching */
287 
288 	int wps_state;
289 #ifdef CONFIG_WPS
290 	int ap_setup_locked;
291 	u8 uuid[16];
292 	char *wps_pin_requests;
293 	char *device_name;
294 	char *manufacturer;
295 	char *model_name;
296 	char *model_number;
297 	char *serial_number;
298 	char *device_type;
299 	char *config_methods;
300 	u8 os_version[4];
301 	char *ap_pin;
302 	int skip_cred_build;
303 	u8 *extra_cred;
304 	size_t extra_cred_len;
305 	int wps_cred_processing;
306 	u8 *ap_settings;
307 	size_t ap_settings_len;
308 	char *upnp_iface;
309 	char *friendly_name;
310 	char *manufacturer_url;
311 	char *model_description;
312 	char *model_url;
313 	char *upc;
314 #endif /* CONFIG_WPS */
315 };
316 
317 
318 /**
319  * struct hostapd_config - Per-radio interface configuration
320  */
321 struct hostapd_config {
322 	struct hostapd_bss_config *bss, *last_bss;
323 	size_t num_bss;
324 
325 	u16 beacon_int;
326 	int rts_threshold;
327 	int fragm_threshold;
328 	u8 send_probe_response;
329 	u8 channel;
330 	enum hostapd_hw_mode hw_mode; /* HOSTAPD_MODE_IEEE80211A, .. */
331 	enum {
332 		LONG_PREAMBLE = 0,
333 		SHORT_PREAMBLE = 1
334 	} preamble;
335 	enum {
336 		CTS_PROTECTION_AUTOMATIC = 0,
337 		CTS_PROTECTION_FORCE_ENABLED = 1,
338 		CTS_PROTECTION_FORCE_DISABLED = 2,
339 		CTS_PROTECTION_AUTOMATIC_NO_OLBC = 3,
340 	} cts_protection_type;
341 
342 	int *supported_rates;
343 	int *basic_rates;
344 
345 	const struct wpa_driver_ops *driver;
346 
347 	int ap_table_max_size;
348 	int ap_table_expiration_time;
349 
350 	char country[3]; /* first two octets: country code as described in
351 			  * ISO/IEC 3166-1. Third octet:
352 			  * ' ' (ascii 32): all environments
353 			  * 'O': Outdoor environemnt only
354 			  * 'I': Indoor environment only
355 			  */
356 
357 	int ieee80211d;
358 
359 	struct hostapd_tx_queue_params tx_queue[NUM_TX_QUEUES];
360 
361 	/*
362 	 * WMM AC parameters, in same order as 802.1D, i.e.
363 	 * 0 = BE (best effort)
364 	 * 1 = BK (background)
365 	 * 2 = VI (video)
366 	 * 3 = VO (voice)
367 	 */
368 	struct hostapd_wmm_ac_params wmm_ac_params[4];
369 
370 	int ht_op_mode_fixed;
371 	u16 ht_capab;
372 	int ieee80211n;
373 	int secondary_channel;
374 };
375 
376 
377 int hostapd_mac_comp(const void *a, const void *b);
378 int hostapd_mac_comp_empty(const void *a);
379 struct hostapd_config * hostapd_config_defaults(void);
380 void hostapd_config_defaults_bss(struct hostapd_bss_config *bss);
381 void hostapd_config_free(struct hostapd_config *conf);
382 int hostapd_maclist_found(struct mac_acl_entry *list, int num_entries,
383 			  const u8 *addr, int *vlan_id);
384 int hostapd_rate_found(int *list, int rate);
385 int hostapd_wep_key_cmp(struct hostapd_wep_keys *a,
386 			struct hostapd_wep_keys *b);
387 const u8 * hostapd_get_psk(const struct hostapd_bss_config *conf,
388 			   const u8 *addr, const u8 *prev_psk);
389 int hostapd_setup_wpa_psk(struct hostapd_bss_config *conf);
390 const char * hostapd_get_vlan_id_ifname(struct hostapd_vlan *vlan,
391 					int vlan_id);
392 const struct hostapd_eap_user *
393 hostapd_get_eap_user(const struct hostapd_bss_config *conf, const u8 *identity,
394 		     size_t identity_len, int phase2);
395 
396 #endif /* HOSTAPD_CONFIG_H */
397