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;
46 unsigned int pairwise_cipher;
47 unsigned int group_cipher;
48 unsigned int mgmt_group_cipher;
49 int dot11MeshMaxRetries;
50 int dot11MeshRetryTimeout; /* msec */
51 int dot11MeshConfirmTimeout; /* msec */
52 int dot11MeshHoldingTimeout; /* msec */
55 #define MAX_STA_COUNT 2007
56 #define MAX_VLAN_ID 4094
58 typedef u8 macaddr[ETH_ALEN];
60 struct mac_acl_entry {
62 struct vlan_description vlan_id;
65 struct hostapd_radius_servers;
66 struct ft_remote_r0kh;
67 struct ft_remote_r1kh;
69 #define NUM_WEP_KEYS 4
70 struct hostapd_wep_keys {
72 u8 *key[NUM_WEP_KEYS];
73 size_t len[NUM_WEP_KEYS];
75 size_t default_len; /* key length used for dynamic key generation */
78 typedef enum hostap_security_policy {
79 SECURITY_PLAINTEXT = 0,
80 SECURITY_STATIC_WEP = 1,
81 SECURITY_IEEE_802_1X = 2,
88 u8 ssid[SSID_MAX_LEN];
90 unsigned int ssid_set:1;
91 unsigned int utf8_ssid:1;
92 unsigned int wpa_passphrase_set:1;
93 unsigned int wpa_psk_set:1;
95 char vlan[IFNAMSIZ + 1];
96 secpolicy security_policy;
98 struct hostapd_wpa_psk *wpa_psk;
102 struct hostapd_wep_keys wep;
104 #define DYNAMIC_VLAN_DISABLED 0
105 #define DYNAMIC_VLAN_OPTIONAL 1
106 #define DYNAMIC_VLAN_REQUIRED 2
108 #define DYNAMIC_VLAN_NAMING_WITHOUT_DEVICE 0
109 #define DYNAMIC_VLAN_NAMING_WITH_DEVICE 1
110 #define DYNAMIC_VLAN_NAMING_END 2
113 #ifdef CONFIG_FULL_DYNAMIC_VLAN
114 char *vlan_tagged_interface;
115 #endif /* CONFIG_FULL_DYNAMIC_VLAN */
119 #define VLAN_ID_WILDCARD -1
121 struct hostapd_vlan {
122 struct hostapd_vlan *next;
123 int vlan_id; /* VLAN ID or -1 (VLAN_ID_WILDCARD) for wildcard entry */
124 struct vlan_description vlan_desc;
125 char ifname[IFNAMSIZ + 1];
126 char bridge[IFNAMSIZ + 1];
129 #ifdef CONFIG_FULL_DYNAMIC_VLAN
131 #define DVLAN_CLEAN_WLAN_PORT 0x8
133 #endif /* CONFIG_FULL_DYNAMIC_VLAN */
138 #define MIN_PASSPHRASE_LEN 8
139 #define MAX_PASSPHRASE_LEN 63
140 struct hostapd_sta_wpa_psk_short {
141 struct hostapd_sta_wpa_psk_short *next;
142 unsigned int is_passphrase:1;
144 char passphrase[MAX_PASSPHRASE_LEN + 1];
145 int ref; /* (number of references held) - 1 */
148 struct hostapd_wpa_psk {
149 struct hostapd_wpa_psk *next;
151 char keyid[KEYID_LEN];
154 u8 p2p_dev_addr[ETH_ALEN];
158 struct hostapd_eap_user {
159 struct hostapd_eap_user *next;
165 } methods[EAP_MAX_METHODS];
169 size_t salt_len; /* non-zero when password is salted */
172 unsigned int wildcard_prefix:1;
173 unsigned int password_hash:1; /* whether password is hashed with
174 * nt_password_hash() */
175 unsigned int remediation:1;
176 unsigned int macacl:1;
177 int ttls_auth; /* EAP_TTLS_AUTH_* bitfield */
178 struct hostapd_radius_attr *accept_attr;
182 struct hostapd_radius_attr {
185 struct hostapd_radius_attr *next;
189 #define NUM_TX_QUEUES 4
191 struct hostapd_tx_queue_params {
195 int burst; /* maximum burst time in 0.1 ms, i.e., 10 = 1 ms */
199 #define MAX_ROAMING_CONSORTIUM_LEN 15
201 struct hostapd_roaming_consortium {
203 u8 oi[MAX_ROAMING_CONSORTIUM_LEN];
206 struct hostapd_lang_string {
212 struct hostapd_venue_url {
218 #define MAX_NAI_REALMS 10
219 #define MAX_NAI_REALMLEN 255
220 #define MAX_NAI_EAP_METHODS 5
221 #define MAX_NAI_AUTH_TYPES 4
222 struct hostapd_nai_realm_data {
224 char realm_buf[MAX_NAI_REALMLEN + 1];
225 char *realm[MAX_NAI_REALMS];
227 struct hostapd_nai_realm_eap {
230 u8 auth_id[MAX_NAI_AUTH_TYPES];
231 u8 auth_val[MAX_NAI_AUTH_TYPES];
232 } eap_method[MAX_NAI_EAP_METHODS];
235 struct anqp_element {
238 struct wpabuf *payload;
247 struct sae_password_entry {
248 struct sae_password_entry *next;
251 u8 peer_addr[ETH_ALEN];
256 * struct hostapd_bss_config - Per-BSS configuration
258 struct hostapd_bss_config {
259 char iface[IFNAMSIZ + 1];
260 char bridge[IFNAMSIZ + 1];
261 char vlan_bridge[IFNAMSIZ + 1];
262 char wds_bridge[IFNAMSIZ + 1];
264 enum hostapd_logger_level logger_syslog_level, logger_stdout_level;
266 unsigned int logger_syslog; /* module bitfield */
267 unsigned int logger_stdout; /* module bitfield */
269 int max_num_sta; /* maximum number of STAs in station table */
272 unsigned int bss_load_update_period;
273 unsigned int chan_util_avg_period;
275 int ieee802_1x; /* use IEEE 802.1X */
277 int eap_server; /* Use internal EAP server instead of external
279 struct hostapd_eap_user *eap_user;
280 char *eap_user_sqlite;
282 unsigned int eap_sim_db_timeout;
283 int eap_server_erp; /* Whether ERP is enabled on internal EAP server */
284 struct hostapd_ip_addr own_ip_addr;
285 char *nas_identifier;
286 struct hostapd_radius_servers *radius;
287 int acct_interim_interval;
288 int radius_request_cui;
289 struct hostapd_radius_attr *radius_auth_req_attr;
290 struct hostapd_radius_attr *radius_acct_req_attr;
292 unsigned int radius_das_time_window;
293 int radius_das_require_event_timestamp;
294 int radius_das_require_message_authenticator;
295 struct hostapd_ip_addr radius_das_client_addr;
296 u8 *radius_das_shared_secret;
297 size_t radius_das_shared_secret_len;
299 struct hostapd_ssid ssid;
301 char *eap_req_id_text; /* optional displayable message sent with
302 * EAP Request-Identity */
303 size_t eap_req_id_text_len;
304 int eapol_key_index_workaround;
306 size_t default_wep_key_len;
307 int individual_wep_key_len;
308 int wep_rekeying_period;
309 int broadcast_key_idx_min, broadcast_key_idx_max;
310 int eap_reauth_period;
311 int erp_send_reauth_start;
314 int ieee802_11f; /* use IEEE 802.11f (IAPP) */
315 char iapp_iface[IFNAMSIZ + 1]; /* interface used with IAPP broadcast
319 ACCEPT_UNLESS_DENIED = 0,
320 DENY_UNLESS_ACCEPTED = 1,
321 USE_EXTERNAL_RADIUS_AUTH = 2
323 struct mac_acl_entry *accept_mac;
325 struct mac_acl_entry *deny_mac;
331 int auth_algs; /* bitfield of allowed IEEE 802.11 authentication
332 * algorithms, WPA_AUTH_ALG_{OPEN,SHARED,LEAP} */
334 int wpa; /* bitfield of WPA_PROTO_WPA, WPA_PROTO_RSN */
336 #ifdef CONFIG_IEEE80211W
337 enum mfp_options ieee80211w;
338 int group_mgmt_cipher;
339 /* dot11AssociationSAQueryMaximumTimeout (in TUs) */
340 unsigned int assoc_sa_query_max_timeout;
341 /* dot11AssociationSAQueryRetryTimeout (in TUs) */
342 int assoc_sa_query_retry_timeout;
343 #endif /* CONFIG_IEEE80211W */
345 int ocv; /* Operating Channel Validation */
346 #endif /* CONFIG_OCV */
348 PSK_RADIUS_IGNORED = 0,
349 PSK_RADIUS_ACCEPTED = 1,
350 PSK_RADIUS_REQUIRED = 2
353 int group_cipher; /* wpa_group value override from configuation */
356 int wpa_group_rekey_set;
357 int wpa_strict_rekey;
360 u32 wpa_group_update_count;
361 u32 wpa_pairwise_update_count;
362 int wpa_disable_eapol_key_retries;
365 char *rsn_preauth_interfaces;
367 #ifdef CONFIG_IEEE80211R_AP
368 /* IEEE 802.11r - Fast BSS Transition */
369 u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
370 u8 r1_key_holder[FT_R1KH_ID_LEN];
371 u32 r0_key_lifetime; /* PMK-R0 lifetime seconds */
374 int rkh_pull_timeout; /* ms */
375 int rkh_pull_retries;
376 u32 reassociation_deadline;
377 struct ft_remote_r0kh *r0kh_list;
378 struct ft_remote_r1kh *r1kh_list;
381 int ft_psk_generate_local;
382 int r1_max_key_lifetime;
383 #endif /* CONFIG_IEEE80211R_AP */
385 char *ctrl_interface; /* directory for UNIX domain sockets */
386 #ifndef CONFIG_NATIVE_WINDOWS
387 gid_t ctrl_interface_gid;
388 #endif /* CONFIG_NATIVE_WINDOWS */
389 int ctrl_interface_gid_set;
394 char *private_key_passwd;
395 char *check_cert_subject;
397 int check_crl_strict;
398 unsigned int crl_reload_interval;
399 unsigned int tls_session_lifetime;
400 unsigned int tls_flags;
401 char *ocsp_stapling_response;
402 char *ocsp_stapling_response_multi;
404 char *openssl_ciphers;
405 char *openssl_ecdh_curves;
406 u8 *pac_opaque_encr_key;
408 size_t eap_fast_a_id_len;
409 char *eap_fast_a_id_info;
411 int pac_key_lifetime;
412 int pac_key_refresh_time;
413 int eap_sim_aka_result_ind;
418 char *radius_server_clients;
419 int radius_server_auth_port;
420 int radius_server_acct_port;
421 int radius_server_ipv6;
423 int use_pae_group_addr; /* Whether to send EAPOL frames to PAE group
424 * address instead of individual address
425 * (for driver_wired.c).
428 int ap_max_inactivity;
429 int ignore_broadcast_ssid;
430 int no_probe_resp_if_max_sta;
435 struct hostapd_vlan *vlan;
440 * Maximum listen interval that STAs can use when associating with this
441 * BSS. If a STA tries to use larger value, the association will be
442 * denied with status code 51.
444 u16 max_listen_interval;
446 int disable_pmksa_caching;
447 int okc; /* Opportunistic Key Caching */
454 char *wps_pin_requests;
460 u8 device_type[WPS_DEV_TYPE_LEN];
461 char *config_methods;
466 size_t extra_cred_len;
467 int wps_cred_processing;
468 int wps_cred_add_sae;
469 int force_per_enrollee_psk;
471 size_t ap_settings_len;
472 struct hostapd_ssid multi_ap_backhaul_ssid;
475 char *manufacturer_url;
476 char *model_description;
479 struct wpabuf *wps_vendor_ext[MAX_WPS_VENDOR_EXTENSIONS];
480 int wps_nfc_pw_from_config;
481 int wps_nfc_dev_pw_id;
482 struct wpabuf *wps_nfc_dh_pubkey;
483 struct wpabuf *wps_nfc_dh_privkey;
484 struct wpabuf *wps_nfc_dev_pw;
485 #endif /* CONFIG_WPS */
489 #define P2P_ENABLED BIT(0)
490 #define P2P_GROUP_OWNER BIT(1)
491 #define P2P_GROUP_FORMATION BIT(2)
492 #define P2P_MANAGE BIT(3)
493 #define P2P_ALLOW_CROSS_CONNECTION BIT(4)
500 #endif /* CONFIG_P2P */
502 int disassoc_low_ack;
503 int skip_inactivity_poll;
505 #define TDLS_PROHIBIT BIT(0)
506 #define TDLS_PROHIBIT_CHAN_SWITCH BIT(1)
512 int time_advertisement;
515 int wnm_sleep_mode_no_keys;
518 /* IEEE 802.11u - Interworking */
520 int access_network_type;
530 /* IEEE 802.11u - Roaming Consortium list */
531 unsigned int roaming_consortium_count;
532 struct hostapd_roaming_consortium *roaming_consortium;
534 /* IEEE 802.11u - Venue Name duples */
535 unsigned int venue_name_count;
536 struct hostapd_lang_string *venue_name;
538 /* Venue URL duples */
539 unsigned int venue_url_count;
540 struct hostapd_venue_url *venue_url;
542 /* IEEE 802.11u - Network Authentication Type */
543 u8 *network_auth_type;
544 size_t network_auth_type_len;
546 /* IEEE 802.11u - IP Address Type Availability */
547 u8 ipaddr_type_availability;
548 u8 ipaddr_type_configured;
550 /* IEEE 802.11u - 3GPP Cellular Network */
551 u8 *anqp_3gpp_cell_net;
552 size_t anqp_3gpp_cell_net_len;
554 /* IEEE 802.11u - Domain Name */
556 size_t domain_name_len;
558 unsigned int nai_realm_count;
559 struct hostapd_nai_realm_data *nai_realm_data;
561 struct dl_list anqp_elem; /* list of struct anqp_element */
563 u16 gas_comeback_delay;
564 size_t gas_frag_limit;
567 u8 qos_map_set[16 + 2 * 21];
568 unsigned int qos_map_set_len;
572 int na_mcast_to_ucast;
578 unsigned int hs20_oper_friendly_name_count;
579 struct hostapd_lang_string *hs20_oper_friendly_name;
580 u8 *hs20_wan_metrics;
581 u8 *hs20_connection_capability;
582 size_t hs20_connection_capability_len;
583 u8 *hs20_operating_class;
584 u8 hs20_operating_class_len;
593 size_t hs20_icons_count;
594 u8 osu_ssid[SSID_MAX_LEN];
596 struct hs20_osu_provider {
597 unsigned int friendly_name_count;
598 struct hostapd_lang_string *friendly_name;
605 unsigned int service_desc_count;
606 struct hostapd_lang_string *service_desc;
607 } *hs20_osu_providers, *last_osu;
608 size_t hs20_osu_providers_count;
609 size_t hs20_osu_providers_nai_count;
610 char **hs20_operator_icon;
611 size_t hs20_operator_icon_count;
612 unsigned int hs20_deauth_req_timeout;
613 char *subscr_remediation_url;
614 u8 subscr_remediation_method;
615 char *hs20_sim_provisioning_url;
618 char *t_c_server_url;
619 #endif /* CONFIG_HS20 */
621 u8 wps_rf_bands; /* RF bands for WPS (WPS_RF_*) */
623 #ifdef CONFIG_RADIUS_TEST
625 #endif /* CONFIG_RADIUS_TEST */
627 struct wpabuf *vendor_elements;
628 struct wpabuf *assocresp_elements;
630 unsigned int sae_anti_clogging_threshold;
631 unsigned int sae_sync;
634 struct sae_password_entry *sae_passwords;
636 char *wowlan_triggers; /* Wake-on-WLAN triggers */
638 #ifdef CONFIG_TESTING_OPTIONS
640 u8 bss_load_test_set;
641 struct wpabuf *own_ie_override;
642 int sae_reflection_attack;
643 struct wpabuf *sae_commit_override;
644 #endif /* CONFIG_TESTING_OPTIONS */
646 #define MESH_ENABLED BIT(0)
649 u8 radio_measurements[RRM_CAPABILITIES_IE_LEN];
654 char *no_probe_resp_if_seen_on;
655 char *no_auth_if_seen_on;
662 * oce - Enable OCE in AP and/or STA-CFON mode
663 * - BIT(0) is Reserved
664 * - Set BIT(1) to enable OCE in STA-CFON mode
665 * - Set BIT(2) to enable OCE in AP mode
668 int mbo_cell_data_conn_pref;
669 #endif /* CONFIG_MBO */
675 u8 fils_cache_id[FILS_CACHE_ID_LEN];
676 int fils_cache_id_set;
677 struct dl_list fils_realms; /* list of struct fils_realm */
679 struct hostapd_ip_addr dhcp_server;
680 int dhcp_rapid_commit_proxy;
681 unsigned int fils_hlp_wait_time;
682 u16 dhcp_server_port;
684 #endif /* CONFIG_FILS */
686 int multicast_to_unicast;
688 int broadcast_deauth;
692 struct wpabuf *dpp_netaccesskey;
693 unsigned int dpp_netaccesskey_expiry;
694 struct wpabuf *dpp_csign;
695 #endif /* CONFIG_DPP */
698 macaddr owe_transition_bssid;
699 u8 owe_transition_ssid[SSID_MAX_LEN];
700 size_t owe_transition_ssid_len;
701 char owe_transition_ifname[IFNAMSIZ + 1];
703 #endif /* CONFIG_OWE */
705 int coloc_intf_reporting;
707 u8 send_probe_response;
709 #define BACKHAUL_BSS 1
710 #define FRONTHAUL_BSS 2
711 int multi_ap; /* bitmap of BACKHAUL_BSS, FRONTHAUL_BSS */
715 * struct he_phy_capabilities_info - HE PHY capabilities
717 struct he_phy_capabilities_info {
718 Boolean he_su_beamformer;
719 Boolean he_su_beamformee;
720 Boolean he_mu_beamformer;
724 * struct he_operation - HE operation
726 struct he_operation {
728 u8 he_default_pe_duration;
734 * struct hostapd_config - Per-radio interface configuration
736 struct hostapd_config {
737 struct hostapd_bss_config **bss, *last_bss;
745 struct wpa_freq_range_list acs_ch_list;
747 enum hostapd_hw_mode hw_mode; /* HOSTAPD_MODE_IEEE80211A, .. */
753 int *supported_rates;
755 unsigned int beacon_rate;
756 enum beacon_rate_type rate_type;
758 const struct wpa_driver_ops *driver;
761 int ap_table_max_size;
762 int ap_table_expiration_time;
764 unsigned int track_sta_max_num;
765 unsigned int track_sta_max_age;
767 char country[3]; /* first two octets: country code as described in
768 * ISO/IEC 3166-1. Third octet:
769 * ' ' (ascii 32): all environments
770 * 'O': Outdoor environemnt only
771 * 'I': Indoor environment only
772 * 'X': Used with noncountry entity ("XXX")
773 * 0x00..0x31: identifying IEEE 802.11 standard
774 * Annex E table (0x04 = global table)
779 int ieee80211h; /* DFS */
782 * Local power constraint is an octet encoded as an unsigned integer in
783 * units of decibels. Invalid value -1 indicates that Power Constraint
784 * element will not be added.
786 int local_pwr_constraint;
788 /* Control Spectrum Management bit */
789 int spectrum_mgmt_required;
791 struct hostapd_tx_queue_params tx_queue[NUM_TX_QUEUES];
794 * WMM AC parameters, in same order as 802.1D, i.e.
795 * 0 = BE (best effort)
796 * 1 = BK (background)
800 struct hostapd_wmm_ac_params wmm_ac_params[4];
802 int ht_op_mode_fixed;
805 int secondary_channel;
806 int no_pri_sec_switch;
813 u8 vht_oper_centr_freq_seg0_idx;
814 u8 vht_oper_centr_freq_seg1_idx;
815 u8 ht40_plus_minus_allowed;
817 /* Use driver-generated interface addresses when adding multiple BSSs */
818 u8 use_driver_iface_addr;
821 struct fst_iface_cfg fst_cfg;
822 #endif /* CONFIG_FST */
826 #endif /* CONFIG_P2P */
828 #ifdef CONFIG_TESTING_OPTIONS
829 double ignore_probe_probability;
830 double ignore_auth_probability;
831 double ignore_assoc_probability;
832 double ignore_reassoc_probability;
833 double corrupt_gtk_rekey_mic_probability;
835 #endif /* CONFIG_TESTING_OPTIONS */
838 unsigned int acs_num_scans;
843 unsigned int num_acs_chan_bias;
844 #endif /* CONFIG_ACS */
847 struct wpabuf *civic;
851 #ifdef CONFIG_IEEE80211AX
852 struct he_phy_capabilities_info he_phy_capab;
853 struct he_operation he_op;
854 struct ieee80211_he_mu_edca_parameter_set he_mu_edca;
855 #endif /* CONFIG_IEEE80211AX */
857 /* VHT enable/disable config from CHAN_SWITCH */
858 #define CH_SWITCH_VHT_ENABLED BIT(0)
859 #define CH_SWITCH_VHT_DISABLED BIT(1)
860 unsigned int ch_switch_vht_config;
862 int rssi_reject_assoc_rssi;
863 int rssi_reject_assoc_timeout;
867 int hostapd_mac_comp(const void *a, const void *b);
868 struct hostapd_config * hostapd_config_defaults(void);
869 void hostapd_config_defaults_bss(struct hostapd_bss_config *bss);
870 void hostapd_config_free_eap_user(struct hostapd_eap_user *user);
871 void hostapd_config_free_eap_users(struct hostapd_eap_user *user);
872 void hostapd_config_clear_wpa_psk(struct hostapd_wpa_psk **p);
873 void hostapd_config_free_bss(struct hostapd_bss_config *conf);
874 void hostapd_config_free(struct hostapd_config *conf);
875 int hostapd_maclist_found(struct mac_acl_entry *list, int num_entries,
876 const u8 *addr, struct vlan_description *vlan_id);
877 int hostapd_rate_found(int *list, int rate);
878 const u8 * hostapd_get_psk(const struct hostapd_bss_config *conf,
879 const u8 *addr, const u8 *p2p_dev_addr,
880 const u8 *prev_psk, int *vlan_id);
881 int hostapd_setup_wpa_psk(struct hostapd_bss_config *conf);
882 int hostapd_vlan_valid(struct hostapd_vlan *vlan,
883 struct vlan_description *vlan_desc);
884 const char * hostapd_get_vlan_id_ifname(struct hostapd_vlan *vlan,
886 struct hostapd_radius_attr *
887 hostapd_config_get_radius_attr(struct hostapd_radius_attr *attr, u8 type);
888 int hostapd_config_check(struct hostapd_config *conf, int full_config);
889 void hostapd_set_security_params(struct hostapd_bss_config *bss,
891 int hostapd_sae_pw_id_in_use(struct hostapd_bss_config *conf);
893 #endif /* HOSTAPD_CONFIG_H */