2 * hostapd / Configuration definitions and helpers functions
3 * Copyright (c) 2003-2015, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
9 #ifndef HOSTAPD_CONFIG_H
10 #define HOSTAPD_CONFIG_H
12 #include "common/defs.h"
13 #include "utils/list.h"
15 #include "common/wpa_common.h"
16 #include "common/ieee802_11_defs.h"
17 #include "common/ieee802_11_common.h"
23 * mesh_conf - local MBSS state and settings
28 /* Active Path Selection Protocol Identifier */
30 /* Active Path Selection Metric Identifier */
32 /* Congestion Control Mode Identifier */
34 /* Synchronization Protocol Identifier */
36 /* Authentication Protocol Identifier */
40 #define MESH_CONF_SEC_NONE BIT(0)
41 #define MESH_CONF_SEC_AUTH BIT(1)
42 #define MESH_CONF_SEC_AMPE BIT(2)
43 unsigned int security;
44 enum mfp_options ieee80211w;
45 unsigned int pairwise_cipher;
46 unsigned int group_cipher;
47 unsigned int mgmt_group_cipher;
48 int dot11MeshMaxRetries;
49 int dot11MeshRetryTimeout; /* msec */
50 int dot11MeshConfirmTimeout; /* msec */
51 int dot11MeshHoldingTimeout; /* msec */
54 #define MAX_STA_COUNT 2007
55 #define MAX_VLAN_ID 4094
57 typedef u8 macaddr[ETH_ALEN];
59 struct mac_acl_entry {
61 struct vlan_description vlan_id;
64 struct hostapd_radius_servers;
65 struct ft_remote_r0kh;
66 struct ft_remote_r1kh;
68 #define NUM_WEP_KEYS 4
69 struct hostapd_wep_keys {
71 u8 *key[NUM_WEP_KEYS];
72 size_t len[NUM_WEP_KEYS];
74 size_t default_len; /* key length used for dynamic key generation */
77 typedef enum hostap_security_policy {
78 SECURITY_PLAINTEXT = 0,
79 SECURITY_STATIC_WEP = 1,
80 SECURITY_IEEE_802_1X = 2,
87 u8 ssid[SSID_MAX_LEN];
89 unsigned int ssid_set:1;
90 unsigned int utf8_ssid:1;
91 unsigned int wpa_passphrase_set:1;
92 unsigned int wpa_psk_set:1;
94 char vlan[IFNAMSIZ + 1];
95 secpolicy security_policy;
97 struct hostapd_wpa_psk *wpa_psk;
101 struct hostapd_wep_keys wep;
103 #define DYNAMIC_VLAN_DISABLED 0
104 #define DYNAMIC_VLAN_OPTIONAL 1
105 #define DYNAMIC_VLAN_REQUIRED 2
107 #define DYNAMIC_VLAN_NAMING_WITHOUT_DEVICE 0
108 #define DYNAMIC_VLAN_NAMING_WITH_DEVICE 1
109 #define DYNAMIC_VLAN_NAMING_END 2
112 #ifdef CONFIG_FULL_DYNAMIC_VLAN
113 char *vlan_tagged_interface;
114 #endif /* CONFIG_FULL_DYNAMIC_VLAN */
118 #define VLAN_ID_WILDCARD -1
120 struct hostapd_vlan {
121 struct hostapd_vlan *next;
122 int vlan_id; /* VLAN ID or -1 (VLAN_ID_WILDCARD) for wildcard entry */
123 struct vlan_description vlan_desc;
124 char ifname[IFNAMSIZ + 1];
127 #ifdef CONFIG_FULL_DYNAMIC_VLAN
129 #define DVLAN_CLEAN_WLAN_PORT 0x8
131 #endif /* CONFIG_FULL_DYNAMIC_VLAN */
135 #define MIN_PASSPHRASE_LEN 8
136 #define MAX_PASSPHRASE_LEN 63
137 struct hostapd_sta_wpa_psk_short {
138 struct hostapd_sta_wpa_psk_short *next;
139 unsigned int is_passphrase:1;
141 char passphrase[MAX_PASSPHRASE_LEN + 1];
142 int ref; /* (number of references held) - 1 */
145 struct hostapd_wpa_psk {
146 struct hostapd_wpa_psk *next;
150 u8 p2p_dev_addr[ETH_ALEN];
153 struct hostapd_eap_user {
154 struct hostapd_eap_user *next;
160 } methods[EAP_MAX_METHODS];
164 size_t salt_len; /* non-zero when password is salted */
167 unsigned int wildcard_prefix:1;
168 unsigned int password_hash:1; /* whether password is hashed with
169 * nt_password_hash() */
170 unsigned int remediation:1;
171 unsigned int macacl:1;
172 int ttls_auth; /* EAP_TTLS_AUTH_* bitfield */
173 struct hostapd_radius_attr *accept_attr;
177 struct hostapd_radius_attr {
180 struct hostapd_radius_attr *next;
184 #define NUM_TX_QUEUES 4
186 struct hostapd_tx_queue_params {
190 int burst; /* maximum burst time in 0.1 ms, i.e., 10 = 1 ms */
194 #define MAX_ROAMING_CONSORTIUM_LEN 15
196 struct hostapd_roaming_consortium {
198 u8 oi[MAX_ROAMING_CONSORTIUM_LEN];
201 struct hostapd_lang_string {
207 struct hostapd_venue_url {
213 #define MAX_NAI_REALMS 10
214 #define MAX_NAI_REALMLEN 255
215 #define MAX_NAI_EAP_METHODS 5
216 #define MAX_NAI_AUTH_TYPES 4
217 struct hostapd_nai_realm_data {
219 char realm_buf[MAX_NAI_REALMLEN + 1];
220 char *realm[MAX_NAI_REALMS];
222 struct hostapd_nai_realm_eap {
225 u8 auth_id[MAX_NAI_AUTH_TYPES];
226 u8 auth_val[MAX_NAI_AUTH_TYPES];
227 } eap_method[MAX_NAI_EAP_METHODS];
230 struct anqp_element {
233 struct wpabuf *payload;
242 struct sae_password_entry {
243 struct sae_password_entry *next;
246 u8 peer_addr[ETH_ALEN];
250 * struct hostapd_bss_config - Per-BSS configuration
252 struct hostapd_bss_config {
253 char iface[IFNAMSIZ + 1];
254 char bridge[IFNAMSIZ + 1];
255 char vlan_bridge[IFNAMSIZ + 1];
256 char wds_bridge[IFNAMSIZ + 1];
258 enum hostapd_logger_level logger_syslog_level, logger_stdout_level;
260 unsigned int logger_syslog; /* module bitfield */
261 unsigned int logger_stdout; /* module bitfield */
263 int max_num_sta; /* maximum number of STAs in station table */
266 unsigned int bss_load_update_period;
267 unsigned int chan_util_avg_period;
269 int ieee802_1x; /* use IEEE 802.1X */
271 int eap_server; /* Use internal EAP server instead of external
273 struct hostapd_eap_user *eap_user;
274 char *eap_user_sqlite;
276 unsigned int eap_sim_db_timeout;
277 int eap_server_erp; /* Whether ERP is enabled on internal EAP server */
278 struct hostapd_ip_addr own_ip_addr;
279 char *nas_identifier;
280 struct hostapd_radius_servers *radius;
281 int acct_interim_interval;
282 int radius_request_cui;
283 struct hostapd_radius_attr *radius_auth_req_attr;
284 struct hostapd_radius_attr *radius_acct_req_attr;
286 unsigned int radius_das_time_window;
287 int radius_das_require_event_timestamp;
288 int radius_das_require_message_authenticator;
289 struct hostapd_ip_addr radius_das_client_addr;
290 u8 *radius_das_shared_secret;
291 size_t radius_das_shared_secret_len;
293 struct hostapd_ssid ssid;
295 char *eap_req_id_text; /* optional displayable message sent with
296 * EAP Request-Identity */
297 size_t eap_req_id_text_len;
298 int eapol_key_index_workaround;
300 size_t default_wep_key_len;
301 int individual_wep_key_len;
302 int wep_rekeying_period;
303 int broadcast_key_idx_min, broadcast_key_idx_max;
304 int eap_reauth_period;
305 int erp_send_reauth_start;
308 int ieee802_11f; /* use IEEE 802.11f (IAPP) */
309 char iapp_iface[IFNAMSIZ + 1]; /* interface used with IAPP broadcast
313 ACCEPT_UNLESS_DENIED = 0,
314 DENY_UNLESS_ACCEPTED = 1,
315 USE_EXTERNAL_RADIUS_AUTH = 2
317 struct mac_acl_entry *accept_mac;
319 struct mac_acl_entry *deny_mac;
325 int auth_algs; /* bitfield of allowed IEEE 802.11 authentication
326 * algorithms, WPA_AUTH_ALG_{OPEN,SHARED,LEAP} */
328 int wpa; /* bitfield of WPA_PROTO_WPA, WPA_PROTO_RSN */
330 #ifdef CONFIG_IEEE80211W
331 enum mfp_options ieee80211w;
332 int group_mgmt_cipher;
333 /* dot11AssociationSAQueryMaximumTimeout (in TUs) */
334 unsigned int assoc_sa_query_max_timeout;
335 /* dot11AssociationSAQueryRetryTimeout (in TUs) */
336 int assoc_sa_query_retry_timeout;
337 #endif /* CONFIG_IEEE80211W */
339 PSK_RADIUS_IGNORED = 0,
340 PSK_RADIUS_ACCEPTED = 1,
341 PSK_RADIUS_REQUIRED = 2
344 int group_cipher; /* wpa_group value override from configuation */
347 int wpa_group_rekey_set;
348 int wpa_strict_rekey;
351 u32 wpa_group_update_count;
352 u32 wpa_pairwise_update_count;
353 int wpa_disable_eapol_key_retries;
356 char *rsn_preauth_interfaces;
358 #ifdef CONFIG_IEEE80211R_AP
359 /* IEEE 802.11r - Fast BSS Transition */
360 u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
361 u8 r1_key_holder[FT_R1KH_ID_LEN];
362 u32 r0_key_lifetime; /* PMK-R0 lifetime seconds */
365 int rkh_pull_timeout; /* ms */
366 int rkh_pull_retries;
367 u32 reassociation_deadline;
368 struct ft_remote_r0kh *r0kh_list;
369 struct ft_remote_r1kh *r1kh_list;
372 int ft_psk_generate_local;
373 int r1_max_key_lifetime;
374 #endif /* CONFIG_IEEE80211R_AP */
376 char *ctrl_interface; /* directory for UNIX domain sockets */
377 #ifndef CONFIG_NATIVE_WINDOWS
378 gid_t ctrl_interface_gid;
379 #endif /* CONFIG_NATIVE_WINDOWS */
380 int ctrl_interface_gid_set;
385 char *private_key_passwd;
387 unsigned int tls_session_lifetime;
388 unsigned int tls_flags;
389 char *ocsp_stapling_response;
390 char *ocsp_stapling_response_multi;
392 char *openssl_ciphers;
393 u8 *pac_opaque_encr_key;
395 size_t eap_fast_a_id_len;
396 char *eap_fast_a_id_info;
398 int pac_key_lifetime;
399 int pac_key_refresh_time;
400 int eap_sim_aka_result_ind;
405 char *radius_server_clients;
406 int radius_server_auth_port;
407 int radius_server_acct_port;
408 int radius_server_ipv6;
410 int use_pae_group_addr; /* Whether to send EAPOL frames to PAE group
411 * address instead of individual address
412 * (for driver_wired.c).
415 int ap_max_inactivity;
416 int ignore_broadcast_ssid;
417 int no_probe_resp_if_max_sta;
422 struct hostapd_vlan *vlan;
427 * Maximum listen interval that STAs can use when associating with this
428 * BSS. If a STA tries to use larger value, the association will be
429 * denied with status code 51.
431 u16 max_listen_interval;
433 int disable_pmksa_caching;
434 int okc; /* Opportunistic Key Caching */
441 char *wps_pin_requests;
447 u8 device_type[WPS_DEV_TYPE_LEN];
448 char *config_methods;
453 size_t extra_cred_len;
454 int wps_cred_processing;
455 int force_per_enrollee_psk;
457 size_t ap_settings_len;
460 char *manufacturer_url;
461 char *model_description;
464 struct wpabuf *wps_vendor_ext[MAX_WPS_VENDOR_EXTENSIONS];
465 int wps_nfc_pw_from_config;
466 int wps_nfc_dev_pw_id;
467 struct wpabuf *wps_nfc_dh_pubkey;
468 struct wpabuf *wps_nfc_dh_privkey;
469 struct wpabuf *wps_nfc_dev_pw;
470 #endif /* CONFIG_WPS */
474 #define P2P_ENABLED BIT(0)
475 #define P2P_GROUP_OWNER BIT(1)
476 #define P2P_GROUP_FORMATION BIT(2)
477 #define P2P_MANAGE BIT(3)
478 #define P2P_ALLOW_CROSS_CONNECTION BIT(4)
485 #endif /* CONFIG_P2P */
487 int disassoc_low_ack;
488 int skip_inactivity_poll;
490 #define TDLS_PROHIBIT BIT(0)
491 #define TDLS_PROHIBIT_CHAN_SWITCH BIT(1)
497 int time_advertisement;
500 int wnm_sleep_mode_no_keys;
503 /* IEEE 802.11u - Interworking */
505 int access_network_type;
515 /* IEEE 802.11u - Roaming Consortium list */
516 unsigned int roaming_consortium_count;
517 struct hostapd_roaming_consortium *roaming_consortium;
519 /* IEEE 802.11u - Venue Name duples */
520 unsigned int venue_name_count;
521 struct hostapd_lang_string *venue_name;
523 /* Venue URL duples */
524 unsigned int venue_url_count;
525 struct hostapd_venue_url *venue_url;
527 /* IEEE 802.11u - Network Authentication Type */
528 u8 *network_auth_type;
529 size_t network_auth_type_len;
531 /* IEEE 802.11u - IP Address Type Availability */
532 u8 ipaddr_type_availability;
533 u8 ipaddr_type_configured;
535 /* IEEE 802.11u - 3GPP Cellular Network */
536 u8 *anqp_3gpp_cell_net;
537 size_t anqp_3gpp_cell_net_len;
539 /* IEEE 802.11u - Domain Name */
541 size_t domain_name_len;
543 unsigned int nai_realm_count;
544 struct hostapd_nai_realm_data *nai_realm_data;
546 struct dl_list anqp_elem; /* list of struct anqp_element */
548 u16 gas_comeback_delay;
549 size_t gas_frag_limit;
552 u8 qos_map_set[16 + 2 * 21];
553 unsigned int qos_map_set_len;
557 int na_mcast_to_ucast;
562 unsigned int hs20_oper_friendly_name_count;
563 struct hostapd_lang_string *hs20_oper_friendly_name;
564 u8 *hs20_wan_metrics;
565 u8 *hs20_connection_capability;
566 size_t hs20_connection_capability_len;
567 u8 *hs20_operating_class;
568 u8 hs20_operating_class_len;
577 size_t hs20_icons_count;
578 u8 osu_ssid[SSID_MAX_LEN];
580 struct hs20_osu_provider {
581 unsigned int friendly_name_count;
582 struct hostapd_lang_string *friendly_name;
589 unsigned int service_desc_count;
590 struct hostapd_lang_string *service_desc;
591 } *hs20_osu_providers, *last_osu;
592 size_t hs20_osu_providers_count;
593 size_t hs20_osu_providers_nai_count;
594 char **hs20_operator_icon;
595 size_t hs20_operator_icon_count;
596 unsigned int hs20_deauth_req_timeout;
597 char *subscr_remediation_url;
598 u8 subscr_remediation_method;
601 char *t_c_server_url;
602 #endif /* CONFIG_HS20 */
604 u8 wps_rf_bands; /* RF bands for WPS (WPS_RF_*) */
606 #ifdef CONFIG_RADIUS_TEST
608 #endif /* CONFIG_RADIUS_TEST */
610 struct wpabuf *vendor_elements;
611 struct wpabuf *assocresp_elements;
613 unsigned int sae_anti_clogging_threshold;
614 unsigned int sae_sync;
617 struct sae_password_entry *sae_passwords;
619 char *wowlan_triggers; /* Wake-on-WLAN triggers */
621 #ifdef CONFIG_TESTING_OPTIONS
623 u8 bss_load_test_set;
624 struct wpabuf *own_ie_override;
625 int sae_reflection_attack;
626 struct wpabuf *sae_commit_override;
627 #endif /* CONFIG_TESTING_OPTIONS */
629 #define MESH_ENABLED BIT(0)
632 u8 radio_measurements[RRM_CAPABILITIES_IE_LEN];
637 char *no_probe_resp_if_seen_on;
638 char *no_auth_if_seen_on;
645 * oce - Enable OCE in AP and/or STA-CFON mode
646 * - BIT(0) is Reserved
647 * - Set BIT(1) to enable OCE in STA-CFON mode
648 * - Set BIT(2) to enable OCE in AP mode
651 int mbo_cell_data_conn_pref;
652 #endif /* CONFIG_MBO */
658 u8 fils_cache_id[FILS_CACHE_ID_LEN];
659 int fils_cache_id_set;
660 struct dl_list fils_realms; /* list of struct fils_realm */
662 struct hostapd_ip_addr dhcp_server;
663 int dhcp_rapid_commit_proxy;
664 unsigned int fils_hlp_wait_time;
665 u16 dhcp_server_port;
667 #endif /* CONFIG_FILS */
669 int multicast_to_unicast;
671 int broadcast_deauth;
675 struct wpabuf *dpp_netaccesskey;
676 unsigned int dpp_netaccesskey_expiry;
677 struct wpabuf *dpp_csign;
678 #endif /* CONFIG_DPP */
681 macaddr owe_transition_bssid;
682 u8 owe_transition_ssid[SSID_MAX_LEN];
683 size_t owe_transition_ssid_len;
684 char owe_transition_ifname[IFNAMSIZ + 1];
686 #endif /* CONFIG_OWE */
688 int coloc_intf_reporting;
692 * struct he_phy_capabilities_info - HE PHY capabilities
694 struct he_phy_capabilities_info {
695 Boolean he_su_beamformer;
696 Boolean he_su_beamformee;
697 Boolean he_mu_beamformer;
701 * struct he_operation - HE operation
703 struct he_operation {
705 u8 he_default_pe_duration;
711 * struct hostapd_config - Per-radio interface configuration
713 struct hostapd_config {
714 struct hostapd_bss_config **bss, *last_bss;
720 u8 send_probe_response;
723 struct wpa_freq_range_list acs_ch_list;
725 enum hostapd_hw_mode hw_mode; /* HOSTAPD_MODE_IEEE80211A, .. */
731 int *supported_rates;
733 unsigned int beacon_rate;
734 enum beacon_rate_type rate_type;
736 const struct wpa_driver_ops *driver;
739 int ap_table_max_size;
740 int ap_table_expiration_time;
742 unsigned int track_sta_max_num;
743 unsigned int track_sta_max_age;
745 char country[3]; /* first two octets: country code as described in
746 * ISO/IEC 3166-1. Third octet:
747 * ' ' (ascii 32): all environments
748 * 'O': Outdoor environemnt only
749 * 'I': Indoor environment only
750 * 'X': Used with noncountry entity ("XXX")
751 * 0x00..0x31: identifying IEEE 802.11 standard
752 * Annex E table (0x04 = global table)
757 int ieee80211h; /* DFS */
760 * Local power constraint is an octet encoded as an unsigned integer in
761 * units of decibels. Invalid value -1 indicates that Power Constraint
762 * element will not be added.
764 int local_pwr_constraint;
766 /* Control Spectrum Management bit */
767 int spectrum_mgmt_required;
769 struct hostapd_tx_queue_params tx_queue[NUM_TX_QUEUES];
772 * WMM AC parameters, in same order as 802.1D, i.e.
773 * 0 = BE (best effort)
774 * 1 = BK (background)
778 struct hostapd_wmm_ac_params wmm_ac_params[4];
780 int ht_op_mode_fixed;
783 int secondary_channel;
784 int no_pri_sec_switch;
791 u8 vht_oper_centr_freq_seg0_idx;
792 u8 vht_oper_centr_freq_seg1_idx;
793 u8 ht40_plus_minus_allowed;
795 /* Use driver-generated interface addresses when adding multiple BSSs */
796 u8 use_driver_iface_addr;
799 struct fst_iface_cfg fst_cfg;
800 #endif /* CONFIG_FST */
804 #endif /* CONFIG_P2P */
806 #ifdef CONFIG_TESTING_OPTIONS
807 double ignore_probe_probability;
808 double ignore_auth_probability;
809 double ignore_assoc_probability;
810 double ignore_reassoc_probability;
811 double corrupt_gtk_rekey_mic_probability;
813 #endif /* CONFIG_TESTING_OPTIONS */
816 unsigned int acs_num_scans;
821 unsigned int num_acs_chan_bias;
822 #endif /* CONFIG_ACS */
825 struct wpabuf *civic;
829 #ifdef CONFIG_IEEE80211AX
830 struct he_phy_capabilities_info he_phy_capab;
831 struct he_operation he_op;
832 #endif /* CONFIG_IEEE80211AX */
834 /* VHT enable/disable config from CHAN_SWITCH */
835 #define CH_SWITCH_VHT_ENABLED BIT(0)
836 #define CH_SWITCH_VHT_DISABLED BIT(1)
837 unsigned int ch_switch_vht_config;
841 int hostapd_mac_comp(const void *a, const void *b);
842 struct hostapd_config * hostapd_config_defaults(void);
843 void hostapd_config_defaults_bss(struct hostapd_bss_config *bss);
844 void hostapd_config_free_eap_user(struct hostapd_eap_user *user);
845 void hostapd_config_free_eap_users(struct hostapd_eap_user *user);
846 void hostapd_config_clear_wpa_psk(struct hostapd_wpa_psk **p);
847 void hostapd_config_free_bss(struct hostapd_bss_config *conf);
848 void hostapd_config_free(struct hostapd_config *conf);
849 int hostapd_maclist_found(struct mac_acl_entry *list, int num_entries,
850 const u8 *addr, struct vlan_description *vlan_id);
851 int hostapd_rate_found(int *list, int rate);
852 const u8 * hostapd_get_psk(const struct hostapd_bss_config *conf,
853 const u8 *addr, const u8 *p2p_dev_addr,
855 int hostapd_setup_wpa_psk(struct hostapd_bss_config *conf);
856 int hostapd_vlan_valid(struct hostapd_vlan *vlan,
857 struct vlan_description *vlan_desc);
858 const char * hostapd_get_vlan_id_ifname(struct hostapd_vlan *vlan,
860 struct hostapd_radius_attr *
861 hostapd_config_get_radius_attr(struct hostapd_radius_attr *attr, u8 type);
862 int hostapd_config_check(struct hostapd_config *conf, int full_config);
863 void hostapd_set_security_params(struct hostapd_bss_config *bss,
866 #endif /* HOSTAPD_CONFIG_H */