src/ap/ap_config.h

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