Home | History | Annotate | Line # | Download | only in wpa_supplicant
wpa_supplicant.conf revision 1.1.1.3.4.2
      1          1.1  christos ##### Example wpa_supplicant configuration file ###############################
      2          1.1  christos #
      3          1.1  christos # This file describes configuration file format and lists all available option.
      4          1.1  christos # Please also take a look at simpler configuration examples in 'examples'
      5          1.1  christos # subdirectory.
      6          1.1  christos #
      7          1.1  christos # Empty lines and lines starting with # are ignored
      8          1.1  christos 
      9          1.1  christos # NOTE! This file may contain password information and should probably be made
     10          1.1  christos # readable only by root user on multiuser systems.
     11          1.1  christos 
     12          1.1  christos # Note: All file paths in this configuration file should use full (absolute,
     13          1.1  christos # not relative to working directory) path in order to allow working directory
     14          1.1  christos # to be changed. This can happen if wpa_supplicant is run in the background.
     15          1.1  christos 
     16          1.1  christos # Whether to allow wpa_supplicant to update (overwrite) configuration
     17          1.1  christos #
     18          1.1  christos # This option can be used to allow wpa_supplicant to overwrite configuration
     19          1.1  christos # file whenever configuration is changed (e.g., new network block is added with
     20          1.1  christos # wpa_cli or wpa_gui, or a password is changed). This is required for
     21          1.1  christos # wpa_cli/wpa_gui to be able to store the configuration changes permanently.
     22          1.1  christos # Please note that overwriting configuration file will remove the comments from
     23          1.1  christos # it.
     24          1.1  christos #update_config=1
     25          1.1  christos 
     26          1.1  christos # global configuration (shared by all network blocks)
     27          1.1  christos #
     28          1.1  christos # Parameters for the control interface. If this is specified, wpa_supplicant
     29          1.1  christos # will open a control interface that is available for external programs to
     30          1.1  christos # manage wpa_supplicant. The meaning of this string depends on which control
     31      1.1.1.2  christos # interface mechanism is used. For all cases, the existence of this parameter
     32          1.1  christos # in configuration is used to determine whether the control interface is
     33          1.1  christos # enabled.
     34          1.1  christos #
     35          1.1  christos # For UNIX domain sockets (default on Linux and BSD): This is a directory that
     36          1.1  christos # will be created for UNIX domain sockets for listening to requests from
     37          1.1  christos # external programs (CLI/GUI, etc.) for status information and configuration.
     38          1.1  christos # The socket file will be named based on the interface name, so multiple
     39          1.1  christos # wpa_supplicant processes can be run at the same time if more than one
     40          1.1  christos # interface is used.
     41          1.1  christos # /var/run/wpa_supplicant is the recommended directory for sockets and by
     42          1.1  christos # default, wpa_cli will use it when trying to connect with wpa_supplicant.
     43          1.1  christos #
     44          1.1  christos # Access control for the control interface can be configured by setting the
     45          1.1  christos # directory to allow only members of a group to use sockets. This way, it is
     46          1.1  christos # possible to run wpa_supplicant as root (since it needs to change network
     47          1.1  christos # configuration and open raw sockets) and still allow GUI/CLI components to be
     48          1.1  christos # run as non-root users. However, since the control interface can be used to
     49          1.1  christos # change the network configuration, this access needs to be protected in many
     50          1.1  christos # cases. By default, wpa_supplicant is configured to use gid 0 (root). If you
     51          1.1  christos # want to allow non-root users to use the control interface, add a new group
     52          1.1  christos # and change this value to match with that group. Add users that should have
     53          1.1  christos # control interface access to this group. If this variable is commented out or
     54          1.1  christos # not included in the configuration file, group will not be changed from the
     55          1.1  christos # value it got by default when the directory or socket was created.
     56          1.1  christos #
     57          1.1  christos # When configuring both the directory and group, use following format:
     58          1.1  christos # DIR=/var/run/wpa_supplicant GROUP=wheel
     59          1.1  christos # DIR=/var/run/wpa_supplicant GROUP=0
     60          1.1  christos # (group can be either group name or gid)
     61          1.1  christos #
     62          1.1  christos # For UDP connections (default on Windows): The value will be ignored. This
     63          1.1  christos # variable is just used to select that the control interface is to be created.
     64          1.1  christos # The value can be set to, e.g., udp (ctrl_interface=udp)
     65          1.1  christos #
     66          1.1  christos # For Windows Named Pipe: This value can be used to set the security descriptor
     67          1.1  christos # for controlling access to the control interface. Security descriptor can be
     68          1.1  christos # set using Security Descriptor String Format (see http://msdn.microsoft.com/
     69          1.1  christos # library/default.asp?url=/library/en-us/secauthz/security/
     70          1.1  christos # security_descriptor_string_format.asp). The descriptor string needs to be
     71          1.1  christos # prefixed with SDDL=. For example, ctrl_interface=SDDL=D: would set an empty
     72          1.1  christos # DACL (which will reject all connections). See README-Windows.txt for more
     73          1.1  christos # information about SDDL string format.
     74          1.1  christos #
     75          1.1  christos ctrl_interface=/var/run/wpa_supplicant
     76          1.1  christos 
     77          1.1  christos # IEEE 802.1X/EAPOL version
     78          1.1  christos # wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which defines
     79          1.1  christos # EAPOL version 2. However, there are many APs that do not handle the new
     80          1.1  christos # version number correctly (they seem to drop the frames completely). In order
     81          1.1  christos # to make wpa_supplicant interoperate with these APs, the version number is set
     82          1.1  christos # to 1 by default. This configuration value can be used to set it to the new
     83          1.1  christos # version (2).
     84  1.1.1.3.4.1       snj # Note: When using MACsec, eapol_version shall be set to 3, which is
     85  1.1.1.3.4.1       snj # defined in IEEE Std 802.1X-2010.
     86          1.1  christos eapol_version=1
     87          1.1  christos 
     88          1.1  christos # AP scanning/selection
     89          1.1  christos # By default, wpa_supplicant requests driver to perform AP scanning and then
     90          1.1  christos # uses the scan results to select a suitable AP. Another alternative is to
     91          1.1  christos # allow the driver to take care of AP scanning and selection and use
     92          1.1  christos # wpa_supplicant just to process EAPOL frames based on IEEE 802.11 association
     93          1.1  christos # information from the driver.
     94          1.1  christos # 1: wpa_supplicant initiates scanning and AP selection; if no APs matching to
     95          1.1  christos #    the currently enabled networks are found, a new network (IBSS or AP mode
     96          1.1  christos #    operation) may be initialized (if configured) (default)
     97          1.1  christos # 0: driver takes care of scanning, AP selection, and IEEE 802.11 association
     98          1.1  christos #    parameters (e.g., WPA IE generation); this mode can also be used with
     99          1.1  christos #    non-WPA drivers when using IEEE 802.1X mode; do not try to associate with
    100          1.1  christos #    APs (i.e., external program needs to control association). This mode must
    101          1.1  christos #    also be used when using wired Ethernet drivers.
    102  1.1.1.3.4.1       snj #    Note: macsec_qca driver is one type of Ethernet driver which implements
    103  1.1.1.3.4.1       snj #    macsec feature.
    104          1.1  christos # 2: like 0, but associate with APs using security policy and SSID (but not
    105          1.1  christos #    BSSID); this can be used, e.g., with ndiswrapper and NDIS drivers to
    106          1.1  christos #    enable operation with hidden SSIDs and optimized roaming; in this mode,
    107          1.1  christos #    the network blocks in the configuration file are tried one by one until
    108          1.1  christos #    the driver reports successful association; each network block should have
    109          1.1  christos #    explicit security policy (i.e., only one option in the lists) for
    110          1.1  christos #    key_mgmt, pairwise, group, proto variables
    111  1.1.1.3.4.2       snj # Note: ap_scan=2 should not be used with the nl80211 driver interface (the
    112  1.1.1.3.4.2       snj # current Linux interface). ap_scan=1 is optimized work working with nl80211.
    113  1.1.1.3.4.2       snj # For finding networks using hidden SSID, scan_ssid=1 in the network block can
    114  1.1.1.3.4.2       snj # be used with nl80211.
    115          1.1  christos # When using IBSS or AP mode, ap_scan=2 mode can force the new network to be
    116          1.1  christos # created immediately regardless of scan results. ap_scan=1 mode will first try
    117          1.1  christos # to scan for existing networks and only if no matches with the enabled
    118          1.1  christos # networks are found, a new IBSS or AP mode network is created.
    119          1.1  christos ap_scan=1
    120          1.1  christos 
    121  1.1.1.3.4.2       snj # Whether to force passive scan for network connection
    122  1.1.1.3.4.2       snj #
    123  1.1.1.3.4.2       snj # By default, scans will send out Probe Request frames on channels that allow
    124  1.1.1.3.4.2       snj # active scanning. This advertise the local station to the world. Normally this
    125  1.1.1.3.4.2       snj # is fine, but users may wish to do passive scanning where the radio should only
    126  1.1.1.3.4.2       snj # listen quietly for Beacon frames and not send any Probe Request frames. Actual
    127  1.1.1.3.4.2       snj # functionality may be driver dependent.
    128  1.1.1.3.4.2       snj #
    129  1.1.1.3.4.2       snj # This parameter can be used to force only passive scanning to be used
    130  1.1.1.3.4.2       snj # for network connection cases. It should be noted that this will slow
    131  1.1.1.3.4.2       snj # down scan operations and reduce likelihood of finding the AP. In
    132  1.1.1.3.4.2       snj # addition, some use cases will override this due to functional
    133  1.1.1.3.4.2       snj # requirements, e.g., for finding an AP that uses hidden SSID
    134  1.1.1.3.4.2       snj # (scan_ssid=1) or P2P device discovery.
    135  1.1.1.3.4.2       snj #
    136  1.1.1.3.4.2       snj # 0:  Do normal scans (allow active scans) (default)
    137  1.1.1.3.4.2       snj # 1:  Do passive scans.
    138  1.1.1.3.4.2       snj #passive_scan=0
    139  1.1.1.3.4.2       snj 
    140  1.1.1.3.4.1       snj # MPM residency
    141  1.1.1.3.4.1       snj # By default, wpa_supplicant implements the mesh peering manager (MPM) for an
    142  1.1.1.3.4.1       snj # open mesh. However, if the driver can implement the MPM, you may set this to
    143  1.1.1.3.4.1       snj # 0 to use the driver version. When AMPE is enabled, the wpa_supplicant MPM is
    144  1.1.1.3.4.1       snj # always used.
    145  1.1.1.3.4.1       snj # 0: MPM lives in the driver
    146  1.1.1.3.4.1       snj # 1: wpa_supplicant provides an MPM which handles peering (default)
    147  1.1.1.3.4.1       snj #user_mpm=1
    148  1.1.1.3.4.1       snj 
    149  1.1.1.3.4.1       snj # Maximum number of peer links (0-255; default: 99)
    150  1.1.1.3.4.1       snj # Maximum number of mesh peering currently maintained by the STA.
    151  1.1.1.3.4.1       snj #max_peer_links=99
    152  1.1.1.3.4.1       snj 
    153  1.1.1.3.4.1       snj # Timeout in seconds to detect STA inactivity (default: 300 seconds)
    154  1.1.1.3.4.1       snj #
    155  1.1.1.3.4.1       snj # This timeout value is used in mesh STA to clean up inactive stations.
    156  1.1.1.3.4.1       snj #mesh_max_inactivity=300
    157  1.1.1.3.4.1       snj 
    158  1.1.1.3.4.1       snj # cert_in_cb - Whether to include a peer certificate dump in events
    159  1.1.1.3.4.1       snj # This controls whether peer certificates for authentication server and
    160  1.1.1.3.4.1       snj # its certificate chain are included in EAP peer certificate events. This is
    161  1.1.1.3.4.1       snj # enabled by default.
    162  1.1.1.3.4.1       snj #cert_in_cb=1
    163  1.1.1.3.4.1       snj 
    164          1.1  christos # EAP fast re-authentication
    165          1.1  christos # By default, fast re-authentication is enabled for all EAP methods that
    166          1.1  christos # support it. This variable can be used to disable fast re-authentication.
    167          1.1  christos # Normally, there is no need to disable this.
    168          1.1  christos fast_reauth=1
    169          1.1  christos 
    170          1.1  christos # OpenSSL Engine support
    171  1.1.1.3.4.2       snj # These options can be used to load OpenSSL engines in special or legacy
    172  1.1.1.3.4.2       snj # modes.
    173          1.1  christos # The two engines that are supported currently are shown below:
    174          1.1  christos # They are both from the opensc project (http://www.opensc.org/)
    175  1.1.1.3.4.2       snj # By default the PKCS#11 engine is loaded if the client_cert or
    176  1.1.1.3.4.2       snj # private_key option appear to be a PKCS#11 URI, and these options
    177  1.1.1.3.4.2       snj # should not need to be used explicitly.
    178          1.1  christos # make the opensc engine available
    179          1.1  christos #opensc_engine_path=/usr/lib/opensc/engine_opensc.so
    180          1.1  christos # make the pkcs11 engine available
    181          1.1  christos #pkcs11_engine_path=/usr/lib/opensc/engine_pkcs11.so
    182          1.1  christos # configure the path to the pkcs11 module required by the pkcs11 engine
    183          1.1  christos #pkcs11_module_path=/usr/lib/pkcs11/opensc-pkcs11.so
    184          1.1  christos 
    185  1.1.1.3.4.1       snj # OpenSSL cipher string
    186  1.1.1.3.4.1       snj #
    187  1.1.1.3.4.1       snj # This is an OpenSSL specific configuration option for configuring the default
    188  1.1.1.3.4.1       snj # ciphers. If not set, "DEFAULT:!EXP:!LOW" is used as the default.
    189  1.1.1.3.4.1       snj # See https://www.openssl.org/docs/apps/ciphers.html for OpenSSL documentation
    190  1.1.1.3.4.1       snj # on cipher suite configuration. This is applicable only if wpa_supplicant is
    191  1.1.1.3.4.1       snj # built to use OpenSSL.
    192  1.1.1.3.4.1       snj #openssl_ciphers=DEFAULT:!EXP:!LOW
    193  1.1.1.3.4.1       snj 
    194  1.1.1.3.4.1       snj 
    195          1.1  christos # Dynamic EAP methods
    196          1.1  christos # If EAP methods were built dynamically as shared object files, they need to be
    197          1.1  christos # loaded here before being used in the network blocks. By default, EAP methods
    198          1.1  christos # are included statically in the build, so these lines are not needed
    199          1.1  christos #load_dynamic_eap=/usr/lib/wpa_supplicant/eap_tls.so
    200          1.1  christos #load_dynamic_eap=/usr/lib/wpa_supplicant/eap_md5.so
    201          1.1  christos 
    202          1.1  christos # Driver interface parameters
    203  1.1.1.3.4.2       snj # This field can be used to configure arbitrary driver interface parameters. The
    204          1.1  christos # format is specific to the selected driver interface. This field is not used
    205          1.1  christos # in most cases.
    206          1.1  christos #driver_param="field=value"
    207          1.1  christos 
    208          1.1  christos # Country code
    209          1.1  christos # The ISO/IEC alpha2 country code for the country in which this device is
    210          1.1  christos # currently operating.
    211          1.1  christos #country=US
    212          1.1  christos 
    213          1.1  christos # Maximum lifetime for PMKSA in seconds; default 43200
    214          1.1  christos #dot11RSNAConfigPMKLifetime=43200
    215          1.1  christos # Threshold for reauthentication (percentage of PMK lifetime); default 70
    216          1.1  christos #dot11RSNAConfigPMKReauthThreshold=70
    217          1.1  christos # Timeout for security association negotiation in seconds; default 60
    218          1.1  christos #dot11RSNAConfigSATimeout=60
    219          1.1  christos 
    220          1.1  christos # Wi-Fi Protected Setup (WPS) parameters
    221          1.1  christos 
    222          1.1  christos # Universally Unique IDentifier (UUID; see RFC 4122) of the device
    223          1.1  christos # If not configured, UUID will be generated based on the local MAC address.
    224          1.1  christos #uuid=12345678-9abc-def0-1234-56789abcdef0
    225          1.1  christos 
    226          1.1  christos # Device Name
    227          1.1  christos # User-friendly description of device; up to 32 octets encoded in UTF-8
    228          1.1  christos #device_name=Wireless Client
    229          1.1  christos 
    230          1.1  christos # Manufacturer
    231          1.1  christos # The manufacturer of the device (up to 64 ASCII characters)
    232          1.1  christos #manufacturer=Company
    233          1.1  christos 
    234          1.1  christos # Model Name
    235          1.1  christos # Model of the device (up to 32 ASCII characters)
    236          1.1  christos #model_name=cmodel
    237          1.1  christos 
    238          1.1  christos # Model Number
    239          1.1  christos # Additional device description (up to 32 ASCII characters)
    240          1.1  christos #model_number=123
    241          1.1  christos 
    242          1.1  christos # Serial Number
    243          1.1  christos # Serial number of the device (up to 32 characters)
    244          1.1  christos #serial_number=12345
    245          1.1  christos 
    246          1.1  christos # Primary Device Type
    247          1.1  christos # Used format: <categ>-<OUI>-<subcateg>
    248          1.1  christos # categ = Category as an integer value
    249          1.1  christos # OUI = OUI and type octet as a 4-octet hex-encoded value; 0050F204 for
    250          1.1  christos #       default WPS OUI
    251          1.1  christos # subcateg = OUI-specific Sub Category as an integer value
    252          1.1  christos # Examples:
    253          1.1  christos #   1-0050F204-1 (Computer / PC)
    254          1.1  christos #   1-0050F204-2 (Computer / Server)
    255          1.1  christos #   5-0050F204-1 (Storage / NAS)
    256          1.1  christos #   6-0050F204-1 (Network Infrastructure / AP)
    257          1.1  christos #device_type=1-0050F204-1
    258          1.1  christos 
    259          1.1  christos # OS Version
    260          1.1  christos # 4-octet operating system version number (hex string)
    261          1.1  christos #os_version=01020300
    262          1.1  christos 
    263          1.1  christos # Config Methods
    264          1.1  christos # List of the supported configuration methods
    265          1.1  christos # Available methods: usba ethernet label display ext_nfc_token int_nfc_token
    266      1.1.1.2  christos #	nfc_interface push_button keypad virtual_display physical_display
    267      1.1.1.2  christos #	virtual_push_button physical_push_button
    268      1.1.1.2  christos # For WSC 1.0:
    269          1.1  christos #config_methods=label display push_button keypad
    270      1.1.1.2  christos # For WSC 2.0:
    271      1.1.1.2  christos #config_methods=label virtual_display virtual_push_button keypad
    272          1.1  christos 
    273          1.1  christos # Credential processing
    274          1.1  christos #   0 = process received credentials internally (default)
    275          1.1  christos #   1 = do not process received credentials; just pass them over ctrl_iface to
    276          1.1  christos #	external program(s)
    277          1.1  christos #   2 = process received credentials internally and pass them over ctrl_iface
    278          1.1  christos #	to external program(s)
    279          1.1  christos #wps_cred_processing=0
    280          1.1  christos 
    281      1.1.1.3  christos # Vendor attribute in WPS M1, e.g., Windows 7 Vertical Pairing
    282      1.1.1.3  christos # The vendor attribute contents to be added in M1 (hex string)
    283      1.1.1.3  christos #wps_vendor_ext_m1=000137100100020001
    284      1.1.1.3  christos 
    285      1.1.1.3  christos # NFC password token for WPS
    286      1.1.1.3  christos # These parameters can be used to configure a fixed NFC password token for the
    287      1.1.1.3  christos # station. This can be generated, e.g., with nfc_pw_token. When these
    288      1.1.1.3  christos # parameters are used, the station is assumed to be deployed with a NFC tag
    289      1.1.1.3  christos # that includes the matching NFC password token (e.g., written based on the
    290      1.1.1.3  christos # NDEF record from nfc_pw_token).
    291      1.1.1.3  christos #
    292      1.1.1.3  christos #wps_nfc_dev_pw_id: Device Password ID (16..65535)
    293      1.1.1.3  christos #wps_nfc_dh_pubkey: Hexdump of DH Public Key
    294      1.1.1.3  christos #wps_nfc_dh_privkey: Hexdump of DH Private Key
    295      1.1.1.3  christos #wps_nfc_dev_pw: Hexdump of Device Password
    296      1.1.1.3  christos 
    297  1.1.1.3.4.2       snj # Priority for the networks added through WPS
    298  1.1.1.3.4.2       snj # This priority value will be set to each network profile that is added
    299  1.1.1.3.4.2       snj # by executing the WPS protocol.
    300  1.1.1.3.4.2       snj #wps_priority=0
    301  1.1.1.3.4.2       snj 
    302          1.1  christos # Maximum number of BSS entries to keep in memory
    303          1.1  christos # Default: 200
    304          1.1  christos # This can be used to limit memory use on the BSS entries (cached scan
    305          1.1  christos # results). A larger value may be needed in environments that have huge number
    306          1.1  christos # of APs when using ap_scan=1 mode.
    307          1.1  christos #bss_max_count=200
    308          1.1  christos 
    309      1.1.1.3  christos # Automatic scan
    310      1.1.1.3  christos # This is an optional set of parameters for automatic scanning
    311      1.1.1.3  christos # within an interface in following format:
    312      1.1.1.3  christos #autoscan=<autoscan module name>:<module parameters>
    313  1.1.1.3.4.1       snj # autoscan is like bgscan but on disconnected or inactive state.
    314  1.1.1.3.4.1       snj # For instance, on exponential module parameters would be <base>:<limit>
    315      1.1.1.3  christos #autoscan=exponential:3:300
    316      1.1.1.3  christos # Which means a delay between scans on a base exponential of 3,
    317  1.1.1.3.4.1       snj # up to the limit of 300 seconds (3, 9, 27 ... 300)
    318  1.1.1.3.4.1       snj # For periodic module, parameters would be <fixed interval>
    319      1.1.1.3  christos #autoscan=periodic:30
    320  1.1.1.3.4.2       snj # So a delay of 30 seconds will be applied between each scan.
    321  1.1.1.3.4.2       snj # Note: If sched_scan_plans are configured and supported by the driver,
    322  1.1.1.3.4.2       snj # autoscan is ignored.
    323          1.1  christos 
    324          1.1  christos # filter_ssids - SSID-based scan result filtering
    325          1.1  christos # 0 = do not filter scan results (default)
    326          1.1  christos # 1 = only include configured SSIDs in scan results/BSS table
    327          1.1  christos #filter_ssids=0
    328          1.1  christos 
    329      1.1.1.3  christos # Password (and passphrase, etc.) backend for external storage
    330      1.1.1.3  christos # format: <backend name>[:<optional backend parameters>]
    331      1.1.1.3  christos #ext_password_backend=test:pw1=password|pw2=testing
    332      1.1.1.3  christos 
    333  1.1.1.3.4.2       snj 
    334  1.1.1.3.4.2       snj # Disable P2P functionality
    335  1.1.1.3.4.2       snj # p2p_disabled=1
    336  1.1.1.3.4.2       snj 
    337      1.1.1.3  christos # Timeout in seconds to detect STA inactivity (default: 300 seconds)
    338      1.1.1.3  christos #
    339      1.1.1.3  christos # This timeout value is used in P2P GO mode to clean up
    340      1.1.1.3  christos # inactive stations.
    341      1.1.1.3  christos #p2p_go_max_inactivity=300
    342      1.1.1.3  christos 
    343  1.1.1.3.4.1       snj # Passphrase length (8..63) for P2P GO
    344  1.1.1.3.4.1       snj #
    345  1.1.1.3.4.1       snj # This parameter controls the length of the random passphrase that is
    346  1.1.1.3.4.1       snj # generated at the GO. Default: 8.
    347  1.1.1.3.4.1       snj #p2p_passphrase_len=8
    348  1.1.1.3.4.1       snj 
    349  1.1.1.3.4.1       snj # Extra delay between concurrent P2P search iterations
    350  1.1.1.3.4.1       snj #
    351  1.1.1.3.4.1       snj # This value adds extra delay in milliseconds between concurrent search
    352  1.1.1.3.4.1       snj # iterations to make p2p_find friendlier to concurrent operations by avoiding
    353  1.1.1.3.4.1       snj # it from taking 100% of radio resources. The default value is 500 ms.
    354  1.1.1.3.4.1       snj #p2p_search_delay=500
    355  1.1.1.3.4.1       snj 
    356      1.1.1.3  christos # Opportunistic Key Caching (also known as Proactive Key Caching) default
    357      1.1.1.3  christos # This parameter can be used to set the default behavior for the
    358      1.1.1.3  christos # proactive_key_caching parameter. By default, OKC is disabled unless enabled
    359      1.1.1.3  christos # with the global okc=1 parameter or with the per-network
    360      1.1.1.3  christos # proactive_key_caching=1 parameter. With okc=1, OKC is enabled by default, but
    361      1.1.1.3  christos # can be disabled with per-network proactive_key_caching=0 parameter.
    362      1.1.1.3  christos #okc=0
    363      1.1.1.3  christos 
    364      1.1.1.3  christos # Protected Management Frames default
    365      1.1.1.3  christos # This parameter can be used to set the default behavior for the ieee80211w
    366  1.1.1.3.4.2       snj # parameter for RSN networks. By default, PMF is disabled unless enabled with
    367  1.1.1.3.4.2       snj # the global pmf=1/2 parameter or with the per-network ieee80211w=1/2 parameter.
    368  1.1.1.3.4.2       snj # With pmf=1/2, PMF is enabled/required by default, but can be disabled with the
    369  1.1.1.3.4.2       snj # per-network ieee80211w parameter. This global default value does not apply
    370  1.1.1.3.4.2       snj # for non-RSN networks (key_mgmt=NONE) since PMF is available only when using
    371  1.1.1.3.4.2       snj # RSN.
    372      1.1.1.3  christos #pmf=0
    373          1.1  christos 
    374  1.1.1.3.4.1       snj # Enabled SAE finite cyclic groups in preference order
    375  1.1.1.3.4.1       snj # By default (if this parameter is not set), the mandatory group 19 (ECC group
    376  1.1.1.3.4.1       snj # defined over a 256-bit prime order field) is preferred, but other groups are
    377  1.1.1.3.4.1       snj # also enabled. If this parameter is set, the groups will be tried in the
    378  1.1.1.3.4.1       snj # indicated order. The group values are listed in the IANA registry:
    379  1.1.1.3.4.1       snj # http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-9
    380  1.1.1.3.4.1       snj #sae_groups=21 20 19 26 25
    381  1.1.1.3.4.1       snj 
    382  1.1.1.3.4.1       snj # Default value for DTIM period (if not overridden in network block)
    383  1.1.1.3.4.1       snj #dtim_period=2
    384  1.1.1.3.4.1       snj 
    385  1.1.1.3.4.1       snj # Default value for Beacon interval (if not overridden in network block)
    386  1.1.1.3.4.1       snj #beacon_int=100
    387  1.1.1.3.4.1       snj 
    388  1.1.1.3.4.1       snj # Additional vendor specific elements for Beacon and Probe Response frames
    389  1.1.1.3.4.1       snj # This parameter can be used to add additional vendor specific element(s) into
    390  1.1.1.3.4.1       snj # the end of the Beacon and Probe Response frames. The format for these
    391  1.1.1.3.4.1       snj # element(s) is a hexdump of the raw information elements (id+len+payload for
    392  1.1.1.3.4.1       snj # one or more elements). This is used in AP and P2P GO modes.
    393  1.1.1.3.4.1       snj #ap_vendor_elements=dd0411223301
    394  1.1.1.3.4.1       snj 
    395  1.1.1.3.4.1       snj # Ignore scan results older than request
    396  1.1.1.3.4.1       snj #
    397  1.1.1.3.4.1       snj # The driver may have a cache of scan results that makes it return
    398  1.1.1.3.4.1       snj # information that is older than our scan trigger. This parameter can
    399  1.1.1.3.4.1       snj # be used to configure such old information to be ignored instead of
    400  1.1.1.3.4.1       snj # allowing it to update the internal BSS table.
    401  1.1.1.3.4.1       snj #ignore_old_scan_res=0
    402  1.1.1.3.4.1       snj 
    403  1.1.1.3.4.1       snj # scan_cur_freq: Whether to scan only the current frequency
    404  1.1.1.3.4.1       snj # 0:  Scan all available frequencies. (Default)
    405  1.1.1.3.4.1       snj # 1:  Scan current operating frequency if another VIF on the same radio
    406  1.1.1.3.4.1       snj #     is already associated.
    407  1.1.1.3.4.1       snj 
    408  1.1.1.3.4.1       snj # MAC address policy default
    409  1.1.1.3.4.1       snj # 0 = use permanent MAC address
    410  1.1.1.3.4.1       snj # 1 = use random MAC address for each ESS connection
    411  1.1.1.3.4.1       snj # 2 = like 1, but maintain OUI (with local admin bit set)
    412  1.1.1.3.4.1       snj #
    413  1.1.1.3.4.1       snj # By default, permanent MAC address is used unless policy is changed by
    414  1.1.1.3.4.1       snj # the per-network mac_addr parameter. Global mac_addr=1 can be used to
    415  1.1.1.3.4.1       snj # change this default behavior.
    416  1.1.1.3.4.1       snj #mac_addr=0
    417  1.1.1.3.4.1       snj 
    418  1.1.1.3.4.1       snj # Lifetime of random MAC address in seconds (default: 60)
    419  1.1.1.3.4.1       snj #rand_addr_lifetime=60
    420  1.1.1.3.4.1       snj 
    421  1.1.1.3.4.1       snj # MAC address policy for pre-association operations (scanning, ANQP)
    422  1.1.1.3.4.1       snj # 0 = use permanent MAC address
    423  1.1.1.3.4.1       snj # 1 = use random MAC address
    424  1.1.1.3.4.1       snj # 2 = like 1, but maintain OUI (with local admin bit set)
    425  1.1.1.3.4.1       snj #preassoc_mac_addr=0
    426  1.1.1.3.4.1       snj 
    427      1.1.1.2  christos # Interworking (IEEE 802.11u)
    428      1.1.1.2  christos 
    429      1.1.1.2  christos # Enable Interworking
    430      1.1.1.2  christos # interworking=1
    431      1.1.1.2  christos 
    432      1.1.1.2  christos # Homogenous ESS identifier
    433      1.1.1.2  christos # If this is set, scans will be used to request response only from BSSes
    434      1.1.1.2  christos # belonging to the specified Homogeneous ESS. This is used only if interworking
    435      1.1.1.2  christos # is enabled.
    436      1.1.1.2  christos # hessid=00:11:22:33:44:55
    437      1.1.1.2  christos 
    438      1.1.1.3  christos # Automatic network selection behavior
    439      1.1.1.3  christos # 0 = do not automatically go through Interworking network selection
    440      1.1.1.3  christos #     (i.e., require explicit interworking_select command for this; default)
    441      1.1.1.3  christos # 1 = perform Interworking network selection if one or more
    442      1.1.1.3  christos #     credentials have been configured and scan did not find a
    443      1.1.1.3  christos #     matching network block
    444      1.1.1.3  christos #auto_interworking=0
    445      1.1.1.2  christos 
    446  1.1.1.3.4.2       snj # GAS Address3 field behavior
    447  1.1.1.3.4.2       snj # 0 = P2P specification (Address3 = AP BSSID); default
    448  1.1.1.3.4.2       snj # 1 = IEEE 802.11 standard compliant (Address3 = Wildcard BSSID when
    449  1.1.1.3.4.2       snj #     sent to not-associated AP; if associated, AP BSSID)
    450  1.1.1.3.4.2       snj #gas_address3=0
    451  1.1.1.3.4.2       snj 
    452  1.1.1.3.4.2       snj # Publish fine timing measurement (FTM) responder functionality in
    453  1.1.1.3.4.2       snj # the Extended Capabilities element bit 70.
    454  1.1.1.3.4.2       snj # Controls whether FTM responder functionality will be published by AP/STA.
    455  1.1.1.3.4.2       snj # Note that actual FTM responder operation is managed outside wpa_supplicant.
    456  1.1.1.3.4.2       snj # 0 = Do not publish; default
    457  1.1.1.3.4.2       snj # 1 = Publish
    458  1.1.1.3.4.2       snj #ftm_responder=0
    459  1.1.1.3.4.2       snj 
    460  1.1.1.3.4.2       snj # Publish fine timing measurement (FTM) initiator functionality in
    461  1.1.1.3.4.2       snj # the Extended Capabilities element bit 71.
    462  1.1.1.3.4.2       snj # Controls whether FTM initiator functionality will be published by AP/STA.
    463  1.1.1.3.4.2       snj # Note that actual FTM initiator operation is managed outside wpa_supplicant.
    464  1.1.1.3.4.2       snj # 0 = Do not publish; default
    465  1.1.1.3.4.2       snj # 1 = Publish
    466  1.1.1.3.4.2       snj #ftm_initiator=0
    467  1.1.1.3.4.2       snj 
    468      1.1.1.3  christos # credential block
    469      1.1.1.3  christos #
    470      1.1.1.3  christos # Each credential used for automatic network selection is configured as a set
    471      1.1.1.3  christos # of parameters that are compared to the information advertised by the APs when
    472      1.1.1.3  christos # interworking_select and interworking_connect commands are used.
    473      1.1.1.3  christos #
    474      1.1.1.3  christos # credential fields:
    475      1.1.1.3  christos #
    476  1.1.1.3.4.1       snj # temporary: Whether this credential is temporary and not to be saved
    477  1.1.1.3.4.1       snj #
    478      1.1.1.3  christos # priority: Priority group
    479      1.1.1.3  christos #	By default, all networks and credentials get the same priority group
    480      1.1.1.3  christos #	(0). This field can be used to give higher priority for credentials
    481      1.1.1.3  christos #	(and similarly in struct wpa_ssid for network blocks) to change the
    482      1.1.1.3  christos #	Interworking automatic networking selection behavior. The matching
    483      1.1.1.3  christos #	network (based on either an enabled network block or a credential)
    484      1.1.1.3  christos #	with the highest priority value will be selected.
    485      1.1.1.3  christos #
    486      1.1.1.3  christos # pcsc: Use PC/SC and SIM/USIM card
    487      1.1.1.3  christos #
    488      1.1.1.3  christos # realm: Home Realm for Interworking
    489      1.1.1.3  christos #
    490      1.1.1.3  christos # username: Username for Interworking network selection
    491      1.1.1.3  christos #
    492      1.1.1.3  christos # password: Password for Interworking network selection
    493      1.1.1.3  christos #
    494      1.1.1.3  christos # ca_cert: CA certificate for Interworking network selection
    495      1.1.1.3  christos #
    496      1.1.1.3  christos # client_cert: File path to client certificate file (PEM/DER)
    497      1.1.1.3  christos #	This field is used with Interworking networking selection for a case
    498      1.1.1.3  christos #	where client certificate/private key is used for authentication
    499      1.1.1.3  christos #	(EAP-TLS). Full path to the file should be used since working
    500      1.1.1.3  christos #	directory may change when wpa_supplicant is run in the background.
    501      1.1.1.3  christos #
    502  1.1.1.3.4.2       snj #	Certificates from PKCS#11 tokens can be referenced by a PKCS#11 URI.
    503  1.1.1.3.4.2       snj #
    504  1.1.1.3.4.2       snj #	For example: private_key="pkcs11:manufacturer=piv_II;id=%01"
    505  1.1.1.3.4.2       snj #
    506      1.1.1.3  christos #	Alternatively, a named configuration blob can be used by setting
    507      1.1.1.3  christos #	this to blob://blob_name.
    508      1.1.1.3  christos #
    509      1.1.1.3  christos # private_key: File path to client private key file (PEM/DER/PFX)
    510      1.1.1.3  christos #	When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
    511      1.1.1.3  christos #	commented out. Both the private key and certificate will be read
    512      1.1.1.3  christos #	from the PKCS#12 file in this case. Full path to the file should be
    513      1.1.1.3  christos #	used since working directory may change when wpa_supplicant is run
    514      1.1.1.3  christos #	in the background.
    515      1.1.1.3  christos #
    516  1.1.1.3.4.2       snj #	Keys in PKCS#11 tokens can be referenced by a PKCS#11 URI.
    517  1.1.1.3.4.2       snj #	For example: private_key="pkcs11:manufacturer=piv_II;id=%01"
    518  1.1.1.3.4.2       snj #
    519      1.1.1.3  christos #	Windows certificate store can be used by leaving client_cert out and
    520      1.1.1.3  christos #	configuring private_key in one of the following formats:
    521      1.1.1.3  christos #
    522      1.1.1.3  christos #	cert://substring_to_match
    523      1.1.1.3  christos #
    524      1.1.1.3  christos #	hash://certificate_thumbprint_in_hex
    525      1.1.1.3  christos #
    526      1.1.1.3  christos #	For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
    527      1.1.1.3  christos #
    528      1.1.1.3  christos #	Note that when running wpa_supplicant as an application, the user
    529      1.1.1.3  christos #	certificate store (My user account) is used, whereas computer store
    530      1.1.1.3  christos #	(Computer account) is used when running wpasvc as a service.
    531      1.1.1.3  christos #
    532      1.1.1.3  christos #	Alternatively, a named configuration blob can be used by setting
    533      1.1.1.3  christos #	this to blob://blob_name.
    534      1.1.1.3  christos #
    535      1.1.1.3  christos # private_key_passwd: Password for private key file
    536      1.1.1.3  christos #
    537      1.1.1.3  christos # imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format
    538      1.1.1.3  christos #
    539      1.1.1.3  christos # milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN>
    540      1.1.1.3  christos #	format
    541      1.1.1.3  christos #
    542  1.1.1.3.4.1       snj # domain: Home service provider FQDN(s)
    543      1.1.1.3  christos #	This is used to compare against the Domain Name List to figure out
    544  1.1.1.3.4.1       snj #	whether the AP is operated by the Home SP. Multiple domain entries can
    545  1.1.1.3.4.1       snj #	be used to configure alternative FQDNs that will be considered home
    546  1.1.1.3.4.1       snj #	networks.
    547      1.1.1.3  christos #
    548      1.1.1.3  christos # roaming_consortium: Roaming Consortium OI
    549      1.1.1.3  christos #	If roaming_consortium_len is non-zero, this field contains the
    550      1.1.1.3  christos #	Roaming Consortium OI that can be used to determine which access
    551      1.1.1.3  christos #	points support authentication with this credential. This is an
    552      1.1.1.3  christos #	alternative to the use of the realm parameter. When using Roaming
    553      1.1.1.3  christos #	Consortium to match the network, the EAP parameters need to be
    554      1.1.1.3  christos #	pre-configured with the credential since the NAI Realm information
    555      1.1.1.3  christos #	may not be available or fetched.
    556      1.1.1.3  christos #
    557      1.1.1.3  christos # eap: Pre-configured EAP method
    558      1.1.1.3  christos #	This optional field can be used to specify which EAP method will be
    559      1.1.1.3  christos #	used with this credential. If not set, the EAP method is selected
    560      1.1.1.3  christos #	automatically based on ANQP information (e.g., NAI Realm).
    561      1.1.1.3  christos #
    562      1.1.1.3  christos # phase1: Pre-configure Phase 1 (outer authentication) parameters
    563      1.1.1.3  christos #	This optional field is used with like the 'eap' parameter.
    564      1.1.1.3  christos #
    565      1.1.1.3  christos # phase2: Pre-configure Phase 2 (inner authentication) parameters
    566      1.1.1.3  christos #	This optional field is used with like the 'eap' parameter.
    567      1.1.1.3  christos #
    568      1.1.1.3  christos # excluded_ssid: Excluded SSID
    569      1.1.1.3  christos #	This optional field can be used to excluded specific SSID(s) from
    570      1.1.1.3  christos #	matching with the network. Multiple entries can be used to specify more
    571      1.1.1.3  christos #	than one SSID.
    572      1.1.1.3  christos #
    573  1.1.1.3.4.1       snj # roaming_partner: Roaming partner information
    574  1.1.1.3.4.1       snj #	This optional field can be used to configure preferences between roaming
    575  1.1.1.3.4.1       snj #	partners. The field is a string in following format:
    576  1.1.1.3.4.1       snj #	<FQDN>,<0/1 exact match>,<priority>,<* or country code>
    577  1.1.1.3.4.1       snj #	(non-exact match means any subdomain matches the entry; priority is in
    578  1.1.1.3.4.1       snj #	0..255 range with 0 being the highest priority)
    579  1.1.1.3.4.1       snj #
    580  1.1.1.3.4.1       snj # update_identifier: PPS MO ID
    581  1.1.1.3.4.1       snj #	(Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
    582  1.1.1.3.4.1       snj #
    583  1.1.1.3.4.1       snj # provisioning_sp: FQDN of the SP that provisioned the credential
    584  1.1.1.3.4.1       snj #	This optional field can be used to keep track of the SP that provisioned
    585  1.1.1.3.4.1       snj #	the credential to find the PPS MO (./Wi-Fi/<provisioning_sp>).
    586  1.1.1.3.4.1       snj #
    587  1.1.1.3.4.1       snj # Minimum backhaul threshold (PPS/<X+>/Policy/MinBackhauldThreshold/*)
    588  1.1.1.3.4.1       snj #	These fields can be used to specify minimum download/upload backhaul
    589  1.1.1.3.4.1       snj #	bandwidth that is preferred for the credential. This constraint is
    590  1.1.1.3.4.1       snj #	ignored if the AP does not advertise WAN Metrics information or if the
    591  1.1.1.3.4.1       snj #	limit would prevent any connection. Values are in kilobits per second.
    592  1.1.1.3.4.1       snj # min_dl_bandwidth_home
    593  1.1.1.3.4.1       snj # min_ul_bandwidth_home
    594  1.1.1.3.4.1       snj # min_dl_bandwidth_roaming
    595  1.1.1.3.4.1       snj # min_ul_bandwidth_roaming
    596  1.1.1.3.4.1       snj #
    597  1.1.1.3.4.1       snj # max_bss_load: Maximum BSS Load Channel Utilization (1..255)
    598  1.1.1.3.4.1       snj #	(PPS/<X+>/Policy/MaximumBSSLoadValue)
    599  1.1.1.3.4.1       snj #	This value is used as the maximum channel utilization for network
    600  1.1.1.3.4.1       snj #	selection purposes for home networks. If the AP does not advertise
    601  1.1.1.3.4.1       snj #	BSS Load or if the limit would prevent any connection, this constraint
    602  1.1.1.3.4.1       snj #	will be ignored.
    603  1.1.1.3.4.1       snj #
    604  1.1.1.3.4.1       snj # req_conn_capab: Required connection capability
    605  1.1.1.3.4.1       snj #	(PPS/<X+>/Policy/RequiredProtoPortTuple)
    606  1.1.1.3.4.1       snj #	This value is used to configure set of required protocol/port pairs that
    607  1.1.1.3.4.1       snj #	a roaming network shall support (include explicitly in Connection
    608  1.1.1.3.4.1       snj #	Capability ANQP element). This constraint is ignored if the AP does not
    609  1.1.1.3.4.1       snj #	advertise Connection Capability or if this constraint would prevent any
    610  1.1.1.3.4.1       snj #	network connection. This policy is not used in home networks.
    611  1.1.1.3.4.1       snj #	Format: <protocol>[:<comma-separated list of ports]
    612  1.1.1.3.4.1       snj #	Multiple entries can be used to list multiple requirements.
    613  1.1.1.3.4.1       snj #	For example, number of common TCP protocols:
    614  1.1.1.3.4.1       snj #	req_conn_capab=6,22,80,443
    615  1.1.1.3.4.1       snj #	For example, IPSec/IKE:
    616  1.1.1.3.4.1       snj #	req_conn_capab=17:500
    617  1.1.1.3.4.1       snj #	req_conn_capab=50
    618  1.1.1.3.4.1       snj #
    619  1.1.1.3.4.1       snj # ocsp: Whether to use/require OCSP to check server certificate
    620  1.1.1.3.4.1       snj #	0 = do not use OCSP stapling (TLS certificate status extension)
    621  1.1.1.3.4.1       snj #	1 = try to use OCSP stapling, but not require response
    622  1.1.1.3.4.1       snj #	2 = require valid OCSP stapling response
    623  1.1.1.3.4.2       snj #	3 = require valid OCSP stapling response for all not-trusted
    624  1.1.1.3.4.2       snj #	    certificates in the server certificate chain
    625  1.1.1.3.4.1       snj #
    626  1.1.1.3.4.1       snj # sim_num: Identifier for which SIM to use in multi-SIM devices
    627  1.1.1.3.4.1       snj #
    628      1.1.1.3  christos # for example:
    629      1.1.1.3  christos #
    630      1.1.1.3  christos #cred={
    631      1.1.1.3  christos #	realm="example.com"
    632      1.1.1.3  christos #	username="user (at] example.com"
    633      1.1.1.3  christos #	password="password"
    634      1.1.1.3  christos #	ca_cert="/etc/wpa_supplicant/ca.pem"
    635      1.1.1.3  christos #	domain="example.com"
    636      1.1.1.3  christos #}
    637      1.1.1.3  christos #
    638      1.1.1.3  christos #cred={
    639      1.1.1.3  christos #	imsi="310026-000000000"
    640      1.1.1.3  christos #	milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82"
    641      1.1.1.3  christos #}
    642      1.1.1.3  christos #
    643      1.1.1.3  christos #cred={
    644      1.1.1.3  christos #	realm="example.com"
    645      1.1.1.3  christos #	username="user"
    646      1.1.1.3  christos #	password="password"
    647      1.1.1.3  christos #	ca_cert="/etc/wpa_supplicant/ca.pem"
    648      1.1.1.3  christos #	domain="example.com"
    649      1.1.1.3  christos #	roaming_consortium=223344
    650      1.1.1.3  christos #	eap=TTLS
    651      1.1.1.3  christos #	phase2="auth=MSCHAPV2"
    652      1.1.1.3  christos #}
    653      1.1.1.2  christos 
    654      1.1.1.3  christos # Hotspot 2.0
    655      1.1.1.3  christos # hs20=1
    656      1.1.1.2  christos 
    657  1.1.1.3.4.2       snj # Scheduled scan plans
    658  1.1.1.3.4.2       snj #
    659  1.1.1.3.4.2       snj # A space delimited list of scan plans. Each scan plan specifies the scan
    660  1.1.1.3.4.2       snj # interval and number of iterations, delimited by a colon. The last scan plan
    661  1.1.1.3.4.2       snj # will run infinitely and thus must specify only the interval and not the number
    662  1.1.1.3.4.2       snj # of iterations.
    663  1.1.1.3.4.2       snj #
    664  1.1.1.3.4.2       snj # The driver advertises the maximum number of scan plans supported. If more scan
    665  1.1.1.3.4.2       snj # plans than supported are configured, only the first ones are set (up to the
    666  1.1.1.3.4.2       snj # maximum supported). The last scan plan that specifies only the interval is
    667  1.1.1.3.4.2       snj # always set as the last plan.
    668  1.1.1.3.4.2       snj #
    669  1.1.1.3.4.2       snj # If the scan interval or the number of iterations for a scan plan exceeds the
    670  1.1.1.3.4.2       snj # maximum supported, it will be set to the maximum supported value.
    671  1.1.1.3.4.2       snj #
    672  1.1.1.3.4.2       snj # Format:
    673  1.1.1.3.4.2       snj # sched_scan_plans=<interval:iterations> <interval:iterations> ... <interval>
    674  1.1.1.3.4.2       snj #
    675  1.1.1.3.4.2       snj # Example:
    676  1.1.1.3.4.2       snj # sched_scan_plans=10:100 20:200 30
    677  1.1.1.3.4.2       snj 
    678  1.1.1.3.4.2       snj # Multi Band Operation (MBO) non-preferred channels
    679  1.1.1.3.4.2       snj # A space delimited list of non-preferred channels where each channel is a colon
    680  1.1.1.3.4.2       snj # delimited list of values.
    681  1.1.1.3.4.2       snj # Format:
    682  1.1.1.3.4.2       snj # non_pref_chan=<oper_class>:<chan>:<preference>:<reason>
    683  1.1.1.3.4.2       snj # Example:
    684  1.1.1.3.4.2       snj # non_pref_chan="81:5:10:2 81:1:0:2 81:9:0:2"
    685  1.1.1.3.4.2       snj 
    686  1.1.1.3.4.2       snj # MBO Cellular Data Capabilities
    687  1.1.1.3.4.2       snj # 1 = Cellular data connection available
    688  1.1.1.3.4.2       snj # 2 = Cellular data connection not available
    689  1.1.1.3.4.2       snj # 3 = Not cellular capable (default)
    690  1.1.1.3.4.2       snj #mbo_cell_capa=3
    691  1.1.1.3.4.2       snj 
    692          1.1  christos # network block
    693          1.1  christos #
    694          1.1  christos # Each network (usually AP's sharing the same SSID) is configured as a separate
    695          1.1  christos # block in this configuration file. The network blocks are in preference order
    696          1.1  christos # (the first match is used).
    697          1.1  christos #
    698          1.1  christos # network block fields:
    699          1.1  christos #
    700          1.1  christos # disabled:
    701          1.1  christos #	0 = this network can be used (default)
    702          1.1  christos #	1 = this network block is disabled (can be enabled through ctrl_iface,
    703          1.1  christos #	    e.g., with wpa_cli or wpa_gui)
    704          1.1  christos #
    705          1.1  christos # id_str: Network identifier string for external scripts. This value is passed
    706          1.1  christos #	to external action script through wpa_cli as WPA_ID_STR environment
    707          1.1  christos #	variable to make it easier to do network specific configuration.
    708          1.1  christos #
    709      1.1.1.3  christos # ssid: SSID (mandatory); network name in one of the optional formats:
    710      1.1.1.3  christos #	- an ASCII string with double quotation
    711      1.1.1.3  christos #	- a hex string (two characters per octet of SSID)
    712      1.1.1.3  christos #	- a printf-escaped ASCII string P"<escaped string>"
    713          1.1  christos #
    714          1.1  christos # scan_ssid:
    715          1.1  christos #	0 = do not scan this SSID with specific Probe Request frames (default)
    716          1.1  christos #	1 = scan with SSID-specific Probe Request frames (this can be used to
    717          1.1  christos #	    find APs that do not accept broadcast SSID or use multiple SSIDs;
    718          1.1  christos #	    this will add latency to scanning, so enable this only when needed)
    719          1.1  christos #
    720          1.1  christos # bssid: BSSID (optional); if set, this network block is used only when
    721          1.1  christos #	associating with the AP using the configured BSSID
    722          1.1  christos #
    723          1.1  christos # priority: priority group (integer)
    724          1.1  christos # By default, all networks will get same priority group (0). If some of the
    725          1.1  christos # networks are more desirable, this field can be used to change the order in
    726          1.1  christos # which wpa_supplicant goes through the networks when selecting a BSS. The
    727          1.1  christos # priority groups will be iterated in decreasing priority (i.e., the larger the
    728          1.1  christos # priority value, the sooner the network is matched against the scan results).
    729          1.1  christos # Within each priority group, networks will be selected based on security
    730          1.1  christos # policy, signal strength, etc.
    731          1.1  christos # Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
    732          1.1  christos # using this priority to select the order for scanning. Instead, they try the
    733          1.1  christos # networks in the order that used in the configuration file.
    734          1.1  christos #
    735          1.1  christos # mode: IEEE 802.11 operation mode
    736          1.1  christos # 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
    737          1.1  christos # 1 = IBSS (ad-hoc, peer-to-peer)
    738          1.1  christos # 2 = AP (access point)
    739  1.1.1.3.4.1       snj # Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) and
    740  1.1.1.3.4.1       snj # WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE (fixed group key
    741  1.1.1.3.4.1       snj # TKIP/CCMP) is available for backwards compatibility, but its use is
    742  1.1.1.3.4.1       snj # deprecated. WPA-None requires following network block options:
    743          1.1  christos # proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
    744          1.1  christos # both), and psk must also be set.
    745          1.1  christos #
    746          1.1  christos # frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
    747          1.1  christos # 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
    748          1.1  christos # channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
    749          1.1  christos # In addition, this value is only used by the station that creates the IBSS. If
    750          1.1  christos # an IBSS network with the configured SSID is already present, the frequency of
    751          1.1  christos # the network will be used instead of this configured value.
    752          1.1  christos #
    753  1.1.1.3.4.2       snj # pbss: Whether to use PBSS. Relevant to IEEE 802.11ad networks only.
    754  1.1.1.3.4.2       snj # 0 = do not use PBSS
    755  1.1.1.3.4.2       snj # 1 = use PBSS
    756  1.1.1.3.4.2       snj # 2 = don't care (not allowed in AP mode)
    757  1.1.1.3.4.2       snj # Used together with mode configuration. When mode is AP, it means to start a
    758  1.1.1.3.4.2       snj # PCP instead of a regular AP. When mode is infrastructure it means connect
    759  1.1.1.3.4.2       snj # to a PCP instead of AP. In this mode you can also specify 2 (don't care)
    760  1.1.1.3.4.2       snj # which means connect to either PCP or AP.
    761  1.1.1.3.4.2       snj # P2P_GO and P2P_GROUP_FORMATION modes must use PBSS in IEEE 802.11ad network.
    762  1.1.1.3.4.2       snj # For more details, see IEEE Std 802.11ad-2012.
    763  1.1.1.3.4.2       snj #
    764          1.1  christos # scan_freq: List of frequencies to scan
    765          1.1  christos # Space-separated list of frequencies in MHz to scan when searching for this
    766          1.1  christos # BSS. If the subset of channels used by the network is known, this option can
    767          1.1  christos # be used to optimize scanning to not occur on channels that the network does
    768          1.1  christos # not use. Example: scan_freq=2412 2437 2462
    769          1.1  christos #
    770          1.1  christos # freq_list: Array of allowed frequencies
    771          1.1  christos # Space-separated list of frequencies in MHz to allow for selecting the BSS. If
    772          1.1  christos # set, scan results that do not match any of the specified frequencies are not
    773          1.1  christos # considered when selecting a BSS.
    774          1.1  christos #
    775  1.1.1.3.4.1       snj # This can also be set on the outside of the network block. In this case,
    776  1.1.1.3.4.1       snj # it limits the frequencies that will be scanned.
    777  1.1.1.3.4.1       snj #
    778      1.1.1.3  christos # bgscan: Background scanning
    779      1.1.1.3  christos # wpa_supplicant behavior for background scanning can be specified by
    780      1.1.1.3  christos # configuring a bgscan module. These modules are responsible for requesting
    781      1.1.1.3  christos # background scans for the purpose of roaming within an ESS (i.e., within a
    782      1.1.1.3  christos # single network block with all the APs using the same SSID). The bgscan
    783      1.1.1.3  christos # parameter uses following format: "<bgscan module name>:<module parameters>"
    784      1.1.1.3  christos # Following bgscan modules are available:
    785      1.1.1.3  christos # simple - Periodic background scans based on signal strength
    786      1.1.1.3  christos # bgscan="simple:<short bgscan interval in seconds>:<signal strength threshold>:
    787      1.1.1.3  christos # <long interval>"
    788      1.1.1.3  christos # bgscan="simple:30:-45:300"
    789      1.1.1.3  christos # learn - Learn channels used by the network and try to avoid bgscans on other
    790      1.1.1.3  christos # channels (experimental)
    791      1.1.1.3  christos # bgscan="learn:<short bgscan interval in seconds>:<signal strength threshold>:
    792      1.1.1.3  christos # <long interval>[:<database file name>]"
    793      1.1.1.3  christos # bgscan="learn:30:-45:300:/etc/wpa_supplicant/network1.bgscan"
    794  1.1.1.3.4.1       snj # Explicitly disable bgscan by setting
    795  1.1.1.3.4.1       snj # bgscan=""
    796  1.1.1.3.4.1       snj #
    797  1.1.1.3.4.1       snj # This option can also be set outside of all network blocks for the bgscan
    798  1.1.1.3.4.1       snj # parameter to apply for all the networks that have no specific bgscan
    799  1.1.1.3.4.1       snj # parameter.
    800      1.1.1.3  christos #
    801          1.1  christos # proto: list of accepted protocols
    802          1.1  christos # WPA = WPA/IEEE 802.11i/D3.0
    803          1.1  christos # RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
    804          1.1  christos # If not set, this defaults to: WPA RSN
    805          1.1  christos #
    806          1.1  christos # key_mgmt: list of accepted authenticated key management protocols
    807          1.1  christos # WPA-PSK = WPA pre-shared key (this requires 'psk' field)
    808          1.1  christos # WPA-EAP = WPA using EAP authentication
    809          1.1  christos # IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
    810          1.1  christos #	generated WEP keys
    811          1.1  christos # NONE = WPA is not used; plaintext or static WEP could be used
    812  1.1.1.3.4.2       snj # WPA-NONE = WPA-None for IBSS (deprecated; use proto=RSN key_mgmt=WPA-PSK
    813  1.1.1.3.4.2       snj #	instead)
    814  1.1.1.3.4.2       snj # FT-PSK = Fast BSS Transition (IEEE 802.11r) with pre-shared key
    815  1.1.1.3.4.2       snj # FT-EAP = Fast BSS Transition (IEEE 802.11r) with EAP authentication
    816          1.1  christos # WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
    817          1.1  christos # WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
    818  1.1.1.3.4.2       snj # SAE = Simultaneous authentication of equals; pre-shared key/password -based
    819  1.1.1.3.4.2       snj #	authentication with stronger security than WPA-PSK especially when using
    820  1.1.1.3.4.2       snj #	not that strong password
    821  1.1.1.3.4.2       snj # FT-SAE = SAE with FT
    822  1.1.1.3.4.2       snj # WPA-EAP-SUITE-B = Suite B 128-bit level
    823  1.1.1.3.4.2       snj # WPA-EAP-SUITE-B-192 = Suite B 192-bit level
    824  1.1.1.3.4.2       snj # OSEN = Hotspot 2.0 Rel 2 online signup connection
    825          1.1  christos # If not set, this defaults to: WPA-PSK WPA-EAP
    826          1.1  christos #
    827      1.1.1.3  christos # ieee80211w: whether management frame protection is enabled
    828      1.1.1.3  christos # 0 = disabled (default unless changed with the global pmf parameter)
    829      1.1.1.3  christos # 1 = optional
    830      1.1.1.3  christos # 2 = required
    831      1.1.1.3  christos # The most common configuration options for this based on the PMF (protected
    832      1.1.1.3  christos # management frames) certification program are:
    833      1.1.1.3  christos # PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256
    834      1.1.1.3  christos # PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256
    835      1.1.1.3  christos # (and similarly for WPA-PSK and WPA-WPSK-SHA256 if WPA2-Personal is used)
    836      1.1.1.3  christos #
    837          1.1  christos # auth_alg: list of allowed IEEE 802.11 authentication algorithms
    838          1.1  christos # OPEN = Open System authentication (required for WPA/WPA2)
    839          1.1  christos # SHARED = Shared Key authentication (requires static WEP keys)
    840          1.1  christos # LEAP = LEAP/Network EAP (only used with LEAP)
    841          1.1  christos # If not set, automatic selection is used (Open System with LEAP enabled if
    842          1.1  christos # LEAP is allowed as one of the EAP methods).
    843          1.1  christos #
    844          1.1  christos # pairwise: list of accepted pairwise (unicast) ciphers for WPA
    845          1.1  christos # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
    846          1.1  christos # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
    847          1.1  christos # NONE = Use only Group Keys (deprecated, should not be included if APs support
    848          1.1  christos #	pairwise keys)
    849          1.1  christos # If not set, this defaults to: CCMP TKIP
    850          1.1  christos #
    851          1.1  christos # group: list of accepted group (broadcast/multicast) ciphers for WPA
    852          1.1  christos # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
    853          1.1  christos # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
    854          1.1  christos # WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
    855          1.1  christos # WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
    856          1.1  christos # If not set, this defaults to: CCMP TKIP WEP104 WEP40
    857          1.1  christos #
    858          1.1  christos # psk: WPA preshared key; 256-bit pre-shared key
    859          1.1  christos # The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
    860          1.1  christos # 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
    861          1.1  christos # generated using the passphrase and SSID). ASCII passphrase must be between
    862      1.1.1.3  christos # 8 and 63 characters (inclusive). ext:<name of external PSK field> format can
    863      1.1.1.3  christos # be used to indicate that the PSK/passphrase is stored in external storage.
    864          1.1  christos # This field is not needed, if WPA-EAP is used.
    865          1.1  christos # Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
    866          1.1  christos # from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
    867          1.1  christos # startup and reconfiguration time can be optimized by generating the PSK only
    868          1.1  christos # only when the passphrase or SSID has actually changed.
    869          1.1  christos #
    870  1.1.1.3.4.2       snj # mem_only_psk: Whether to keep PSK/passphrase only in memory
    871  1.1.1.3.4.2       snj # 0 = allow psk/passphrase to be stored to the configuration file
    872  1.1.1.3.4.2       snj # 1 = do not store psk/passphrase to the configuration file
    873  1.1.1.3.4.2       snj #mem_only_psk=0
    874  1.1.1.3.4.2       snj #
    875          1.1  christos # eapol_flags: IEEE 802.1X/EAPOL options (bit field)
    876          1.1  christos # Dynamic WEP key required for non-WPA mode
    877          1.1  christos # bit0 (1): require dynamically generated unicast WEP key
    878          1.1  christos # bit1 (2): require dynamically generated broadcast WEP key
    879          1.1  christos # 	(3 = require both keys; default)
    880  1.1.1.3.4.1       snj # Note: When using wired authentication (including macsec_qca driver),
    881  1.1.1.3.4.1       snj # eapol_flags must be set to 0 for the authentication to be completed
    882  1.1.1.3.4.1       snj # successfully.
    883  1.1.1.3.4.1       snj #
    884  1.1.1.3.4.1       snj # macsec_policy: IEEE 802.1X/MACsec options
    885  1.1.1.3.4.1       snj # This determines how sessions are secured with MACsec. It is currently
    886  1.1.1.3.4.1       snj # applicable only when using the macsec_qca driver interface.
    887  1.1.1.3.4.1       snj # 0: MACsec not in use (default)
    888  1.1.1.3.4.1       snj # 1: MACsec enabled - Should secure, accept key server's advice to
    889  1.1.1.3.4.1       snj #    determine whether to use a secure session or not.
    890          1.1  christos #
    891          1.1  christos # mixed_cell: This option can be used to configure whether so called mixed
    892          1.1  christos # cells, i.e., networks that use both plaintext and encryption in the same
    893      1.1.1.2  christos # SSID, are allowed when selecting a BSS from scan results.
    894          1.1  christos # 0 = disabled (default)
    895          1.1  christos # 1 = enabled
    896          1.1  christos #
    897          1.1  christos # proactive_key_caching:
    898          1.1  christos # Enable/disable opportunistic PMKSA caching for WPA2.
    899      1.1.1.3  christos # 0 = disabled (default unless changed with the global okc parameter)
    900          1.1  christos # 1 = enabled
    901          1.1  christos #
    902          1.1  christos # wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
    903          1.1  christos # hex without quotation, e.g., 0102030405)
    904          1.1  christos # wep_tx_keyidx: Default WEP key index (TX) (0..3)
    905          1.1  christos #
    906          1.1  christos # peerkey: Whether PeerKey negotiation for direct links (IEEE 802.11e DLS) is
    907          1.1  christos # allowed. This is only used with RSN/WPA2.
    908          1.1  christos # 0 = disabled (default)
    909          1.1  christos # 1 = enabled
    910          1.1  christos #peerkey=1
    911          1.1  christos #
    912          1.1  christos # wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
    913          1.1  christos # enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
    914          1.1  christos #
    915  1.1.1.3.4.2       snj # group_rekey: Group rekeying time in seconds. This value, if non-zero, is used
    916  1.1.1.3.4.2       snj # as the dot11RSNAConfigGroupRekeyTime parameter when operating in
    917  1.1.1.3.4.2       snj # Authenticator role in IBSS.
    918  1.1.1.3.4.2       snj #
    919          1.1  christos # Following fields are only used with internal EAP implementation.
    920          1.1  christos # eap: space-separated list of accepted EAP methods
    921  1.1.1.3.4.2       snj #	MD5 = EAP-MD5 (insecure and does not generate keying material ->
    922          1.1  christos #			cannot be used with WPA; to be used as a Phase 2 method
    923          1.1  christos #			with EAP-PEAP or EAP-TTLS)
    924          1.1  christos #       MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
    925          1.1  christos #		as a Phase 2 method with EAP-PEAP or EAP-TTLS)
    926          1.1  christos #       OTP = EAP-OTP (cannot be used separately with WPA; to be used
    927          1.1  christos #		as a Phase 2 method with EAP-PEAP or EAP-TTLS)
    928          1.1  christos #       GTC = EAP-GTC (cannot be used separately with WPA; to be used
    929          1.1  christos #		as a Phase 2 method with EAP-PEAP or EAP-TTLS)
    930          1.1  christos #	TLS = EAP-TLS (client and server certificate)
    931          1.1  christos #	PEAP = EAP-PEAP (with tunnelled EAP authentication)
    932          1.1  christos #	TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
    933          1.1  christos #			 authentication)
    934          1.1  christos #	If not set, all compiled in methods are allowed.
    935          1.1  christos #
    936          1.1  christos # identity: Identity string for EAP
    937          1.1  christos #	This field is also used to configure user NAI for
    938          1.1  christos #	EAP-PSK/PAX/SAKE/GPSK.
    939          1.1  christos # anonymous_identity: Anonymous identity string for EAP (to be used as the
    940          1.1  christos #	unencrypted identity with EAP types that support different tunnelled
    941      1.1.1.3  christos #	identity, e.g., EAP-TTLS). This field can also be used with
    942      1.1.1.3  christos #	EAP-SIM/AKA/AKA' to store the pseudonym identity.
    943          1.1  christos # password: Password string for EAP. This field can include either the
    944          1.1  christos #	plaintext password (using ASCII or hex string) or a NtPasswordHash
    945          1.1  christos #	(16-byte MD4 hash of password) in hash:<32 hex digits> format.
    946          1.1  christos #	NtPasswordHash can only be used when the password is for MSCHAPv2 or
    947          1.1  christos #	MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
    948          1.1  christos #	EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
    949          1.1  christos #	PSK) is also configured using this field. For EAP-GPSK, this is a
    950      1.1.1.3  christos #	variable length PSK. ext:<name of external password field> format can
    951      1.1.1.3  christos #	be used to indicate that the password is stored in external storage.
    952          1.1  christos # ca_cert: File path to CA certificate file (PEM/DER). This file can have one
    953          1.1  christos #	or more trusted CA certificates. If ca_cert and ca_path are not
    954          1.1  christos #	included, server certificate will not be verified. This is insecure and
    955          1.1  christos #	a trusted CA certificate should always be configured when using
    956          1.1  christos #	EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
    957          1.1  christos #	change when wpa_supplicant is run in the background.
    958          1.1  christos #
    959          1.1  christos #	Alternatively, this can be used to only perform matching of the server
    960          1.1  christos #	certificate (SHA-256 hash of the DER encoded X.509 certificate). In
    961          1.1  christos #	this case, the possible CA certificates in the server certificate chain
    962          1.1  christos #	are ignored and only the server certificate is verified. This is
    963          1.1  christos #	configured with the following format:
    964          1.1  christos #	hash:://server/sha256/cert_hash_in_hex
    965          1.1  christos #	For example: "hash://server/sha256/
    966          1.1  christos #	5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
    967          1.1  christos #
    968          1.1  christos #	On Windows, trusted CA certificates can be loaded from the system
    969          1.1  christos #	certificate store by setting this to cert_store://<name>, e.g.,
    970          1.1  christos #	ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
    971          1.1  christos #	Note that when running wpa_supplicant as an application, the user
    972          1.1  christos #	certificate store (My user account) is used, whereas computer store
    973          1.1  christos #	(Computer account) is used when running wpasvc as a service.
    974          1.1  christos # ca_path: Directory path for CA certificate files (PEM). This path may
    975          1.1  christos #	contain multiple CA certificates in OpenSSL format. Common use for this
    976          1.1  christos #	is to point to system trusted CA list which is often installed into
    977          1.1  christos #	directory like /etc/ssl/certs. If configured, these certificates are
    978          1.1  christos #	added to the list of trusted CAs. ca_cert may also be included in that
    979          1.1  christos #	case, but it is not required.
    980          1.1  christos # client_cert: File path to client certificate file (PEM/DER)
    981          1.1  christos #	Full path should be used since working directory may change when
    982          1.1  christos #	wpa_supplicant is run in the background.
    983          1.1  christos #	Alternatively, a named configuration blob can be used by setting this
    984          1.1  christos #	to blob://<blob name>.
    985          1.1  christos # private_key: File path to client private key file (PEM/DER/PFX)
    986          1.1  christos #	When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
    987          1.1  christos #	commented out. Both the private key and certificate will be read from
    988          1.1  christos #	the PKCS#12 file in this case. Full path should be used since working
    989          1.1  christos #	directory may change when wpa_supplicant is run in the background.
    990          1.1  christos #	Windows certificate store can be used by leaving client_cert out and
    991          1.1  christos #	configuring private_key in one of the following formats:
    992          1.1  christos #	cert://substring_to_match
    993          1.1  christos #	hash://certificate_thumbprint_in_hex
    994          1.1  christos #	for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
    995          1.1  christos #	Note that when running wpa_supplicant as an application, the user
    996          1.1  christos #	certificate store (My user account) is used, whereas computer store
    997          1.1  christos #	(Computer account) is used when running wpasvc as a service.
    998          1.1  christos #	Alternatively, a named configuration blob can be used by setting this
    999          1.1  christos #	to blob://<blob name>.
   1000          1.1  christos # private_key_passwd: Password for private key file (if left out, this will be
   1001          1.1  christos #	asked through control interface)
   1002          1.1  christos # dh_file: File path to DH/DSA parameters file (in PEM format)
   1003          1.1  christos #	This is an optional configuration file for setting parameters for an
   1004          1.1  christos #	ephemeral DH key exchange. In most cases, the default RSA
   1005          1.1  christos #	authentication does not use this configuration. However, it is possible
   1006          1.1  christos #	setup RSA to use ephemeral DH key exchange. In addition, ciphers with
   1007          1.1  christos #	DSA keys always use ephemeral DH keys. This can be used to achieve
   1008          1.1  christos #	forward secrecy. If the file is in DSA parameters format, it will be
   1009          1.1  christos #	automatically converted into DH params.
   1010          1.1  christos # subject_match: Substring to be matched against the subject of the
   1011          1.1  christos #	authentication server certificate. If this string is set, the server
   1012  1.1.1.3.4.2       snj #	certificate is only accepted if it contains this string in the subject.
   1013          1.1  christos #	The subject string is in following format:
   1014          1.1  christos #	/C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as (at] example.com
   1015  1.1.1.3.4.2       snj #	Note: Since this is a substring match, this cannot be used securely to
   1016  1.1.1.3.4.1       snj #	do a suffix match against a possible domain name in the CN entry. For
   1017  1.1.1.3.4.1       snj #	such a use case, domain_suffix_match or domain_match should be used
   1018  1.1.1.3.4.1       snj #	instead.
   1019          1.1  christos # altsubject_match: Semicolon separated string of entries to be matched against
   1020          1.1  christos #	the alternative subject name of the authentication server certificate.
   1021  1.1.1.3.4.2       snj #	If this string is set, the server certificate is only accepted if it
   1022          1.1  christos #	contains one of the entries in an alternative subject name extension.
   1023          1.1  christos #	altSubjectName string is in following format: TYPE:VALUE
   1024          1.1  christos #	Example: EMAIL:server (at] example.com
   1025          1.1  christos #	Example: DNS:server.example.com;DNS:server2.example.com
   1026          1.1  christos #	Following types are supported: EMAIL, DNS, URI
   1027  1.1.1.3.4.1       snj # domain_suffix_match: Constraint for server domain name. If set, this FQDN is
   1028  1.1.1.3.4.2       snj #	used as a suffix match requirement for the AAA server certificate in
   1029  1.1.1.3.4.1       snj #	SubjectAltName dNSName element(s). If a matching dNSName is found, this
   1030  1.1.1.3.4.1       snj #	constraint is met. If no dNSName values are present, this constraint is
   1031  1.1.1.3.4.1       snj #	matched against SubjectName CN using same suffix match comparison.
   1032  1.1.1.3.4.1       snj #
   1033  1.1.1.3.4.1       snj #	Suffix match here means that the host/domain name is compared one label
   1034  1.1.1.3.4.1       snj #	at a time starting from the top-level domain and all the labels in
   1035  1.1.1.3.4.1       snj #	domain_suffix_match shall be included in the certificate. The
   1036  1.1.1.3.4.1       snj #	certificate may include additional sub-level labels in addition to the
   1037  1.1.1.3.4.1       snj #	required labels.
   1038  1.1.1.3.4.1       snj #
   1039  1.1.1.3.4.1       snj #	For example, domain_suffix_match=example.com would match
   1040  1.1.1.3.4.1       snj #	test.example.com but would not match test-example.com.
   1041  1.1.1.3.4.1       snj # domain_match: Constraint for server domain name
   1042  1.1.1.3.4.1       snj #	If set, this FQDN is used as a full match requirement for the
   1043  1.1.1.3.4.1       snj #	server certificate in SubjectAltName dNSName element(s). If a
   1044  1.1.1.3.4.1       snj #	matching dNSName is found, this constraint is met. If no dNSName
   1045  1.1.1.3.4.1       snj #	values are present, this constraint is matched against SubjectName CN
   1046  1.1.1.3.4.1       snj #	using same full match comparison. This behavior is similar to
   1047  1.1.1.3.4.1       snj #	domain_suffix_match, but has the requirement of a full match, i.e.,
   1048  1.1.1.3.4.1       snj #	no subdomains or wildcard matches are allowed. Case-insensitive
   1049  1.1.1.3.4.1       snj #	comparison is used, so "Example.com" matches "example.com", but would
   1050  1.1.1.3.4.1       snj #	not match "test.Example.com".
   1051          1.1  christos # phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
   1052          1.1  christos #	(string with field-value pairs, e.g., "peapver=0" or
   1053          1.1  christos #	"peapver=1 peaplabel=1")
   1054          1.1  christos #	'peapver' can be used to force which PEAP version (0 or 1) is used.
   1055          1.1  christos #	'peaplabel=1' can be used to force new label, "client PEAP encryption",
   1056          1.1  christos #	to be used during key derivation when PEAPv1 or newer. Most existing
   1057          1.1  christos #	PEAPv1 implementation seem to be using the old label, "client EAP
   1058          1.1  christos #	encryption", and wpa_supplicant is now using that as the default value.
   1059          1.1  christos #	Some servers, e.g., Radiator, may require peaplabel=1 configuration to
   1060          1.1  christos #	interoperate with PEAPv1; see eap_testing.txt for more details.
   1061          1.1  christos #	'peap_outer_success=0' can be used to terminate PEAP authentication on
   1062          1.1  christos #	tunneled EAP-Success. This is required with some RADIUS servers that
   1063          1.1  christos #	implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
   1064          1.1  christos #	Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
   1065          1.1  christos #	include_tls_length=1 can be used to force wpa_supplicant to include
   1066          1.1  christos #	TLS Message Length field in all TLS messages even if they are not
   1067          1.1  christos #	fragmented.
   1068          1.1  christos #	sim_min_num_chal=3 can be used to configure EAP-SIM to require three
   1069          1.1  christos #	challenges (by default, it accepts 2 or 3)
   1070          1.1  christos #	result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
   1071          1.1  christos #	protected result indication.
   1072          1.1  christos #	'crypto_binding' option can be used to control PEAPv0 cryptobinding
   1073          1.1  christos #	behavior:
   1074          1.1  christos #	 * 0 = do not use cryptobinding (default)
   1075          1.1  christos #	 * 1 = use cryptobinding if server supports it
   1076          1.1  christos #	 * 2 = require cryptobinding
   1077          1.1  christos #	EAP-WSC (WPS) uses following options: pin=<Device Password> or
   1078          1.1  christos #	pbc=1.
   1079  1.1.1.3.4.1       snj #
   1080  1.1.1.3.4.1       snj #	For wired IEEE 802.1X authentication, "allow_canned_success=1" can be
   1081  1.1.1.3.4.1       snj #	used to configure a mode that allows EAP-Success (and EAP-Failure)
   1082  1.1.1.3.4.1       snj #	without going through authentication step. Some switches use such
   1083  1.1.1.3.4.1       snj #	sequence when forcing the port to be authorized/unauthorized or as a
   1084  1.1.1.3.4.1       snj #	fallback option if the authentication server is unreachable. By default,
   1085  1.1.1.3.4.1       snj #	wpa_supplicant discards such frames to protect against potential attacks
   1086  1.1.1.3.4.1       snj #	by rogue devices, but this option can be used to disable that protection
   1087  1.1.1.3.4.1       snj #	for cases where the server/authenticator does not need to be
   1088  1.1.1.3.4.1       snj #	authenticated.
   1089          1.1  christos # phase2: Phase2 (inner authentication with TLS tunnel) parameters
   1090          1.1  christos #	(string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
   1091  1.1.1.3.4.1       snj #	"autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS). "mschapv2_retry=0" can be
   1092  1.1.1.3.4.1       snj #	used to disable MSCHAPv2 password retry in authentication failure cases.
   1093      1.1.1.3  christos #
   1094      1.1.1.3  christos # TLS-based methods can use the following parameters to control TLS behavior
   1095      1.1.1.3  christos # (these are normally in the phase1 parameter, but can be used also in the
   1096      1.1.1.3  christos # phase2 parameter when EAP-TLS is used within the inner tunnel):
   1097      1.1.1.3  christos # tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the
   1098      1.1.1.3  christos #	TLS library, these may be disabled by default to enforce stronger
   1099      1.1.1.3  christos #	security)
   1100      1.1.1.3  christos # tls_disable_time_checks=1 - ignore certificate validity time (this requests
   1101      1.1.1.3  christos #	the TLS library to accept certificates even if they are not currently
   1102      1.1.1.3  christos #	valid, i.e., have expired or have not yet become valid; this should be
   1103      1.1.1.3  christos #	used only for testing purposes)
   1104      1.1.1.3  christos # tls_disable_session_ticket=1 - disable TLS Session Ticket extension
   1105      1.1.1.3  christos # tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used
   1106      1.1.1.3  christos #	Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS
   1107      1.1.1.3  christos #	as a workaround for broken authentication server implementations unless
   1108  1.1.1.3.4.2       snj #	EAP workarounds are disabled with eap_workaround=0.
   1109      1.1.1.3  christos #	For EAP-FAST, this must be set to 0 (or left unconfigured for the
   1110      1.1.1.3  christos #	default value to be used automatically).
   1111  1.1.1.3.4.2       snj # tls_disable_tlsv1_0=1 - disable use of TLSv1.0
   1112  1.1.1.3.4.1       snj # tls_disable_tlsv1_1=1 - disable use of TLSv1.1 (a workaround for AAA servers
   1113  1.1.1.3.4.1       snj #	that have issues interoperating with updated TLS version)
   1114  1.1.1.3.4.1       snj # tls_disable_tlsv1_2=1 - disable use of TLSv1.2 (a workaround for AAA servers
   1115  1.1.1.3.4.1       snj #	that have issues interoperating with updated TLS version)
   1116  1.1.1.3.4.2       snj # tls_ext_cert_check=0 - No external server certificate validation (default)
   1117  1.1.1.3.4.2       snj # tls_ext_cert_check=1 - External server certificate validation enabled; this
   1118  1.1.1.3.4.2       snj #	requires an external program doing validation of server certificate
   1119  1.1.1.3.4.2       snj #	chain when receiving CTRL-RSP-EXT_CERT_CHECK event from the control
   1120  1.1.1.3.4.2       snj #	interface and report the result of the validation with
   1121  1.1.1.3.4.2       snj #	CTRL-RSP_EXT_CERT_CHECK.
   1122      1.1.1.3  christos #
   1123          1.1  christos # Following certificate/private key fields are used in inner Phase2
   1124          1.1  christos # authentication when using EAP-TTLS or EAP-PEAP.
   1125          1.1  christos # ca_cert2: File path to CA certificate file. This file can have one or more
   1126          1.1  christos #	trusted CA certificates. If ca_cert2 and ca_path2 are not included,
   1127          1.1  christos #	server certificate will not be verified. This is insecure and a trusted
   1128          1.1  christos #	CA certificate should always be configured.
   1129          1.1  christos # ca_path2: Directory path for CA certificate files (PEM)
   1130          1.1  christos # client_cert2: File path to client certificate file
   1131          1.1  christos # private_key2: File path to client private key file
   1132          1.1  christos # private_key2_passwd: Password for private key file
   1133          1.1  christos # dh_file2: File path to DH/DSA parameters file (in PEM format)
   1134          1.1  christos # subject_match2: Substring to be matched against the subject of the
   1135  1.1.1.3.4.1       snj #	authentication server certificate. See subject_match for more details.
   1136  1.1.1.3.4.1       snj # altsubject_match2: Semicolon separated string of entries to be matched
   1137  1.1.1.3.4.1       snj #	against the alternative subject name of the authentication server
   1138  1.1.1.3.4.1       snj #	certificate. See altsubject_match documentation for more details.
   1139  1.1.1.3.4.1       snj # domain_suffix_match2: Constraint for server domain name. See
   1140  1.1.1.3.4.1       snj #	domain_suffix_match for more details.
   1141          1.1  christos #
   1142          1.1  christos # fragment_size: Maximum EAP fragment size in bytes (default 1398).
   1143          1.1  christos #	This value limits the fragment size for EAP methods that support
   1144          1.1  christos #	fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
   1145          1.1  christos #	small enough to make the EAP messages fit in MTU of the network
   1146          1.1  christos #	interface used for EAPOL. The default value is suitable for most
   1147          1.1  christos #	cases.
   1148          1.1  christos #
   1149  1.1.1.3.4.1       snj # ocsp: Whether to use/require OCSP to check server certificate
   1150  1.1.1.3.4.1       snj #	0 = do not use OCSP stapling (TLS certificate status extension)
   1151  1.1.1.3.4.1       snj #	1 = try to use OCSP stapling, but not require response
   1152  1.1.1.3.4.1       snj #	2 = require valid OCSP stapling response
   1153  1.1.1.3.4.2       snj #	3 = require valid OCSP stapling response for all not-trusted
   1154  1.1.1.3.4.2       snj #	    certificates in the server certificate chain
   1155  1.1.1.3.4.1       snj #
   1156  1.1.1.3.4.1       snj # openssl_ciphers: OpenSSL specific cipher configuration
   1157  1.1.1.3.4.1       snj #	This can be used to override the global openssl_ciphers configuration
   1158  1.1.1.3.4.1       snj #	parameter (see above).
   1159  1.1.1.3.4.1       snj #
   1160  1.1.1.3.4.1       snj # erp: Whether EAP Re-authentication Protocol (ERP) is enabled
   1161  1.1.1.3.4.1       snj #
   1162          1.1  christos # EAP-FAST variables:
   1163          1.1  christos # pac_file: File path for the PAC entries. wpa_supplicant will need to be able
   1164          1.1  christos #	to create this file and write updates to it when PAC is being
   1165          1.1  christos #	provisioned or refreshed. Full path to the file should be used since
   1166          1.1  christos #	working directory may change when wpa_supplicant is run in the
   1167          1.1  christos #	background. Alternatively, a named configuration blob can be used by
   1168          1.1  christos #	setting this to blob://<blob name>
   1169          1.1  christos # phase1: fast_provisioning option can be used to enable in-line provisioning
   1170          1.1  christos #         of EAP-FAST credentials (PAC):
   1171          1.1  christos #         0 = disabled,
   1172          1.1  christos #         1 = allow unauthenticated provisioning,
   1173          1.1  christos #         2 = allow authenticated provisioning,
   1174          1.1  christos #         3 = allow both unauthenticated and authenticated provisioning
   1175          1.1  christos #	fast_max_pac_list_len=<num> option can be used to set the maximum
   1176          1.1  christos #		number of PAC entries to store in a PAC list (default: 10)
   1177          1.1  christos #	fast_pac_format=binary option can be used to select binary format for
   1178          1.1  christos #		storing PAC entries in order to save some space (the default
   1179          1.1  christos #		text format uses about 2.5 times the size of minimal binary
   1180          1.1  christos #		format)
   1181          1.1  christos #
   1182          1.1  christos # wpa_supplicant supports number of "EAP workarounds" to work around
   1183          1.1  christos # interoperability issues with incorrectly behaving authentication servers.
   1184          1.1  christos # These are enabled by default because some of the issues are present in large
   1185          1.1  christos # number of authentication servers. Strict EAP conformance mode can be
   1186          1.1  christos # configured by disabling workarounds with eap_workaround=0.
   1187          1.1  christos 
   1188  1.1.1.3.4.2       snj # update_identifier: PPS MO ID
   1189  1.1.1.3.4.2       snj #	(Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
   1190  1.1.1.3.4.2       snj 
   1191      1.1.1.3  christos # Station inactivity limit
   1192      1.1.1.3  christos #
   1193      1.1.1.3  christos # If a station does not send anything in ap_max_inactivity seconds, an
   1194      1.1.1.3  christos # empty data frame is sent to it in order to verify whether it is
   1195      1.1.1.3  christos # still in range. If this frame is not ACKed, the station will be
   1196      1.1.1.3  christos # disassociated and then deauthenticated. This feature is used to
   1197      1.1.1.3  christos # clear station table of old entries when the STAs move out of the
   1198      1.1.1.3  christos # range.
   1199      1.1.1.3  christos #
   1200      1.1.1.3  christos # The station can associate again with the AP if it is still in range;
   1201      1.1.1.3  christos # this inactivity poll is just used as a nicer way of verifying
   1202      1.1.1.3  christos # inactivity; i.e., client will not report broken connection because
   1203      1.1.1.3  christos # disassociation frame is not sent immediately without first polling
   1204      1.1.1.3  christos # the STA with a data frame.
   1205      1.1.1.3  christos # default: 300 (i.e., 5 minutes)
   1206      1.1.1.3  christos #ap_max_inactivity=300
   1207      1.1.1.3  christos 
   1208      1.1.1.3  christos # DTIM period in Beacon intervals for AP mode (default: 2)
   1209      1.1.1.3  christos #dtim_period=2
   1210      1.1.1.3  christos 
   1211  1.1.1.3.4.1       snj # Beacon interval (default: 100 TU)
   1212  1.1.1.3.4.1       snj #beacon_int=100
   1213  1.1.1.3.4.1       snj 
   1214  1.1.1.3.4.2       snj # WPS in AP mode
   1215  1.1.1.3.4.2       snj # 0 = WPS enabled and configured (default)
   1216  1.1.1.3.4.2       snj # 1 = WPS disabled
   1217  1.1.1.3.4.2       snj #wps_disabled=0
   1218  1.1.1.3.4.2       snj 
   1219  1.1.1.3.4.1       snj # MAC address policy
   1220  1.1.1.3.4.1       snj # 0 = use permanent MAC address
   1221  1.1.1.3.4.1       snj # 1 = use random MAC address for each ESS connection
   1222  1.1.1.3.4.1       snj # 2 = like 1, but maintain OUI (with local admin bit set)
   1223  1.1.1.3.4.1       snj #mac_addr=0
   1224  1.1.1.3.4.1       snj 
   1225      1.1.1.3  christos # disable_ht: Whether HT (802.11n) should be disabled.
   1226      1.1.1.3  christos # 0 = HT enabled (if AP supports it)
   1227      1.1.1.3  christos # 1 = HT disabled
   1228      1.1.1.3  christos #
   1229      1.1.1.3  christos # disable_ht40: Whether HT-40 (802.11n) should be disabled.
   1230      1.1.1.3  christos # 0 = HT-40 enabled (if AP supports it)
   1231      1.1.1.3  christos # 1 = HT-40 disabled
   1232      1.1.1.3  christos #
   1233      1.1.1.3  christos # disable_sgi: Whether SGI (short guard interval) should be disabled.
   1234      1.1.1.3  christos # 0 = SGI enabled (if AP supports it)
   1235      1.1.1.3  christos # 1 = SGI disabled
   1236      1.1.1.3  christos #
   1237  1.1.1.3.4.1       snj # disable_ldpc: Whether LDPC should be disabled.
   1238  1.1.1.3.4.1       snj # 0 = LDPC enabled (if AP supports it)
   1239  1.1.1.3.4.1       snj # 1 = LDPC disabled
   1240  1.1.1.3.4.1       snj #
   1241  1.1.1.3.4.1       snj # ht40_intolerant: Whether 40 MHz intolerant should be indicated.
   1242  1.1.1.3.4.1       snj # 0 = 40 MHz tolerant (default)
   1243  1.1.1.3.4.1       snj # 1 = 40 MHz intolerant
   1244  1.1.1.3.4.1       snj #
   1245      1.1.1.3  christos # ht_mcs:  Configure allowed MCS rates.
   1246      1.1.1.3  christos #  Parsed as an array of bytes, in base-16 (ascii-hex)
   1247      1.1.1.3  christos # ht_mcs=""                                   // Use all available (default)
   1248      1.1.1.3  christos # ht_mcs="0xff 00 00 00 00 00 00 00 00 00 "   // Use MCS 0-7 only
   1249      1.1.1.3  christos # ht_mcs="0xff ff 00 00 00 00 00 00 00 00 "   // Use MCS 0-15 only
   1250      1.1.1.3  christos #
   1251      1.1.1.3  christos # disable_max_amsdu:  Whether MAX_AMSDU should be disabled.
   1252      1.1.1.3  christos # -1 = Do not make any changes.
   1253      1.1.1.3  christos # 0  = Enable MAX-AMSDU if hardware supports it.
   1254      1.1.1.3  christos # 1  = Disable AMSDU
   1255      1.1.1.3  christos #
   1256  1.1.1.3.4.1       snj # ampdu_factor: Maximum A-MPDU Length Exponent
   1257  1.1.1.3.4.1       snj # Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
   1258  1.1.1.3.4.1       snj #
   1259      1.1.1.3  christos # ampdu_density:  Allow overriding AMPDU density configuration.
   1260      1.1.1.3  christos #  Treated as hint by the kernel.
   1261      1.1.1.3  christos # -1 = Do not make any changes.
   1262      1.1.1.3  christos # 0-3 = Set AMPDU density (aka factor) to specified value.
   1263      1.1.1.3  christos 
   1264  1.1.1.3.4.1       snj # disable_vht: Whether VHT should be disabled.
   1265  1.1.1.3.4.1       snj # 0 = VHT enabled (if AP supports it)
   1266  1.1.1.3.4.1       snj # 1 = VHT disabled
   1267  1.1.1.3.4.1       snj #
   1268  1.1.1.3.4.1       snj # vht_capa: VHT capabilities to set in the override
   1269  1.1.1.3.4.1       snj # vht_capa_mask: mask of VHT capabilities
   1270  1.1.1.3.4.1       snj #
   1271  1.1.1.3.4.1       snj # vht_rx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for RX NSS 1-8
   1272  1.1.1.3.4.1       snj # vht_tx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for TX NSS 1-8
   1273  1.1.1.3.4.1       snj #  0: MCS 0-7
   1274  1.1.1.3.4.1       snj #  1: MCS 0-8
   1275  1.1.1.3.4.1       snj #  2: MCS 0-9
   1276  1.1.1.3.4.1       snj #  3: not supported
   1277  1.1.1.3.4.1       snj 
   1278  1.1.1.3.4.2       snj ##### Fast Session Transfer (FST) support #####################################
   1279  1.1.1.3.4.2       snj #
   1280  1.1.1.3.4.2       snj # The options in this section are only available when the build configuration
   1281  1.1.1.3.4.2       snj # option CONFIG_FST is set while compiling wpa_supplicant. They allow this
   1282  1.1.1.3.4.2       snj # interface to be a part of FST setup.
   1283  1.1.1.3.4.2       snj #
   1284  1.1.1.3.4.2       snj # FST is the transfer of a session from a channel to another channel, in the
   1285  1.1.1.3.4.2       snj # same or different frequency bands.
   1286  1.1.1.3.4.2       snj #
   1287  1.1.1.3.4.2       snj # For details, see IEEE Std 802.11ad-2012.
   1288  1.1.1.3.4.2       snj 
   1289  1.1.1.3.4.2       snj # Identifier of an FST Group  the interface belongs to.
   1290  1.1.1.3.4.2       snj #fst_group_id=bond0
   1291  1.1.1.3.4.2       snj 
   1292  1.1.1.3.4.2       snj # Interface priority within the FST Group.
   1293  1.1.1.3.4.2       snj # Announcing a higher priority for an interface means declaring it more
   1294  1.1.1.3.4.2       snj # preferable for FST switch.
   1295  1.1.1.3.4.2       snj # fst_priority is in 1..255 range with 1 being the lowest priority.
   1296  1.1.1.3.4.2       snj #fst_priority=100
   1297  1.1.1.3.4.2       snj 
   1298  1.1.1.3.4.2       snj # Default LLT value for this interface in milliseconds. The value used in case
   1299  1.1.1.3.4.2       snj # no value provided during session setup. Default is 50 msec.
   1300  1.1.1.3.4.2       snj # fst_llt is in 1..4294967 range (due to spec limitation, see 10.32.2.2
   1301  1.1.1.3.4.2       snj # Transitioning between states).
   1302  1.1.1.3.4.2       snj #fst_llt=100
   1303  1.1.1.3.4.2       snj 
   1304          1.1  christos # Example blocks:
   1305          1.1  christos 
   1306          1.1  christos # Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
   1307          1.1  christos network={
   1308          1.1  christos 	ssid="simple"
   1309          1.1  christos 	psk="very secret passphrase"
   1310          1.1  christos 	priority=5
   1311          1.1  christos }
   1312          1.1  christos 
   1313          1.1  christos # Same as previous, but request SSID-specific scanning (for APs that reject
   1314          1.1  christos # broadcast SSID)
   1315          1.1  christos network={
   1316          1.1  christos 	ssid="second ssid"
   1317          1.1  christos 	scan_ssid=1
   1318          1.1  christos 	psk="very secret passphrase"
   1319          1.1  christos 	priority=2
   1320          1.1  christos }
   1321          1.1  christos 
   1322          1.1  christos # Only WPA-PSK is used. Any valid cipher combination is accepted.
   1323          1.1  christos network={
   1324          1.1  christos 	ssid="example"
   1325          1.1  christos 	proto=WPA
   1326          1.1  christos 	key_mgmt=WPA-PSK
   1327          1.1  christos 	pairwise=CCMP TKIP
   1328          1.1  christos 	group=CCMP TKIP WEP104 WEP40
   1329          1.1  christos 	psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
   1330          1.1  christos 	priority=2
   1331          1.1  christos }
   1332          1.1  christos 
   1333          1.1  christos # WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
   1334          1.1  christos network={
   1335          1.1  christos 	ssid="example"
   1336          1.1  christos 	proto=WPA
   1337          1.1  christos 	key_mgmt=WPA-PSK
   1338          1.1  christos 	pairwise=TKIP
   1339          1.1  christos 	group=TKIP
   1340          1.1  christos 	psk="not so secure passphrase"
   1341          1.1  christos 	wpa_ptk_rekey=600
   1342          1.1  christos }
   1343          1.1  christos 
   1344          1.1  christos # Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
   1345          1.1  christos # or WEP40 as the group cipher will not be accepted.
   1346          1.1  christos network={
   1347          1.1  christos 	ssid="example"
   1348          1.1  christos 	proto=RSN
   1349          1.1  christos 	key_mgmt=WPA-EAP
   1350          1.1  christos 	pairwise=CCMP TKIP
   1351          1.1  christos 	group=CCMP TKIP
   1352          1.1  christos 	eap=TLS
   1353          1.1  christos 	identity="user (at] example.com"
   1354          1.1  christos 	ca_cert="/etc/cert/ca.pem"
   1355          1.1  christos 	client_cert="/etc/cert/user.pem"
   1356          1.1  christos 	private_key="/etc/cert/user.prv"
   1357          1.1  christos 	private_key_passwd="password"
   1358          1.1  christos 	priority=1
   1359          1.1  christos }
   1360          1.1  christos 
   1361          1.1  christos # EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
   1362          1.1  christos # (e.g., Radiator)
   1363          1.1  christos network={
   1364          1.1  christos 	ssid="example"
   1365          1.1  christos 	key_mgmt=WPA-EAP
   1366          1.1  christos 	eap=PEAP
   1367          1.1  christos 	identity="user (at] example.com"
   1368          1.1  christos 	password="foobar"
   1369          1.1  christos 	ca_cert="/etc/cert/ca.pem"
   1370          1.1  christos 	phase1="peaplabel=1"
   1371          1.1  christos 	phase2="auth=MSCHAPV2"
   1372          1.1  christos 	priority=10
   1373          1.1  christos }
   1374          1.1  christos 
   1375          1.1  christos # EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
   1376          1.1  christos # unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
   1377          1.1  christos network={
   1378          1.1  christos 	ssid="example"
   1379          1.1  christos 	key_mgmt=WPA-EAP
   1380          1.1  christos 	eap=TTLS
   1381          1.1  christos 	identity="user (at] example.com"
   1382          1.1  christos 	anonymous_identity="anonymous (at] example.com"
   1383          1.1  christos 	password="foobar"
   1384          1.1  christos 	ca_cert="/etc/cert/ca.pem"
   1385          1.1  christos 	priority=2
   1386          1.1  christos }
   1387          1.1  christos 
   1388          1.1  christos # EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
   1389          1.1  christos # use. Real identity is sent only within an encrypted TLS tunnel.
   1390          1.1  christos network={
   1391          1.1  christos 	ssid="example"
   1392          1.1  christos 	key_mgmt=WPA-EAP
   1393          1.1  christos 	eap=TTLS
   1394          1.1  christos 	identity="user (at] example.com"
   1395          1.1  christos 	anonymous_identity="anonymous (at] example.com"
   1396          1.1  christos 	password="foobar"
   1397          1.1  christos 	ca_cert="/etc/cert/ca.pem"
   1398          1.1  christos 	phase2="auth=MSCHAPV2"
   1399          1.1  christos }
   1400          1.1  christos 
   1401          1.1  christos # WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
   1402          1.1  christos # authentication.
   1403          1.1  christos network={
   1404          1.1  christos 	ssid="example"
   1405          1.1  christos 	key_mgmt=WPA-EAP
   1406          1.1  christos 	eap=TTLS
   1407          1.1  christos 	# Phase1 / outer authentication
   1408          1.1  christos 	anonymous_identity="anonymous (at] example.com"
   1409          1.1  christos 	ca_cert="/etc/cert/ca.pem"
   1410          1.1  christos 	# Phase 2 / inner authentication
   1411          1.1  christos 	phase2="autheap=TLS"
   1412          1.1  christos 	ca_cert2="/etc/cert/ca2.pem"
   1413          1.1  christos 	client_cert2="/etc/cer/user.pem"
   1414          1.1  christos 	private_key2="/etc/cer/user.prv"
   1415          1.1  christos 	private_key2_passwd="password"
   1416          1.1  christos 	priority=2
   1417          1.1  christos }
   1418          1.1  christos 
   1419          1.1  christos # Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
   1420          1.1  christos # group cipher.
   1421          1.1  christos network={
   1422          1.1  christos 	ssid="example"
   1423          1.1  christos 	bssid=00:11:22:33:44:55
   1424          1.1  christos 	proto=WPA RSN
   1425          1.1  christos 	key_mgmt=WPA-PSK WPA-EAP
   1426          1.1  christos 	pairwise=CCMP
   1427          1.1  christos 	group=CCMP
   1428          1.1  christos 	psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
   1429          1.1  christos }
   1430          1.1  christos 
   1431          1.1  christos # Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
   1432          1.1  christos # and all valid ciphers.
   1433          1.1  christos network={
   1434          1.1  christos 	ssid=00010203
   1435          1.1  christos 	psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
   1436          1.1  christos }
   1437          1.1  christos 
   1438          1.1  christos 
   1439          1.1  christos # EAP-SIM with a GSM SIM or USIM
   1440          1.1  christos network={
   1441          1.1  christos 	ssid="eap-sim-test"
   1442          1.1  christos 	key_mgmt=WPA-EAP
   1443          1.1  christos 	eap=SIM
   1444          1.1  christos 	pin="1234"
   1445          1.1  christos 	pcsc=""
   1446          1.1  christos }
   1447          1.1  christos 
   1448          1.1  christos 
   1449          1.1  christos # EAP-PSK
   1450          1.1  christos network={
   1451          1.1  christos 	ssid="eap-psk-test"
   1452          1.1  christos 	key_mgmt=WPA-EAP
   1453          1.1  christos 	eap=PSK
   1454          1.1  christos 	anonymous_identity="eap_psk_user"
   1455          1.1  christos 	password=06b4be19da289f475aa46a33cb793029
   1456          1.1  christos 	identity="eap_psk_user (at] example.com"
   1457          1.1  christos }
   1458          1.1  christos 
   1459          1.1  christos 
   1460          1.1  christos # IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
   1461          1.1  christos # EAP-TLS for authentication and key generation; require both unicast and
   1462          1.1  christos # broadcast WEP keys.
   1463          1.1  christos network={
   1464          1.1  christos 	ssid="1x-test"
   1465          1.1  christos 	key_mgmt=IEEE8021X
   1466          1.1  christos 	eap=TLS
   1467          1.1  christos 	identity="user (at] example.com"
   1468          1.1  christos 	ca_cert="/etc/cert/ca.pem"
   1469          1.1  christos 	client_cert="/etc/cert/user.pem"
   1470          1.1  christos 	private_key="/etc/cert/user.prv"
   1471          1.1  christos 	private_key_passwd="password"
   1472          1.1  christos 	eapol_flags=3
   1473          1.1  christos }
   1474          1.1  christos 
   1475          1.1  christos 
   1476          1.1  christos # LEAP with dynamic WEP keys
   1477          1.1  christos network={
   1478          1.1  christos 	ssid="leap-example"
   1479          1.1  christos 	key_mgmt=IEEE8021X
   1480          1.1  christos 	eap=LEAP
   1481          1.1  christos 	identity="user"
   1482          1.1  christos 	password="foobar"
   1483          1.1  christos }
   1484          1.1  christos 
   1485          1.1  christos # EAP-IKEv2 using shared secrets for both server and peer authentication
   1486          1.1  christos network={
   1487          1.1  christos 	ssid="ikev2-example"
   1488          1.1  christos 	key_mgmt=WPA-EAP
   1489          1.1  christos 	eap=IKEV2
   1490          1.1  christos 	identity="user"
   1491          1.1  christos 	password="foobar"
   1492          1.1  christos }
   1493          1.1  christos 
   1494          1.1  christos # EAP-FAST with WPA (WPA or WPA2)
   1495          1.1  christos network={
   1496          1.1  christos 	ssid="eap-fast-test"
   1497          1.1  christos 	key_mgmt=WPA-EAP
   1498          1.1  christos 	eap=FAST
   1499          1.1  christos 	anonymous_identity="FAST-000102030405"
   1500          1.1  christos 	identity="username"
   1501          1.1  christos 	password="password"
   1502          1.1  christos 	phase1="fast_provisioning=1"
   1503          1.1  christos 	pac_file="/etc/wpa_supplicant.eap-fast-pac"
   1504          1.1  christos }
   1505          1.1  christos 
   1506          1.1  christos network={
   1507          1.1  christos 	ssid="eap-fast-test"
   1508          1.1  christos 	key_mgmt=WPA-EAP
   1509          1.1  christos 	eap=FAST
   1510          1.1  christos 	anonymous_identity="FAST-000102030405"
   1511          1.1  christos 	identity="username"
   1512          1.1  christos 	password="password"
   1513          1.1  christos 	phase1="fast_provisioning=1"
   1514          1.1  christos 	pac_file="blob://eap-fast-pac"
   1515          1.1  christos }
   1516          1.1  christos 
   1517          1.1  christos # Plaintext connection (no WPA, no IEEE 802.1X)
   1518          1.1  christos network={
   1519          1.1  christos 	ssid="plaintext-test"
   1520          1.1  christos 	key_mgmt=NONE
   1521          1.1  christos }
   1522          1.1  christos 
   1523          1.1  christos 
   1524          1.1  christos # Shared WEP key connection (no WPA, no IEEE 802.1X)
   1525          1.1  christos network={
   1526          1.1  christos 	ssid="static-wep-test"
   1527          1.1  christos 	key_mgmt=NONE
   1528          1.1  christos 	wep_key0="abcde"
   1529          1.1  christos 	wep_key1=0102030405
   1530          1.1  christos 	wep_key2="1234567890123"
   1531          1.1  christos 	wep_tx_keyidx=0
   1532          1.1  christos 	priority=5
   1533          1.1  christos }
   1534          1.1  christos 
   1535          1.1  christos 
   1536          1.1  christos # Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
   1537          1.1  christos # IEEE 802.11 authentication
   1538          1.1  christos network={
   1539          1.1  christos 	ssid="static-wep-test2"
   1540          1.1  christos 	key_mgmt=NONE
   1541          1.1  christos 	wep_key0="abcde"
   1542          1.1  christos 	wep_key1=0102030405
   1543          1.1  christos 	wep_key2="1234567890123"
   1544          1.1  christos 	wep_tx_keyidx=0
   1545          1.1  christos 	priority=5
   1546          1.1  christos 	auth_alg=SHARED
   1547          1.1  christos }
   1548          1.1  christos 
   1549          1.1  christos 
   1550  1.1.1.3.4.1       snj # IBSS/ad-hoc network with RSN
   1551  1.1.1.3.4.1       snj network={
   1552  1.1.1.3.4.1       snj 	ssid="ibss-rsn"
   1553  1.1.1.3.4.1       snj 	key_mgmt=WPA-PSK
   1554  1.1.1.3.4.1       snj 	proto=RSN
   1555  1.1.1.3.4.1       snj 	psk="12345678"
   1556  1.1.1.3.4.1       snj 	mode=1
   1557  1.1.1.3.4.1       snj 	frequency=2412
   1558  1.1.1.3.4.1       snj 	pairwise=CCMP
   1559  1.1.1.3.4.1       snj 	group=CCMP
   1560  1.1.1.3.4.1       snj }
   1561  1.1.1.3.4.1       snj 
   1562  1.1.1.3.4.1       snj # IBSS/ad-hoc network with WPA-None/TKIP (deprecated)
   1563          1.1  christos network={
   1564          1.1  christos 	ssid="test adhoc"
   1565          1.1  christos 	mode=1
   1566          1.1  christos 	frequency=2412
   1567          1.1  christos 	proto=WPA
   1568          1.1  christos 	key_mgmt=WPA-NONE
   1569          1.1  christos 	pairwise=NONE
   1570          1.1  christos 	group=TKIP
   1571          1.1  christos 	psk="secret passphrase"
   1572          1.1  christos }
   1573          1.1  christos 
   1574  1.1.1.3.4.1       snj # open mesh network
   1575  1.1.1.3.4.1       snj network={
   1576  1.1.1.3.4.1       snj 	ssid="test mesh"
   1577  1.1.1.3.4.1       snj 	mode=5
   1578  1.1.1.3.4.1       snj 	frequency=2437
   1579  1.1.1.3.4.1       snj 	key_mgmt=NONE
   1580  1.1.1.3.4.1       snj }
   1581  1.1.1.3.4.1       snj 
   1582  1.1.1.3.4.1       snj # secure (SAE + AMPE) network
   1583  1.1.1.3.4.1       snj network={
   1584  1.1.1.3.4.1       snj 	ssid="secure mesh"
   1585  1.1.1.3.4.1       snj 	mode=5
   1586  1.1.1.3.4.1       snj 	frequency=2437
   1587  1.1.1.3.4.1       snj 	key_mgmt=SAE
   1588  1.1.1.3.4.1       snj 	psk="very secret passphrase"
   1589  1.1.1.3.4.1       snj }
   1590  1.1.1.3.4.1       snj 
   1591          1.1  christos 
   1592          1.1  christos # Catch all example that allows more or less all configuration modes
   1593          1.1  christos network={
   1594          1.1  christos 	ssid="example"
   1595          1.1  christos 	scan_ssid=1
   1596          1.1  christos 	key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
   1597          1.1  christos 	pairwise=CCMP TKIP
   1598          1.1  christos 	group=CCMP TKIP WEP104 WEP40
   1599          1.1  christos 	psk="very secret passphrase"
   1600          1.1  christos 	eap=TTLS PEAP TLS
   1601          1.1  christos 	identity="user (at] example.com"
   1602          1.1  christos 	password="foobar"
   1603          1.1  christos 	ca_cert="/etc/cert/ca.pem"
   1604          1.1  christos 	client_cert="/etc/cert/user.pem"
   1605          1.1  christos 	private_key="/etc/cert/user.prv"
   1606          1.1  christos 	private_key_passwd="password"
   1607          1.1  christos 	phase1="peaplabel=0"
   1608          1.1  christos }
   1609          1.1  christos 
   1610          1.1  christos # Example of EAP-TLS with smartcard (openssl engine)
   1611          1.1  christos network={
   1612          1.1  christos 	ssid="example"
   1613          1.1  christos 	key_mgmt=WPA-EAP
   1614          1.1  christos 	eap=TLS
   1615          1.1  christos 	proto=RSN
   1616          1.1  christos 	pairwise=CCMP TKIP
   1617          1.1  christos 	group=CCMP TKIP
   1618          1.1  christos 	identity="user (at] example.com"
   1619          1.1  christos 	ca_cert="/etc/cert/ca.pem"
   1620          1.1  christos 
   1621  1.1.1.3.4.2       snj 	# Certificate and/or key identified by PKCS#11 URI (RFC7512)
   1622  1.1.1.3.4.2       snj 	client_cert="pkcs11:manufacturer=piv_II;id=%01"
   1623  1.1.1.3.4.2       snj 	private_key="pkcs11:manufacturer=piv_II;id=%01"
   1624          1.1  christos 
   1625          1.1  christos 	# Optional PIN configuration; this can be left out and PIN will be
   1626          1.1  christos 	# asked through the control interface
   1627          1.1  christos 	pin="1234"
   1628          1.1  christos }
   1629          1.1  christos 
   1630          1.1  christos # Example configuration showing how to use an inlined blob as a CA certificate
   1631          1.1  christos # data instead of using external file
   1632          1.1  christos network={
   1633          1.1  christos 	ssid="example"
   1634          1.1  christos 	key_mgmt=WPA-EAP
   1635          1.1  christos 	eap=TTLS
   1636          1.1  christos 	identity="user (at] example.com"
   1637          1.1  christos 	anonymous_identity="anonymous (at] example.com"
   1638          1.1  christos 	password="foobar"
   1639          1.1  christos 	ca_cert="blob://exampleblob"
   1640          1.1  christos 	priority=20
   1641          1.1  christos }
   1642          1.1  christos 
   1643          1.1  christos blob-base64-exampleblob={
   1644          1.1  christos SGVsbG8gV29ybGQhCg==
   1645          1.1  christos }
   1646          1.1  christos 
   1647          1.1  christos 
   1648          1.1  christos # Wildcard match for SSID (plaintext APs only). This example select any
   1649          1.1  christos # open AP regardless of its SSID.
   1650          1.1  christos network={
   1651          1.1  christos 	key_mgmt=NONE
   1652          1.1  christos }
   1653  1.1.1.3.4.1       snj 
   1654  1.1.1.3.4.1       snj # Example configuration blacklisting two APs - these will be ignored
   1655  1.1.1.3.4.1       snj # for this network.
   1656  1.1.1.3.4.1       snj network={
   1657  1.1.1.3.4.1       snj 	ssid="example"
   1658  1.1.1.3.4.1       snj 	psk="very secret passphrase"
   1659  1.1.1.3.4.1       snj 	bssid_blacklist=02:11:22:33:44:55 02:22:aa:44:55:66
   1660  1.1.1.3.4.1       snj }
   1661  1.1.1.3.4.1       snj 
   1662  1.1.1.3.4.1       snj # Example configuration limiting AP selection to a specific set of APs;
   1663  1.1.1.3.4.1       snj # any other AP not matching the masked address will be ignored.
   1664  1.1.1.3.4.1       snj network={
   1665  1.1.1.3.4.1       snj 	ssid="example"
   1666  1.1.1.3.4.1       snj 	psk="very secret passphrase"
   1667  1.1.1.3.4.1       snj 	bssid_whitelist=02:55:ae:bc:00:00/ff:ff:ff:ff:00:00 00:00:77:66:55:44/00:00:ff:ff:ff:ff
   1668  1.1.1.3.4.1       snj }
   1669  1.1.1.3.4.1       snj 
   1670  1.1.1.3.4.1       snj # Example config file that will only scan on channel 36.
   1671  1.1.1.3.4.1       snj freq_list=5180
   1672  1.1.1.3.4.1       snj network={
   1673  1.1.1.3.4.1       snj 	key_mgmt=NONE
   1674  1.1.1.3.4.1       snj }
   1675  1.1.1.3.4.1       snj 
   1676  1.1.1.3.4.1       snj 
   1677  1.1.1.3.4.1       snj # Example MACsec configuration
   1678  1.1.1.3.4.1       snj #network={
   1679  1.1.1.3.4.1       snj #	key_mgmt=IEEE8021X
   1680  1.1.1.3.4.1       snj #	eap=TTLS
   1681  1.1.1.3.4.1       snj #	phase2="auth=PAP"
   1682  1.1.1.3.4.1       snj #	anonymous_identity="anonymous (at] example.com"
   1683  1.1.1.3.4.1       snj #	identity="user (at] example.com"
   1684  1.1.1.3.4.1       snj #	password="secretr"
   1685  1.1.1.3.4.1       snj #	ca_cert="/etc/cert/ca.pem"
   1686  1.1.1.3.4.1       snj #	eapol_flags=0
   1687  1.1.1.3.4.1       snj #	macsec_policy=1
   1688  1.1.1.3.4.1       snj #}
   1689