xref: /freebsd/contrib/wpa/hostapd/hostapd.conf (revision a90b9d0159070121c221b966469c3e36d912bf82)
139beb93cSSam Leffler##### hostapd configuration file ##############################################
239beb93cSSam Leffler# Empty lines and lines starting with # are ignored
339beb93cSSam Leffler
439beb93cSSam Leffler# AP netdevice name (without 'ap' postfix, i.e., wlan0 uses wlan0ap for
55b9c547cSRui Paulo# management frames with the Host AP driver); wlan0 with many nl80211 drivers
6780fb4a2SCy Schubert# Note: This attribute can be overridden by the values supplied with the '-i'
7780fb4a2SCy Schubert# command line parameter.
839beb93cSSam Lefflerinterface=wlan0
939beb93cSSam Leffler
105b9c547cSRui Paulo# In case of atheros and nl80211 driver interfaces, an additional
11e28a4053SRui Paulo# configuration parameter, bridge, may be used to notify hostapd if the
12e28a4053SRui Paulo# interface is included in a bridge. This parameter is not used with Host AP
13e28a4053SRui Paulo# driver. If the bridge parameter is not set, the drivers will automatically
14e28a4053SRui Paulo# figure out the bridge interface (assuming sysfs is enabled and mounted to
15e28a4053SRui Paulo# /sys) and this parameter may not be needed.
16e28a4053SRui Paulo#
17e28a4053SRui Paulo# For nl80211, this parameter can be used to request the AP interface to be
18e28a4053SRui Paulo# added to the bridge automatically (brctl may refuse to do this before hostapd
19e28a4053SRui Paulo# has been started to change the interface mode). If needed, the bridge
20e28a4053SRui Paulo# interface is also created.
2139beb93cSSam Leffler#bridge=br0
2239beb93cSSam Leffler
235b9c547cSRui Paulo# Driver interface type (hostap/wired/none/nl80211/bsd);
2439beb93cSSam Leffler# default: hostap). nl80211 is used with all Linux mac80211 drivers.
2539beb93cSSam Leffler# Use driver=none if building hostapd as a standalone RADIUS server that does
2639beb93cSSam Leffler# not control any wireless/wired driver.
2739beb93cSSam Leffler# driver=hostap
2839beb93cSSam Leffler
295b9c547cSRui Paulo# Driver interface parameters (mainly for development testing use)
305b9c547cSRui Paulo# driver_params=<params>
315b9c547cSRui Paulo
3239beb93cSSam Leffler# hostapd event logger configuration
3339beb93cSSam Leffler#
3439beb93cSSam Leffler# Two output method: syslog and stdout (only usable if not forking to
3539beb93cSSam Leffler# background).
3639beb93cSSam Leffler#
3739beb93cSSam Leffler# Module bitfield (ORed bitfield of modules that will be logged; -1 = all
3839beb93cSSam Leffler# modules):
3939beb93cSSam Leffler# bit 0 (1) = IEEE 802.11
4039beb93cSSam Leffler# bit 1 (2) = IEEE 802.1X
4139beb93cSSam Leffler# bit 2 (4) = RADIUS
4239beb93cSSam Leffler# bit 3 (8) = WPA
4339beb93cSSam Leffler# bit 4 (16) = driver interface
4439beb93cSSam Leffler# bit 6 (64) = MLME
4539beb93cSSam Leffler#
4639beb93cSSam Leffler# Levels (minimum value for logged events):
4739beb93cSSam Leffler#  0 = verbose debugging
4839beb93cSSam Leffler#  1 = debugging
4939beb93cSSam Leffler#  2 = informational messages
5039beb93cSSam Leffler#  3 = notification
5139beb93cSSam Leffler#  4 = warning
5239beb93cSSam Leffler#
5339beb93cSSam Lefflerlogger_syslog=-1
5439beb93cSSam Lefflerlogger_syslog_level=2
5539beb93cSSam Lefflerlogger_stdout=-1
5639beb93cSSam Lefflerlogger_stdout_level=2
5739beb93cSSam Leffler
5839beb93cSSam Leffler# Interface for separate control program. If this is specified, hostapd
5939beb93cSSam Leffler# will create this directory and a UNIX domain socket for listening to requests
6039beb93cSSam Leffler# from external programs (CLI/GUI, etc.) for status information and
6139beb93cSSam Leffler# configuration. The socket file will be named based on the interface name, so
6239beb93cSSam Leffler# multiple hostapd processes/interfaces can be run at the same time if more
6339beb93cSSam Leffler# than one interface is used.
6439beb93cSSam Leffler# /var/run/hostapd is the recommended directory for sockets and by default,
6539beb93cSSam Leffler# hostapd_cli will use it when trying to connect with hostapd.
6639beb93cSSam Lefflerctrl_interface=/var/run/hostapd
6739beb93cSSam Leffler
6839beb93cSSam Leffler# Access control for the control interface can be configured by setting the
6939beb93cSSam Leffler# directory to allow only members of a group to use sockets. This way, it is
7039beb93cSSam Leffler# possible to run hostapd as root (since it needs to change network
7139beb93cSSam Leffler# configuration and open raw sockets) and still allow GUI/CLI components to be
7239beb93cSSam Leffler# run as non-root users. However, since the control interface can be used to
7339beb93cSSam Leffler# change the network configuration, this access needs to be protected in many
7439beb93cSSam Leffler# cases. By default, hostapd is configured to use gid 0 (root). If you
75c1d255d3SCy Schubert# want to allow non-root users to use the control interface, add a new group
7639beb93cSSam Leffler# and change this value to match with that group. Add users that should have
7739beb93cSSam Leffler# control interface access to this group.
7839beb93cSSam Leffler#
7939beb93cSSam Leffler# This variable can be a group name or gid.
8039beb93cSSam Leffler#ctrl_interface_group=wheel
8139beb93cSSam Lefflerctrl_interface_group=0
8239beb93cSSam Leffler
8339beb93cSSam Leffler
8439beb93cSSam Leffler##### IEEE 802.11 related configuration #######################################
8539beb93cSSam Leffler
8639beb93cSSam Leffler# SSID to be used in IEEE 802.11 management frames
8739beb93cSSam Lefflerssid=test
88f05cddf9SRui Paulo# Alternative formats for configuring SSID
89f05cddf9SRui Paulo# (double quoted string, hexdump, printf-escaped string)
90f05cddf9SRui Paulo#ssid2="test"
91f05cddf9SRui Paulo#ssid2=74657374
92f05cddf9SRui Paulo#ssid2=P"hello\nthere"
93f05cddf9SRui Paulo
94f05cddf9SRui Paulo# UTF-8 SSID: Whether the SSID is to be interpreted using UTF-8 encoding
95f05cddf9SRui Paulo#utf8_ssid=1
9639beb93cSSam Leffler
9739beb93cSSam Leffler# Country code (ISO/IEC 3166-1). Used to set regulatory domain.
9839beb93cSSam Leffler# Set as needed to indicate country in which device is operating.
9939beb93cSSam Leffler# This can limit available channels and transmit power.
10085732ac8SCy Schubert# These two octets are used as the first two octets of the Country String
10185732ac8SCy Schubert# (dot11CountryString)
10239beb93cSSam Leffler#country_code=US
10339beb93cSSam Leffler
10485732ac8SCy Schubert# The third octet of the Country String (dot11CountryString)
10585732ac8SCy Schubert# This parameter is used to set the third octet of the country string.
10685732ac8SCy Schubert#
10785732ac8SCy Schubert# All environments of the current frequency band and country (default)
10885732ac8SCy Schubert#country3=0x20
10985732ac8SCy Schubert# Outdoor environment only
11085732ac8SCy Schubert#country3=0x4f
11185732ac8SCy Schubert# Indoor environment only
11285732ac8SCy Schubert#country3=0x49
11385732ac8SCy Schubert# Noncountry entity (country_code=XX)
11485732ac8SCy Schubert#country3=0x58
11585732ac8SCy Schubert# IEEE 802.11 standard Annex E table indication: 0x01 .. 0x1f
11685732ac8SCy Schubert# Annex E, Table E-4 (Global operating classes)
11785732ac8SCy Schubert#country3=0x04
11885732ac8SCy Schubert
11939beb93cSSam Leffler# Enable IEEE 802.11d. This advertises the country_code and the set of allowed
12039beb93cSSam Leffler# channels and transmit power levels based on the regulatory limits. The
12139beb93cSSam Leffler# country_code setting must be configured with the correct country for
12239beb93cSSam Leffler# IEEE 802.11d functions.
12339beb93cSSam Leffler# (default: 0 = disabled)
12439beb93cSSam Leffler#ieee80211d=1
12539beb93cSSam Leffler
1265b9c547cSRui Paulo# Enable IEEE 802.11h. This enables radar detection and DFS support if
1275b9c547cSRui Paulo# available. DFS support is required on outdoor 5 GHz channels in most countries
1285b9c547cSRui Paulo# of the world. This can be used only with ieee80211d=1.
1295b9c547cSRui Paulo# (default: 0 = disabled)
1305b9c547cSRui Paulo#ieee80211h=1
1315b9c547cSRui Paulo
1325b9c547cSRui Paulo# Add Power Constraint element to Beacon and Probe Response frames
1335b9c547cSRui Paulo# This config option adds Power Constraint element when applicable and Country
1345b9c547cSRui Paulo# element is added. Power Constraint element is required by Transmit Power
1355b9c547cSRui Paulo# Control. This can be used only with ieee80211d=1.
1365b9c547cSRui Paulo# Valid values are 0..255.
1375b9c547cSRui Paulo#local_pwr_constraint=3
1385b9c547cSRui Paulo
1395b9c547cSRui Paulo# Set Spectrum Management subfield in the Capability Information field.
1405b9c547cSRui Paulo# This config option forces the Spectrum Management bit to be set. When this
1415b9c547cSRui Paulo# option is not set, the value of the Spectrum Management bit depends on whether
1425b9c547cSRui Paulo# DFS or TPC is required by regulatory authorities. This can be used only with
1435b9c547cSRui Paulo# ieee80211d=1 and local_pwr_constraint configured.
1445b9c547cSRui Paulo#spectrum_mgmt_required=1
1455b9c547cSRui Paulo
146780fb4a2SCy Schubert# Operation mode (a = IEEE 802.11a (5 GHz), b = IEEE 802.11b (2.4 GHz),
147780fb4a2SCy Schubert# g = IEEE 802.11g (2.4 GHz), ad = IEEE 802.11ad (60 GHz); a/g options are used
148780fb4a2SCy Schubert# with IEEE 802.11n (HT), too, to specify band). For IEEE 802.11ac (VHT), this
149c1d255d3SCy Schubert# needs to be set to hw_mode=a. For IEEE 802.11ax (HE) on 6 GHz this needs
150c1d255d3SCy Schubert# to be set to hw_mode=a. When using ACS (see channel parameter), a
151780fb4a2SCy Schubert# special value "any" can be used to indicate that any support band can be used.
152780fb4a2SCy Schubert# This special case is currently supported only with drivers with which
153780fb4a2SCy Schubert# offloaded ACS is used.
15439beb93cSSam Leffler# Default: IEEE 802.11b
155f05cddf9SRui Paulohw_mode=g
15639beb93cSSam Leffler
15739beb93cSSam Leffler# Channel number (IEEE 802.11)
15839beb93cSSam Leffler# (default: 0, i.e., not set)
159f05cddf9SRui Paulo# Please note that some drivers do not use this value from hostapd and the
160f05cddf9SRui Paulo# channel will need to be configured separately with iwconfig.
1615b9c547cSRui Paulo#
1625b9c547cSRui Paulo# If CONFIG_ACS build option is enabled, the channel can be selected
1635b9c547cSRui Paulo# automatically at run time by setting channel=acs_survey or channel=0, both of
1645b9c547cSRui Paulo# which will enable the ACS survey based algorithm.
165f05cddf9SRui Paulochannel=1
16639beb93cSSam Leffler
167c1d255d3SCy Schubert# Global operating class (IEEE 802.11, Annex E, Table E-4)
168c1d255d3SCy Schubert# This option allows hostapd to specify the operating class of the channel
169c1d255d3SCy Schubert# configured with the channel parameter. channel and op_class together can
170c1d255d3SCy Schubert# uniquely identify channels across different bands, including the 6 GHz band.
171c1d255d3SCy Schubert#op_class=131
172c1d255d3SCy Schubert
1735b9c547cSRui Paulo# ACS tuning - Automatic Channel Selection
174c1d255d3SCy Schubert# See: https://wireless.wiki.kernel.org/en/users/documentation/acs
1755b9c547cSRui Paulo#
1765b9c547cSRui Paulo# You can customize the ACS survey algorithm with following variables:
1775b9c547cSRui Paulo#
1785b9c547cSRui Paulo# acs_num_scans requirement is 1..100 - number of scans to be performed that
1795b9c547cSRui Paulo# are used to trigger survey data gathering of an underlying device driver.
1805b9c547cSRui Paulo# Scans are passive and typically take a little over 100ms (depending on the
1815b9c547cSRui Paulo# driver) on each available channel for given hw_mode. Increasing this value
1825b9c547cSRui Paulo# means sacrificing startup time and gathering more data wrt channel
1835b9c547cSRui Paulo# interference that may help choosing a better channel. This can also help fine
1845b9c547cSRui Paulo# tune the ACS scan time in case a driver has different scan dwell times.
1855b9c547cSRui Paulo#
1865b9c547cSRui Paulo# acs_chan_bias is a space-separated list of <channel>:<bias> pairs. It can be
1875b9c547cSRui Paulo# used to increase (or decrease) the likelihood of a specific channel to be
1885b9c547cSRui Paulo# selected by the ACS algorithm. The total interference factor for each channel
1895b9c547cSRui Paulo# gets multiplied by the specified bias value before finding the channel with
1905b9c547cSRui Paulo# the lowest value. In other words, values between 0.0 and 1.0 can be used to
1915b9c547cSRui Paulo# make a channel more likely to be picked while values larger than 1.0 make the
1925b9c547cSRui Paulo# specified channel less likely to be picked. This can be used, e.g., to prefer
1935b9c547cSRui Paulo# the commonly used 2.4 GHz band channels 1, 6, and 11 (which is the default
1945b9c547cSRui Paulo# behavior on 2.4 GHz band if no acs_chan_bias parameter is specified).
1955b9c547cSRui Paulo#
1965b9c547cSRui Paulo# Defaults:
1975b9c547cSRui Paulo#acs_num_scans=5
1985b9c547cSRui Paulo#acs_chan_bias=1:0.8 6:0.8 11:0.8
1995b9c547cSRui Paulo
2005b9c547cSRui Paulo# Channel list restriction. This option allows hostapd to select one of the
2015b9c547cSRui Paulo# provided channels when a channel should be automatically selected.
202325151a3SRui Paulo# Channel list can be provided as range using hyphen ('-') or individual
203780fb4a2SCy Schubert# channels can be specified by space (' ') separated values
204325151a3SRui Paulo# Default: all channels allowed in selected hw_mode
2055b9c547cSRui Paulo#chanlist=100 104 108 112 116
206325151a3SRui Paulo#chanlist=1 6 11-13
2075b9c547cSRui Paulo
208c1d255d3SCy Schubert# Frequency list restriction. This option allows hostapd to select one of the
209c1d255d3SCy Schubert# provided frequencies when a frequency should be automatically selected.
210c1d255d3SCy Schubert# Frequency list can be provided as range using hyphen ('-') or individual
211c1d255d3SCy Schubert# frequencies can be specified by comma (',') separated values
212c1d255d3SCy Schubert# Default: all frequencies allowed in selected hw_mode
213c1d255d3SCy Schubert#freqlist=2437,5955,5975
214c1d255d3SCy Schubert#freqlist=2437,5985-6105
215c1d255d3SCy Schubert
21685732ac8SCy Schubert# Exclude DFS channels from ACS
21785732ac8SCy Schubert# This option can be used to exclude all DFS channels from the ACS channel list
21885732ac8SCy Schubert# in cases where the driver supports DFS channels.
21985732ac8SCy Schubert#acs_exclude_dfs=1
22085732ac8SCy Schubert
221c1d255d3SCy Schubert# Include only preferred scan channels from 6 GHz band for ACS
222c1d255d3SCy Schubert# This option can be used to include only preferred scan channels in the 6 GHz
223c1d255d3SCy Schubert# band. This can be useful in particular for devices that operate only a 6 GHz
224c1d255d3SCy Schubert# BSS without a collocated 2.4/5 GHz BSS.
225c1d255d3SCy Schubert# Default behavior is to include all PSC and non-PSC channels.
226c1d255d3SCy Schubert#acs_exclude_6ghz_non_psc=1
227c1d255d3SCy Schubert
228*a90b9d01SCy Schubert# Enable background radar feature
229*a90b9d01SCy Schubert# This feature allows CAC to be run on dedicated radio RF chains while the
230*a90b9d01SCy Schubert# radio(s) are otherwise running normal AP activities on other channels.
231*a90b9d01SCy Schubert# This requires that the driver and the radio support it before feature will
232*a90b9d01SCy Schubert# actually be enabled, i.e., this parameter value is ignored with drivers that
233*a90b9d01SCy Schubert# do not advertise support for the capability.
234*a90b9d01SCy Schubert# 0: Leave disabled (default)
235*a90b9d01SCy Schubert# 1: Enable it.
236*a90b9d01SCy Schubert#enable_background_radar=1
237*a90b9d01SCy Schubert
23832a95656SCy Schubert# Set minimum permitted max TX power (in dBm) for ACS and DFS channel selection.
23932a95656SCy Schubert# (default 0, i.e., not constraint)
24032a95656SCy Schubert#min_tx_power=20
24132a95656SCy Schubert
24239beb93cSSam Leffler# Beacon interval in kus (1.024 ms) (default: 100; range 15..65535)
24339beb93cSSam Lefflerbeacon_int=100
24439beb93cSSam Leffler
245f05cddf9SRui Paulo# DTIM (delivery traffic information message) period (range 1..255):
24639beb93cSSam Leffler# number of beacons between DTIMs (1 = every beacon includes DTIM element)
24739beb93cSSam Leffler# (default: 2)
24839beb93cSSam Lefflerdtim_period=2
24939beb93cSSam Leffler
25039beb93cSSam Leffler# Maximum number of stations allowed in station table. New stations will be
25139beb93cSSam Leffler# rejected after the station table is full. IEEE 802.11 has a limit of 2007
25239beb93cSSam Leffler# different association IDs, so this number should not be larger than that.
25339beb93cSSam Leffler# (default: 2007)
25439beb93cSSam Lefflermax_num_sta=255
25539beb93cSSam Leffler
256780fb4a2SCy Schubert# RTS/CTS threshold; -1 = disabled (default); range -1..65535
25739beb93cSSam Leffler# If this field is not included in hostapd.conf, hostapd will not control
25839beb93cSSam Leffler# RTS threshold and 'iwconfig wlan# rts <val>' can be used to set it.
259780fb4a2SCy Schubertrts_threshold=-1
26039beb93cSSam Leffler
261780fb4a2SCy Schubert# Fragmentation threshold; -1 = disabled (default); range -1, 256..2346
26239beb93cSSam Leffler# If this field is not included in hostapd.conf, hostapd will not control
26339beb93cSSam Leffler# fragmentation threshold and 'iwconfig wlan# frag <val>' can be used to set
26439beb93cSSam Leffler# it.
265780fb4a2SCy Schubertfragm_threshold=-1
26639beb93cSSam Leffler
26739beb93cSSam Leffler# Rate configuration
26839beb93cSSam Leffler# Default is to enable all rates supported by the hardware. This configuration
26939beb93cSSam Leffler# item allows this list be filtered so that only the listed rates will be left
27039beb93cSSam Leffler# in the list. If the list is empty, all rates are used. This list can have
27139beb93cSSam Leffler# entries that are not in the list of rates the hardware supports (such entries
27239beb93cSSam Leffler# are ignored). The entries in this list are in 100 kbps, i.e., 11 Mbps = 110.
27339beb93cSSam Leffler# If this item is present, at least one rate have to be matching with the rates
27439beb93cSSam Leffler# hardware supports.
27539beb93cSSam Leffler# default: use the most common supported rate setting for the selected
27639beb93cSSam Leffler# hw_mode (i.e., this line can be removed from configuration file in most
27739beb93cSSam Leffler# cases)
27839beb93cSSam Leffler#supported_rates=10 20 55 110 60 90 120 180 240 360 480 540
27939beb93cSSam Leffler
28039beb93cSSam Leffler# Basic rate set configuration
28139beb93cSSam Leffler# List of rates (in 100 kbps) that are included in the basic rate set.
28239beb93cSSam Leffler# If this item is not included, usually reasonable default set is used.
28339beb93cSSam Leffler#basic_rates=10 20
28439beb93cSSam Leffler#basic_rates=10 20 55 110
28539beb93cSSam Leffler#basic_rates=60 120 240
28639beb93cSSam Leffler
28785732ac8SCy Schubert# Beacon frame TX rate configuration
28885732ac8SCy Schubert# This sets the TX rate that is used to transmit Beacon frames. If this item is
28985732ac8SCy Schubert# not included, the driver default rate (likely lowest rate) is used.
29085732ac8SCy Schubert# Legacy (CCK/OFDM rates):
29185732ac8SCy Schubert#    beacon_rate=<legacy rate in 100 kbps>
29285732ac8SCy Schubert# HT:
29385732ac8SCy Schubert#    beacon_rate=ht:<HT MCS>
29485732ac8SCy Schubert# VHT:
29585732ac8SCy Schubert#    beacon_rate=vht:<VHT MCS>
296c1d255d3SCy Schubert# HE:
297c1d255d3SCy Schubert#    beacon_rate=he:<HE MCS>
29885732ac8SCy Schubert#
29985732ac8SCy Schubert# For example, beacon_rate=10 for 1 Mbps or beacon_rate=60 for 6 Mbps (OFDM).
30085732ac8SCy Schubert#beacon_rate=10
30185732ac8SCy Schubert
30239beb93cSSam Leffler# Short Preamble
30339beb93cSSam Leffler# This parameter can be used to enable optional use of short preamble for
30439beb93cSSam Leffler# frames sent at 2 Mbps, 5.5 Mbps, and 11 Mbps to improve network performance.
30539beb93cSSam Leffler# This applies only to IEEE 802.11b-compatible networks and this should only be
30639beb93cSSam Leffler# enabled if the local hardware supports use of short preamble. If any of the
30739beb93cSSam Leffler# associated STAs do not support short preamble, use of short preamble will be
30839beb93cSSam Leffler# disabled (and enabled when such STAs disassociate) dynamically.
30939beb93cSSam Leffler# 0 = do not allow use of short preamble (default)
31039beb93cSSam Leffler# 1 = allow use of short preamble
31139beb93cSSam Leffler#preamble=1
31239beb93cSSam Leffler
31339beb93cSSam Leffler# Station MAC address -based authentication
31439beb93cSSam Leffler# Please note that this kind of access control requires a driver that uses
31539beb93cSSam Leffler# hostapd to take care of management frame processing and as such, this can be
3165b9c547cSRui Paulo# used with driver=hostap or driver=nl80211, but not with driver=atheros.
31739beb93cSSam Leffler# 0 = accept unless in deny list
31839beb93cSSam Leffler# 1 = deny unless in accept list
31939beb93cSSam Leffler# 2 = use external RADIUS server (accept/deny lists are searched first)
32039beb93cSSam Lefflermacaddr_acl=0
32139beb93cSSam Leffler
32239beb93cSSam Leffler# Accept/deny lists are read from separate files (containing list of
32339beb93cSSam Leffler# MAC addresses, one per line). Use absolute path name to make sure that the
32439beb93cSSam Leffler# files can be read on SIGHUP configuration reloads.
32539beb93cSSam Leffler#accept_mac_file=/etc/hostapd.accept
32639beb93cSSam Leffler#deny_mac_file=/etc/hostapd.deny
32739beb93cSSam Leffler
32839beb93cSSam Leffler# IEEE 802.11 specifies two authentication algorithms. hostapd can be
32939beb93cSSam Leffler# configured to allow both of these or only one. Open system authentication
33039beb93cSSam Leffler# should be used with IEEE 802.1X.
33139beb93cSSam Leffler# Bit fields of allowed authentication algorithms:
33239beb93cSSam Leffler# bit 0 = Open System Authentication
33339beb93cSSam Leffler# bit 1 = Shared Key Authentication (requires WEP)
33439beb93cSSam Lefflerauth_algs=3
33539beb93cSSam Leffler
33639beb93cSSam Leffler# Send empty SSID in beacons and ignore probe request frames that do not
33739beb93cSSam Leffler# specify full SSID, i.e., require stations to know SSID.
33839beb93cSSam Leffler# default: disabled (0)
33939beb93cSSam Leffler# 1 = send empty (length=0) SSID in beacon and ignore probe request for
34039beb93cSSam Leffler#     broadcast SSID
34139beb93cSSam Leffler# 2 = clear SSID (ASCII 0), but keep the original length (this may be required
34239beb93cSSam Leffler#     with some clients that do not support empty SSID) and ignore probe
34339beb93cSSam Leffler#     requests for broadcast SSID
34439beb93cSSam Lefflerignore_broadcast_ssid=0
34539beb93cSSam Leffler
346780fb4a2SCy Schubert# Do not reply to broadcast Probe Request frames from unassociated STA if there
347780fb4a2SCy Schubert# is no room for additional stations (max_num_sta). This can be used to
348780fb4a2SCy Schubert# discourage a STA from trying to associate with this AP if the association
349780fb4a2SCy Schubert# would be rejected due to maximum STA limit.
350780fb4a2SCy Schubert# Default: 0 (disabled)
351780fb4a2SCy Schubert#no_probe_resp_if_max_sta=0
352780fb4a2SCy Schubert
353780fb4a2SCy Schubert# Additional vendor specific elements for Beacon and Probe Response frames
354f05cddf9SRui Paulo# This parameter can be used to add additional vendor specific element(s) into
355f05cddf9SRui Paulo# the end of the Beacon and Probe Response frames. The format for these
356f05cddf9SRui Paulo# element(s) is a hexdump of the raw information elements (id+len+payload for
357f05cddf9SRui Paulo# one or more elements)
358f05cddf9SRui Paulo#vendor_elements=dd0411223301
359f05cddf9SRui Paulo
360780fb4a2SCy Schubert# Additional vendor specific elements for (Re)Association Response frames
361780fb4a2SCy Schubert# This parameter can be used to add additional vendor specific element(s) into
362780fb4a2SCy Schubert# the end of the (Re)Association Response frames. The format for these
363780fb4a2SCy Schubert# element(s) is a hexdump of the raw information elements (id+len+payload for
364780fb4a2SCy Schubert# one or more elements)
365780fb4a2SCy Schubert#assocresp_elements=dd0411223301
366780fb4a2SCy Schubert
36739beb93cSSam Leffler# TX queue parameters (EDCF / bursting)
36839beb93cSSam Leffler# tx_queue_<queue name>_<param>
36985732ac8SCy Schubert# queues: data0, data1, data2, data3
37039beb93cSSam Leffler#		(data0 is the highest priority queue)
37139beb93cSSam Leffler# parameters:
37239beb93cSSam Leffler#   aifs: AIFS (default 2)
373325151a3SRui Paulo#   cwmin: cwMin (1, 3, 7, 15, 31, 63, 127, 255, 511, 1023, 2047, 4095, 8191,
374325151a3SRui Paulo#	   16383, 32767)
375325151a3SRui Paulo#   cwmax: cwMax (same values as cwMin, cwMax >= cwMin)
37639beb93cSSam Leffler#   burst: maximum length (in milliseconds with precision of up to 0.1 ms) for
37739beb93cSSam Leffler#          bursting
37839beb93cSSam Leffler#
37939beb93cSSam Leffler# Default WMM parameters (IEEE 802.11 draft; 11-03-0504-03-000e):
38039beb93cSSam Leffler# These parameters are used by the access point when transmitting frames
38139beb93cSSam Leffler# to the clients.
38239beb93cSSam Leffler#
38339beb93cSSam Leffler# Low priority / AC_BK = background
38439beb93cSSam Leffler#tx_queue_data3_aifs=7
38539beb93cSSam Leffler#tx_queue_data3_cwmin=15
38639beb93cSSam Leffler#tx_queue_data3_cwmax=1023
38739beb93cSSam Leffler#tx_queue_data3_burst=0
38839beb93cSSam Leffler# Note: for IEEE 802.11b mode: cWmin=31 cWmax=1023 burst=0
38939beb93cSSam Leffler#
39039beb93cSSam Leffler# Normal priority / AC_BE = best effort
39139beb93cSSam Leffler#tx_queue_data2_aifs=3
39239beb93cSSam Leffler#tx_queue_data2_cwmin=15
39339beb93cSSam Leffler#tx_queue_data2_cwmax=63
39439beb93cSSam Leffler#tx_queue_data2_burst=0
39539beb93cSSam Leffler# Note: for IEEE 802.11b mode: cWmin=31 cWmax=127 burst=0
39639beb93cSSam Leffler#
39739beb93cSSam Leffler# High priority / AC_VI = video
39839beb93cSSam Leffler#tx_queue_data1_aifs=1
39939beb93cSSam Leffler#tx_queue_data1_cwmin=7
40039beb93cSSam Leffler#tx_queue_data1_cwmax=15
40139beb93cSSam Leffler#tx_queue_data1_burst=3.0
40239beb93cSSam Leffler# Note: for IEEE 802.11b mode: cWmin=15 cWmax=31 burst=6.0
40339beb93cSSam Leffler#
40439beb93cSSam Leffler# Highest priority / AC_VO = voice
40539beb93cSSam Leffler#tx_queue_data0_aifs=1
40639beb93cSSam Leffler#tx_queue_data0_cwmin=3
40739beb93cSSam Leffler#tx_queue_data0_cwmax=7
40839beb93cSSam Leffler#tx_queue_data0_burst=1.5
40939beb93cSSam Leffler# Note: for IEEE 802.11b mode: cWmin=7 cWmax=15 burst=3.3
41039beb93cSSam Leffler
4113157ba21SRui Paulo# 802.1D Tag (= UP) to AC mappings
41239beb93cSSam Leffler# WMM specifies following mapping of data frames to different ACs. This mapping
41339beb93cSSam Leffler# can be configured using Linux QoS/tc and sch_pktpri.o module.
41439beb93cSSam Leffler# 802.1D Tag	802.1D Designation	Access Category	WMM Designation
41539beb93cSSam Leffler# 1		BK			AC_BK		Background
41639beb93cSSam Leffler# 2		-			AC_BK		Background
41739beb93cSSam Leffler# 0		BE			AC_BE		Best Effort
4183157ba21SRui Paulo# 3		EE			AC_BE		Best Effort
41939beb93cSSam Leffler# 4		CL			AC_VI		Video
42039beb93cSSam Leffler# 5		VI			AC_VI		Video
42139beb93cSSam Leffler# 6		VO			AC_VO		Voice
42239beb93cSSam Leffler# 7		NC			AC_VO		Voice
42339beb93cSSam Leffler# Data frames with no priority information: AC_BE
42439beb93cSSam Leffler# Management frames: AC_VO
42539beb93cSSam Leffler# PS-Poll frames: AC_BE
42639beb93cSSam Leffler
42739beb93cSSam Leffler# Default WMM parameters (IEEE 802.11 draft; 11-03-0504-03-000e):
42839beb93cSSam Leffler# for 802.11a or 802.11g networks
42939beb93cSSam Leffler# These parameters are sent to WMM clients when they associate.
43039beb93cSSam Leffler# The parameters will be used by WMM clients for frames transmitted to the
43139beb93cSSam Leffler# access point.
43239beb93cSSam Leffler#
43339beb93cSSam Leffler# note - txop_limit is in units of 32microseconds
43439beb93cSSam Leffler# note - acm is admission control mandatory flag. 0 = admission control not
43539beb93cSSam Leffler# required, 1 = mandatory
436325151a3SRui Paulo# note - Here cwMin and cmMax are in exponent form. The actual cw value used
437325151a3SRui Paulo# will be (2^n)-1 where n is the value given here. The allowed range for these
438325151a3SRui Paulo# wmm_ac_??_{cwmin,cwmax} is 0..15 with cwmax >= cwmin.
43939beb93cSSam Leffler#
4403157ba21SRui Paulowmm_enabled=1
44139beb93cSSam Leffler#
442e28a4053SRui Paulo# WMM-PS Unscheduled Automatic Power Save Delivery [U-APSD]
443e28a4053SRui Paulo# Enable this flag if U-APSD supported outside hostapd (eg., Firmware/driver)
444e28a4053SRui Paulo#uapsd_advertisement_enabled=1
445e28a4053SRui Paulo#
44639beb93cSSam Leffler# Low priority / AC_BK = background
4473157ba21SRui Paulowmm_ac_bk_cwmin=4
4483157ba21SRui Paulowmm_ac_bk_cwmax=10
4493157ba21SRui Paulowmm_ac_bk_aifs=7
4503157ba21SRui Paulowmm_ac_bk_txop_limit=0
4513157ba21SRui Paulowmm_ac_bk_acm=0
45239beb93cSSam Leffler# Note: for IEEE 802.11b mode: cWmin=5 cWmax=10
45339beb93cSSam Leffler#
45439beb93cSSam Leffler# Normal priority / AC_BE = best effort
4553157ba21SRui Paulowmm_ac_be_aifs=3
4563157ba21SRui Paulowmm_ac_be_cwmin=4
4573157ba21SRui Paulowmm_ac_be_cwmax=10
4583157ba21SRui Paulowmm_ac_be_txop_limit=0
4593157ba21SRui Paulowmm_ac_be_acm=0
46039beb93cSSam Leffler# Note: for IEEE 802.11b mode: cWmin=5 cWmax=7
46139beb93cSSam Leffler#
46239beb93cSSam Leffler# High priority / AC_VI = video
4633157ba21SRui Paulowmm_ac_vi_aifs=2
4643157ba21SRui Paulowmm_ac_vi_cwmin=3
4653157ba21SRui Paulowmm_ac_vi_cwmax=4
4663157ba21SRui Paulowmm_ac_vi_txop_limit=94
4673157ba21SRui Paulowmm_ac_vi_acm=0
46839beb93cSSam Leffler# Note: for IEEE 802.11b mode: cWmin=4 cWmax=5 txop_limit=188
46939beb93cSSam Leffler#
47039beb93cSSam Leffler# Highest priority / AC_VO = voice
4713157ba21SRui Paulowmm_ac_vo_aifs=2
4723157ba21SRui Paulowmm_ac_vo_cwmin=2
4733157ba21SRui Paulowmm_ac_vo_cwmax=3
4743157ba21SRui Paulowmm_ac_vo_txop_limit=47
4753157ba21SRui Paulowmm_ac_vo_acm=0
47639beb93cSSam Leffler# Note: for IEEE 802.11b mode: cWmin=3 cWmax=4 burst=102
47739beb93cSSam Leffler
4784bc52338SCy Schubert# Enable Multi-AP functionality
4794bc52338SCy Schubert# 0 = disabled (default)
4804bc52338SCy Schubert# 1 = AP support backhaul BSS
4814bc52338SCy Schubert# 2 = AP support fronthaul BSS
4824bc52338SCy Schubert# 3 = AP supports both backhaul BSS and fronthaul BSS
4834bc52338SCy Schubert#multi_ap=0
4844bc52338SCy Schubert
48539beb93cSSam Leffler# Static WEP key configuration
48639beb93cSSam Leffler#
48739beb93cSSam Leffler# The key number to use when transmitting.
48839beb93cSSam Leffler# It must be between 0 and 3, and the corresponding key must be set.
48939beb93cSSam Leffler# default: not set
49039beb93cSSam Leffler#wep_default_key=0
49139beb93cSSam Leffler# The WEP keys to use.
49239beb93cSSam Leffler# A key may be a quoted string or unquoted hexadecimal digits.
49339beb93cSSam Leffler# The key length should be 5, 13, or 16 characters, or 10, 26, or 32
49439beb93cSSam Leffler# digits, depending on whether 40-bit (64-bit), 104-bit (128-bit), or
49539beb93cSSam Leffler# 128-bit (152-bit) WEP is used.
49639beb93cSSam Leffler# Only the default key must be supplied; the others are optional.
49739beb93cSSam Leffler# default: not set
49839beb93cSSam Leffler#wep_key0=123456789a
49939beb93cSSam Leffler#wep_key1="vwxyz"
50039beb93cSSam Leffler#wep_key2=0102030405060708090a0b0c0d
50139beb93cSSam Leffler#wep_key3=".2.4.6.8.0.23"
50239beb93cSSam Leffler
50339beb93cSSam Leffler# Station inactivity limit
50439beb93cSSam Leffler#
50539beb93cSSam Leffler# If a station does not send anything in ap_max_inactivity seconds, an
50639beb93cSSam Leffler# empty data frame is sent to it in order to verify whether it is
50739beb93cSSam Leffler# still in range. If this frame is not ACKed, the station will be
50839beb93cSSam Leffler# disassociated and then deauthenticated. This feature is used to
50939beb93cSSam Leffler# clear station table of old entries when the STAs move out of the
51039beb93cSSam Leffler# range.
51139beb93cSSam Leffler#
51239beb93cSSam Leffler# The station can associate again with the AP if it is still in range;
51339beb93cSSam Leffler# this inactivity poll is just used as a nicer way of verifying
51439beb93cSSam Leffler# inactivity; i.e., client will not report broken connection because
51539beb93cSSam Leffler# disassociation frame is not sent immediately without first polling
51639beb93cSSam Leffler# the STA with a data frame.
51739beb93cSSam Leffler# default: 300 (i.e., 5 minutes)
51839beb93cSSam Leffler#ap_max_inactivity=300
519f05cddf9SRui Paulo#
520f05cddf9SRui Paulo# The inactivity polling can be disabled to disconnect stations based on
521f05cddf9SRui Paulo# inactivity timeout so that idle stations are more likely to be disconnected
522f05cddf9SRui Paulo# even if they are still in range of the AP. This can be done by setting
523f05cddf9SRui Paulo# skip_inactivity_poll to 1 (default 0).
524f05cddf9SRui Paulo#skip_inactivity_poll=0
525*a90b9d01SCy Schubert#
526*a90b9d01SCy Schubert# BSS max idle period management
527*a90b9d01SCy Schubert# 0 = disabled (do not advertise and manage BSS max idle period)
528*a90b9d01SCy Schubert# 1 = enabled (advertise and manage BSS max idle period; default)
529*a90b9d01SCy Schubert# 2 = enabled requiring protected frames (advertise and manage BSS max idle
530*a90b9d01SCy Schubert#     period and require STAs to use protected keep-alive frames)
531*a90b9d01SCy Schubert#bss_max_idle=1
532*a90b9d01SCy Schubert#
533*a90b9d01SCy Schubert# Maximum acceptable BSS maximum idle period
534*a90b9d01SCy Schubert# If this is set to a nonzero value, the AP allows STAs to request different
535*a90b9d01SCy Schubert# maximum idle period values. This is in the units to 1000 TUs (1.024 s)
536*a90b9d01SCy Schubert#max_acceptable_idle_period=600
537*a90b9d01SCy Schubert#
538*a90b9d01SCy Schubert# Allow STA to skip group key handshake without getting disconnection when
539*a90b9d01SCy Schubert# BSS max idle period management is enabled.
540*a90b9d01SCy Schubert# 0 = disconnect STA if it does not reply to group key handshake (default)
541*a90b9d01SCy Schubert# 1 = do not disconnect STA if it does not reply to group key handshake and
542*a90b9d01SCy Schubert#     if BSS max idle period management is enabled
543*a90b9d01SCy Schubert#no_disconnect_on_group_keyerror=0
544f05cddf9SRui Paulo
545f05cddf9SRui Paulo# Disassociate stations based on excessive transmission failures or other
546f05cddf9SRui Paulo# indications of connection loss. This depends on the driver capabilities and
547f05cddf9SRui Paulo# may not be available with all drivers.
548f05cddf9SRui Paulo#disassoc_low_ack=1
54939beb93cSSam Leffler
55039beb93cSSam Leffler# Maximum allowed Listen Interval (how many Beacon periods STAs are allowed to
55139beb93cSSam Leffler# remain asleep). Default: 65535 (no limit apart from field size)
55239beb93cSSam Leffler#max_listen_interval=100
55339beb93cSSam Leffler
554e28a4053SRui Paulo# WDS (4-address frame) mode with per-station virtual interfaces
555e28a4053SRui Paulo# (only supported with driver=nl80211)
556e28a4053SRui Paulo# This mode allows associated stations to use 4-address frames to allow layer 2
557e28a4053SRui Paulo# bridging to be used.
558e28a4053SRui Paulo#wds_sta=1
559e28a4053SRui Paulo
560f05cddf9SRui Paulo# If bridge parameter is set, the WDS STA interface will be added to the same
561f05cddf9SRui Paulo# bridge by default. This can be overridden with the wds_bridge parameter to
562f05cddf9SRui Paulo# use a separate bridge.
563f05cddf9SRui Paulo#wds_bridge=wds-br0
564f05cddf9SRui Paulo
5655b9c547cSRui Paulo# Start the AP with beaconing disabled by default.
5665b9c547cSRui Paulo#start_disabled=0
5675b9c547cSRui Paulo
568f05cddf9SRui Paulo# Client isolation can be used to prevent low-level bridging of frames between
569f05cddf9SRui Paulo# associated stations in the BSS. By default, this bridging is allowed.
570f05cddf9SRui Paulo#ap_isolate=1
571f05cddf9SRui Paulo
5725b9c547cSRui Paulo# BSS Load update period (in BUs)
5735b9c547cSRui Paulo# This field is used to enable and configure adding a BSS Load element into
5745b9c547cSRui Paulo# Beacon and Probe Response frames.
5755b9c547cSRui Paulo#bss_load_update_period=50
5765b9c547cSRui Paulo
57785732ac8SCy Schubert# Channel utilization averaging period (in BUs)
57885732ac8SCy Schubert# This field is used to enable and configure channel utilization average
57985732ac8SCy Schubert# calculation with bss_load_update_period. This should be in multiples of
58085732ac8SCy Schubert# bss_load_update_period for more accurate calculation.
58185732ac8SCy Schubert#chan_util_avg_period=600
58285732ac8SCy Schubert
5835b9c547cSRui Paulo# Fixed BSS Load value for testing purposes
5845b9c547cSRui Paulo# This field can be used to configure hostapd to add a fixed BSS Load element
5855b9c547cSRui Paulo# into Beacon and Probe Response frames for testing purposes. The format is
5865b9c547cSRui Paulo# <station count>:<channel utilization>:<available admission capacity>
5875b9c547cSRui Paulo#bss_load_test=12:80:20000
5885b9c547cSRui Paulo
58985732ac8SCy Schubert# Multicast to unicast conversion
59085732ac8SCy Schubert# Request that the AP will do multicast-to-unicast conversion for ARP, IPv4, and
59185732ac8SCy Schubert# IPv6 frames (possibly within 802.1Q). If enabled, such frames are to be sent
59285732ac8SCy Schubert# to each station separately, with the DA replaced by their own MAC address
59385732ac8SCy Schubert# rather than the group address.
59485732ac8SCy Schubert#
59585732ac8SCy Schubert# Note that this may break certain expectations of the receiver, such as the
59685732ac8SCy Schubert# ability to drop unicast IP packets received within multicast L2 frames, or the
59785732ac8SCy Schubert# ability to not send ICMP destination unreachable messages for packets received
59885732ac8SCy Schubert# in L2 multicast (which is required, but the receiver can't tell the difference
59985732ac8SCy Schubert# if this new option is enabled).
60085732ac8SCy Schubert#
60185732ac8SCy Schubert# This also doesn't implement the 802.11 DMS (directed multicast service).
60285732ac8SCy Schubert#
60385732ac8SCy Schubert#multicast_to_unicast=0
60485732ac8SCy Schubert
60585732ac8SCy Schubert# Send broadcast Deauthentication frame on AP start/stop
60685732ac8SCy Schubert# Default: 1 (enabled)
60785732ac8SCy Schubert#broadcast_deauth=1
60885732ac8SCy Schubert
609c1d255d3SCy Schubert# Get notifications for received Management frames on control interface
610c1d255d3SCy Schubert# Default: 0 (disabled)
611c1d255d3SCy Schubert#notify_mgmt_frames=0
612c1d255d3SCy Schubert
61339beb93cSSam Leffler##### IEEE 802.11n related configuration ######################################
61439beb93cSSam Leffler
61539beb93cSSam Leffler# ieee80211n: Whether IEEE 802.11n (HT) is enabled
61639beb93cSSam Leffler# 0 = disabled (default)
61739beb93cSSam Leffler# 1 = enabled
6183157ba21SRui Paulo# Note: You will also need to enable WMM for full HT functionality.
619780fb4a2SCy Schubert# Note: hw_mode=g (2.4 GHz) and hw_mode=a (5 GHz) is used to specify the band.
62039beb93cSSam Leffler#ieee80211n=1
62139beb93cSSam Leffler
622c1d255d3SCy Schubert# disable_11n: Boolean (0/1) to disable HT for a specific BSS
623c1d255d3SCy Schubert#disable_11n=0
624c1d255d3SCy Schubert
62539beb93cSSam Leffler# ht_capab: HT capabilities (list of flags)
62639beb93cSSam Leffler# LDPC coding capability: [LDPC] = supported
62739beb93cSSam Leffler# Supported channel width set: [HT40-] = both 20 MHz and 40 MHz with secondary
62839beb93cSSam Leffler#	channel below the primary channel; [HT40+] = both 20 MHz and 40 MHz
6295b9c547cSRui Paulo#	with secondary channel above the primary channel
63039beb93cSSam Leffler#	(20 MHz only if neither is set)
63139beb93cSSam Leffler#	Note: There are limits on which channels can be used with HT40- and
63239beb93cSSam Leffler#	HT40+. Following table shows the channels that may be available for
63339beb93cSSam Leffler#	HT40- and HT40+ use per IEEE 802.11n Annex J:
63439beb93cSSam Leffler#	freq		HT40-		HT40+
63539beb93cSSam Leffler#	2.4 GHz		5-13		1-7 (1-9 in Europe/Japan)
63639beb93cSSam Leffler#	5 GHz		40,48,56,64	36,44,52,60
63739beb93cSSam Leffler#	(depending on the location, not all of these channels may be available
63839beb93cSSam Leffler#	for use)
639e28a4053SRui Paulo#	Please note that 40 MHz channels may switch their primary and secondary
640e28a4053SRui Paulo#	channels if needed or creation of 40 MHz channel maybe rejected based
641e28a4053SRui Paulo#	on overlapping BSSes. These changes are done automatically when hostapd
642e28a4053SRui Paulo#	is setting up the 40 MHz channel.
64339beb93cSSam Leffler# HT-greenfield: [GF] (disabled if not set)
64439beb93cSSam Leffler# Short GI for 20 MHz: [SHORT-GI-20] (disabled if not set)
64539beb93cSSam Leffler# Short GI for 40 MHz: [SHORT-GI-40] (disabled if not set)
64639beb93cSSam Leffler# Tx STBC: [TX-STBC] (disabled if not set)
64739beb93cSSam Leffler# Rx STBC: [RX-STBC1] (one spatial stream), [RX-STBC12] (one or two spatial
64839beb93cSSam Leffler#	streams), or [RX-STBC123] (one, two, or three spatial streams); Rx STBC
64939beb93cSSam Leffler#	disabled if none of these set
65039beb93cSSam Leffler# HT-delayed Block Ack: [DELAYED-BA] (disabled if not set)
65139beb93cSSam Leffler# Maximum A-MSDU length: [MAX-AMSDU-7935] for 7935 octets (3839 octets if not
65239beb93cSSam Leffler#	set)
65339beb93cSSam Leffler# DSSS/CCK Mode in 40 MHz: [DSSS_CCK-40] = allowed (not allowed if not set)
6545b9c547cSRui Paulo# 40 MHz intolerant [40-INTOLERANT] (not advertised if not set)
65539beb93cSSam Leffler# L-SIG TXOP protection support: [LSIG-TXOP-PROT] (disabled if not set)
65639beb93cSSam Leffler#ht_capab=[HT40-][SHORT-GI-20][SHORT-GI-40]
65739beb93cSSam Leffler
658f05cddf9SRui Paulo# Require stations to support HT PHY (reject association if they do not)
659f05cddf9SRui Paulo#require_ht=1
660f05cddf9SRui Paulo
6615b9c547cSRui Paulo# If set non-zero, require stations to perform scans of overlapping
6625b9c547cSRui Paulo# channels to test for stations which would be affected by 40 MHz traffic.
6635b9c547cSRui Paulo# This parameter sets the interval in seconds between these scans. Setting this
6645b9c547cSRui Paulo# to non-zero allows 2.4 GHz band AP to move dynamically to a 40 MHz channel if
6655b9c547cSRui Paulo# no co-existence issues with neighboring devices are found.
6665b9c547cSRui Paulo#obss_interval=0
6675b9c547cSRui Paulo
668*a90b9d01SCy Schubert# ht_vht_twt_responder: Whether TWT responder is enabled in HT and VHT modes
669*a90b9d01SCy Schubert# 0 = disable; Disable TWT responder support in  HT and VHT modes (default).
670*a90b9d01SCy Schubert# 1 = enable; Enable TWT responder support in HT and VHT modes if supported by
671*a90b9d01SCy Schubert# the driver.
672*a90b9d01SCy Schubert#ht_vht_twt_responder=0
673*a90b9d01SCy Schubert
674f05cddf9SRui Paulo##### IEEE 802.11ac related configuration #####################################
675f05cddf9SRui Paulo
676f05cddf9SRui Paulo# ieee80211ac: Whether IEEE 802.11ac (VHT) is enabled
677f05cddf9SRui Paulo# 0 = disabled (default)
678f05cddf9SRui Paulo# 1 = enabled
679f05cddf9SRui Paulo# Note: You will also need to enable WMM for full VHT functionality.
680780fb4a2SCy Schubert# Note: hw_mode=a is used to specify that 5 GHz band is used with VHT.
681f05cddf9SRui Paulo#ieee80211ac=1
682f05cddf9SRui Paulo
683c1d255d3SCy Schubert# disable_11ac: Boolean (0/1) to disable VHT for a specific BSS
684c1d255d3SCy Schubert#disable_11ac=0
685c1d255d3SCy Schubert
686f05cddf9SRui Paulo# vht_capab: VHT capabilities (list of flags)
687f05cddf9SRui Paulo#
688f05cddf9SRui Paulo# vht_max_mpdu_len: [MAX-MPDU-7991] [MAX-MPDU-11454]
689f05cddf9SRui Paulo# Indicates maximum MPDU length
690f05cddf9SRui Paulo# 0 = 3895 octets (default)
691f05cddf9SRui Paulo# 1 = 7991 octets
692f05cddf9SRui Paulo# 2 = 11454 octets
693f05cddf9SRui Paulo# 3 = reserved
694f05cddf9SRui Paulo#
695f05cddf9SRui Paulo# supported_chan_width: [VHT160] [VHT160-80PLUS80]
696f05cddf9SRui Paulo# Indicates supported Channel widths
697f05cddf9SRui Paulo# 0 = 160 MHz & 80+80 channel widths are not supported (default)
698f05cddf9SRui Paulo# 1 = 160 MHz channel width is supported
699f05cddf9SRui Paulo# 2 = 160 MHz & 80+80 channel widths are supported
700f05cddf9SRui Paulo# 3 = reserved
701f05cddf9SRui Paulo#
702f05cddf9SRui Paulo# Rx LDPC coding capability: [RXLDPC]
703f05cddf9SRui Paulo# Indicates support for receiving LDPC coded pkts
704f05cddf9SRui Paulo# 0 = Not supported (default)
705f05cddf9SRui Paulo# 1 = Supported
706f05cddf9SRui Paulo#
707f05cddf9SRui Paulo# Short GI for 80 MHz: [SHORT-GI-80]
708f05cddf9SRui Paulo# Indicates short GI support for reception of packets transmitted with TXVECTOR
709f05cddf9SRui Paulo# params format equal to VHT and CBW = 80Mhz
710f05cddf9SRui Paulo# 0 = Not supported (default)
711f05cddf9SRui Paulo# 1 = Supported
712f05cddf9SRui Paulo#
713f05cddf9SRui Paulo# Short GI for 160 MHz: [SHORT-GI-160]
714f05cddf9SRui Paulo# Indicates short GI support for reception of packets transmitted with TXVECTOR
715f05cddf9SRui Paulo# params format equal to VHT and CBW = 160Mhz
716f05cddf9SRui Paulo# 0 = Not supported (default)
717f05cddf9SRui Paulo# 1 = Supported
718f05cddf9SRui Paulo#
719f05cddf9SRui Paulo# Tx STBC: [TX-STBC-2BY1]
720f05cddf9SRui Paulo# Indicates support for the transmission of at least 2x1 STBC
721f05cddf9SRui Paulo# 0 = Not supported (default)
722f05cddf9SRui Paulo# 1 = Supported
723f05cddf9SRui Paulo#
724f05cddf9SRui Paulo# Rx STBC: [RX-STBC-1] [RX-STBC-12] [RX-STBC-123] [RX-STBC-1234]
725f05cddf9SRui Paulo# Indicates support for the reception of PPDUs using STBC
726f05cddf9SRui Paulo# 0 = Not supported (default)
727f05cddf9SRui Paulo# 1 = support of one spatial stream
728f05cddf9SRui Paulo# 2 = support of one and two spatial streams
729f05cddf9SRui Paulo# 3 = support of one, two and three spatial streams
730f05cddf9SRui Paulo# 4 = support of one, two, three and four spatial streams
731f05cddf9SRui Paulo# 5,6,7 = reserved
732f05cddf9SRui Paulo#
733f05cddf9SRui Paulo# SU Beamformer Capable: [SU-BEAMFORMER]
734f05cddf9SRui Paulo# Indicates support for operation as a single user beamformer
735f05cddf9SRui Paulo# 0 = Not supported (default)
736f05cddf9SRui Paulo# 1 = Supported
737f05cddf9SRui Paulo#
738f05cddf9SRui Paulo# SU Beamformee Capable: [SU-BEAMFORMEE]
739f05cddf9SRui Paulo# Indicates support for operation as a single user beamformee
740f05cddf9SRui Paulo# 0 = Not supported (default)
741f05cddf9SRui Paulo# 1 = Supported
742f05cddf9SRui Paulo#
743325151a3SRui Paulo# Compressed Steering Number of Beamformer Antennas Supported:
744325151a3SRui Paulo# [BF-ANTENNA-2] [BF-ANTENNA-3] [BF-ANTENNA-4]
745f05cddf9SRui Paulo#   Beamformee's capability indicating the maximum number of beamformer
746f05cddf9SRui Paulo#   antennas the beamformee can support when sending compressed beamforming
747f05cddf9SRui Paulo#   feedback
748f05cddf9SRui Paulo# If SU beamformer capable, set to maximum value minus 1
749f05cddf9SRui Paulo# else reserved (default)
750f05cddf9SRui Paulo#
751325151a3SRui Paulo# Number of Sounding Dimensions:
752325151a3SRui Paulo# [SOUNDING-DIMENSION-2] [SOUNDING-DIMENSION-3] [SOUNDING-DIMENSION-4]
753f05cddf9SRui Paulo# Beamformer's capability indicating the maximum value of the NUM_STS parameter
754f05cddf9SRui Paulo# in the TXVECTOR of a VHT NDP
755f05cddf9SRui Paulo# If SU beamformer capable, set to maximum value minus 1
756f05cddf9SRui Paulo# else reserved (default)
757f05cddf9SRui Paulo#
758f05cddf9SRui Paulo# MU Beamformer Capable: [MU-BEAMFORMER]
759f05cddf9SRui Paulo# Indicates support for operation as an MU beamformer
760f05cddf9SRui Paulo# 0 = Not supported or sent by Non-AP STA (default)
761f05cddf9SRui Paulo# 1 = Supported
762f05cddf9SRui Paulo#
763f05cddf9SRui Paulo# VHT TXOP PS: [VHT-TXOP-PS]
764f05cddf9SRui Paulo# Indicates whether or not the AP supports VHT TXOP Power Save Mode
765f05cddf9SRui Paulo#  or whether or not the STA is in VHT TXOP Power Save mode
766780fb4a2SCy Schubert# 0 = VHT AP doesn't support VHT TXOP PS mode (OR) VHT STA not in VHT TXOP PS
767f05cddf9SRui Paulo#  mode
768780fb4a2SCy Schubert# 1 = VHT AP supports VHT TXOP PS mode (OR) VHT STA is in VHT TXOP power save
769f05cddf9SRui Paulo#  mode
770f05cddf9SRui Paulo#
771f05cddf9SRui Paulo# +HTC-VHT Capable: [HTC-VHT]
772f05cddf9SRui Paulo# Indicates whether or not the STA supports receiving a VHT variant HT Control
773f05cddf9SRui Paulo# field.
774f05cddf9SRui Paulo# 0 = Not supported (default)
775f05cddf9SRui Paulo# 1 = supported
776f05cddf9SRui Paulo#
777f05cddf9SRui Paulo# Maximum A-MPDU Length Exponent: [MAX-A-MPDU-LEN-EXP0]..[MAX-A-MPDU-LEN-EXP7]
778f05cddf9SRui Paulo# Indicates the maximum length of A-MPDU pre-EOF padding that the STA can recv
779f05cddf9SRui Paulo# This field is an integer in the range of 0 to 7.
780f05cddf9SRui Paulo# The length defined by this field is equal to
781f05cddf9SRui Paulo# 2 pow(13 + Maximum A-MPDU Length Exponent) -1 octets
782f05cddf9SRui Paulo#
783f05cddf9SRui Paulo# VHT Link Adaptation Capable: [VHT-LINK-ADAPT2] [VHT-LINK-ADAPT3]
784f05cddf9SRui Paulo# Indicates whether or not the STA supports link adaptation using VHT variant
785f05cddf9SRui Paulo# HT Control field
786f05cddf9SRui Paulo# If +HTC-VHTcapable is 1
787f05cddf9SRui Paulo#  0 = (no feedback) if the STA does not provide VHT MFB (default)
788f05cddf9SRui Paulo#  1 = reserved
789f05cddf9SRui Paulo#  2 = (Unsolicited) if the STA provides only unsolicited VHT MFB
790f05cddf9SRui Paulo#  3 = (Both) if the STA can provide VHT MFB in response to VHT MRQ and if the
791f05cddf9SRui Paulo#      STA provides unsolicited VHT MFB
792f05cddf9SRui Paulo# Reserved if +HTC-VHTcapable is 0
793f05cddf9SRui Paulo#
794f05cddf9SRui Paulo# Rx Antenna Pattern Consistency: [RX-ANTENNA-PATTERN]
795f05cddf9SRui Paulo# Indicates the possibility of Rx antenna pattern change
796f05cddf9SRui Paulo# 0 = Rx antenna pattern might change during the lifetime of an association
797f05cddf9SRui Paulo# 1 = Rx antenna pattern does not change during the lifetime of an association
798f05cddf9SRui Paulo#
799f05cddf9SRui Paulo# Tx Antenna Pattern Consistency: [TX-ANTENNA-PATTERN]
800f05cddf9SRui Paulo# Indicates the possibility of Tx antenna pattern change
801f05cddf9SRui Paulo# 0 = Tx antenna pattern might change during the lifetime of an association
802f05cddf9SRui Paulo# 1 = Tx antenna pattern does not change during the lifetime of an association
803f05cddf9SRui Paulo#vht_capab=[SHORT-GI-80][HTC-VHT]
804f05cddf9SRui Paulo#
805f05cddf9SRui Paulo# Require stations to support VHT PHY (reject association if they do not)
806f05cddf9SRui Paulo#require_vht=1
807f05cddf9SRui Paulo
808f05cddf9SRui Paulo# 0 = 20 or 40 MHz operating Channel width
809f05cddf9SRui Paulo# 1 = 80 MHz channel width
810f05cddf9SRui Paulo# 2 = 160 MHz channel width
811f05cddf9SRui Paulo# 3 = 80+80 MHz channel width
812f05cddf9SRui Paulo#vht_oper_chwidth=1
813f05cddf9SRui Paulo#
814f05cddf9SRui Paulo# center freq = 5 GHz + (5 * index)
815f05cddf9SRui Paulo# So index 42 gives center freq 5.210 GHz
816f05cddf9SRui Paulo# which is channel 42 in 5G band
817f05cddf9SRui Paulo#
818f05cddf9SRui Paulo#vht_oper_centr_freq_seg0_idx=42
819f05cddf9SRui Paulo#
820f05cddf9SRui Paulo# center freq = 5 GHz + (5 * index)
821f05cddf9SRui Paulo# So index 159 gives center freq 5.795 GHz
822f05cddf9SRui Paulo# which is channel 159 in 5G band
823f05cddf9SRui Paulo#
824f05cddf9SRui Paulo#vht_oper_centr_freq_seg1_idx=159
825f05cddf9SRui Paulo
826780fb4a2SCy Schubert# Workaround to use station's nsts capability in (Re)Association Response frame
827780fb4a2SCy Schubert# This may be needed with some deployed devices as an interoperability
828780fb4a2SCy Schubert# workaround for beamforming if the AP's capability is greater than the
829780fb4a2SCy Schubert# station's capability. This is disabled by default and can be enabled by
830780fb4a2SCy Schubert# setting use_sta_nsts=1.
831780fb4a2SCy Schubert#use_sta_nsts=0
832780fb4a2SCy Schubert
83385732ac8SCy Schubert##### IEEE 802.11ax related configuration #####################################
83485732ac8SCy Schubert
83585732ac8SCy Schubert#ieee80211ax: Whether IEEE 802.11ax (HE) is enabled
83685732ac8SCy Schubert# 0 = disabled (default)
83785732ac8SCy Schubert# 1 = enabled
83885732ac8SCy Schubert#ieee80211ax=1
83985732ac8SCy Schubert
840*a90b9d01SCy Schubert# Require stations to support HE PHY (reject association if they do not)
841*a90b9d01SCy Schubert#require_he=1
842*a90b9d01SCy Schubert
843c1d255d3SCy Schubert# disable_11ax: Boolean (0/1) to disable HE for a specific BSS
844c1d255d3SCy Schubert#disable_11ax=0
845c1d255d3SCy Schubert
84685732ac8SCy Schubert#he_su_beamformer: HE single user beamformer support
84785732ac8SCy Schubert# 0 = not supported (default)
84885732ac8SCy Schubert# 1 = supported
84985732ac8SCy Schubert#he_su_beamformer=1
85085732ac8SCy Schubert
85185732ac8SCy Schubert#he_su_beamformee: HE single user beamformee support
85285732ac8SCy Schubert# 0 = not supported (default)
85385732ac8SCy Schubert# 1 = supported
85485732ac8SCy Schubert#he_su_beamformee=1
85585732ac8SCy Schubert
85685732ac8SCy Schubert#he_mu_beamformer: HE multiple user beamformer support
85785732ac8SCy Schubert# 0 = not supported (default)
85885732ac8SCy Schubert# 1 = supported
85985732ac8SCy Schubert#he_mu_beamformer=1
86085732ac8SCy Schubert
861206b73d0SCy Schubert# he_bss_color: BSS color (1-63)
862206b73d0SCy Schubert#he_bss_color=1
86385732ac8SCy Schubert
864c1d255d3SCy Schubert# he_bss_color_partial: BSS color AID equation
865c1d255d3SCy Schubert#he_bss_color_partial=0
866c1d255d3SCy Schubert
86785732ac8SCy Schubert#he_default_pe_duration: The duration of PE field in an HE PPDU in us
86885732ac8SCy Schubert# Possible values are 0 us (default), 4 us, 8 us, 12 us, and 16 us
86985732ac8SCy Schubert#he_default_pe_duration=0
87085732ac8SCy Schubert
87185732ac8SCy Schubert#he_twt_required: Whether TWT is required
87285732ac8SCy Schubert# 0 = not required (default)
87385732ac8SCy Schubert# 1 = required
87485732ac8SCy Schubert#he_twt_required=0
87585732ac8SCy Schubert
876c1d255d3SCy Schubert#he_twt_responder: Whether TWT (HE) responder is enabled
877c1d255d3SCy Schubert# 0 = disabled
878c1d255d3SCy Schubert# 1 = enabled if supported by the driver (default)
879c1d255d3SCy Schubert#he_twt_responder=1
880c1d255d3SCy Schubert
88185732ac8SCy Schubert#he_rts_threshold: Duration of STA transmission
88285732ac8SCy Schubert# 0 = not set (default)
88385732ac8SCy Schubert# unsigned integer = duration in units of 16 us
88485732ac8SCy Schubert#he_rts_threshold=0
88585732ac8SCy Schubert
8864b72b91aSCy Schubert#he_er_su_disable: Disable 242-tone HE ER SU PPDU reception by the AP
8874b72b91aSCy Schubert# 0 = enable reception (default)
8884b72b91aSCy Schubert# 1 = disable reception
8894b72b91aSCy Schubert#he_er_su_disable=0
8904b72b91aSCy Schubert
891206b73d0SCy Schubert# HE operating channel information; see matching vht_* parameters for details.
892c1d255d3SCy Schubert# he_oper_centr_freq_seg0_idx field is used to indicate center frequency of 80
893c1d255d3SCy Schubert# and 160 MHz bandwidth operation. In 80+80 MHz operation, it is the center
894c1d255d3SCy Schubert# frequency of the lower frequency segment. he_oper_centr_freq_seg1_idx field
895c1d255d3SCy Schubert# is used only with 80+80 MHz bandwidth operation and it is used to transmit
896c1d255d3SCy Schubert# the center frequency of the second segment.
897c1d255d3SCy Schubert# On the 6 GHz band the center freq calculation starts from 5.950 GHz offset.
898c1d255d3SCy Schubert# For example idx=3 would result in 5965 MHz center frequency. In addition,
899c1d255d3SCy Schubert# he_oper_chwidth is ignored, and the channel width is derived from the
900c1d255d3SCy Schubert# configured operating class or center frequency indexes (see
901c1d255d3SCy Schubert# IEEE P802.11ax/D6.1 Annex E, Table E-4).
902*a90b9d01SCy Schubert#he_oper_chwidth (see vht_oper_chwidth)
903206b73d0SCy Schubert#he_oper_centr_freq_seg0_idx
904206b73d0SCy Schubert#he_oper_centr_freq_seg1_idx
905206b73d0SCy Schubert
906206b73d0SCy Schubert#he_basic_mcs_nss_set: Basic NSS/MCS set
907206b73d0SCy Schubert# 16-bit combination of 2-bit values of Max HE-MCS For 1..8 SS; each 2-bit
908206b73d0SCy Schubert# value having following meaning:
909206b73d0SCy Schubert# 0 = HE-MCS 0-7, 1 = HE-MCS 0-9, 2 = HE-MCS 0-11, 3 = not supported
910206b73d0SCy Schubert#he_basic_mcs_nss_set
911206b73d0SCy Schubert
9124bc52338SCy Schubert#he_mu_edca_qos_info_param_count
9134bc52338SCy Schubert#he_mu_edca_qos_info_q_ack
9144bc52338SCy Schubert#he_mu_edca_qos_info_queue_request=1
9154bc52338SCy Schubert#he_mu_edca_qos_info_txop_request
9164bc52338SCy Schubert#he_mu_edca_ac_be_aifsn=0
9174bc52338SCy Schubert#he_mu_edca_ac_be_ecwmin=15
9184bc52338SCy Schubert#he_mu_edca_ac_be_ecwmax=15
9194bc52338SCy Schubert#he_mu_edca_ac_be_timer=255
9204bc52338SCy Schubert#he_mu_edca_ac_bk_aifsn=0
9214bc52338SCy Schubert#he_mu_edca_ac_bk_aci=1
9224bc52338SCy Schubert#he_mu_edca_ac_bk_ecwmin=15
9234bc52338SCy Schubert#he_mu_edca_ac_bk_ecwmax=15
9244bc52338SCy Schubert#he_mu_edca_ac_bk_timer=255
9254bc52338SCy Schubert#he_mu_edca_ac_vi_ecwmin=15
9264bc52338SCy Schubert#he_mu_edca_ac_vi_ecwmax=15
9274bc52338SCy Schubert#he_mu_edca_ac_vi_aifsn=0
9284bc52338SCy Schubert#he_mu_edca_ac_vi_aci=2
9294bc52338SCy Schubert#he_mu_edca_ac_vi_timer=255
9304bc52338SCy Schubert#he_mu_edca_ac_vo_aifsn=0
9314bc52338SCy Schubert#he_mu_edca_ac_vo_aci=3
9324bc52338SCy Schubert#he_mu_edca_ac_vo_ecwmin=15
9334bc52338SCy Schubert#he_mu_edca_ac_vo_ecwmax=15
9344bc52338SCy Schubert#he_mu_edca_ac_vo_timer=255
9354bc52338SCy Schubert
936206b73d0SCy Schubert# Spatial Reuse Parameter Set
937c1d255d3SCy Schubert#
938c1d255d3SCy Schubert# SR Control field value
939c1d255d3SCy Schubert# B0 = PSR Disallowed
940c1d255d3SCy Schubert# B1 = Non-SRG OBSS PD SR Disallowed
941c1d255d3SCy Schubert# B2 = Non-SRG Offset Present
942c1d255d3SCy Schubert# B3 = SRG Information Present
943c1d255d3SCy Schubert# B4 = HESIGA_Spatial_reuse_value15_allowed
944206b73d0SCy Schubert#he_spr_sr_control
945c1d255d3SCy Schubert#
946c1d255d3SCy Schubert# Non-SRG OBSS PD Max Offset (included if he_spr_sr_control B2=1)
947206b73d0SCy Schubert#he_spr_non_srg_obss_pd_max_offset
948c1d255d3SCy Schubert
949c1d255d3SCy Schubert# SRG OBSS PD Min Offset (included if he_spr_sr_control B3=1)
950206b73d0SCy Schubert#he_spr_srg_obss_pd_min_offset
951c1d255d3SCy Schubert#
952c1d255d3SCy Schubert# SRG OBSS PD Max Offset (included if he_spr_sr_control B3=1)
953206b73d0SCy Schubert#he_spr_srg_obss_pd_max_offset
954c1d255d3SCy Schubert#
955c1d255d3SCy Schubert# SPR SRG BSS Color (included if he_spr_sr_control B3=1)
956c1d255d3SCy Schubert# This config represents SRG BSS Color Bitmap field of Spatial Reuse Parameter
957c1d255d3SCy Schubert# Set element that indicates the BSS color values used by members of the
958c1d255d3SCy Schubert# SRG of which the transmitting STA is a member. The value is in range of 0-63.
959c1d255d3SCy Schubert#he_spr_srg_bss_colors=1 2 10 63
960c1d255d3SCy Schubert#
961c1d255d3SCy Schubert# SPR SRG Partial BSSID (included if he_spr_sr_control B3=1)
962c1d255d3SCy Schubert# This config represents SRG Partial BSSID Bitmap field of Spatial Reuse
963c1d255d3SCy Schubert# Parameter Set element that indicates the Partial BSSID values used by members
964c1d255d3SCy Schubert# of the SRG of which the transmitting STA is a member. The value range
965c1d255d3SCy Schubert# corresponds to one of the 64 possible values of BSSID[39:44], where the lowest
966c1d255d3SCy Schubert# numbered bit corresponds to Partial BSSID value 0 and the highest numbered bit
967c1d255d3SCy Schubert# corresponds to Partial BSSID value 63.
968c1d255d3SCy Schubert#he_spr_srg_partial_bssid=0 1 3 63
969c1d255d3SCy Schubert#
970c1d255d3SCy Schubert#he_6ghz_max_mpdu: Maximum MPDU Length of HE 6 GHz band capabilities.
971c1d255d3SCy Schubert# Indicates maximum MPDU length
972c1d255d3SCy Schubert# 0 = 3895 octets
973c1d255d3SCy Schubert# 1 = 7991 octets
974c1d255d3SCy Schubert# 2 = 11454 octets (default)
975c1d255d3SCy Schubert#he_6ghz_max_mpdu=2
976c1d255d3SCy Schubert#
977c1d255d3SCy Schubert#he_6ghz_max_ampdu_len_exp: Maximum A-MPDU Length Exponent of HE 6 GHz band
978c1d255d3SCy Schubert# capabilities. Indicates the maximum length of A-MPDU pre-EOF padding that
979c1d255d3SCy Schubert# the STA can receive. This field is an integer in the range of 0 to 7.
980c1d255d3SCy Schubert# The length defined by this field is equal to
981c1d255d3SCy Schubert# 2 pow(13 + Maximum A-MPDU Length Exponent) -1 octets
982c1d255d3SCy Schubert# 0 = AMPDU length of 8k
983c1d255d3SCy Schubert# 1 = AMPDU length of 16k
984c1d255d3SCy Schubert# 2 = AMPDU length of 32k
985c1d255d3SCy Schubert# 3 = AMPDU length of 65k
986c1d255d3SCy Schubert# 4 = AMPDU length of 131k
987c1d255d3SCy Schubert# 5 = AMPDU length of 262k
988c1d255d3SCy Schubert# 6 = AMPDU length of 524k
989c1d255d3SCy Schubert# 7 = AMPDU length of 1048k (default)
990c1d255d3SCy Schubert#he_6ghz_max_ampdu_len_exp=7
991c1d255d3SCy Schubert#
992c1d255d3SCy Schubert#he_6ghz_rx_ant_pat: Rx Antenna Pattern Consistency of HE 6 GHz capability.
993c1d255d3SCy Schubert# Indicates the possibility of Rx antenna pattern change
994c1d255d3SCy Schubert# 0 = Rx antenna pattern might change during the lifetime of an association
995c1d255d3SCy Schubert# 1 = Rx antenna pattern does not change during the lifetime of an association
996c1d255d3SCy Schubert#     (default)
997c1d255d3SCy Schubert#he_6ghz_rx_ant_pat=1
998c1d255d3SCy Schubert#
999c1d255d3SCy Schubert#he_6ghz_tx_ant_pat: Tx Antenna Pattern Consistency of HE 6 GHz capability.
1000c1d255d3SCy Schubert# Indicates the possibility of Tx antenna pattern change
1001c1d255d3SCy Schubert# 0 = Tx antenna pattern might change during the lifetime of an association
1002c1d255d3SCy Schubert# 1 = Tx antenna pattern does not change during the lifetime of an association
1003c1d255d3SCy Schubert#     (default)
1004c1d255d3SCy Schubert#he_6ghz_tx_ant_pat=1
1005c1d255d3SCy Schubert
1006*a90b9d01SCy Schubert# 6 GHz Access Point type
1007*a90b9d01SCy Schubert# This config is to set the 6 GHz Access Point type. Possible options are:
1008*a90b9d01SCy Schubert# 0 = Indoor AP
1009*a90b9d01SCy Schubert# 1 = Standard power AP
1010*a90b9d01SCy Schubert# 2 = Very low power AP (default)
1011*a90b9d01SCy Schubert# 3 = Indoor enabled AP
1012*a90b9d01SCy Schubert# 4 = Indoor standard power AP
1013*a90b9d01SCy Schubert# This has no impact for operation on other bands.
1014*a90b9d01SCy Schubert# See IEEE P802.11-REVme/D4.0, Table E-12 (Regulatory Info subfield encoding)
1015*a90b9d01SCy Schubert# for more details.
1016*a90b9d01SCy Schubert#he_6ghz_reg_pwr_type=0
1017*a90b9d01SCy Schubert#
1018*a90b9d01SCy Schubert# 6 GHz Maximum Tx Power used in Transmit Power Envelope elements, where the
1019*a90b9d01SCy Schubert# "Transmit Power Interpretation" is set to "Regulatory client EIRP PSD".
1020*a90b9d01SCy Schubert# For Maximum Transmit Power Category subfield encoding set to default (0):
1021*a90b9d01SCy Schubert#reg_def_cli_eirp_psd=-1
1022*a90b9d01SCy Schubert# For Maximum Transmit Power Category subfield encoding set to subordinate (1):
1023*a90b9d01SCy Schubert#reg_sub_cli_eirp_psd=-1
1024*a90b9d01SCy Schubert
1025c1d255d3SCy Schubert# Unsolicited broadcast Probe Response transmission settings
1026c1d255d3SCy Schubert# This is for the 6 GHz band only. If the interval is set to a non-zero value,
1027c1d255d3SCy Schubert# the AP schedules unsolicited broadcast Probe Response frames to be
1028c1d255d3SCy Schubert# transmitted for in-band discovery. Refer to
1029c1d255d3SCy Schubert# IEEE P802.11ax/D8.0 26.17.2.3.2, AP behavior for fast passive scanning.
1030c1d255d3SCy Schubert# Valid range: 0..20 TUs; default is 0 (disabled)
1031c1d255d3SCy Schubert#unsol_bcast_probe_resp_interval=0
1032206b73d0SCy Schubert
1033*a90b9d01SCy Schubert##### IEEE 802.11be related configuration #####################################
1034*a90b9d01SCy Schubert
1035*a90b9d01SCy Schubert#ieee80211be: Whether IEEE 802.11be (EHT) is enabled
1036*a90b9d01SCy Schubert# 0 = disabled (default)
1037*a90b9d01SCy Schubert# 1 = enabled
1038*a90b9d01SCy Schubert#ieee80211be=1
1039*a90b9d01SCy Schubert
1040*a90b9d01SCy Schubert#disable_11be: Boolean (0/1) to disable EHT for a specific BSS
1041*a90b9d01SCy Schubert#disable_11be=0
1042*a90b9d01SCy Schubert
1043*a90b9d01SCy Schubert#eht_su_beamformer: EHT single user beamformer support
1044*a90b9d01SCy Schubert# 0 = not supported (default)
1045*a90b9d01SCy Schubert# 1 = supported
1046*a90b9d01SCy Schubert#eht_su_beamformer=1
1047*a90b9d01SCy Schubert
1048*a90b9d01SCy Schubert#eht_su_beamformee: EHT single user beamformee support
1049*a90b9d01SCy Schubert# 0 = not supported (default)
1050*a90b9d01SCy Schubert# 1 = supported
1051*a90b9d01SCy Schubert#eht_su_beamformee=1
1052*a90b9d01SCy Schubert
1053*a90b9d01SCy Schubert#eht_mu_beamformer: EHT multiple user beamformer support
1054*a90b9d01SCy Schubert# 0 = not supported (default)
1055*a90b9d01SCy Schubert# 1 = supported
1056*a90b9d01SCy Schubert#eht_mu_beamformer=1
1057*a90b9d01SCy Schubert
1058*a90b9d01SCy Schubert# EHT operating channel information; see matching he_* parameters for details.
1059*a90b9d01SCy Schubert# The field eht_oper_centr_freq_seg0_idx field is used to indicate center
1060*a90b9d01SCy Schubert# frequency of 40, 80, and 160 MHz bandwidth operation.
1061*a90b9d01SCy Schubert# In the 6 GHz band, eht_oper_chwidth is ignored and the channel width is
1062*a90b9d01SCy Schubert# derived from the configured operating class (IEEE P802.11be/D1.5,
1063*a90b9d01SCy Schubert# Annex E.1 - Country information and operating classes).
1064*a90b9d01SCy Schubert#eht_oper_chwidth (see vht_oper_chwidth)
1065*a90b9d01SCy Schubert#eht_oper_centr_freq_seg0_idx
1066*a90b9d01SCy Schubert
1067*a90b9d01SCy Schubert#eht_default_pe_duration: The duration of PE field in EHT TB PPDU
1068*a90b9d01SCy Schubert# 0 = PE field duration is the same as he_default_pe_duration (default)
1069*a90b9d01SCy Schubert# 1 = PE field duration is 20 us
1070*a90b9d01SCy Schubert#eht_default_pe_duration=0
1071*a90b9d01SCy Schubert
1072*a90b9d01SCy Schubert#eht_bw320_offset: For automatic channel selection (ACS) to indicate a preferred
1073*a90b9d01SCy Schubert# 320 MHz channelization in EHT mode.
1074*a90b9d01SCy Schubert# If the channel is decided or the bandwidth is not 320 MHz, this option is
1075*a90b9d01SCy Schubert# meaningless.
1076*a90b9d01SCy Schubert# 0 = auto-detect by hostapd
1077*a90b9d01SCy Schubert# 1 = 320 MHz-1 (channel center frequency 31, 95, 159)
1078*a90b9d01SCy Schubert# 2 = 320 MHz-2 (channel center frequency 63, 127, 191)
1079*a90b9d01SCy Schubert#eht_bw320_offset=0
1080*a90b9d01SCy Schubert
1081*a90b9d01SCy Schubert# Disabled subchannel bitmap (16 bits) as per IEEE P802.11be/3.0,
1082*a90b9d01SCy Schubert# Figure 9-1002c (EHT Operation Information field format). Each bit corresponds
1083*a90b9d01SCy Schubert# to a 20 MHz channel, the lowest bit corresponds to the lowest frequency. A
1084*a90b9d01SCy Schubert# bit set to 1 indicates that the channel is punctured (disabled). The default
1085*a90b9d01SCy Schubert# value is 0 indicating that all channels are active.
1086*a90b9d01SCy Schubert#punct_bitmap=0
1087*a90b9d01SCy Schubert
1088*a90b9d01SCy Schubert# Preamble puncturing threshold in automatic channel selection (ACS).
1089*a90b9d01SCy Schubert# The value indicates the percentage of ideal channel average interference
1090*a90b9d01SCy Schubert# factor above which a channel should be punctured.
1091*a90b9d01SCy Schubert# Default is 0, indicates that ACS algorithm should not puncture any channel.
1092*a90b9d01SCy Schubert#punct_acs_threshold=75
1093*a90b9d01SCy Schubert
1094*a90b9d01SCy Schubert# AP MLD - Whether this AP is a part of an AP MLD
1095*a90b9d01SCy Schubert# 0 = no (no MLO)
1096*a90b9d01SCy Schubert# 1 = yes (MLO)
1097*a90b9d01SCy Schubert#mld_ap=0
1098*a90b9d01SCy Schubert
1099*a90b9d01SCy Schubert# AP MLD MAC address
1100*a90b9d01SCy Schubert# The configured address will be set as the interface hardware address and used
1101*a90b9d01SCy Schubert# as the AP MLD MAC address. If not set, the current interface hardware address
1102*a90b9d01SCy Schubert# will be used as the AP MLD MAC address.
1103*a90b9d01SCy Schubert#mld_addr=02:03:04:05:06:07
1104*a90b9d01SCy Schubert
110539beb93cSSam Leffler##### IEEE 802.1X-2004 related configuration ##################################
110639beb93cSSam Leffler
110739beb93cSSam Leffler# Require IEEE 802.1X authorization
110839beb93cSSam Leffler#ieee8021x=1
110939beb93cSSam Leffler
111039beb93cSSam Leffler# IEEE 802.1X/EAPOL version
111139beb93cSSam Leffler# hostapd is implemented based on IEEE Std 802.1X-2004 which defines EAPOL
111239beb93cSSam Leffler# version 2. However, there are many client implementations that do not handle
111339beb93cSSam Leffler# the new version number correctly (they seem to drop the frames completely).
111439beb93cSSam Leffler# In order to make hostapd interoperate with these clients, the version number
111539beb93cSSam Leffler# can be set to the older version (1) with this configuration value.
1116206b73d0SCy Schubert# Note: When using MACsec, eapol_version shall be set to 3, which is
1117206b73d0SCy Schubert# defined in IEEE Std 802.1X-2010.
111839beb93cSSam Leffler#eapol_version=2
111939beb93cSSam Leffler
112039beb93cSSam Leffler# Optional displayable message sent with EAP Request-Identity. The first \0
112139beb93cSSam Leffler# in this string will be converted to ASCII-0 (nul). This can be used to
112239beb93cSSam Leffler# separate network info (comma separated list of attribute=value pairs); see,
112339beb93cSSam Leffler# e.g., RFC 4284.
112439beb93cSSam Leffler#eap_message=hello
112539beb93cSSam Leffler#eap_message=hello\0networkid=netw,nasid=foo,portid=0,NAIRealms=example.com
112639beb93cSSam Leffler
112739beb93cSSam Leffler# WEP rekeying (disabled if key lengths are not set or are set to 0)
112839beb93cSSam Leffler# Key lengths for default/broadcast and individual/unicast keys:
112939beb93cSSam Leffler# 5 = 40-bit WEP (also known as 64-bit WEP with 40 secret bits)
113039beb93cSSam Leffler# 13 = 104-bit WEP (also known as 128-bit WEP with 104 secret bits)
113139beb93cSSam Leffler#wep_key_len_broadcast=5
113239beb93cSSam Leffler#wep_key_len_unicast=5
113339beb93cSSam Leffler# Rekeying period in seconds. 0 = do not rekey (i.e., set keys only once)
113439beb93cSSam Leffler#wep_rekey_period=300
113539beb93cSSam Leffler
113639beb93cSSam Leffler# EAPOL-Key index workaround (set bit7) for WinXP Supplicant (needed only if
113739beb93cSSam Leffler# only broadcast keys are used)
113839beb93cSSam Lefflereapol_key_index_workaround=0
113939beb93cSSam Leffler
114039beb93cSSam Leffler# EAP reauthentication period in seconds (default: 3600 seconds; 0 = disable
114139beb93cSSam Leffler# reauthentication).
1142c1d255d3SCy Schubert# Note: Reauthentications may enforce a disconnection, check the related
1143c1d255d3SCy Schubert# parameter wpa_deny_ptk0_rekey for details.
114439beb93cSSam Leffler#eap_reauth_period=3600
114539beb93cSSam Leffler
114639beb93cSSam Leffler# Use PAE group address (01:80:c2:00:00:03) instead of individual target
114739beb93cSSam Leffler# address when sending EAPOL frames with driver=wired. This is the most common
114839beb93cSSam Leffler# mechanism used in wired authentication, but it also requires that the port
114939beb93cSSam Leffler# is only used by one station.
115039beb93cSSam Leffler#use_pae_group_addr=1
115139beb93cSSam Leffler
11525b9c547cSRui Paulo# EAP Re-authentication Protocol (ERP) authenticator (RFC 6696)
11535b9c547cSRui Paulo#
11545b9c547cSRui Paulo# Whether to initiate EAP authentication with EAP-Initiate/Re-auth-Start before
11555b9c547cSRui Paulo# EAP-Identity/Request
11565b9c547cSRui Paulo#erp_send_reauth_start=1
11575b9c547cSRui Paulo#
11585b9c547cSRui Paulo# Domain name for EAP-Initiate/Re-auth-Start. Omitted from the message if not
11595b9c547cSRui Paulo# set (no local ER server). This is also used by the integrated EAP server if
11605b9c547cSRui Paulo# ERP is enabled (eap_server_erp=1).
11615b9c547cSRui Paulo#erp_domain=example.com
11625b9c547cSRui Paulo
1163206b73d0SCy Schubert##### MACsec ##################################################################
1164206b73d0SCy Schubert
1165206b73d0SCy Schubert# macsec_policy: IEEE 802.1X/MACsec options
1166206b73d0SCy Schubert# This determines how sessions are secured with MACsec (only for MACsec
1167206b73d0SCy Schubert# drivers).
1168206b73d0SCy Schubert# 0: MACsec not in use (default)
1169206b73d0SCy Schubert# 1: MACsec enabled - Should secure, accept key server's advice to
1170206b73d0SCy Schubert#    determine whether to use a secure session or not.
1171206b73d0SCy Schubert#
1172206b73d0SCy Schubert# macsec_integ_only: IEEE 802.1X/MACsec transmit mode
1173206b73d0SCy Schubert# This setting applies only when MACsec is in use, i.e.,
1174206b73d0SCy Schubert#  - macsec_policy is enabled
1175206b73d0SCy Schubert#  - the key server has decided to enable MACsec
1176206b73d0SCy Schubert# 0: Encrypt traffic (default)
1177206b73d0SCy Schubert# 1: Integrity only
1178206b73d0SCy Schubert#
1179206b73d0SCy Schubert# macsec_replay_protect: IEEE 802.1X/MACsec replay protection
1180206b73d0SCy Schubert# This setting applies only when MACsec is in use, i.e.,
1181206b73d0SCy Schubert#  - macsec_policy is enabled
1182206b73d0SCy Schubert#  - the key server has decided to enable MACsec
1183206b73d0SCy Schubert# 0: Replay protection disabled (default)
1184206b73d0SCy Schubert# 1: Replay protection enabled
1185206b73d0SCy Schubert#
1186206b73d0SCy Schubert# macsec_replay_window: IEEE 802.1X/MACsec replay protection window
1187206b73d0SCy Schubert# This determines a window in which replay is tolerated, to allow receipt
1188206b73d0SCy Schubert# of frames that have been misordered by the network.
1189206b73d0SCy Schubert# This setting applies only when MACsec replay protection active, i.e.,
1190206b73d0SCy Schubert#  - macsec_replay_protect is enabled
1191206b73d0SCy Schubert#  - the key server has decided to enable MACsec
1192206b73d0SCy Schubert# 0: No replay window, strict check (default)
1193206b73d0SCy Schubert# 1..2^32-1: number of packets that could be misordered
1194206b73d0SCy Schubert#
1195*a90b9d01SCy Schubert# macsec_offload: IEEE 802.1X/MACsec hardware offload
1196*a90b9d01SCy Schubert# This setting applies only when MACsec is in use, i.e.,
1197*a90b9d01SCy Schubert#  - macsec_policy is enabled
1198*a90b9d01SCy Schubert#  - the key server has decided to enable MACsec
1199*a90b9d01SCy Schubert# 0 = MACSEC_OFFLOAD_OFF (default)
1200*a90b9d01SCy Schubert# 1 = MACSEC_OFFLOAD_PHY
1201*a90b9d01SCy Schubert# 2 = MACSEC_OFFLOAD_MAC
1202*a90b9d01SCy Schubert#
1203206b73d0SCy Schubert# macsec_port: IEEE 802.1X/MACsec port
1204206b73d0SCy Schubert# Port component of the SCI
1205206b73d0SCy Schubert# Range: 1-65534 (default: 1)
1206206b73d0SCy Schubert#
1207206b73d0SCy Schubert# mka_priority (Priority of MKA Actor)
1208206b73d0SCy Schubert# Range: 0..255 (default: 255)
1209206b73d0SCy Schubert#
1210*a90b9d01SCy Schubert# macsec_csindex: IEEE 802.1X/MACsec cipher suite
1211*a90b9d01SCy Schubert# 0 = GCM-AES-128 (default)
1212*a90b9d01SCy Schubert# 1 = GCM-AES-256 (default)
1213*a90b9d01SCy Schubert#
1214206b73d0SCy Schubert# mka_cak, mka_ckn, and mka_priority: IEEE 802.1X/MACsec pre-shared key mode
1215206b73d0SCy Schubert# This allows to configure MACsec with a pre-shared key using a (CAK,CKN) pair.
1216206b73d0SCy Schubert# In this mode, instances of hostapd can act as MACsec peers. The peer
1217206b73d0SCy Schubert# with lower priority will become the key server and start distributing SAKs.
1218206b73d0SCy Schubert# mka_cak (CAK = Secure Connectivity Association Key) takes a 16-byte (128-bit)
1219206b73d0SCy Schubert# hex-string (32 hex-digits) or a 32-byte (256-bit) hex-string (64 hex-digits)
1220206b73d0SCy Schubert# mka_ckn (CKN = CAK Name) takes a 1..32-bytes (8..256 bit) hex-string
1221206b73d0SCy Schubert# (2..64 hex-digits)
1222206b73d0SCy Schubert
122339beb93cSSam Leffler##### Integrated EAP server ###################################################
122439beb93cSSam Leffler
122539beb93cSSam Leffler# Optionally, hostapd can be configured to use an integrated EAP server
122639beb93cSSam Leffler# to process EAP authentication locally without need for an external RADIUS
122739beb93cSSam Leffler# server. This functionality can be used both as a local authentication server
122839beb93cSSam Leffler# for IEEE 802.1X/EAPOL and as a RADIUS server for other devices.
122939beb93cSSam Leffler
123039beb93cSSam Leffler# Use integrated EAP server instead of external RADIUS authentication
123139beb93cSSam Leffler# server. This is also needed if hostapd is configured to act as a RADIUS
123239beb93cSSam Leffler# authentication server.
123339beb93cSSam Lefflereap_server=0
123439beb93cSSam Leffler
123539beb93cSSam Leffler# Path for EAP server user database
1236f05cddf9SRui Paulo# If SQLite support is included, this can be set to "sqlite:/path/to/sqlite.db"
1237f05cddf9SRui Paulo# to use SQLite database instead of a text file.
123839beb93cSSam Leffler#eap_user_file=/etc/hostapd.eap_user
123939beb93cSSam Leffler
124039beb93cSSam Leffler# CA certificate (PEM or DER file) for EAP-TLS/PEAP/TTLS
124139beb93cSSam Leffler#ca_cert=/etc/hostapd.ca.pem
124239beb93cSSam Leffler
124339beb93cSSam Leffler# Server certificate (PEM or DER file) for EAP-TLS/PEAP/TTLS
124439beb93cSSam Leffler#server_cert=/etc/hostapd.server.pem
124539beb93cSSam Leffler
124639beb93cSSam Leffler# Private key matching with the server certificate for EAP-TLS/PEAP/TTLS
124739beb93cSSam Leffler# This may point to the same file as server_cert if both certificate and key
124839beb93cSSam Leffler# are included in a single file. PKCS#12 (PFX) file (.p12/.pfx) can also be
124939beb93cSSam Leffler# used by commenting out server_cert and specifying the PFX file as the
125039beb93cSSam Leffler# private_key.
125139beb93cSSam Leffler#private_key=/etc/hostapd.server.prv
125239beb93cSSam Leffler
125339beb93cSSam Leffler# Passphrase for private key
125439beb93cSSam Leffler#private_key_passwd=secret passphrase
125539beb93cSSam Leffler
1256206b73d0SCy Schubert# An alternative server certificate and private key can be configured with the
1257206b73d0SCy Schubert# following parameters (with values just like the parameters above without the
1258206b73d0SCy Schubert# '2' suffix). The ca_cert file (in PEM encoding) is used to add the trust roots
1259206b73d0SCy Schubert# for both server certificates and/or client certificates).
1260206b73d0SCy Schubert#
1261206b73d0SCy Schubert# The main use case for this alternative server certificate configuration is to
1262206b73d0SCy Schubert# enable both RSA and ECC public keys. The server will pick which one to use
1263206b73d0SCy Schubert# based on the client preferences for the cipher suite (in the TLS ClientHello
1264206b73d0SCy Schubert# message). It should be noted that number of deployed EAP peer implementations
1265206b73d0SCy Schubert# do not filter out the cipher suite list based on their local configuration and
1266206b73d0SCy Schubert# as such, configuration of alternative types of certificates on the server may
1267206b73d0SCy Schubert# result in interoperability issues.
1268206b73d0SCy Schubert#server_cert2=/etc/hostapd.server-ecc.pem
1269206b73d0SCy Schubert#private_key2=/etc/hostapd.server-ecc.prv
1270206b73d0SCy Schubert#private_key_passwd2=secret passphrase
1271206b73d0SCy Schubert
1272206b73d0SCy Schubert
12735b9c547cSRui Paulo# Server identity
12745b9c547cSRui Paulo# EAP methods that provide mechanism for authenticated server identity delivery
12755b9c547cSRui Paulo# use this value. If not set, "hostapd" is used as a default.
12765b9c547cSRui Paulo#server_id=server.example.com
12775b9c547cSRui Paulo
127839beb93cSSam Leffler# Enable CRL verification.
127939beb93cSSam Leffler# Note: hostapd does not yet support CRL downloading based on CDP. Thus, a
128039beb93cSSam Leffler# valid CRL signed by the CA is required to be included in the ca_cert file.
128139beb93cSSam Leffler# This can be done by using PEM format for CA certificate and CRL and
128239beb93cSSam Leffler# concatenating these into one file. Whenever CRL changes, hostapd needs to be
12834bc52338SCy Schubert# restarted to take the new CRL into use. Alternatively, crl_reload_interval can
12844bc52338SCy Schubert# be used to configure periodic updating of the loaded CRL information.
128539beb93cSSam Leffler# 0 = do not verify CRLs (default)
128639beb93cSSam Leffler# 1 = check the CRL of the user certificate
128739beb93cSSam Leffler# 2 = check all CRLs in the certificate path
128839beb93cSSam Leffler#check_crl=1
128939beb93cSSam Leffler
12904bc52338SCy Schubert# Specify whether to ignore certificate CRL validity time mismatches with
1291c1d255d3SCy Schubert# errors X509_V_ERR_CRL_HAS_EXPIRED and X509_V_ERR_CRL_NOT_YET_VALID.
12924bc52338SCy Schubert#
12934bc52338SCy Schubert# 0 = ignore errors
12944bc52338SCy Schubert# 1 = do not ignore errors (default)
12954bc52338SCy Schubert#check_crl_strict=1
12964bc52338SCy Schubert
12974bc52338SCy Schubert# CRL reload interval in seconds
12984bc52338SCy Schubert# This can be used to reload ca_cert file and the included CRL on every new TLS
12994bc52338SCy Schubert# session if difference between last reload and the current reload time in
13004bc52338SCy Schubert# seconds is greater than crl_reload_interval.
13014bc52338SCy Schubert# Note: If interval time is very short, CPU overhead may be negatively affected
13024bc52338SCy Schubert# and it is advised to not go below 300 seconds.
13034bc52338SCy Schubert# This is applicable only with check_crl values 1 and 2.
13044bc52338SCy Schubert# 0 = do not reload CRLs (default)
13054bc52338SCy Schubert# crl_reload_interval = 300
13064bc52338SCy Schubert
13074bc52338SCy Schubert# If check_cert_subject is set, the value of every field will be checked
13084bc52338SCy Schubert# against the DN of the subject in the client certificate. If the values do
13094bc52338SCy Schubert# not match, the certificate verification will fail, rejecting the user.
13104bc52338SCy Schubert# This option allows hostapd to match every individual field in the right order
13114bc52338SCy Schubert# against the DN of the subject in the client certificate.
13124bc52338SCy Schubert#
13134bc52338SCy Schubert# For example, check_cert_subject=C=US/O=XX/OU=ABC/OU=XYZ/CN=1234 will check
13144bc52338SCy Schubert# every individual DN field of the subject in the client certificate. If OU=XYZ
13154bc52338SCy Schubert# comes first in terms of the order in the client certificate (DN field of
13164bc52338SCy Schubert# client certificate C=US/O=XX/OU=XYZ/OU=ABC/CN=1234), hostapd will reject the
13174bc52338SCy Schubert# client because the order of 'OU' is not matching the specified string in
13184bc52338SCy Schubert# check_cert_subject.
13194bc52338SCy Schubert#
13204bc52338SCy Schubert# This option also allows '*' as a wildcard. This option has some limitation.
13214bc52338SCy Schubert# It can only be used as per the following example.
13224bc52338SCy Schubert#
13234bc52338SCy Schubert# For example, check_cert_subject=C=US/O=XX/OU=Production* and we have two
13244bc52338SCy Schubert# clients and DN of the subject in the first client certificate is
13254bc52338SCy Schubert# (C=US/O=XX/OU=Production Unit) and DN of the subject in the second client is
13264bc52338SCy Schubert# (C=US/O=XX/OU=Production Factory). In this case, hostapd will allow both
13274bc52338SCy Schubert# clients because the value of 'OU' field in both client certificates matches
13284bc52338SCy Schubert# 'OU' value in 'check_cert_subject' up to 'wildcard'.
13294bc52338SCy Schubert#
13304bc52338SCy Schubert# * (Allow all clients, e.g., check_cert_subject=*)
13314bc52338SCy Schubert#check_cert_subject=string
13324bc52338SCy Schubert
1333325151a3SRui Paulo# TLS Session Lifetime in seconds
1334325151a3SRui Paulo# This can be used to allow TLS sessions to be cached and resumed with an
1335325151a3SRui Paulo# abbreviated handshake when using EAP-TLS/TTLS/PEAP.
1336325151a3SRui Paulo# (default: 0 = session caching and resumption disabled)
1337325151a3SRui Paulo#tls_session_lifetime=3600
1338325151a3SRui Paulo
13394bc52338SCy Schubert# TLS flags
13404bc52338SCy Schubert# [ALLOW-SIGN-RSA-MD5] = allow MD5-based certificate signatures (depending on
13414bc52338SCy Schubert#	the TLS library, these may be disabled by default to enforce stronger
13424bc52338SCy Schubert#	security)
13434bc52338SCy Schubert# [DISABLE-TIME-CHECKS] = ignore certificate validity time (this requests
13444bc52338SCy Schubert#	the TLS library to accept certificates even if they are not currently
13454bc52338SCy Schubert#	valid, i.e., have expired or have not yet become valid; this should be
13464bc52338SCy Schubert#	used only for testing purposes)
13474bc52338SCy Schubert# [DISABLE-TLSv1.0] = disable use of TLSv1.0
13484bc52338SCy Schubert# [ENABLE-TLSv1.0] = explicitly enable use of TLSv1.0 (this allows
13494bc52338SCy Schubert#	systemwide TLS policies to be overridden)
13504bc52338SCy Schubert# [DISABLE-TLSv1.1] = disable use of TLSv1.1
13514bc52338SCy Schubert# [ENABLE-TLSv1.1] = explicitly enable use of TLSv1.1 (this allows
13524bc52338SCy Schubert#	systemwide TLS policies to be overridden)
13534bc52338SCy Schubert# [DISABLE-TLSv1.2] = disable use of TLSv1.2
13544bc52338SCy Schubert# [ENABLE-TLSv1.2] = explicitly enable use of TLSv1.2 (this allows
13554bc52338SCy Schubert#	systemwide TLS policies to be overridden)
13564bc52338SCy Schubert# [DISABLE-TLSv1.3] = disable use of TLSv1.3
13574bc52338SCy Schubert# [ENABLE-TLSv1.3] = enable TLSv1.3 (experimental - disabled by default)
13584bc52338SCy Schubert#tls_flags=[flag1][flag2]...
13594bc52338SCy Schubert
1360c1d255d3SCy Schubert# Maximum number of EAP message rounds with data (default: 100)
1361c1d255d3SCy Schubert#max_auth_rounds=100
1362c1d255d3SCy Schubert
1363c1d255d3SCy Schubert# Maximum number of short EAP message rounds (default: 50)
1364c1d255d3SCy Schubert#max_auth_rounds_short=50
1365c1d255d3SCy Schubert
13665b9c547cSRui Paulo# Cached OCSP stapling response (DER encoded)
13675b9c547cSRui Paulo# If set, this file is sent as a certificate status response by the EAP server
13685b9c547cSRui Paulo# if the EAP peer requests certificate status in the ClientHello message.
13695b9c547cSRui Paulo# This cache file can be updated, e.g., by running following command
13705b9c547cSRui Paulo# periodically to get an update from the OCSP responder:
13715b9c547cSRui Paulo# openssl ocsp \
13725b9c547cSRui Paulo#	-no_nonce \
13735b9c547cSRui Paulo#	-CAfile /etc/hostapd.ca.pem \
13745b9c547cSRui Paulo#	-issuer /etc/hostapd.ca.pem \
13755b9c547cSRui Paulo#	-cert /etc/hostapd.server.pem \
13765b9c547cSRui Paulo#	-url http://ocsp.example.com:8888/ \
13775b9c547cSRui Paulo#	-respout /tmp/ocsp-cache.der
13785b9c547cSRui Paulo#ocsp_stapling_response=/tmp/ocsp-cache.der
13795b9c547cSRui Paulo
1380780fb4a2SCy Schubert# Cached OCSP stapling response list (DER encoded OCSPResponseList)
1381780fb4a2SCy Schubert# This is similar to ocsp_stapling_response, but the extended version defined in
1382780fb4a2SCy Schubert# RFC 6961 to allow multiple OCSP responses to be provided.
1383780fb4a2SCy Schubert#ocsp_stapling_response_multi=/tmp/ocsp-multi-cache.der
1384780fb4a2SCy Schubert
138539beb93cSSam Leffler# dh_file: File path to DH/DSA parameters file (in PEM format)
138639beb93cSSam Leffler# This is an optional configuration file for setting parameters for an
1387*a90b9d01SCy Schubert# ephemeral DH key exchange. If the file is in DSA parameters format, it will
1388*a90b9d01SCy Schubert# be automatically converted into DH params. If the used TLS library supports
1389*a90b9d01SCy Schubert# automatic DH parameter selection, that functionality will be used if this
1390*a90b9d01SCy Schubert# parameter is not set. DH parameters are required if anonymous EAP-FAST is
1391*a90b9d01SCy Schubert# used.
139239beb93cSSam Leffler# You can generate DH parameters file with OpenSSL, e.g.,
1393325151a3SRui Paulo# "openssl dhparam -out /etc/hostapd.dh.pem 2048"
139439beb93cSSam Leffler#dh_file=/etc/hostapd.dh.pem
139539beb93cSSam Leffler
13965b9c547cSRui Paulo# OpenSSL cipher string
13975b9c547cSRui Paulo#
13985b9c547cSRui Paulo# This is an OpenSSL specific configuration option for configuring the default
139985732ac8SCy Schubert# ciphers. If not set, the value configured at build time ("DEFAULT:!EXP:!LOW"
140085732ac8SCy Schubert# by default) is used.
14015b9c547cSRui Paulo# See https://www.openssl.org/docs/apps/ciphers.html for OpenSSL documentation
14025b9c547cSRui Paulo# on cipher suite configuration. This is applicable only if hostapd is built to
14035b9c547cSRui Paulo# use OpenSSL.
14045b9c547cSRui Paulo#openssl_ciphers=DEFAULT:!EXP:!LOW
14055b9c547cSRui Paulo
14064bc52338SCy Schubert# OpenSSL ECDH curves
14074bc52338SCy Schubert#
14084bc52338SCy Schubert# This is an OpenSSL specific configuration option for configuring the ECDH
14094bc52338SCy Schubert# curves for EAP-TLS/TTLS/PEAP/FAST server. If not set, automatic curve
14104bc52338SCy Schubert# selection is enabled. If set to an empty string, ECDH curve configuration is
14114bc52338SCy Schubert# not done (the exact library behavior depends on the library version).
14124bc52338SCy Schubert# Otherwise, this is a colon separated list of the supported curves (e.g.,
14134bc52338SCy Schubert# P-521:P-384:P-256). This is applicable only if hostapd is built to use
14144bc52338SCy Schubert# OpenSSL. This must not be used for Suite B cases since the same OpenSSL
14154bc52338SCy Schubert# parameter is set differently in those cases and this might conflict with that
14164bc52338SCy Schubert# design.
14174bc52338SCy Schubert#openssl_ecdh_curves=P-521:P-384:P-256
14184bc52338SCy Schubert
1419f05cddf9SRui Paulo# Fragment size for EAP methods
1420f05cddf9SRui Paulo#fragment_size=1400
1421f05cddf9SRui Paulo
1422f05cddf9SRui Paulo# Finite cyclic group for EAP-pwd. Number maps to group of domain parameters
1423f05cddf9SRui Paulo# using the IANA repository for IKE (RFC 2409).
1424f05cddf9SRui Paulo#pwd_group=19
1425f05cddf9SRui Paulo
142639beb93cSSam Leffler# Configuration data for EAP-SIM database/authentication gateway interface.
142739beb93cSSam Leffler# This is a text string in implementation specific format. The example
142839beb93cSSam Leffler# implementation in eap_sim_db.c uses this as the UNIX domain socket name for
142939beb93cSSam Leffler# the HLR/AuC gateway (e.g., hlr_auc_gw). In this case, the path uses "unix:"
1430f05cddf9SRui Paulo# prefix. If hostapd is built with SQLite support (CONFIG_SQLITE=y in .config),
1431f05cddf9SRui Paulo# database file can be described with an optional db=<path> parameter.
143239beb93cSSam Leffler#eap_sim_db=unix:/tmp/hlr_auc_gw.sock
1433f05cddf9SRui Paulo#eap_sim_db=unix:/tmp/hlr_auc_gw.sock db=/tmp/hostapd.db
143439beb93cSSam Leffler
1435780fb4a2SCy Schubert# EAP-SIM DB request timeout
1436780fb4a2SCy Schubert# This parameter sets the maximum time to wait for a database request response.
1437780fb4a2SCy Schubert# The parameter value is in seconds.
1438780fb4a2SCy Schubert#eap_sim_db_timeout=1
1439780fb4a2SCy Schubert
144039beb93cSSam Leffler# Encryption key for EAP-FAST PAC-Opaque values. This key must be a secret,
144139beb93cSSam Leffler# random value. It is configured as a 16-octet value in hex format. It can be
144239beb93cSSam Leffler# generated, e.g., with the following command:
144339beb93cSSam Leffler# od -tx1 -v -N16 /dev/random | colrm 1 8 | tr -d ' '
144439beb93cSSam Leffler#pac_opaque_encr_key=000102030405060708090a0b0c0d0e0f
144539beb93cSSam Leffler
144639beb93cSSam Leffler# EAP-FAST authority identity (A-ID)
144739beb93cSSam Leffler# A-ID indicates the identity of the authority that issues PACs. The A-ID
144839beb93cSSam Leffler# should be unique across all issuing servers. In theory, this is a variable
1449e28a4053SRui Paulo# length field, but due to some existing implementations requiring A-ID to be
145039beb93cSSam Leffler# 16 octets in length, it is strongly recommended to use that length for the
1451c1d255d3SCy Schubert# field to provide interoperability with deployed peer implementations. This
145239beb93cSSam Leffler# field is configured in hex format.
145339beb93cSSam Leffler#eap_fast_a_id=101112131415161718191a1b1c1d1e1f
145439beb93cSSam Leffler
145539beb93cSSam Leffler# EAP-FAST authority identifier information (A-ID-Info)
145639beb93cSSam Leffler# This is a user-friendly name for the A-ID. For example, the enterprise name
145739beb93cSSam Leffler# and server name in a human-readable format. This field is encoded as UTF-8.
145839beb93cSSam Leffler#eap_fast_a_id_info=test server
145939beb93cSSam Leffler
146039beb93cSSam Leffler# Enable/disable different EAP-FAST provisioning modes:
146139beb93cSSam Leffler#0 = provisioning disabled
146239beb93cSSam Leffler#1 = only anonymous provisioning allowed
146339beb93cSSam Leffler#2 = only authenticated provisioning allowed
146439beb93cSSam Leffler#3 = both provisioning modes allowed (default)
146539beb93cSSam Leffler#eap_fast_prov=3
146639beb93cSSam Leffler
146739beb93cSSam Leffler# EAP-FAST PAC-Key lifetime in seconds (hard limit)
146839beb93cSSam Leffler#pac_key_lifetime=604800
146939beb93cSSam Leffler
147039beb93cSSam Leffler# EAP-FAST PAC-Key refresh time in seconds (soft limit on remaining hard
147139beb93cSSam Leffler# limit). The server will generate a new PAC-Key when this number of seconds
147239beb93cSSam Leffler# (or fewer) of the lifetime remains.
147339beb93cSSam Leffler#pac_key_refresh_time=86400
147439beb93cSSam Leffler
1475206b73d0SCy Schubert# EAP-TEAP authentication type
1476206b73d0SCy Schubert# 0 = inner EAP (default)
1477206b73d0SCy Schubert# 1 = Basic-Password-Auth
1478c1d255d3SCy Schubert# 2 = Do not require Phase 2 authentication if client can be authenticated
1479c1d255d3SCy Schubert#     during Phase 1
1480206b73d0SCy Schubert#eap_teap_auth=0
1481206b73d0SCy Schubert
1482206b73d0SCy Schubert# EAP-TEAP authentication behavior when using PAC
1483206b73d0SCy Schubert# 0 = perform inner authentication (default)
1484206b73d0SCy Schubert# 1 = skip inner authentication (inner EAP/Basic-Password-Auth)
1485206b73d0SCy Schubert#eap_teap_pac_no_inner=0
1486206b73d0SCy Schubert
1487c1d255d3SCy Schubert# EAP-TEAP behavior with Result TLV
1488c1d255d3SCy Schubert# 0 = include with Intermediate-Result TLV (default)
1489c1d255d3SCy Schubert# 1 = send in a separate message (for testing purposes)
1490c1d255d3SCy Schubert#eap_teap_separate_result=0
1491c1d255d3SCy Schubert
1492c1d255d3SCy Schubert# EAP-TEAP identities
1493c1d255d3SCy Schubert# 0 = allow any identity type (default)
1494c1d255d3SCy Schubert# 1 = require user identity
1495c1d255d3SCy Schubert# 2 = require machine identity
1496c1d255d3SCy Schubert# 3 = request user identity; accept either user or machine identity
1497c1d255d3SCy Schubert# 4 = request machine identity; accept either user or machine identity
1498c1d255d3SCy Schubert# 5 = require both user and machine identity
1499c1d255d3SCy Schubert#eap_teap_id=0
1500c1d255d3SCy Schubert
1501*a90b9d01SCy Schubert# EAP-TEAP tunneled EAP method behavior
1502*a90b9d01SCy Schubert# 0 = minimize roundtrips by merging start of the next EAP method with the
1503*a90b9d01SCy Schubert#     crypto-binding of the previous one.
1504*a90b9d01SCy Schubert# 1 = complete crypto-binding before starting the next EAP method
1505*a90b9d01SCy Schubert#eap_teap_method_sequence=0
1506*a90b9d01SCy Schubert
150739beb93cSSam Leffler# EAP-SIM and EAP-AKA protected success/failure indication using AT_RESULT_IND
150839beb93cSSam Leffler# (default: 0 = disabled).
150939beb93cSSam Leffler#eap_sim_aka_result_ind=1
151039beb93cSSam Leffler
1511206b73d0SCy Schubert# EAP-SIM and EAP-AKA identity options
1512206b73d0SCy Schubert# 0 = do not use pseudonyms or fast reauthentication
1513206b73d0SCy Schubert# 1 = use pseudonyms, but not fast reauthentication
1514206b73d0SCy Schubert# 2 = do not use pseudonyms, but use fast reauthentication
1515206b73d0SCy Schubert# 3 = use pseudonyms and use fast reauthentication (default)
1516*a90b9d01SCy Schubert# 4 = do not use pseudonyms or fast reauthentication and allow
1517*a90b9d01SCy Schubert#     EAP-Response/Identity to be used without method specific identity exchange
1518*a90b9d01SCy Schubert# 5 = use pseudonyms, but not fast reauthentication and allow
1519*a90b9d01SCy Schubert#     EAP-Response/Identity to be used without method specific identity exchange
1520*a90b9d01SCy Schubert# 6 = do not use pseudonyms, but use fast reauthentication and allow
1521*a90b9d01SCy Schubert#     EAP-Response/Identity to be used without method specific identity exchange
1522*a90b9d01SCy Schubert# 7 = use pseudonyms and use fast reauthentication and allow
1523*a90b9d01SCy Schubert#     EAP-Response/Identity to be used without method specific identity exchange
1524206b73d0SCy Schubert#eap_sim_id=3
1525206b73d0SCy Schubert
1526*a90b9d01SCy Schubert# IMSI privacy key (PEM encoded RSA 2048-bit private key) for decrypting
1527*a90b9d01SCy Schubert# permanent identity when using EAP-SIM/AKA/AKA'.
1528*a90b9d01SCy Schubert#imsi_privacy_key=imsi-privacy-key.pem
1529*a90b9d01SCy Schubert
1530*a90b9d01SCy Schubert# EAP-SIM and EAP-AKA fast re-authentication limit
1531*a90b9d01SCy Schubert# Maximum number of fast re-authentications allowed after each full
1532*a90b9d01SCy Schubert# authentication.
1533*a90b9d01SCy Schubert#eap_sim_aka_fast_reauth_limit=1000
1534*a90b9d01SCy Schubert
153539beb93cSSam Leffler# Trusted Network Connect (TNC)
153639beb93cSSam Leffler# If enabled, TNC validation will be required before the peer is allowed to
153739beb93cSSam Leffler# connect. Note: This is only used with EAP-TTLS and EAP-FAST. If any other
153839beb93cSSam Leffler# EAP method is enabled, the peer will be allowed to connect without TNC.
153939beb93cSSam Leffler#tnc=1
154039beb93cSSam Leffler
15415b9c547cSRui Paulo# EAP Re-authentication Protocol (ERP) - RFC 6696
15425b9c547cSRui Paulo#
15435b9c547cSRui Paulo# Whether to enable ERP on the EAP server.
15445b9c547cSRui Paulo#eap_server_erp=1
154539beb93cSSam Leffler
154639beb93cSSam Leffler
154739beb93cSSam Leffler##### RADIUS client configuration #############################################
154839beb93cSSam Leffler# for IEEE 802.1X with external Authentication Server, IEEE 802.11
154939beb93cSSam Leffler# authentication with external ACL for MAC addresses, and accounting
155039beb93cSSam Leffler
155139beb93cSSam Leffler# The own IP address of the access point (used as NAS-IP-Address)
155239beb93cSSam Lefflerown_ip_addr=127.0.0.1
155339beb93cSSam Leffler
1554780fb4a2SCy Schubert# NAS-Identifier string for RADIUS messages. When used, this should be unique
1555780fb4a2SCy Schubert# to the NAS within the scope of the RADIUS server. Please note that hostapd
1556780fb4a2SCy Schubert# uses a separate RADIUS client for each BSS and as such, a unique
1557780fb4a2SCy Schubert# nas_identifier value should be configured separately for each BSS. This is
1558780fb4a2SCy Schubert# particularly important for cases where RADIUS accounting is used
1559780fb4a2SCy Schubert# (Accounting-On/Off messages are interpreted as clearing all ongoing sessions
1560780fb4a2SCy Schubert# and that may get interpreted as applying to all BSSes if the same
1561780fb4a2SCy Schubert# NAS-Identifier value is used.) For example, a fully qualified domain name
1562780fb4a2SCy Schubert# prefixed with a unique identifier of the BSS (e.g., BSSID) can be used here.
1563780fb4a2SCy Schubert#
156439beb93cSSam Leffler# When using IEEE 802.11r, nas_identifier must be set and must be between 1 and
156539beb93cSSam Leffler# 48 octets long.
1566780fb4a2SCy Schubert#
1567780fb4a2SCy Schubert# It is mandatory to configure either own_ip_addr or nas_identifier to be
1568780fb4a2SCy Schubert# compliant with the RADIUS protocol. When using RADIUS accounting, it is
1569780fb4a2SCy Schubert# strongly recommended that nas_identifier is set to a unique value for each
1570780fb4a2SCy Schubert# BSS.
157139beb93cSSam Leffler#nas_identifier=ap.example.com
157239beb93cSSam Leffler
15735b9c547cSRui Paulo# RADIUS client forced local IP address for the access point
15745b9c547cSRui Paulo# Normally the local IP address is determined automatically based on configured
15755b9c547cSRui Paulo# IP addresses, but this field can be used to force a specific address to be
15765b9c547cSRui Paulo# used, e.g., when the device has multiple IP addresses.
15775b9c547cSRui Paulo#radius_client_addr=127.0.0.1
15785b9c547cSRui Paulo
1579c1d255d3SCy Schubert# RADIUS client forced local interface. Helps run properly with VRF
1580c1d255d3SCy Schubert# Default is none set which allows the network stack to pick the appropriate
1581c1d255d3SCy Schubert# interface automatically.
1582c1d255d3SCy Schubert# Example below binds to eth0
1583c1d255d3SCy Schubert#radius_client_dev=eth0
1584c1d255d3SCy Schubert
158539beb93cSSam Leffler# RADIUS authentication server
158639beb93cSSam Leffler#auth_server_addr=127.0.0.1
158739beb93cSSam Leffler#auth_server_port=1812
158839beb93cSSam Leffler#auth_server_shared_secret=secret
158939beb93cSSam Leffler
159039beb93cSSam Leffler# RADIUS accounting server
159139beb93cSSam Leffler#acct_server_addr=127.0.0.1
159239beb93cSSam Leffler#acct_server_port=1813
159339beb93cSSam Leffler#acct_server_shared_secret=secret
159439beb93cSSam Leffler
159539beb93cSSam Leffler# Secondary RADIUS servers; to be used if primary one does not reply to
159639beb93cSSam Leffler# RADIUS packets. These are optional and there can be more than one secondary
159739beb93cSSam Leffler# server listed.
159839beb93cSSam Leffler#auth_server_addr=127.0.0.2
159939beb93cSSam Leffler#auth_server_port=1812
160039beb93cSSam Leffler#auth_server_shared_secret=secret2
160139beb93cSSam Leffler#
160239beb93cSSam Leffler#acct_server_addr=127.0.0.2
160339beb93cSSam Leffler#acct_server_port=1813
160439beb93cSSam Leffler#acct_server_shared_secret=secret2
160539beb93cSSam Leffler
1606*a90b9d01SCy Schubert# RADIUS/TLS instead of RADIUS/UDP
1607*a90b9d01SCy Schubert#auth_server_addr=127.0.0.1
1608*a90b9d01SCy Schubert#auth_server_port=2083
1609*a90b9d01SCy Schubert#auth_server_type=TLS
1610*a90b9d01SCy Schubert#auth_server_shared_secret=radsec
1611*a90b9d01SCy Schubert#auth_server_ca_cert=<path to trusted CA certificate(s)>
1612*a90b9d01SCy Schubert#auth_server_client_cert=<path to client certificate>
1613*a90b9d01SCy Schubert#auth_server_private_key=<path to private key>
1614*a90b9d01SCy Schubert#auth_server_private_key_passwd=<password for decrypting private key>
1615*a90b9d01SCy Schubert
161639beb93cSSam Leffler# Retry interval for trying to return to the primary RADIUS server (in
161739beb93cSSam Leffler# seconds). RADIUS client code will automatically try to use the next server
161839beb93cSSam Leffler# when the current server is not replying to requests. If this interval is set,
161939beb93cSSam Leffler# primary server will be retried after configured amount of time even if the
162039beb93cSSam Leffler# currently used secondary server is still working.
162139beb93cSSam Leffler#radius_retry_primary_interval=600
162239beb93cSSam Leffler
1623*a90b9d01SCy Schubert# Message-Authenticator attribute requirement for non-EAP cases
1624*a90b9d01SCy Schubert# hostapd requires Message-Authenticator attribute to be included in all cases
1625*a90b9d01SCy Schubert# where RADIUS is used for EAP authentication. This is also required for cases
1626*a90b9d01SCy Schubert# where RADIUS is used for MAC ACL (macaddr_acl=2) by default, but that case
1627*a90b9d01SCy Schubert# can be configured to not require this for compatibility with RADIUS servers
1628*a90b9d01SCy Schubert# that do not include the attribute. This is not recommended due to potential
1629*a90b9d01SCy Schubert# security concerns, but can be used as a temporary workaround in networks where
1630*a90b9d01SCy Schubert# the connection to the RADIUS server is secure.
1631*a90b9d01SCy Schubert# 0 = Do not require Message-Authenticator in MAC ACL response
1632*a90b9d01SCy Schubert# 1 = Require Message-Authenticator in all authentication cases (default)
1633*a90b9d01SCy Schubert#radius_require_message_authenticator=1
163439beb93cSSam Leffler
163539beb93cSSam Leffler# Interim accounting update interval
163639beb93cSSam Leffler# If this is set (larger than 0) and acct_server is configured, hostapd will
163739beb93cSSam Leffler# send interim accounting updates every N seconds. Note: if set, this overrides
163839beb93cSSam Leffler# possible Acct-Interim-Interval attribute in Access-Accept message. Thus, this
163939beb93cSSam Leffler# value should not be configured in hostapd.conf, if RADIUS server is used to
164039beb93cSSam Leffler# control the interim interval.
164139beb93cSSam Leffler# This value should not be less 600 (10 minutes) and must not be less than
164239beb93cSSam Leffler# 60 (1 minute).
164339beb93cSSam Leffler#radius_acct_interim_interval=600
164439beb93cSSam Leffler
1645f05cddf9SRui Paulo# Request Chargeable-User-Identity (RFC 4372)
1646f05cddf9SRui Paulo# This parameter can be used to configure hostapd to request CUI from the
1647f05cddf9SRui Paulo# RADIUS server by including Chargeable-User-Identity attribute into
1648f05cddf9SRui Paulo# Access-Request packets.
1649f05cddf9SRui Paulo#radius_request_cui=1
1650f05cddf9SRui Paulo
165139beb93cSSam Leffler# Dynamic VLAN mode; allow RADIUS authentication server to decide which VLAN
165239beb93cSSam Leffler# is used for the stations. This information is parsed from following RADIUS
165339beb93cSSam Leffler# attributes based on RFC 3580 and RFC 2868: Tunnel-Type (value 13 = VLAN),
165439beb93cSSam Leffler# Tunnel-Medium-Type (value 6 = IEEE 802), Tunnel-Private-Group-ID (value
16555b9c547cSRui Paulo# VLANID as a string). Optionally, the local MAC ACL list (accept_mac_file) can
16565b9c547cSRui Paulo# be used to set static client MAC address to VLAN ID mapping.
16574bc52338SCy Schubert# Dynamic VLAN mode is also used with VLAN ID assignment based on WPA/WPA2
16584bc52338SCy Schubert# passphrase from wpa_psk_file or vlan_id parameter from sae_password.
16594bc52338SCy Schubert# 0 = disabled (default); only VLAN IDs from accept_mac_file will be used
16604bc52338SCy Schubert# 1 = optional; use default interface if RADIUS server does not include VLAN ID
166139beb93cSSam Leffler# 2 = required; reject authentication if RADIUS server does not include VLAN ID
166239beb93cSSam Leffler#dynamic_vlan=0
166339beb93cSSam Leffler
1664780fb4a2SCy Schubert# Per-Station AP_VLAN interface mode
1665780fb4a2SCy Schubert# If enabled, each station is assigned its own AP_VLAN interface.
1666780fb4a2SCy Schubert# This implies per-station group keying and ebtables filtering of inter-STA
1667780fb4a2SCy Schubert# traffic (when passed through the AP).
1668780fb4a2SCy Schubert# If the sta is not assigned to any VLAN, then its AP_VLAN interface will be
1669780fb4a2SCy Schubert# added to the bridge given by the "bridge" configuration option (see above).
1670780fb4a2SCy Schubert# Otherwise, it will be added to the per-VLAN bridge.
1671780fb4a2SCy Schubert# 0 = disabled (default)
1672780fb4a2SCy Schubert# 1 = enabled
1673780fb4a2SCy Schubert#per_sta_vif=0
1674780fb4a2SCy Schubert
167539beb93cSSam Leffler# VLAN interface list for dynamic VLAN mode is read from a separate text file.
167639beb93cSSam Leffler# This list is used to map VLAN ID from the RADIUS server to a network
167739beb93cSSam Leffler# interface. Each station is bound to one interface in the same way as with
167839beb93cSSam Leffler# multiple BSSIDs or SSIDs. Each line in this text file is defining a new
167939beb93cSSam Leffler# interface and the line must include VLAN ID and interface name separated by
168039beb93cSSam Leffler# white space (space or tab).
16815b9c547cSRui Paulo# If no entries are provided by this file, the station is statically mapped
16825b9c547cSRui Paulo# to <bss-iface>.<vlan-id> interfaces.
16834bc52338SCy Schubert# Each line can optionally also contain the name of a bridge to add the VLAN to
168439beb93cSSam Leffler#vlan_file=/etc/hostapd.vlan
168539beb93cSSam Leffler
168639beb93cSSam Leffler# Interface where 802.1q tagged packets should appear when a RADIUS server is
168739beb93cSSam Leffler# used to determine which VLAN a station is on.  hostapd creates a bridge for
168839beb93cSSam Leffler# each VLAN.  Then hostapd adds a VLAN interface (associated with the interface
168939beb93cSSam Leffler# indicated by 'vlan_tagged_interface') and the appropriate wireless interface
169039beb93cSSam Leffler# to the bridge.
169139beb93cSSam Leffler#vlan_tagged_interface=eth0
169239beb93cSSam Leffler
16935b9c547cSRui Paulo# Bridge (prefix) to add the wifi and the tagged interface to. This gets the
16945b9c547cSRui Paulo# VLAN ID appended. It defaults to brvlan%d if no tagged interface is given
16955b9c547cSRui Paulo# and br%s.%d if a tagged interface is given, provided %s = tagged interface
16965b9c547cSRui Paulo# and %d = VLAN ID.
16975b9c547cSRui Paulo#vlan_bridge=brvlan
16985b9c547cSRui Paulo
1699f05cddf9SRui Paulo# When hostapd creates a VLAN interface on vlan_tagged_interfaces, it needs
1700f05cddf9SRui Paulo# to know how to name it.
1701f05cddf9SRui Paulo# 0 = vlan<XXX>, e.g., vlan1
1702f05cddf9SRui Paulo# 1 = <vlan_tagged_interface>.<XXX>, e.g. eth0.1
1703f05cddf9SRui Paulo#vlan_naming=0
1704f05cddf9SRui Paulo
1705f05cddf9SRui Paulo# Arbitrary RADIUS attributes can be added into Access-Request and
1706f05cddf9SRui Paulo# Accounting-Request packets by specifying the contents of the attributes with
1707f05cddf9SRui Paulo# the following configuration parameters. There can be multiple of these to
1708f05cddf9SRui Paulo# add multiple attributes. These parameters can also be used to override some
1709f05cddf9SRui Paulo# of the attributes added automatically by hostapd.
1710f05cddf9SRui Paulo# Format: <attr_id>[:<syntax:value>]
1711f05cddf9SRui Paulo# attr_id: RADIUS attribute type (e.g., 26 = Vendor-Specific)
1712f05cddf9SRui Paulo# syntax: s = string (UTF-8), d = integer, x = octet string
1713f05cddf9SRui Paulo# value: attribute value in format indicated by the syntax
1714f05cddf9SRui Paulo# If syntax and value parts are omitted, a null value (single 0x00 octet) is
1715f05cddf9SRui Paulo# used.
1716f05cddf9SRui Paulo#
1717f05cddf9SRui Paulo# Additional Access-Request attributes
1718f05cddf9SRui Paulo# radius_auth_req_attr=<attr_id>[:<syntax:value>]
1719f05cddf9SRui Paulo# Examples:
1720f05cddf9SRui Paulo# Operator-Name = "Operator"
1721f05cddf9SRui Paulo#radius_auth_req_attr=126:s:Operator
1722f05cddf9SRui Paulo# Service-Type = Framed (2)
1723f05cddf9SRui Paulo#radius_auth_req_attr=6:d:2
1724f05cddf9SRui Paulo# Connect-Info = "testing" (this overrides the automatically generated value)
1725f05cddf9SRui Paulo#radius_auth_req_attr=77:s:testing
1726f05cddf9SRui Paulo# Same Connect-Info value set as a hexdump
1727f05cddf9SRui Paulo#radius_auth_req_attr=77:x:74657374696e67
1728f05cddf9SRui Paulo
1729f05cddf9SRui Paulo#
1730f05cddf9SRui Paulo# Additional Accounting-Request attributes
1731f05cddf9SRui Paulo# radius_acct_req_attr=<attr_id>[:<syntax:value>]
1732f05cddf9SRui Paulo# Examples:
1733f05cddf9SRui Paulo# Operator-Name = "Operator"
1734f05cddf9SRui Paulo#radius_acct_req_attr=126:s:Operator
1735f05cddf9SRui Paulo
1736206b73d0SCy Schubert# If SQLite support is included, path to a database from which additional
1737206b73d0SCy Schubert# RADIUS request attributes are extracted based on the station MAC address.
1738206b73d0SCy Schubert#
1739206b73d0SCy Schubert# The schema for the radius_attributes table is:
1740206b73d0SCy Schubert# id | sta | reqtype | attr   :   multi-key (sta, reqtype)
1741206b73d0SCy Schubert# id   = autonumber
1742206b73d0SCy Schubert# sta  = station MAC address in `11:22:33:44:55:66` format.
1743206b73d0SCy Schubert# type = `auth` | `acct` | NULL (match any)
1744206b73d0SCy Schubert# attr = existing config file format, e.g. `126:s:Test Operator`
1745206b73d0SCy Schubert#radius_req_attr_sqlite=radius_attr.sqlite
1746206b73d0SCy Schubert
1747f05cddf9SRui Paulo# Dynamic Authorization Extensions (RFC 5176)
1748f05cddf9SRui Paulo# This mechanism can be used to allow dynamic changes to user session based on
1749f05cddf9SRui Paulo# commands from a RADIUS server (or some other disconnect client that has the
1750f05cddf9SRui Paulo# needed session information). For example, Disconnect message can be used to
1751f05cddf9SRui Paulo# request an associated station to be disconnected.
1752f05cddf9SRui Paulo#
1753f05cddf9SRui Paulo# This is disabled by default. Set radius_das_port to non-zero UDP port
1754f05cddf9SRui Paulo# number to enable.
1755f05cddf9SRui Paulo#radius_das_port=3799
1756f05cddf9SRui Paulo#
1757f05cddf9SRui Paulo# DAS client (the host that can send Disconnect/CoA requests) and shared secret
175885732ac8SCy Schubert# Format: <IP address> <shared secret>
175985732ac8SCy Schubert# IP address 0.0.0.0 can be used to allow requests from any address.
1760f05cddf9SRui Paulo#radius_das_client=192.168.1.123 shared secret here
1761f05cddf9SRui Paulo#
1762f05cddf9SRui Paulo# DAS Event-Timestamp time window in seconds
1763f05cddf9SRui Paulo#radius_das_time_window=300
1764f05cddf9SRui Paulo#
1765f05cddf9SRui Paulo# DAS require Event-Timestamp
1766f05cddf9SRui Paulo#radius_das_require_event_timestamp=1
1767780fb4a2SCy Schubert#
1768780fb4a2SCy Schubert# DAS require Message-Authenticator
1769780fb4a2SCy Schubert#radius_das_require_message_authenticator=1
177039beb93cSSam Leffler
177139beb93cSSam Leffler##### RADIUS authentication server configuration ##############################
177239beb93cSSam Leffler
177339beb93cSSam Leffler# hostapd can be used as a RADIUS authentication server for other hosts. This
177439beb93cSSam Leffler# requires that the integrated EAP server is also enabled and both
177539beb93cSSam Leffler# authentication services are sharing the same configuration.
177639beb93cSSam Leffler
177739beb93cSSam Leffler# File name of the RADIUS clients configuration for the RADIUS server. If this
177839beb93cSSam Leffler# commented out, RADIUS server is disabled.
177939beb93cSSam Leffler#radius_server_clients=/etc/hostapd.radius_clients
178039beb93cSSam Leffler
178139beb93cSSam Leffler# The UDP port number for the RADIUS authentication server
178239beb93cSSam Leffler#radius_server_auth_port=1812
178339beb93cSSam Leffler
17845b9c547cSRui Paulo# The UDP port number for the RADIUS accounting server
17855b9c547cSRui Paulo# Commenting this out or setting this to 0 can be used to disable RADIUS
17865b9c547cSRui Paulo# accounting while still enabling RADIUS authentication.
17875b9c547cSRui Paulo#radius_server_acct_port=1813
17885b9c547cSRui Paulo
178939beb93cSSam Leffler# Use IPv6 with RADIUS server (IPv4 will also be supported using IPv6 API)
179039beb93cSSam Leffler#radius_server_ipv6=1
179139beb93cSSam Leffler
179239beb93cSSam Leffler
179339beb93cSSam Leffler##### WPA/IEEE 802.11i configuration ##########################################
179439beb93cSSam Leffler
179539beb93cSSam Leffler# Enable WPA. Setting this variable configures the AP to require WPA (either
179639beb93cSSam Leffler# WPA-PSK or WPA-RADIUS/EAP based on other configuration). For WPA-PSK, either
179739beb93cSSam Leffler# wpa_psk or wpa_passphrase must be set and wpa_key_mgmt must include WPA-PSK.
1798f05cddf9SRui Paulo# Instead of wpa_psk / wpa_passphrase, wpa_psk_radius might suffice.
179939beb93cSSam Leffler# For WPA-RADIUS/EAP, ieee8021x must be set (but without dynamic WEP keys),
180039beb93cSSam Leffler# RADIUS authentication server must be configured, and WPA-EAP must be included
180139beb93cSSam Leffler# in wpa_key_mgmt.
180239beb93cSSam Leffler# This field is a bit field that can be used to enable WPA (IEEE 802.11i/D3.0)
180339beb93cSSam Leffler# and/or WPA2 (full IEEE 802.11i/RSN):
180439beb93cSSam Leffler# bit0 = WPA
180539beb93cSSam Leffler# bit1 = IEEE 802.11i/RSN (WPA2) (dot11RSNAEnabled)
180685732ac8SCy Schubert# Note that WPA3 is also configured with bit1 since it uses RSN just like WPA2.
180785732ac8SCy Schubert# In other words, for WPA3, wpa=2 is used the configuration (and
180885732ac8SCy Schubert# wpa_key_mgmt=SAE for WPA3-Personal instead of wpa_key_mgmt=WPA-PSK).
180985732ac8SCy Schubert#wpa=2
181039beb93cSSam Leffler
1811c1d255d3SCy Schubert# Extended Key ID support for Individually Addressed frames
1812c1d255d3SCy Schubert#
1813c1d255d3SCy Schubert# Extended Key ID allows to rekey PTK keys without the impacts the "normal"
1814c1d255d3SCy Schubert# PTK rekeying with only a single Key ID 0 has. It can only be used when the
1815c1d255d3SCy Schubert# driver supports it and RSN/WPA2 is used with a CCMP/GCMP pairwise cipher.
1816c1d255d3SCy Schubert#
1817c1d255d3SCy Schubert# 0 = force off, i.e., use only Key ID 0 (default)
1818c1d255d3SCy Schubert# 1 = enable and use Extended Key ID support when possible
1819c1d255d3SCy Schubert# 2 = identical to 1 but start with Key ID 1 when possible
1820c1d255d3SCy Schubert#extended_key_id=0
1821c1d255d3SCy Schubert
182239beb93cSSam Leffler# WPA pre-shared keys for WPA-PSK. This can be either entered as a 256-bit
182339beb93cSSam Leffler# secret in hex format (64 hex digits), wpa_psk, or as an ASCII passphrase
182439beb93cSSam Leffler# (8..63 characters) that will be converted to PSK. This conversion uses SSID
182539beb93cSSam Leffler# so the PSK changes when ASCII passphrase is used and the SSID is changed.
182639beb93cSSam Leffler# wpa_psk (dot11RSNAConfigPSKValue)
182739beb93cSSam Leffler# wpa_passphrase (dot11RSNAConfigPSKPassPhrase)
182839beb93cSSam Leffler#wpa_psk=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
182939beb93cSSam Leffler#wpa_passphrase=secret passphrase
183039beb93cSSam Leffler
183139beb93cSSam Leffler# Optionally, WPA PSKs can be read from a separate text file (containing list
183239beb93cSSam Leffler# of (PSK,MAC address) pairs. This allows more than one PSK to be configured.
183339beb93cSSam Leffler# Use absolute path name to make sure that the files can be read on SIGHUP
183439beb93cSSam Leffler# configuration reloads.
183539beb93cSSam Leffler#wpa_psk_file=/etc/hostapd.wpa_psk
183639beb93cSSam Leffler
1837f05cddf9SRui Paulo# Optionally, WPA passphrase can be received from RADIUS authentication server
1838*a90b9d01SCy Schubert# This requires macaddr_acl to be set to 2 (RADIUS) for wpa_psk_radius values
1839*a90b9d01SCy Schubert# 1 and 2.
1840f05cddf9SRui Paulo# 0 = disabled (default)
1841f05cddf9SRui Paulo# 1 = optional; use default passphrase/psk if RADIUS server does not include
1842f05cddf9SRui Paulo#	Tunnel-Password
1843f05cddf9SRui Paulo# 2 = required; reject authentication if RADIUS server does not include
1844f05cddf9SRui Paulo#	Tunnel-Password
1845*a90b9d01SCy Schubert# 3 = ask RADIUS server during 4-way handshake if there is no locally
1846*a90b9d01SCy Schubert#	configured PSK/passphrase for the STA
1847*a90b9d01SCy Schubert#
1848*a90b9d01SCy Schubert# The Tunnel-Password attribute in Access-Accept can contain either the
1849*a90b9d01SCy Schubert# 8..63 character ASCII passphrase or a 64 hex character encoding of the PSK.
1850*a90b9d01SCy Schubert#
1851f05cddf9SRui Paulo#wpa_psk_radius=0
1852f05cddf9SRui Paulo
185339beb93cSSam Leffler# Set of accepted key management algorithms (WPA-PSK, WPA-EAP, or both). The
185439beb93cSSam Leffler# entries are separated with a space. WPA-PSK-SHA256 and WPA-EAP-SHA256 can be
185539beb93cSSam Leffler# added to enable SHA256-based stronger algorithms.
185685732ac8SCy Schubert# WPA-PSK = WPA-Personal / WPA2-Personal
185785732ac8SCy Schubert# WPA-PSK-SHA256 = WPA2-Personal using SHA256
185885732ac8SCy Schubert# WPA-EAP = WPA-Enterprise / WPA2-Enterprise
185985732ac8SCy Schubert# WPA-EAP-SHA256 = WPA2-Enterprise using SHA256
186085732ac8SCy Schubert# SAE = SAE (WPA3-Personal)
186185732ac8SCy Schubert# WPA-EAP-SUITE-B-192 = WPA3-Enterprise with 192-bit security/CNSA suite
186285732ac8SCy Schubert# FT-PSK = FT with passphrase/PSK
186385732ac8SCy Schubert# FT-EAP = FT with EAP
186485732ac8SCy Schubert# FT-EAP-SHA384 = FT with EAP using SHA384
186585732ac8SCy Schubert# FT-SAE = FT with SAE
186685732ac8SCy Schubert# FILS-SHA256 = Fast Initial Link Setup with SHA256
186785732ac8SCy Schubert# FILS-SHA384 = Fast Initial Link Setup with SHA384
186885732ac8SCy Schubert# FT-FILS-SHA256 = FT and Fast Initial Link Setup with SHA256
186985732ac8SCy Schubert# FT-FILS-SHA384 = FT and Fast Initial Link Setup with SHA384
187085732ac8SCy Schubert# OWE = Opportunistic Wireless Encryption (a.k.a. Enhanced Open)
187185732ac8SCy Schubert# DPP = Device Provisioning Protocol
187285732ac8SCy Schubert# OSEN = Hotspot 2.0 online signup with encryption
187339beb93cSSam Leffler# (dot11RSNAConfigAuthenticationSuitesTable)
187439beb93cSSam Leffler#wpa_key_mgmt=WPA-PSK WPA-EAP
187539beb93cSSam Leffler
187639beb93cSSam Leffler# Set of accepted cipher suites (encryption algorithms) for pairwise keys
187739beb93cSSam Leffler# (unicast packets). This is a space separated list of algorithms:
187885732ac8SCy Schubert# CCMP = AES in Counter mode with CBC-MAC (CCMP-128)
187985732ac8SCy Schubert# TKIP = Temporal Key Integrity Protocol
188085732ac8SCy Schubert# CCMP-256 = AES in Counter mode with CBC-MAC with 256-bit key
188185732ac8SCy Schubert# GCMP = Galois/counter mode protocol (GCMP-128)
188285732ac8SCy Schubert# GCMP-256 = Galois/counter mode protocol with 256-bit key
188339beb93cSSam Leffler# Group cipher suite (encryption algorithm for broadcast and multicast frames)
188439beb93cSSam Leffler# is automatically selected based on this configuration. If only CCMP is
188539beb93cSSam Leffler# allowed as the pairwise cipher, group cipher will also be CCMP. Otherwise,
188685732ac8SCy Schubert# TKIP will be used as the group cipher. The optional group_cipher parameter can
188785732ac8SCy Schubert# be used to override this automatic selection.
188885732ac8SCy Schubert#
188939beb93cSSam Leffler# (dot11RSNAConfigPairwiseCiphersTable)
189039beb93cSSam Leffler# Pairwise cipher for WPA (v1) (default: TKIP)
189139beb93cSSam Leffler#wpa_pairwise=TKIP CCMP
189239beb93cSSam Leffler# Pairwise cipher for RSN/WPA2 (default: use wpa_pairwise value)
189339beb93cSSam Leffler#rsn_pairwise=CCMP
189439beb93cSSam Leffler
189585732ac8SCy Schubert# Optional override for automatic group cipher selection
189685732ac8SCy Schubert# This can be used to select a specific group cipher regardless of which
189785732ac8SCy Schubert# pairwise ciphers were enabled for WPA and RSN. It should be noted that
189885732ac8SCy Schubert# overriding the group cipher with an unexpected value can result in
189985732ac8SCy Schubert# interoperability issues and in general, this parameter is mainly used for
190085732ac8SCy Schubert# testing purposes.
190185732ac8SCy Schubert#group_cipher=CCMP
190285732ac8SCy Schubert
190339beb93cSSam Leffler# Time interval for rekeying GTK (broadcast/multicast encryption keys) in
190439beb93cSSam Leffler# seconds. (dot11RSNAConfigGroupRekeyTime)
190585732ac8SCy Schubert# This defaults to 86400 seconds (once per day) when using CCMP/GCMP as the
190685732ac8SCy Schubert# group cipher and 600 seconds (once per 10 minutes) when using TKIP as the
190785732ac8SCy Schubert# group cipher.
190885732ac8SCy Schubert#wpa_group_rekey=86400
190939beb93cSSam Leffler
191039beb93cSSam Leffler# Rekey GTK when any STA that possesses the current GTK is leaving the BSS.
191139beb93cSSam Leffler# (dot11RSNAConfigGroupRekeyStrict)
191239beb93cSSam Leffler#wpa_strict_rekey=1
191339beb93cSSam Leffler
191485732ac8SCy Schubert# The number of times EAPOL-Key Message 1/2 in the RSN Group Key Handshake is
191585732ac8SCy Schubert#retried per GTK Handshake attempt. (dot11RSNAConfigGroupUpdateCount)
191685732ac8SCy Schubert# This value should only be increased when stations are constantly
191785732ac8SCy Schubert# deauthenticated during GTK rekeying with the log message
191885732ac8SCy Schubert# "group key handshake failed...".
191985732ac8SCy Schubert# You should consider to also increase wpa_pairwise_update_count then.
192085732ac8SCy Schubert# Range 1..4294967295; default: 4
192185732ac8SCy Schubert#wpa_group_update_count=4
192285732ac8SCy Schubert
192339beb93cSSam Leffler# Time interval for rekeying GMK (master key used internally to generate GTKs
192439beb93cSSam Leffler# (in seconds).
192539beb93cSSam Leffler#wpa_gmk_rekey=86400
192639beb93cSSam Leffler
192739beb93cSSam Leffler# Maximum lifetime for PTK in seconds. This can be used to enforce rekeying of
192839beb93cSSam Leffler# PTK to mitigate some attacks against TKIP deficiencies.
1929c1d255d3SCy Schubert# Warning: PTK rekeying is buggy with many drivers/devices and with such
1930c1d255d3SCy Schubert# devices, the only secure method to rekey the PTK without Extended Key ID
1931c1d255d3SCy Schubert# support requires a disconnection. Check the related parameter
1932c1d255d3SCy Schubert# wpa_deny_ptk0_rekey for details.
193339beb93cSSam Leffler#wpa_ptk_rekey=600
193439beb93cSSam Leffler
1935c1d255d3SCy Schubert# Workaround for PTK rekey issues
1936c1d255d3SCy Schubert#
1937c1d255d3SCy Schubert# PTK0 rekeys (rekeying the PTK without "Extended Key ID for Individually
1938c1d255d3SCy Schubert# Addressed Frames") can degrade the security and stability with some cards.
1939c1d255d3SCy Schubert# To avoid such issues hostapd can replace those PTK rekeys (including EAP
1940c1d255d3SCy Schubert# reauthentications) with disconnects.
1941c1d255d3SCy Schubert#
1942c1d255d3SCy Schubert# Available options:
1943c1d255d3SCy Schubert# 0 = always rekey when configured/instructed (default)
1944c1d255d3SCy Schubert# 1 = only rekey when the local driver is explicitly indicating it can perform
1945c1d255d3SCy Schubert#	this operation without issues
1946c1d255d3SCy Schubert# 2 = never allow PTK0 rekeys
1947c1d255d3SCy Schubert#wpa_deny_ptk0_rekey=0
1948c1d255d3SCy Schubert
194985732ac8SCy Schubert# The number of times EAPOL-Key Message 1/4 and Message 3/4 in the RSN 4-Way
195085732ac8SCy Schubert# Handshake are retried per 4-Way Handshake attempt.
195185732ac8SCy Schubert# (dot11RSNAConfigPairwiseUpdateCount)
195285732ac8SCy Schubert# Range 1..4294967295; default: 4
195385732ac8SCy Schubert#wpa_pairwise_update_count=4
195485732ac8SCy Schubert
195585732ac8SCy Schubert# Workaround for key reinstallation attacks
195685732ac8SCy Schubert#
195785732ac8SCy Schubert# This parameter can be used to disable retransmission of EAPOL-Key frames that
195885732ac8SCy Schubert# are used to install keys (EAPOL-Key message 3/4 and group message 1/2). This
195985732ac8SCy Schubert# is similar to setting wpa_group_update_count=1 and
196085732ac8SCy Schubert# wpa_pairwise_update_count=1, but with no impact to message 1/4 and with
196185732ac8SCy Schubert# extended timeout on the response to avoid causing issues with stations that
196285732ac8SCy Schubert# may use aggressive power saving have very long time in replying to the
196385732ac8SCy Schubert# EAPOL-Key messages.
196485732ac8SCy Schubert#
196585732ac8SCy Schubert# This option can be used to work around key reinstallation attacks on the
196685732ac8SCy Schubert# station (supplicant) side in cases those station devices cannot be updated
196785732ac8SCy Schubert# for some reason. By removing the retransmissions the attacker cannot cause
196885732ac8SCy Schubert# key reinstallation with a delayed frame transmission. This is related to the
196985732ac8SCy Schubert# station side vulnerabilities CVE-2017-13077, CVE-2017-13078, CVE-2017-13079,
197085732ac8SCy Schubert# CVE-2017-13080, and CVE-2017-13081.
197185732ac8SCy Schubert#
197285732ac8SCy Schubert# This workaround might cause interoperability issues and reduced robustness of
197385732ac8SCy Schubert# key negotiation especially in environments with heavy traffic load due to the
197485732ac8SCy Schubert# number of attempts to perform the key exchange is reduced significantly. As
197585732ac8SCy Schubert# such, this workaround is disabled by default (unless overridden in build
197685732ac8SCy Schubert# configuration). To enable this, set the parameter to 1.
197785732ac8SCy Schubert#wpa_disable_eapol_key_retries=1
197885732ac8SCy Schubert
197939beb93cSSam Leffler# Enable IEEE 802.11i/RSN/WPA2 pre-authentication. This is used to speed up
198039beb93cSSam Leffler# roaming be pre-authenticating IEEE 802.1X/EAP part of the full RSN
198139beb93cSSam Leffler# authentication and key handshake before actually associating with a new AP.
198239beb93cSSam Leffler# (dot11RSNAPreauthenticationEnabled)
198339beb93cSSam Leffler#rsn_preauth=1
198439beb93cSSam Leffler#
198539beb93cSSam Leffler# Space separated list of interfaces from which pre-authentication frames are
198639beb93cSSam Leffler# accepted (e.g., 'eth0' or 'eth0 wlan0wds0'. This list should include all
198739beb93cSSam Leffler# interface that are used for connections to other APs. This could include
198839beb93cSSam Leffler# wired interfaces and WDS links. The normal wireless data interface towards
198939beb93cSSam Leffler# associated stations (e.g., wlan0) should not be added, since
199039beb93cSSam Leffler# pre-authentication is only used with APs other than the currently associated
199139beb93cSSam Leffler# one.
199239beb93cSSam Leffler#rsn_preauth_interfaces=eth0
199339beb93cSSam Leffler
199439beb93cSSam Leffler# ieee80211w: Whether management frame protection (MFP) is enabled
199539beb93cSSam Leffler# 0 = disabled (default)
199639beb93cSSam Leffler# 1 = optional
199739beb93cSSam Leffler# 2 = required
199839beb93cSSam Leffler#ieee80211w=0
1999c1d255d3SCy Schubert# The most common configuration options for this based on the PMF (protected
2000c1d255d3SCy Schubert# management frames) certification program are:
2001c1d255d3SCy Schubert# PMF enabled: ieee80211w=1 and wpa_key_mgmt=WPA-EAP WPA-EAP-SHA256
2002c1d255d3SCy Schubert# PMF required: ieee80211w=2 and wpa_key_mgmt=WPA-EAP-SHA256
2003c1d255d3SCy Schubert# (and similarly for WPA-PSK and WPA-PSK-SHA256 if WPA2-Personal is used)
2004c1d255d3SCy Schubert# WPA3-Personal-only mode: ieee80211w=2 and wpa_key_mgmt=SAE
200539beb93cSSam Leffler
20065b9c547cSRui Paulo# Group management cipher suite
20075b9c547cSRui Paulo# Default: AES-128-CMAC (BIP)
20085b9c547cSRui Paulo# Other options (depending on driver support):
20095b9c547cSRui Paulo# BIP-GMAC-128
20105b9c547cSRui Paulo# BIP-GMAC-256
20115b9c547cSRui Paulo# BIP-CMAC-256
20125b9c547cSRui Paulo# Note: All the stations connecting to the BSS will also need to support the
20135b9c547cSRui Paulo# selected cipher. The default AES-128-CMAC is the only option that is commonly
20145b9c547cSRui Paulo# available in deployed devices.
20155b9c547cSRui Paulo#group_mgmt_cipher=AES-128-CMAC
20165b9c547cSRui Paulo
2017c1d255d3SCy Schubert# Beacon Protection (management frame protection for Beacon frames)
2018c1d255d3SCy Schubert# This depends on management frame protection being enabled (ieee80211w != 0)
2019c1d255d3SCy Schubert# and beacon protection support indication from the driver.
2020c1d255d3SCy Schubert# 0 = disabled (default)
2021c1d255d3SCy Schubert# 1 = enabled
2022c1d255d3SCy Schubert#beacon_prot=0
2023c1d255d3SCy Schubert
202439beb93cSSam Leffler# Association SA Query maximum timeout (in TU = 1.024 ms; for MFP)
202539beb93cSSam Leffler# (maximum time to wait for a SA Query response)
202639beb93cSSam Leffler# dot11AssociationSAQueryMaximumTimeout, 1...4294967295
202739beb93cSSam Leffler#assoc_sa_query_max_timeout=1000
202839beb93cSSam Leffler
202939beb93cSSam Leffler# Association SA Query retry timeout (in TU = 1.024 ms; for MFP)
203039beb93cSSam Leffler# (time between two subsequent SA Query requests)
203139beb93cSSam Leffler# dot11AssociationSAQueryRetryTimeout, 1...4294967295
203239beb93cSSam Leffler#assoc_sa_query_retry_timeout=201
203339beb93cSSam Leffler
20344bc52338SCy Schubert# ocv: Operating Channel Validation
20354b72b91aSCy Schubert# This is a countermeasure against multi-channel on-path attacks.
2036c1d255d3SCy Schubert# Enabling this depends on the driver's support for OCV when the driver SME is
2037c1d255d3SCy Schubert# used. If hostapd SME is used, this will be enabled just based on this
2038c1d255d3SCy Schubert# configuration.
20394bc52338SCy Schubert# Enabling this automatically also enables ieee80211w, if not yet enabled.
20404bc52338SCy Schubert# 0 = disabled (default)
20414bc52338SCy Schubert# 1 = enabled
2042c1d255d3SCy Schubert# 2 = enabled in workaround mode - Allow STA that claims OCV capability to
2043c1d255d3SCy Schubert#     connect even if the STA doesn't send OCI or negotiate PMF. This
2044c1d255d3SCy Schubert#     workaround is to improve interoperability with legacy STAs which are
2045c1d255d3SCy Schubert#     wrongly copying reserved bits of RSN capabilities from the AP's
2046c1d255d3SCy Schubert#     RSNE into (Re)Association Request frames. When this configuration is
2047c1d255d3SCy Schubert#     enabled, the AP considers STA is OCV capable only when the STA indicates
2048c1d255d3SCy Schubert#     MFP capability in (Re)Association Request frames and sends OCI in
2049c1d255d3SCy Schubert#     EAPOL-Key msg 2/4/FT Reassociation Request frame/FILS (Re)Association
2050c1d255d3SCy Schubert#     Request frame; otherwise, the AP disables OCV for the current connection
2051c1d255d3SCy Schubert#     with the STA. Enabling this workaround mode reduced OCV protection to
2052c1d255d3SCy Schubert#     some extend since it allows misbehavior to go through. As such, this
2053c1d255d3SCy Schubert#     should be enabled only if interoperability with misbehaving STAs is
2054c1d255d3SCy Schubert#     needed.
20554bc52338SCy Schubert#ocv=1
20564bc52338SCy Schubert
2057f05cddf9SRui Paulo# disable_pmksa_caching: Disable PMKSA caching
2058f05cddf9SRui Paulo# This parameter can be used to disable caching of PMKSA created through EAP
2059f05cddf9SRui Paulo# authentication. RSN preauthentication may still end up using PMKSA caching if
2060f05cddf9SRui Paulo# it is enabled (rsn_preauth=1).
2061f05cddf9SRui Paulo# 0 = PMKSA caching enabled (default)
2062f05cddf9SRui Paulo# 1 = PMKSA caching disabled
2063f05cddf9SRui Paulo#disable_pmksa_caching=0
206439beb93cSSam Leffler
206539beb93cSSam Leffler# okc: Opportunistic Key Caching (aka Proactive Key Caching)
206639beb93cSSam Leffler# Allow PMK cache to be shared opportunistically among configured interfaces
206739beb93cSSam Leffler# and BSSes (i.e., all configurations within a single hostapd process).
206839beb93cSSam Leffler# 0 = disabled (default)
206939beb93cSSam Leffler# 1 = enabled
207039beb93cSSam Leffler#okc=1
207139beb93cSSam Leffler
207285732ac8SCy Schubert# SAE password
207385732ac8SCy Schubert# This parameter can be used to set passwords for SAE. By default, the
207485732ac8SCy Schubert# wpa_passphrase value is used if this separate parameter is not used, but
207585732ac8SCy Schubert# wpa_passphrase follows the WPA-PSK constraints (8..63 characters) even though
207685732ac8SCy Schubert# SAE passwords do not have such constraints. If the BSS enabled both SAE and
207785732ac8SCy Schubert# WPA-PSK and both values are set, SAE uses the sae_password values and WPA-PSK
207885732ac8SCy Schubert# uses the wpa_passphrase value.
207985732ac8SCy Schubert#
208085732ac8SCy Schubert# Each sae_password entry is added to a list of available passwords. This
208185732ac8SCy Schubert# corresponds to the dot11RSNAConfigPasswordValueEntry. sae_password value
208285732ac8SCy Schubert# starts with the password (dot11RSNAConfigPasswordCredential). That value can
208385732ac8SCy Schubert# be followed by optional peer MAC address (dot11RSNAConfigPasswordPeerMac) and
20844bc52338SCy Schubert# by optional password identifier (dot11RSNAConfigPasswordIdentifier). In
20854bc52338SCy Schubert# addition, an optional VLAN ID specification can be used to bind the station
2086c1d255d3SCy Schubert# to the specified VLAN whenever the specific SAE password entry is used.
20874bc52338SCy Schubert#
20884bc52338SCy Schubert# If the peer MAC address is not included or is set to the wildcard address
208985732ac8SCy Schubert# (ff:ff:ff:ff:ff:ff), the entry is available for any station to use. If a
209085732ac8SCy Schubert# specific peer MAC address is included, only a station with that MAC address
20914bc52338SCy Schubert# is allowed to use the entry.
20924bc52338SCy Schubert#
20934bc52338SCy Schubert# If the password identifier (with non-zero length) is included, the entry is
20944bc52338SCy Schubert# limited to be used only with that specified identifier.
20954bc52338SCy Schubert
20964bc52338SCy Schubert# The last matching (based on peer MAC address and identifier) entry is used to
20974bc52338SCy Schubert# select which password to use. Setting sae_password to an empty string has a
20984bc52338SCy Schubert# special meaning of removing all previously added entries.
20994bc52338SCy Schubert#
210085732ac8SCy Schubert# sae_password uses the following encoding:
2101c1d255d3SCy Schubert#<password/credential>[|mac=<peer mac>][|vlanid=<VLAN ID>]
2102c1d255d3SCy Schubert#[|pk=<m:ECPrivateKey-base64>][|id=<identifier>]
210385732ac8SCy Schubert# Examples:
210485732ac8SCy Schubert#sae_password=secret
210585732ac8SCy Schubert#sae_password=really secret|mac=ff:ff:ff:ff:ff:ff
210685732ac8SCy Schubert#sae_password=example secret|mac=02:03:04:05:06:07|id=pw identifier
21074bc52338SCy Schubert#sae_password=example secret|vlanid=3|id=pw identifier
2108*a90b9d01SCy Schubert#
2109*a90b9d01SCy Schubert# SAE passwords can also be read from a separate file in which each line
2110*a90b9d01SCy Schubert# contains and entry in the same format as sae_password uses.
2111*a90b9d01SCy Schubert#sae_password_file=/tc/hostapd.sae_passwords
211285732ac8SCy Schubert
21135b9c547cSRui Paulo# SAE threshold for anti-clogging mechanism (dot11RSNASAEAntiCloggingThreshold)
21145b9c547cSRui Paulo# This parameter defines how many open SAE instances can be in progress at the
21155b9c547cSRui Paulo# same time before the anti-clogging mechanism is taken into use.
2116c1d255d3SCy Schubert#sae_anti_clogging_threshold=5 (deprecated)
2117c1d255d3SCy Schubert#anti_clogging_threshold=5
21185b9c547cSRui Paulo
211985732ac8SCy Schubert# Maximum number of SAE synchronization errors (dot11RSNASAESync)
2120c1d255d3SCy Schubert# The offending SAE peer will be disconnected if more than this many
212185732ac8SCy Schubert# synchronization errors happen.
2122*a90b9d01SCy Schubert#sae_sync=3
212385732ac8SCy Schubert
21245b9c547cSRui Paulo# Enabled SAE finite cyclic groups
21255b9c547cSRui Paulo# SAE implementation are required to support group 19 (ECC group defined over a
21264bc52338SCy Schubert# 256-bit prime order field). This configuration parameter can be used to
21274bc52338SCy Schubert# specify a set of allowed groups. If not included, only the mandatory group 19
21284bc52338SCy Schubert# is enabled.
21294bc52338SCy Schubert# The group values are listed in the IANA registry:
21305b9c547cSRui Paulo# http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-9
21314bc52338SCy Schubert# Note that groups 1, 2, 5, 22, 23, and 24 should not be used in production
21324bc52338SCy Schubert# purposes due limited security (see RFC 8247). Groups that are not as strong as
21334bc52338SCy Schubert# group 19 (ECC, NIST P-256) are unlikely to be useful for production use cases
21344bc52338SCy Schubert# since all implementations are required to support group 19.
21354bc52338SCy Schubert#sae_groups=19 20 21
213639beb93cSSam Leffler
213785732ac8SCy Schubert# Require MFP for all associations using SAE
213885732ac8SCy Schubert# This parameter can be used to enforce negotiation of MFP for all associations
213985732ac8SCy Schubert# that negotiate use of SAE. This is used in cases where SAE-capable devices are
214085732ac8SCy Schubert# known to be MFP-capable and the BSS is configured with optional MFP
214185732ac8SCy Schubert# (ieee80211w=1) for legacy support. The non-SAE stations can connect without
214285732ac8SCy Schubert# MFP while SAE stations are required to negotiate MFP if sae_require_mfp=1.
214385732ac8SCy Schubert#sae_require_mfp=0
214485732ac8SCy Schubert
2145c1d255d3SCy Schubert# SAE Confirm behavior
2146c1d255d3SCy Schubert# By default, AP will send out only SAE Commit message in response to a received
2147c1d255d3SCy Schubert# SAE Commit message. This parameter can be set to 1 to override that behavior
2148c1d255d3SCy Schubert# to send both SAE Commit and SAE Confirm messages without waiting for the STA
2149c1d255d3SCy Schubert# to send its SAE Confirm message first.
2150c1d255d3SCy Schubert#sae_confirm_immediate=0
2151c1d255d3SCy Schubert
2152c1d255d3SCy Schubert# SAE mechanism for PWE derivation
2153c1d255d3SCy Schubert# 0 = hunting-and-pecking loop only (default without password identifier)
2154c1d255d3SCy Schubert# 1 = hash-to-element only (default with password identifier)
2155c1d255d3SCy Schubert# 2 = both hunting-and-pecking loop and hash-to-element enabled
2156c1d255d3SCy Schubert# Note: The default value is likely to change from 0 to 2 once the new
2157c1d255d3SCy Schubert# hash-to-element mechanism has received more interoperability testing.
2158c1d255d3SCy Schubert# When using SAE password identifier, the hash-to-element mechanism is used
2159c1d255d3SCy Schubert# regardless of the sae_pwe parameter value.
2160c1d255d3SCy Schubert#sae_pwe=0
2161c1d255d3SCy Schubert
216285732ac8SCy Schubert# FILS Cache Identifier (16-bit value in hexdump format)
216385732ac8SCy Schubert#fils_cache_id=0011
216485732ac8SCy Schubert
216585732ac8SCy Schubert# FILS Realm Information
216685732ac8SCy Schubert# One or more FILS realms need to be configured when FILS is enabled. This list
216785732ac8SCy Schubert# of realms is used to define which realms (used in keyName-NAI by the client)
216885732ac8SCy Schubert# can be used with FILS shared key authentication for ERP.
216985732ac8SCy Schubert#fils_realm=example.com
217085732ac8SCy Schubert#fils_realm=example.org
217185732ac8SCy Schubert
217285732ac8SCy Schubert# FILS DH Group for PFS
217385732ac8SCy Schubert# 0 = PFS disabled with FILS shared key authentication (default)
217485732ac8SCy Schubert# 1-65535 DH Group to use for FILS PFS
217585732ac8SCy Schubert#fils_dh_group=0
217685732ac8SCy Schubert
217785732ac8SCy Schubert# OWE DH groups
217885732ac8SCy Schubert# OWE implementations are required to support group 19 (NIST P-256). All groups
217985732ac8SCy Schubert# that are supported by the implementation (e.g., groups 19, 20, and 21 when
218085732ac8SCy Schubert# using OpenSSL) are enabled by default. This configuration parameter can be
218185732ac8SCy Schubert# used to specify a limited set of allowed groups. The group values are listed
218285732ac8SCy Schubert# in the IANA registry:
218385732ac8SCy Schubert# http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-10
218485732ac8SCy Schubert#owe_groups=19 20 21
218585732ac8SCy Schubert
2186c1d255d3SCy Schubert# OWE PTK derivation workaround
2187c1d255d3SCy Schubert# Initial OWE implementation used SHA256 when deriving the PTK for all OWE
2188c1d255d3SCy Schubert# groups. This was supposed to change to SHA384 for group 20 and SHA512 for
2189c1d255d3SCy Schubert# group 21. This parameter can be used to enable workaround for interoperability
2190c1d255d3SCy Schubert# with stations that use SHA256 with groups 20 and 21. By default (0) only the
2191c1d255d3SCy Schubert# appropriate hash function is accepted. When workaround is enabled (1), the
2192c1d255d3SCy Schubert# appropriate hash function is tried first and if that fails, SHA256-based PTK
2193c1d255d3SCy Schubert# derivation is attempted. This workaround can result in reduced security for
2194c1d255d3SCy Schubert# groups 20 and 21, but is required for interoperability with older
2195c1d255d3SCy Schubert# implementations. There is no impact to group 19 behavior. The workaround is
2196c1d255d3SCy Schubert# disabled by default and can be enabled by uncommenting the following line.
2197c1d255d3SCy Schubert#owe_ptk_workaround=1
2198c1d255d3SCy Schubert
219985732ac8SCy Schubert# OWE transition mode configuration
220085732ac8SCy Schubert# Pointer to the matching open/OWE BSS
220185732ac8SCy Schubert#owe_transition_bssid=<bssid>
220285732ac8SCy Schubert# SSID in same format as ssid2 described above.
220385732ac8SCy Schubert#owe_transition_ssid=<SSID>
220485732ac8SCy Schubert# Alternatively, OWE transition mode BSSID/SSID can be configured with a
220585732ac8SCy Schubert# reference to a BSS operated by this hostapd process.
220685732ac8SCy Schubert#owe_transition_ifname=<ifname>
220785732ac8SCy Schubert
220885732ac8SCy Schubert# DHCP server for FILS HLP
220985732ac8SCy Schubert# If configured, hostapd will act as a DHCP relay for all FILS HLP requests
221085732ac8SCy Schubert# that include a DHCPDISCOVER message and send them to the specific DHCP
221185732ac8SCy Schubert# server for processing. hostapd will then wait for a response from that server
221285732ac8SCy Schubert# before replying with (Re)Association Response frame that encapsulates this
221385732ac8SCy Schubert# DHCP response. own_ip_addr is used as the local address for the communication
221485732ac8SCy Schubert# with the DHCP server.
221585732ac8SCy Schubert#dhcp_server=127.0.0.1
221685732ac8SCy Schubert
221785732ac8SCy Schubert# DHCP server UDP port
221885732ac8SCy Schubert# Default: 67
221985732ac8SCy Schubert#dhcp_server_port=67
222085732ac8SCy Schubert
222185732ac8SCy Schubert# DHCP relay UDP port on the local device
222285732ac8SCy Schubert# Default: 67; 0 means not to bind any specific port
222385732ac8SCy Schubert#dhcp_relay_port=67
222485732ac8SCy Schubert
222585732ac8SCy Schubert# DHCP rapid commit proxy
222685732ac8SCy Schubert# If set to 1, this enables hostapd to act as a DHCP rapid commit proxy to
222785732ac8SCy Schubert# allow the rapid commit options (two message DHCP exchange) to be used with a
222885732ac8SCy Schubert# server that supports only the four message DHCP exchange. This is disabled by
222985732ac8SCy Schubert# default (= 0) and can be enabled by setting this to 1.
223085732ac8SCy Schubert#dhcp_rapid_commit_proxy=0
223185732ac8SCy Schubert
223285732ac8SCy Schubert# Wait time for FILS HLP (dot11HLPWaitTime) in TUs
223385732ac8SCy Schubert# default: 30 TUs (= 30.72 milliseconds)
223485732ac8SCy Schubert#fils_hlp_wait_time=30
223585732ac8SCy Schubert
2236c1d255d3SCy Schubert# FILS Discovery frame transmission minimum and maximum interval settings.
2237c1d255d3SCy Schubert# If fils_discovery_max_interval is non-zero, the AP enables FILS Discovery
2238c1d255d3SCy Schubert# frame transmission. These values use TUs as the unit and have allowed range
2239c1d255d3SCy Schubert# of 0-10000. fils_discovery_min_interval defaults to 20.
2240*a90b9d01SCy Schubert# This feature is currently supported only when ieee80211ax is enabled for
2241*a90b9d01SCy Schubert# the radio and disable_11ax is not set for the BSS.
2242c1d255d3SCy Schubert#fils_discovery_min_interval=20
2243c1d255d3SCy Schubert#fils_discovery_max_interval=0
2244c1d255d3SCy Schubert
2245c1d255d3SCy Schubert# Transition Disable indication
2246c1d255d3SCy Schubert# The AP can notify authenticated stations to disable transition mode in their
2247c1d255d3SCy Schubert# network profiles when the network has completed transition steps, i.e., once
2248c1d255d3SCy Schubert# sufficiently large number of APs in the ESS have been updated to support the
2249c1d255d3SCy Schubert# more secure alternative. When this indication is used, the stations are
2250c1d255d3SCy Schubert# expected to automatically disable transition mode and less secure security
2251c1d255d3SCy Schubert# options. This includes use of WEP, TKIP (including use of TKIP as the group
2252c1d255d3SCy Schubert# cipher), and connections without PMF.
2253c1d255d3SCy Schubert# Bitmap bits:
2254c1d255d3SCy Schubert# bit 0 (0x01): WPA3-Personal (i.e., disable WPA2-Personal = WPA-PSK and only
2255c1d255d3SCy Schubert#	allow SAE to be used)
2256c1d255d3SCy Schubert# bit 1 (0x02): SAE-PK (disable SAE without use of SAE-PK)
2257c1d255d3SCy Schubert# bit 2 (0x04): WPA3-Enterprise (move to requiring PMF)
2258c1d255d3SCy Schubert# bit 3 (0x08): Enhanced Open (disable use of open network; require OWE)
2259c1d255d3SCy Schubert# (default: 0 = do not include Transition Disable KDE)
2260c1d255d3SCy Schubert#transition_disable=0x01
2261c1d255d3SCy Schubert
2262c1d255d3SCy Schubert# PASN ECDH groups
2263c1d255d3SCy Schubert# PASN implementations are required to support group 19 (NIST P-256). If this
2264c1d255d3SCy Schubert# parameter is not set, only group 19 is supported by default. This
2265c1d255d3SCy Schubert# configuration parameter can be used to specify a limited set of allowed
2266c1d255d3SCy Schubert# groups. The group values are listed in the IANA registry:
2267c1d255d3SCy Schubert# http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-10
2268c1d255d3SCy Schubert#pasn_groups=19 20 21
2269c1d255d3SCy Schubert
2270c1d255d3SCy Schubert# PASN comeback after time in TUs
2271c1d255d3SCy Schubert# In case the AP is temporarily unable to handle a PASN authentication exchange
2272c1d255d3SCy Schubert# due to a too large number of parallel operations, this value indicates to the
2273c1d255d3SCy Schubert# peer after how many TUs it can try the PASN exchange again.
2274c1d255d3SCy Schubert# (default: 10 TUs)
2275c1d255d3SCy Schubert#pasn_comeback_after=10
2276c1d255d3SCy Schubert
2277*a90b9d01SCy Schubert# Unauthenticated PASN activated (dot11NoAuthPASNActivated)
2278*a90b9d01SCy Schubert# This indicates whether PASN without mutual authentication is allowed.
2279*a90b9d01SCy Schubert# (default: 1 = activated)
2280*a90b9d01SCy Schubert#pasn_noauth=1
2281*a90b9d01SCy Schubert
2282*a90b9d01SCy Schubert# SSID protection in 4-way handshake
2283*a90b9d01SCy Schubert# The IEEE 802.11i-2004 RSN design did not provide means for protecting the
2284*a90b9d01SCy Schubert# SSID in the general case. IEEE P802.11REVme/D6.0 added support for this in
2285*a90b9d01SCy Schubert# 4-way handshake. This capability allows a STA to confirm that the AP has the
2286*a90b9d01SCy Schubert# same understanding on which SSID is being used for an association in a
2287*a90b9d01SCy Schubert# protected manner in cases where both the AP and the STA has this capability.
2288*a90b9d01SCy Schubert# This can be used to mitigate CVE-2023-52424 (a.k.a. the SSID Confusion
2289*a90b9d01SCy Schubert# Attack).
2290*a90b9d01SCy Schubert#
2291*a90b9d01SCy Schubert# Ideally, this capability would be enabled by default on the AP, but since this
2292*a90b9d01SCy Schubert# is new functionality with limited testing, the default is to disable this for
2293*a90b9d01SCy Schubert# now and require explicitly configuration to enable. The default behavior is
2294*a90b9d01SCy Schubert# like to change once this capability has received more testing.
2295*a90b9d01SCy Schubert#
2296*a90b9d01SCy Schubert# 0 = SSID protection in 4-way handshake disabled (default)
2297*a90b9d01SCy Schubert# 1 = SSID protection in 4-way handshake enabled
2298*a90b9d01SCy Schubert#
2299*a90b9d01SCy Schubert#ssid_protection=0
2300*a90b9d01SCy Schubert
230139beb93cSSam Leffler##### IEEE 802.11r configuration ##############################################
230239beb93cSSam Leffler
230339beb93cSSam Leffler# Mobility Domain identifier (dot11FTMobilityDomainID, MDID)
230439beb93cSSam Leffler# MDID is used to indicate a group of APs (within an ESS, i.e., sharing the
230539beb93cSSam Leffler# same SSID) between which a STA can use Fast BSS Transition.
230639beb93cSSam Leffler# 2-octet identifier as a hex string.
230739beb93cSSam Leffler#mobility_domain=a1b2
230839beb93cSSam Leffler
230939beb93cSSam Leffler# PMK-R0 Key Holder identifier (dot11FTR0KeyHolderID)
231039beb93cSSam Leffler# 1 to 48 octet identifier.
231139beb93cSSam Leffler# This is configured with nas_identifier (see RADIUS client section above).
231239beb93cSSam Leffler
231385732ac8SCy Schubert# Default lifetime of the PMK-R0 in seconds; range 60..4294967295
231485732ac8SCy Schubert# (default: 14 days / 1209600 seconds; 0 = disable timeout)
231539beb93cSSam Leffler# (dot11FTR0KeyLifetime)
231685732ac8SCy Schubert#ft_r0_key_lifetime=1209600
231785732ac8SCy Schubert
231885732ac8SCy Schubert# Maximum lifetime for PMK-R1; applied only if not zero
231985732ac8SCy Schubert# PMK-R1 is removed at latest after this limit.
232085732ac8SCy Schubert# Removing any PMK-R1 for expiry can be disabled by setting this to -1.
232185732ac8SCy Schubert# (default: 0)
232285732ac8SCy Schubert#r1_max_key_lifetime=0
232339beb93cSSam Leffler
232439beb93cSSam Leffler# PMK-R1 Key Holder identifier (dot11FTR1KeyHolderID)
232539beb93cSSam Leffler# 6-octet identifier as a hex string.
2326780fb4a2SCy Schubert# Defaults to BSSID.
232739beb93cSSam Leffler#r1_key_holder=000102030405
232839beb93cSSam Leffler
232939beb93cSSam Leffler# Reassociation deadline in time units (TUs / 1.024 ms; range 1000..65535)
233039beb93cSSam Leffler# (dot11FTReassociationDeadline)
233139beb93cSSam Leffler#reassociation_deadline=1000
233239beb93cSSam Leffler
233339beb93cSSam Leffler# List of R0KHs in the same Mobility Domain
233485732ac8SCy Schubert# format: <MAC address> <NAS Identifier> <256-bit key as hex string>
233539beb93cSSam Leffler# This list is used to map R0KH-ID (NAS Identifier) to a destination MAC
233639beb93cSSam Leffler# address when requesting PMK-R1 key from the R0KH that the STA used during the
233739beb93cSSam Leffler# Initial Mobility Domain Association.
233885732ac8SCy Schubert#r0kh=02:01:02:03:04:05 r0kh-1.example.com 000102030405060708090a0b0c0d0e0f000102030405060708090a0b0c0d0e0f
233985732ac8SCy Schubert#r0kh=02:01:02:03:04:06 r0kh-2.example.com 00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff
234039beb93cSSam Leffler# And so on.. One line per R0KH.
234185732ac8SCy Schubert# Wildcard entry:
234285732ac8SCy Schubert# Upon receiving a response from R0KH, it will be added to this list, so
234385732ac8SCy Schubert# subsequent requests won't be broadcast. If R0KH does not reply, it will be
2344c1d255d3SCy Schubert# temporarily blocked (see rkh_neg_timeout).
234585732ac8SCy Schubert#r0kh=ff:ff:ff:ff:ff:ff * 00112233445566778899aabbccddeeff
234639beb93cSSam Leffler
234739beb93cSSam Leffler# List of R1KHs in the same Mobility Domain
234885732ac8SCy Schubert# format: <MAC address> <R1KH-ID> <256-bit key as hex string>
234939beb93cSSam Leffler# This list is used to map R1KH-ID to a destination MAC address when sending
235039beb93cSSam Leffler# PMK-R1 key from the R0KH. This is also the list of authorized R1KHs in the MD
235139beb93cSSam Leffler# that can request PMK-R1 keys.
235285732ac8SCy Schubert#r1kh=02:01:02:03:04:05 02:11:22:33:44:55 000102030405060708090a0b0c0d0e0f000102030405060708090a0b0c0d0e0f
235385732ac8SCy Schubert#r1kh=02:01:02:03:04:06 02:11:22:33:44:66 00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff
235439beb93cSSam Leffler# And so on.. One line per R1KH.
235585732ac8SCy Schubert# Wildcard entry:
235685732ac8SCy Schubert# Upon receiving a request from an R1KH not yet known, it will be added to this
235785732ac8SCy Schubert# list and thus will receive push notifications.
235885732ac8SCy Schubert#r1kh=00:00:00:00:00:00 00:00:00:00:00:00 00112233445566778899aabbccddeeff
235985732ac8SCy Schubert
2360*a90b9d01SCy Schubert# Optionally, the list of RxKHs can be read from a text file. Format is the same
2361*a90b9d01SCy Schubert# as specified above. File shall contain both r0kh and r1kh. Once this variable
2362*a90b9d01SCy Schubert# is set, RxKHs can be reloaded at runtime without bringing down an interface
2363*a90b9d01SCy Schubert# using the RELOAD_RXKHS command.
2364*a90b9d01SCy Schubert#rxkh_file=<path>
2365*a90b9d01SCy Schubert
236685732ac8SCy Schubert# Timeout (seconds) for newly discovered R0KH/R1KH (see wildcard entries above)
236785732ac8SCy Schubert# Special values: 0 -> do not expire
236885732ac8SCy Schubert# Warning: do not cache implies no sequence number validation with wildcards
236985732ac8SCy Schubert#rkh_pos_timeout=86400 (default = 1 day)
237085732ac8SCy Schubert
237185732ac8SCy Schubert# Timeout (milliseconds) for requesting PMK-R1 from R0KH using PULL request
237285732ac8SCy Schubert# and number of retries.
237385732ac8SCy Schubert#rkh_pull_timeout=1000 (default = 1 second)
237485732ac8SCy Schubert#rkh_pull_retries=4 (default)
237585732ac8SCy Schubert
237685732ac8SCy Schubert# Timeout (seconds) for non replying R0KH (see wildcard entries above)
237785732ac8SCy Schubert# Special values: 0 -> do not cache
237885732ac8SCy Schubert# default: 60 seconds
237985732ac8SCy Schubert#rkh_neg_timeout=60
238085732ac8SCy Schubert
238185732ac8SCy Schubert# Note: The R0KH/R1KH keys used to be 128-bit in length before the message
238285732ac8SCy Schubert# format was changed. That shorter key length is still supported for backwards
238385732ac8SCy Schubert# compatibility of the configuration files. If such a shorter key is used, a
238485732ac8SCy Schubert# 256-bit key is derived from it. For new deployments, configuring the 256-bit
238585732ac8SCy Schubert# key is recommended.
238639beb93cSSam Leffler
238739beb93cSSam Leffler# Whether PMK-R1 push is enabled at R0KH
238839beb93cSSam Leffler# 0 = do not push PMK-R1 to all configured R1KHs (default)
238939beb93cSSam Leffler# 1 = push PMK-R1 to all configured R1KHs whenever a new PMK-R0 is derived
239039beb93cSSam Leffler#pmk_r1_push=1
239139beb93cSSam Leffler
2392325151a3SRui Paulo# Whether to enable FT-over-DS
2393325151a3SRui Paulo# 0 = FT-over-DS disabled
2394325151a3SRui Paulo# 1 = FT-over-DS enabled (default)
2395325151a3SRui Paulo#ft_over_ds=1
2396325151a3SRui Paulo
239785732ac8SCy Schubert# Whether to generate FT response locally for PSK networks
239885732ac8SCy Schubert# This avoids use of PMK-R1 push/pull from other APs with FT-PSK networks as
239985732ac8SCy Schubert# the required information (PSK and other session data) is already locally
240085732ac8SCy Schubert# available.
240185732ac8SCy Schubert# 0 = disabled (default)
240285732ac8SCy Schubert# 1 = enabled
240385732ac8SCy Schubert#ft_psk_generate_local=0
240485732ac8SCy Schubert
2405e28a4053SRui Paulo##### Neighbor table ##########################################################
2406c1d255d3SCy Schubert# Maximum number of entries kept in AP table (either for neighbor table or for
2407e28a4053SRui Paulo# detecting Overlapping Legacy BSS Condition). The oldest entry will be
240839beb93cSSam Leffler# removed when adding a new entry that would make the list grow over this
2409e28a4053SRui Paulo# limit. Note! WFA certification for IEEE 802.11g requires that OLBC is
241039beb93cSSam Leffler# enabled, so this field should not be set to 0 when using IEEE 802.11g.
241139beb93cSSam Leffler# default: 255
241239beb93cSSam Leffler#ap_table_max_size=255
241339beb93cSSam Leffler
241439beb93cSSam Leffler# Number of seconds of no frames received after which entries may be deleted
241539beb93cSSam Leffler# from the AP table. Since passive scanning is not usually performed frequently
241639beb93cSSam Leffler# this should not be set to very small value. In addition, there is no
241739beb93cSSam Leffler# guarantee that every scan cycle will receive beacon frames from the
241839beb93cSSam Leffler# neighboring APs.
241939beb93cSSam Leffler# default: 60
242039beb93cSSam Leffler#ap_table_expiration_time=3600
242139beb93cSSam Leffler
2422325151a3SRui Paulo# Maximum number of stations to track on the operating channel
2423325151a3SRui Paulo# This can be used to detect dualband capable stations before they have
2424325151a3SRui Paulo# associated, e.g., to provide guidance on which colocated BSS to use.
2425325151a3SRui Paulo# Default: 0 (disabled)
2426325151a3SRui Paulo#track_sta_max_num=100
2427325151a3SRui Paulo
2428325151a3SRui Paulo# Maximum age of a station tracking entry in seconds
2429325151a3SRui Paulo# Default: 180
2430325151a3SRui Paulo#track_sta_max_age=180
2431325151a3SRui Paulo
2432325151a3SRui Paulo# Do not reply to group-addressed Probe Request from a station that was seen on
2433325151a3SRui Paulo# another radio.
2434325151a3SRui Paulo# Default: Disabled
2435325151a3SRui Paulo#
2436325151a3SRui Paulo# This can be used with enabled track_sta_max_num configuration on another
2437325151a3SRui Paulo# interface controlled by the same hostapd process to restrict Probe Request
2438325151a3SRui Paulo# frame handling from replying to group-addressed Probe Request frames from a
2439325151a3SRui Paulo# station that has been detected to be capable of operating on another band,
2440325151a3SRui Paulo# e.g., to try to reduce likelihood of the station selecting a 2.4 GHz BSS when
2441325151a3SRui Paulo# the AP operates both a 2.4 GHz and 5 GHz BSS concurrently.
2442325151a3SRui Paulo#
2443325151a3SRui Paulo# Note: Enabling this can cause connectivity issues and increase latency for
2444325151a3SRui Paulo# discovering the AP.
2445325151a3SRui Paulo#no_probe_resp_if_seen_on=wlan1
2446325151a3SRui Paulo
2447325151a3SRui Paulo# Reject authentication from a station that was seen on another radio.
2448325151a3SRui Paulo# Default: Disabled
2449325151a3SRui Paulo#
2450325151a3SRui Paulo# This can be used with enabled track_sta_max_num configuration on another
2451325151a3SRui Paulo# interface controlled by the same hostapd process to reject authentication
2452325151a3SRui Paulo# attempts from a station that has been detected to be capable of operating on
2453325151a3SRui Paulo# another band, e.g., to try to reduce likelihood of the station selecting a
2454325151a3SRui Paulo# 2.4 GHz BSS when the AP operates both a 2.4 GHz and 5 GHz BSS concurrently.
2455325151a3SRui Paulo#
2456325151a3SRui Paulo# Note: Enabling this can cause connectivity issues and increase latency for
2457325151a3SRui Paulo# connecting with the AP.
2458325151a3SRui Paulo#no_auth_if_seen_on=wlan1
245939beb93cSSam Leffler
246039beb93cSSam Leffler##### Wi-Fi Protected Setup (WPS) #############################################
246139beb93cSSam Leffler
246239beb93cSSam Leffler# WPS state
246339beb93cSSam Leffler# 0 = WPS disabled (default)
246439beb93cSSam Leffler# 1 = WPS enabled, not configured
246539beb93cSSam Leffler# 2 = WPS enabled, configured
246639beb93cSSam Leffler#wps_state=2
246739beb93cSSam Leffler
24685b9c547cSRui Paulo# Whether to manage this interface independently from other WPS interfaces
24695b9c547cSRui Paulo# By default, a single hostapd process applies WPS operations to all configured
24705b9c547cSRui Paulo# interfaces. This parameter can be used to disable that behavior for a subset
24715b9c547cSRui Paulo# of interfaces. If this is set to non-zero for an interface, WPS commands
24725b9c547cSRui Paulo# issued on that interface do not apply to other interfaces and WPS operations
24735b9c547cSRui Paulo# performed on other interfaces do not affect this interface.
24745b9c547cSRui Paulo#wps_independent=0
24755b9c547cSRui Paulo
247639beb93cSSam Leffler# AP can be configured into a locked state where new WPS Registrar are not
247739beb93cSSam Leffler# accepted, but previously authorized Registrars (including the internal one)
247839beb93cSSam Leffler# can continue to add new Enrollees.
247939beb93cSSam Leffler#ap_setup_locked=1
248039beb93cSSam Leffler
248139beb93cSSam Leffler# Universally Unique IDentifier (UUID; see RFC 4122) of the device
248239beb93cSSam Leffler# This value is used as the UUID for the internal WPS Registrar. If the AP
248339beb93cSSam Leffler# is also using UPnP, this value should be set to the device's UPnP UUID.
248439beb93cSSam Leffler# If not configured, UUID will be generated based on the local MAC address.
248539beb93cSSam Leffler#uuid=12345678-9abc-def0-1234-56789abcdef0
248639beb93cSSam Leffler
248739beb93cSSam Leffler# Note: If wpa_psk_file is set, WPS is used to generate random, per-device PSKs
248839beb93cSSam Leffler# that will be appended to the wpa_psk_file. If wpa_psk_file is not set, the
248939beb93cSSam Leffler# default PSK (wpa_psk/wpa_passphrase) will be delivered to Enrollees. Use of
249039beb93cSSam Leffler# per-device PSKs is recommended as the more secure option (i.e., make sure to
249139beb93cSSam Leffler# set wpa_psk_file when using WPS with WPA-PSK).
249239beb93cSSam Leffler
249339beb93cSSam Leffler# When an Enrollee requests access to the network with PIN method, the Enrollee
249439beb93cSSam Leffler# PIN will need to be entered for the Registrar. PIN request notifications are
249539beb93cSSam Leffler# sent to hostapd ctrl_iface monitor. In addition, they can be written to a
249639beb93cSSam Leffler# text file that could be used, e.g., to populate the AP administration UI with
249739beb93cSSam Leffler# pending PIN requests. If the following variable is set, the PIN requests will
249839beb93cSSam Leffler# be written to the configured file.
249939beb93cSSam Leffler#wps_pin_requests=/var/run/hostapd_wps_pin_requests
250039beb93cSSam Leffler
250139beb93cSSam Leffler# Device Name
250239beb93cSSam Leffler# User-friendly description of device; up to 32 octets encoded in UTF-8
250339beb93cSSam Leffler#device_name=Wireless AP
250439beb93cSSam Leffler
250539beb93cSSam Leffler# Manufacturer
250639beb93cSSam Leffler# The manufacturer of the device (up to 64 ASCII characters)
250739beb93cSSam Leffler#manufacturer=Company
250839beb93cSSam Leffler
250939beb93cSSam Leffler# Model Name
251039beb93cSSam Leffler# Model of the device (up to 32 ASCII characters)
251139beb93cSSam Leffler#model_name=WAP
251239beb93cSSam Leffler
251339beb93cSSam Leffler# Model Number
251439beb93cSSam Leffler# Additional device description (up to 32 ASCII characters)
251539beb93cSSam Leffler#model_number=123
251639beb93cSSam Leffler
251739beb93cSSam Leffler# Serial Number
251839beb93cSSam Leffler# Serial number of the device (up to 32 characters)
251939beb93cSSam Leffler#serial_number=12345
252039beb93cSSam Leffler
252139beb93cSSam Leffler# Primary Device Type
252239beb93cSSam Leffler# Used format: <categ>-<OUI>-<subcateg>
252339beb93cSSam Leffler# categ = Category as an integer value
252439beb93cSSam Leffler# OUI = OUI and type octet as a 4-octet hex-encoded value; 0050F204 for
252539beb93cSSam Leffler#       default WPS OUI
252639beb93cSSam Leffler# subcateg = OUI-specific Sub Category as an integer value
252739beb93cSSam Leffler# Examples:
252839beb93cSSam Leffler#   1-0050F204-1 (Computer / PC)
252939beb93cSSam Leffler#   1-0050F204-2 (Computer / Server)
253039beb93cSSam Leffler#   5-0050F204-1 (Storage / NAS)
253139beb93cSSam Leffler#   6-0050F204-1 (Network Infrastructure / AP)
253239beb93cSSam Leffler#device_type=6-0050F204-1
253339beb93cSSam Leffler
253439beb93cSSam Leffler# OS Version
253539beb93cSSam Leffler# 4-octet operating system version number (hex string)
253639beb93cSSam Leffler#os_version=01020300
253739beb93cSSam Leffler
253839beb93cSSam Leffler# Config Methods
253939beb93cSSam Leffler# List of the supported configuration methods
2540e28a4053SRui Paulo# Available methods: usba ethernet label display ext_nfc_token int_nfc_token
2541f05cddf9SRui Paulo#	nfc_interface push_button keypad virtual_display physical_display
2542f05cddf9SRui Paulo#	virtual_push_button physical_push_button
2543f05cddf9SRui Paulo#config_methods=label virtual_display virtual_push_button keypad
2544f05cddf9SRui Paulo
2545f05cddf9SRui Paulo# WPS capability discovery workaround for PBC with Windows 7
2546f05cddf9SRui Paulo# Windows 7 uses incorrect way of figuring out AP's WPS capabilities by acting
2547f05cddf9SRui Paulo# as a Registrar and using M1 from the AP. The config methods attribute in that
2548f05cddf9SRui Paulo# message is supposed to indicate only the configuration method supported by
2549f05cddf9SRui Paulo# the AP in Enrollee role, i.e., to add an external Registrar. For that case,
2550f05cddf9SRui Paulo# PBC shall not be used and as such, the PushButton config method is removed
2551f05cddf9SRui Paulo# from M1 by default. If pbc_in_m1=1 is included in the configuration file,
2552f05cddf9SRui Paulo# the PushButton config method is left in M1 (if included in config_methods
2553f05cddf9SRui Paulo# parameter) to allow Windows 7 to use PBC instead of PIN (e.g., from a label
2554f05cddf9SRui Paulo# in the AP).
2555f05cddf9SRui Paulo#pbc_in_m1=1
255639beb93cSSam Leffler
2557e28a4053SRui Paulo# Static access point PIN for initial configuration and adding Registrars
255839beb93cSSam Leffler# If not set, hostapd will not allow external WPS Registrars to control the
2559e28a4053SRui Paulo# access point. The AP PIN can also be set at runtime with hostapd_cli
2560e28a4053SRui Paulo# wps_ap_pin command. Use of temporary (enabled by user action) and random
2561e28a4053SRui Paulo# AP PIN is much more secure than configuring a static AP PIN here. As such,
2562e28a4053SRui Paulo# use of the ap_pin parameter is not recommended if the AP device has means for
2563e28a4053SRui Paulo# displaying a random PIN.
256439beb93cSSam Leffler#ap_pin=12345670
256539beb93cSSam Leffler
256639beb93cSSam Leffler# Skip building of automatic WPS credential
256739beb93cSSam Leffler# This can be used to allow the automatically generated Credential attribute to
256839beb93cSSam Leffler# be replaced with pre-configured Credential(s).
256939beb93cSSam Leffler#skip_cred_build=1
257039beb93cSSam Leffler
257139beb93cSSam Leffler# Additional Credential attribute(s)
257239beb93cSSam Leffler# This option can be used to add pre-configured Credential attributes into M8
257339beb93cSSam Leffler# message when acting as a Registrar. If skip_cred_build=1, this data will also
257439beb93cSSam Leffler# be able to override the Credential attribute that would have otherwise been
257539beb93cSSam Leffler# automatically generated based on network configuration. This configuration
257639beb93cSSam Leffler# option points to an external file that much contain the WPS Credential
257739beb93cSSam Leffler# attribute(s) as binary data.
257839beb93cSSam Leffler#extra_cred=hostapd.cred
257939beb93cSSam Leffler
258039beb93cSSam Leffler# Credential processing
258139beb93cSSam Leffler#   0 = process received credentials internally (default)
258239beb93cSSam Leffler#   1 = do not process received credentials; just pass them over ctrl_iface to
258339beb93cSSam Leffler#	external program(s)
258439beb93cSSam Leffler#   2 = process received credentials internally and pass them over ctrl_iface
258539beb93cSSam Leffler#	to external program(s)
258639beb93cSSam Leffler# Note: With wps_cred_processing=1, skip_cred_build should be set to 1 and
258739beb93cSSam Leffler# extra_cred be used to provide the Credential data for Enrollees.
258839beb93cSSam Leffler#
258939beb93cSSam Leffler# wps_cred_processing=1 will disabled automatic updates of hostapd.conf file
259039beb93cSSam Leffler# both for Credential processing and for marking AP Setup Locked based on
259139beb93cSSam Leffler# validation failures of AP PIN. An external program is responsible on updating
259239beb93cSSam Leffler# the configuration appropriately in this case.
259339beb93cSSam Leffler#wps_cred_processing=0
259439beb93cSSam Leffler
25954bc52338SCy Schubert# Whether to enable SAE (WPA3-Personal transition mode) automatically for
25964bc52338SCy Schubert# WPA2-PSK credentials received using WPS.
25974bc52338SCy Schubert# 0 = only add the explicitly listed WPA2-PSK configuration (default)
25984bc52338SCy Schubert# 1 = add both the WPA2-PSK and SAE configuration and enable PMF so that the
25994bc52338SCy Schubert#     AP gets configured in WPA3-Personal transition mode (supports both
26004bc52338SCy Schubert#     WPA2-Personal (PSK) and WPA3-Personal (SAE) clients).
26014bc52338SCy Schubert#wps_cred_add_sae=0
26024bc52338SCy Schubert
260339beb93cSSam Leffler# AP Settings Attributes for M7
260439beb93cSSam Leffler# By default, hostapd generates the AP Settings Attributes for M7 based on the
260539beb93cSSam Leffler# current configuration. It is possible to override this by providing a file
260639beb93cSSam Leffler# with pre-configured attributes. This is similar to extra_cred file format,
260739beb93cSSam Leffler# but the AP Settings attributes are not encapsulated in a Credential
260839beb93cSSam Leffler# attribute.
260939beb93cSSam Leffler#ap_settings=hostapd.ap_settings
261039beb93cSSam Leffler
26114bc52338SCy Schubert# Multi-AP backhaul BSS config
26124bc52338SCy Schubert# Used in WPS when multi_ap=2 or 3. Defines "backhaul BSS" credentials.
26134bc52338SCy Schubert# These are passed in WPS M8 instead of the normal (fronthaul) credentials
26144bc52338SCy Schubert# if the Enrollee has the Multi-AP subelement set. Backhaul SSID is formatted
26154bc52338SCy Schubert# like ssid2. The key is set like wpa_psk or wpa_passphrase.
26164bc52338SCy Schubert#multi_ap_backhaul_ssid="backhaul"
26174bc52338SCy Schubert#multi_ap_backhaul_wpa_psk=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
26184bc52338SCy Schubert#multi_ap_backhaul_wpa_passphrase=secret passphrase
26194bc52338SCy Schubert
2620*a90b9d01SCy Schubert# Multi-AP Profile
2621*a90b9d01SCy Schubert# Indicate the supported Multi-AP profile (default: 2)
2622*a90b9d01SCy Schubert# 1 = Supports Multi-AP profile 1 as defined in Wi-Fi EasyMesh specification
2623*a90b9d01SCy Schubert# 2 = Supports Multi-AP profile 2 as defined in Wi-Fi EasyMesh specification
2624*a90b9d01SCy Schubert#multi_ap_profile=2
2625*a90b9d01SCy Schubert
2626*a90b9d01SCy Schubert# Multi-AP client disallow
2627*a90b9d01SCy Schubert# Used to disallow profile specific backhaul STA association
2628*a90b9d01SCy Schubert# Bitmap of the disallowed Profile-X profiles
2629*a90b9d01SCy Schubert# 1 = Profile-1 Backhaul STA association disallowed
2630*a90b9d01SCy Schubert# 2 = Profile-2 Backhaul STA association disallowed
2631*a90b9d01SCy Schubert#multi_ap_client_disallow=0
2632*a90b9d01SCy Schubert
2633*a90b9d01SCy Schubert# Multi-AP VLAN ID
2634*a90b9d01SCy Schubert# A valid non-zero VLAN ID will be used to update Default IEEE 802.1Q Setting
2635*a90b9d01SCy Schubert#multi_ap_vlanid=0
2636*a90b9d01SCy Schubert
263739beb93cSSam Leffler# WPS UPnP interface
263839beb93cSSam Leffler# If set, support for external Registrars is enabled.
263939beb93cSSam Leffler#upnp_iface=br0
264039beb93cSSam Leffler
264139beb93cSSam Leffler# Friendly Name (required for UPnP)
264239beb93cSSam Leffler# Short description for end use. Should be less than 64 characters.
264339beb93cSSam Leffler#friendly_name=WPS Access Point
264439beb93cSSam Leffler
264539beb93cSSam Leffler# Manufacturer URL (optional for UPnP)
264639beb93cSSam Leffler#manufacturer_url=http://www.example.com/
264739beb93cSSam Leffler
264839beb93cSSam Leffler# Model Description (recommended for UPnP)
264939beb93cSSam Leffler# Long description for end user. Should be less than 128 characters.
265039beb93cSSam Leffler#model_description=Wireless Access Point
265139beb93cSSam Leffler
265239beb93cSSam Leffler# Model URL (optional for UPnP)
265339beb93cSSam Leffler#model_url=http://www.example.com/model/
265439beb93cSSam Leffler
265539beb93cSSam Leffler# Universal Product Code (optional for UPnP)
265639beb93cSSam Leffler# 12-digit, all-numeric code that identifies the consumer package.
265739beb93cSSam Leffler#upc=123456789012
265839beb93cSSam Leffler
2659325151a3SRui Paulo# WPS RF Bands (a = 5G, b = 2.4G, g = 2.4G, ag = dual band, ad = 60 GHz)
2660f05cddf9SRui Paulo# This value should be set according to RF band(s) supported by the AP if
2661f05cddf9SRui Paulo# hw_mode is not set. For dual band dual concurrent devices, this needs to be
2662f05cddf9SRui Paulo# set to ag to allow both RF bands to be advertized.
2663f05cddf9SRui Paulo#wps_rf_bands=ag
2664f05cddf9SRui Paulo
2665f05cddf9SRui Paulo# NFC password token for WPS
2666f05cddf9SRui Paulo# These parameters can be used to configure a fixed NFC password token for the
2667f05cddf9SRui Paulo# AP. This can be generated, e.g., with nfc_pw_token from wpa_supplicant. When
2668f05cddf9SRui Paulo# these parameters are used, the AP is assumed to be deployed with a NFC tag
2669f05cddf9SRui Paulo# that includes the matching NFC password token (e.g., written based on the
2670f05cddf9SRui Paulo# NDEF record from nfc_pw_token).
2671f05cddf9SRui Paulo#
2672f05cddf9SRui Paulo#wps_nfc_dev_pw_id: Device Password ID (16..65535)
2673f05cddf9SRui Paulo#wps_nfc_dh_pubkey: Hexdump of DH Public Key
2674f05cddf9SRui Paulo#wps_nfc_dh_privkey: Hexdump of DH Private Key
2675f05cddf9SRui Paulo#wps_nfc_dev_pw: Hexdump of Device Password
2676f05cddf9SRui Paulo
2677c1d255d3SCy Schubert# Application Extension attribute for Beacon and Probe Response frames
2678c1d255d3SCy Schubert# This parameter can be used to add application extension into WPS IE. The
2679c1d255d3SCy Schubert# contents of this parameter starts with 16-octet (32 hexdump characters) of
2680c1d255d3SCy Schubert# UUID to identify the specific application and that is followed by the actual
2681c1d255d3SCy Schubert# application specific data.
2682c1d255d3SCy Schubert#wps_application_ext=<hexdump>
2683c1d255d3SCy Schubert
2684f05cddf9SRui Paulo##### Wi-Fi Direct (P2P) ######################################################
2685f05cddf9SRui Paulo
2686f05cddf9SRui Paulo# Enable P2P Device management
2687f05cddf9SRui Paulo#manage_p2p=1
2688f05cddf9SRui Paulo
2689f05cddf9SRui Paulo# Allow cross connection
2690f05cddf9SRui Paulo#allow_cross_connection=1
2691f05cddf9SRui Paulo
2692c1d255d3SCy Schubert##### Device Provisioning Protocol (DPP) ######################################
2693c1d255d3SCy Schubert
2694c1d255d3SCy Schubert# Name for Enrollee's DPP Configuration Request
2695c1d255d3SCy Schubert#dpp_name=Test
2696c1d255d3SCy Schubert
2697c1d255d3SCy Schubert# MUD URL for Enrollee's DPP Configuration Request (optional)
2698c1d255d3SCy Schubert#dpp_mud_url=https://example.com/mud
2699c1d255d3SCy Schubert
2700*a90b9d01SCy Schubert# JSON node name of additional data for Enrollee's DPP Configuration Request
2701*a90b9d01SCy Schubert#dpp_extra_conf_req_name=org.example
2702*a90b9d01SCy Schubert
2703*a90b9d01SCy Schubert# JSON node data of additional data for Enrollee's DPP Configuration Request
2704*a90b9d01SCy Schubert#dpp_extra_conf_req_value="abc":123
2705*a90b9d01SCy Schubert
2706c1d255d3SCy Schubert#dpp_connector
2707c1d255d3SCy Schubert#dpp_netaccesskey
2708c1d255d3SCy Schubert#dpp_netaccesskey_expiry
2709c1d255d3SCy Schubert#dpp_csign
2710c1d255d3SCy Schubert#dpp_controller
2711c1d255d3SCy Schubert
2712*a90b9d01SCy Schubert# DPP Relay port number
2713*a90b9d01SCy Schubert# TCP port to listen to for incoming connections from a Controller. This can be
2714*a90b9d01SCy Schubert# used to allow Controller initiated exchanges in addition to the
2715*a90b9d01SCy Schubert# Controller-as-responder cases covered by the dpp_controller parameter.
2716*a90b9d01SCy Schubert#dpp_relay_port=12345
2717*a90b9d01SCy Schubert
2718c1d255d3SCy Schubert# Configurator Connectivity indication
2719c1d255d3SCy Schubert# 0: no Configurator is currently connected (default)
2720c1d255d3SCy Schubert# 1: advertise that a Configurator is available
2721c1d255d3SCy Schubert#dpp_configurator_connectivity=0
2722c1d255d3SCy Schubert
2723c1d255d3SCy Schubert# DPP PFS
2724c1d255d3SCy Schubert# 0: allow PFS to be used or not used (default)
2725c1d255d3SCy Schubert# 1: require PFS to be used (note: not compatible with DPP R1)
2726c1d255d3SCy Schubert# 2: do not allow PFS to be used
2727c1d255d3SCy Schubert#dpp_pfs=0
2728c1d255d3SCy Schubert
2729f05cddf9SRui Paulo#### TDLS (IEEE 802.11z-2010) #################################################
2730f05cddf9SRui Paulo
2731f05cddf9SRui Paulo# Prohibit use of TDLS in this BSS
2732f05cddf9SRui Paulo#tdls_prohibit=1
2733f05cddf9SRui Paulo
2734f05cddf9SRui Paulo# Prohibit use of TDLS Channel Switching in this BSS
2735f05cddf9SRui Paulo#tdls_prohibit_chan_switch=1
2736f05cddf9SRui Paulo
2737f05cddf9SRui Paulo##### IEEE 802.11v-2011 #######################################################
2738f05cddf9SRui Paulo
2739f05cddf9SRui Paulo# Time advertisement
2740f05cddf9SRui Paulo# 0 = disabled (default)
2741f05cddf9SRui Paulo# 2 = UTC time at which the TSF timer is 0
2742f05cddf9SRui Paulo#time_advertisement=2
2743f05cddf9SRui Paulo
2744f05cddf9SRui Paulo# Local time zone as specified in 8.3 of IEEE Std 1003.1-2004:
2745f05cddf9SRui Paulo# stdoffset[dst[offset][,start[/time],end[/time]]]
2746f05cddf9SRui Paulo#time_zone=EST5
2747f05cddf9SRui Paulo
2748f05cddf9SRui Paulo# WNM-Sleep Mode (extended sleep mode for stations)
2749f05cddf9SRui Paulo# 0 = disabled (default)
2750f05cddf9SRui Paulo# 1 = enabled (allow stations to use WNM-Sleep Mode)
2751f05cddf9SRui Paulo#wnm_sleep_mode=1
2752f05cddf9SRui Paulo
275385732ac8SCy Schubert# WNM-Sleep Mode GTK/IGTK workaround
275485732ac8SCy Schubert# Normally, WNM-Sleep Mode exit with management frame protection negotiated
275585732ac8SCy Schubert# would result in the current GTK/IGTK getting added into the WNM-Sleep Mode
275685732ac8SCy Schubert# Response frame. Some station implementations may have a vulnerability that
275785732ac8SCy Schubert# results in GTK/IGTK reinstallation based on this frame being replayed. This
275885732ac8SCy Schubert# configuration parameter can be used to disable that behavior and use EAPOL-Key
275985732ac8SCy Schubert# frames for GTK/IGTK update instead. This would likely be only used with
276085732ac8SCy Schubert# wpa_disable_eapol_key_retries=1 that enables a workaround for similar issues
276185732ac8SCy Schubert# with EAPOL-Key. This is related to station side vulnerabilities CVE-2017-13087
276285732ac8SCy Schubert# and CVE-2017-13088. To enable this AP-side workaround, set the parameter to 1.
276385732ac8SCy Schubert#wnm_sleep_mode_no_keys=0
276485732ac8SCy Schubert
2765f05cddf9SRui Paulo# BSS Transition Management
2766f05cddf9SRui Paulo# 0 = disabled (default)
2767f05cddf9SRui Paulo# 1 = enabled
2768f05cddf9SRui Paulo#bss_transition=1
2769f05cddf9SRui Paulo
27705b9c547cSRui Paulo# Proxy ARP
27715b9c547cSRui Paulo# 0 = disabled (default)
27725b9c547cSRui Paulo# 1 = enabled
27735b9c547cSRui Paulo#proxy_arp=1
27745b9c547cSRui Paulo
2775325151a3SRui Paulo# IPv6 Neighbor Advertisement multicast-to-unicast conversion
2776325151a3SRui Paulo# This can be used with Proxy ARP to allow multicast NAs to be forwarded to
2777325151a3SRui Paulo# associated STAs using link layer unicast delivery.
2778325151a3SRui Paulo# 0 = disabled (default)
2779325151a3SRui Paulo# 1 = enabled
2780325151a3SRui Paulo#na_mcast_to_ucast=0
2781325151a3SRui Paulo
2782f05cddf9SRui Paulo##### IEEE 802.11u-2011 #######################################################
2783f05cddf9SRui Paulo
2784f05cddf9SRui Paulo# Enable Interworking service
2785f05cddf9SRui Paulo#interworking=1
2786f05cddf9SRui Paulo
2787f05cddf9SRui Paulo# Access Network Type
2788f05cddf9SRui Paulo# 0 = Private network
2789f05cddf9SRui Paulo# 1 = Private network with guest access
2790f05cddf9SRui Paulo# 2 = Chargeable public network
2791f05cddf9SRui Paulo# 3 = Free public network
2792f05cddf9SRui Paulo# 4 = Personal device network
2793f05cddf9SRui Paulo# 5 = Emergency services only network
2794f05cddf9SRui Paulo# 14 = Test or experimental
2795f05cddf9SRui Paulo# 15 = Wildcard
2796f05cddf9SRui Paulo#access_network_type=0
2797f05cddf9SRui Paulo
2798f05cddf9SRui Paulo# Whether the network provides connectivity to the Internet
2799f05cddf9SRui Paulo# 0 = Unspecified
2800f05cddf9SRui Paulo# 1 = Network provides connectivity to the Internet
2801f05cddf9SRui Paulo#internet=1
2802f05cddf9SRui Paulo
2803f05cddf9SRui Paulo# Additional Step Required for Access
2804f05cddf9SRui Paulo# Note: This is only used with open network, i.e., ASRA shall ne set to 0 if
2805f05cddf9SRui Paulo# RSN is used.
2806f05cddf9SRui Paulo#asra=0
2807f05cddf9SRui Paulo
2808f05cddf9SRui Paulo# Emergency services reachable
2809f05cddf9SRui Paulo#esr=0
2810f05cddf9SRui Paulo
2811f05cddf9SRui Paulo# Unauthenticated emergency service accessible
2812f05cddf9SRui Paulo#uesa=0
2813f05cddf9SRui Paulo
2814f05cddf9SRui Paulo# Venue Info (optional)
2815f05cddf9SRui Paulo# The available values are defined in IEEE Std 802.11u-2011, 7.3.1.34.
2816f05cddf9SRui Paulo# Example values (group,type):
2817f05cddf9SRui Paulo# 0,0 = Unspecified
2818f05cddf9SRui Paulo# 1,7 = Convention Center
2819f05cddf9SRui Paulo# 1,13 = Coffee Shop
2820f05cddf9SRui Paulo# 2,0 = Unspecified Business
2821f05cddf9SRui Paulo# 7,1  Private Residence
2822f05cddf9SRui Paulo#venue_group=7
2823f05cddf9SRui Paulo#venue_type=1
2824f05cddf9SRui Paulo
2825f05cddf9SRui Paulo# Homogeneous ESS identifier (optional; dot11HESSID)
2826f05cddf9SRui Paulo# If set, this shall be identifical to one of the BSSIDs in the homogeneous
2827f05cddf9SRui Paulo# ESS and this shall be set to the same value across all BSSs in homogeneous
2828f05cddf9SRui Paulo# ESS.
2829f05cddf9SRui Paulo#hessid=02:03:04:05:06:07
2830f05cddf9SRui Paulo
2831f05cddf9SRui Paulo# Roaming Consortium List
2832f05cddf9SRui Paulo# Arbitrary number of Roaming Consortium OIs can be configured with each line
2833f05cddf9SRui Paulo# adding a new OI to the list. The first three entries are available through
2834f05cddf9SRui Paulo# Beacon and Probe Response frames. Any additional entry will be available only
2835f05cddf9SRui Paulo# through ANQP queries. Each OI is between 3 and 15 octets and is configured as
2836f05cddf9SRui Paulo# a hexstring.
2837f05cddf9SRui Paulo#roaming_consortium=021122
2838f05cddf9SRui Paulo#roaming_consortium=2233445566
2839f05cddf9SRui Paulo
2840f05cddf9SRui Paulo# Venue Name information
2841f05cddf9SRui Paulo# This parameter can be used to configure one or more Venue Name Duples for
2842f05cddf9SRui Paulo# Venue Name ANQP information. Each entry has a two or three character language
2843f05cddf9SRui Paulo# code (ISO-639) separated by colon from the venue name string.
2844f05cddf9SRui Paulo# Note that venue_group and venue_type have to be set for Venue Name
2845f05cddf9SRui Paulo# information to be complete.
2846f05cddf9SRui Paulo#venue_name=eng:Example venue
2847f05cddf9SRui Paulo#venue_name=fin:Esimerkkipaikka
28485b9c547cSRui Paulo# Alternative format for language:value strings:
28495b9c547cSRui Paulo# (double quoted string, printf-escaped string)
28505b9c547cSRui Paulo#venue_name=P"eng:Example\nvenue"
2851f05cddf9SRui Paulo
285285732ac8SCy Schubert# Venue URL information
285385732ac8SCy Schubert# This parameter can be used to configure one or more Venue URL Duples to
285485732ac8SCy Schubert# provide additional information corresponding to Venue Name information.
285585732ac8SCy Schubert# Each entry has a Venue Number value separated by colon from the Venue URL
285685732ac8SCy Schubert# string. Venue Number indicates the corresponding venue_name entry (1 = 1st
285785732ac8SCy Schubert# venue_name, 2 = 2nd venue_name, and so on; 0 = no matching venue_name)
285885732ac8SCy Schubert#venue_url=1:http://www.example.com/info-eng
285985732ac8SCy Schubert#venue_url=2:http://www.example.com/info-fin
286085732ac8SCy Schubert
2861f05cddf9SRui Paulo# Network Authentication Type
2862f05cddf9SRui Paulo# This parameter indicates what type of network authentication is used in the
2863f05cddf9SRui Paulo# network.
2864f05cddf9SRui Paulo# format: <network auth type indicator (1-octet hex str)> [redirect URL]
2865f05cddf9SRui Paulo# Network Authentication Type Indicator values:
2866f05cddf9SRui Paulo# 00 = Acceptance of terms and conditions
2867f05cddf9SRui Paulo# 01 = On-line enrollment supported
2868f05cddf9SRui Paulo# 02 = http/https redirection
2869f05cddf9SRui Paulo# 03 = DNS redirection
2870f05cddf9SRui Paulo#network_auth_type=00
2871f05cddf9SRui Paulo#network_auth_type=02http://www.example.com/redirect/me/here/
2872f05cddf9SRui Paulo
2873f05cddf9SRui Paulo# IP Address Type Availability
2874f05cddf9SRui Paulo# format: <1-octet encoded value as hex str>
2875f05cddf9SRui Paulo# (ipv4_type & 0x3f) << 2 | (ipv6_type & 0x3)
2876f05cddf9SRui Paulo# ipv4_type:
2877f05cddf9SRui Paulo# 0 = Address type not available
2878f05cddf9SRui Paulo# 1 = Public IPv4 address available
2879f05cddf9SRui Paulo# 2 = Port-restricted IPv4 address available
2880f05cddf9SRui Paulo# 3 = Single NATed private IPv4 address available
2881f05cddf9SRui Paulo# 4 = Double NATed private IPv4 address available
2882f05cddf9SRui Paulo# 5 = Port-restricted IPv4 address and single NATed IPv4 address available
2883f05cddf9SRui Paulo# 6 = Port-restricted IPv4 address and double NATed IPv4 address available
2884f05cddf9SRui Paulo# 7 = Availability of the address type is not known
2885f05cddf9SRui Paulo# ipv6_type:
2886f05cddf9SRui Paulo# 0 = Address type not available
2887f05cddf9SRui Paulo# 1 = Address type available
2888f05cddf9SRui Paulo# 2 = Availability of the address type not known
2889f05cddf9SRui Paulo#ipaddr_type_availability=14
2890f05cddf9SRui Paulo
2891f05cddf9SRui Paulo# Domain Name
2892f05cddf9SRui Paulo# format: <variable-octet str>[,<variable-octet str>]
2893f05cddf9SRui Paulo#domain_name=example.com,another.example.com,yet-another.example.com
2894f05cddf9SRui Paulo
2895f05cddf9SRui Paulo# 3GPP Cellular Network information
2896f05cddf9SRui Paulo# format: <MCC1,MNC1>[;<MCC2,MNC2>][;...]
2897f05cddf9SRui Paulo#anqp_3gpp_cell_net=244,91;310,026;234,56
2898f05cddf9SRui Paulo
2899f05cddf9SRui Paulo# NAI Realm information
2900f05cddf9SRui Paulo# One or more realm can be advertised. Each nai_realm line adds a new realm to
2901f05cddf9SRui Paulo# the set. These parameters provide information for stations using Interworking
2902f05cddf9SRui Paulo# network selection to allow automatic connection to a network based on
2903f05cddf9SRui Paulo# credentials.
2904f05cddf9SRui Paulo# format: <encoding>,<NAI Realm(s)>[,<EAP Method 1>][,<EAP Method 2>][,...]
2905f05cddf9SRui Paulo# encoding:
2906f05cddf9SRui Paulo#	0 = Realm formatted in accordance with IETF RFC 4282
2907f05cddf9SRui Paulo#	1 = UTF-8 formatted character string that is not formatted in
2908f05cddf9SRui Paulo#	    accordance with IETF RFC 4282
2909f05cddf9SRui Paulo# NAI Realm(s): Semi-colon delimited NAI Realm(s)
2910f05cddf9SRui Paulo# EAP Method: <EAP Method>[:<[AuthParam1:Val1]>][<[AuthParam2:Val2]>][...]
29115b9c547cSRui Paulo# EAP Method types, see:
29125b9c547cSRui Paulo# http://www.iana.org/assignments/eap-numbers/eap-numbers.xhtml#eap-numbers-4
2913f05cddf9SRui Paulo# AuthParam (Table 8-188 in IEEE Std 802.11-2012):
2914f05cddf9SRui Paulo# ID 2 = Non-EAP Inner Authentication Type
2915f05cddf9SRui Paulo#	1 = PAP, 2 = CHAP, 3 = MSCHAP, 4 = MSCHAPV2
2916f05cddf9SRui Paulo# ID 3 = Inner authentication EAP Method Type
2917f05cddf9SRui Paulo# ID 5 = Credential Type
2918f05cddf9SRui Paulo#	1 = SIM, 2 = USIM, 3 = NFC Secure Element, 4 = Hardware Token,
2919f05cddf9SRui Paulo#	5 = Softoken, 6 = Certificate, 7 = username/password, 9 = Anonymous,
2920f05cddf9SRui Paulo#	10 = Vendor Specific
2921f05cddf9SRui Paulo#nai_realm=0,example.com;example.net
2922f05cddf9SRui Paulo# EAP methods EAP-TLS with certificate and EAP-TTLS/MSCHAPv2 with
2923f05cddf9SRui Paulo# username/password
2924f05cddf9SRui Paulo#nai_realm=0,example.org,13[5:6],21[2:4][5:7]
2925f05cddf9SRui Paulo
2926780fb4a2SCy Schubert# Arbitrary ANQP-element configuration
2927780fb4a2SCy Schubert# Additional ANQP-elements with arbitrary values can be defined by specifying
2928780fb4a2SCy Schubert# their contents in raw format as a hexdump of the payload. Note that these
2929780fb4a2SCy Schubert# values will override ANQP-element contents that may have been specified in the
2930780fb4a2SCy Schubert# more higher layer configuration parameters listed above.
2931780fb4a2SCy Schubert# format: anqp_elem=<InfoID>:<hexdump of payload>
2932780fb4a2SCy Schubert# For example, AP Geospatial Location ANQP-element with unknown location:
2933780fb4a2SCy Schubert#anqp_elem=265:0000
2934780fb4a2SCy Schubert# For example, AP Civic Location ANQP-element with unknown location:
2935780fb4a2SCy Schubert#anqp_elem=266:000000
2936780fb4a2SCy Schubert
2937780fb4a2SCy Schubert# GAS Address 3 behavior
2938780fb4a2SCy Schubert# 0 = P2P specification (Address3 = AP BSSID) workaround enabled by default
2939780fb4a2SCy Schubert#     based on GAS request Address3
2940780fb4a2SCy Schubert# 1 = IEEE 802.11 standard compliant regardless of GAS request Address3
2941780fb4a2SCy Schubert# 2 = Force non-compliant behavior (Address3 = AP BSSID for all cases)
2942780fb4a2SCy Schubert#gas_address3=0
2943780fb4a2SCy Schubert
29445b9c547cSRui Paulo# QoS Map Set configuration
29455b9c547cSRui Paulo#
29465b9c547cSRui Paulo# Comma delimited QoS Map Set in decimal values
29475b9c547cSRui Paulo# (see IEEE Std 802.11-2012, 8.4.2.97)
29485b9c547cSRui Paulo#
29495b9c547cSRui Paulo# format:
29505b9c547cSRui Paulo# [<DSCP Exceptions[DSCP,UP]>,]<UP 0 range[low,high]>,...<UP 7 range[low,high]>
29515b9c547cSRui Paulo#
29525b9c547cSRui Paulo# There can be up to 21 optional DSCP Exceptions which are pairs of DSCP Value
29535b9c547cSRui Paulo# (0..63 or 255) and User Priority (0..7). This is followed by eight DSCP Range
29545b9c547cSRui Paulo# descriptions with DSCP Low Value and DSCP High Value pairs (0..63 or 255) for
29555b9c547cSRui Paulo# each UP starting from 0. If both low and high value are set to 255, the
29565b9c547cSRui Paulo# corresponding UP is not used.
29575b9c547cSRui Paulo#
29585b9c547cSRui Paulo# default: not set
29595b9c547cSRui Paulo#qos_map_set=53,2,22,6,8,15,0,7,255,255,16,31,32,39,255,255,40,47,255,255
29605b9c547cSRui Paulo
2961f05cddf9SRui Paulo##### Hotspot 2.0 #############################################################
2962f05cddf9SRui Paulo
2963f05cddf9SRui Paulo# Enable Hotspot 2.0 support
2964f05cddf9SRui Paulo#hs20=1
2965f05cddf9SRui Paulo
2966f05cddf9SRui Paulo# Disable Downstream Group-Addressed Forwarding (DGAF)
2967f05cddf9SRui Paulo# This can be used to configure a network where no group-addressed frames are
2968f05cddf9SRui Paulo# allowed. The AP will not forward any group-address frames to the stations and
2969f05cddf9SRui Paulo# random GTKs are issued for each station to prevent associated stations from
2970f05cddf9SRui Paulo# forging such frames to other stations in the BSS.
2971f05cddf9SRui Paulo#disable_dgaf=1
2972f05cddf9SRui Paulo
29735b9c547cSRui Paulo# OSU Server-Only Authenticated L2 Encryption Network
29745b9c547cSRui Paulo#osen=1
29755b9c547cSRui Paulo
29765b9c547cSRui Paulo# ANQP Domain ID (0..65535)
29775b9c547cSRui Paulo# An identifier for a set of APs in an ESS that share the same common ANQP
29785b9c547cSRui Paulo# information. 0 = Some of the ANQP information is unique to this AP (default).
29795b9c547cSRui Paulo#anqp_domain_id=1234
29805b9c547cSRui Paulo
29815b9c547cSRui Paulo# Deauthentication request timeout
29825b9c547cSRui Paulo# If the RADIUS server indicates that the station is not allowed to connect to
29835b9c547cSRui Paulo# the BSS/ESS, the AP can allow the station some time to download a
29845b9c547cSRui Paulo# notification page (URL included in the message). This parameter sets that
2985*a90b9d01SCy Schubert# timeout in seconds. If the RADIUS server provides no URL, this value is
2986*a90b9d01SCy Schubert# reduced to two seconds with an additional trigger for immediate
2987*a90b9d01SCy Schubert# deauthentication when the STA acknowledges reception of the deauthentication
2988*a90b9d01SCy Schubert# imminent indication. Note that setting this value to 0 will prevent delivery
2989*a90b9d01SCy Schubert# of the notification to the STA, so a value of at least 1 should be used here
2990*a90b9d01SCy Schubert# for normal use cases.
29915b9c547cSRui Paulo#hs20_deauth_req_timeout=60
29925b9c547cSRui Paulo
2993f05cddf9SRui Paulo# Operator Friendly Name
2994f05cddf9SRui Paulo# This parameter can be used to configure one or more Operator Friendly Name
2995f05cddf9SRui Paulo# Duples. Each entry has a two or three character language code (ISO-639)
2996f05cddf9SRui Paulo# separated by colon from the operator friendly name string.
2997f05cddf9SRui Paulo#hs20_oper_friendly_name=eng:Example operator
2998f05cddf9SRui Paulo#hs20_oper_friendly_name=fin:Esimerkkioperaattori
2999f05cddf9SRui Paulo
3000f05cddf9SRui Paulo# Connection Capability
3001f05cddf9SRui Paulo# This can be used to advertise what type of IP traffic can be sent through the
3002f05cddf9SRui Paulo# hotspot (e.g., due to firewall allowing/blocking protocols/ports).
3003f05cddf9SRui Paulo# format: <IP Protocol>:<Port Number>:<Status>
3004f05cddf9SRui Paulo# IP Protocol: 1 = ICMP, 6 = TCP, 17 = UDP
3005f05cddf9SRui Paulo# Port Number: 0..65535
3006f05cddf9SRui Paulo# Status: 0 = Closed, 1 = Open, 2 = Unknown
3007f05cddf9SRui Paulo# Each hs20_conn_capab line is added to the list of advertised tuples.
3008f05cddf9SRui Paulo#hs20_conn_capab=1:0:2
3009f05cddf9SRui Paulo#hs20_conn_capab=6:22:1
3010f05cddf9SRui Paulo#hs20_conn_capab=17:5060:0
3011f05cddf9SRui Paulo
3012f05cddf9SRui Paulo# WAN Metrics
3013f05cddf9SRui Paulo# format: <WAN Info>:<DL Speed>:<UL Speed>:<DL Load>:<UL Load>:<LMD>
3014f05cddf9SRui Paulo# WAN Info: B0-B1: Link Status, B2: Symmetric Link, B3: At Capabity
3015f05cddf9SRui Paulo#    (encoded as two hex digits)
3016f05cddf9SRui Paulo#    Link Status: 1 = Link up, 2 = Link down, 3 = Link in test state
3017f05cddf9SRui Paulo# Downlink Speed: Estimate of WAN backhaul link current downlink speed in kbps;
3018f05cddf9SRui Paulo#	1..4294967295; 0 = unknown
3019f05cddf9SRui Paulo# Uplink Speed: Estimate of WAN backhaul link current uplink speed in kbps
3020f05cddf9SRui Paulo#	1..4294967295; 0 = unknown
3021f05cddf9SRui Paulo# Downlink Load: Current load of downlink WAN connection (scaled to 255 = 100%)
3022f05cddf9SRui Paulo# Uplink Load: Current load of uplink WAN connection (scaled to 255 = 100%)
3023f05cddf9SRui Paulo# Load Measurement Duration: Duration for measuring downlink/uplink load in
3024f05cddf9SRui Paulo# tenths of a second (1..65535); 0 if load cannot be determined
3025f05cddf9SRui Paulo#hs20_wan_metrics=01:8000:1000:80:240:3000
3026f05cddf9SRui Paulo
3027f05cddf9SRui Paulo# Operating Class Indication
3028f05cddf9SRui Paulo# List of operating classes the BSSes in this ESS use. The Global operating
3029f05cddf9SRui Paulo# classes in Table E-4 of IEEE Std 802.11-2012 Annex E define the values that
3030f05cddf9SRui Paulo# can be used in this.
3031f05cddf9SRui Paulo# format: hexdump of operating class octets
3032f05cddf9SRui Paulo# for example, operating classes 81 (2.4 GHz channels 1-13) and 115 (5 GHz
3033f05cddf9SRui Paulo# channels 36-48):
3034f05cddf9SRui Paulo#hs20_operating_class=5173
3035f05cddf9SRui Paulo
303685732ac8SCy Schubert# Terms and Conditions information
303785732ac8SCy Schubert#
303885732ac8SCy Schubert# hs20_t_c_filename contains the Terms and Conditions filename that the AP
303985732ac8SCy Schubert# indicates in RADIUS Access-Request messages.
304085732ac8SCy Schubert#hs20_t_c_filename=terms-and-conditions
304185732ac8SCy Schubert#
304285732ac8SCy Schubert# hs20_t_c_timestamp contains the Terms and Conditions timestamp that the AP
304385732ac8SCy Schubert# indicates in RADIUS Access-Request messages. Usually, this contains the number
304485732ac8SCy Schubert# of seconds since January 1, 1970 00:00 UTC showing the time when the file was
304585732ac8SCy Schubert# last modified.
304685732ac8SCy Schubert#hs20_t_c_timestamp=1234567
304785732ac8SCy Schubert#
304885732ac8SCy Schubert# hs20_t_c_server_url contains a template for the Terms and Conditions server
304985732ac8SCy Schubert# URL. This template is used to generate the URL for a STA that needs to
305085732ac8SCy Schubert# acknowledge Terms and Conditions. Unlike the other hs20_t_c_* parameters, this
305185732ac8SCy Schubert# parameter is used on the authentication server, not the AP.
305285732ac8SCy Schubert# Macros:
305385732ac8SCy Schubert# @1@ = MAC address of the STA (colon separated hex octets)
305485732ac8SCy Schubert#hs20_t_c_server_url=https://example.com/t_and_c?addr=@1@&ap=123
305585732ac8SCy Schubert
305685732ac8SCy Schubert# OSU and Operator icons
30575b9c547cSRui Paulo# <Icon Width>:<Icon Height>:<Language code>:<Icon Type>:<Name>:<file path>
30585b9c547cSRui Paulo#hs20_icon=32:32:eng:image/png:icon32:/tmp/icon32.png
30595b9c547cSRui Paulo#hs20_icon=64:64:eng:image/png:icon64:/tmp/icon64.png
30605b9c547cSRui Paulo
30615b9c547cSRui Paulo# OSU SSID (see ssid2 for format description)
30625b9c547cSRui Paulo# This is the SSID used for all OSU connections to all the listed OSU Providers.
30635b9c547cSRui Paulo#osu_ssid="example"
30645b9c547cSRui Paulo
30655b9c547cSRui Paulo# OSU Providers
30665b9c547cSRui Paulo# One or more sets of following parameter. Each OSU provider is started by the
30675b9c547cSRui Paulo# mandatory osu_server_uri item. The other parameters add information for the
306885732ac8SCy Schubert# last added OSU provider. osu_nai specifies the OSU_NAI value for OSEN
306985732ac8SCy Schubert# authentication when using a standalone OSU BSS. osu_nai2 specifies the OSU_NAI
307085732ac8SCy Schubert# value for OSEN authentication when using a shared BSS (Single SSID) for OSU.
30715b9c547cSRui Paulo#
30725b9c547cSRui Paulo#osu_server_uri=https://example.com/osu/
30735b9c547cSRui Paulo#osu_friendly_name=eng:Example operator
30745b9c547cSRui Paulo#osu_friendly_name=fin:Esimerkkipalveluntarjoaja
30755b9c547cSRui Paulo#osu_nai=anonymous@example.com
307685732ac8SCy Schubert#osu_nai2=anonymous@example.com
30775b9c547cSRui Paulo#osu_method_list=1 0
30785b9c547cSRui Paulo#osu_icon=icon32
30795b9c547cSRui Paulo#osu_icon=icon64
30805b9c547cSRui Paulo#osu_service_desc=eng:Example services
30815b9c547cSRui Paulo#osu_service_desc=fin:Esimerkkipalveluja
30825b9c547cSRui Paulo#
30835b9c547cSRui Paulo#osu_server_uri=...
30845b9c547cSRui Paulo
308585732ac8SCy Schubert# Operator Icons
308685732ac8SCy Schubert# Operator icons are specified using references to the hs20_icon entries
308785732ac8SCy Schubert# (Name subfield). This information, if present, is advertsised in the
308885732ac8SCy Schubert# Operator Icon Metadata ANQO-element.
308985732ac8SCy Schubert#operator_icon=icon32
309085732ac8SCy Schubert#operator_icon=icon64
309185732ac8SCy Schubert
309285732ac8SCy Schubert##### Multiband Operation (MBO) ###############################################
309385732ac8SCy Schubert#
309485732ac8SCy Schubert# MBO enabled
309585732ac8SCy Schubert# 0 = disabled (default)
309685732ac8SCy Schubert# 1 = enabled
309785732ac8SCy Schubert#mbo=1
309885732ac8SCy Schubert#
309985732ac8SCy Schubert# Cellular data connection preference
310085732ac8SCy Schubert# 0 = Excluded - AP does not want STA to use the cellular data connection
310185732ac8SCy Schubert# 1 = AP prefers the STA not to use cellular data connection
310285732ac8SCy Schubert# 255 = AP prefers the STA to use cellular data connection
310385732ac8SCy Schubert#mbo_cell_data_conn_pref=1
310485732ac8SCy Schubert
310585732ac8SCy Schubert##### Optimized Connectivity Experience (OCE) #################################
310685732ac8SCy Schubert#
310785732ac8SCy Schubert# Enable OCE specific features (bitmap)
310885732ac8SCy Schubert# BIT(0) - Reserved
310985732ac8SCy Schubert# Set BIT(1) (= 2) to enable OCE in STA-CFON mode
311085732ac8SCy Schubert# Set BIT(2) (= 4) to enable OCE in AP mode
311185732ac8SCy Schubert# Default is 0 = OCE disabled
311285732ac8SCy Schubert#oce=0
311385732ac8SCy Schubert
3114c1d255d3SCy Schubert# RSSI-based association rejection
31154bc52338SCy Schubert#
31164bc52338SCy Schubert# Reject STA association if RSSI is below given threshold (in dBm)
31174bc52338SCy Schubert# Allowed range: -60 to -90 dBm; default = 0 (rejection disabled)
31184bc52338SCy Schubert# Note: This rejection happens based on a signal strength detected while
31194bc52338SCy Schubert# receiving a single frame and as such, there is significant risk of the value
31204bc52338SCy Schubert# not being accurate and this resulting in valid stations being rejected. As
31214bc52338SCy Schubert# such, this functionality is not recommended to be used for purposes other than
31224bc52338SCy Schubert# testing.
31234bc52338SCy Schubert#rssi_reject_assoc_rssi=-75
31244bc52338SCy Schubert#
31254bc52338SCy Schubert# Association retry delay in seconds allowed by the STA if RSSI has not met the
31264bc52338SCy Schubert# threshold (range: 0..255, default=30).
31274bc52338SCy Schubert#rssi_reject_assoc_timeout=30
31284bc52338SCy Schubert
3129c1d255d3SCy Schubert# Ignore Probe Request frames if RSSI is below given threshold (in dBm)
3130c1d255d3SCy Schubert# Allowed range: -60 to -90 dBm; default = 0 (rejection disabled)
3131c1d255d3SCy Schubert#rssi_ignore_probe_request=-75
3132c1d255d3SCy Schubert
3133325151a3SRui Paulo##### Fast Session Transfer (FST) support #####################################
3134325151a3SRui Paulo#
3135325151a3SRui Paulo# The options in this section are only available when the build configuration
3136325151a3SRui Paulo# option CONFIG_FST is set while compiling hostapd. They allow this interface
3137325151a3SRui Paulo# to be a part of FST setup.
3138325151a3SRui Paulo#
3139325151a3SRui Paulo# FST is the transfer of a session from a channel to another channel, in the
3140325151a3SRui Paulo# same or different frequency bands.
3141325151a3SRui Paulo#
3142325151a3SRui Paulo# For detals, see IEEE Std 802.11ad-2012.
3143325151a3SRui Paulo
3144325151a3SRui Paulo# Identifier of an FST Group the interface belongs to.
3145325151a3SRui Paulo#fst_group_id=bond0
3146325151a3SRui Paulo
3147325151a3SRui Paulo# Interface priority within the FST Group.
3148325151a3SRui Paulo# Announcing a higher priority for an interface means declaring it more
3149325151a3SRui Paulo# preferable for FST switch.
3150325151a3SRui Paulo# fst_priority is in 1..255 range with 1 being the lowest priority.
3151325151a3SRui Paulo#fst_priority=100
3152325151a3SRui Paulo
3153325151a3SRui Paulo# Default LLT value for this interface in milliseconds. The value used in case
3154325151a3SRui Paulo# no value provided during session setup. Default is 50 ms.
3155325151a3SRui Paulo# fst_llt is in 1..4294967 range (due to spec limitation, see 10.32.2.2
3156325151a3SRui Paulo# Transitioning between states).
3157325151a3SRui Paulo#fst_llt=100
3158325151a3SRui Paulo
3159780fb4a2SCy Schubert##### Radio measurements / location ###########################################
3160780fb4a2SCy Schubert
3161780fb4a2SCy Schubert# The content of a LCI measurement subelement
3162780fb4a2SCy Schubert#lci=<Hexdump of binary data of the LCI report>
3163780fb4a2SCy Schubert
3164780fb4a2SCy Schubert# The content of a location civic measurement subelement
3165780fb4a2SCy Schubert#civic=<Hexdump of binary data of the location civic report>
3166780fb4a2SCy Schubert
3167780fb4a2SCy Schubert# Enable neighbor report via radio measurements
3168780fb4a2SCy Schubert#rrm_neighbor_report=1
3169780fb4a2SCy Schubert
3170*a90b9d01SCy Schubert# Enable link measurement report via radio measurements
3171*a90b9d01SCy Schubert#rrm_link_measurement_report=1
3172*a90b9d01SCy Schubert
317385732ac8SCy Schubert# Enable beacon report via radio measurements
317485732ac8SCy Schubert#rrm_beacon_report=1
317585732ac8SCy Schubert
3176780fb4a2SCy Schubert# Publish fine timing measurement (FTM) responder functionality
3177780fb4a2SCy Schubert# This parameter only controls publishing via Extended Capabilities element.
3178780fb4a2SCy Schubert# Actual functionality is managed outside hostapd.
3179780fb4a2SCy Schubert#ftm_responder=0
3180780fb4a2SCy Schubert
3181780fb4a2SCy Schubert# Publish fine timing measurement (FTM) initiator functionality
3182780fb4a2SCy Schubert# This parameter only controls publishing via Extended Capabilities element.
3183780fb4a2SCy Schubert# Actual functionality is managed outside hostapd.
3184780fb4a2SCy Schubert#ftm_initiator=0
318585732ac8SCy Schubert#
318685732ac8SCy Schubert# Stationary AP config indicates that the AP doesn't move hence location data
318785732ac8SCy Schubert# can be considered as always up to date. If configured, LCI data will be sent
318885732ac8SCy Schubert# as a radio measurement even if the request doesn't contain a max age element
318985732ac8SCy Schubert# that allows sending of such data. Default: 0.
319085732ac8SCy Schubert#stationary_ap=0
3191780fb4a2SCy Schubert
31924b72b91aSCy Schubert# Enable reduced neighbor reporting (RNR)
31934b72b91aSCy Schubert#rnr=0
31944b72b91aSCy Schubert
3195206b73d0SCy Schubert##### Airtime policy configuration ###########################################
3196206b73d0SCy Schubert
3197206b73d0SCy Schubert# Set the airtime policy operating mode:
3198206b73d0SCy Schubert# 0 = disabled (default)
3199206b73d0SCy Schubert# 1 = static config
3200206b73d0SCy Schubert# 2 = per-BSS dynamic config
3201206b73d0SCy Schubert# 3 = per-BSS limit mode
3202206b73d0SCy Schubert#airtime_mode=0
3203206b73d0SCy Schubert
3204206b73d0SCy Schubert# Interval (in milliseconds) to poll the kernel for updated station activity in
3205206b73d0SCy Schubert# dynamic and limit modes
3206206b73d0SCy Schubert#airtime_update_interval=200
3207206b73d0SCy Schubert
3208206b73d0SCy Schubert# Static configuration of station weights (when airtime_mode=1). Kernel default
3209206b73d0SCy Schubert# weight is 256; set higher for larger airtime share, lower for smaller share.
3210206b73d0SCy Schubert# Each entry is a MAC address followed by a weight.
3211206b73d0SCy Schubert#airtime_sta_weight=02:01:02:03:04:05 256
3212206b73d0SCy Schubert#airtime_sta_weight=02:01:02:03:04:06 512
3213206b73d0SCy Schubert
3214206b73d0SCy Schubert# Per-BSS airtime weight. In multi-BSS mode, set for each BSS and hostapd will
3215206b73d0SCy Schubert# configure station weights to enforce the correct ratio between BSS weights
3216206b73d0SCy Schubert# depending on the number of active stations. The *ratios* between different
3217206b73d0SCy Schubert# BSSes is what's important, not the absolute numbers.
3218206b73d0SCy Schubert# Must be set for all BSSes if airtime_mode=2 or 3, has no effect otherwise.
3219206b73d0SCy Schubert#airtime_bss_weight=1
3220206b73d0SCy Schubert
3221206b73d0SCy Schubert# Whether the current BSS should be limited (when airtime_mode=3).
3222206b73d0SCy Schubert#
3223206b73d0SCy Schubert# If set, the BSS weight ratio will be applied in the case where the current BSS
3224206b73d0SCy Schubert# would exceed the share defined by the BSS weight ratio. E.g., if two BSSes are
3225206b73d0SCy Schubert# set to the same weights, and one is set to limited, the limited BSS will get
3226206b73d0SCy Schubert# no more than half the available airtime, but if the non-limited BSS has more
3227206b73d0SCy Schubert# stations active, that *will* be allowed to exceed its half of the available
3228206b73d0SCy Schubert# airtime.
3229206b73d0SCy Schubert#airtime_bss_limit=1
3230206b73d0SCy Schubert
3231c1d255d3SCy Schubert##### EDMG support ############################################################
3232c1d255d3SCy Schubert#
3233c1d255d3SCy Schubert# Enable EDMG capability for AP mode in the 60 GHz band. Default value is false.
3234c1d255d3SCy Schubert# To configure channel bonding for an EDMG AP use edmg_channel below.
3235c1d255d3SCy Schubert# If enable_edmg is set and edmg_channel is not set, EDMG CB1 will be
3236c1d255d3SCy Schubert# configured.
3237c1d255d3SCy Schubert#enable_edmg=1
3238c1d255d3SCy Schubert#
3239c1d255d3SCy Schubert# Configure channel bonding for AP mode in the 60 GHz band.
3240c1d255d3SCy Schubert# This parameter is relevant only if enable_edmg is set.
3241c1d255d3SCy Schubert# Default value is 0 (no channel bonding).
3242c1d255d3SCy Schubert#edmg_channel=9
3243c1d255d3SCy Schubert
32445b9c547cSRui Paulo##### TESTING OPTIONS #########################################################
32455b9c547cSRui Paulo#
32465b9c547cSRui Paulo# The options in this section are only available when the build configuration
32475b9c547cSRui Paulo# option CONFIG_TESTING_OPTIONS is set while compiling hostapd. They allow
32485b9c547cSRui Paulo# testing some scenarios that are otherwise difficult to reproduce.
32495b9c547cSRui Paulo#
32505b9c547cSRui Paulo# Ignore probe requests sent to hostapd with the given probability, must be a
32515b9c547cSRui Paulo# floating point number in the range [0, 1).
32525b9c547cSRui Paulo#ignore_probe_probability=0.0
32535b9c547cSRui Paulo#
32545b9c547cSRui Paulo# Ignore authentication frames with the given probability
32555b9c547cSRui Paulo#ignore_auth_probability=0.0
32565b9c547cSRui Paulo#
32575b9c547cSRui Paulo# Ignore association requests with the given probability
32585b9c547cSRui Paulo#ignore_assoc_probability=0.0
32595b9c547cSRui Paulo#
32605b9c547cSRui Paulo# Ignore reassociation requests with the given probability
32615b9c547cSRui Paulo#ignore_reassoc_probability=0.0
32625b9c547cSRui Paulo#
32635b9c547cSRui Paulo# Corrupt Key MIC in GTK rekey EAPOL-Key frames with the given probability
32645b9c547cSRui Paulo#corrupt_gtk_rekey_mic_probability=0.0
3265780fb4a2SCy Schubert#
3266780fb4a2SCy Schubert# Include only ECSA IE without CSA IE where possible
3267780fb4a2SCy Schubert# (channel switch operating class is needed)
3268780fb4a2SCy Schubert#ecsa_ie_only=0
3269*a90b9d01SCy Schubert#
3270*a90b9d01SCy Schubert# Delay EAPOL-Key messages 1/4 and 3/4 by not sending the frame until the last
3271*a90b9d01SCy Schubert# attempt (wpa_pairwise_update_count). This will trigger a timeout on all
3272*a90b9d01SCy Schubert# previous attempts and thus delays the frame. (testing only)
3273*a90b9d01SCy Schubert#delay_eapol_tx=0
3274*a90b9d01SCy Schubert#
3275*a90b9d01SCy Schubert# Additional elements for Probe Response frames.
3276*a90b9d01SCy Schubert# This parameter can be used to add additional element(s) to the end of the
3277*a90b9d01SCy Schubert# Probe Response frames. The format for these element(s) is a hexdump of the
3278*a90b9d01SCy Schubert# raw information elements (id+len+payload for one or more elements).
3279*a90b9d01SCy Schubert# These elements are added after the 'vendor_elements'.
3280*a90b9d01SCy Schubert#presp_elements=
32815b9c547cSRui Paulo
328239beb93cSSam Leffler##### Multiple BSSID support ##################################################
328339beb93cSSam Leffler#
328439beb93cSSam Leffler# Above configuration is using the default interface (wlan#, or multi-SSID VLAN
328539beb93cSSam Leffler# interfaces). Other BSSIDs can be added by using separator 'bss' with
328639beb93cSSam Leffler# default interface name to be allocated for the data packets of the new BSS.
328739beb93cSSam Leffler#
328839beb93cSSam Leffler# hostapd will generate BSSID mask based on the BSSIDs that are
328939beb93cSSam Leffler# configured. hostapd will verify that dev_addr & MASK == dev_addr. If this is
329039beb93cSSam Leffler# not the case, the MAC address of the radio must be changed before starting
3291e28a4053SRui Paulo# hostapd (ifconfig wlan0 hw ether <MAC addr>). If a BSSID is configured for
3292e28a4053SRui Paulo# every secondary BSS, this limitation is not applied at hostapd and other
3293e28a4053SRui Paulo# masks may be used if the driver supports them (e.g., swap the locally
3294e28a4053SRui Paulo# administered bit)
329539beb93cSSam Leffler#
329639beb93cSSam Leffler# BSSIDs are assigned in order to each BSS, unless an explicit BSSID is
329739beb93cSSam Leffler# specified using the 'bssid' parameter.
329839beb93cSSam Leffler# If an explicit BSSID is specified, it must be chosen such that it:
329939beb93cSSam Leffler# - results in a valid MASK that covers it and the dev_addr
330039beb93cSSam Leffler# - is not the same as the MAC address of the radio
330139beb93cSSam Leffler# - is not the same as any other explicitly specified BSSID
330239beb93cSSam Leffler#
3303780fb4a2SCy Schubert# Alternatively, the 'use_driver_iface_addr' parameter can be used to request
3304780fb4a2SCy Schubert# hostapd to use the driver auto-generated interface address (e.g., to use the
3305780fb4a2SCy Schubert# exact MAC addresses allocated to the device).
3306780fb4a2SCy Schubert#
33075b9c547cSRui Paulo# Not all drivers support multiple BSSes. The exact mechanism for determining
33085b9c547cSRui Paulo# the driver capabilities is driver specific. With the current (i.e., a recent
33095b9c547cSRui Paulo# kernel) drivers using nl80211, this information can be checked with "iw list"
33105b9c547cSRui Paulo# (search for "valid interface combinations").
33115b9c547cSRui Paulo#
331239beb93cSSam Leffler# Please note that hostapd uses some of the values configured for the first BSS
331339beb93cSSam Leffler# as the defaults for the following BSSes. However, it is recommended that all
331439beb93cSSam Leffler# BSSes include explicit configuration of all relevant configuration items.
331539beb93cSSam Leffler#
331639beb93cSSam Leffler#bss=wlan0_0
331739beb93cSSam Leffler#ssid=test2
331839beb93cSSam Leffler# most of the above items can be used here (apart from radio interface specific
331939beb93cSSam Leffler# items, like channel)
332039beb93cSSam Leffler
332139beb93cSSam Leffler#bss=wlan0_1
332239beb93cSSam Leffler#bssid=00:13:10:95:fe:0b
332339beb93cSSam Leffler# ...
3324*a90b9d01SCy Schubert#
3325*a90b9d01SCy Schubert# Multiple BSSID Advertisement in IEEE 802.11ax
3326*a90b9d01SCy Schubert# IEEE Std 802.11ax-2021 added a feature where instead of multiple interfaces
3327*a90b9d01SCy Schubert# on a common radio transmitting individual Beacon frames, those interfaces can
3328*a90b9d01SCy Schubert# form a set with a common Beacon frame transmitted for all. The interface
3329*a90b9d01SCy Schubert# which is brought up first is called the transmitting profile of the MBSSID
3330*a90b9d01SCy Schubert# set which transmits the Beacon frames. The remaining interfaces are called
3331*a90b9d01SCy Schubert# the non-transmitting profiles and these are advertised inside the Multiple
3332*a90b9d01SCy Schubert# BSSID element in the Beacon and Probe Response frames from the first
3333*a90b9d01SCy Schubert# interface.
3334*a90b9d01SCy Schubert#
3335*a90b9d01SCy Schubert# The transmitting interface is visible to all stations in the vicinity, however
3336*a90b9d01SCy Schubert# the stations that do not support parsing of the Multiple BSSID element will
3337*a90b9d01SCy Schubert# not be able to connect to the non-transmitting interfaces.
3338*a90b9d01SCy Schubert#
3339*a90b9d01SCy Schubert# Enhanced Multiple BSSID Advertisements (EMA)
3340*a90b9d01SCy Schubert# When enabled, the non-transmitting interfaces are split into multiple
3341*a90b9d01SCy Schubert# Beacon frames. The number of Beacon frames required to cover all the
3342*a90b9d01SCy Schubert# non-transmitting profiles is called the profile periodicity.
3343*a90b9d01SCy Schubert#
3344*a90b9d01SCy Schubert# Refer to IEEE Std 802.11-2020 for details regarding the procedure and
3345*a90b9d01SCy Schubert# required MAC address assignment.
3346*a90b9d01SCy Schubert#
3347*a90b9d01SCy Schubert# Following configuration is per radio.
3348*a90b9d01SCy Schubert# 0 = Disabled (default)
3349*a90b9d01SCy Schubert# 1 = Multiple BSSID advertisement enabled.
3350*a90b9d01SCy Schubert# 2 = Enhanced multiple BSSID advertisement enabled.
3351*a90b9d01SCy Schubert#mbssid=0
3352*a90b9d01SCy Schubert#
3353*a90b9d01SCy Schubert# The transmitting interface should be added with the 'interface' option while
3354*a90b9d01SCy Schubert# the non-transmitting interfaces should be added using the 'bss' option.
3355*a90b9d01SCy Schubert# Security configuration should be added separately per interface, if required.
3356*a90b9d01SCy Schubert#
3357*a90b9d01SCy Schubert# Example:
3358*a90b9d01SCy Schubert#mbssid=2
3359*a90b9d01SCy Schubert#interface=wlan2
3360*a90b9d01SCy Schubert#ctrl_interface=/var/run/hostapd
3361*a90b9d01SCy Schubert#wpa_passphrase=0123456789
3362*a90b9d01SCy Schubert#ieee80211w=2
3363*a90b9d01SCy Schubert#sae_pwe=1
3364*a90b9d01SCy Schubert#auth_algs=1
3365*a90b9d01SCy Schubert#wpa=2
3366*a90b9d01SCy Schubert#wpa_pairwise=CCMP
3367*a90b9d01SCy Schubert#ssid=<SSID-0>
3368*a90b9d01SCy Schubert#bridge=br-lan
3369*a90b9d01SCy Schubert#wpa_key_mgmt=SAE
3370*a90b9d01SCy Schubert#bssid=00:03:7f:12:84:84
3371*a90b9d01SCy Schubert#
3372*a90b9d01SCy Schubert#bss=wlan2-1
3373*a90b9d01SCy Schubert#ctrl_interface=/var/run/hostapd
3374*a90b9d01SCy Schubert#wpa_passphrase=0123456789
3375*a90b9d01SCy Schubert#ieee80211w=2
3376*a90b9d01SCy Schubert#sae_pwe=1
3377*a90b9d01SCy Schubert#auth_algs=1
3378*a90b9d01SCy Schubert#wpa=2
3379*a90b9d01SCy Schubert#wpa_pairwise=CCMP
3380*a90b9d01SCy Schubert#ssid=<SSID-1>
3381*a90b9d01SCy Schubert#bridge=br-lan
3382*a90b9d01SCy Schubert#wpa_key_mgmt=SAE
3383*a90b9d01SCy Schubert#bssid=00:03:7f:12:84:85
3384