hostapd.conf revision 1.1.1.10 1 1.1 christos ##### hostapd configuration file ##############################################
2 1.1 christos # Empty lines and lines starting with # are ignored
3 1.1 christos
4 1.1 christos # AP netdevice name (without 'ap' postfix, i.e., wlan0 uses wlan0ap for
5 1.1.1.6 christos # management frames with the Host AP driver); wlan0 with many nl80211 drivers
6 1.1.1.7 christos # Note: This attribute can be overridden by the values supplied with the '-i'
7 1.1.1.7 christos # command line parameter.
8 1.1 christos interface=wlan0
9 1.1 christos
10 1.1.1.6 christos # In case of atheros and nl80211 driver interfaces, an additional
11 1.1 christos # configuration parameter, bridge, may be used to notify hostapd if the
12 1.1 christos # interface is included in a bridge. This parameter is not used with Host AP
13 1.1 christos # driver. If the bridge parameter is not set, the drivers will automatically
14 1.1 christos # figure out the bridge interface (assuming sysfs is enabled and mounted to
15 1.1 christos # /sys) and this parameter may not be needed.
16 1.1 christos #
17 1.1 christos # For nl80211, this parameter can be used to request the AP interface to be
18 1.1 christos # added to the bridge automatically (brctl may refuse to do this before hostapd
19 1.1 christos # has been started to change the interface mode). If needed, the bridge
20 1.1 christos # interface is also created.
21 1.1 christos #bridge=br0
22 1.1 christos
23 1.1.1.6 christos # Driver interface type (hostap/wired/none/nl80211/bsd);
24 1.1 christos # default: hostap). nl80211 is used with all Linux mac80211 drivers.
25 1.1 christos # Use driver=none if building hostapd as a standalone RADIUS server that does
26 1.1 christos # not control any wireless/wired driver.
27 1.1 christos # driver=hostap
28 1.1 christos
29 1.1.1.6 christos # Driver interface parameters (mainly for development testing use)
30 1.1.1.6 christos # driver_params=<params>
31 1.1.1.6 christos
32 1.1 christos # hostapd event logger configuration
33 1.1 christos #
34 1.1 christos # Two output method: syslog and stdout (only usable if not forking to
35 1.1 christos # background).
36 1.1 christos #
37 1.1 christos # Module bitfield (ORed bitfield of modules that will be logged; -1 = all
38 1.1 christos # modules):
39 1.1 christos # bit 0 (1) = IEEE 802.11
40 1.1 christos # bit 1 (2) = IEEE 802.1X
41 1.1 christos # bit 2 (4) = RADIUS
42 1.1 christos # bit 3 (8) = WPA
43 1.1 christos # bit 4 (16) = driver interface
44 1.1 christos # bit 6 (64) = MLME
45 1.1 christos #
46 1.1 christos # Levels (minimum value for logged events):
47 1.1 christos # 0 = verbose debugging
48 1.1 christos # 1 = debugging
49 1.1 christos # 2 = informational messages
50 1.1 christos # 3 = notification
51 1.1 christos # 4 = warning
52 1.1 christos #
53 1.1 christos logger_syslog=-1
54 1.1 christos logger_syslog_level=2
55 1.1 christos logger_stdout=-1
56 1.1 christos logger_stdout_level=2
57 1.1 christos
58 1.1 christos # Interface for separate control program. If this is specified, hostapd
59 1.1 christos # will create this directory and a UNIX domain socket for listening to requests
60 1.1 christos # from external programs (CLI/GUI, etc.) for status information and
61 1.1 christos # configuration. The socket file will be named based on the interface name, so
62 1.1 christos # multiple hostapd processes/interfaces can be run at the same time if more
63 1.1 christos # than one interface is used.
64 1.1 christos # /var/run/hostapd is the recommended directory for sockets and by default,
65 1.1 christos # hostapd_cli will use it when trying to connect with hostapd.
66 1.1 christos ctrl_interface=/var/run/hostapd
67 1.1 christos
68 1.1 christos # Access control for the control interface can be configured by setting the
69 1.1 christos # directory to allow only members of a group to use sockets. This way, it is
70 1.1 christos # possible to run hostapd as root (since it needs to change network
71 1.1 christos # configuration and open raw sockets) and still allow GUI/CLI components to be
72 1.1 christos # run as non-root users. However, since the control interface can be used to
73 1.1 christos # change the network configuration, this access needs to be protected in many
74 1.1 christos # cases. By default, hostapd is configured to use gid 0 (root). If you
75 1.1.1.10 christos # want to allow non-root users to use the control interface, add a new group
76 1.1 christos # and change this value to match with that group. Add users that should have
77 1.1 christos # control interface access to this group.
78 1.1 christos #
79 1.1 christos # This variable can be a group name or gid.
80 1.1 christos #ctrl_interface_group=wheel
81 1.1 christos ctrl_interface_group=0
82 1.1 christos
83 1.1 christos
84 1.1 christos ##### IEEE 802.11 related configuration #######################################
85 1.1 christos
86 1.1 christos # SSID to be used in IEEE 802.11 management frames
87 1.1 christos ssid=test
88 1.1.1.4 christos # Alternative formats for configuring SSID
89 1.1.1.4 christos # (double quoted string, hexdump, printf-escaped string)
90 1.1.1.4 christos #ssid2="test"
91 1.1.1.4 christos #ssid2=74657374
92 1.1.1.4 christos #ssid2=P"hello\nthere"
93 1.1.1.4 christos
94 1.1.1.4 christos # UTF-8 SSID: Whether the SSID is to be interpreted using UTF-8 encoding
95 1.1.1.4 christos #utf8_ssid=1
96 1.1 christos
97 1.1 christos # Country code (ISO/IEC 3166-1). Used to set regulatory domain.
98 1.1 christos # Set as needed to indicate country in which device is operating.
99 1.1 christos # This can limit available channels and transmit power.
100 1.1.1.8 christos # These two octets are used as the first two octets of the Country String
101 1.1.1.8 christos # (dot11CountryString)
102 1.1 christos #country_code=US
103 1.1 christos
104 1.1.1.8 christos # The third octet of the Country String (dot11CountryString)
105 1.1.1.8 christos # This parameter is used to set the third octet of the country string.
106 1.1.1.8 christos #
107 1.1.1.8 christos # All environments of the current frequency band and country (default)
108 1.1.1.8 christos #country3=0x20
109 1.1.1.8 christos # Outdoor environment only
110 1.1.1.8 christos #country3=0x4f
111 1.1.1.8 christos # Indoor environment only
112 1.1.1.8 christos #country3=0x49
113 1.1.1.8 christos # Noncountry entity (country_code=XX)
114 1.1.1.8 christos #country3=0x58
115 1.1.1.8 christos # IEEE 802.11 standard Annex E table indication: 0x01 .. 0x1f
116 1.1.1.8 christos # Annex E, Table E-4 (Global operating classes)
117 1.1.1.8 christos #country3=0x04
118 1.1.1.8 christos
119 1.1 christos # Enable IEEE 802.11d. This advertises the country_code and the set of allowed
120 1.1 christos # channels and transmit power levels based on the regulatory limits. The
121 1.1 christos # country_code setting must be configured with the correct country for
122 1.1 christos # IEEE 802.11d functions.
123 1.1 christos # (default: 0 = disabled)
124 1.1 christos #ieee80211d=1
125 1.1 christos
126 1.1.1.5 christos # Enable IEEE 802.11h. This enables radar detection and DFS support if
127 1.1.1.5 christos # available. DFS support is required on outdoor 5 GHz channels in most countries
128 1.1.1.5 christos # of the world. This can be used only with ieee80211d=1.
129 1.1.1.5 christos # (default: 0 = disabled)
130 1.1.1.5 christos #ieee80211h=1
131 1.1.1.5 christos
132 1.1.1.5 christos # Add Power Constraint element to Beacon and Probe Response frames
133 1.1.1.5 christos # This config option adds Power Constraint element when applicable and Country
134 1.1.1.5 christos # element is added. Power Constraint element is required by Transmit Power
135 1.1.1.5 christos # Control. This can be used only with ieee80211d=1.
136 1.1.1.5 christos # Valid values are 0..255.
137 1.1.1.5 christos #local_pwr_constraint=3
138 1.1.1.5 christos
139 1.1.1.5 christos # Set Spectrum Management subfield in the Capability Information field.
140 1.1.1.5 christos # This config option forces the Spectrum Management bit to be set. When this
141 1.1.1.5 christos # option is not set, the value of the Spectrum Management bit depends on whether
142 1.1.1.5 christos # DFS or TPC is required by regulatory authorities. This can be used only with
143 1.1.1.5 christos # ieee80211d=1 and local_pwr_constraint configured.
144 1.1.1.5 christos #spectrum_mgmt_required=1
145 1.1.1.5 christos
146 1.1.1.7 christos # Operation mode (a = IEEE 802.11a (5 GHz), b = IEEE 802.11b (2.4 GHz),
147 1.1.1.7 christos # g = IEEE 802.11g (2.4 GHz), ad = IEEE 802.11ad (60 GHz); a/g options are used
148 1.1.1.7 christos # with IEEE 802.11n (HT), too, to specify band). For IEEE 802.11ac (VHT), this
149 1.1.1.10 christos # needs to be set to hw_mode=a. For IEEE 802.11ax (HE) on 6 GHz this needs
150 1.1.1.10 christos # to be set to hw_mode=a. When using ACS (see channel parameter), a
151 1.1.1.7 christos # special value "any" can be used to indicate that any support band can be used.
152 1.1.1.7 christos # This special case is currently supported only with drivers with which
153 1.1.1.7 christos # offloaded ACS is used.
154 1.1 christos # Default: IEEE 802.11b
155 1.1.1.3 christos hw_mode=g
156 1.1 christos
157 1.1 christos # Channel number (IEEE 802.11)
158 1.1 christos # (default: 0, i.e., not set)
159 1.1.1.3 christos # Please note that some drivers do not use this value from hostapd and the
160 1.1.1.3 christos # channel will need to be configured separately with iwconfig.
161 1.1.1.5 christos #
162 1.1.1.5 christos # If CONFIG_ACS build option is enabled, the channel can be selected
163 1.1.1.5 christos # automatically at run time by setting channel=acs_survey or channel=0, both of
164 1.1.1.5 christos # which will enable the ACS survey based algorithm.
165 1.1.1.3 christos channel=1
166 1.1 christos
167 1.1.1.10 christos # Global operating class (IEEE 802.11, Annex E, Table E-4)
168 1.1.1.10 christos # This option allows hostapd to specify the operating class of the channel
169 1.1.1.10 christos # configured with the channel parameter. channel and op_class together can
170 1.1.1.10 christos # uniquely identify channels across different bands, including the 6 GHz band.
171 1.1.1.10 christos #op_class=131
172 1.1.1.10 christos
173 1.1.1.5 christos # ACS tuning - Automatic Channel Selection
174 1.1.1.10 christos # See: https://wireless.wiki.kernel.org/en/users/documentation/acs
175 1.1.1.5 christos #
176 1.1.1.5 christos # You can customize the ACS survey algorithm with following variables:
177 1.1.1.5 christos #
178 1.1.1.5 christos # acs_num_scans requirement is 1..100 - number of scans to be performed that
179 1.1.1.5 christos # are used to trigger survey data gathering of an underlying device driver.
180 1.1.1.5 christos # Scans are passive and typically take a little over 100ms (depending on the
181 1.1.1.5 christos # driver) on each available channel for given hw_mode. Increasing this value
182 1.1.1.5 christos # means sacrificing startup time and gathering more data wrt channel
183 1.1.1.5 christos # interference that may help choosing a better channel. This can also help fine
184 1.1.1.5 christos # tune the ACS scan time in case a driver has different scan dwell times.
185 1.1.1.5 christos #
186 1.1.1.6 christos # acs_chan_bias is a space-separated list of <channel>:<bias> pairs. It can be
187 1.1.1.6 christos # used to increase (or decrease) the likelihood of a specific channel to be
188 1.1.1.6 christos # selected by the ACS algorithm. The total interference factor for each channel
189 1.1.1.6 christos # gets multiplied by the specified bias value before finding the channel with
190 1.1.1.6 christos # the lowest value. In other words, values between 0.0 and 1.0 can be used to
191 1.1.1.6 christos # make a channel more likely to be picked while values larger than 1.0 make the
192 1.1.1.6 christos # specified channel less likely to be picked. This can be used, e.g., to prefer
193 1.1.1.6 christos # the commonly used 2.4 GHz band channels 1, 6, and 11 (which is the default
194 1.1.1.6 christos # behavior on 2.4 GHz band if no acs_chan_bias parameter is specified).
195 1.1.1.6 christos #
196 1.1.1.5 christos # Defaults:
197 1.1.1.5 christos #acs_num_scans=5
198 1.1.1.6 christos #acs_chan_bias=1:0.8 6:0.8 11:0.8
199 1.1.1.5 christos
200 1.1.1.5 christos # Channel list restriction. This option allows hostapd to select one of the
201 1.1.1.6 christos # provided channels when a channel should be automatically selected.
202 1.1.1.7 christos # Channel list can be provided as range using hyphen ('-') or individual
203 1.1.1.7 christos # channels can be specified by space (' ') separated values
204 1.1.1.7 christos # Default: all channels allowed in selected hw_mode
205 1.1.1.5 christos #chanlist=100 104 108 112 116
206 1.1.1.7 christos #chanlist=1 6 11-13
207 1.1.1.5 christos
208 1.1.1.10 christos # Frequency list restriction. This option allows hostapd to select one of the
209 1.1.1.10 christos # provided frequencies when a frequency should be automatically selected.
210 1.1.1.10 christos # Frequency list can be provided as range using hyphen ('-') or individual
211 1.1.1.10 christos # frequencies can be specified by comma (',') separated values
212 1.1.1.10 christos # Default: all frequencies allowed in selected hw_mode
213 1.1.1.10 christos #freqlist=2437,5955,5975
214 1.1.1.10 christos #freqlist=2437,5985-6105
215 1.1.1.10 christos
216 1.1.1.8 christos # Exclude DFS channels from ACS
217 1.1.1.8 christos # This option can be used to exclude all DFS channels from the ACS channel list
218 1.1.1.8 christos # in cases where the driver supports DFS channels.
219 1.1.1.8 christos #acs_exclude_dfs=1
220 1.1.1.8 christos
221 1.1.1.10 christos # Include only preferred scan channels from 6 GHz band for ACS
222 1.1.1.10 christos # This option can be used to include only preferred scan channels in the 6 GHz
223 1.1.1.10 christos # band. This can be useful in particular for devices that operate only a 6 GHz
224 1.1.1.10 christos # BSS without a collocated 2.4/5 GHz BSS.
225 1.1.1.10 christos # Default behavior is to include all PSC and non-PSC channels.
226 1.1.1.10 christos #acs_exclude_6ghz_non_psc=1
227 1.1.1.10 christos
228 1.1.1.10 christos # Enable background radar feature
229 1.1.1.10 christos # This feature allows CAC to be run on dedicated radio RF chains while the
230 1.1.1.10 christos # radio(s) are otherwise running normal AP activities on other channels.
231 1.1.1.10 christos # This requires that the driver and the radio support it before feature will
232 1.1.1.10 christos # actually be enabled, i.e., this parameter value is ignored with drivers that
233 1.1.1.10 christos # do not advertise support for the capability.
234 1.1.1.10 christos # 0: Leave disabled (default)
235 1.1.1.10 christos # 1: Enable it.
236 1.1.1.10 christos #enable_background_radar=1
237 1.1.1.10 christos
238 1.1.1.10 christos # Set minimum permitted max TX power (in dBm) for ACS and DFS channel selection.
239 1.1.1.10 christos # (default 0, i.e., not constraint)
240 1.1.1.10 christos #min_tx_power=20
241 1.1.1.10 christos
242 1.1 christos # Beacon interval in kus (1.024 ms) (default: 100; range 15..65535)
243 1.1 christos beacon_int=100
244 1.1 christos
245 1.1.1.3 christos # DTIM (delivery traffic information message) period (range 1..255):
246 1.1 christos # number of beacons between DTIMs (1 = every beacon includes DTIM element)
247 1.1 christos # (default: 2)
248 1.1 christos dtim_period=2
249 1.1 christos
250 1.1 christos # Maximum number of stations allowed in station table. New stations will be
251 1.1 christos # rejected after the station table is full. IEEE 802.11 has a limit of 2007
252 1.1 christos # different association IDs, so this number should not be larger than that.
253 1.1 christos # (default: 2007)
254 1.1 christos max_num_sta=255
255 1.1 christos
256 1.1.1.7 christos # RTS/CTS threshold; -1 = disabled (default); range -1..65535
257 1.1 christos # If this field is not included in hostapd.conf, hostapd will not control
258 1.1 christos # RTS threshold and 'iwconfig wlan# rts <val>' can be used to set it.
259 1.1.1.7 christos rts_threshold=-1
260 1.1 christos
261 1.1.1.7 christos # Fragmentation threshold; -1 = disabled (default); range -1, 256..2346
262 1.1 christos # If this field is not included in hostapd.conf, hostapd will not control
263 1.1 christos # fragmentation threshold and 'iwconfig wlan# frag <val>' can be used to set
264 1.1 christos # it.
265 1.1.1.7 christos fragm_threshold=-1
266 1.1 christos
267 1.1 christos # Rate configuration
268 1.1 christos # Default is to enable all rates supported by the hardware. This configuration
269 1.1 christos # item allows this list be filtered so that only the listed rates will be left
270 1.1 christos # in the list. If the list is empty, all rates are used. This list can have
271 1.1 christos # entries that are not in the list of rates the hardware supports (such entries
272 1.1 christos # are ignored). The entries in this list are in 100 kbps, i.e., 11 Mbps = 110.
273 1.1 christos # If this item is present, at least one rate have to be matching with the rates
274 1.1 christos # hardware supports.
275 1.1 christos # default: use the most common supported rate setting for the selected
276 1.1 christos # hw_mode (i.e., this line can be removed from configuration file in most
277 1.1 christos # cases)
278 1.1 christos #supported_rates=10 20 55 110 60 90 120 180 240 360 480 540
279 1.1 christos
280 1.1 christos # Basic rate set configuration
281 1.1 christos # List of rates (in 100 kbps) that are included in the basic rate set.
282 1.1 christos # If this item is not included, usually reasonable default set is used.
283 1.1 christos #basic_rates=10 20
284 1.1 christos #basic_rates=10 20 55 110
285 1.1 christos #basic_rates=60 120 240
286 1.1 christos
287 1.1.1.8 christos # Beacon frame TX rate configuration
288 1.1.1.8 christos # This sets the TX rate that is used to transmit Beacon frames. If this item is
289 1.1.1.8 christos # not included, the driver default rate (likely lowest rate) is used.
290 1.1.1.8 christos # Legacy (CCK/OFDM rates):
291 1.1.1.8 christos # beacon_rate=<legacy rate in 100 kbps>
292 1.1.1.8 christos # HT:
293 1.1.1.8 christos # beacon_rate=ht:<HT MCS>
294 1.1.1.8 christos # VHT:
295 1.1.1.8 christos # beacon_rate=vht:<VHT MCS>
296 1.1.1.10 christos # HE:
297 1.1.1.10 christos # beacon_rate=he:<HE MCS>
298 1.1.1.8 christos #
299 1.1.1.8 christos # For example, beacon_rate=10 for 1 Mbps or beacon_rate=60 for 6 Mbps (OFDM).
300 1.1.1.8 christos #beacon_rate=10
301 1.1.1.8 christos
302 1.1 christos # Short Preamble
303 1.1 christos # This parameter can be used to enable optional use of short preamble for
304 1.1 christos # frames sent at 2 Mbps, 5.5 Mbps, and 11 Mbps to improve network performance.
305 1.1 christos # This applies only to IEEE 802.11b-compatible networks and this should only be
306 1.1 christos # enabled if the local hardware supports use of short preamble. If any of the
307 1.1 christos # associated STAs do not support short preamble, use of short preamble will be
308 1.1 christos # disabled (and enabled when such STAs disassociate) dynamically.
309 1.1 christos # 0 = do not allow use of short preamble (default)
310 1.1 christos # 1 = allow use of short preamble
311 1.1 christos #preamble=1
312 1.1 christos
313 1.1 christos # Station MAC address -based authentication
314 1.1 christos # Please note that this kind of access control requires a driver that uses
315 1.1 christos # hostapd to take care of management frame processing and as such, this can be
316 1.1.1.6 christos # used with driver=hostap or driver=nl80211, but not with driver=atheros.
317 1.1 christos # 0 = accept unless in deny list
318 1.1 christos # 1 = deny unless in accept list
319 1.1 christos # 2 = use external RADIUS server (accept/deny lists are searched first)
320 1.1 christos macaddr_acl=0
321 1.1 christos
322 1.1 christos # Accept/deny lists are read from separate files (containing list of
323 1.1 christos # MAC addresses, one per line). Use absolute path name to make sure that the
324 1.1 christos # files can be read on SIGHUP configuration reloads.
325 1.1 christos #accept_mac_file=/etc/hostapd.accept
326 1.1 christos #deny_mac_file=/etc/hostapd.deny
327 1.1 christos
328 1.1 christos # IEEE 802.11 specifies two authentication algorithms. hostapd can be
329 1.1 christos # configured to allow both of these or only one. Open system authentication
330 1.1 christos # should be used with IEEE 802.1X.
331 1.1 christos # Bit fields of allowed authentication algorithms:
332 1.1 christos # bit 0 = Open System Authentication
333 1.1 christos # bit 1 = Shared Key Authentication (requires WEP)
334 1.1 christos auth_algs=3
335 1.1 christos
336 1.1 christos # Send empty SSID in beacons and ignore probe request frames that do not
337 1.1 christos # specify full SSID, i.e., require stations to know SSID.
338 1.1 christos # default: disabled (0)
339 1.1 christos # 1 = send empty (length=0) SSID in beacon and ignore probe request for
340 1.1 christos # broadcast SSID
341 1.1 christos # 2 = clear SSID (ASCII 0), but keep the original length (this may be required
342 1.1 christos # with some clients that do not support empty SSID) and ignore probe
343 1.1 christos # requests for broadcast SSID
344 1.1 christos ignore_broadcast_ssid=0
345 1.1 christos
346 1.1.1.7 christos # Do not reply to broadcast Probe Request frames from unassociated STA if there
347 1.1.1.7 christos # is no room for additional stations (max_num_sta). This can be used to
348 1.1.1.7 christos # discourage a STA from trying to associate with this AP if the association
349 1.1.1.7 christos # would be rejected due to maximum STA limit.
350 1.1.1.7 christos # Default: 0 (disabled)
351 1.1.1.7 christos #no_probe_resp_if_max_sta=0
352 1.1.1.7 christos
353 1.1.1.7 christos # Additional vendor specific elements for Beacon and Probe Response frames
354 1.1.1.4 christos # This parameter can be used to add additional vendor specific element(s) into
355 1.1.1.4 christos # the end of the Beacon and Probe Response frames. The format for these
356 1.1.1.4 christos # element(s) is a hexdump of the raw information elements (id+len+payload for
357 1.1.1.4 christos # one or more elements)
358 1.1.1.4 christos #vendor_elements=dd0411223301
359 1.1.1.4 christos
360 1.1.1.7 christos # Additional vendor specific elements for (Re)Association Response frames
361 1.1.1.7 christos # This parameter can be used to add additional vendor specific element(s) into
362 1.1.1.7 christos # the end of the (Re)Association Response frames. The format for these
363 1.1.1.7 christos # element(s) is a hexdump of the raw information elements (id+len+payload for
364 1.1.1.7 christos # one or more elements)
365 1.1.1.7 christos #assocresp_elements=dd0411223301
366 1.1.1.7 christos
367 1.1 christos # TX queue parameters (EDCF / bursting)
368 1.1 christos # tx_queue_<queue name>_<param>
369 1.1.1.8 christos # queues: data0, data1, data2, data3
370 1.1 christos # (data0 is the highest priority queue)
371 1.1 christos # parameters:
372 1.1 christos # aifs: AIFS (default 2)
373 1.1.1.7 christos # cwmin: cwMin (1, 3, 7, 15, 31, 63, 127, 255, 511, 1023, 2047, 4095, 8191,
374 1.1.1.7 christos # 16383, 32767)
375 1.1.1.7 christos # cwmax: cwMax (same values as cwMin, cwMax >= cwMin)
376 1.1 christos # burst: maximum length (in milliseconds with precision of up to 0.1 ms) for
377 1.1 christos # bursting
378 1.1 christos #
379 1.1 christos # Default WMM parameters (IEEE 802.11 draft; 11-03-0504-03-000e):
380 1.1 christos # These parameters are used by the access point when transmitting frames
381 1.1 christos # to the clients.
382 1.1 christos #
383 1.1 christos # Low priority / AC_BK = background
384 1.1 christos #tx_queue_data3_aifs=7
385 1.1 christos #tx_queue_data3_cwmin=15
386 1.1 christos #tx_queue_data3_cwmax=1023
387 1.1 christos #tx_queue_data3_burst=0
388 1.1 christos # Note: for IEEE 802.11b mode: cWmin=31 cWmax=1023 burst=0
389 1.1 christos #
390 1.1 christos # Normal priority / AC_BE = best effort
391 1.1 christos #tx_queue_data2_aifs=3
392 1.1 christos #tx_queue_data2_cwmin=15
393 1.1 christos #tx_queue_data2_cwmax=63
394 1.1 christos #tx_queue_data2_burst=0
395 1.1 christos # Note: for IEEE 802.11b mode: cWmin=31 cWmax=127 burst=0
396 1.1 christos #
397 1.1 christos # High priority / AC_VI = video
398 1.1 christos #tx_queue_data1_aifs=1
399 1.1 christos #tx_queue_data1_cwmin=7
400 1.1 christos #tx_queue_data1_cwmax=15
401 1.1 christos #tx_queue_data1_burst=3.0
402 1.1 christos # Note: for IEEE 802.11b mode: cWmin=15 cWmax=31 burst=6.0
403 1.1 christos #
404 1.1 christos # Highest priority / AC_VO = voice
405 1.1 christos #tx_queue_data0_aifs=1
406 1.1 christos #tx_queue_data0_cwmin=3
407 1.1 christos #tx_queue_data0_cwmax=7
408 1.1 christos #tx_queue_data0_burst=1.5
409 1.1 christos # Note: for IEEE 802.11b mode: cWmin=7 cWmax=15 burst=3.3
410 1.1 christos
411 1.1 christos # 802.1D Tag (= UP) to AC mappings
412 1.1 christos # WMM specifies following mapping of data frames to different ACs. This mapping
413 1.1 christos # can be configured using Linux QoS/tc and sch_pktpri.o module.
414 1.1 christos # 802.1D Tag 802.1D Designation Access Category WMM Designation
415 1.1 christos # 1 BK AC_BK Background
416 1.1 christos # 2 - AC_BK Background
417 1.1 christos # 0 BE AC_BE Best Effort
418 1.1 christos # 3 EE AC_BE Best Effort
419 1.1 christos # 4 CL AC_VI Video
420 1.1 christos # 5 VI AC_VI Video
421 1.1 christos # 6 VO AC_VO Voice
422 1.1 christos # 7 NC AC_VO Voice
423 1.1 christos # Data frames with no priority information: AC_BE
424 1.1 christos # Management frames: AC_VO
425 1.1 christos # PS-Poll frames: AC_BE
426 1.1 christos
427 1.1 christos # Default WMM parameters (IEEE 802.11 draft; 11-03-0504-03-000e):
428 1.1 christos # for 802.11a or 802.11g networks
429 1.1 christos # These parameters are sent to WMM clients when they associate.
430 1.1 christos # The parameters will be used by WMM clients for frames transmitted to the
431 1.1 christos # access point.
432 1.1 christos #
433 1.1 christos # note - txop_limit is in units of 32microseconds
434 1.1 christos # note - acm is admission control mandatory flag. 0 = admission control not
435 1.1 christos # required, 1 = mandatory
436 1.1.1.7 christos # note - Here cwMin and cmMax are in exponent form. The actual cw value used
437 1.1.1.7 christos # will be (2^n)-1 where n is the value given here. The allowed range for these
438 1.1.1.7 christos # wmm_ac_??_{cwmin,cwmax} is 0..15 with cwmax >= cwmin.
439 1.1 christos #
440 1.1 christos wmm_enabled=1
441 1.1 christos #
442 1.1 christos # WMM-PS Unscheduled Automatic Power Save Delivery [U-APSD]
443 1.1 christos # Enable this flag if U-APSD supported outside hostapd (eg., Firmware/driver)
444 1.1 christos #uapsd_advertisement_enabled=1
445 1.1 christos #
446 1.1 christos # Low priority / AC_BK = background
447 1.1 christos wmm_ac_bk_cwmin=4
448 1.1 christos wmm_ac_bk_cwmax=10
449 1.1 christos wmm_ac_bk_aifs=7
450 1.1 christos wmm_ac_bk_txop_limit=0
451 1.1 christos wmm_ac_bk_acm=0
452 1.1 christos # Note: for IEEE 802.11b mode: cWmin=5 cWmax=10
453 1.1 christos #
454 1.1 christos # Normal priority / AC_BE = best effort
455 1.1 christos wmm_ac_be_aifs=3
456 1.1 christos wmm_ac_be_cwmin=4
457 1.1 christos wmm_ac_be_cwmax=10
458 1.1 christos wmm_ac_be_txop_limit=0
459 1.1 christos wmm_ac_be_acm=0
460 1.1 christos # Note: for IEEE 802.11b mode: cWmin=5 cWmax=7
461 1.1 christos #
462 1.1 christos # High priority / AC_VI = video
463 1.1 christos wmm_ac_vi_aifs=2
464 1.1 christos wmm_ac_vi_cwmin=3
465 1.1 christos wmm_ac_vi_cwmax=4
466 1.1 christos wmm_ac_vi_txop_limit=94
467 1.1 christos wmm_ac_vi_acm=0
468 1.1 christos # Note: for IEEE 802.11b mode: cWmin=4 cWmax=5 txop_limit=188
469 1.1 christos #
470 1.1 christos # Highest priority / AC_VO = voice
471 1.1 christos wmm_ac_vo_aifs=2
472 1.1 christos wmm_ac_vo_cwmin=2
473 1.1 christos wmm_ac_vo_cwmax=3
474 1.1 christos wmm_ac_vo_txop_limit=47
475 1.1 christos wmm_ac_vo_acm=0
476 1.1 christos # Note: for IEEE 802.11b mode: cWmin=3 cWmax=4 burst=102
477 1.1 christos
478 1.1.1.9 christos # Enable Multi-AP functionality
479 1.1.1.9 christos # 0 = disabled (default)
480 1.1.1.9 christos # 1 = AP support backhaul BSS
481 1.1.1.9 christos # 2 = AP support fronthaul BSS
482 1.1.1.9 christos # 3 = AP supports both backhaul BSS and fronthaul BSS
483 1.1.1.9 christos #multi_ap=0
484 1.1.1.9 christos
485 1.1 christos # Static WEP key configuration
486 1.1 christos #
487 1.1 christos # The key number to use when transmitting.
488 1.1 christos # It must be between 0 and 3, and the corresponding key must be set.
489 1.1 christos # default: not set
490 1.1 christos #wep_default_key=0
491 1.1 christos # The WEP keys to use.
492 1.1 christos # A key may be a quoted string or unquoted hexadecimal digits.
493 1.1 christos # The key length should be 5, 13, or 16 characters, or 10, 26, or 32
494 1.1 christos # digits, depending on whether 40-bit (64-bit), 104-bit (128-bit), or
495 1.1 christos # 128-bit (152-bit) WEP is used.
496 1.1 christos # Only the default key must be supplied; the others are optional.
497 1.1 christos # default: not set
498 1.1 christos #wep_key0=123456789a
499 1.1 christos #wep_key1="vwxyz"
500 1.1 christos #wep_key2=0102030405060708090a0b0c0d
501 1.1 christos #wep_key3=".2.4.6.8.0.23"
502 1.1 christos
503 1.1 christos # Station inactivity limit
504 1.1 christos #
505 1.1 christos # If a station does not send anything in ap_max_inactivity seconds, an
506 1.1 christos # empty data frame is sent to it in order to verify whether it is
507 1.1 christos # still in range. If this frame is not ACKed, the station will be
508 1.1 christos # disassociated and then deauthenticated. This feature is used to
509 1.1 christos # clear station table of old entries when the STAs move out of the
510 1.1 christos # range.
511 1.1 christos #
512 1.1 christos # The station can associate again with the AP if it is still in range;
513 1.1 christos # this inactivity poll is just used as a nicer way of verifying
514 1.1 christos # inactivity; i.e., client will not report broken connection because
515 1.1 christos # disassociation frame is not sent immediately without first polling
516 1.1 christos # the STA with a data frame.
517 1.1 christos # default: 300 (i.e., 5 minutes)
518 1.1 christos #ap_max_inactivity=300
519 1.1.1.4 christos #
520 1.1.1.4 christos # The inactivity polling can be disabled to disconnect stations based on
521 1.1.1.4 christos # inactivity timeout so that idle stations are more likely to be disconnected
522 1.1.1.4 christos # even if they are still in range of the AP. This can be done by setting
523 1.1.1.4 christos # skip_inactivity_poll to 1 (default 0).
524 1.1.1.4 christos #skip_inactivity_poll=0
525 1.1.1.10 christos #
526 1.1.1.10 christos # BSS max idle period management
527 1.1.1.10 christos # 0 = disabled (do not advertise and manage BSS max idle period)
528 1.1.1.10 christos # 1 = enabled (advertise and manage BSS max idle period; default)
529 1.1.1.10 christos # 2 = enabled requiring protected frames (advertise and manage BSS max idle
530 1.1.1.10 christos # period and require STAs to use protected keep-alive frames)
531 1.1.1.10 christos #bss_max_idle=1
532 1.1.1.10 christos #
533 1.1.1.10 christos # Maximum acceptable BSS maximum idle period
534 1.1.1.10 christos # If this is set to a nonzero value, the AP allows STAs to request different
535 1.1.1.10 christos # maximum idle period values. This is in the units to 1000 TUs (1.024 s)
536 1.1.1.10 christos #max_acceptable_idle_period=600
537 1.1.1.10 christos #
538 1.1.1.10 christos # Allow STA to skip group key handshake without getting disconnection when
539 1.1.1.10 christos # BSS max idle period management is enabled.
540 1.1.1.10 christos # 0 = disconnect STA if it does not reply to group key handshake (default)
541 1.1.1.10 christos # 1 = do not disconnect STA if it does not reply to group key handshake and
542 1.1.1.10 christos # if BSS max idle period management is enabled
543 1.1.1.10 christos #no_disconnect_on_group_keyerror=0
544 1.1 christos
545 1.1.1.3 christos # Disassociate stations based on excessive transmission failures or other
546 1.1.1.3 christos # indications of connection loss. This depends on the driver capabilities and
547 1.1.1.3 christos # may not be available with all drivers.
548 1.1.1.3 christos #disassoc_low_ack=1
549 1.1.1.3 christos
550 1.1 christos # Maximum allowed Listen Interval (how many Beacon periods STAs are allowed to
551 1.1 christos # remain asleep). Default: 65535 (no limit apart from field size)
552 1.1 christos #max_listen_interval=100
553 1.1 christos
554 1.1 christos # WDS (4-address frame) mode with per-station virtual interfaces
555 1.1 christos # (only supported with driver=nl80211)
556 1.1 christos # This mode allows associated stations to use 4-address frames to allow layer 2
557 1.1 christos # bridging to be used.
558 1.1 christos #wds_sta=1
559 1.1 christos
560 1.1.1.3 christos # If bridge parameter is set, the WDS STA interface will be added to the same
561 1.1.1.3 christos # bridge by default. This can be overridden with the wds_bridge parameter to
562 1.1.1.3 christos # use a separate bridge.
563 1.1.1.3 christos #wds_bridge=wds-br0
564 1.1.1.3 christos
565 1.1.1.5 christos # Start the AP with beaconing disabled by default.
566 1.1.1.5 christos #start_disabled=0
567 1.1.1.5 christos
568 1.1.1.3 christos # Client isolation can be used to prevent low-level bridging of frames between
569 1.1.1.3 christos # associated stations in the BSS. By default, this bridging is allowed.
570 1.1.1.3 christos #ap_isolate=1
571 1.1.1.3 christos
572 1.1.1.6 christos # BSS Load update period (in BUs)
573 1.1.1.6 christos # This field is used to enable and configure adding a BSS Load element into
574 1.1.1.6 christos # Beacon and Probe Response frames.
575 1.1.1.6 christos #bss_load_update_period=50
576 1.1.1.6 christos
577 1.1.1.8 christos # Channel utilization averaging period (in BUs)
578 1.1.1.8 christos # This field is used to enable and configure channel utilization average
579 1.1.1.8 christos # calculation with bss_load_update_period. This should be in multiples of
580 1.1.1.8 christos # bss_load_update_period for more accurate calculation.
581 1.1.1.8 christos #chan_util_avg_period=600
582 1.1.1.8 christos
583 1.1.1.5 christos # Fixed BSS Load value for testing purposes
584 1.1.1.5 christos # This field can be used to configure hostapd to add a fixed BSS Load element
585 1.1.1.5 christos # into Beacon and Probe Response frames for testing purposes. The format is
586 1.1.1.5 christos # <station count>:<channel utilization>:<available admission capacity>
587 1.1.1.5 christos #bss_load_test=12:80:20000
588 1.1.1.5 christos
589 1.1.1.8 christos # Multicast to unicast conversion
590 1.1.1.8 christos # Request that the AP will do multicast-to-unicast conversion for ARP, IPv4, and
591 1.1.1.8 christos # IPv6 frames (possibly within 802.1Q). If enabled, such frames are to be sent
592 1.1.1.8 christos # to each station separately, with the DA replaced by their own MAC address
593 1.1.1.8 christos # rather than the group address.
594 1.1.1.8 christos #
595 1.1.1.8 christos # Note that this may break certain expectations of the receiver, such as the
596 1.1.1.8 christos # ability to drop unicast IP packets received within multicast L2 frames, or the
597 1.1.1.8 christos # ability to not send ICMP destination unreachable messages for packets received
598 1.1.1.8 christos # in L2 multicast (which is required, but the receiver can't tell the difference
599 1.1.1.8 christos # if this new option is enabled).
600 1.1.1.8 christos #
601 1.1.1.8 christos # This also doesn't implement the 802.11 DMS (directed multicast service).
602 1.1.1.8 christos #
603 1.1.1.8 christos #multicast_to_unicast=0
604 1.1.1.8 christos
605 1.1.1.8 christos # Send broadcast Deauthentication frame on AP start/stop
606 1.1.1.8 christos # Default: 1 (enabled)
607 1.1.1.8 christos #broadcast_deauth=1
608 1.1.1.8 christos
609 1.1.1.10 christos # Get notifications for received Management frames on control interface
610 1.1.1.10 christos # Default: 0 (disabled)
611 1.1.1.10 christos #notify_mgmt_frames=0
612 1.1.1.10 christos
613 1.1 christos ##### IEEE 802.11n related configuration ######################################
614 1.1 christos
615 1.1 christos # ieee80211n: Whether IEEE 802.11n (HT) is enabled
616 1.1 christos # 0 = disabled (default)
617 1.1 christos # 1 = enabled
618 1.1 christos # Note: You will also need to enable WMM for full HT functionality.
619 1.1.1.7 christos # Note: hw_mode=g (2.4 GHz) and hw_mode=a (5 GHz) is used to specify the band.
620 1.1 christos #ieee80211n=1
621 1.1 christos
622 1.1.1.10 christos # disable_11n: Boolean (0/1) to disable HT for a specific BSS
623 1.1.1.10 christos #disable_11n=0
624 1.1.1.10 christos
625 1.1 christos # ht_capab: HT capabilities (list of flags)
626 1.1 christos # LDPC coding capability: [LDPC] = supported
627 1.1 christos # Supported channel width set: [HT40-] = both 20 MHz and 40 MHz with secondary
628 1.1 christos # channel below the primary channel; [HT40+] = both 20 MHz and 40 MHz
629 1.1.1.5 christos # with secondary channel above the primary channel
630 1.1 christos # (20 MHz only if neither is set)
631 1.1 christos # Note: There are limits on which channels can be used with HT40- and
632 1.1 christos # HT40+. Following table shows the channels that may be available for
633 1.1 christos # HT40- and HT40+ use per IEEE 802.11n Annex J:
634 1.1 christos # freq HT40- HT40+
635 1.1 christos # 2.4 GHz 5-13 1-7 (1-9 in Europe/Japan)
636 1.1 christos # 5 GHz 40,48,56,64 36,44,52,60
637 1.1 christos # (depending on the location, not all of these channels may be available
638 1.1 christos # for use)
639 1.1 christos # Please note that 40 MHz channels may switch their primary and secondary
640 1.1 christos # channels if needed or creation of 40 MHz channel maybe rejected based
641 1.1 christos # on overlapping BSSes. These changes are done automatically when hostapd
642 1.1 christos # is setting up the 40 MHz channel.
643 1.1 christos # HT-greenfield: [GF] (disabled if not set)
644 1.1 christos # Short GI for 20 MHz: [SHORT-GI-20] (disabled if not set)
645 1.1 christos # Short GI for 40 MHz: [SHORT-GI-40] (disabled if not set)
646 1.1 christos # Tx STBC: [TX-STBC] (disabled if not set)
647 1.1 christos # Rx STBC: [RX-STBC1] (one spatial stream), [RX-STBC12] (one or two spatial
648 1.1 christos # streams), or [RX-STBC123] (one, two, or three spatial streams); Rx STBC
649 1.1 christos # disabled if none of these set
650 1.1 christos # HT-delayed Block Ack: [DELAYED-BA] (disabled if not set)
651 1.1 christos # Maximum A-MSDU length: [MAX-AMSDU-7935] for 7935 octets (3839 octets if not
652 1.1 christos # set)
653 1.1 christos # DSSS/CCK Mode in 40 MHz: [DSSS_CCK-40] = allowed (not allowed if not set)
654 1.1.1.5 christos # 40 MHz intolerant [40-INTOLERANT] (not advertised if not set)
655 1.1 christos # L-SIG TXOP protection support: [LSIG-TXOP-PROT] (disabled if not set)
656 1.1 christos #ht_capab=[HT40-][SHORT-GI-20][SHORT-GI-40]
657 1.1 christos
658 1.1.1.3 christos # Require stations to support HT PHY (reject association if they do not)
659 1.1.1.3 christos #require_ht=1
660 1.1.1.3 christos
661 1.1.1.5 christos # If set non-zero, require stations to perform scans of overlapping
662 1.1.1.5 christos # channels to test for stations which would be affected by 40 MHz traffic.
663 1.1.1.6 christos # This parameter sets the interval in seconds between these scans. Setting this
664 1.1.1.6 christos # to non-zero allows 2.4 GHz band AP to move dynamically to a 40 MHz channel if
665 1.1.1.6 christos # no co-existence issues with neighboring devices are found.
666 1.1.1.5 christos #obss_interval=0
667 1.1.1.5 christos
668 1.1.1.10 christos # ht_vht_twt_responder: Whether TWT responder is enabled in HT and VHT modes
669 1.1.1.10 christos # 0 = disable; Disable TWT responder support in HT and VHT modes (default).
670 1.1.1.10 christos # 1 = enable; Enable TWT responder support in HT and VHT modes if supported by
671 1.1.1.10 christos # the driver.
672 1.1.1.10 christos #ht_vht_twt_responder=0
673 1.1.1.10 christos
674 1.1.1.4 christos ##### IEEE 802.11ac related configuration #####################################
675 1.1.1.4 christos
676 1.1.1.4 christos # ieee80211ac: Whether IEEE 802.11ac (VHT) is enabled
677 1.1.1.4 christos # 0 = disabled (default)
678 1.1.1.4 christos # 1 = enabled
679 1.1.1.4 christos # Note: You will also need to enable WMM for full VHT functionality.
680 1.1.1.7 christos # Note: hw_mode=a is used to specify that 5 GHz band is used with VHT.
681 1.1.1.4 christos #ieee80211ac=1
682 1.1.1.4 christos
683 1.1.1.10 christos # disable_11ac: Boolean (0/1) to disable VHT for a specific BSS
684 1.1.1.10 christos #disable_11ac=0
685 1.1.1.10 christos
686 1.1.1.4 christos # vht_capab: VHT capabilities (list of flags)
687 1.1.1.4 christos #
688 1.1.1.4 christos # vht_max_mpdu_len: [MAX-MPDU-7991] [MAX-MPDU-11454]
689 1.1.1.4 christos # Indicates maximum MPDU length
690 1.1.1.4 christos # 0 = 3895 octets (default)
691 1.1.1.4 christos # 1 = 7991 octets
692 1.1.1.4 christos # 2 = 11454 octets
693 1.1.1.4 christos # 3 = reserved
694 1.1.1.4 christos #
695 1.1.1.4 christos # supported_chan_width: [VHT160] [VHT160-80PLUS80]
696 1.1.1.4 christos # Indicates supported Channel widths
697 1.1.1.4 christos # 0 = 160 MHz & 80+80 channel widths are not supported (default)
698 1.1.1.4 christos # 1 = 160 MHz channel width is supported
699 1.1.1.4 christos # 2 = 160 MHz & 80+80 channel widths are supported
700 1.1.1.4 christos # 3 = reserved
701 1.1.1.4 christos #
702 1.1.1.4 christos # Rx LDPC coding capability: [RXLDPC]
703 1.1.1.4 christos # Indicates support for receiving LDPC coded pkts
704 1.1.1.4 christos # 0 = Not supported (default)
705 1.1.1.4 christos # 1 = Supported
706 1.1.1.4 christos #
707 1.1.1.4 christos # Short GI for 80 MHz: [SHORT-GI-80]
708 1.1.1.4 christos # Indicates short GI support for reception of packets transmitted with TXVECTOR
709 1.1.1.4 christos # params format equal to VHT and CBW = 80Mhz
710 1.1.1.4 christos # 0 = Not supported (default)
711 1.1.1.4 christos # 1 = Supported
712 1.1.1.4 christos #
713 1.1.1.4 christos # Short GI for 160 MHz: [SHORT-GI-160]
714 1.1.1.4 christos # Indicates short GI support for reception of packets transmitted with TXVECTOR
715 1.1.1.4 christos # params format equal to VHT and CBW = 160Mhz
716 1.1.1.4 christos # 0 = Not supported (default)
717 1.1.1.4 christos # 1 = Supported
718 1.1.1.4 christos #
719 1.1.1.4 christos # Tx STBC: [TX-STBC-2BY1]
720 1.1.1.4 christos # Indicates support for the transmission of at least 2x1 STBC
721 1.1.1.4 christos # 0 = Not supported (default)
722 1.1.1.4 christos # 1 = Supported
723 1.1.1.4 christos #
724 1.1.1.4 christos # Rx STBC: [RX-STBC-1] [RX-STBC-12] [RX-STBC-123] [RX-STBC-1234]
725 1.1.1.4 christos # Indicates support for the reception of PPDUs using STBC
726 1.1.1.4 christos # 0 = Not supported (default)
727 1.1.1.4 christos # 1 = support of one spatial stream
728 1.1.1.4 christos # 2 = support of one and two spatial streams
729 1.1.1.4 christos # 3 = support of one, two and three spatial streams
730 1.1.1.4 christos # 4 = support of one, two, three and four spatial streams
731 1.1.1.4 christos # 5,6,7 = reserved
732 1.1.1.4 christos #
733 1.1.1.4 christos # SU Beamformer Capable: [SU-BEAMFORMER]
734 1.1.1.4 christos # Indicates support for operation as a single user beamformer
735 1.1.1.4 christos # 0 = Not supported (default)
736 1.1.1.4 christos # 1 = Supported
737 1.1.1.4 christos #
738 1.1.1.4 christos # SU Beamformee Capable: [SU-BEAMFORMEE]
739 1.1.1.4 christos # Indicates support for operation as a single user beamformee
740 1.1.1.4 christos # 0 = Not supported (default)
741 1.1.1.4 christos # 1 = Supported
742 1.1.1.4 christos #
743 1.1.1.7 christos # Compressed Steering Number of Beamformer Antennas Supported:
744 1.1.1.7 christos # [BF-ANTENNA-2] [BF-ANTENNA-3] [BF-ANTENNA-4]
745 1.1.1.4 christos # Beamformee's capability indicating the maximum number of beamformer
746 1.1.1.4 christos # antennas the beamformee can support when sending compressed beamforming
747 1.1.1.4 christos # feedback
748 1.1.1.4 christos # If SU beamformer capable, set to maximum value minus 1
749 1.1.1.4 christos # else reserved (default)
750 1.1.1.4 christos #
751 1.1.1.7 christos # Number of Sounding Dimensions:
752 1.1.1.7 christos # [SOUNDING-DIMENSION-2] [SOUNDING-DIMENSION-3] [SOUNDING-DIMENSION-4]
753 1.1.1.4 christos # Beamformer's capability indicating the maximum value of the NUM_STS parameter
754 1.1.1.4 christos # in the TXVECTOR of a VHT NDP
755 1.1.1.4 christos # If SU beamformer capable, set to maximum value minus 1
756 1.1.1.4 christos # else reserved (default)
757 1.1.1.4 christos #
758 1.1.1.4 christos # MU Beamformer Capable: [MU-BEAMFORMER]
759 1.1.1.4 christos # Indicates support for operation as an MU beamformer
760 1.1.1.4 christos # 0 = Not supported or sent by Non-AP STA (default)
761 1.1.1.4 christos # 1 = Supported
762 1.1.1.4 christos #
763 1.1.1.4 christos # VHT TXOP PS: [VHT-TXOP-PS]
764 1.1.1.4 christos # Indicates whether or not the AP supports VHT TXOP Power Save Mode
765 1.1.1.4 christos # or whether or not the STA is in VHT TXOP Power Save mode
766 1.1.1.7 christos # 0 = VHT AP doesn't support VHT TXOP PS mode (OR) VHT STA not in VHT TXOP PS
767 1.1.1.4 christos # mode
768 1.1.1.7 christos # 1 = VHT AP supports VHT TXOP PS mode (OR) VHT STA is in VHT TXOP power save
769 1.1.1.4 christos # mode
770 1.1.1.4 christos #
771 1.1.1.4 christos # +HTC-VHT Capable: [HTC-VHT]
772 1.1.1.4 christos # Indicates whether or not the STA supports receiving a VHT variant HT Control
773 1.1.1.4 christos # field.
774 1.1.1.4 christos # 0 = Not supported (default)
775 1.1.1.4 christos # 1 = supported
776 1.1.1.4 christos #
777 1.1.1.4 christos # Maximum A-MPDU Length Exponent: [MAX-A-MPDU-LEN-EXP0]..[MAX-A-MPDU-LEN-EXP7]
778 1.1.1.4 christos # Indicates the maximum length of A-MPDU pre-EOF padding that the STA can recv
779 1.1.1.4 christos # This field is an integer in the range of 0 to 7.
780 1.1.1.4 christos # The length defined by this field is equal to
781 1.1.1.4 christos # 2 pow(13 + Maximum A-MPDU Length Exponent) -1 octets
782 1.1.1.4 christos #
783 1.1.1.4 christos # VHT Link Adaptation Capable: [VHT-LINK-ADAPT2] [VHT-LINK-ADAPT3]
784 1.1.1.4 christos # Indicates whether or not the STA supports link adaptation using VHT variant
785 1.1.1.4 christos # HT Control field
786 1.1.1.4 christos # If +HTC-VHTcapable is 1
787 1.1.1.4 christos # 0 = (no feedback) if the STA does not provide VHT MFB (default)
788 1.1.1.4 christos # 1 = reserved
789 1.1.1.4 christos # 2 = (Unsolicited) if the STA provides only unsolicited VHT MFB
790 1.1.1.4 christos # 3 = (Both) if the STA can provide VHT MFB in response to VHT MRQ and if the
791 1.1.1.4 christos # STA provides unsolicited VHT MFB
792 1.1.1.4 christos # Reserved if +HTC-VHTcapable is 0
793 1.1.1.4 christos #
794 1.1.1.4 christos # Rx Antenna Pattern Consistency: [RX-ANTENNA-PATTERN]
795 1.1.1.4 christos # Indicates the possibility of Rx antenna pattern change
796 1.1.1.4 christos # 0 = Rx antenna pattern might change during the lifetime of an association
797 1.1.1.4 christos # 1 = Rx antenna pattern does not change during the lifetime of an association
798 1.1.1.4 christos #
799 1.1.1.4 christos # Tx Antenna Pattern Consistency: [TX-ANTENNA-PATTERN]
800 1.1.1.4 christos # Indicates the possibility of Tx antenna pattern change
801 1.1.1.4 christos # 0 = Tx antenna pattern might change during the lifetime of an association
802 1.1.1.4 christos # 1 = Tx antenna pattern does not change during the lifetime of an association
803 1.1.1.4 christos #vht_capab=[SHORT-GI-80][HTC-VHT]
804 1.1.1.4 christos #
805 1.1.1.4 christos # Require stations to support VHT PHY (reject association if they do not)
806 1.1.1.4 christos #require_vht=1
807 1.1.1.4 christos
808 1.1.1.4 christos # 0 = 20 or 40 MHz operating Channel width
809 1.1.1.4 christos # 1 = 80 MHz channel width
810 1.1.1.4 christos # 2 = 160 MHz channel width
811 1.1.1.4 christos # 3 = 80+80 MHz channel width
812 1.1.1.4 christos #vht_oper_chwidth=1
813 1.1.1.4 christos #
814 1.1.1.4 christos # center freq = 5 GHz + (5 * index)
815 1.1.1.4 christos # So index 42 gives center freq 5.210 GHz
816 1.1.1.4 christos # which is channel 42 in 5G band
817 1.1.1.4 christos #
818 1.1.1.4 christos #vht_oper_centr_freq_seg0_idx=42
819 1.1.1.4 christos #
820 1.1.1.4 christos # center freq = 5 GHz + (5 * index)
821 1.1.1.4 christos # So index 159 gives center freq 5.795 GHz
822 1.1.1.4 christos # which is channel 159 in 5G band
823 1.1.1.4 christos #
824 1.1.1.4 christos #vht_oper_centr_freq_seg1_idx=159
825 1.1.1.4 christos
826 1.1.1.7 christos # Workaround to use station's nsts capability in (Re)Association Response frame
827 1.1.1.7 christos # This may be needed with some deployed devices as an interoperability
828 1.1.1.7 christos # workaround for beamforming if the AP's capability is greater than the
829 1.1.1.7 christos # station's capability. This is disabled by default and can be enabled by
830 1.1.1.7 christos # setting use_sta_nsts=1.
831 1.1.1.7 christos #use_sta_nsts=0
832 1.1.1.7 christos
833 1.1.1.8 christos ##### IEEE 802.11ax related configuration #####################################
834 1.1.1.8 christos
835 1.1.1.8 christos #ieee80211ax: Whether IEEE 802.11ax (HE) is enabled
836 1.1.1.8 christos # 0 = disabled (default)
837 1.1.1.8 christos # 1 = enabled
838 1.1.1.8 christos #ieee80211ax=1
839 1.1.1.8 christos
840 1.1.1.10 christos # Require stations to support HE PHY (reject association if they do not)
841 1.1.1.10 christos #require_he=1
842 1.1.1.10 christos
843 1.1.1.10 christos # disable_11ax: Boolean (0/1) to disable HE for a specific BSS
844 1.1.1.10 christos #disable_11ax=0
845 1.1.1.10 christos
846 1.1.1.8 christos #he_su_beamformer: HE single user beamformer support
847 1.1.1.8 christos # 0 = not supported (default)
848 1.1.1.8 christos # 1 = supported
849 1.1.1.8 christos #he_su_beamformer=1
850 1.1.1.8 christos
851 1.1.1.8 christos #he_su_beamformee: HE single user beamformee support
852 1.1.1.8 christos # 0 = not supported (default)
853 1.1.1.8 christos # 1 = supported
854 1.1.1.8 christos #he_su_beamformee=1
855 1.1.1.8 christos
856 1.1.1.8 christos #he_mu_beamformer: HE multiple user beamformer support
857 1.1.1.8 christos # 0 = not supported (default)
858 1.1.1.8 christos # 1 = supported
859 1.1.1.8 christos #he_mu_beamformer=1
860 1.1.1.8 christos
861 1.1.1.9 christos # he_bss_color: BSS color (1-63)
862 1.1.1.9 christos #he_bss_color=1
863 1.1.1.8 christos
864 1.1.1.10 christos # he_bss_color_partial: BSS color AID equation
865 1.1.1.10 christos #he_bss_color_partial=0
866 1.1.1.10 christos
867 1.1.1.8 christos #he_default_pe_duration: The duration of PE field in an HE PPDU in us
868 1.1.1.8 christos # Possible values are 0 us (default), 4 us, 8 us, 12 us, and 16 us
869 1.1.1.8 christos #he_default_pe_duration=0
870 1.1.1.8 christos
871 1.1.1.8 christos #he_twt_required: Whether TWT is required
872 1.1.1.8 christos # 0 = not required (default)
873 1.1.1.8 christos # 1 = required
874 1.1.1.8 christos #he_twt_required=0
875 1.1.1.8 christos
876 1.1.1.10 christos #he_twt_responder: Whether TWT (HE) responder is enabled
877 1.1.1.10 christos # 0 = disabled
878 1.1.1.10 christos # 1 = enabled if supported by the driver (default)
879 1.1.1.10 christos #he_twt_responder=1
880 1.1.1.10 christos
881 1.1.1.8 christos #he_rts_threshold: Duration of STA transmission
882 1.1.1.8 christos # 0 = not set (default)
883 1.1.1.8 christos # unsigned integer = duration in units of 16 us
884 1.1.1.8 christos #he_rts_threshold=0
885 1.1.1.8 christos
886 1.1.1.10 christos #he_er_su_disable: Disable 242-tone HE ER SU PPDU reception by the AP
887 1.1.1.10 christos # 0 = enable reception (default)
888 1.1.1.10 christos # 1 = disable reception
889 1.1.1.10 christos #he_er_su_disable=0
890 1.1.1.10 christos
891 1.1.1.9 christos # HE operating channel information; see matching vht_* parameters for details.
892 1.1.1.10 christos # he_oper_centr_freq_seg0_idx field is used to indicate center frequency of 80
893 1.1.1.10 christos # and 160 MHz bandwidth operation. In 80+80 MHz operation, it is the center
894 1.1.1.10 christos # frequency of the lower frequency segment. he_oper_centr_freq_seg1_idx field
895 1.1.1.10 christos # is used only with 80+80 MHz bandwidth operation and it is used to transmit
896 1.1.1.10 christos # the center frequency of the second segment.
897 1.1.1.10 christos # On the 6 GHz band the center freq calculation starts from 5.950 GHz offset.
898 1.1.1.10 christos # For example idx=3 would result in 5965 MHz center frequency. In addition,
899 1.1.1.10 christos # he_oper_chwidth is ignored, and the channel width is derived from the
900 1.1.1.10 christos # configured operating class or center frequency indexes (see
901 1.1.1.10 christos # IEEE P802.11ax/D6.1 Annex E, Table E-4).
902 1.1.1.10 christos #he_oper_chwidth (see vht_oper_chwidth)
903 1.1.1.9 christos #he_oper_centr_freq_seg0_idx
904 1.1.1.9 christos #he_oper_centr_freq_seg1_idx
905 1.1.1.9 christos
906 1.1.1.9 christos #he_basic_mcs_nss_set: Basic NSS/MCS set
907 1.1.1.9 christos # 16-bit combination of 2-bit values of Max HE-MCS For 1..8 SS; each 2-bit
908 1.1.1.9 christos # value having following meaning:
909 1.1.1.9 christos # 0 = HE-MCS 0-7, 1 = HE-MCS 0-9, 2 = HE-MCS 0-11, 3 = not supported
910 1.1.1.9 christos #he_basic_mcs_nss_set
911 1.1.1.9 christos
912 1.1.1.9 christos #he_mu_edca_qos_info_param_count
913 1.1.1.9 christos #he_mu_edca_qos_info_q_ack
914 1.1.1.9 christos #he_mu_edca_qos_info_queue_request=1
915 1.1.1.9 christos #he_mu_edca_qos_info_txop_request
916 1.1.1.9 christos #he_mu_edca_ac_be_aifsn=0
917 1.1.1.9 christos #he_mu_edca_ac_be_ecwmin=15
918 1.1.1.9 christos #he_mu_edca_ac_be_ecwmax=15
919 1.1.1.9 christos #he_mu_edca_ac_be_timer=255
920 1.1.1.9 christos #he_mu_edca_ac_bk_aifsn=0
921 1.1.1.9 christos #he_mu_edca_ac_bk_aci=1
922 1.1.1.9 christos #he_mu_edca_ac_bk_ecwmin=15
923 1.1.1.9 christos #he_mu_edca_ac_bk_ecwmax=15
924 1.1.1.9 christos #he_mu_edca_ac_bk_timer=255
925 1.1.1.9 christos #he_mu_edca_ac_vi_ecwmin=15
926 1.1.1.9 christos #he_mu_edca_ac_vi_ecwmax=15
927 1.1.1.9 christos #he_mu_edca_ac_vi_aifsn=0
928 1.1.1.9 christos #he_mu_edca_ac_vi_aci=2
929 1.1.1.9 christos #he_mu_edca_ac_vi_timer=255
930 1.1.1.9 christos #he_mu_edca_ac_vo_aifsn=0
931 1.1.1.9 christos #he_mu_edca_ac_vo_aci=3
932 1.1.1.9 christos #he_mu_edca_ac_vo_ecwmin=15
933 1.1.1.9 christos #he_mu_edca_ac_vo_ecwmax=15
934 1.1.1.9 christos #he_mu_edca_ac_vo_timer=255
935 1.1.1.9 christos
936 1.1.1.9 christos # Spatial Reuse Parameter Set
937 1.1.1.10 christos #
938 1.1.1.10 christos # SR Control field value
939 1.1.1.10 christos # B0 = PSR Disallowed
940 1.1.1.10 christos # B1 = Non-SRG OBSS PD SR Disallowed
941 1.1.1.10 christos # B2 = Non-SRG Offset Present
942 1.1.1.10 christos # B3 = SRG Information Present
943 1.1.1.10 christos # B4 = HESIGA_Spatial_reuse_value15_allowed
944 1.1.1.9 christos #he_spr_sr_control
945 1.1.1.10 christos #
946 1.1.1.10 christos # Non-SRG OBSS PD Max Offset (included if he_spr_sr_control B2=1)
947 1.1.1.9 christos #he_spr_non_srg_obss_pd_max_offset
948 1.1.1.10 christos
949 1.1.1.10 christos # SRG OBSS PD Min Offset (included if he_spr_sr_control B3=1)
950 1.1.1.9 christos #he_spr_srg_obss_pd_min_offset
951 1.1.1.10 christos #
952 1.1.1.10 christos # SRG OBSS PD Max Offset (included if he_spr_sr_control B3=1)
953 1.1.1.9 christos #he_spr_srg_obss_pd_max_offset
954 1.1.1.10 christos #
955 1.1.1.10 christos # SPR SRG BSS Color (included if he_spr_sr_control B3=1)
956 1.1.1.10 christos # This config represents SRG BSS Color Bitmap field of Spatial Reuse Parameter
957 1.1.1.10 christos # Set element that indicates the BSS color values used by members of the
958 1.1.1.10 christos # SRG of which the transmitting STA is a member. The value is in range of 0-63.
959 1.1.1.10 christos #he_spr_srg_bss_colors=1 2 10 63
960 1.1.1.10 christos #
961 1.1.1.10 christos # SPR SRG Partial BSSID (included if he_spr_sr_control B3=1)
962 1.1.1.10 christos # This config represents SRG Partial BSSID Bitmap field of Spatial Reuse
963 1.1.1.10 christos # Parameter Set element that indicates the Partial BSSID values used by members
964 1.1.1.10 christos # of the SRG of which the transmitting STA is a member. The value range
965 1.1.1.10 christos # corresponds to one of the 64 possible values of BSSID[39:44], where the lowest
966 1.1.1.10 christos # numbered bit corresponds to Partial BSSID value 0 and the highest numbered bit
967 1.1.1.10 christos # corresponds to Partial BSSID value 63.
968 1.1.1.10 christos #he_spr_srg_partial_bssid=0 1 3 63
969 1.1.1.10 christos #
970 1.1.1.10 christos #he_6ghz_max_mpdu: Maximum MPDU Length of HE 6 GHz band capabilities.
971 1.1.1.10 christos # Indicates maximum MPDU length
972 1.1.1.10 christos # 0 = 3895 octets
973 1.1.1.10 christos # 1 = 7991 octets
974 1.1.1.10 christos # 2 = 11454 octets (default)
975 1.1.1.10 christos #he_6ghz_max_mpdu=2
976 1.1.1.10 christos #
977 1.1.1.10 christos #he_6ghz_max_ampdu_len_exp: Maximum A-MPDU Length Exponent of HE 6 GHz band
978 1.1.1.10 christos # capabilities. Indicates the maximum length of A-MPDU pre-EOF padding that
979 1.1.1.10 christos # the STA can receive. This field is an integer in the range of 0 to 7.
980 1.1.1.10 christos # The length defined by this field is equal to
981 1.1.1.10 christos # 2 pow(13 + Maximum A-MPDU Length Exponent) -1 octets
982 1.1.1.10 christos # 0 = AMPDU length of 8k
983 1.1.1.10 christos # 1 = AMPDU length of 16k
984 1.1.1.10 christos # 2 = AMPDU length of 32k
985 1.1.1.10 christos # 3 = AMPDU length of 65k
986 1.1.1.10 christos # 4 = AMPDU length of 131k
987 1.1.1.10 christos # 5 = AMPDU length of 262k
988 1.1.1.10 christos # 6 = AMPDU length of 524k
989 1.1.1.10 christos # 7 = AMPDU length of 1048k (default)
990 1.1.1.10 christos #he_6ghz_max_ampdu_len_exp=7
991 1.1.1.10 christos #
992 1.1.1.10 christos #he_6ghz_rx_ant_pat: Rx Antenna Pattern Consistency of HE 6 GHz capability.
993 1.1.1.10 christos # Indicates the possibility of Rx antenna pattern change
994 1.1.1.10 christos # 0 = Rx antenna pattern might change during the lifetime of an association
995 1.1.1.10 christos # 1 = Rx antenna pattern does not change during the lifetime of an association
996 1.1.1.10 christos # (default)
997 1.1.1.10 christos #he_6ghz_rx_ant_pat=1
998 1.1.1.10 christos #
999 1.1.1.10 christos #he_6ghz_tx_ant_pat: Tx Antenna Pattern Consistency of HE 6 GHz capability.
1000 1.1.1.10 christos # Indicates the possibility of Tx antenna pattern change
1001 1.1.1.10 christos # 0 = Tx antenna pattern might change during the lifetime of an association
1002 1.1.1.10 christos # 1 = Tx antenna pattern does not change during the lifetime of an association
1003 1.1.1.10 christos # (default)
1004 1.1.1.10 christos #he_6ghz_tx_ant_pat=1
1005 1.1.1.10 christos
1006 1.1.1.10 christos # 6 GHz Access Point type
1007 1.1.1.10 christos # This config is to set the 6 GHz Access Point type. Possible options are:
1008 1.1.1.10 christos # 0 = Indoor AP
1009 1.1.1.10 christos # 1 = Standard power AP
1010 1.1.1.10 christos # 2 = Very low power AP (default)
1011 1.1.1.10 christos # 3 = Indoor enabled AP
1012 1.1.1.10 christos # 4 = Indoor standard power AP
1013 1.1.1.10 christos # This has no impact for operation on other bands.
1014 1.1.1.10 christos # See IEEE P802.11-REVme/D4.0, Table E-12 (Regulatory Info subfield encoding)
1015 1.1.1.10 christos # for more details.
1016 1.1.1.10 christos #he_6ghz_reg_pwr_type=0
1017 1.1.1.10 christos #
1018 1.1.1.10 christos # 6 GHz Maximum Tx Power used in Transmit Power Envelope elements, where the
1019 1.1.1.10 christos # "Transmit Power Interpretation" is set to "Regulatory client EIRP PSD".
1020 1.1.1.10 christos # For Maximum Transmit Power Category subfield encoding set to default (0):
1021 1.1.1.10 christos #reg_def_cli_eirp_psd=-1
1022 1.1.1.10 christos # For Maximum Transmit Power Category subfield encoding set to subordinate (1):
1023 1.1.1.10 christos #reg_sub_cli_eirp_psd=-1
1024 1.1.1.10 christos
1025 1.1.1.10 christos # Unsolicited broadcast Probe Response transmission settings
1026 1.1.1.10 christos # This is for the 6 GHz band only. If the interval is set to a non-zero value,
1027 1.1.1.10 christos # the AP schedules unsolicited broadcast Probe Response frames to be
1028 1.1.1.10 christos # transmitted for in-band discovery. Refer to
1029 1.1.1.10 christos # IEEE P802.11ax/D8.0 26.17.2.3.2, AP behavior for fast passive scanning.
1030 1.1.1.10 christos # Valid range: 0..20 TUs; default is 0 (disabled)
1031 1.1.1.10 christos #unsol_bcast_probe_resp_interval=0
1032 1.1.1.10 christos
1033 1.1.1.10 christos ##### IEEE 802.11be related configuration #####################################
1034 1.1.1.10 christos
1035 1.1.1.10 christos #ieee80211be: Whether IEEE 802.11be (EHT) is enabled
1036 1.1.1.10 christos # 0 = disabled (default)
1037 1.1.1.10 christos # 1 = enabled
1038 1.1.1.10 christos #ieee80211be=1
1039 1.1.1.10 christos
1040 1.1.1.10 christos #disable_11be: Boolean (0/1) to disable EHT for a specific BSS
1041 1.1.1.10 christos #disable_11be=0
1042 1.1.1.10 christos
1043 1.1.1.10 christos #eht_su_beamformer: EHT single user beamformer support
1044 1.1.1.10 christos # 0 = not supported (default)
1045 1.1.1.10 christos # 1 = supported
1046 1.1.1.10 christos #eht_su_beamformer=1
1047 1.1.1.10 christos
1048 1.1.1.10 christos #eht_su_beamformee: EHT single user beamformee support
1049 1.1.1.10 christos # 0 = not supported (default)
1050 1.1.1.10 christos # 1 = supported
1051 1.1.1.10 christos #eht_su_beamformee=1
1052 1.1.1.10 christos
1053 1.1.1.10 christos #eht_mu_beamformer: EHT multiple user beamformer support
1054 1.1.1.10 christos # 0 = not supported (default)
1055 1.1.1.10 christos # 1 = supported
1056 1.1.1.10 christos #eht_mu_beamformer=1
1057 1.1.1.10 christos
1058 1.1.1.10 christos # EHT operating channel information; see matching he_* parameters for details.
1059 1.1.1.10 christos # The field eht_oper_centr_freq_seg0_idx field is used to indicate center
1060 1.1.1.10 christos # frequency of 40, 80, and 160 MHz bandwidth operation.
1061 1.1.1.10 christos # In the 6 GHz band, eht_oper_chwidth is ignored and the channel width is
1062 1.1.1.10 christos # derived from the configured operating class (IEEE P802.11be/D1.5,
1063 1.1.1.10 christos # Annex E.1 - Country information and operating classes).
1064 1.1.1.10 christos #eht_oper_chwidth (see vht_oper_chwidth)
1065 1.1.1.10 christos #eht_oper_centr_freq_seg0_idx
1066 1.1.1.10 christos
1067 1.1.1.10 christos #eht_default_pe_duration: The duration of PE field in EHT TB PPDU
1068 1.1.1.10 christos # 0 = PE field duration is the same as he_default_pe_duration (default)
1069 1.1.1.10 christos # 1 = PE field duration is 20 us
1070 1.1.1.10 christos #eht_default_pe_duration=0
1071 1.1.1.10 christos
1072 1.1.1.10 christos #eht_bw320_offset: For automatic channel selection (ACS) to indicate a preferred
1073 1.1.1.10 christos # 320 MHz channelization in EHT mode.
1074 1.1.1.10 christos # If the channel is decided or the bandwidth is not 320 MHz, this option is
1075 1.1.1.10 christos # meaningless.
1076 1.1.1.10 christos # 0 = auto-detect by hostapd
1077 1.1.1.10 christos # 1 = 320 MHz-1 (channel center frequency 31, 95, 159)
1078 1.1.1.10 christos # 2 = 320 MHz-2 (channel center frequency 63, 127, 191)
1079 1.1.1.10 christos #eht_bw320_offset=0
1080 1.1.1.10 christos
1081 1.1.1.10 christos # Disabled subchannel bitmap (16 bits) as per IEEE P802.11be/3.0,
1082 1.1.1.10 christos # Figure 9-1002c (EHT Operation Information field format). Each bit corresponds
1083 1.1.1.10 christos # to a 20 MHz channel, the lowest bit corresponds to the lowest frequency. A
1084 1.1.1.10 christos # bit set to 1 indicates that the channel is punctured (disabled). The default
1085 1.1.1.10 christos # value is 0 indicating that all channels are active.
1086 1.1.1.10 christos #punct_bitmap=0
1087 1.1.1.10 christos
1088 1.1.1.10 christos # Preamble puncturing threshold in automatic channel selection (ACS).
1089 1.1.1.10 christos # The value indicates the percentage of ideal channel average interference
1090 1.1.1.10 christos # factor above which a channel should be punctured.
1091 1.1.1.10 christos # Default is 0, indicates that ACS algorithm should not puncture any channel.
1092 1.1.1.10 christos #punct_acs_threshold=75
1093 1.1.1.10 christos
1094 1.1.1.10 christos # AP MLD - Whether this AP is a part of an AP MLD
1095 1.1.1.10 christos # 0 = no (no MLO)
1096 1.1.1.10 christos # 1 = yes (MLO)
1097 1.1.1.10 christos #mld_ap=0
1098 1.1.1.10 christos
1099 1.1.1.10 christos # AP MLD MAC address
1100 1.1.1.10 christos # The configured address will be set as the interface hardware address and used
1101 1.1.1.10 christos # as the AP MLD MAC address. If not set, the current interface hardware address
1102 1.1.1.10 christos # will be used as the AP MLD MAC address.
1103 1.1.1.10 christos #mld_addr=02:03:04:05:06:07
1104 1.1.1.9 christos
1105 1.1 christos ##### IEEE 802.1X-2004 related configuration ##################################
1106 1.1 christos
1107 1.1 christos # Require IEEE 802.1X authorization
1108 1.1 christos #ieee8021x=1
1109 1.1 christos
1110 1.1 christos # IEEE 802.1X/EAPOL version
1111 1.1 christos # hostapd is implemented based on IEEE Std 802.1X-2004 which defines EAPOL
1112 1.1 christos # version 2. However, there are many client implementations that do not handle
1113 1.1 christos # the new version number correctly (they seem to drop the frames completely).
1114 1.1 christos # In order to make hostapd interoperate with these clients, the version number
1115 1.1 christos # can be set to the older version (1) with this configuration value.
1116 1.1.1.9 christos # Note: When using MACsec, eapol_version shall be set to 3, which is
1117 1.1.1.9 christos # defined in IEEE Std 802.1X-2010.
1118 1.1 christos #eapol_version=2
1119 1.1 christos
1120 1.1 christos # Optional displayable message sent with EAP Request-Identity. The first \0
1121 1.1 christos # in this string will be converted to ASCII-0 (nul). This can be used to
1122 1.1 christos # separate network info (comma separated list of attribute=value pairs); see,
1123 1.1 christos # e.g., RFC 4284.
1124 1.1 christos #eap_message=hello
1125 1.1 christos #eap_message=hello\0networkid=netw,nasid=foo,portid=0,NAIRealms=example.com
1126 1.1 christos
1127 1.1 christos # WEP rekeying (disabled if key lengths are not set or are set to 0)
1128 1.1 christos # Key lengths for default/broadcast and individual/unicast keys:
1129 1.1 christos # 5 = 40-bit WEP (also known as 64-bit WEP with 40 secret bits)
1130 1.1 christos # 13 = 104-bit WEP (also known as 128-bit WEP with 104 secret bits)
1131 1.1 christos #wep_key_len_broadcast=5
1132 1.1 christos #wep_key_len_unicast=5
1133 1.1 christos # Rekeying period in seconds. 0 = do not rekey (i.e., set keys only once)
1134 1.1 christos #wep_rekey_period=300
1135 1.1 christos
1136 1.1 christos # EAPOL-Key index workaround (set bit7) for WinXP Supplicant (needed only if
1137 1.1 christos # only broadcast keys are used)
1138 1.1 christos eapol_key_index_workaround=0
1139 1.1 christos
1140 1.1 christos # EAP reauthentication period in seconds (default: 3600 seconds; 0 = disable
1141 1.1 christos # reauthentication).
1142 1.1.1.10 christos # Note: Reauthentications may enforce a disconnection, check the related
1143 1.1.1.10 christos # parameter wpa_deny_ptk0_rekey for details.
1144 1.1 christos #eap_reauth_period=3600
1145 1.1 christos
1146 1.1 christos # Use PAE group address (01:80:c2:00:00:03) instead of individual target
1147 1.1 christos # address when sending EAPOL frames with driver=wired. This is the most common
1148 1.1 christos # mechanism used in wired authentication, but it also requires that the port
1149 1.1 christos # is only used by one station.
1150 1.1 christos #use_pae_group_addr=1
1151 1.1 christos
1152 1.1.1.6 christos # EAP Re-authentication Protocol (ERP) authenticator (RFC 6696)
1153 1.1.1.6 christos #
1154 1.1.1.6 christos # Whether to initiate EAP authentication with EAP-Initiate/Re-auth-Start before
1155 1.1.1.6 christos # EAP-Identity/Request
1156 1.1.1.6 christos #erp_send_reauth_start=1
1157 1.1.1.6 christos #
1158 1.1.1.6 christos # Domain name for EAP-Initiate/Re-auth-Start. Omitted from the message if not
1159 1.1.1.6 christos # set (no local ER server). This is also used by the integrated EAP server if
1160 1.1.1.6 christos # ERP is enabled (eap_server_erp=1).
1161 1.1.1.6 christos #erp_domain=example.com
1162 1.1.1.6 christos
1163 1.1.1.9 christos ##### MACsec ##################################################################
1164 1.1.1.9 christos
1165 1.1.1.9 christos # macsec_policy: IEEE 802.1X/MACsec options
1166 1.1.1.9 christos # This determines how sessions are secured with MACsec (only for MACsec
1167 1.1.1.9 christos # drivers).
1168 1.1.1.9 christos # 0: MACsec not in use (default)
1169 1.1.1.9 christos # 1: MACsec enabled - Should secure, accept key server's advice to
1170 1.1.1.9 christos # determine whether to use a secure session or not.
1171 1.1.1.9 christos #
1172 1.1.1.9 christos # macsec_integ_only: IEEE 802.1X/MACsec transmit mode
1173 1.1.1.9 christos # This setting applies only when MACsec is in use, i.e.,
1174 1.1.1.9 christos # - macsec_policy is enabled
1175 1.1.1.9 christos # - the key server has decided to enable MACsec
1176 1.1.1.9 christos # 0: Encrypt traffic (default)
1177 1.1.1.9 christos # 1: Integrity only
1178 1.1.1.9 christos #
1179 1.1.1.9 christos # macsec_replay_protect: IEEE 802.1X/MACsec replay protection
1180 1.1.1.9 christos # This setting applies only when MACsec is in use, i.e.,
1181 1.1.1.9 christos # - macsec_policy is enabled
1182 1.1.1.9 christos # - the key server has decided to enable MACsec
1183 1.1.1.9 christos # 0: Replay protection disabled (default)
1184 1.1.1.9 christos # 1: Replay protection enabled
1185 1.1.1.9 christos #
1186 1.1.1.9 christos # macsec_replay_window: IEEE 802.1X/MACsec replay protection window
1187 1.1.1.9 christos # This determines a window in which replay is tolerated, to allow receipt
1188 1.1.1.9 christos # of frames that have been misordered by the network.
1189 1.1.1.9 christos # This setting applies only when MACsec replay protection active, i.e.,
1190 1.1.1.9 christos # - macsec_replay_protect is enabled
1191 1.1.1.9 christos # - the key server has decided to enable MACsec
1192 1.1.1.9 christos # 0: No replay window, strict check (default)
1193 1.1.1.9 christos # 1..2^32-1: number of packets that could be misordered
1194 1.1.1.9 christos #
1195 1.1.1.10 christos # macsec_offload: IEEE 802.1X/MACsec hardware offload
1196 1.1.1.10 christos # This setting applies only when MACsec is in use, i.e.,
1197 1.1.1.10 christos # - macsec_policy is enabled
1198 1.1.1.10 christos # - the key server has decided to enable MACsec
1199 1.1.1.10 christos # 0 = MACSEC_OFFLOAD_OFF (default)
1200 1.1.1.10 christos # 1 = MACSEC_OFFLOAD_PHY
1201 1.1.1.10 christos # 2 = MACSEC_OFFLOAD_MAC
1202 1.1.1.10 christos #
1203 1.1.1.9 christos # macsec_port: IEEE 802.1X/MACsec port
1204 1.1.1.9 christos # Port component of the SCI
1205 1.1.1.9 christos # Range: 1-65534 (default: 1)
1206 1.1.1.9 christos #
1207 1.1.1.9 christos # mka_priority (Priority of MKA Actor)
1208 1.1.1.9 christos # Range: 0..255 (default: 255)
1209 1.1.1.9 christos #
1210 1.1.1.10 christos # macsec_csindex: IEEE 802.1X/MACsec cipher suite
1211 1.1.1.10 christos # 0 = GCM-AES-128 (default)
1212 1.1.1.10 christos # 1 = GCM-AES-256 (default)
1213 1.1.1.10 christos #
1214 1.1.1.9 christos # mka_cak, mka_ckn, and mka_priority: IEEE 802.1X/MACsec pre-shared key mode
1215 1.1.1.9 christos # This allows to configure MACsec with a pre-shared key using a (CAK,CKN) pair.
1216 1.1.1.9 christos # In this mode, instances of hostapd can act as MACsec peers. The peer
1217 1.1.1.9 christos # with lower priority will become the key server and start distributing SAKs.
1218 1.1.1.9 christos # mka_cak (CAK = Secure Connectivity Association Key) takes a 16-byte (128-bit)
1219 1.1.1.9 christos # hex-string (32 hex-digits) or a 32-byte (256-bit) hex-string (64 hex-digits)
1220 1.1.1.9 christos # mka_ckn (CKN = CAK Name) takes a 1..32-bytes (8..256 bit) hex-string
1221 1.1.1.9 christos # (2..64 hex-digits)
1222 1.1.1.9 christos
1223 1.1 christos ##### Integrated EAP server ###################################################
1224 1.1 christos
1225 1.1 christos # Optionally, hostapd can be configured to use an integrated EAP server
1226 1.1 christos # to process EAP authentication locally without need for an external RADIUS
1227 1.1 christos # server. This functionality can be used both as a local authentication server
1228 1.1 christos # for IEEE 802.1X/EAPOL and as a RADIUS server for other devices.
1229 1.1 christos
1230 1.1 christos # Use integrated EAP server instead of external RADIUS authentication
1231 1.1 christos # server. This is also needed if hostapd is configured to act as a RADIUS
1232 1.1 christos # authentication server.
1233 1.1 christos eap_server=0
1234 1.1 christos
1235 1.1 christos # Path for EAP server user database
1236 1.1.1.4 christos # If SQLite support is included, this can be set to "sqlite:/path/to/sqlite.db"
1237 1.1.1.4 christos # to use SQLite database instead of a text file.
1238 1.1 christos #eap_user_file=/etc/hostapd.eap_user
1239 1.1 christos
1240 1.1 christos # CA certificate (PEM or DER file) for EAP-TLS/PEAP/TTLS
1241 1.1 christos #ca_cert=/etc/hostapd.ca.pem
1242 1.1 christos
1243 1.1 christos # Server certificate (PEM or DER file) for EAP-TLS/PEAP/TTLS
1244 1.1 christos #server_cert=/etc/hostapd.server.pem
1245 1.1 christos
1246 1.1 christos # Private key matching with the server certificate for EAP-TLS/PEAP/TTLS
1247 1.1 christos # This may point to the same file as server_cert if both certificate and key
1248 1.1 christos # are included in a single file. PKCS#12 (PFX) file (.p12/.pfx) can also be
1249 1.1 christos # used by commenting out server_cert and specifying the PFX file as the
1250 1.1 christos # private_key.
1251 1.1 christos #private_key=/etc/hostapd.server.prv
1252 1.1 christos
1253 1.1 christos # Passphrase for private key
1254 1.1 christos #private_key_passwd=secret passphrase
1255 1.1 christos
1256 1.1.1.9 christos # An alternative server certificate and private key can be configured with the
1257 1.1.1.9 christos # following parameters (with values just like the parameters above without the
1258 1.1.1.9 christos # '2' suffix). The ca_cert file (in PEM encoding) is used to add the trust roots
1259 1.1.1.9 christos # for both server certificates and/or client certificates).
1260 1.1.1.9 christos #
1261 1.1.1.9 christos # The main use case for this alternative server certificate configuration is to
1262 1.1.1.9 christos # enable both RSA and ECC public keys. The server will pick which one to use
1263 1.1.1.9 christos # based on the client preferences for the cipher suite (in the TLS ClientHello
1264 1.1.1.9 christos # message). It should be noted that number of deployed EAP peer implementations
1265 1.1.1.9 christos # do not filter out the cipher suite list based on their local configuration and
1266 1.1.1.9 christos # as such, configuration of alternative types of certificates on the server may
1267 1.1.1.9 christos # result in interoperability issues.
1268 1.1.1.9 christos #server_cert2=/etc/hostapd.server-ecc.pem
1269 1.1.1.9 christos #private_key2=/etc/hostapd.server-ecc.prv
1270 1.1.1.9 christos #private_key_passwd2=secret passphrase
1271 1.1.1.9 christos
1272 1.1.1.9 christos
1273 1.1.1.5 christos # Server identity
1274 1.1.1.5 christos # EAP methods that provide mechanism for authenticated server identity delivery
1275 1.1.1.5 christos # use this value. If not set, "hostapd" is used as a default.
1276 1.1.1.5 christos #server_id=server.example.com
1277 1.1.1.5 christos
1278 1.1 christos # Enable CRL verification.
1279 1.1 christos # Note: hostapd does not yet support CRL downloading based on CDP. Thus, a
1280 1.1 christos # valid CRL signed by the CA is required to be included in the ca_cert file.
1281 1.1 christos # This can be done by using PEM format for CA certificate and CRL and
1282 1.1 christos # concatenating these into one file. Whenever CRL changes, hostapd needs to be
1283 1.1.1.9 christos # restarted to take the new CRL into use. Alternatively, crl_reload_interval can
1284 1.1.1.9 christos # be used to configure periodic updating of the loaded CRL information.
1285 1.1 christos # 0 = do not verify CRLs (default)
1286 1.1 christos # 1 = check the CRL of the user certificate
1287 1.1 christos # 2 = check all CRLs in the certificate path
1288 1.1 christos #check_crl=1
1289 1.1 christos
1290 1.1.1.9 christos # Specify whether to ignore certificate CRL validity time mismatches with
1291 1.1.1.10 christos # errors X509_V_ERR_CRL_HAS_EXPIRED and X509_V_ERR_CRL_NOT_YET_VALID.
1292 1.1.1.9 christos #
1293 1.1.1.9 christos # 0 = ignore errors
1294 1.1.1.9 christos # 1 = do not ignore errors (default)
1295 1.1.1.9 christos #check_crl_strict=1
1296 1.1.1.9 christos
1297 1.1.1.9 christos # CRL reload interval in seconds
1298 1.1.1.9 christos # This can be used to reload ca_cert file and the included CRL on every new TLS
1299 1.1.1.9 christos # session if difference between last reload and the current reload time in
1300 1.1.1.9 christos # seconds is greater than crl_reload_interval.
1301 1.1.1.9 christos # Note: If interval time is very short, CPU overhead may be negatively affected
1302 1.1.1.9 christos # and it is advised to not go below 300 seconds.
1303 1.1.1.9 christos # This is applicable only with check_crl values 1 and 2.
1304 1.1.1.9 christos # 0 = do not reload CRLs (default)
1305 1.1.1.9 christos # crl_reload_interval = 300
1306 1.1.1.9 christos
1307 1.1.1.9 christos # If check_cert_subject is set, the value of every field will be checked
1308 1.1.1.9 christos # against the DN of the subject in the client certificate. If the values do
1309 1.1.1.9 christos # not match, the certificate verification will fail, rejecting the user.
1310 1.1.1.9 christos # This option allows hostapd to match every individual field in the right order
1311 1.1.1.9 christos # against the DN of the subject in the client certificate.
1312 1.1.1.9 christos #
1313 1.1.1.9 christos # For example, check_cert_subject=C=US/O=XX/OU=ABC/OU=XYZ/CN=1234 will check
1314 1.1.1.9 christos # every individual DN field of the subject in the client certificate. If OU=XYZ
1315 1.1.1.9 christos # comes first in terms of the order in the client certificate (DN field of
1316 1.1.1.9 christos # client certificate C=US/O=XX/OU=XYZ/OU=ABC/CN=1234), hostapd will reject the
1317 1.1.1.9 christos # client because the order of 'OU' is not matching the specified string in
1318 1.1.1.9 christos # check_cert_subject.
1319 1.1.1.9 christos #
1320 1.1.1.9 christos # This option also allows '*' as a wildcard. This option has some limitation.
1321 1.1.1.9 christos # It can only be used as per the following example.
1322 1.1.1.9 christos #
1323 1.1.1.9 christos # For example, check_cert_subject=C=US/O=XX/OU=Production* and we have two
1324 1.1.1.9 christos # clients and DN of the subject in the first client certificate is
1325 1.1.1.9 christos # (C=US/O=XX/OU=Production Unit) and DN of the subject in the second client is
1326 1.1.1.9 christos # (C=US/O=XX/OU=Production Factory). In this case, hostapd will allow both
1327 1.1.1.9 christos # clients because the value of 'OU' field in both client certificates matches
1328 1.1.1.9 christos # 'OU' value in 'check_cert_subject' up to 'wildcard'.
1329 1.1.1.9 christos #
1330 1.1.1.9 christos # * (Allow all clients, e.g., check_cert_subject=*)
1331 1.1.1.9 christos #check_cert_subject=string
1332 1.1.1.9 christos
1333 1.1.1.7 christos # TLS Session Lifetime in seconds
1334 1.1.1.7 christos # This can be used to allow TLS sessions to be cached and resumed with an
1335 1.1.1.7 christos # abbreviated handshake when using EAP-TLS/TTLS/PEAP.
1336 1.1.1.7 christos # (default: 0 = session caching and resumption disabled)
1337 1.1.1.7 christos #tls_session_lifetime=3600
1338 1.1.1.7 christos
1339 1.1.1.9 christos # TLS flags
1340 1.1.1.9 christos # [ALLOW-SIGN-RSA-MD5] = allow MD5-based certificate signatures (depending on
1341 1.1.1.9 christos # the TLS library, these may be disabled by default to enforce stronger
1342 1.1.1.9 christos # security)
1343 1.1.1.9 christos # [DISABLE-TIME-CHECKS] = ignore certificate validity time (this requests
1344 1.1.1.9 christos # the TLS library to accept certificates even if they are not currently
1345 1.1.1.9 christos # valid, i.e., have expired or have not yet become valid; this should be
1346 1.1.1.9 christos # used only for testing purposes)
1347 1.1.1.9 christos # [DISABLE-TLSv1.0] = disable use of TLSv1.0
1348 1.1.1.9 christos # [ENABLE-TLSv1.0] = explicitly enable use of TLSv1.0 (this allows
1349 1.1.1.9 christos # systemwide TLS policies to be overridden)
1350 1.1.1.9 christos # [DISABLE-TLSv1.1] = disable use of TLSv1.1
1351 1.1.1.9 christos # [ENABLE-TLSv1.1] = explicitly enable use of TLSv1.1 (this allows
1352 1.1.1.9 christos # systemwide TLS policies to be overridden)
1353 1.1.1.9 christos # [DISABLE-TLSv1.2] = disable use of TLSv1.2
1354 1.1.1.9 christos # [ENABLE-TLSv1.2] = explicitly enable use of TLSv1.2 (this allows
1355 1.1.1.9 christos # systemwide TLS policies to be overridden)
1356 1.1.1.9 christos # [DISABLE-TLSv1.3] = disable use of TLSv1.3
1357 1.1.1.9 christos # [ENABLE-TLSv1.3] = enable TLSv1.3 (experimental - disabled by default)
1358 1.1.1.9 christos #tls_flags=[flag1][flag2]...
1359 1.1.1.9 christos
1360 1.1.1.10 christos # Maximum number of EAP message rounds with data (default: 100)
1361 1.1.1.10 christos #max_auth_rounds=100
1362 1.1.1.10 christos
1363 1.1.1.10 christos # Maximum number of short EAP message rounds (default: 50)
1364 1.1.1.10 christos #max_auth_rounds_short=50
1365 1.1.1.10 christos
1366 1.1.1.5 christos # Cached OCSP stapling response (DER encoded)
1367 1.1.1.5 christos # If set, this file is sent as a certificate status response by the EAP server
1368 1.1.1.5 christos # if the EAP peer requests certificate status in the ClientHello message.
1369 1.1.1.5 christos # This cache file can be updated, e.g., by running following command
1370 1.1.1.5 christos # periodically to get an update from the OCSP responder:
1371 1.1.1.5 christos # openssl ocsp \
1372 1.1.1.5 christos # -no_nonce \
1373 1.1.1.5 christos # -CAfile /etc/hostapd.ca.pem \
1374 1.1.1.5 christos # -issuer /etc/hostapd.ca.pem \
1375 1.1.1.5 christos # -cert /etc/hostapd.server.pem \
1376 1.1.1.5 christos # -url http://ocsp.example.com:8888/ \
1377 1.1.1.5 christos # -respout /tmp/ocsp-cache.der
1378 1.1.1.5 christos #ocsp_stapling_response=/tmp/ocsp-cache.der
1379 1.1.1.5 christos
1380 1.1.1.7 christos # Cached OCSP stapling response list (DER encoded OCSPResponseList)
1381 1.1.1.7 christos # This is similar to ocsp_stapling_response, but the extended version defined in
1382 1.1.1.7 christos # RFC 6961 to allow multiple OCSP responses to be provided.
1383 1.1.1.7 christos #ocsp_stapling_response_multi=/tmp/ocsp-multi-cache.der
1384 1.1.1.7 christos
1385 1.1 christos # dh_file: File path to DH/DSA parameters file (in PEM format)
1386 1.1 christos # This is an optional configuration file for setting parameters for an
1387 1.1.1.10 christos # ephemeral DH key exchange. If the file is in DSA parameters format, it will
1388 1.1.1.10 christos # be automatically converted into DH params. If the used TLS library supports
1389 1.1.1.10 christos # automatic DH parameter selection, that functionality will be used if this
1390 1.1.1.10 christos # parameter is not set. DH parameters are required if anonymous EAP-FAST is
1391 1.1.1.10 christos # used.
1392 1.1 christos # You can generate DH parameters file with OpenSSL, e.g.,
1393 1.1.1.7 christos # "openssl dhparam -out /etc/hostapd.dh.pem 2048"
1394 1.1 christos #dh_file=/etc/hostapd.dh.pem
1395 1.1 christos
1396 1.1.1.6 christos # OpenSSL cipher string
1397 1.1.1.6 christos #
1398 1.1.1.6 christos # This is an OpenSSL specific configuration option for configuring the default
1399 1.1.1.8 christos # ciphers. If not set, the value configured at build time ("DEFAULT:!EXP:!LOW"
1400 1.1.1.8 christos # by default) is used.
1401 1.1.1.6 christos # See https://www.openssl.org/docs/apps/ciphers.html for OpenSSL documentation
1402 1.1.1.6 christos # on cipher suite configuration. This is applicable only if hostapd is built to
1403 1.1.1.6 christos # use OpenSSL.
1404 1.1.1.6 christos #openssl_ciphers=DEFAULT:!EXP:!LOW
1405 1.1.1.6 christos
1406 1.1.1.9 christos # OpenSSL ECDH curves
1407 1.1.1.9 christos #
1408 1.1.1.9 christos # This is an OpenSSL specific configuration option for configuring the ECDH
1409 1.1.1.9 christos # curves for EAP-TLS/TTLS/PEAP/FAST server. If not set, automatic curve
1410 1.1.1.9 christos # selection is enabled. If set to an empty string, ECDH curve configuration is
1411 1.1.1.9 christos # not done (the exact library behavior depends on the library version).
1412 1.1.1.9 christos # Otherwise, this is a colon separated list of the supported curves (e.g.,
1413 1.1.1.9 christos # P-521:P-384:P-256). This is applicable only if hostapd is built to use
1414 1.1.1.9 christos # OpenSSL. This must not be used for Suite B cases since the same OpenSSL
1415 1.1.1.9 christos # parameter is set differently in those cases and this might conflict with that
1416 1.1.1.9 christos # design.
1417 1.1.1.9 christos #openssl_ecdh_curves=P-521:P-384:P-256
1418 1.1.1.9 christos
1419 1.1.1.3 christos # Fragment size for EAP methods
1420 1.1.1.3 christos #fragment_size=1400
1421 1.1.1.3 christos
1422 1.1.1.4 christos # Finite cyclic group for EAP-pwd. Number maps to group of domain parameters
1423 1.1.1.4 christos # using the IANA repository for IKE (RFC 2409).
1424 1.1.1.4 christos #pwd_group=19
1425 1.1.1.4 christos
1426 1.1 christos # Configuration data for EAP-SIM database/authentication gateway interface.
1427 1.1 christos # This is a text string in implementation specific format. The example
1428 1.1 christos # implementation in eap_sim_db.c uses this as the UNIX domain socket name for
1429 1.1 christos # the HLR/AuC gateway (e.g., hlr_auc_gw). In this case, the path uses "unix:"
1430 1.1.1.4 christos # prefix. If hostapd is built with SQLite support (CONFIG_SQLITE=y in .config),
1431 1.1.1.4 christos # database file can be described with an optional db=<path> parameter.
1432 1.1 christos #eap_sim_db=unix:/tmp/hlr_auc_gw.sock
1433 1.1.1.4 christos #eap_sim_db=unix:/tmp/hlr_auc_gw.sock db=/tmp/hostapd.db
1434 1.1 christos
1435 1.1.1.7 christos # EAP-SIM DB request timeout
1436 1.1.1.7 christos # This parameter sets the maximum time to wait for a database request response.
1437 1.1.1.7 christos # The parameter value is in seconds.
1438 1.1.1.7 christos #eap_sim_db_timeout=1
1439 1.1.1.7 christos
1440 1.1 christos # Encryption key for EAP-FAST PAC-Opaque values. This key must be a secret,
1441 1.1 christos # random value. It is configured as a 16-octet value in hex format. It can be
1442 1.1 christos # generated, e.g., with the following command:
1443 1.1 christos # od -tx1 -v -N16 /dev/random | colrm 1 8 | tr -d ' '
1444 1.1 christos #pac_opaque_encr_key=000102030405060708090a0b0c0d0e0f
1445 1.1 christos
1446 1.1 christos # EAP-FAST authority identity (A-ID)
1447 1.1 christos # A-ID indicates the identity of the authority that issues PACs. The A-ID
1448 1.1 christos # should be unique across all issuing servers. In theory, this is a variable
1449 1.1 christos # length field, but due to some existing implementations requiring A-ID to be
1450 1.1 christos # 16 octets in length, it is strongly recommended to use that length for the
1451 1.1.1.10 christos # field to provide interoperability with deployed peer implementations. This
1452 1.1 christos # field is configured in hex format.
1453 1.1 christos #eap_fast_a_id=101112131415161718191a1b1c1d1e1f
1454 1.1 christos
1455 1.1 christos # EAP-FAST authority identifier information (A-ID-Info)
1456 1.1 christos # This is a user-friendly name for the A-ID. For example, the enterprise name
1457 1.1 christos # and server name in a human-readable format. This field is encoded as UTF-8.
1458 1.1 christos #eap_fast_a_id_info=test server
1459 1.1 christos
1460 1.1 christos # Enable/disable different EAP-FAST provisioning modes:
1461 1.1 christos #0 = provisioning disabled
1462 1.1 christos #1 = only anonymous provisioning allowed
1463 1.1 christos #2 = only authenticated provisioning allowed
1464 1.1 christos #3 = both provisioning modes allowed (default)
1465 1.1 christos #eap_fast_prov=3
1466 1.1 christos
1467 1.1 christos # EAP-FAST PAC-Key lifetime in seconds (hard limit)
1468 1.1 christos #pac_key_lifetime=604800
1469 1.1 christos
1470 1.1 christos # EAP-FAST PAC-Key refresh time in seconds (soft limit on remaining hard
1471 1.1 christos # limit). The server will generate a new PAC-Key when this number of seconds
1472 1.1 christos # (or fewer) of the lifetime remains.
1473 1.1 christos #pac_key_refresh_time=86400
1474 1.1 christos
1475 1.1.1.9 christos # EAP-TEAP authentication type
1476 1.1.1.9 christos # 0 = inner EAP (default)
1477 1.1.1.9 christos # 1 = Basic-Password-Auth
1478 1.1.1.10 christos # 2 = Do not require Phase 2 authentication if client can be authenticated
1479 1.1.1.10 christos # during Phase 1
1480 1.1.1.9 christos #eap_teap_auth=0
1481 1.1.1.9 christos
1482 1.1.1.9 christos # EAP-TEAP authentication behavior when using PAC
1483 1.1.1.9 christos # 0 = perform inner authentication (default)
1484 1.1.1.9 christos # 1 = skip inner authentication (inner EAP/Basic-Password-Auth)
1485 1.1.1.9 christos #eap_teap_pac_no_inner=0
1486 1.1.1.9 christos
1487 1.1.1.10 christos # EAP-TEAP behavior with Result TLV
1488 1.1.1.10 christos # 0 = include with Intermediate-Result TLV (default)
1489 1.1.1.10 christos # 1 = send in a separate message (for testing purposes)
1490 1.1.1.10 christos #eap_teap_separate_result=0
1491 1.1.1.10 christos
1492 1.1.1.10 christos # EAP-TEAP identities
1493 1.1.1.10 christos # 0 = allow any identity type (default)
1494 1.1.1.10 christos # 1 = require user identity
1495 1.1.1.10 christos # 2 = require machine identity
1496 1.1.1.10 christos # 3 = request user identity; accept either user or machine identity
1497 1.1.1.10 christos # 4 = request machine identity; accept either user or machine identity
1498 1.1.1.10 christos # 5 = require both user and machine identity
1499 1.1.1.10 christos #eap_teap_id=0
1500 1.1.1.10 christos
1501 1.1.1.10 christos # EAP-TEAP tunneled EAP method behavior
1502 1.1.1.10 christos # 0 = minimize roundtrips by merging start of the next EAP method with the
1503 1.1.1.10 christos # crypto-binding of the previous one.
1504 1.1.1.10 christos # 1 = complete crypto-binding before starting the next EAP method
1505 1.1.1.10 christos #eap_teap_method_sequence=0
1506 1.1.1.10 christos
1507 1.1 christos # EAP-SIM and EAP-AKA protected success/failure indication using AT_RESULT_IND
1508 1.1 christos # (default: 0 = disabled).
1509 1.1 christos #eap_sim_aka_result_ind=1
1510 1.1 christos
1511 1.1.1.9 christos # EAP-SIM and EAP-AKA identity options
1512 1.1.1.9 christos # 0 = do not use pseudonyms or fast reauthentication
1513 1.1.1.9 christos # 1 = use pseudonyms, but not fast reauthentication
1514 1.1.1.9 christos # 2 = do not use pseudonyms, but use fast reauthentication
1515 1.1.1.9 christos # 3 = use pseudonyms and use fast reauthentication (default)
1516 1.1.1.10 christos # 4 = do not use pseudonyms or fast reauthentication and allow
1517 1.1.1.10 christos # EAP-Response/Identity to be used without method specific identity exchange
1518 1.1.1.10 christos # 5 = use pseudonyms, but not fast reauthentication and allow
1519 1.1.1.10 christos # EAP-Response/Identity to be used without method specific identity exchange
1520 1.1.1.10 christos # 6 = do not use pseudonyms, but use fast reauthentication and allow
1521 1.1.1.10 christos # EAP-Response/Identity to be used without method specific identity exchange
1522 1.1.1.10 christos # 7 = use pseudonyms and use fast reauthentication and allow
1523 1.1.1.10 christos # EAP-Response/Identity to be used without method specific identity exchange
1524 1.1.1.9 christos #eap_sim_id=3
1525 1.1.1.9 christos
1526 1.1.1.10 christos # IMSI privacy key (PEM encoded RSA 2048-bit private key) for decrypting
1527 1.1.1.10 christos # permanent identity when using EAP-SIM/AKA/AKA'.
1528 1.1.1.10 christos #imsi_privacy_key=imsi-privacy-key.pem
1529 1.1.1.10 christos
1530 1.1.1.10 christos # EAP-SIM and EAP-AKA fast re-authentication limit
1531 1.1.1.10 christos # Maximum number of fast re-authentications allowed after each full
1532 1.1.1.10 christos # authentication.
1533 1.1.1.10 christos #eap_sim_aka_fast_reauth_limit=1000
1534 1.1.1.10 christos
1535 1.1 christos # Trusted Network Connect (TNC)
1536 1.1 christos # If enabled, TNC validation will be required before the peer is allowed to
1537 1.1 christos # connect. Note: This is only used with EAP-TTLS and EAP-FAST. If any other
1538 1.1 christos # EAP method is enabled, the peer will be allowed to connect without TNC.
1539 1.1 christos #tnc=1
1540 1.1 christos
1541 1.1.1.6 christos # EAP Re-authentication Protocol (ERP) - RFC 6696
1542 1.1.1.6 christos #
1543 1.1.1.6 christos # Whether to enable ERP on the EAP server.
1544 1.1.1.6 christos #eap_server_erp=1
1545 1.1 christos
1546 1.1 christos
1547 1.1 christos ##### RADIUS client configuration #############################################
1548 1.1 christos # for IEEE 802.1X with external Authentication Server, IEEE 802.11
1549 1.1 christos # authentication with external ACL for MAC addresses, and accounting
1550 1.1 christos
1551 1.1 christos # The own IP address of the access point (used as NAS-IP-Address)
1552 1.1 christos own_ip_addr=127.0.0.1
1553 1.1 christos
1554 1.1.1.7 christos # NAS-Identifier string for RADIUS messages. When used, this should be unique
1555 1.1.1.7 christos # to the NAS within the scope of the RADIUS server. Please note that hostapd
1556 1.1.1.7 christos # uses a separate RADIUS client for each BSS and as such, a unique
1557 1.1.1.7 christos # nas_identifier value should be configured separately for each BSS. This is
1558 1.1.1.7 christos # particularly important for cases where RADIUS accounting is used
1559 1.1.1.7 christos # (Accounting-On/Off messages are interpreted as clearing all ongoing sessions
1560 1.1.1.7 christos # and that may get interpreted as applying to all BSSes if the same
1561 1.1.1.7 christos # NAS-Identifier value is used.) For example, a fully qualified domain name
1562 1.1.1.7 christos # prefixed with a unique identifier of the BSS (e.g., BSSID) can be used here.
1563 1.1.1.7 christos #
1564 1.1 christos # When using IEEE 802.11r, nas_identifier must be set and must be between 1 and
1565 1.1 christos # 48 octets long.
1566 1.1.1.7 christos #
1567 1.1.1.7 christos # It is mandatory to configure either own_ip_addr or nas_identifier to be
1568 1.1.1.7 christos # compliant with the RADIUS protocol. When using RADIUS accounting, it is
1569 1.1.1.7 christos # strongly recommended that nas_identifier is set to a unique value for each
1570 1.1.1.7 christos # BSS.
1571 1.1 christos #nas_identifier=ap.example.com
1572 1.1 christos
1573 1.1.1.6 christos # RADIUS client forced local IP address for the access point
1574 1.1.1.6 christos # Normally the local IP address is determined automatically based on configured
1575 1.1.1.6 christos # IP addresses, but this field can be used to force a specific address to be
1576 1.1.1.6 christos # used, e.g., when the device has multiple IP addresses.
1577 1.1.1.6 christos #radius_client_addr=127.0.0.1
1578 1.1.1.6 christos
1579 1.1.1.10 christos # RADIUS client forced local interface. Helps run properly with VRF
1580 1.1.1.10 christos # Default is none set which allows the network stack to pick the appropriate
1581 1.1.1.10 christos # interface automatically.
1582 1.1.1.10 christos # Example below binds to eth0
1583 1.1.1.10 christos #radius_client_dev=eth0
1584 1.1.1.10 christos
1585 1.1 christos # RADIUS authentication server
1586 1.1 christos #auth_server_addr=127.0.0.1
1587 1.1 christos #auth_server_port=1812
1588 1.1 christos #auth_server_shared_secret=secret
1589 1.1 christos
1590 1.1 christos # RADIUS accounting server
1591 1.1 christos #acct_server_addr=127.0.0.1
1592 1.1 christos #acct_server_port=1813
1593 1.1 christos #acct_server_shared_secret=secret
1594 1.1 christos
1595 1.1 christos # Secondary RADIUS servers; to be used if primary one does not reply to
1596 1.1 christos # RADIUS packets. These are optional and there can be more than one secondary
1597 1.1 christos # server listed.
1598 1.1 christos #auth_server_addr=127.0.0.2
1599 1.1 christos #auth_server_port=1812
1600 1.1 christos #auth_server_shared_secret=secret2
1601 1.1 christos #
1602 1.1 christos #acct_server_addr=127.0.0.2
1603 1.1 christos #acct_server_port=1813
1604 1.1 christos #acct_server_shared_secret=secret2
1605 1.1 christos
1606 1.1.1.10 christos # RADIUS/TLS instead of RADIUS/UDP
1607 1.1.1.10 christos #auth_server_addr=127.0.0.1
1608 1.1.1.10 christos #auth_server_port=2083
1609 1.1.1.10 christos #auth_server_type=TLS
1610 1.1.1.10 christos #auth_server_shared_secret=radsec
1611 1.1.1.10 christos #auth_server_ca_cert=<path to trusted CA certificate(s)>
1612 1.1.1.10 christos #auth_server_client_cert=<path to client certificate>
1613 1.1.1.10 christos #auth_server_private_key=<path to private key>
1614 1.1.1.10 christos #auth_server_private_key_passwd=<password for decrypting private key>
1615 1.1.1.10 christos
1616 1.1 christos # Retry interval for trying to return to the primary RADIUS server (in
1617 1.1 christos # seconds). RADIUS client code will automatically try to use the next server
1618 1.1 christos # when the current server is not replying to requests. If this interval is set,
1619 1.1 christos # primary server will be retried after configured amount of time even if the
1620 1.1 christos # currently used secondary server is still working.
1621 1.1 christos #radius_retry_primary_interval=600
1622 1.1 christos
1623 1.1.1.10 christos # Message-Authenticator attribute requirement for non-EAP cases
1624 1.1.1.10 christos # hostapd requires Message-Authenticator attribute to be included in all cases
1625 1.1.1.10 christos # where RADIUS is used for EAP authentication. This is also required for cases
1626 1.1.1.10 christos # where RADIUS is used for MAC ACL (macaddr_acl=2) by default, but that case
1627 1.1.1.10 christos # can be configured to not require this for compatibility with RADIUS servers
1628 1.1.1.10 christos # that do not include the attribute. This is not recommended due to potential
1629 1.1.1.10 christos # security concerns, but can be used as a temporary workaround in networks where
1630 1.1.1.10 christos # the connection to the RADIUS server is secure.
1631 1.1.1.10 christos # 0 = Do not require Message-Authenticator in MAC ACL response
1632 1.1.1.10 christos # 1 = Require Message-Authenticator in all authentication cases (default)
1633 1.1.1.10 christos #radius_require_message_authenticator=1
1634 1.1 christos
1635 1.1 christos # Interim accounting update interval
1636 1.1 christos # If this is set (larger than 0) and acct_server is configured, hostapd will
1637 1.1 christos # send interim accounting updates every N seconds. Note: if set, this overrides
1638 1.1 christos # possible Acct-Interim-Interval attribute in Access-Accept message. Thus, this
1639 1.1 christos # value should not be configured in hostapd.conf, if RADIUS server is used to
1640 1.1 christos # control the interim interval.
1641 1.1 christos # This value should not be less 600 (10 minutes) and must not be less than
1642 1.1 christos # 60 (1 minute).
1643 1.1 christos #radius_acct_interim_interval=600
1644 1.1 christos
1645 1.1.1.4 christos # Request Chargeable-User-Identity (RFC 4372)
1646 1.1.1.4 christos # This parameter can be used to configure hostapd to request CUI from the
1647 1.1.1.4 christos # RADIUS server by including Chargeable-User-Identity attribute into
1648 1.1.1.4 christos # Access-Request packets.
1649 1.1.1.4 christos #radius_request_cui=1
1650 1.1.1.4 christos
1651 1.1 christos # Dynamic VLAN mode; allow RADIUS authentication server to decide which VLAN
1652 1.1 christos # is used for the stations. This information is parsed from following RADIUS
1653 1.1 christos # attributes based on RFC 3580 and RFC 2868: Tunnel-Type (value 13 = VLAN),
1654 1.1 christos # Tunnel-Medium-Type (value 6 = IEEE 802), Tunnel-Private-Group-ID (value
1655 1.1.1.5 christos # VLANID as a string). Optionally, the local MAC ACL list (accept_mac_file) can
1656 1.1.1.5 christos # be used to set static client MAC address to VLAN ID mapping.
1657 1.1.1.9 christos # Dynamic VLAN mode is also used with VLAN ID assignment based on WPA/WPA2
1658 1.1.1.9 christos # passphrase from wpa_psk_file or vlan_id parameter from sae_password.
1659 1.1.1.9 christos # 0 = disabled (default); only VLAN IDs from accept_mac_file will be used
1660 1.1.1.9 christos # 1 = optional; use default interface if RADIUS server does not include VLAN ID
1661 1.1 christos # 2 = required; reject authentication if RADIUS server does not include VLAN ID
1662 1.1 christos #dynamic_vlan=0
1663 1.1 christos
1664 1.1.1.7 christos # Per-Station AP_VLAN interface mode
1665 1.1.1.7 christos # If enabled, each station is assigned its own AP_VLAN interface.
1666 1.1.1.7 christos # This implies per-station group keying and ebtables filtering of inter-STA
1667 1.1.1.7 christos # traffic (when passed through the AP).
1668 1.1.1.7 christos # If the sta is not assigned to any VLAN, then its AP_VLAN interface will be
1669 1.1.1.7 christos # added to the bridge given by the "bridge" configuration option (see above).
1670 1.1.1.7 christos # Otherwise, it will be added to the per-VLAN bridge.
1671 1.1.1.7 christos # 0 = disabled (default)
1672 1.1.1.7 christos # 1 = enabled
1673 1.1.1.7 christos #per_sta_vif=0
1674 1.1.1.7 christos
1675 1.1 christos # VLAN interface list for dynamic VLAN mode is read from a separate text file.
1676 1.1 christos # This list is used to map VLAN ID from the RADIUS server to a network
1677 1.1 christos # interface. Each station is bound to one interface in the same way as with
1678 1.1 christos # multiple BSSIDs or SSIDs. Each line in this text file is defining a new
1679 1.1 christos # interface and the line must include VLAN ID and interface name separated by
1680 1.1 christos # white space (space or tab).
1681 1.1.1.5 christos # If no entries are provided by this file, the station is statically mapped
1682 1.1.1.5 christos # to <bss-iface>.<vlan-id> interfaces.
1683 1.1.1.9 christos # Each line can optionally also contain the name of a bridge to add the VLAN to
1684 1.1 christos #vlan_file=/etc/hostapd.vlan
1685 1.1 christos
1686 1.1 christos # Interface where 802.1q tagged packets should appear when a RADIUS server is
1687 1.1 christos # used to determine which VLAN a station is on. hostapd creates a bridge for
1688 1.1 christos # each VLAN. Then hostapd adds a VLAN interface (associated with the interface
1689 1.1 christos # indicated by 'vlan_tagged_interface') and the appropriate wireless interface
1690 1.1 christos # to the bridge.
1691 1.1 christos #vlan_tagged_interface=eth0
1692 1.1 christos
1693 1.1.1.5 christos # Bridge (prefix) to add the wifi and the tagged interface to. This gets the
1694 1.1.1.5 christos # VLAN ID appended. It defaults to brvlan%d if no tagged interface is given
1695 1.1.1.5 christos # and br%s.%d if a tagged interface is given, provided %s = tagged interface
1696 1.1.1.5 christos # and %d = VLAN ID.
1697 1.1.1.5 christos #vlan_bridge=brvlan
1698 1.1.1.5 christos
1699 1.1.1.4 christos # When hostapd creates a VLAN interface on vlan_tagged_interfaces, it needs
1700 1.1.1.4 christos # to know how to name it.
1701 1.1.1.4 christos # 0 = vlan<XXX>, e.g., vlan1
1702 1.1.1.4 christos # 1 = <vlan_tagged_interface>.<XXX>, e.g. eth0.1
1703 1.1.1.4 christos #vlan_naming=0
1704 1.1.1.4 christos
1705 1.1.1.4 christos # Arbitrary RADIUS attributes can be added into Access-Request and
1706 1.1.1.4 christos # Accounting-Request packets by specifying the contents of the attributes with
1707 1.1.1.4 christos # the following configuration parameters. There can be multiple of these to
1708 1.1.1.4 christos # add multiple attributes. These parameters can also be used to override some
1709 1.1.1.4 christos # of the attributes added automatically by hostapd.
1710 1.1.1.4 christos # Format: <attr_id>[:<syntax:value>]
1711 1.1.1.4 christos # attr_id: RADIUS attribute type (e.g., 26 = Vendor-Specific)
1712 1.1.1.4 christos # syntax: s = string (UTF-8), d = integer, x = octet string
1713 1.1.1.4 christos # value: attribute value in format indicated by the syntax
1714 1.1.1.4 christos # If syntax and value parts are omitted, a null value (single 0x00 octet) is
1715 1.1.1.4 christos # used.
1716 1.1.1.4 christos #
1717 1.1.1.4 christos # Additional Access-Request attributes
1718 1.1.1.4 christos # radius_auth_req_attr=<attr_id>[:<syntax:value>]
1719 1.1.1.4 christos # Examples:
1720 1.1.1.4 christos # Operator-Name = "Operator"
1721 1.1.1.4 christos #radius_auth_req_attr=126:s:Operator
1722 1.1.1.4 christos # Service-Type = Framed (2)
1723 1.1.1.4 christos #radius_auth_req_attr=6:d:2
1724 1.1.1.4 christos # Connect-Info = "testing" (this overrides the automatically generated value)
1725 1.1.1.4 christos #radius_auth_req_attr=77:s:testing
1726 1.1.1.4 christos # Same Connect-Info value set as a hexdump
1727 1.1.1.4 christos #radius_auth_req_attr=77:x:74657374696e67
1728 1.1.1.4 christos
1729 1.1.1.4 christos #
1730 1.1.1.4 christos # Additional Accounting-Request attributes
1731 1.1.1.4 christos # radius_acct_req_attr=<attr_id>[:<syntax:value>]
1732 1.1.1.4 christos # Examples:
1733 1.1.1.4 christos # Operator-Name = "Operator"
1734 1.1.1.4 christos #radius_acct_req_attr=126:s:Operator
1735 1.1.1.4 christos
1736 1.1.1.9 christos # If SQLite support is included, path to a database from which additional
1737 1.1.1.9 christos # RADIUS request attributes are extracted based on the station MAC address.
1738 1.1.1.9 christos #
1739 1.1.1.9 christos # The schema for the radius_attributes table is:
1740 1.1.1.9 christos # id | sta | reqtype | attr : multi-key (sta, reqtype)
1741 1.1.1.9 christos # id = autonumber
1742 1.1.1.9 christos # sta = station MAC address in `11:22:33:44:55:66` format.
1743 1.1.1.9 christos # type = `auth` | `acct` | NULL (match any)
1744 1.1.1.9 christos # attr = existing config file format, e.g. `126:s:Test Operator`
1745 1.1.1.9 christos #radius_req_attr_sqlite=radius_attr.sqlite
1746 1.1.1.9 christos
1747 1.1.1.4 christos # Dynamic Authorization Extensions (RFC 5176)
1748 1.1.1.4 christos # This mechanism can be used to allow dynamic changes to user session based on
1749 1.1.1.4 christos # commands from a RADIUS server (or some other disconnect client that has the
1750 1.1.1.4 christos # needed session information). For example, Disconnect message can be used to
1751 1.1.1.4 christos # request an associated station to be disconnected.
1752 1.1.1.4 christos #
1753 1.1.1.4 christos # This is disabled by default. Set radius_das_port to non-zero UDP port
1754 1.1.1.4 christos # number to enable.
1755 1.1.1.4 christos #radius_das_port=3799
1756 1.1.1.4 christos #
1757 1.1.1.4 christos # DAS client (the host that can send Disconnect/CoA requests) and shared secret
1758 1.1.1.8 christos # Format: <IP address> <shared secret>
1759 1.1.1.8 christos # IP address 0.0.0.0 can be used to allow requests from any address.
1760 1.1.1.4 christos #radius_das_client=192.168.1.123 shared secret here
1761 1.1.1.4 christos #
1762 1.1.1.4 christos # DAS Event-Timestamp time window in seconds
1763 1.1.1.4 christos #radius_das_time_window=300
1764 1.1.1.4 christos #
1765 1.1.1.4 christos # DAS require Event-Timestamp
1766 1.1.1.4 christos #radius_das_require_event_timestamp=1
1767 1.1.1.7 christos #
1768 1.1.1.7 christos # DAS require Message-Authenticator
1769 1.1.1.7 christos #radius_das_require_message_authenticator=1
1770 1.1 christos
1771 1.1 christos ##### RADIUS authentication server configuration ##############################
1772 1.1 christos
1773 1.1 christos # hostapd can be used as a RADIUS authentication server for other hosts. This
1774 1.1 christos # requires that the integrated EAP server is also enabled and both
1775 1.1 christos # authentication services are sharing the same configuration.
1776 1.1 christos
1777 1.1 christos # File name of the RADIUS clients configuration for the RADIUS server. If this
1778 1.1 christos # commented out, RADIUS server is disabled.
1779 1.1 christos #radius_server_clients=/etc/hostapd.radius_clients
1780 1.1 christos
1781 1.1 christos # The UDP port number for the RADIUS authentication server
1782 1.1 christos #radius_server_auth_port=1812
1783 1.1 christos
1784 1.1.1.5 christos # The UDP port number for the RADIUS accounting server
1785 1.1.1.5 christos # Commenting this out or setting this to 0 can be used to disable RADIUS
1786 1.1.1.5 christos # accounting while still enabling RADIUS authentication.
1787 1.1.1.5 christos #radius_server_acct_port=1813
1788 1.1.1.5 christos
1789 1.1 christos # Use IPv6 with RADIUS server (IPv4 will also be supported using IPv6 API)
1790 1.1 christos #radius_server_ipv6=1
1791 1.1 christos
1792 1.1 christos
1793 1.1 christos ##### WPA/IEEE 802.11i configuration ##########################################
1794 1.1 christos
1795 1.1 christos # Enable WPA. Setting this variable configures the AP to require WPA (either
1796 1.1 christos # WPA-PSK or WPA-RADIUS/EAP based on other configuration). For WPA-PSK, either
1797 1.1 christos # wpa_psk or wpa_passphrase must be set and wpa_key_mgmt must include WPA-PSK.
1798 1.1.1.4 christos # Instead of wpa_psk / wpa_passphrase, wpa_psk_radius might suffice.
1799 1.1 christos # For WPA-RADIUS/EAP, ieee8021x must be set (but without dynamic WEP keys),
1800 1.1 christos # RADIUS authentication server must be configured, and WPA-EAP must be included
1801 1.1 christos # in wpa_key_mgmt.
1802 1.1 christos # This field is a bit field that can be used to enable WPA (IEEE 802.11i/D3.0)
1803 1.1 christos # and/or WPA2 (full IEEE 802.11i/RSN):
1804 1.1 christos # bit0 = WPA
1805 1.1 christos # bit1 = IEEE 802.11i/RSN (WPA2) (dot11RSNAEnabled)
1806 1.1.1.8 christos # Note that WPA3 is also configured with bit1 since it uses RSN just like WPA2.
1807 1.1.1.8 christos # In other words, for WPA3, wpa=2 is used the configuration (and
1808 1.1.1.8 christos # wpa_key_mgmt=SAE for WPA3-Personal instead of wpa_key_mgmt=WPA-PSK).
1809 1.1.1.8 christos #wpa=2
1810 1.1 christos
1811 1.1.1.10 christos # Extended Key ID support for Individually Addressed frames
1812 1.1.1.10 christos #
1813 1.1.1.10 christos # Extended Key ID allows to rekey PTK keys without the impacts the "normal"
1814 1.1.1.10 christos # PTK rekeying with only a single Key ID 0 has. It can only be used when the
1815 1.1.1.10 christos # driver supports it and RSN/WPA2 is used with a CCMP/GCMP pairwise cipher.
1816 1.1.1.10 christos #
1817 1.1.1.10 christos # 0 = force off, i.e., use only Key ID 0 (default)
1818 1.1.1.10 christos # 1 = enable and use Extended Key ID support when possible
1819 1.1.1.10 christos # 2 = identical to 1 but start with Key ID 1 when possible
1820 1.1.1.10 christos #extended_key_id=0
1821 1.1.1.10 christos
1822 1.1 christos # WPA pre-shared keys for WPA-PSK. This can be either entered as a 256-bit
1823 1.1 christos # secret in hex format (64 hex digits), wpa_psk, or as an ASCII passphrase
1824 1.1 christos # (8..63 characters) that will be converted to PSK. This conversion uses SSID
1825 1.1 christos # so the PSK changes when ASCII passphrase is used and the SSID is changed.
1826 1.1 christos # wpa_psk (dot11RSNAConfigPSKValue)
1827 1.1 christos # wpa_passphrase (dot11RSNAConfigPSKPassPhrase)
1828 1.1 christos #wpa_psk=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
1829 1.1 christos #wpa_passphrase=secret passphrase
1830 1.1 christos
1831 1.1 christos # Optionally, WPA PSKs can be read from a separate text file (containing list
1832 1.1 christos # of (PSK,MAC address) pairs. This allows more than one PSK to be configured.
1833 1.1 christos # Use absolute path name to make sure that the files can be read on SIGHUP
1834 1.1 christos # configuration reloads.
1835 1.1 christos #wpa_psk_file=/etc/hostapd.wpa_psk
1836 1.1 christos
1837 1.1.1.4 christos # Optionally, WPA passphrase can be received from RADIUS authentication server
1838 1.1.1.10 christos # This requires macaddr_acl to be set to 2 (RADIUS) for wpa_psk_radius values
1839 1.1.1.10 christos # 1 and 2.
1840 1.1.1.4 christos # 0 = disabled (default)
1841 1.1.1.4 christos # 1 = optional; use default passphrase/psk if RADIUS server does not include
1842 1.1.1.4 christos # Tunnel-Password
1843 1.1.1.4 christos # 2 = required; reject authentication if RADIUS server does not include
1844 1.1.1.4 christos # Tunnel-Password
1845 1.1.1.10 christos # 3 = ask RADIUS server during 4-way handshake if there is no locally
1846 1.1.1.10 christos # configured PSK/passphrase for the STA
1847 1.1.1.10 christos #
1848 1.1.1.10 christos # The Tunnel-Password attribute in Access-Accept can contain either the
1849 1.1.1.10 christos # 8..63 character ASCII passphrase or a 64 hex character encoding of the PSK.
1850 1.1.1.10 christos #
1851 1.1.1.4 christos #wpa_psk_radius=0
1852 1.1.1.4 christos
1853 1.1 christos # Set of accepted key management algorithms (WPA-PSK, WPA-EAP, or both). The
1854 1.1 christos # entries are separated with a space. WPA-PSK-SHA256 and WPA-EAP-SHA256 can be
1855 1.1 christos # added to enable SHA256-based stronger algorithms.
1856 1.1.1.8 christos # WPA-PSK = WPA-Personal / WPA2-Personal
1857 1.1.1.8 christos # WPA-PSK-SHA256 = WPA2-Personal using SHA256
1858 1.1.1.8 christos # WPA-EAP = WPA-Enterprise / WPA2-Enterprise
1859 1.1.1.8 christos # WPA-EAP-SHA256 = WPA2-Enterprise using SHA256
1860 1.1.1.8 christos # SAE = SAE (WPA3-Personal)
1861 1.1.1.8 christos # WPA-EAP-SUITE-B-192 = WPA3-Enterprise with 192-bit security/CNSA suite
1862 1.1.1.8 christos # FT-PSK = FT with passphrase/PSK
1863 1.1.1.8 christos # FT-EAP = FT with EAP
1864 1.1.1.8 christos # FT-EAP-SHA384 = FT with EAP using SHA384
1865 1.1.1.8 christos # FT-SAE = FT with SAE
1866 1.1.1.8 christos # FILS-SHA256 = Fast Initial Link Setup with SHA256
1867 1.1.1.8 christos # FILS-SHA384 = Fast Initial Link Setup with SHA384
1868 1.1.1.8 christos # FT-FILS-SHA256 = FT and Fast Initial Link Setup with SHA256
1869 1.1.1.8 christos # FT-FILS-SHA384 = FT and Fast Initial Link Setup with SHA384
1870 1.1.1.8 christos # OWE = Opportunistic Wireless Encryption (a.k.a. Enhanced Open)
1871 1.1.1.8 christos # DPP = Device Provisioning Protocol
1872 1.1.1.8 christos # OSEN = Hotspot 2.0 online signup with encryption
1873 1.1 christos # (dot11RSNAConfigAuthenticationSuitesTable)
1874 1.1 christos #wpa_key_mgmt=WPA-PSK WPA-EAP
1875 1.1 christos
1876 1.1 christos # Set of accepted cipher suites (encryption algorithms) for pairwise keys
1877 1.1 christos # (unicast packets). This is a space separated list of algorithms:
1878 1.1.1.8 christos # CCMP = AES in Counter mode with CBC-MAC (CCMP-128)
1879 1.1.1.8 christos # TKIP = Temporal Key Integrity Protocol
1880 1.1.1.8 christos # CCMP-256 = AES in Counter mode with CBC-MAC with 256-bit key
1881 1.1.1.8 christos # GCMP = Galois/counter mode protocol (GCMP-128)
1882 1.1.1.8 christos # GCMP-256 = Galois/counter mode protocol with 256-bit key
1883 1.1 christos # Group cipher suite (encryption algorithm for broadcast and multicast frames)
1884 1.1 christos # is automatically selected based on this configuration. If only CCMP is
1885 1.1 christos # allowed as the pairwise cipher, group cipher will also be CCMP. Otherwise,
1886 1.1.1.8 christos # TKIP will be used as the group cipher. The optional group_cipher parameter can
1887 1.1.1.8 christos # be used to override this automatic selection.
1888 1.1.1.8 christos #
1889 1.1 christos # (dot11RSNAConfigPairwiseCiphersTable)
1890 1.1 christos # Pairwise cipher for WPA (v1) (default: TKIP)
1891 1.1 christos #wpa_pairwise=TKIP CCMP
1892 1.1 christos # Pairwise cipher for RSN/WPA2 (default: use wpa_pairwise value)
1893 1.1 christos #rsn_pairwise=CCMP
1894 1.1 christos
1895 1.1.1.8 christos # Optional override for automatic group cipher selection
1896 1.1.1.8 christos # This can be used to select a specific group cipher regardless of which
1897 1.1.1.8 christos # pairwise ciphers were enabled for WPA and RSN. It should be noted that
1898 1.1.1.8 christos # overriding the group cipher with an unexpected value can result in
1899 1.1.1.8 christos # interoperability issues and in general, this parameter is mainly used for
1900 1.1.1.8 christos # testing purposes.
1901 1.1.1.8 christos #group_cipher=CCMP
1902 1.1.1.8 christos
1903 1.1 christos # Time interval for rekeying GTK (broadcast/multicast encryption keys) in
1904 1.1 christos # seconds. (dot11RSNAConfigGroupRekeyTime)
1905 1.1.1.8 christos # This defaults to 86400 seconds (once per day) when using CCMP/GCMP as the
1906 1.1.1.8 christos # group cipher and 600 seconds (once per 10 minutes) when using TKIP as the
1907 1.1.1.8 christos # group cipher.
1908 1.1.1.8 christos #wpa_group_rekey=86400
1909 1.1 christos
1910 1.1 christos # Rekey GTK when any STA that possesses the current GTK is leaving the BSS.
1911 1.1 christos # (dot11RSNAConfigGroupRekeyStrict)
1912 1.1 christos #wpa_strict_rekey=1
1913 1.1 christos
1914 1.1.1.8 christos # The number of times EAPOL-Key Message 1/2 in the RSN Group Key Handshake is
1915 1.1.1.8 christos #retried per GTK Handshake attempt. (dot11RSNAConfigGroupUpdateCount)
1916 1.1.1.8 christos # This value should only be increased when stations are constantly
1917 1.1.1.8 christos # deauthenticated during GTK rekeying with the log message
1918 1.1.1.8 christos # "group key handshake failed...".
1919 1.1.1.8 christos # You should consider to also increase wpa_pairwise_update_count then.
1920 1.1.1.8 christos # Range 1..4294967295; default: 4
1921 1.1.1.8 christos #wpa_group_update_count=4
1922 1.1.1.8 christos
1923 1.1 christos # Time interval for rekeying GMK (master key used internally to generate GTKs
1924 1.1 christos # (in seconds).
1925 1.1 christos #wpa_gmk_rekey=86400
1926 1.1 christos
1927 1.1 christos # Maximum lifetime for PTK in seconds. This can be used to enforce rekeying of
1928 1.1 christos # PTK to mitigate some attacks against TKIP deficiencies.
1929 1.1.1.10 christos # Warning: PTK rekeying is buggy with many drivers/devices and with such
1930 1.1.1.10 christos # devices, the only secure method to rekey the PTK without Extended Key ID
1931 1.1.1.10 christos # support requires a disconnection. Check the related parameter
1932 1.1.1.10 christos # wpa_deny_ptk0_rekey for details.
1933 1.1 christos #wpa_ptk_rekey=600
1934 1.1 christos
1935 1.1.1.10 christos # Workaround for PTK rekey issues
1936 1.1.1.10 christos #
1937 1.1.1.10 christos # PTK0 rekeys (rekeying the PTK without "Extended Key ID for Individually
1938 1.1.1.10 christos # Addressed Frames") can degrade the security and stability with some cards.
1939 1.1.1.10 christos # To avoid such issues hostapd can replace those PTK rekeys (including EAP
1940 1.1.1.10 christos # reauthentications) with disconnects.
1941 1.1.1.10 christos #
1942 1.1.1.10 christos # Available options:
1943 1.1.1.10 christos # 0 = always rekey when configured/instructed (default)
1944 1.1.1.10 christos # 1 = only rekey when the local driver is explicitly indicating it can perform
1945 1.1.1.10 christos # this operation without issues
1946 1.1.1.10 christos # 2 = never allow PTK0 rekeys
1947 1.1.1.10 christos #wpa_deny_ptk0_rekey=0
1948 1.1.1.10 christos
1949 1.1.1.8 christos # The number of times EAPOL-Key Message 1/4 and Message 3/4 in the RSN 4-Way
1950 1.1.1.8 christos # Handshake are retried per 4-Way Handshake attempt.
1951 1.1.1.8 christos # (dot11RSNAConfigPairwiseUpdateCount)
1952 1.1.1.8 christos # Range 1..4294967295; default: 4
1953 1.1.1.8 christos #wpa_pairwise_update_count=4
1954 1.1.1.8 christos
1955 1.1.1.8 christos # Workaround for key reinstallation attacks
1956 1.1.1.8 christos #
1957 1.1.1.8 christos # This parameter can be used to disable retransmission of EAPOL-Key frames that
1958 1.1.1.8 christos # are used to install keys (EAPOL-Key message 3/4 and group message 1/2). This
1959 1.1.1.8 christos # is similar to setting wpa_group_update_count=1 and
1960 1.1.1.8 christos # wpa_pairwise_update_count=1, but with no impact to message 1/4 and with
1961 1.1.1.8 christos # extended timeout on the response to avoid causing issues with stations that
1962 1.1.1.8 christos # may use aggressive power saving have very long time in replying to the
1963 1.1.1.8 christos # EAPOL-Key messages.
1964 1.1.1.8 christos #
1965 1.1.1.8 christos # This option can be used to work around key reinstallation attacks on the
1966 1.1.1.8 christos # station (supplicant) side in cases those station devices cannot be updated
1967 1.1.1.8 christos # for some reason. By removing the retransmissions the attacker cannot cause
1968 1.1.1.8 christos # key reinstallation with a delayed frame transmission. This is related to the
1969 1.1.1.8 christos # station side vulnerabilities CVE-2017-13077, CVE-2017-13078, CVE-2017-13079,
1970 1.1.1.8 christos # CVE-2017-13080, and CVE-2017-13081.
1971 1.1.1.8 christos #
1972 1.1.1.8 christos # This workaround might cause interoperability issues and reduced robustness of
1973 1.1.1.8 christos # key negotiation especially in environments with heavy traffic load due to the
1974 1.1.1.8 christos # number of attempts to perform the key exchange is reduced significantly. As
1975 1.1.1.8 christos # such, this workaround is disabled by default (unless overridden in build
1976 1.1.1.8 christos # configuration). To enable this, set the parameter to 1.
1977 1.1.1.8 christos #wpa_disable_eapol_key_retries=1
1978 1.1.1.8 christos
1979 1.1 christos # Enable IEEE 802.11i/RSN/WPA2 pre-authentication. This is used to speed up
1980 1.1 christos # roaming be pre-authenticating IEEE 802.1X/EAP part of the full RSN
1981 1.1 christos # authentication and key handshake before actually associating with a new AP.
1982 1.1 christos # (dot11RSNAPreauthenticationEnabled)
1983 1.1 christos #rsn_preauth=1
1984 1.1 christos #
1985 1.1 christos # Space separated list of interfaces from which pre-authentication frames are
1986 1.1 christos # accepted (e.g., 'eth0' or 'eth0 wlan0wds0'. This list should include all
1987 1.1 christos # interface that are used for connections to other APs. This could include
1988 1.1 christos # wired interfaces and WDS links. The normal wireless data interface towards
1989 1.1 christos # associated stations (e.g., wlan0) should not be added, since
1990 1.1 christos # pre-authentication is only used with APs other than the currently associated
1991 1.1 christos # one.
1992 1.1 christos #rsn_preauth_interfaces=eth0
1993 1.1 christos
1994 1.1 christos # ieee80211w: Whether management frame protection (MFP) is enabled
1995 1.1 christos # 0 = disabled (default)
1996 1.1 christos # 1 = optional
1997 1.1 christos # 2 = required
1998 1.1 christos #ieee80211w=0
1999 1.1.1.10 christos # The most common configuration options for this based on the PMF (protected
2000 1.1.1.10 christos # management frames) certification program are:
2001 1.1.1.10 christos # PMF enabled: ieee80211w=1 and wpa_key_mgmt=WPA-EAP WPA-EAP-SHA256
2002 1.1.1.10 christos # PMF required: ieee80211w=2 and wpa_key_mgmt=WPA-EAP-SHA256
2003 1.1.1.10 christos # (and similarly for WPA-PSK and WPA-PSK-SHA256 if WPA2-Personal is used)
2004 1.1.1.10 christos # WPA3-Personal-only mode: ieee80211w=2 and wpa_key_mgmt=SAE
2005 1.1 christos
2006 1.1.1.5 christos # Group management cipher suite
2007 1.1.1.5 christos # Default: AES-128-CMAC (BIP)
2008 1.1.1.5 christos # Other options (depending on driver support):
2009 1.1.1.5 christos # BIP-GMAC-128
2010 1.1.1.5 christos # BIP-GMAC-256
2011 1.1.1.5 christos # BIP-CMAC-256
2012 1.1.1.5 christos # Note: All the stations connecting to the BSS will also need to support the
2013 1.1.1.5 christos # selected cipher. The default AES-128-CMAC is the only option that is commonly
2014 1.1.1.5 christos # available in deployed devices.
2015 1.1.1.5 christos #group_mgmt_cipher=AES-128-CMAC
2016 1.1.1.5 christos
2017 1.1.1.10 christos # Beacon Protection (management frame protection for Beacon frames)
2018 1.1.1.10 christos # This depends on management frame protection being enabled (ieee80211w != 0)
2019 1.1.1.10 christos # and beacon protection support indication from the driver.
2020 1.1.1.10 christos # 0 = disabled (default)
2021 1.1.1.10 christos # 1 = enabled
2022 1.1.1.10 christos #beacon_prot=0
2023 1.1.1.10 christos
2024 1.1 christos # Association SA Query maximum timeout (in TU = 1.024 ms; for MFP)
2025 1.1 christos # (maximum time to wait for a SA Query response)
2026 1.1 christos # dot11AssociationSAQueryMaximumTimeout, 1...4294967295
2027 1.1 christos #assoc_sa_query_max_timeout=1000
2028 1.1 christos
2029 1.1 christos # Association SA Query retry timeout (in TU = 1.024 ms; for MFP)
2030 1.1 christos # (time between two subsequent SA Query requests)
2031 1.1 christos # dot11AssociationSAQueryRetryTimeout, 1...4294967295
2032 1.1 christos #assoc_sa_query_retry_timeout=201
2033 1.1 christos
2034 1.1.1.9 christos # ocv: Operating Channel Validation
2035 1.1.1.10 christos # This is a countermeasure against multi-channel on-path attacks.
2036 1.1.1.10 christos # Enabling this depends on the driver's support for OCV when the driver SME is
2037 1.1.1.10 christos # used. If hostapd SME is used, this will be enabled just based on this
2038 1.1.1.10 christos # configuration.
2039 1.1.1.9 christos # Enabling this automatically also enables ieee80211w, if not yet enabled.
2040 1.1.1.9 christos # 0 = disabled (default)
2041 1.1.1.9 christos # 1 = enabled
2042 1.1.1.10 christos # 2 = enabled in workaround mode - Allow STA that claims OCV capability to
2043 1.1.1.10 christos # connect even if the STA doesn't send OCI or negotiate PMF. This
2044 1.1.1.10 christos # workaround is to improve interoperability with legacy STAs which are
2045 1.1.1.10 christos # wrongly copying reserved bits of RSN capabilities from the AP's
2046 1.1.1.10 christos # RSNE into (Re)Association Request frames. When this configuration is
2047 1.1.1.10 christos # enabled, the AP considers STA is OCV capable only when the STA indicates
2048 1.1.1.10 christos # MFP capability in (Re)Association Request frames and sends OCI in
2049 1.1.1.10 christos # EAPOL-Key msg 2/4/FT Reassociation Request frame/FILS (Re)Association
2050 1.1.1.10 christos # Request frame; otherwise, the AP disables OCV for the current connection
2051 1.1.1.10 christos # with the STA. Enabling this workaround mode reduced OCV protection to
2052 1.1.1.10 christos # some extend since it allows misbehavior to go through. As such, this
2053 1.1.1.10 christos # should be enabled only if interoperability with misbehaving STAs is
2054 1.1.1.10 christos # needed.
2055 1.1.1.9 christos #ocv=1
2056 1.1.1.9 christos
2057 1.1.1.3 christos # disable_pmksa_caching: Disable PMKSA caching
2058 1.1.1.3 christos # This parameter can be used to disable caching of PMKSA created through EAP
2059 1.1.1.3 christos # authentication. RSN preauthentication may still end up using PMKSA caching if
2060 1.1.1.3 christos # it is enabled (rsn_preauth=1).
2061 1.1.1.3 christos # 0 = PMKSA caching enabled (default)
2062 1.1.1.3 christos # 1 = PMKSA caching disabled
2063 1.1.1.3 christos #disable_pmksa_caching=0
2064 1.1 christos
2065 1.1 christos # okc: Opportunistic Key Caching (aka Proactive Key Caching)
2066 1.1 christos # Allow PMK cache to be shared opportunistically among configured interfaces
2067 1.1 christos # and BSSes (i.e., all configurations within a single hostapd process).
2068 1.1 christos # 0 = disabled (default)
2069 1.1 christos # 1 = enabled
2070 1.1 christos #okc=1
2071 1.1 christos
2072 1.1.1.8 christos # SAE password
2073 1.1.1.8 christos # This parameter can be used to set passwords for SAE. By default, the
2074 1.1.1.8 christos # wpa_passphrase value is used if this separate parameter is not used, but
2075 1.1.1.8 christos # wpa_passphrase follows the WPA-PSK constraints (8..63 characters) even though
2076 1.1.1.8 christos # SAE passwords do not have such constraints. If the BSS enabled both SAE and
2077 1.1.1.8 christos # WPA-PSK and both values are set, SAE uses the sae_password values and WPA-PSK
2078 1.1.1.8 christos # uses the wpa_passphrase value.
2079 1.1.1.8 christos #
2080 1.1.1.8 christos # Each sae_password entry is added to a list of available passwords. This
2081 1.1.1.8 christos # corresponds to the dot11RSNAConfigPasswordValueEntry. sae_password value
2082 1.1.1.8 christos # starts with the password (dot11RSNAConfigPasswordCredential). That value can
2083 1.1.1.8 christos # be followed by optional peer MAC address (dot11RSNAConfigPasswordPeerMac) and
2084 1.1.1.9 christos # by optional password identifier (dot11RSNAConfigPasswordIdentifier). In
2085 1.1.1.9 christos # addition, an optional VLAN ID specification can be used to bind the station
2086 1.1.1.10 christos # to the specified VLAN whenever the specific SAE password entry is used.
2087 1.1.1.9 christos #
2088 1.1.1.9 christos # If the peer MAC address is not included or is set to the wildcard address
2089 1.1.1.8 christos # (ff:ff:ff:ff:ff:ff), the entry is available for any station to use. If a
2090 1.1.1.8 christos # specific peer MAC address is included, only a station with that MAC address
2091 1.1.1.9 christos # is allowed to use the entry.
2092 1.1.1.9 christos #
2093 1.1.1.9 christos # If the password identifier (with non-zero length) is included, the entry is
2094 1.1.1.9 christos # limited to be used only with that specified identifier.
2095 1.1.1.9 christos
2096 1.1.1.9 christos # The last matching (based on peer MAC address and identifier) entry is used to
2097 1.1.1.9 christos # select which password to use. Setting sae_password to an empty string has a
2098 1.1.1.9 christos # special meaning of removing all previously added entries.
2099 1.1.1.9 christos #
2100 1.1.1.8 christos # sae_password uses the following encoding:
2101 1.1.1.10 christos #<password/credential>[|mac=<peer mac>][|vlanid=<VLAN ID>]
2102 1.1.1.10 christos #[|pk=<m:ECPrivateKey-base64>][|id=<identifier>]
2103 1.1.1.8 christos # Examples:
2104 1.1.1.8 christos #sae_password=secret
2105 1.1.1.8 christos #sae_password=really secret|mac=ff:ff:ff:ff:ff:ff
2106 1.1.1.8 christos #sae_password=example secret|mac=02:03:04:05:06:07|id=pw identifier
2107 1.1.1.9 christos #sae_password=example secret|vlanid=3|id=pw identifier
2108 1.1.1.10 christos #
2109 1.1.1.10 christos # SAE passwords can also be read from a separate file in which each line
2110 1.1.1.10 christos # contains and entry in the same format as sae_password uses.
2111 1.1.1.10 christos #sae_password_file=/tc/hostapd.sae_passwords
2112 1.1.1.8 christos
2113 1.1.1.5 christos # SAE threshold for anti-clogging mechanism (dot11RSNASAEAntiCloggingThreshold)
2114 1.1.1.5 christos # This parameter defines how many open SAE instances can be in progress at the
2115 1.1.1.5 christos # same time before the anti-clogging mechanism is taken into use.
2116 1.1.1.10 christos #sae_anti_clogging_threshold=5 (deprecated)
2117 1.1.1.10 christos #anti_clogging_threshold=5
2118 1.1.1.5 christos
2119 1.1.1.8 christos # Maximum number of SAE synchronization errors (dot11RSNASAESync)
2120 1.1.1.10 christos # The offending SAE peer will be disconnected if more than this many
2121 1.1.1.8 christos # synchronization errors happen.
2122 1.1.1.10 christos #sae_sync=3
2123 1.1.1.8 christos
2124 1.1.1.5 christos # Enabled SAE finite cyclic groups
2125 1.1.1.5 christos # SAE implementation are required to support group 19 (ECC group defined over a
2126 1.1.1.9 christos # 256-bit prime order field). This configuration parameter can be used to
2127 1.1.1.9 christos # specify a set of allowed groups. If not included, only the mandatory group 19
2128 1.1.1.9 christos # is enabled.
2129 1.1.1.9 christos # The group values are listed in the IANA registry:
2130 1.1.1.5 christos # http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-9
2131 1.1.1.9 christos # Note that groups 1, 2, 5, 22, 23, and 24 should not be used in production
2132 1.1.1.9 christos # purposes due limited security (see RFC 8247). Groups that are not as strong as
2133 1.1.1.9 christos # group 19 (ECC, NIST P-256) are unlikely to be useful for production use cases
2134 1.1.1.9 christos # since all implementations are required to support group 19.
2135 1.1.1.9 christos #sae_groups=19 20 21
2136 1.1 christos
2137 1.1.1.8 christos # Require MFP for all associations using SAE
2138 1.1.1.8 christos # This parameter can be used to enforce negotiation of MFP for all associations
2139 1.1.1.8 christos # that negotiate use of SAE. This is used in cases where SAE-capable devices are
2140 1.1.1.8 christos # known to be MFP-capable and the BSS is configured with optional MFP
2141 1.1.1.8 christos # (ieee80211w=1) for legacy support. The non-SAE stations can connect without
2142 1.1.1.8 christos # MFP while SAE stations are required to negotiate MFP if sae_require_mfp=1.
2143 1.1.1.8 christos #sae_require_mfp=0
2144 1.1.1.8 christos
2145 1.1.1.10 christos # SAE Confirm behavior
2146 1.1.1.10 christos # By default, AP will send out only SAE Commit message in response to a received
2147 1.1.1.10 christos # SAE Commit message. This parameter can be set to 1 to override that behavior
2148 1.1.1.10 christos # to send both SAE Commit and SAE Confirm messages without waiting for the STA
2149 1.1.1.10 christos # to send its SAE Confirm message first.
2150 1.1.1.10 christos #sae_confirm_immediate=0
2151 1.1.1.10 christos
2152 1.1.1.10 christos # SAE mechanism for PWE derivation
2153 1.1.1.10 christos # 0 = hunting-and-pecking loop only (default without password identifier)
2154 1.1.1.10 christos # 1 = hash-to-element only (default with password identifier)
2155 1.1.1.10 christos # 2 = both hunting-and-pecking loop and hash-to-element enabled
2156 1.1.1.10 christos # Note: The default value is likely to change from 0 to 2 once the new
2157 1.1.1.10 christos # hash-to-element mechanism has received more interoperability testing.
2158 1.1.1.10 christos # When using SAE password identifier, the hash-to-element mechanism is used
2159 1.1.1.10 christos # regardless of the sae_pwe parameter value.
2160 1.1.1.10 christos #sae_pwe=0
2161 1.1.1.10 christos
2162 1.1.1.8 christos # FILS Cache Identifier (16-bit value in hexdump format)
2163 1.1.1.8 christos #fils_cache_id=0011
2164 1.1.1.8 christos
2165 1.1.1.8 christos # FILS Realm Information
2166 1.1.1.8 christos # One or more FILS realms need to be configured when FILS is enabled. This list
2167 1.1.1.8 christos # of realms is used to define which realms (used in keyName-NAI by the client)
2168 1.1.1.8 christos # can be used with FILS shared key authentication for ERP.
2169 1.1.1.8 christos #fils_realm=example.com
2170 1.1.1.8 christos #fils_realm=example.org
2171 1.1.1.8 christos
2172 1.1.1.8 christos # FILS DH Group for PFS
2173 1.1.1.8 christos # 0 = PFS disabled with FILS shared key authentication (default)
2174 1.1.1.8 christos # 1-65535 DH Group to use for FILS PFS
2175 1.1.1.8 christos #fils_dh_group=0
2176 1.1.1.8 christos
2177 1.1.1.8 christos # OWE DH groups
2178 1.1.1.8 christos # OWE implementations are required to support group 19 (NIST P-256). All groups
2179 1.1.1.8 christos # that are supported by the implementation (e.g., groups 19, 20, and 21 when
2180 1.1.1.8 christos # using OpenSSL) are enabled by default. This configuration parameter can be
2181 1.1.1.8 christos # used to specify a limited set of allowed groups. The group values are listed
2182 1.1.1.8 christos # in the IANA registry:
2183 1.1.1.8 christos # http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-10
2184 1.1.1.8 christos #owe_groups=19 20 21
2185 1.1.1.8 christos
2186 1.1.1.10 christos # OWE PTK derivation workaround
2187 1.1.1.10 christos # Initial OWE implementation used SHA256 when deriving the PTK for all OWE
2188 1.1.1.10 christos # groups. This was supposed to change to SHA384 for group 20 and SHA512 for
2189 1.1.1.10 christos # group 21. This parameter can be used to enable workaround for interoperability
2190 1.1.1.10 christos # with stations that use SHA256 with groups 20 and 21. By default (0) only the
2191 1.1.1.10 christos # appropriate hash function is accepted. When workaround is enabled (1), the
2192 1.1.1.10 christos # appropriate hash function is tried first and if that fails, SHA256-based PTK
2193 1.1.1.10 christos # derivation is attempted. This workaround can result in reduced security for
2194 1.1.1.10 christos # groups 20 and 21, but is required for interoperability with older
2195 1.1.1.10 christos # implementations. There is no impact to group 19 behavior. The workaround is
2196 1.1.1.10 christos # disabled by default and can be enabled by uncommenting the following line.
2197 1.1.1.10 christos #owe_ptk_workaround=1
2198 1.1.1.10 christos
2199 1.1.1.8 christos # OWE transition mode configuration
2200 1.1.1.8 christos # Pointer to the matching open/OWE BSS
2201 1.1.1.8 christos #owe_transition_bssid=<bssid>
2202 1.1.1.8 christos # SSID in same format as ssid2 described above.
2203 1.1.1.8 christos #owe_transition_ssid=<SSID>
2204 1.1.1.8 christos # Alternatively, OWE transition mode BSSID/SSID can be configured with a
2205 1.1.1.8 christos # reference to a BSS operated by this hostapd process.
2206 1.1.1.8 christos #owe_transition_ifname=<ifname>
2207 1.1.1.8 christos
2208 1.1.1.8 christos # DHCP server for FILS HLP
2209 1.1.1.8 christos # If configured, hostapd will act as a DHCP relay for all FILS HLP requests
2210 1.1.1.8 christos # that include a DHCPDISCOVER message and send them to the specific DHCP
2211 1.1.1.8 christos # server for processing. hostapd will then wait for a response from that server
2212 1.1.1.8 christos # before replying with (Re)Association Response frame that encapsulates this
2213 1.1.1.8 christos # DHCP response. own_ip_addr is used as the local address for the communication
2214 1.1.1.8 christos # with the DHCP server.
2215 1.1.1.8 christos #dhcp_server=127.0.0.1
2216 1.1.1.8 christos
2217 1.1.1.8 christos # DHCP server UDP port
2218 1.1.1.8 christos # Default: 67
2219 1.1.1.8 christos #dhcp_server_port=67
2220 1.1.1.8 christos
2221 1.1.1.8 christos # DHCP relay UDP port on the local device
2222 1.1.1.8 christos # Default: 67; 0 means not to bind any specific port
2223 1.1.1.8 christos #dhcp_relay_port=67
2224 1.1.1.8 christos
2225 1.1.1.8 christos # DHCP rapid commit proxy
2226 1.1.1.8 christos # If set to 1, this enables hostapd to act as a DHCP rapid commit proxy to
2227 1.1.1.8 christos # allow the rapid commit options (two message DHCP exchange) to be used with a
2228 1.1.1.8 christos # server that supports only the four message DHCP exchange. This is disabled by
2229 1.1.1.8 christos # default (= 0) and can be enabled by setting this to 1.
2230 1.1.1.8 christos #dhcp_rapid_commit_proxy=0
2231 1.1.1.8 christos
2232 1.1.1.8 christos # Wait time for FILS HLP (dot11HLPWaitTime) in TUs
2233 1.1.1.8 christos # default: 30 TUs (= 30.72 milliseconds)
2234 1.1.1.8 christos #fils_hlp_wait_time=30
2235 1.1.1.8 christos
2236 1.1.1.10 christos # FILS Discovery frame transmission minimum and maximum interval settings.
2237 1.1.1.10 christos # If fils_discovery_max_interval is non-zero, the AP enables FILS Discovery
2238 1.1.1.10 christos # frame transmission. These values use TUs as the unit and have allowed range
2239 1.1.1.10 christos # of 0-10000. fils_discovery_min_interval defaults to 20.
2240 1.1.1.10 christos # This feature is currently supported only when ieee80211ax is enabled for
2241 1.1.1.10 christos # the radio and disable_11ax is not set for the BSS.
2242 1.1.1.10 christos #fils_discovery_min_interval=20
2243 1.1.1.10 christos #fils_discovery_max_interval=0
2244 1.1.1.10 christos
2245 1.1.1.10 christos # Transition Disable indication
2246 1.1.1.10 christos # The AP can notify authenticated stations to disable transition mode in their
2247 1.1.1.10 christos # network profiles when the network has completed transition steps, i.e., once
2248 1.1.1.10 christos # sufficiently large number of APs in the ESS have been updated to support the
2249 1.1.1.10 christos # more secure alternative. When this indication is used, the stations are
2250 1.1.1.10 christos # expected to automatically disable transition mode and less secure security
2251 1.1.1.10 christos # options. This includes use of WEP, TKIP (including use of TKIP as the group
2252 1.1.1.10 christos # cipher), and connections without PMF.
2253 1.1.1.10 christos # Bitmap bits:
2254 1.1.1.10 christos # bit 0 (0x01): WPA3-Personal (i.e., disable WPA2-Personal = WPA-PSK and only
2255 1.1.1.10 christos # allow SAE to be used)
2256 1.1.1.10 christos # bit 1 (0x02): SAE-PK (disable SAE without use of SAE-PK)
2257 1.1.1.10 christos # bit 2 (0x04): WPA3-Enterprise (move to requiring PMF)
2258 1.1.1.10 christos # bit 3 (0x08): Enhanced Open (disable use of open network; require OWE)
2259 1.1.1.10 christos # (default: 0 = do not include Transition Disable KDE)
2260 1.1.1.10 christos #transition_disable=0x01
2261 1.1.1.10 christos
2262 1.1.1.10 christos # PASN ECDH groups
2263 1.1.1.10 christos # PASN implementations are required to support group 19 (NIST P-256). If this
2264 1.1.1.10 christos # parameter is not set, only group 19 is supported by default. This
2265 1.1.1.10 christos # configuration parameter can be used to specify a limited set of allowed
2266 1.1.1.10 christos # groups. The group values are listed in the IANA registry:
2267 1.1.1.10 christos # http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-10
2268 1.1.1.10 christos #pasn_groups=19 20 21
2269 1.1.1.10 christos
2270 1.1.1.10 christos # PASN comeback after time in TUs
2271 1.1.1.10 christos # In case the AP is temporarily unable to handle a PASN authentication exchange
2272 1.1.1.10 christos # due to a too large number of parallel operations, this value indicates to the
2273 1.1.1.10 christos # peer after how many TUs it can try the PASN exchange again.
2274 1.1.1.10 christos # (default: 10 TUs)
2275 1.1.1.10 christos #pasn_comeback_after=10
2276 1.1.1.10 christos
2277 1.1.1.10 christos # Unauthenticated PASN activated (dot11NoAuthPASNActivated)
2278 1.1.1.10 christos # This indicates whether PASN without mutual authentication is allowed.
2279 1.1.1.10 christos # (default: 1 = activated)
2280 1.1.1.10 christos #pasn_noauth=1
2281 1.1.1.10 christos
2282 1.1.1.10 christos # SSID protection in 4-way handshake
2283 1.1.1.10 christos # The IEEE 802.11i-2004 RSN design did not provide means for protecting the
2284 1.1.1.10 christos # SSID in the general case. IEEE P802.11REVme/D6.0 added support for this in
2285 1.1.1.10 christos # 4-way handshake. This capability allows a STA to confirm that the AP has the
2286 1.1.1.10 christos # same understanding on which SSID is being used for an association in a
2287 1.1.1.10 christos # protected manner in cases where both the AP and the STA has this capability.
2288 1.1.1.10 christos # This can be used to mitigate CVE-2023-52424 (a.k.a. the SSID Confusion
2289 1.1.1.10 christos # Attack).
2290 1.1.1.10 christos #
2291 1.1.1.10 christos # Ideally, this capability would be enabled by default on the AP, but since this
2292 1.1.1.10 christos # is new functionality with limited testing, the default is to disable this for
2293 1.1.1.10 christos # now and require explicitly configuration to enable. The default behavior is
2294 1.1.1.10 christos # like to change once this capability has received more testing.
2295 1.1.1.10 christos #
2296 1.1.1.10 christos # 0 = SSID protection in 4-way handshake disabled (default)
2297 1.1.1.10 christos # 1 = SSID protection in 4-way handshake enabled
2298 1.1.1.10 christos #
2299 1.1.1.10 christos #ssid_protection=0
2300 1.1.1.10 christos
2301 1.1 christos ##### IEEE 802.11r configuration ##############################################
2302 1.1 christos
2303 1.1 christos # Mobility Domain identifier (dot11FTMobilityDomainID, MDID)
2304 1.1 christos # MDID is used to indicate a group of APs (within an ESS, i.e., sharing the
2305 1.1 christos # same SSID) between which a STA can use Fast BSS Transition.
2306 1.1 christos # 2-octet identifier as a hex string.
2307 1.1 christos #mobility_domain=a1b2
2308 1.1 christos
2309 1.1 christos # PMK-R0 Key Holder identifier (dot11FTR0KeyHolderID)
2310 1.1 christos # 1 to 48 octet identifier.
2311 1.1 christos # This is configured with nas_identifier (see RADIUS client section above).
2312 1.1 christos
2313 1.1.1.8 christos # Default lifetime of the PMK-R0 in seconds; range 60..4294967295
2314 1.1.1.8 christos # (default: 14 days / 1209600 seconds; 0 = disable timeout)
2315 1.1 christos # (dot11FTR0KeyLifetime)
2316 1.1.1.8 christos #ft_r0_key_lifetime=1209600
2317 1.1.1.8 christos
2318 1.1.1.8 christos # Maximum lifetime for PMK-R1; applied only if not zero
2319 1.1.1.8 christos # PMK-R1 is removed at latest after this limit.
2320 1.1.1.8 christos # Removing any PMK-R1 for expiry can be disabled by setting this to -1.
2321 1.1.1.8 christos # (default: 0)
2322 1.1.1.8 christos #r1_max_key_lifetime=0
2323 1.1 christos
2324 1.1 christos # PMK-R1 Key Holder identifier (dot11FTR1KeyHolderID)
2325 1.1 christos # 6-octet identifier as a hex string.
2326 1.1.1.7 christos # Defaults to BSSID.
2327 1.1 christos #r1_key_holder=000102030405
2328 1.1 christos
2329 1.1 christos # Reassociation deadline in time units (TUs / 1.024 ms; range 1000..65535)
2330 1.1 christos # (dot11FTReassociationDeadline)
2331 1.1 christos #reassociation_deadline=1000
2332 1.1 christos
2333 1.1 christos # List of R0KHs in the same Mobility Domain
2334 1.1.1.8 christos # format: <MAC address> <NAS Identifier> <256-bit key as hex string>
2335 1.1 christos # This list is used to map R0KH-ID (NAS Identifier) to a destination MAC
2336 1.1 christos # address when requesting PMK-R1 key from the R0KH that the STA used during the
2337 1.1 christos # Initial Mobility Domain Association.
2338 1.1.1.8 christos #r0kh=02:01:02:03:04:05 r0kh-1.example.com 000102030405060708090a0b0c0d0e0f000102030405060708090a0b0c0d0e0f
2339 1.1.1.8 christos #r0kh=02:01:02:03:04:06 r0kh-2.example.com 00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff
2340 1.1 christos # And so on.. One line per R0KH.
2341 1.1.1.8 christos # Wildcard entry:
2342 1.1.1.8 christos # Upon receiving a response from R0KH, it will be added to this list, so
2343 1.1.1.8 christos # subsequent requests won't be broadcast. If R0KH does not reply, it will be
2344 1.1.1.10 christos # temporarily blocked (see rkh_neg_timeout).
2345 1.1.1.8 christos #r0kh=ff:ff:ff:ff:ff:ff * 00112233445566778899aabbccddeeff
2346 1.1 christos
2347 1.1 christos # List of R1KHs in the same Mobility Domain
2348 1.1.1.8 christos # format: <MAC address> <R1KH-ID> <256-bit key as hex string>
2349 1.1 christos # This list is used to map R1KH-ID to a destination MAC address when sending
2350 1.1 christos # PMK-R1 key from the R0KH. This is also the list of authorized R1KHs in the MD
2351 1.1 christos # that can request PMK-R1 keys.
2352 1.1.1.8 christos #r1kh=02:01:02:03:04:05 02:11:22:33:44:55 000102030405060708090a0b0c0d0e0f000102030405060708090a0b0c0d0e0f
2353 1.1.1.8 christos #r1kh=02:01:02:03:04:06 02:11:22:33:44:66 00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff
2354 1.1 christos # And so on.. One line per R1KH.
2355 1.1.1.8 christos # Wildcard entry:
2356 1.1.1.8 christos # Upon receiving a request from an R1KH not yet known, it will be added to this
2357 1.1.1.8 christos # list and thus will receive push notifications.
2358 1.1.1.8 christos #r1kh=00:00:00:00:00:00 00:00:00:00:00:00 00112233445566778899aabbccddeeff
2359 1.1.1.8 christos
2360 1.1.1.10 christos # Optionally, the list of RxKHs can be read from a text file. Format is the same
2361 1.1.1.10 christos # as specified above. File shall contain both r0kh and r1kh. Once this variable
2362 1.1.1.10 christos # is set, RxKHs can be reloaded at runtime without bringing down an interface
2363 1.1.1.10 christos # using the RELOAD_RXKHS command.
2364 1.1.1.10 christos #rxkh_file=<path>
2365 1.1.1.10 christos
2366 1.1.1.8 christos # Timeout (seconds) for newly discovered R0KH/R1KH (see wildcard entries above)
2367 1.1.1.8 christos # Special values: 0 -> do not expire
2368 1.1.1.8 christos # Warning: do not cache implies no sequence number validation with wildcards
2369 1.1.1.8 christos #rkh_pos_timeout=86400 (default = 1 day)
2370 1.1.1.8 christos
2371 1.1.1.8 christos # Timeout (milliseconds) for requesting PMK-R1 from R0KH using PULL request
2372 1.1.1.8 christos # and number of retries.
2373 1.1.1.8 christos #rkh_pull_timeout=1000 (default = 1 second)
2374 1.1.1.8 christos #rkh_pull_retries=4 (default)
2375 1.1.1.8 christos
2376 1.1.1.8 christos # Timeout (seconds) for non replying R0KH (see wildcard entries above)
2377 1.1.1.8 christos # Special values: 0 -> do not cache
2378 1.1.1.8 christos # default: 60 seconds
2379 1.1.1.8 christos #rkh_neg_timeout=60
2380 1.1.1.8 christos
2381 1.1.1.8 christos # Note: The R0KH/R1KH keys used to be 128-bit in length before the message
2382 1.1.1.8 christos # format was changed. That shorter key length is still supported for backwards
2383 1.1.1.8 christos # compatibility of the configuration files. If such a shorter key is used, a
2384 1.1.1.8 christos # 256-bit key is derived from it. For new deployments, configuring the 256-bit
2385 1.1.1.8 christos # key is recommended.
2386 1.1 christos
2387 1.1 christos # Whether PMK-R1 push is enabled at R0KH
2388 1.1 christos # 0 = do not push PMK-R1 to all configured R1KHs (default)
2389 1.1 christos # 1 = push PMK-R1 to all configured R1KHs whenever a new PMK-R0 is derived
2390 1.1 christos #pmk_r1_push=1
2391 1.1 christos
2392 1.1.1.7 christos # Whether to enable FT-over-DS
2393 1.1.1.7 christos # 0 = FT-over-DS disabled
2394 1.1.1.7 christos # 1 = FT-over-DS enabled (default)
2395 1.1.1.7 christos #ft_over_ds=1
2396 1.1.1.7 christos
2397 1.1.1.8 christos # Whether to generate FT response locally for PSK networks
2398 1.1.1.8 christos # This avoids use of PMK-R1 push/pull from other APs with FT-PSK networks as
2399 1.1.1.8 christos # the required information (PSK and other session data) is already locally
2400 1.1.1.8 christos # available.
2401 1.1.1.8 christos # 0 = disabled (default)
2402 1.1.1.8 christos # 1 = enabled
2403 1.1.1.8 christos #ft_psk_generate_local=0
2404 1.1.1.8 christos
2405 1.1 christos ##### Neighbor table ##########################################################
2406 1.1.1.10 christos # Maximum number of entries kept in AP table (either for neighbor table or for
2407 1.1 christos # detecting Overlapping Legacy BSS Condition). The oldest entry will be
2408 1.1 christos # removed when adding a new entry that would make the list grow over this
2409 1.1 christos # limit. Note! WFA certification for IEEE 802.11g requires that OLBC is
2410 1.1 christos # enabled, so this field should not be set to 0 when using IEEE 802.11g.
2411 1.1 christos # default: 255
2412 1.1 christos #ap_table_max_size=255
2413 1.1 christos
2414 1.1 christos # Number of seconds of no frames received after which entries may be deleted
2415 1.1 christos # from the AP table. Since passive scanning is not usually performed frequently
2416 1.1 christos # this should not be set to very small value. In addition, there is no
2417 1.1 christos # guarantee that every scan cycle will receive beacon frames from the
2418 1.1 christos # neighboring APs.
2419 1.1 christos # default: 60
2420 1.1 christos #ap_table_expiration_time=3600
2421 1.1 christos
2422 1.1.1.7 christos # Maximum number of stations to track on the operating channel
2423 1.1.1.7 christos # This can be used to detect dualband capable stations before they have
2424 1.1.1.7 christos # associated, e.g., to provide guidance on which colocated BSS to use.
2425 1.1.1.7 christos # Default: 0 (disabled)
2426 1.1.1.7 christos #track_sta_max_num=100
2427 1.1.1.7 christos
2428 1.1.1.7 christos # Maximum age of a station tracking entry in seconds
2429 1.1.1.7 christos # Default: 180
2430 1.1.1.7 christos #track_sta_max_age=180
2431 1.1.1.7 christos
2432 1.1.1.7 christos # Do not reply to group-addressed Probe Request from a station that was seen on
2433 1.1.1.7 christos # another radio.
2434 1.1.1.7 christos # Default: Disabled
2435 1.1.1.7 christos #
2436 1.1.1.7 christos # This can be used with enabled track_sta_max_num configuration on another
2437 1.1.1.7 christos # interface controlled by the same hostapd process to restrict Probe Request
2438 1.1.1.7 christos # frame handling from replying to group-addressed Probe Request frames from a
2439 1.1.1.7 christos # station that has been detected to be capable of operating on another band,
2440 1.1.1.7 christos # e.g., to try to reduce likelihood of the station selecting a 2.4 GHz BSS when
2441 1.1.1.7 christos # the AP operates both a 2.4 GHz and 5 GHz BSS concurrently.
2442 1.1.1.7 christos #
2443 1.1.1.7 christos # Note: Enabling this can cause connectivity issues and increase latency for
2444 1.1.1.7 christos # discovering the AP.
2445 1.1.1.7 christos #no_probe_resp_if_seen_on=wlan1
2446 1.1.1.7 christos
2447 1.1.1.7 christos # Reject authentication from a station that was seen on another radio.
2448 1.1.1.7 christos # Default: Disabled
2449 1.1.1.7 christos #
2450 1.1.1.7 christos # This can be used with enabled track_sta_max_num configuration on another
2451 1.1.1.7 christos # interface controlled by the same hostapd process to reject authentication
2452 1.1.1.7 christos # attempts from a station that has been detected to be capable of operating on
2453 1.1.1.7 christos # another band, e.g., to try to reduce likelihood of the station selecting a
2454 1.1.1.7 christos # 2.4 GHz BSS when the AP operates both a 2.4 GHz and 5 GHz BSS concurrently.
2455 1.1.1.7 christos #
2456 1.1.1.7 christos # Note: Enabling this can cause connectivity issues and increase latency for
2457 1.1.1.7 christos # connecting with the AP.
2458 1.1.1.7 christos #no_auth_if_seen_on=wlan1
2459 1.1 christos
2460 1.1 christos ##### Wi-Fi Protected Setup (WPS) #############################################
2461 1.1 christos
2462 1.1 christos # WPS state
2463 1.1 christos # 0 = WPS disabled (default)
2464 1.1 christos # 1 = WPS enabled, not configured
2465 1.1 christos # 2 = WPS enabled, configured
2466 1.1 christos #wps_state=2
2467 1.1 christos
2468 1.1.1.5 christos # Whether to manage this interface independently from other WPS interfaces
2469 1.1.1.5 christos # By default, a single hostapd process applies WPS operations to all configured
2470 1.1.1.5 christos # interfaces. This parameter can be used to disable that behavior for a subset
2471 1.1.1.5 christos # of interfaces. If this is set to non-zero for an interface, WPS commands
2472 1.1.1.5 christos # issued on that interface do not apply to other interfaces and WPS operations
2473 1.1.1.5 christos # performed on other interfaces do not affect this interface.
2474 1.1.1.5 christos #wps_independent=0
2475 1.1.1.5 christos
2476 1.1 christos # AP can be configured into a locked state where new WPS Registrar are not
2477 1.1 christos # accepted, but previously authorized Registrars (including the internal one)
2478 1.1 christos # can continue to add new Enrollees.
2479 1.1 christos #ap_setup_locked=1
2480 1.1 christos
2481 1.1 christos # Universally Unique IDentifier (UUID; see RFC 4122) of the device
2482 1.1 christos # This value is used as the UUID for the internal WPS Registrar. If the AP
2483 1.1 christos # is also using UPnP, this value should be set to the device's UPnP UUID.
2484 1.1 christos # If not configured, UUID will be generated based on the local MAC address.
2485 1.1 christos #uuid=12345678-9abc-def0-1234-56789abcdef0
2486 1.1 christos
2487 1.1 christos # Note: If wpa_psk_file is set, WPS is used to generate random, per-device PSKs
2488 1.1 christos # that will be appended to the wpa_psk_file. If wpa_psk_file is not set, the
2489 1.1 christos # default PSK (wpa_psk/wpa_passphrase) will be delivered to Enrollees. Use of
2490 1.1 christos # per-device PSKs is recommended as the more secure option (i.e., make sure to
2491 1.1 christos # set wpa_psk_file when using WPS with WPA-PSK).
2492 1.1 christos
2493 1.1 christos # When an Enrollee requests access to the network with PIN method, the Enrollee
2494 1.1 christos # PIN will need to be entered for the Registrar. PIN request notifications are
2495 1.1 christos # sent to hostapd ctrl_iface monitor. In addition, they can be written to a
2496 1.1 christos # text file that could be used, e.g., to populate the AP administration UI with
2497 1.1 christos # pending PIN requests. If the following variable is set, the PIN requests will
2498 1.1 christos # be written to the configured file.
2499 1.1 christos #wps_pin_requests=/var/run/hostapd_wps_pin_requests
2500 1.1 christos
2501 1.1 christos # Device Name
2502 1.1 christos # User-friendly description of device; up to 32 octets encoded in UTF-8
2503 1.1 christos #device_name=Wireless AP
2504 1.1 christos
2505 1.1 christos # Manufacturer
2506 1.1 christos # The manufacturer of the device (up to 64 ASCII characters)
2507 1.1 christos #manufacturer=Company
2508 1.1 christos
2509 1.1 christos # Model Name
2510 1.1 christos # Model of the device (up to 32 ASCII characters)
2511 1.1 christos #model_name=WAP
2512 1.1 christos
2513 1.1 christos # Model Number
2514 1.1 christos # Additional device description (up to 32 ASCII characters)
2515 1.1 christos #model_number=123
2516 1.1 christos
2517 1.1 christos # Serial Number
2518 1.1 christos # Serial number of the device (up to 32 characters)
2519 1.1 christos #serial_number=12345
2520 1.1 christos
2521 1.1 christos # Primary Device Type
2522 1.1 christos # Used format: <categ>-<OUI>-<subcateg>
2523 1.1 christos # categ = Category as an integer value
2524 1.1 christos # OUI = OUI and type octet as a 4-octet hex-encoded value; 0050F204 for
2525 1.1 christos # default WPS OUI
2526 1.1 christos # subcateg = OUI-specific Sub Category as an integer value
2527 1.1 christos # Examples:
2528 1.1 christos # 1-0050F204-1 (Computer / PC)
2529 1.1 christos # 1-0050F204-2 (Computer / Server)
2530 1.1 christos # 5-0050F204-1 (Storage / NAS)
2531 1.1 christos # 6-0050F204-1 (Network Infrastructure / AP)
2532 1.1 christos #device_type=6-0050F204-1
2533 1.1 christos
2534 1.1 christos # OS Version
2535 1.1 christos # 4-octet operating system version number (hex string)
2536 1.1 christos #os_version=01020300
2537 1.1 christos
2538 1.1 christos # Config Methods
2539 1.1 christos # List of the supported configuration methods
2540 1.1 christos # Available methods: usba ethernet label display ext_nfc_token int_nfc_token
2541 1.1.1.3 christos # nfc_interface push_button keypad virtual_display physical_display
2542 1.1.1.3 christos # virtual_push_button physical_push_button
2543 1.1.1.3 christos #config_methods=label virtual_display virtual_push_button keypad
2544 1.1.1.3 christos
2545 1.1.1.3 christos # WPS capability discovery workaround for PBC with Windows 7
2546 1.1.1.3 christos # Windows 7 uses incorrect way of figuring out AP's WPS capabilities by acting
2547 1.1.1.3 christos # as a Registrar and using M1 from the AP. The config methods attribute in that
2548 1.1.1.3 christos # message is supposed to indicate only the configuration method supported by
2549 1.1.1.3 christos # the AP in Enrollee role, i.e., to add an external Registrar. For that case,
2550 1.1.1.3 christos # PBC shall not be used and as such, the PushButton config method is removed
2551 1.1.1.3 christos # from M1 by default. If pbc_in_m1=1 is included in the configuration file,
2552 1.1.1.3 christos # the PushButton config method is left in M1 (if included in config_methods
2553 1.1.1.3 christos # parameter) to allow Windows 7 to use PBC instead of PIN (e.g., from a label
2554 1.1.1.3 christos # in the AP).
2555 1.1.1.3 christos #pbc_in_m1=1
2556 1.1 christos
2557 1.1.1.2 christos # Static access point PIN for initial configuration and adding Registrars
2558 1.1 christos # If not set, hostapd will not allow external WPS Registrars to control the
2559 1.1.1.2 christos # access point. The AP PIN can also be set at runtime with hostapd_cli
2560 1.1.1.2 christos # wps_ap_pin command. Use of temporary (enabled by user action) and random
2561 1.1.1.2 christos # AP PIN is much more secure than configuring a static AP PIN here. As such,
2562 1.1.1.2 christos # use of the ap_pin parameter is not recommended if the AP device has means for
2563 1.1.1.2 christos # displaying a random PIN.
2564 1.1 christos #ap_pin=12345670
2565 1.1 christos
2566 1.1 christos # Skip building of automatic WPS credential
2567 1.1 christos # This can be used to allow the automatically generated Credential attribute to
2568 1.1 christos # be replaced with pre-configured Credential(s).
2569 1.1 christos #skip_cred_build=1
2570 1.1 christos
2571 1.1 christos # Additional Credential attribute(s)
2572 1.1 christos # This option can be used to add pre-configured Credential attributes into M8
2573 1.1 christos # message when acting as a Registrar. If skip_cred_build=1, this data will also
2574 1.1 christos # be able to override the Credential attribute that would have otherwise been
2575 1.1 christos # automatically generated based on network configuration. This configuration
2576 1.1 christos # option points to an external file that much contain the WPS Credential
2577 1.1 christos # attribute(s) as binary data.
2578 1.1 christos #extra_cred=hostapd.cred
2579 1.1 christos
2580 1.1 christos # Credential processing
2581 1.1 christos # 0 = process received credentials internally (default)
2582 1.1 christos # 1 = do not process received credentials; just pass them over ctrl_iface to
2583 1.1 christos # external program(s)
2584 1.1 christos # 2 = process received credentials internally and pass them over ctrl_iface
2585 1.1 christos # to external program(s)
2586 1.1 christos # Note: With wps_cred_processing=1, skip_cred_build should be set to 1 and
2587 1.1 christos # extra_cred be used to provide the Credential data for Enrollees.
2588 1.1 christos #
2589 1.1 christos # wps_cred_processing=1 will disabled automatic updates of hostapd.conf file
2590 1.1 christos # both for Credential processing and for marking AP Setup Locked based on
2591 1.1 christos # validation failures of AP PIN. An external program is responsible on updating
2592 1.1 christos # the configuration appropriately in this case.
2593 1.1 christos #wps_cred_processing=0
2594 1.1 christos
2595 1.1.1.9 christos # Whether to enable SAE (WPA3-Personal transition mode) automatically for
2596 1.1.1.9 christos # WPA2-PSK credentials received using WPS.
2597 1.1.1.9 christos # 0 = only add the explicitly listed WPA2-PSK configuration (default)
2598 1.1.1.9 christos # 1 = add both the WPA2-PSK and SAE configuration and enable PMF so that the
2599 1.1.1.9 christos # AP gets configured in WPA3-Personal transition mode (supports both
2600 1.1.1.9 christos # WPA2-Personal (PSK) and WPA3-Personal (SAE) clients).
2601 1.1.1.9 christos #wps_cred_add_sae=0
2602 1.1.1.9 christos
2603 1.1 christos # AP Settings Attributes for M7
2604 1.1 christos # By default, hostapd generates the AP Settings Attributes for M7 based on the
2605 1.1 christos # current configuration. It is possible to override this by providing a file
2606 1.1 christos # with pre-configured attributes. This is similar to extra_cred file format,
2607 1.1 christos # but the AP Settings attributes are not encapsulated in a Credential
2608 1.1 christos # attribute.
2609 1.1 christos #ap_settings=hostapd.ap_settings
2610 1.1 christos
2611 1.1.1.9 christos # Multi-AP backhaul BSS config
2612 1.1.1.9 christos # Used in WPS when multi_ap=2 or 3. Defines "backhaul BSS" credentials.
2613 1.1.1.9 christos # These are passed in WPS M8 instead of the normal (fronthaul) credentials
2614 1.1.1.9 christos # if the Enrollee has the Multi-AP subelement set. Backhaul SSID is formatted
2615 1.1.1.9 christos # like ssid2. The key is set like wpa_psk or wpa_passphrase.
2616 1.1.1.9 christos #multi_ap_backhaul_ssid="backhaul"
2617 1.1.1.9 christos #multi_ap_backhaul_wpa_psk=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
2618 1.1.1.9 christos #multi_ap_backhaul_wpa_passphrase=secret passphrase
2619 1.1.1.9 christos
2620 1.1.1.10 christos # Multi-AP Profile
2621 1.1.1.10 christos # Indicate the supported Multi-AP profile (default: 2)
2622 1.1.1.10 christos # 1 = Supports Multi-AP profile 1 as defined in Wi-Fi EasyMesh specification
2623 1.1.1.10 christos # 2 = Supports Multi-AP profile 2 as defined in Wi-Fi EasyMesh specification
2624 1.1.1.10 christos #multi_ap_profile=2
2625 1.1.1.10 christos
2626 1.1.1.10 christos # Multi-AP client disallow
2627 1.1.1.10 christos # Used to disallow profile specific backhaul STA association
2628 1.1.1.10 christos # Bitmap of the disallowed Profile-X profiles
2629 1.1.1.10 christos # 1 = Profile-1 Backhaul STA association disallowed
2630 1.1.1.10 christos # 2 = Profile-2 Backhaul STA association disallowed
2631 1.1.1.10 christos #multi_ap_client_disallow=0
2632 1.1.1.10 christos
2633 1.1.1.10 christos # Multi-AP VLAN ID
2634 1.1.1.10 christos # A valid non-zero VLAN ID will be used to update Default IEEE 802.1Q Setting
2635 1.1.1.10 christos #multi_ap_vlanid=0
2636 1.1.1.10 christos
2637 1.1 christos # WPS UPnP interface
2638 1.1 christos # If set, support for external Registrars is enabled.
2639 1.1 christos #upnp_iface=br0
2640 1.1 christos
2641 1.1 christos # Friendly Name (required for UPnP)
2642 1.1 christos # Short description for end use. Should be less than 64 characters.
2643 1.1 christos #friendly_name=WPS Access Point
2644 1.1 christos
2645 1.1 christos # Manufacturer URL (optional for UPnP)
2646 1.1 christos #manufacturer_url=http://www.example.com/
2647 1.1 christos
2648 1.1 christos # Model Description (recommended for UPnP)
2649 1.1 christos # Long description for end user. Should be less than 128 characters.
2650 1.1 christos #model_description=Wireless Access Point
2651 1.1 christos
2652 1.1 christos # Model URL (optional for UPnP)
2653 1.1 christos #model_url=http://www.example.com/model/
2654 1.1 christos
2655 1.1 christos # Universal Product Code (optional for UPnP)
2656 1.1 christos # 12-digit, all-numeric code that identifies the consumer package.
2657 1.1 christos #upc=123456789012
2658 1.1 christos
2659 1.1.1.7 christos # WPS RF Bands (a = 5G, b = 2.4G, g = 2.4G, ag = dual band, ad = 60 GHz)
2660 1.1.1.4 christos # This value should be set according to RF band(s) supported by the AP if
2661 1.1.1.4 christos # hw_mode is not set. For dual band dual concurrent devices, this needs to be
2662 1.1.1.4 christos # set to ag to allow both RF bands to be advertized.
2663 1.1.1.4 christos #wps_rf_bands=ag
2664 1.1.1.4 christos
2665 1.1.1.4 christos # NFC password token for WPS
2666 1.1.1.4 christos # These parameters can be used to configure a fixed NFC password token for the
2667 1.1.1.4 christos # AP. This can be generated, e.g., with nfc_pw_token from wpa_supplicant. When
2668 1.1.1.4 christos # these parameters are used, the AP is assumed to be deployed with a NFC tag
2669 1.1.1.4 christos # that includes the matching NFC password token (e.g., written based on the
2670 1.1.1.4 christos # NDEF record from nfc_pw_token).
2671 1.1.1.4 christos #
2672 1.1.1.4 christos #wps_nfc_dev_pw_id: Device Password ID (16..65535)
2673 1.1.1.4 christos #wps_nfc_dh_pubkey: Hexdump of DH Public Key
2674 1.1.1.4 christos #wps_nfc_dh_privkey: Hexdump of DH Private Key
2675 1.1.1.4 christos #wps_nfc_dev_pw: Hexdump of Device Password
2676 1.1.1.4 christos
2677 1.1.1.10 christos # Application Extension attribute for Beacon and Probe Response frames
2678 1.1.1.10 christos # This parameter can be used to add application extension into WPS IE. The
2679 1.1.1.10 christos # contents of this parameter starts with 16-octet (32 hexdump characters) of
2680 1.1.1.10 christos # UUID to identify the specific application and that is followed by the actual
2681 1.1.1.10 christos # application specific data.
2682 1.1.1.10 christos #wps_application_ext=<hexdump>
2683 1.1.1.10 christos
2684 1.1.1.3 christos ##### Wi-Fi Direct (P2P) ######################################################
2685 1.1.1.3 christos
2686 1.1.1.3 christos # Enable P2P Device management
2687 1.1.1.3 christos #manage_p2p=1
2688 1.1.1.3 christos
2689 1.1.1.3 christos # Allow cross connection
2690 1.1.1.3 christos #allow_cross_connection=1
2691 1.1.1.3 christos
2692 1.1.1.10 christos ##### Device Provisioning Protocol (DPP) ######################################
2693 1.1.1.10 christos
2694 1.1.1.10 christos # Name for Enrollee's DPP Configuration Request
2695 1.1.1.10 christos #dpp_name=Test
2696 1.1.1.10 christos
2697 1.1.1.10 christos # MUD URL for Enrollee's DPP Configuration Request (optional)
2698 1.1.1.10 christos #dpp_mud_url=https://example.com/mud
2699 1.1.1.10 christos
2700 1.1.1.10 christos # JSON node name of additional data for Enrollee's DPP Configuration Request
2701 1.1.1.10 christos #dpp_extra_conf_req_name=org.example
2702 1.1.1.10 christos
2703 1.1.1.10 christos # JSON node data of additional data for Enrollee's DPP Configuration Request
2704 1.1.1.10 christos #dpp_extra_conf_req_value="abc":123
2705 1.1.1.10 christos
2706 1.1.1.10 christos #dpp_connector
2707 1.1.1.10 christos #dpp_netaccesskey
2708 1.1.1.10 christos #dpp_netaccesskey_expiry
2709 1.1.1.10 christos #dpp_csign
2710 1.1.1.10 christos #dpp_controller
2711 1.1.1.10 christos
2712 1.1.1.10 christos # DPP Relay port number
2713 1.1.1.10 christos # TCP port to listen to for incoming connections from a Controller. This can be
2714 1.1.1.10 christos # used to allow Controller initiated exchanges in addition to the
2715 1.1.1.10 christos # Controller-as-responder cases covered by the dpp_controller parameter.
2716 1.1.1.10 christos #dpp_relay_port=12345
2717 1.1.1.10 christos
2718 1.1.1.10 christos # Configurator Connectivity indication
2719 1.1.1.10 christos # 0: no Configurator is currently connected (default)
2720 1.1.1.10 christos # 1: advertise that a Configurator is available
2721 1.1.1.10 christos #dpp_configurator_connectivity=0
2722 1.1.1.10 christos
2723 1.1.1.10 christos # DPP PFS
2724 1.1.1.10 christos # 0: allow PFS to be used or not used (default)
2725 1.1.1.10 christos # 1: require PFS to be used (note: not compatible with DPP R1)
2726 1.1.1.10 christos # 2: do not allow PFS to be used
2727 1.1.1.10 christos #dpp_pfs=0
2728 1.1.1.10 christos
2729 1.1.1.3 christos #### TDLS (IEEE 802.11z-2010) #################################################
2730 1.1.1.3 christos
2731 1.1.1.3 christos # Prohibit use of TDLS in this BSS
2732 1.1.1.3 christos #tdls_prohibit=1
2733 1.1.1.3 christos
2734 1.1.1.3 christos # Prohibit use of TDLS Channel Switching in this BSS
2735 1.1.1.3 christos #tdls_prohibit_chan_switch=1
2736 1.1.1.3 christos
2737 1.1.1.3 christos ##### IEEE 802.11v-2011 #######################################################
2738 1.1.1.3 christos
2739 1.1.1.3 christos # Time advertisement
2740 1.1.1.3 christos # 0 = disabled (default)
2741 1.1.1.3 christos # 2 = UTC time at which the TSF timer is 0
2742 1.1.1.3 christos #time_advertisement=2
2743 1.1.1.3 christos
2744 1.1.1.3 christos # Local time zone as specified in 8.3 of IEEE Std 1003.1-2004:
2745 1.1.1.3 christos # stdoffset[dst[offset][,start[/time],end[/time]]]
2746 1.1.1.3 christos #time_zone=EST5
2747 1.1.1.3 christos
2748 1.1.1.4 christos # WNM-Sleep Mode (extended sleep mode for stations)
2749 1.1.1.4 christos # 0 = disabled (default)
2750 1.1.1.4 christos # 1 = enabled (allow stations to use WNM-Sleep Mode)
2751 1.1.1.4 christos #wnm_sleep_mode=1
2752 1.1.1.4 christos
2753 1.1.1.8 christos # WNM-Sleep Mode GTK/IGTK workaround
2754 1.1.1.8 christos # Normally, WNM-Sleep Mode exit with management frame protection negotiated
2755 1.1.1.8 christos # would result in the current GTK/IGTK getting added into the WNM-Sleep Mode
2756 1.1.1.8 christos # Response frame. Some station implementations may have a vulnerability that
2757 1.1.1.8 christos # results in GTK/IGTK reinstallation based on this frame being replayed. This
2758 1.1.1.8 christos # configuration parameter can be used to disable that behavior and use EAPOL-Key
2759 1.1.1.8 christos # frames for GTK/IGTK update instead. This would likely be only used with
2760 1.1.1.8 christos # wpa_disable_eapol_key_retries=1 that enables a workaround for similar issues
2761 1.1.1.8 christos # with EAPOL-Key. This is related to station side vulnerabilities CVE-2017-13087
2762 1.1.1.8 christos # and CVE-2017-13088. To enable this AP-side workaround, set the parameter to 1.
2763 1.1.1.8 christos #wnm_sleep_mode_no_keys=0
2764 1.1.1.8 christos
2765 1.1.1.4 christos # BSS Transition Management
2766 1.1.1.4 christos # 0 = disabled (default)
2767 1.1.1.4 christos # 1 = enabled
2768 1.1.1.4 christos #bss_transition=1
2769 1.1.1.4 christos
2770 1.1.1.6 christos # Proxy ARP
2771 1.1.1.6 christos # 0 = disabled (default)
2772 1.1.1.6 christos # 1 = enabled
2773 1.1.1.6 christos #proxy_arp=1
2774 1.1.1.6 christos
2775 1.1.1.7 christos # IPv6 Neighbor Advertisement multicast-to-unicast conversion
2776 1.1.1.7 christos # This can be used with Proxy ARP to allow multicast NAs to be forwarded to
2777 1.1.1.7 christos # associated STAs using link layer unicast delivery.
2778 1.1.1.7 christos # 0 = disabled (default)
2779 1.1.1.7 christos # 1 = enabled
2780 1.1.1.7 christos #na_mcast_to_ucast=0
2781 1.1.1.7 christos
2782 1.1.1.3 christos ##### IEEE 802.11u-2011 #######################################################
2783 1.1.1.3 christos
2784 1.1.1.3 christos # Enable Interworking service
2785 1.1.1.3 christos #interworking=1
2786 1.1.1.3 christos
2787 1.1.1.3 christos # Access Network Type
2788 1.1.1.3 christos # 0 = Private network
2789 1.1.1.3 christos # 1 = Private network with guest access
2790 1.1.1.3 christos # 2 = Chargeable public network
2791 1.1.1.3 christos # 3 = Free public network
2792 1.1.1.3 christos # 4 = Personal device network
2793 1.1.1.3 christos # 5 = Emergency services only network
2794 1.1.1.3 christos # 14 = Test or experimental
2795 1.1.1.3 christos # 15 = Wildcard
2796 1.1.1.3 christos #access_network_type=0
2797 1.1.1.3 christos
2798 1.1.1.3 christos # Whether the network provides connectivity to the Internet
2799 1.1.1.3 christos # 0 = Unspecified
2800 1.1.1.3 christos # 1 = Network provides connectivity to the Internet
2801 1.1.1.3 christos #internet=1
2802 1.1.1.3 christos
2803 1.1.1.3 christos # Additional Step Required for Access
2804 1.1.1.3 christos # Note: This is only used with open network, i.e., ASRA shall ne set to 0 if
2805 1.1.1.3 christos # RSN is used.
2806 1.1.1.3 christos #asra=0
2807 1.1.1.3 christos
2808 1.1.1.3 christos # Emergency services reachable
2809 1.1.1.3 christos #esr=0
2810 1.1.1.3 christos
2811 1.1.1.3 christos # Unauthenticated emergency service accessible
2812 1.1.1.3 christos #uesa=0
2813 1.1.1.3 christos
2814 1.1.1.3 christos # Venue Info (optional)
2815 1.1.1.3 christos # The available values are defined in IEEE Std 802.11u-2011, 7.3.1.34.
2816 1.1.1.3 christos # Example values (group,type):
2817 1.1.1.3 christos # 0,0 = Unspecified
2818 1.1.1.3 christos # 1,7 = Convention Center
2819 1.1.1.3 christos # 1,13 = Coffee Shop
2820 1.1.1.3 christos # 2,0 = Unspecified Business
2821 1.1.1.3 christos # 7,1 Private Residence
2822 1.1.1.3 christos #venue_group=7
2823 1.1.1.3 christos #venue_type=1
2824 1.1.1.3 christos
2825 1.1.1.3 christos # Homogeneous ESS identifier (optional; dot11HESSID)
2826 1.1.1.3 christos # If set, this shall be identifical to one of the BSSIDs in the homogeneous
2827 1.1.1.3 christos # ESS and this shall be set to the same value across all BSSs in homogeneous
2828 1.1.1.3 christos # ESS.
2829 1.1.1.3 christos #hessid=02:03:04:05:06:07
2830 1.1.1.3 christos
2831 1.1.1.3 christos # Roaming Consortium List
2832 1.1.1.3 christos # Arbitrary number of Roaming Consortium OIs can be configured with each line
2833 1.1.1.3 christos # adding a new OI to the list. The first three entries are available through
2834 1.1.1.3 christos # Beacon and Probe Response frames. Any additional entry will be available only
2835 1.1.1.4 christos # through ANQP queries. Each OI is between 3 and 15 octets and is configured as
2836 1.1.1.3 christos # a hexstring.
2837 1.1.1.3 christos #roaming_consortium=021122
2838 1.1.1.3 christos #roaming_consortium=2233445566
2839 1.1.1.3 christos
2840 1.1.1.4 christos # Venue Name information
2841 1.1.1.4 christos # This parameter can be used to configure one or more Venue Name Duples for
2842 1.1.1.4 christos # Venue Name ANQP information. Each entry has a two or three character language
2843 1.1.1.4 christos # code (ISO-639) separated by colon from the venue name string.
2844 1.1.1.4 christos # Note that venue_group and venue_type have to be set for Venue Name
2845 1.1.1.4 christos # information to be complete.
2846 1.1.1.4 christos #venue_name=eng:Example venue
2847 1.1.1.4 christos #venue_name=fin:Esimerkkipaikka
2848 1.1.1.5 christos # Alternative format for language:value strings:
2849 1.1.1.5 christos # (double quoted string, printf-escaped string)
2850 1.1.1.5 christos #venue_name=P"eng:Example\nvenue"
2851 1.1.1.4 christos
2852 1.1.1.8 christos # Venue URL information
2853 1.1.1.8 christos # This parameter can be used to configure one or more Venue URL Duples to
2854 1.1.1.8 christos # provide additional information corresponding to Venue Name information.
2855 1.1.1.8 christos # Each entry has a Venue Number value separated by colon from the Venue URL
2856 1.1.1.8 christos # string. Venue Number indicates the corresponding venue_name entry (1 = 1st
2857 1.1.1.8 christos # venue_name, 2 = 2nd venue_name, and so on; 0 = no matching venue_name)
2858 1.1.1.8 christos #venue_url=1:http://www.example.com/info-eng
2859 1.1.1.8 christos #venue_url=2:http://www.example.com/info-fin
2860 1.1.1.8 christos
2861 1.1.1.4 christos # Network Authentication Type
2862 1.1.1.4 christos # This parameter indicates what type of network authentication is used in the
2863 1.1.1.4 christos # network.
2864 1.1.1.4 christos # format: <network auth type indicator (1-octet hex str)> [redirect URL]
2865 1.1.1.4 christos # Network Authentication Type Indicator values:
2866 1.1.1.4 christos # 00 = Acceptance of terms and conditions
2867 1.1.1.4 christos # 01 = On-line enrollment supported
2868 1.1.1.4 christos # 02 = http/https redirection
2869 1.1.1.4 christos # 03 = DNS redirection
2870 1.1.1.4 christos #network_auth_type=00
2871 1.1.1.4 christos #network_auth_type=02http://www.example.com/redirect/me/here/
2872 1.1.1.4 christos
2873 1.1.1.4 christos # IP Address Type Availability
2874 1.1.1.4 christos # format: <1-octet encoded value as hex str>
2875 1.1.1.4 christos # (ipv4_type & 0x3f) << 2 | (ipv6_type & 0x3)
2876 1.1.1.4 christos # ipv4_type:
2877 1.1.1.4 christos # 0 = Address type not available
2878 1.1.1.4 christos # 1 = Public IPv4 address available
2879 1.1.1.4 christos # 2 = Port-restricted IPv4 address available
2880 1.1.1.4 christos # 3 = Single NATed private IPv4 address available
2881 1.1.1.4 christos # 4 = Double NATed private IPv4 address available
2882 1.1.1.4 christos # 5 = Port-restricted IPv4 address and single NATed IPv4 address available
2883 1.1.1.4 christos # 6 = Port-restricted IPv4 address and double NATed IPv4 address available
2884 1.1.1.4 christos # 7 = Availability of the address type is not known
2885 1.1.1.4 christos # ipv6_type:
2886 1.1.1.4 christos # 0 = Address type not available
2887 1.1.1.4 christos # 1 = Address type available
2888 1.1.1.4 christos # 2 = Availability of the address type not known
2889 1.1.1.4 christos #ipaddr_type_availability=14
2890 1.1.1.4 christos
2891 1.1.1.4 christos # Domain Name
2892 1.1.1.4 christos # format: <variable-octet str>[,<variable-octet str>]
2893 1.1.1.4 christos #domain_name=example.com,another.example.com,yet-another.example.com
2894 1.1.1.4 christos
2895 1.1.1.4 christos # 3GPP Cellular Network information
2896 1.1.1.4 christos # format: <MCC1,MNC1>[;<MCC2,MNC2>][;...]
2897 1.1.1.4 christos #anqp_3gpp_cell_net=244,91;310,026;234,56
2898 1.1.1.4 christos
2899 1.1.1.4 christos # NAI Realm information
2900 1.1.1.4 christos # One or more realm can be advertised. Each nai_realm line adds a new realm to
2901 1.1.1.4 christos # the set. These parameters provide information for stations using Interworking
2902 1.1.1.4 christos # network selection to allow automatic connection to a network based on
2903 1.1.1.4 christos # credentials.
2904 1.1.1.4 christos # format: <encoding>,<NAI Realm(s)>[,<EAP Method 1>][,<EAP Method 2>][,...]
2905 1.1.1.4 christos # encoding:
2906 1.1.1.4 christos # 0 = Realm formatted in accordance with IETF RFC 4282
2907 1.1.1.4 christos # 1 = UTF-8 formatted character string that is not formatted in
2908 1.1.1.4 christos # accordance with IETF RFC 4282
2909 1.1.1.4 christos # NAI Realm(s): Semi-colon delimited NAI Realm(s)
2910 1.1.1.4 christos # EAP Method: <EAP Method>[:<[AuthParam1:Val1]>][<[AuthParam2:Val2]>][...]
2911 1.1.1.5 christos # EAP Method types, see:
2912 1.1.1.5 christos # http://www.iana.org/assignments/eap-numbers/eap-numbers.xhtml#eap-numbers-4
2913 1.1.1.4 christos # AuthParam (Table 8-188 in IEEE Std 802.11-2012):
2914 1.1.1.4 christos # ID 2 = Non-EAP Inner Authentication Type
2915 1.1.1.4 christos # 1 = PAP, 2 = CHAP, 3 = MSCHAP, 4 = MSCHAPV2
2916 1.1.1.4 christos # ID 3 = Inner authentication EAP Method Type
2917 1.1.1.4 christos # ID 5 = Credential Type
2918 1.1.1.4 christos # 1 = SIM, 2 = USIM, 3 = NFC Secure Element, 4 = Hardware Token,
2919 1.1.1.4 christos # 5 = Softoken, 6 = Certificate, 7 = username/password, 9 = Anonymous,
2920 1.1.1.4 christos # 10 = Vendor Specific
2921 1.1.1.4 christos #nai_realm=0,example.com;example.net
2922 1.1.1.4 christos # EAP methods EAP-TLS with certificate and EAP-TTLS/MSCHAPv2 with
2923 1.1.1.4 christos # username/password
2924 1.1.1.4 christos #nai_realm=0,example.org,13[5:6],21[2:4][5:7]
2925 1.1.1.4 christos
2926 1.1.1.7 christos # Arbitrary ANQP-element configuration
2927 1.1.1.7 christos # Additional ANQP-elements with arbitrary values can be defined by specifying
2928 1.1.1.7 christos # their contents in raw format as a hexdump of the payload. Note that these
2929 1.1.1.7 christos # values will override ANQP-element contents that may have been specified in the
2930 1.1.1.7 christos # more higher layer configuration parameters listed above.
2931 1.1.1.7 christos # format: anqp_elem=<InfoID>:<hexdump of payload>
2932 1.1.1.7 christos # For example, AP Geospatial Location ANQP-element with unknown location:
2933 1.1.1.7 christos #anqp_elem=265:0000
2934 1.1.1.7 christos # For example, AP Civic Location ANQP-element with unknown location:
2935 1.1.1.7 christos #anqp_elem=266:000000
2936 1.1.1.7 christos
2937 1.1.1.7 christos # GAS Address 3 behavior
2938 1.1.1.7 christos # 0 = P2P specification (Address3 = AP BSSID) workaround enabled by default
2939 1.1.1.7 christos # based on GAS request Address3
2940 1.1.1.7 christos # 1 = IEEE 802.11 standard compliant regardless of GAS request Address3
2941 1.1.1.7 christos # 2 = Force non-compliant behavior (Address3 = AP BSSID for all cases)
2942 1.1.1.7 christos #gas_address3=0
2943 1.1.1.7 christos
2944 1.1.1.5 christos # QoS Map Set configuration
2945 1.1.1.5 christos #
2946 1.1.1.5 christos # Comma delimited QoS Map Set in decimal values
2947 1.1.1.5 christos # (see IEEE Std 802.11-2012, 8.4.2.97)
2948 1.1.1.5 christos #
2949 1.1.1.5 christos # format:
2950 1.1.1.5 christos # [<DSCP Exceptions[DSCP,UP]>,]<UP 0 range[low,high]>,...<UP 7 range[low,high]>
2951 1.1.1.5 christos #
2952 1.1.1.5 christos # There can be up to 21 optional DSCP Exceptions which are pairs of DSCP Value
2953 1.1.1.5 christos # (0..63 or 255) and User Priority (0..7). This is followed by eight DSCP Range
2954 1.1.1.5 christos # descriptions with DSCP Low Value and DSCP High Value pairs (0..63 or 255) for
2955 1.1.1.5 christos # each UP starting from 0. If both low and high value are set to 255, the
2956 1.1.1.5 christos # corresponding UP is not used.
2957 1.1.1.5 christos #
2958 1.1.1.5 christos # default: not set
2959 1.1.1.5 christos #qos_map_set=53,2,22,6,8,15,0,7,255,255,16,31,32,39,255,255,40,47,255,255
2960 1.1.1.5 christos
2961 1.1.1.4 christos ##### Hotspot 2.0 #############################################################
2962 1.1.1.4 christos
2963 1.1.1.4 christos # Enable Hotspot 2.0 support
2964 1.1.1.4 christos #hs20=1
2965 1.1.1.4 christos
2966 1.1.1.4 christos # Disable Downstream Group-Addressed Forwarding (DGAF)
2967 1.1.1.4 christos # This can be used to configure a network where no group-addressed frames are
2968 1.1.1.4 christos # allowed. The AP will not forward any group-address frames to the stations and
2969 1.1.1.4 christos # random GTKs are issued for each station to prevent associated stations from
2970 1.1.1.4 christos # forging such frames to other stations in the BSS.
2971 1.1.1.4 christos #disable_dgaf=1
2972 1.1.1.4 christos
2973 1.1.1.5 christos # OSU Server-Only Authenticated L2 Encryption Network
2974 1.1.1.5 christos #osen=1
2975 1.1.1.5 christos
2976 1.1.1.5 christos # ANQP Domain ID (0..65535)
2977 1.1.1.5 christos # An identifier for a set of APs in an ESS that share the same common ANQP
2978 1.1.1.5 christos # information. 0 = Some of the ANQP information is unique to this AP (default).
2979 1.1.1.5 christos #anqp_domain_id=1234
2980 1.1.1.5 christos
2981 1.1.1.5 christos # Deauthentication request timeout
2982 1.1.1.5 christos # If the RADIUS server indicates that the station is not allowed to connect to
2983 1.1.1.5 christos # the BSS/ESS, the AP can allow the station some time to download a
2984 1.1.1.5 christos # notification page (URL included in the message). This parameter sets that
2985 1.1.1.10 christos # timeout in seconds. If the RADIUS server provides no URL, this value is
2986 1.1.1.10 christos # reduced to two seconds with an additional trigger for immediate
2987 1.1.1.10 christos # deauthentication when the STA acknowledges reception of the deauthentication
2988 1.1.1.10 christos # imminent indication. Note that setting this value to 0 will prevent delivery
2989 1.1.1.10 christos # of the notification to the STA, so a value of at least 1 should be used here
2990 1.1.1.10 christos # for normal use cases.
2991 1.1.1.5 christos #hs20_deauth_req_timeout=60
2992 1.1.1.5 christos
2993 1.1.1.4 christos # Operator Friendly Name
2994 1.1.1.4 christos # This parameter can be used to configure one or more Operator Friendly Name
2995 1.1.1.4 christos # Duples. Each entry has a two or three character language code (ISO-639)
2996 1.1.1.4 christos # separated by colon from the operator friendly name string.
2997 1.1.1.4 christos #hs20_oper_friendly_name=eng:Example operator
2998 1.1.1.4 christos #hs20_oper_friendly_name=fin:Esimerkkioperaattori
2999 1.1.1.4 christos
3000 1.1.1.4 christos # Connection Capability
3001 1.1.1.4 christos # This can be used to advertise what type of IP traffic can be sent through the
3002 1.1.1.4 christos # hotspot (e.g., due to firewall allowing/blocking protocols/ports).
3003 1.1.1.4 christos # format: <IP Protocol>:<Port Number>:<Status>
3004 1.1.1.4 christos # IP Protocol: 1 = ICMP, 6 = TCP, 17 = UDP
3005 1.1.1.4 christos # Port Number: 0..65535
3006 1.1.1.4 christos # Status: 0 = Closed, 1 = Open, 2 = Unknown
3007 1.1.1.4 christos # Each hs20_conn_capab line is added to the list of advertised tuples.
3008 1.1.1.4 christos #hs20_conn_capab=1:0:2
3009 1.1.1.4 christos #hs20_conn_capab=6:22:1
3010 1.1.1.4 christos #hs20_conn_capab=17:5060:0
3011 1.1.1.4 christos
3012 1.1.1.4 christos # WAN Metrics
3013 1.1.1.4 christos # format: <WAN Info>:<DL Speed>:<UL Speed>:<DL Load>:<UL Load>:<LMD>
3014 1.1.1.4 christos # WAN Info: B0-B1: Link Status, B2: Symmetric Link, B3: At Capabity
3015 1.1.1.4 christos # (encoded as two hex digits)
3016 1.1.1.4 christos # Link Status: 1 = Link up, 2 = Link down, 3 = Link in test state
3017 1.1.1.4 christos # Downlink Speed: Estimate of WAN backhaul link current downlink speed in kbps;
3018 1.1.1.4 christos # 1..4294967295; 0 = unknown
3019 1.1.1.4 christos # Uplink Speed: Estimate of WAN backhaul link current uplink speed in kbps
3020 1.1.1.4 christos # 1..4294967295; 0 = unknown
3021 1.1.1.4 christos # Downlink Load: Current load of downlink WAN connection (scaled to 255 = 100%)
3022 1.1.1.4 christos # Uplink Load: Current load of uplink WAN connection (scaled to 255 = 100%)
3023 1.1.1.4 christos # Load Measurement Duration: Duration for measuring downlink/uplink load in
3024 1.1.1.4 christos # tenths of a second (1..65535); 0 if load cannot be determined
3025 1.1.1.4 christos #hs20_wan_metrics=01:8000:1000:80:240:3000
3026 1.1.1.4 christos
3027 1.1.1.4 christos # Operating Class Indication
3028 1.1.1.4 christos # List of operating classes the BSSes in this ESS use. The Global operating
3029 1.1.1.4 christos # classes in Table E-4 of IEEE Std 802.11-2012 Annex E define the values that
3030 1.1.1.4 christos # can be used in this.
3031 1.1.1.4 christos # format: hexdump of operating class octets
3032 1.1.1.4 christos # for example, operating classes 81 (2.4 GHz channels 1-13) and 115 (5 GHz
3033 1.1.1.4 christos # channels 36-48):
3034 1.1.1.4 christos #hs20_operating_class=5173
3035 1.1.1.4 christos
3036 1.1.1.8 christos # Terms and Conditions information
3037 1.1.1.8 christos #
3038 1.1.1.8 christos # hs20_t_c_filename contains the Terms and Conditions filename that the AP
3039 1.1.1.8 christos # indicates in RADIUS Access-Request messages.
3040 1.1.1.8 christos #hs20_t_c_filename=terms-and-conditions
3041 1.1.1.8 christos #
3042 1.1.1.8 christos # hs20_t_c_timestamp contains the Terms and Conditions timestamp that the AP
3043 1.1.1.8 christos # indicates in RADIUS Access-Request messages. Usually, this contains the number
3044 1.1.1.8 christos # of seconds since January 1, 1970 00:00 UTC showing the time when the file was
3045 1.1.1.8 christos # last modified.
3046 1.1.1.8 christos #hs20_t_c_timestamp=1234567
3047 1.1.1.8 christos #
3048 1.1.1.8 christos # hs20_t_c_server_url contains a template for the Terms and Conditions server
3049 1.1.1.8 christos # URL. This template is used to generate the URL for a STA that needs to
3050 1.1.1.8 christos # acknowledge Terms and Conditions. Unlike the other hs20_t_c_* parameters, this
3051 1.1.1.8 christos # parameter is used on the authentication server, not the AP.
3052 1.1.1.8 christos # Macros:
3053 1.1.1.8 christos # @1@ = MAC address of the STA (colon separated hex octets)
3054 1.1.1.8 christos #hs20_t_c_server_url=https://example.com/t_and_c?addr=@1@&ap=123
3055 1.1.1.8 christos
3056 1.1.1.8 christos # OSU and Operator icons
3057 1.1.1.5 christos # <Icon Width>:<Icon Height>:<Language code>:<Icon Type>:<Name>:<file path>
3058 1.1.1.5 christos #hs20_icon=32:32:eng:image/png:icon32:/tmp/icon32.png
3059 1.1.1.5 christos #hs20_icon=64:64:eng:image/png:icon64:/tmp/icon64.png
3060 1.1.1.5 christos
3061 1.1.1.5 christos # OSU SSID (see ssid2 for format description)
3062 1.1.1.5 christos # This is the SSID used for all OSU connections to all the listed OSU Providers.
3063 1.1.1.5 christos #osu_ssid="example"
3064 1.1.1.5 christos
3065 1.1.1.5 christos # OSU Providers
3066 1.1.1.5 christos # One or more sets of following parameter. Each OSU provider is started by the
3067 1.1.1.5 christos # mandatory osu_server_uri item. The other parameters add information for the
3068 1.1.1.8 christos # last added OSU provider. osu_nai specifies the OSU_NAI value for OSEN
3069 1.1.1.8 christos # authentication when using a standalone OSU BSS. osu_nai2 specifies the OSU_NAI
3070 1.1.1.8 christos # value for OSEN authentication when using a shared BSS (Single SSID) for OSU.
3071 1.1.1.5 christos #
3072 1.1.1.5 christos #osu_server_uri=https://example.com/osu/
3073 1.1.1.5 christos #osu_friendly_name=eng:Example operator
3074 1.1.1.5 christos #osu_friendly_name=fin:Esimerkkipalveluntarjoaja
3075 1.1.1.5 christos #osu_nai=anonymous (at] example.com
3076 1.1.1.8 christos #osu_nai2=anonymous (at] example.com
3077 1.1.1.5 christos #osu_method_list=1 0
3078 1.1.1.5 christos #osu_icon=icon32
3079 1.1.1.5 christos #osu_icon=icon64
3080 1.1.1.5 christos #osu_service_desc=eng:Example services
3081 1.1.1.5 christos #osu_service_desc=fin:Esimerkkipalveluja
3082 1.1.1.5 christos #
3083 1.1.1.5 christos #osu_server_uri=...
3084 1.1.1.5 christos
3085 1.1.1.8 christos # Operator Icons
3086 1.1.1.8 christos # Operator icons are specified using references to the hs20_icon entries
3087 1.1.1.8 christos # (Name subfield). This information, if present, is advertsised in the
3088 1.1.1.8 christos # Operator Icon Metadata ANQO-element.
3089 1.1.1.8 christos #operator_icon=icon32
3090 1.1.1.8 christos #operator_icon=icon64
3091 1.1.1.8 christos
3092 1.1.1.8 christos ##### Multiband Operation (MBO) ###############################################
3093 1.1.1.8 christos #
3094 1.1.1.8 christos # MBO enabled
3095 1.1.1.8 christos # 0 = disabled (default)
3096 1.1.1.8 christos # 1 = enabled
3097 1.1.1.8 christos #mbo=1
3098 1.1.1.8 christos #
3099 1.1.1.8 christos # Cellular data connection preference
3100 1.1.1.8 christos # 0 = Excluded - AP does not want STA to use the cellular data connection
3101 1.1.1.8 christos # 1 = AP prefers the STA not to use cellular data connection
3102 1.1.1.8 christos # 255 = AP prefers the STA to use cellular data connection
3103 1.1.1.8 christos #mbo_cell_data_conn_pref=1
3104 1.1.1.8 christos
3105 1.1.1.8 christos ##### Optimized Connectivity Experience (OCE) #################################
3106 1.1.1.8 christos #
3107 1.1.1.8 christos # Enable OCE specific features (bitmap)
3108 1.1.1.8 christos # BIT(0) - Reserved
3109 1.1.1.8 christos # Set BIT(1) (= 2) to enable OCE in STA-CFON mode
3110 1.1.1.8 christos # Set BIT(2) (= 4) to enable OCE in AP mode
3111 1.1.1.8 christos # Default is 0 = OCE disabled
3112 1.1.1.8 christos #oce=0
3113 1.1.1.8 christos
3114 1.1.1.10 christos # RSSI-based association rejection
3115 1.1.1.9 christos #
3116 1.1.1.9 christos # Reject STA association if RSSI is below given threshold (in dBm)
3117 1.1.1.9 christos # Allowed range: -60 to -90 dBm; default = 0 (rejection disabled)
3118 1.1.1.9 christos # Note: This rejection happens based on a signal strength detected while
3119 1.1.1.9 christos # receiving a single frame and as such, there is significant risk of the value
3120 1.1.1.9 christos # not being accurate and this resulting in valid stations being rejected. As
3121 1.1.1.9 christos # such, this functionality is not recommended to be used for purposes other than
3122 1.1.1.9 christos # testing.
3123 1.1.1.9 christos #rssi_reject_assoc_rssi=-75
3124 1.1.1.9 christos #
3125 1.1.1.9 christos # Association retry delay in seconds allowed by the STA if RSSI has not met the
3126 1.1.1.9 christos # threshold (range: 0..255, default=30).
3127 1.1.1.9 christos #rssi_reject_assoc_timeout=30
3128 1.1.1.9 christos
3129 1.1.1.10 christos # Ignore Probe Request frames if RSSI is below given threshold (in dBm)
3130 1.1.1.10 christos # Allowed range: -60 to -90 dBm; default = 0 (rejection disabled)
3131 1.1.1.10 christos #rssi_ignore_probe_request=-75
3132 1.1.1.10 christos
3133 1.1.1.7 christos ##### Fast Session Transfer (FST) support #####################################
3134 1.1.1.7 christos #
3135 1.1.1.7 christos # The options in this section are only available when the build configuration
3136 1.1.1.7 christos # option CONFIG_FST is set while compiling hostapd. They allow this interface
3137 1.1.1.7 christos # to be a part of FST setup.
3138 1.1.1.7 christos #
3139 1.1.1.7 christos # FST is the transfer of a session from a channel to another channel, in the
3140 1.1.1.7 christos # same or different frequency bands.
3141 1.1.1.7 christos #
3142 1.1.1.7 christos # For detals, see IEEE Std 802.11ad-2012.
3143 1.1.1.7 christos
3144 1.1.1.7 christos # Identifier of an FST Group the interface belongs to.
3145 1.1.1.7 christos #fst_group_id=bond0
3146 1.1.1.7 christos
3147 1.1.1.7 christos # Interface priority within the FST Group.
3148 1.1.1.7 christos # Announcing a higher priority for an interface means declaring it more
3149 1.1.1.7 christos # preferable for FST switch.
3150 1.1.1.7 christos # fst_priority is in 1..255 range with 1 being the lowest priority.
3151 1.1.1.7 christos #fst_priority=100
3152 1.1.1.7 christos
3153 1.1.1.7 christos # Default LLT value for this interface in milliseconds. The value used in case
3154 1.1.1.7 christos # no value provided during session setup. Default is 50 ms.
3155 1.1.1.7 christos # fst_llt is in 1..4294967 range (due to spec limitation, see 10.32.2.2
3156 1.1.1.7 christos # Transitioning between states).
3157 1.1.1.7 christos #fst_llt=100
3158 1.1.1.7 christos
3159 1.1.1.7 christos ##### Radio measurements / location ###########################################
3160 1.1.1.7 christos
3161 1.1.1.7 christos # The content of a LCI measurement subelement
3162 1.1.1.7 christos #lci=<Hexdump of binary data of the LCI report>
3163 1.1.1.7 christos
3164 1.1.1.7 christos # The content of a location civic measurement subelement
3165 1.1.1.7 christos #civic=<Hexdump of binary data of the location civic report>
3166 1.1.1.7 christos
3167 1.1.1.7 christos # Enable neighbor report via radio measurements
3168 1.1.1.7 christos #rrm_neighbor_report=1
3169 1.1.1.7 christos
3170 1.1.1.10 christos # Enable link measurement report via radio measurements
3171 1.1.1.10 christos #rrm_link_measurement_report=1
3172 1.1.1.10 christos
3173 1.1.1.8 christos # Enable beacon report via radio measurements
3174 1.1.1.8 christos #rrm_beacon_report=1
3175 1.1.1.8 christos
3176 1.1.1.7 christos # Publish fine timing measurement (FTM) responder functionality
3177 1.1.1.7 christos # This parameter only controls publishing via Extended Capabilities element.
3178 1.1.1.7 christos # Actual functionality is managed outside hostapd.
3179 1.1.1.7 christos #ftm_responder=0
3180 1.1.1.7 christos
3181 1.1.1.7 christos # Publish fine timing measurement (FTM) initiator functionality
3182 1.1.1.7 christos # This parameter only controls publishing via Extended Capabilities element.
3183 1.1.1.7 christos # Actual functionality is managed outside hostapd.
3184 1.1.1.7 christos #ftm_initiator=0
3185 1.1.1.8 christos #
3186 1.1.1.8 christos # Stationary AP config indicates that the AP doesn't move hence location data
3187 1.1.1.8 christos # can be considered as always up to date. If configured, LCI data will be sent
3188 1.1.1.8 christos # as a radio measurement even if the request doesn't contain a max age element
3189 1.1.1.8 christos # that allows sending of such data. Default: 0.
3190 1.1.1.8 christos #stationary_ap=0
3191 1.1.1.7 christos
3192 1.1.1.10 christos # Enable reduced neighbor reporting (RNR)
3193 1.1.1.10 christos #rnr=0
3194 1.1.1.10 christos
3195 1.1.1.9 christos ##### Airtime policy configuration ###########################################
3196 1.1.1.9 christos
3197 1.1.1.9 christos # Set the airtime policy operating mode:
3198 1.1.1.9 christos # 0 = disabled (default)
3199 1.1.1.9 christos # 1 = static config
3200 1.1.1.9 christos # 2 = per-BSS dynamic config
3201 1.1.1.9 christos # 3 = per-BSS limit mode
3202 1.1.1.9 christos #airtime_mode=0
3203 1.1.1.9 christos
3204 1.1.1.9 christos # Interval (in milliseconds) to poll the kernel for updated station activity in
3205 1.1.1.9 christos # dynamic and limit modes
3206 1.1.1.9 christos #airtime_update_interval=200
3207 1.1.1.9 christos
3208 1.1.1.9 christos # Static configuration of station weights (when airtime_mode=1). Kernel default
3209 1.1.1.9 christos # weight is 256; set higher for larger airtime share, lower for smaller share.
3210 1.1.1.9 christos # Each entry is a MAC address followed by a weight.
3211 1.1.1.9 christos #airtime_sta_weight=02:01:02:03:04:05 256
3212 1.1.1.9 christos #airtime_sta_weight=02:01:02:03:04:06 512
3213 1.1.1.9 christos
3214 1.1.1.9 christos # Per-BSS airtime weight. In multi-BSS mode, set for each BSS and hostapd will
3215 1.1.1.9 christos # configure station weights to enforce the correct ratio between BSS weights
3216 1.1.1.9 christos # depending on the number of active stations. The *ratios* between different
3217 1.1.1.9 christos # BSSes is what's important, not the absolute numbers.
3218 1.1.1.9 christos # Must be set for all BSSes if airtime_mode=2 or 3, has no effect otherwise.
3219 1.1.1.9 christos #airtime_bss_weight=1
3220 1.1.1.9 christos
3221 1.1.1.9 christos # Whether the current BSS should be limited (when airtime_mode=3).
3222 1.1.1.9 christos #
3223 1.1.1.9 christos # If set, the BSS weight ratio will be applied in the case where the current BSS
3224 1.1.1.9 christos # would exceed the share defined by the BSS weight ratio. E.g., if two BSSes are
3225 1.1.1.9 christos # set to the same weights, and one is set to limited, the limited BSS will get
3226 1.1.1.9 christos # no more than half the available airtime, but if the non-limited BSS has more
3227 1.1.1.9 christos # stations active, that *will* be allowed to exceed its half of the available
3228 1.1.1.9 christos # airtime.
3229 1.1.1.9 christos #airtime_bss_limit=1
3230 1.1.1.9 christos
3231 1.1.1.10 christos ##### EDMG support ############################################################
3232 1.1.1.10 christos #
3233 1.1.1.10 christos # Enable EDMG capability for AP mode in the 60 GHz band. Default value is false.
3234 1.1.1.10 christos # To configure channel bonding for an EDMG AP use edmg_channel below.
3235 1.1.1.10 christos # If enable_edmg is set and edmg_channel is not set, EDMG CB1 will be
3236 1.1.1.10 christos # configured.
3237 1.1.1.10 christos #enable_edmg=1
3238 1.1.1.10 christos #
3239 1.1.1.10 christos # Configure channel bonding for AP mode in the 60 GHz band.
3240 1.1.1.10 christos # This parameter is relevant only if enable_edmg is set.
3241 1.1.1.10 christos # Default value is 0 (no channel bonding).
3242 1.1.1.10 christos #edmg_channel=9
3243 1.1.1.10 christos
3244 1.1.1.5 christos ##### TESTING OPTIONS #########################################################
3245 1.1.1.5 christos #
3246 1.1.1.5 christos # The options in this section are only available when the build configuration
3247 1.1.1.5 christos # option CONFIG_TESTING_OPTIONS is set while compiling hostapd. They allow
3248 1.1.1.5 christos # testing some scenarios that are otherwise difficult to reproduce.
3249 1.1.1.5 christos #
3250 1.1.1.5 christos # Ignore probe requests sent to hostapd with the given probability, must be a
3251 1.1.1.5 christos # floating point number in the range [0, 1).
3252 1.1.1.5 christos #ignore_probe_probability=0.0
3253 1.1.1.5 christos #
3254 1.1.1.5 christos # Ignore authentication frames with the given probability
3255 1.1.1.5 christos #ignore_auth_probability=0.0
3256 1.1.1.5 christos #
3257 1.1.1.5 christos # Ignore association requests with the given probability
3258 1.1.1.5 christos #ignore_assoc_probability=0.0
3259 1.1.1.5 christos #
3260 1.1.1.5 christos # Ignore reassociation requests with the given probability
3261 1.1.1.5 christos #ignore_reassoc_probability=0.0
3262 1.1.1.5 christos #
3263 1.1.1.5 christos # Corrupt Key MIC in GTK rekey EAPOL-Key frames with the given probability
3264 1.1.1.5 christos #corrupt_gtk_rekey_mic_probability=0.0
3265 1.1.1.7 christos #
3266 1.1.1.7 christos # Include only ECSA IE without CSA IE where possible
3267 1.1.1.7 christos # (channel switch operating class is needed)
3268 1.1.1.7 christos #ecsa_ie_only=0
3269 1.1.1.10 christos #
3270 1.1.1.10 christos # Delay EAPOL-Key messages 1/4 and 3/4 by not sending the frame until the last
3271 1.1.1.10 christos # attempt (wpa_pairwise_update_count). This will trigger a timeout on all
3272 1.1.1.10 christos # previous attempts and thus delays the frame. (testing only)
3273 1.1.1.10 christos #delay_eapol_tx=0
3274 1.1.1.10 christos #
3275 1.1.1.10 christos # Additional elements for Probe Response frames.
3276 1.1.1.10 christos # This parameter can be used to add additional element(s) to the end of the
3277 1.1.1.10 christos # Probe Response frames. The format for these element(s) is a hexdump of the
3278 1.1.1.10 christos # raw information elements (id+len+payload for one or more elements).
3279 1.1.1.10 christos # These elements are added after the 'vendor_elements'.
3280 1.1.1.10 christos #presp_elements=
3281 1.1.1.5 christos
3282 1.1 christos ##### Multiple BSSID support ##################################################
3283 1.1 christos #
3284 1.1 christos # Above configuration is using the default interface (wlan#, or multi-SSID VLAN
3285 1.1 christos # interfaces). Other BSSIDs can be added by using separator 'bss' with
3286 1.1 christos # default interface name to be allocated for the data packets of the new BSS.
3287 1.1 christos #
3288 1.1 christos # hostapd will generate BSSID mask based on the BSSIDs that are
3289 1.1 christos # configured. hostapd will verify that dev_addr & MASK == dev_addr. If this is
3290 1.1 christos # not the case, the MAC address of the radio must be changed before starting
3291 1.1 christos # hostapd (ifconfig wlan0 hw ether <MAC addr>). If a BSSID is configured for
3292 1.1 christos # every secondary BSS, this limitation is not applied at hostapd and other
3293 1.1 christos # masks may be used if the driver supports them (e.g., swap the locally
3294 1.1 christos # administered bit)
3295 1.1 christos #
3296 1.1 christos # BSSIDs are assigned in order to each BSS, unless an explicit BSSID is
3297 1.1 christos # specified using the 'bssid' parameter.
3298 1.1 christos # If an explicit BSSID is specified, it must be chosen such that it:
3299 1.1 christos # - results in a valid MASK that covers it and the dev_addr
3300 1.1 christos # - is not the same as the MAC address of the radio
3301 1.1 christos # - is not the same as any other explicitly specified BSSID
3302 1.1 christos #
3303 1.1.1.7 christos # Alternatively, the 'use_driver_iface_addr' parameter can be used to request
3304 1.1.1.7 christos # hostapd to use the driver auto-generated interface address (e.g., to use the
3305 1.1.1.7 christos # exact MAC addresses allocated to the device).
3306 1.1.1.7 christos #
3307 1.1.1.5 christos # Not all drivers support multiple BSSes. The exact mechanism for determining
3308 1.1.1.5 christos # the driver capabilities is driver specific. With the current (i.e., a recent
3309 1.1.1.5 christos # kernel) drivers using nl80211, this information can be checked with "iw list"
3310 1.1.1.5 christos # (search for "valid interface combinations").
3311 1.1.1.5 christos #
3312 1.1 christos # Please note that hostapd uses some of the values configured for the first BSS
3313 1.1 christos # as the defaults for the following BSSes. However, it is recommended that all
3314 1.1 christos # BSSes include explicit configuration of all relevant configuration items.
3315 1.1 christos #
3316 1.1 christos #bss=wlan0_0
3317 1.1 christos #ssid=test2
3318 1.1 christos # most of the above items can be used here (apart from radio interface specific
3319 1.1 christos # items, like channel)
3320 1.1 christos
3321 1.1 christos #bss=wlan0_1
3322 1.1 christos #bssid=00:13:10:95:fe:0b
3323 1.1 christos # ...
3324 1.1.1.10 christos #
3325 1.1.1.10 christos # Multiple BSSID Advertisement in IEEE 802.11ax
3326 1.1.1.10 christos # IEEE Std 802.11ax-2021 added a feature where instead of multiple interfaces
3327 1.1.1.10 christos # on a common radio transmitting individual Beacon frames, those interfaces can
3328 1.1.1.10 christos # form a set with a common Beacon frame transmitted for all. The interface
3329 1.1.1.10 christos # which is brought up first is called the transmitting profile of the MBSSID
3330 1.1.1.10 christos # set which transmits the Beacon frames. The remaining interfaces are called
3331 1.1.1.10 christos # the non-transmitting profiles and these are advertised inside the Multiple
3332 1.1.1.10 christos # BSSID element in the Beacon and Probe Response frames from the first
3333 1.1.1.10 christos # interface.
3334 1.1.1.10 christos #
3335 1.1.1.10 christos # The transmitting interface is visible to all stations in the vicinity, however
3336 1.1.1.10 christos # the stations that do not support parsing of the Multiple BSSID element will
3337 1.1.1.10 christos # not be able to connect to the non-transmitting interfaces.
3338 1.1.1.10 christos #
3339 1.1.1.10 christos # Enhanced Multiple BSSID Advertisements (EMA)
3340 1.1.1.10 christos # When enabled, the non-transmitting interfaces are split into multiple
3341 1.1.1.10 christos # Beacon frames. The number of Beacon frames required to cover all the
3342 1.1.1.10 christos # non-transmitting profiles is called the profile periodicity.
3343 1.1.1.10 christos #
3344 1.1.1.10 christos # Refer to IEEE Std 802.11-2020 for details regarding the procedure and
3345 1.1.1.10 christos # required MAC address assignment.
3346 1.1.1.10 christos #
3347 1.1.1.10 christos # Following configuration is per radio.
3348 1.1.1.10 christos # 0 = Disabled (default)
3349 1.1.1.10 christos # 1 = Multiple BSSID advertisement enabled.
3350 1.1.1.10 christos # 2 = Enhanced multiple BSSID advertisement enabled.
3351 1.1.1.10 christos #mbssid=0
3352 1.1.1.10 christos #
3353 1.1.1.10 christos # The transmitting interface should be added with the 'interface' option while
3354 1.1.1.10 christos # the non-transmitting interfaces should be added using the 'bss' option.
3355 1.1.1.10 christos # Security configuration should be added separately per interface, if required.
3356 1.1.1.10 christos #
3357 1.1.1.10 christos # Example:
3358 1.1.1.10 christos #mbssid=2
3359 1.1.1.10 christos #interface=wlan2
3360 1.1.1.10 christos #ctrl_interface=/var/run/hostapd
3361 1.1.1.10 christos #wpa_passphrase=0123456789
3362 1.1.1.10 christos #ieee80211w=2
3363 1.1.1.10 christos #sae_pwe=1
3364 1.1.1.10 christos #auth_algs=1
3365 1.1.1.10 christos #wpa=2
3366 1.1.1.10 christos #wpa_pairwise=CCMP
3367 1.1.1.10 christos #ssid=<SSID-0>
3368 1.1.1.10 christos #bridge=br-lan
3369 1.1.1.10 christos #wpa_key_mgmt=SAE
3370 1.1.1.10 christos #bssid=00:03:7f:12:84:84
3371 1.1.1.10 christos #
3372 1.1.1.10 christos #bss=wlan2-1
3373 1.1.1.10 christos #ctrl_interface=/var/run/hostapd
3374 1.1.1.10 christos #wpa_passphrase=0123456789
3375 1.1.1.10 christos #ieee80211w=2
3376 1.1.1.10 christos #sae_pwe=1
3377 1.1.1.10 christos #auth_algs=1
3378 1.1.1.10 christos #wpa=2
3379 1.1.1.10 christos #wpa_pairwise=CCMP
3380 1.1.1.10 christos #ssid=<SSID-1>
3381 1.1.1.10 christos #bridge=br-lan
3382 1.1.1.10 christos #wpa_key_mgmt=SAE
3383 1.1.1.10 christos #bssid=00:03:7f:12:84:85
3384