1214503Srpaulo##### hostapd configuration file ##############################################
2214503Srpaulo# Empty lines and lines starting with # are ignored
3214503Srpaulo
4214503Srpaulo# AP netdevice name (without 'ap' postfix, i.e., wlan0 uses wlan0ap for
5281806Srpaulo# management frames with the Host AP driver); wlan0 with many nl80211 drivers
6337817Scy# Note: This attribute can be overridden by the values supplied with the '-i'
7337817Scy# command line parameter.
8214503Srpaulointerface=wlan0
9214503Srpaulo
10281806Srpaulo# In case of atheros and nl80211 driver interfaces, an additional
11214503Srpaulo# configuration parameter, bridge, may be used to notify hostapd if the
12214503Srpaulo# interface is included in a bridge. This parameter is not used with Host AP
13214503Srpaulo# driver. If the bridge parameter is not set, the drivers will automatically
14214503Srpaulo# figure out the bridge interface (assuming sysfs is enabled and mounted to
15214503Srpaulo# /sys) and this parameter may not be needed.
16214503Srpaulo#
17214503Srpaulo# For nl80211, this parameter can be used to request the AP interface to be
18214503Srpaulo# added to the bridge automatically (brctl may refuse to do this before hostapd
19214503Srpaulo# has been started to change the interface mode). If needed, the bridge
20214503Srpaulo# interface is also created.
21214503Srpaulo#bridge=br0
22214503Srpaulo
23281806Srpaulo# Driver interface type (hostap/wired/none/nl80211/bsd);
24214503Srpaulo# default: hostap). nl80211 is used with all Linux mac80211 drivers.
25214503Srpaulo# Use driver=none if building hostapd as a standalone RADIUS server that does
26214503Srpaulo# not control any wireless/wired driver.
27214503Srpaulo# driver=hostap
28214503Srpaulo
29281806Srpaulo# Driver interface parameters (mainly for development testing use)
30281806Srpaulo# driver_params=<params>
31281806Srpaulo
32214503Srpaulo# hostapd event logger configuration
33214503Srpaulo#
34214503Srpaulo# Two output method: syslog and stdout (only usable if not forking to
35214503Srpaulo# background).
36214503Srpaulo#
37214503Srpaulo# Module bitfield (ORed bitfield of modules that will be logged; -1 = all
38214503Srpaulo# modules):
39214503Srpaulo# bit 0 (1) = IEEE 802.11
40214503Srpaulo# bit 1 (2) = IEEE 802.1X
41214503Srpaulo# bit 2 (4) = RADIUS
42214503Srpaulo# bit 3 (8) = WPA
43214503Srpaulo# bit 4 (16) = driver interface
44214503Srpaulo# bit 5 (32) = IAPP
45214503Srpaulo# bit 6 (64) = MLME
46214503Srpaulo#
47214503Srpaulo# Levels (minimum value for logged events):
48214503Srpaulo#  0 = verbose debugging
49214503Srpaulo#  1 = debugging
50214503Srpaulo#  2 = informational messages
51214503Srpaulo#  3 = notification
52214503Srpaulo#  4 = warning
53214503Srpaulo#
54214503Srpaulologger_syslog=-1
55214503Srpaulologger_syslog_level=2
56214503Srpaulologger_stdout=-1
57214503Srpaulologger_stdout_level=2
58214503Srpaulo
59214503Srpaulo# Interface for separate control program. If this is specified, hostapd
60214503Srpaulo# will create this directory and a UNIX domain socket for listening to requests
61214503Srpaulo# from external programs (CLI/GUI, etc.) for status information and
62214503Srpaulo# configuration. The socket file will be named based on the interface name, so
63214503Srpaulo# multiple hostapd processes/interfaces can be run at the same time if more
64214503Srpaulo# than one interface is used.
65214503Srpaulo# /var/run/hostapd is the recommended directory for sockets and by default,
66214503Srpaulo# hostapd_cli will use it when trying to connect with hostapd.
67214503Srpauloctrl_interface=/var/run/hostapd
68214503Srpaulo
69214503Srpaulo# Access control for the control interface can be configured by setting the
70214503Srpaulo# directory to allow only members of a group to use sockets. This way, it is
71214503Srpaulo# possible to run hostapd as root (since it needs to change network
72214503Srpaulo# configuration and open raw sockets) and still allow GUI/CLI components to be
73214503Srpaulo# run as non-root users. However, since the control interface can be used to
74214503Srpaulo# change the network configuration, this access needs to be protected in many
75214503Srpaulo# cases. By default, hostapd is configured to use gid 0 (root). If you
76214503Srpaulo# want to allow non-root users to use the contron interface, add a new group
77214503Srpaulo# and change this value to match with that group. Add users that should have
78214503Srpaulo# control interface access to this group.
79214503Srpaulo#
80214503Srpaulo# This variable can be a group name or gid.
81214503Srpaulo#ctrl_interface_group=wheel
82214503Srpauloctrl_interface_group=0
83214503Srpaulo
84214503Srpaulo
85214503Srpaulo##### IEEE 802.11 related configuration #######################################
86214503Srpaulo
87214503Srpaulo# SSID to be used in IEEE 802.11 management frames
88214503Srpaulossid=test
89252726Srpaulo# Alternative formats for configuring SSID
90252726Srpaulo# (double quoted string, hexdump, printf-escaped string)
91252726Srpaulo#ssid2="test"
92252726Srpaulo#ssid2=74657374
93252726Srpaulo#ssid2=P"hello\nthere"
94214503Srpaulo
95252726Srpaulo# UTF-8 SSID: Whether the SSID is to be interpreted using UTF-8 encoding
96252726Srpaulo#utf8_ssid=1
97252726Srpaulo
98214503Srpaulo# Country code (ISO/IEC 3166-1). Used to set regulatory domain.
99214503Srpaulo# Set as needed to indicate country in which device is operating.
100214503Srpaulo# This can limit available channels and transmit power.
101346981Scy# These two octets are used as the first two octets of the Country String
102346981Scy# (dot11CountryString)
103214503Srpaulo#country_code=US
104214503Srpaulo
105346981Scy# The third octet of the Country String (dot11CountryString)
106346981Scy# This parameter is used to set the third octet of the country string.
107346981Scy#
108346981Scy# All environments of the current frequency band and country (default)
109346981Scy#country3=0x20
110346981Scy# Outdoor environment only
111346981Scy#country3=0x4f
112346981Scy# Indoor environment only
113346981Scy#country3=0x49
114346981Scy# Noncountry entity (country_code=XX)
115346981Scy#country3=0x58
116346981Scy# IEEE 802.11 standard Annex E table indication: 0x01 .. 0x1f
117346981Scy# Annex E, Table E-4 (Global operating classes)
118346981Scy#country3=0x04
119346981Scy
120214503Srpaulo# Enable IEEE 802.11d. This advertises the country_code and the set of allowed
121214503Srpaulo# channels and transmit power levels based on the regulatory limits. The
122214503Srpaulo# country_code setting must be configured with the correct country for
123214503Srpaulo# IEEE 802.11d functions.
124214503Srpaulo# (default: 0 = disabled)
125214503Srpaulo#ieee80211d=1
126214503Srpaulo
127281806Srpaulo# Enable IEEE 802.11h. This enables radar detection and DFS support if
128281806Srpaulo# available. DFS support is required on outdoor 5 GHz channels in most countries
129281806Srpaulo# of the world. This can be used only with ieee80211d=1.
130281806Srpaulo# (default: 0 = disabled)
131281806Srpaulo#ieee80211h=1
132281806Srpaulo
133281806Srpaulo# Add Power Constraint element to Beacon and Probe Response frames
134281806Srpaulo# This config option adds Power Constraint element when applicable and Country
135281806Srpaulo# element is added. Power Constraint element is required by Transmit Power
136281806Srpaulo# Control. This can be used only with ieee80211d=1.
137281806Srpaulo# Valid values are 0..255.
138281806Srpaulo#local_pwr_constraint=3
139281806Srpaulo
140281806Srpaulo# Set Spectrum Management subfield in the Capability Information field.
141281806Srpaulo# This config option forces the Spectrum Management bit to be set. When this
142281806Srpaulo# option is not set, the value of the Spectrum Management bit depends on whether
143281806Srpaulo# DFS or TPC is required by regulatory authorities. This can be used only with
144281806Srpaulo# ieee80211d=1 and local_pwr_constraint configured.
145281806Srpaulo#spectrum_mgmt_required=1
146281806Srpaulo
147337817Scy# Operation mode (a = IEEE 802.11a (5 GHz), b = IEEE 802.11b (2.4 GHz),
148337817Scy# g = IEEE 802.11g (2.4 GHz), ad = IEEE 802.11ad (60 GHz); a/g options are used
149337817Scy# with IEEE 802.11n (HT), too, to specify band). For IEEE 802.11ac (VHT), this
150337817Scy# needs to be set to hw_mode=a. When using ACS (see channel parameter), a
151337817Scy# special value "any" can be used to indicate that any support band can be used.
152337817Scy# This special case is currently supported only with drivers with which
153337817Scy# offloaded ACS is used.
154214503Srpaulo# Default: IEEE 802.11b
155252726Srpaulohw_mode=g
156214503Srpaulo
157214503Srpaulo# Channel number (IEEE 802.11)
158214503Srpaulo# (default: 0, i.e., not set)
159252726Srpaulo# Please note that some drivers do not use this value from hostapd and the
160252726Srpaulo# channel will need to be configured separately with iwconfig.
161281806Srpaulo#
162281806Srpaulo# If CONFIG_ACS build option is enabled, the channel can be selected
163281806Srpaulo# automatically at run time by setting channel=acs_survey or channel=0, both of
164281806Srpaulo# which will enable the ACS survey based algorithm.
165252726Srpaulochannel=1
166214503Srpaulo
167281806Srpaulo# ACS tuning - Automatic Channel Selection
168281806Srpaulo# See: http://wireless.kernel.org/en/users/Documentation/acs
169281806Srpaulo#
170281806Srpaulo# You can customize the ACS survey algorithm with following variables:
171281806Srpaulo#
172281806Srpaulo# acs_num_scans requirement is 1..100 - number of scans to be performed that
173281806Srpaulo# are used to trigger survey data gathering of an underlying device driver.
174281806Srpaulo# Scans are passive and typically take a little over 100ms (depending on the
175281806Srpaulo# driver) on each available channel for given hw_mode. Increasing this value
176281806Srpaulo# means sacrificing startup time and gathering more data wrt channel
177281806Srpaulo# interference that may help choosing a better channel. This can also help fine
178281806Srpaulo# tune the ACS scan time in case a driver has different scan dwell times.
179281806Srpaulo#
180281806Srpaulo# acs_chan_bias is a space-separated list of <channel>:<bias> pairs. It can be
181281806Srpaulo# used to increase (or decrease) the likelihood of a specific channel to be
182281806Srpaulo# selected by the ACS algorithm. The total interference factor for each channel
183281806Srpaulo# gets multiplied by the specified bias value before finding the channel with
184281806Srpaulo# the lowest value. In other words, values between 0.0 and 1.0 can be used to
185281806Srpaulo# make a channel more likely to be picked while values larger than 1.0 make the
186281806Srpaulo# specified channel less likely to be picked. This can be used, e.g., to prefer
187281806Srpaulo# the commonly used 2.4 GHz band channels 1, 6, and 11 (which is the default
188281806Srpaulo# behavior on 2.4 GHz band if no acs_chan_bias parameter is specified).
189281806Srpaulo#
190281806Srpaulo# Defaults:
191281806Srpaulo#acs_num_scans=5
192281806Srpaulo#acs_chan_bias=1:0.8 6:0.8 11:0.8
193281806Srpaulo
194281806Srpaulo# Channel list restriction. This option allows hostapd to select one of the
195281806Srpaulo# provided channels when a channel should be automatically selected.
196289549Srpaulo# Channel list can be provided as range using hyphen ('-') or individual
197337817Scy# channels can be specified by space (' ') separated values
198289549Srpaulo# Default: all channels allowed in selected hw_mode
199281806Srpaulo#chanlist=100 104 108 112 116
200289549Srpaulo#chanlist=1 6 11-13
201281806Srpaulo
202346981Scy# Exclude DFS channels from ACS
203346981Scy# This option can be used to exclude all DFS channels from the ACS channel list
204346981Scy# in cases where the driver supports DFS channels.
205346981Scy#acs_exclude_dfs=1
206346981Scy
207214503Srpaulo# Beacon interval in kus (1.024 ms) (default: 100; range 15..65535)
208214503Srpaulobeacon_int=100
209214503Srpaulo
210252726Srpaulo# DTIM (delivery traffic information message) period (range 1..255):
211214503Srpaulo# number of beacons between DTIMs (1 = every beacon includes DTIM element)
212214503Srpaulo# (default: 2)
213214503Srpaulodtim_period=2
214214503Srpaulo
215214503Srpaulo# Maximum number of stations allowed in station table. New stations will be
216214503Srpaulo# rejected after the station table is full. IEEE 802.11 has a limit of 2007
217214503Srpaulo# different association IDs, so this number should not be larger than that.
218214503Srpaulo# (default: 2007)
219214503Srpaulomax_num_sta=255
220214503Srpaulo
221337817Scy# RTS/CTS threshold; -1 = disabled (default); range -1..65535
222214503Srpaulo# If this field is not included in hostapd.conf, hostapd will not control
223214503Srpaulo# RTS threshold and 'iwconfig wlan# rts <val>' can be used to set it.
224337817Scyrts_threshold=-1
225214503Srpaulo
226337817Scy# Fragmentation threshold; -1 = disabled (default); range -1, 256..2346
227214503Srpaulo# If this field is not included in hostapd.conf, hostapd will not control
228214503Srpaulo# fragmentation threshold and 'iwconfig wlan# frag <val>' can be used to set
229214503Srpaulo# it.
230337817Scyfragm_threshold=-1
231214503Srpaulo
232214503Srpaulo# Rate configuration
233214503Srpaulo# Default is to enable all rates supported by the hardware. This configuration
234214503Srpaulo# item allows this list be filtered so that only the listed rates will be left
235214503Srpaulo# in the list. If the list is empty, all rates are used. This list can have
236214503Srpaulo# entries that are not in the list of rates the hardware supports (such entries
237214503Srpaulo# are ignored). The entries in this list are in 100 kbps, i.e., 11 Mbps = 110.
238214503Srpaulo# If this item is present, at least one rate have to be matching with the rates
239214503Srpaulo# hardware supports.
240214503Srpaulo# default: use the most common supported rate setting for the selected
241214503Srpaulo# hw_mode (i.e., this line can be removed from configuration file in most
242214503Srpaulo# cases)
243214503Srpaulo#supported_rates=10 20 55 110 60 90 120 180 240 360 480 540
244214503Srpaulo
245214503Srpaulo# Basic rate set configuration
246214503Srpaulo# List of rates (in 100 kbps) that are included in the basic rate set.
247214503Srpaulo# If this item is not included, usually reasonable default set is used.
248214503Srpaulo#basic_rates=10 20
249214503Srpaulo#basic_rates=10 20 55 110
250214503Srpaulo#basic_rates=60 120 240
251214503Srpaulo
252346981Scy# Beacon frame TX rate configuration
253346981Scy# This sets the TX rate that is used to transmit Beacon frames. If this item is
254346981Scy# not included, the driver default rate (likely lowest rate) is used.
255346981Scy# Legacy (CCK/OFDM rates):
256346981Scy#    beacon_rate=<legacy rate in 100 kbps>
257346981Scy# HT:
258346981Scy#    beacon_rate=ht:<HT MCS>
259346981Scy# VHT:
260346981Scy#    beacon_rate=vht:<VHT MCS>
261346981Scy#
262346981Scy# For example, beacon_rate=10 for 1 Mbps or beacon_rate=60 for 6 Mbps (OFDM).
263346981Scy#beacon_rate=10
264346981Scy
265214503Srpaulo# Short Preamble
266214503Srpaulo# This parameter can be used to enable optional use of short preamble for
267214503Srpaulo# frames sent at 2 Mbps, 5.5 Mbps, and 11 Mbps to improve network performance.
268214503Srpaulo# This applies only to IEEE 802.11b-compatible networks and this should only be
269214503Srpaulo# enabled if the local hardware supports use of short preamble. If any of the
270214503Srpaulo# associated STAs do not support short preamble, use of short preamble will be
271214503Srpaulo# disabled (and enabled when such STAs disassociate) dynamically.
272214503Srpaulo# 0 = do not allow use of short preamble (default)
273214503Srpaulo# 1 = allow use of short preamble
274214503Srpaulo#preamble=1
275214503Srpaulo
276214503Srpaulo# Station MAC address -based authentication
277214503Srpaulo# Please note that this kind of access control requires a driver that uses
278214503Srpaulo# hostapd to take care of management frame processing and as such, this can be
279281806Srpaulo# used with driver=hostap or driver=nl80211, but not with driver=atheros.
280214503Srpaulo# 0 = accept unless in deny list
281214503Srpaulo# 1 = deny unless in accept list
282214503Srpaulo# 2 = use external RADIUS server (accept/deny lists are searched first)
283214503Srpaulomacaddr_acl=0
284214503Srpaulo
285214503Srpaulo# Accept/deny lists are read from separate files (containing list of
286214503Srpaulo# MAC addresses, one per line). Use absolute path name to make sure that the
287214503Srpaulo# files can be read on SIGHUP configuration reloads.
288214503Srpaulo#accept_mac_file=/etc/hostapd.accept
289214503Srpaulo#deny_mac_file=/etc/hostapd.deny
290214503Srpaulo
291214503Srpaulo# IEEE 802.11 specifies two authentication algorithms. hostapd can be
292214503Srpaulo# configured to allow both of these or only one. Open system authentication
293214503Srpaulo# should be used with IEEE 802.1X.
294214503Srpaulo# Bit fields of allowed authentication algorithms:
295214503Srpaulo# bit 0 = Open System Authentication
296214503Srpaulo# bit 1 = Shared Key Authentication (requires WEP)
297214503Srpauloauth_algs=3
298214503Srpaulo
299214503Srpaulo# Send empty SSID in beacons and ignore probe request frames that do not
300214503Srpaulo# specify full SSID, i.e., require stations to know SSID.
301214503Srpaulo# default: disabled (0)
302214503Srpaulo# 1 = send empty (length=0) SSID in beacon and ignore probe request for
303214503Srpaulo#     broadcast SSID
304214503Srpaulo# 2 = clear SSID (ASCII 0), but keep the original length (this may be required
305214503Srpaulo#     with some clients that do not support empty SSID) and ignore probe
306214503Srpaulo#     requests for broadcast SSID
307214503Srpauloignore_broadcast_ssid=0
308214503Srpaulo
309337817Scy# Do not reply to broadcast Probe Request frames from unassociated STA if there
310337817Scy# is no room for additional stations (max_num_sta). This can be used to
311337817Scy# discourage a STA from trying to associate with this AP if the association
312337817Scy# would be rejected due to maximum STA limit.
313337817Scy# Default: 0 (disabled)
314337817Scy#no_probe_resp_if_max_sta=0
315337817Scy
316337817Scy# Additional vendor specific elements for Beacon and Probe Response frames
317252726Srpaulo# This parameter can be used to add additional vendor specific element(s) into
318252726Srpaulo# the end of the Beacon and Probe Response frames. The format for these
319252726Srpaulo# element(s) is a hexdump of the raw information elements (id+len+payload for
320252726Srpaulo# one or more elements)
321252726Srpaulo#vendor_elements=dd0411223301
322252726Srpaulo
323337817Scy# Additional vendor specific elements for (Re)Association Response frames
324337817Scy# This parameter can be used to add additional vendor specific element(s) into
325337817Scy# the end of the (Re)Association Response frames. The format for these
326337817Scy# element(s) is a hexdump of the raw information elements (id+len+payload for
327337817Scy# one or more elements)
328337817Scy#assocresp_elements=dd0411223301
329337817Scy
330214503Srpaulo# TX queue parameters (EDCF / bursting)
331214503Srpaulo# tx_queue_<queue name>_<param>
332346981Scy# queues: data0, data1, data2, data3
333214503Srpaulo#		(data0 is the highest priority queue)
334214503Srpaulo# parameters:
335214503Srpaulo#   aifs: AIFS (default 2)
336289549Srpaulo#   cwmin: cwMin (1, 3, 7, 15, 31, 63, 127, 255, 511, 1023, 2047, 4095, 8191,
337289549Srpaulo#	   16383, 32767)
338289549Srpaulo#   cwmax: cwMax (same values as cwMin, cwMax >= cwMin)
339214503Srpaulo#   burst: maximum length (in milliseconds with precision of up to 0.1 ms) for
340214503Srpaulo#          bursting
341214503Srpaulo#
342214503Srpaulo# Default WMM parameters (IEEE 802.11 draft; 11-03-0504-03-000e):
343214503Srpaulo# These parameters are used by the access point when transmitting frames
344214503Srpaulo# to the clients.
345214503Srpaulo#
346214503Srpaulo# Low priority / AC_BK = background
347214503Srpaulo#tx_queue_data3_aifs=7
348214503Srpaulo#tx_queue_data3_cwmin=15
349214503Srpaulo#tx_queue_data3_cwmax=1023
350214503Srpaulo#tx_queue_data3_burst=0
351214503Srpaulo# Note: for IEEE 802.11b mode: cWmin=31 cWmax=1023 burst=0
352214503Srpaulo#
353214503Srpaulo# Normal priority / AC_BE = best effort
354214503Srpaulo#tx_queue_data2_aifs=3
355214503Srpaulo#tx_queue_data2_cwmin=15
356214503Srpaulo#tx_queue_data2_cwmax=63
357214503Srpaulo#tx_queue_data2_burst=0
358214503Srpaulo# Note: for IEEE 802.11b mode: cWmin=31 cWmax=127 burst=0
359214503Srpaulo#
360214503Srpaulo# High priority / AC_VI = video
361214503Srpaulo#tx_queue_data1_aifs=1
362214503Srpaulo#tx_queue_data1_cwmin=7
363214503Srpaulo#tx_queue_data1_cwmax=15
364214503Srpaulo#tx_queue_data1_burst=3.0
365214503Srpaulo# Note: for IEEE 802.11b mode: cWmin=15 cWmax=31 burst=6.0
366214503Srpaulo#
367214503Srpaulo# Highest priority / AC_VO = voice
368214503Srpaulo#tx_queue_data0_aifs=1
369214503Srpaulo#tx_queue_data0_cwmin=3
370214503Srpaulo#tx_queue_data0_cwmax=7
371214503Srpaulo#tx_queue_data0_burst=1.5
372214503Srpaulo# Note: for IEEE 802.11b mode: cWmin=7 cWmax=15 burst=3.3
373214503Srpaulo
374214503Srpaulo# 802.1D Tag (= UP) to AC mappings
375214503Srpaulo# WMM specifies following mapping of data frames to different ACs. This mapping
376214503Srpaulo# can be configured using Linux QoS/tc and sch_pktpri.o module.
377214503Srpaulo# 802.1D Tag	802.1D Designation	Access Category	WMM Designation
378214503Srpaulo# 1		BK			AC_BK		Background
379214503Srpaulo# 2		-			AC_BK		Background
380214503Srpaulo# 0		BE			AC_BE		Best Effort
381214503Srpaulo# 3		EE			AC_BE		Best Effort
382214503Srpaulo# 4		CL			AC_VI		Video
383214503Srpaulo# 5		VI			AC_VI		Video
384214503Srpaulo# 6		VO			AC_VO		Voice
385214503Srpaulo# 7		NC			AC_VO		Voice
386214503Srpaulo# Data frames with no priority information: AC_BE
387214503Srpaulo# Management frames: AC_VO
388214503Srpaulo# PS-Poll frames: AC_BE
389214503Srpaulo
390214503Srpaulo# Default WMM parameters (IEEE 802.11 draft; 11-03-0504-03-000e):
391214503Srpaulo# for 802.11a or 802.11g networks
392214503Srpaulo# These parameters are sent to WMM clients when they associate.
393214503Srpaulo# The parameters will be used by WMM clients for frames transmitted to the
394214503Srpaulo# access point.
395214503Srpaulo#
396214503Srpaulo# note - txop_limit is in units of 32microseconds
397214503Srpaulo# note - acm is admission control mandatory flag. 0 = admission control not
398214503Srpaulo# required, 1 = mandatory
399289549Srpaulo# note - Here cwMin and cmMax are in exponent form. The actual cw value used
400289549Srpaulo# will be (2^n)-1 where n is the value given here. The allowed range for these
401289549Srpaulo# wmm_ac_??_{cwmin,cwmax} is 0..15 with cwmax >= cwmin.
402214503Srpaulo#
403214503Srpaulowmm_enabled=1
404214503Srpaulo#
405214503Srpaulo# WMM-PS Unscheduled Automatic Power Save Delivery [U-APSD]
406214503Srpaulo# Enable this flag if U-APSD supported outside hostapd (eg., Firmware/driver)
407214503Srpaulo#uapsd_advertisement_enabled=1
408214503Srpaulo#
409214503Srpaulo# Low priority / AC_BK = background
410214503Srpaulowmm_ac_bk_cwmin=4
411214503Srpaulowmm_ac_bk_cwmax=10
412214503Srpaulowmm_ac_bk_aifs=7
413214503Srpaulowmm_ac_bk_txop_limit=0
414214503Srpaulowmm_ac_bk_acm=0
415214503Srpaulo# Note: for IEEE 802.11b mode: cWmin=5 cWmax=10
416214503Srpaulo#
417214503Srpaulo# Normal priority / AC_BE = best effort
418214503Srpaulowmm_ac_be_aifs=3
419214503Srpaulowmm_ac_be_cwmin=4
420214503Srpaulowmm_ac_be_cwmax=10
421214503Srpaulowmm_ac_be_txop_limit=0
422214503Srpaulowmm_ac_be_acm=0
423214503Srpaulo# Note: for IEEE 802.11b mode: cWmin=5 cWmax=7
424214503Srpaulo#
425214503Srpaulo# High priority / AC_VI = video
426214503Srpaulowmm_ac_vi_aifs=2
427214503Srpaulowmm_ac_vi_cwmin=3
428214503Srpaulowmm_ac_vi_cwmax=4
429214503Srpaulowmm_ac_vi_txop_limit=94
430214503Srpaulowmm_ac_vi_acm=0
431214503Srpaulo# Note: for IEEE 802.11b mode: cWmin=4 cWmax=5 txop_limit=188
432214503Srpaulo#
433214503Srpaulo# Highest priority / AC_VO = voice
434214503Srpaulowmm_ac_vo_aifs=2
435214503Srpaulowmm_ac_vo_cwmin=2
436214503Srpaulowmm_ac_vo_cwmax=3
437214503Srpaulowmm_ac_vo_txop_limit=47
438214503Srpaulowmm_ac_vo_acm=0
439214503Srpaulo# Note: for IEEE 802.11b mode: cWmin=3 cWmax=4 burst=102
440214503Srpaulo
441346981Scy# Enable Multi-AP functionality
442346981Scy# 0 = disabled (default)
443346981Scy# 1 = AP support backhaul BSS
444346981Scy# 2 = AP support fronthaul BSS
445346981Scy# 3 = AP supports both backhaul BSS and fronthaul BSS
446346981Scy#multi_ap=0
447346981Scy
448214503Srpaulo# Static WEP key configuration
449214503Srpaulo#
450214503Srpaulo# The key number to use when transmitting.
451214503Srpaulo# It must be between 0 and 3, and the corresponding key must be set.
452214503Srpaulo# default: not set
453214503Srpaulo#wep_default_key=0
454214503Srpaulo# The WEP keys to use.
455214503Srpaulo# A key may be a quoted string or unquoted hexadecimal digits.
456214503Srpaulo# The key length should be 5, 13, or 16 characters, or 10, 26, or 32
457214503Srpaulo# digits, depending on whether 40-bit (64-bit), 104-bit (128-bit), or
458214503Srpaulo# 128-bit (152-bit) WEP is used.
459214503Srpaulo# Only the default key must be supplied; the others are optional.
460214503Srpaulo# default: not set
461214503Srpaulo#wep_key0=123456789a
462214503Srpaulo#wep_key1="vwxyz"
463214503Srpaulo#wep_key2=0102030405060708090a0b0c0d
464214503Srpaulo#wep_key3=".2.4.6.8.0.23"
465214503Srpaulo
466214503Srpaulo# Station inactivity limit
467214503Srpaulo#
468214503Srpaulo# If a station does not send anything in ap_max_inactivity seconds, an
469214503Srpaulo# empty data frame is sent to it in order to verify whether it is
470214503Srpaulo# still in range. If this frame is not ACKed, the station will be
471214503Srpaulo# disassociated and then deauthenticated. This feature is used to
472214503Srpaulo# clear station table of old entries when the STAs move out of the
473214503Srpaulo# range.
474214503Srpaulo#
475214503Srpaulo# The station can associate again with the AP if it is still in range;
476214503Srpaulo# this inactivity poll is just used as a nicer way of verifying
477214503Srpaulo# inactivity; i.e., client will not report broken connection because
478214503Srpaulo# disassociation frame is not sent immediately without first polling
479214503Srpaulo# the STA with a data frame.
480214503Srpaulo# default: 300 (i.e., 5 minutes)
481214503Srpaulo#ap_max_inactivity=300
482252726Srpaulo#
483252726Srpaulo# The inactivity polling can be disabled to disconnect stations based on
484252726Srpaulo# inactivity timeout so that idle stations are more likely to be disconnected
485252726Srpaulo# even if they are still in range of the AP. This can be done by setting
486252726Srpaulo# skip_inactivity_poll to 1 (default 0).
487252726Srpaulo#skip_inactivity_poll=0
488214503Srpaulo
489252726Srpaulo# Disassociate stations based on excessive transmission failures or other
490252726Srpaulo# indications of connection loss. This depends on the driver capabilities and
491252726Srpaulo# may not be available with all drivers.
492252726Srpaulo#disassoc_low_ack=1
493252726Srpaulo
494214503Srpaulo# Maximum allowed Listen Interval (how many Beacon periods STAs are allowed to
495214503Srpaulo# remain asleep). Default: 65535 (no limit apart from field size)
496214503Srpaulo#max_listen_interval=100
497214503Srpaulo
498214503Srpaulo# WDS (4-address frame) mode with per-station virtual interfaces
499214503Srpaulo# (only supported with driver=nl80211)
500214503Srpaulo# This mode allows associated stations to use 4-address frames to allow layer 2
501214503Srpaulo# bridging to be used.
502214503Srpaulo#wds_sta=1
503214503Srpaulo
504252726Srpaulo# If bridge parameter is set, the WDS STA interface will be added to the same
505252726Srpaulo# bridge by default. This can be overridden with the wds_bridge parameter to
506252726Srpaulo# use a separate bridge.
507252726Srpaulo#wds_bridge=wds-br0
508252726Srpaulo
509281806Srpaulo# Start the AP with beaconing disabled by default.
510281806Srpaulo#start_disabled=0
511281806Srpaulo
512252726Srpaulo# Client isolation can be used to prevent low-level bridging of frames between
513252726Srpaulo# associated stations in the BSS. By default, this bridging is allowed.
514252726Srpaulo#ap_isolate=1
515252726Srpaulo
516281806Srpaulo# BSS Load update period (in BUs)
517281806Srpaulo# This field is used to enable and configure adding a BSS Load element into
518281806Srpaulo# Beacon and Probe Response frames.
519281806Srpaulo#bss_load_update_period=50
520281806Srpaulo
521346981Scy# Channel utilization averaging period (in BUs)
522346981Scy# This field is used to enable and configure channel utilization average
523346981Scy# calculation with bss_load_update_period. This should be in multiples of
524346981Scy# bss_load_update_period for more accurate calculation.
525346981Scy#chan_util_avg_period=600
526346981Scy
527281806Srpaulo# Fixed BSS Load value for testing purposes
528281806Srpaulo# This field can be used to configure hostapd to add a fixed BSS Load element
529281806Srpaulo# into Beacon and Probe Response frames for testing purposes. The format is
530281806Srpaulo# <station count>:<channel utilization>:<available admission capacity>
531281806Srpaulo#bss_load_test=12:80:20000
532281806Srpaulo
533346981Scy# Multicast to unicast conversion
534346981Scy# Request that the AP will do multicast-to-unicast conversion for ARP, IPv4, and
535346981Scy# IPv6 frames (possibly within 802.1Q). If enabled, such frames are to be sent
536346981Scy# to each station separately, with the DA replaced by their own MAC address
537346981Scy# rather than the group address.
538346981Scy#
539346981Scy# Note that this may break certain expectations of the receiver, such as the
540346981Scy# ability to drop unicast IP packets received within multicast L2 frames, or the
541346981Scy# ability to not send ICMP destination unreachable messages for packets received
542346981Scy# in L2 multicast (which is required, but the receiver can't tell the difference
543346981Scy# if this new option is enabled).
544346981Scy#
545346981Scy# This also doesn't implement the 802.11 DMS (directed multicast service).
546346981Scy#
547346981Scy#multicast_to_unicast=0
548346981Scy
549346981Scy# Send broadcast Deauthentication frame on AP start/stop
550346981Scy# Default: 1 (enabled)
551346981Scy#broadcast_deauth=1
552346981Scy
553214503Srpaulo##### IEEE 802.11n related configuration ######################################
554214503Srpaulo
555214503Srpaulo# ieee80211n: Whether IEEE 802.11n (HT) is enabled
556214503Srpaulo# 0 = disabled (default)
557214503Srpaulo# 1 = enabled
558214503Srpaulo# Note: You will also need to enable WMM for full HT functionality.
559337817Scy# Note: hw_mode=g (2.4 GHz) and hw_mode=a (5 GHz) is used to specify the band.
560214503Srpaulo#ieee80211n=1
561214503Srpaulo
562214503Srpaulo# ht_capab: HT capabilities (list of flags)
563214503Srpaulo# LDPC coding capability: [LDPC] = supported
564214503Srpaulo# Supported channel width set: [HT40-] = both 20 MHz and 40 MHz with secondary
565214503Srpaulo#	channel below the primary channel; [HT40+] = both 20 MHz and 40 MHz
566281806Srpaulo#	with secondary channel above the primary channel
567214503Srpaulo#	(20 MHz only if neither is set)
568214503Srpaulo#	Note: There are limits on which channels can be used with HT40- and
569214503Srpaulo#	HT40+. Following table shows the channels that may be available for
570214503Srpaulo#	HT40- and HT40+ use per IEEE 802.11n Annex J:
571214503Srpaulo#	freq		HT40-		HT40+
572214503Srpaulo#	2.4 GHz		5-13		1-7 (1-9 in Europe/Japan)
573214503Srpaulo#	5 GHz		40,48,56,64	36,44,52,60
574214503Srpaulo#	(depending on the location, not all of these channels may be available
575214503Srpaulo#	for use)
576214503Srpaulo#	Please note that 40 MHz channels may switch their primary and secondary
577214503Srpaulo#	channels if needed or creation of 40 MHz channel maybe rejected based
578214503Srpaulo#	on overlapping BSSes. These changes are done automatically when hostapd
579214503Srpaulo#	is setting up the 40 MHz channel.
580214503Srpaulo# Spatial Multiplexing (SM) Power Save: [SMPS-STATIC] or [SMPS-DYNAMIC]
581214503Srpaulo#	(SMPS disabled if neither is set)
582214503Srpaulo# HT-greenfield: [GF] (disabled if not set)
583214503Srpaulo# Short GI for 20 MHz: [SHORT-GI-20] (disabled if not set)
584214503Srpaulo# Short GI for 40 MHz: [SHORT-GI-40] (disabled if not set)
585214503Srpaulo# Tx STBC: [TX-STBC] (disabled if not set)
586214503Srpaulo# Rx STBC: [RX-STBC1] (one spatial stream), [RX-STBC12] (one or two spatial
587214503Srpaulo#	streams), or [RX-STBC123] (one, two, or three spatial streams); Rx STBC
588214503Srpaulo#	disabled if none of these set
589214503Srpaulo# HT-delayed Block Ack: [DELAYED-BA] (disabled if not set)
590214503Srpaulo# Maximum A-MSDU length: [MAX-AMSDU-7935] for 7935 octets (3839 octets if not
591214503Srpaulo#	set)
592214503Srpaulo# DSSS/CCK Mode in 40 MHz: [DSSS_CCK-40] = allowed (not allowed if not set)
593281806Srpaulo# 40 MHz intolerant [40-INTOLERANT] (not advertised if not set)
594214503Srpaulo# L-SIG TXOP protection support: [LSIG-TXOP-PROT] (disabled if not set)
595214503Srpaulo#ht_capab=[HT40-][SHORT-GI-20][SHORT-GI-40]
596214503Srpaulo
597252726Srpaulo# Require stations to support HT PHY (reject association if they do not)
598252726Srpaulo#require_ht=1
599252726Srpaulo
600281806Srpaulo# If set non-zero, require stations to perform scans of overlapping
601281806Srpaulo# channels to test for stations which would be affected by 40 MHz traffic.
602281806Srpaulo# This parameter sets the interval in seconds between these scans. Setting this
603281806Srpaulo# to non-zero allows 2.4 GHz band AP to move dynamically to a 40 MHz channel if
604281806Srpaulo# no co-existence issues with neighboring devices are found.
605281806Srpaulo#obss_interval=0
606281806Srpaulo
607252726Srpaulo##### IEEE 802.11ac related configuration #####################################
608252726Srpaulo
609252726Srpaulo# ieee80211ac: Whether IEEE 802.11ac (VHT) is enabled
610252726Srpaulo# 0 = disabled (default)
611252726Srpaulo# 1 = enabled
612252726Srpaulo# Note: You will also need to enable WMM for full VHT functionality.
613337817Scy# Note: hw_mode=a is used to specify that 5 GHz band is used with VHT.
614252726Srpaulo#ieee80211ac=1
615252726Srpaulo
616252726Srpaulo# vht_capab: VHT capabilities (list of flags)
617252726Srpaulo#
618252726Srpaulo# vht_max_mpdu_len: [MAX-MPDU-7991] [MAX-MPDU-11454]
619252726Srpaulo# Indicates maximum MPDU length
620252726Srpaulo# 0 = 3895 octets (default)
621252726Srpaulo# 1 = 7991 octets
622252726Srpaulo# 2 = 11454 octets
623252726Srpaulo# 3 = reserved
624252726Srpaulo#
625252726Srpaulo# supported_chan_width: [VHT160] [VHT160-80PLUS80]
626252726Srpaulo# Indicates supported Channel widths
627252726Srpaulo# 0 = 160 MHz & 80+80 channel widths are not supported (default)
628252726Srpaulo# 1 = 160 MHz channel width is supported
629252726Srpaulo# 2 = 160 MHz & 80+80 channel widths are supported
630252726Srpaulo# 3 = reserved
631252726Srpaulo#
632252726Srpaulo# Rx LDPC coding capability: [RXLDPC]
633252726Srpaulo# Indicates support for receiving LDPC coded pkts
634252726Srpaulo# 0 = Not supported (default)
635252726Srpaulo# 1 = Supported
636252726Srpaulo#
637252726Srpaulo# Short GI for 80 MHz: [SHORT-GI-80]
638252726Srpaulo# Indicates short GI support for reception of packets transmitted with TXVECTOR
639252726Srpaulo# params format equal to VHT and CBW = 80Mhz
640252726Srpaulo# 0 = Not supported (default)
641252726Srpaulo# 1 = Supported
642252726Srpaulo#
643252726Srpaulo# Short GI for 160 MHz: [SHORT-GI-160]
644252726Srpaulo# Indicates short GI support for reception of packets transmitted with TXVECTOR
645252726Srpaulo# params format equal to VHT and CBW = 160Mhz
646252726Srpaulo# 0 = Not supported (default)
647252726Srpaulo# 1 = Supported
648252726Srpaulo#
649252726Srpaulo# Tx STBC: [TX-STBC-2BY1]
650252726Srpaulo# Indicates support for the transmission of at least 2x1 STBC
651252726Srpaulo# 0 = Not supported (default)
652252726Srpaulo# 1 = Supported
653252726Srpaulo#
654252726Srpaulo# Rx STBC: [RX-STBC-1] [RX-STBC-12] [RX-STBC-123] [RX-STBC-1234]
655252726Srpaulo# Indicates support for the reception of PPDUs using STBC
656252726Srpaulo# 0 = Not supported (default)
657252726Srpaulo# 1 = support of one spatial stream
658252726Srpaulo# 2 = support of one and two spatial streams
659252726Srpaulo# 3 = support of one, two and three spatial streams
660252726Srpaulo# 4 = support of one, two, three and four spatial streams
661252726Srpaulo# 5,6,7 = reserved
662252726Srpaulo#
663252726Srpaulo# SU Beamformer Capable: [SU-BEAMFORMER]
664252726Srpaulo# Indicates support for operation as a single user beamformer
665252726Srpaulo# 0 = Not supported (default)
666252726Srpaulo# 1 = Supported
667252726Srpaulo#
668252726Srpaulo# SU Beamformee Capable: [SU-BEAMFORMEE]
669252726Srpaulo# Indicates support for operation as a single user beamformee
670252726Srpaulo# 0 = Not supported (default)
671252726Srpaulo# 1 = Supported
672252726Srpaulo#
673289549Srpaulo# Compressed Steering Number of Beamformer Antennas Supported:
674289549Srpaulo# [BF-ANTENNA-2] [BF-ANTENNA-3] [BF-ANTENNA-4]
675252726Srpaulo#   Beamformee's capability indicating the maximum number of beamformer
676252726Srpaulo#   antennas the beamformee can support when sending compressed beamforming
677252726Srpaulo#   feedback
678252726Srpaulo# If SU beamformer capable, set to maximum value minus 1
679252726Srpaulo# else reserved (default)
680252726Srpaulo#
681289549Srpaulo# Number of Sounding Dimensions:
682289549Srpaulo# [SOUNDING-DIMENSION-2] [SOUNDING-DIMENSION-3] [SOUNDING-DIMENSION-4]
683252726Srpaulo# Beamformer's capability indicating the maximum value of the NUM_STS parameter
684252726Srpaulo# in the TXVECTOR of a VHT NDP
685252726Srpaulo# If SU beamformer capable, set to maximum value minus 1
686252726Srpaulo# else reserved (default)
687252726Srpaulo#
688252726Srpaulo# MU Beamformer Capable: [MU-BEAMFORMER]
689252726Srpaulo# Indicates support for operation as an MU beamformer
690252726Srpaulo# 0 = Not supported or sent by Non-AP STA (default)
691252726Srpaulo# 1 = Supported
692252726Srpaulo#
693252726Srpaulo# VHT TXOP PS: [VHT-TXOP-PS]
694252726Srpaulo# Indicates whether or not the AP supports VHT TXOP Power Save Mode
695252726Srpaulo#  or whether or not the STA is in VHT TXOP Power Save mode
696337817Scy# 0 = VHT AP doesn't support VHT TXOP PS mode (OR) VHT STA not in VHT TXOP PS
697252726Srpaulo#  mode
698337817Scy# 1 = VHT AP supports VHT TXOP PS mode (OR) VHT STA is in VHT TXOP power save
699252726Srpaulo#  mode
700252726Srpaulo#
701252726Srpaulo# +HTC-VHT Capable: [HTC-VHT]
702252726Srpaulo# Indicates whether or not the STA supports receiving a VHT variant HT Control
703252726Srpaulo# field.
704252726Srpaulo# 0 = Not supported (default)
705252726Srpaulo# 1 = supported
706252726Srpaulo#
707252726Srpaulo# Maximum A-MPDU Length Exponent: [MAX-A-MPDU-LEN-EXP0]..[MAX-A-MPDU-LEN-EXP7]
708252726Srpaulo# Indicates the maximum length of A-MPDU pre-EOF padding that the STA can recv
709252726Srpaulo# This field is an integer in the range of 0 to 7.
710252726Srpaulo# The length defined by this field is equal to
711252726Srpaulo# 2 pow(13 + Maximum A-MPDU Length Exponent) -1 octets
712252726Srpaulo#
713252726Srpaulo# VHT Link Adaptation Capable: [VHT-LINK-ADAPT2] [VHT-LINK-ADAPT3]
714252726Srpaulo# Indicates whether or not the STA supports link adaptation using VHT variant
715252726Srpaulo# HT Control field
716252726Srpaulo# If +HTC-VHTcapable is 1
717252726Srpaulo#  0 = (no feedback) if the STA does not provide VHT MFB (default)
718252726Srpaulo#  1 = reserved
719252726Srpaulo#  2 = (Unsolicited) if the STA provides only unsolicited VHT MFB
720252726Srpaulo#  3 = (Both) if the STA can provide VHT MFB in response to VHT MRQ and if the
721252726Srpaulo#      STA provides unsolicited VHT MFB
722252726Srpaulo# Reserved if +HTC-VHTcapable is 0
723252726Srpaulo#
724252726Srpaulo# Rx Antenna Pattern Consistency: [RX-ANTENNA-PATTERN]
725252726Srpaulo# Indicates the possibility of Rx antenna pattern change
726252726Srpaulo# 0 = Rx antenna pattern might change during the lifetime of an association
727252726Srpaulo# 1 = Rx antenna pattern does not change during the lifetime of an association
728252726Srpaulo#
729252726Srpaulo# Tx Antenna Pattern Consistency: [TX-ANTENNA-PATTERN]
730252726Srpaulo# Indicates the possibility of Tx antenna pattern change
731252726Srpaulo# 0 = Tx antenna pattern might change during the lifetime of an association
732252726Srpaulo# 1 = Tx antenna pattern does not change during the lifetime of an association
733252726Srpaulo#vht_capab=[SHORT-GI-80][HTC-VHT]
734252726Srpaulo#
735252726Srpaulo# Require stations to support VHT PHY (reject association if they do not)
736252726Srpaulo#require_vht=1
737252726Srpaulo
738252726Srpaulo# 0 = 20 or 40 MHz operating Channel width
739252726Srpaulo# 1 = 80 MHz channel width
740252726Srpaulo# 2 = 160 MHz channel width
741252726Srpaulo# 3 = 80+80 MHz channel width
742252726Srpaulo#vht_oper_chwidth=1
743252726Srpaulo#
744252726Srpaulo# center freq = 5 GHz + (5 * index)
745252726Srpaulo# So index 42 gives center freq 5.210 GHz
746252726Srpaulo# which is channel 42 in 5G band
747252726Srpaulo#
748252726Srpaulo#vht_oper_centr_freq_seg0_idx=42
749252726Srpaulo#
750252726Srpaulo# center freq = 5 GHz + (5 * index)
751252726Srpaulo# So index 159 gives center freq 5.795 GHz
752252726Srpaulo# which is channel 159 in 5G band
753252726Srpaulo#
754252726Srpaulo#vht_oper_centr_freq_seg1_idx=159
755252726Srpaulo
756337817Scy# Workaround to use station's nsts capability in (Re)Association Response frame
757337817Scy# This may be needed with some deployed devices as an interoperability
758337817Scy# workaround for beamforming if the AP's capability is greater than the
759337817Scy# station's capability. This is disabled by default and can be enabled by
760337817Scy# setting use_sta_nsts=1.
761337817Scy#use_sta_nsts=0
762337817Scy
763346981Scy##### IEEE 802.11ax related configuration #####################################
764346981Scy
765346981Scy#ieee80211ax: Whether IEEE 802.11ax (HE) is enabled
766346981Scy# 0 = disabled (default)
767346981Scy# 1 = enabled
768346981Scy#ieee80211ax=1
769346981Scy
770346981Scy#he_su_beamformer: HE single user beamformer support
771346981Scy# 0 = not supported (default)
772346981Scy# 1 = supported
773346981Scy#he_su_beamformer=1
774346981Scy
775346981Scy#he_su_beamformee: HE single user beamformee support
776346981Scy# 0 = not supported (default)
777346981Scy# 1 = supported
778346981Scy#he_su_beamformee=1
779346981Scy
780346981Scy#he_mu_beamformer: HE multiple user beamformer support
781346981Scy# 0 = not supported (default)
782346981Scy# 1 = supported
783346981Scy#he_mu_beamformer=1
784346981Scy
785351611Scy# he_bss_color: BSS color (1-63)
786351611Scy#he_bss_color=1
787346981Scy
788346981Scy#he_default_pe_duration: The duration of PE field in an HE PPDU in us
789346981Scy# Possible values are 0 us (default), 4 us, 8 us, 12 us, and 16 us
790346981Scy#he_default_pe_duration=0
791346981Scy
792346981Scy#he_twt_required: Whether TWT is required
793346981Scy# 0 = not required (default)
794346981Scy# 1 = required
795346981Scy#he_twt_required=0
796346981Scy
797346981Scy#he_rts_threshold: Duration of STA transmission
798346981Scy# 0 = not set (default)
799346981Scy# unsigned integer = duration in units of 16 us
800346981Scy#he_rts_threshold=0
801346981Scy
802351611Scy# HE operating channel information; see matching vht_* parameters for details.
803351611Scy#he_oper_chwidth
804351611Scy#he_oper_centr_freq_seg0_idx
805351611Scy#he_oper_centr_freq_seg1_idx
806351611Scy
807351611Scy#he_basic_mcs_nss_set: Basic NSS/MCS set
808351611Scy# 16-bit combination of 2-bit values of Max HE-MCS For 1..8 SS; each 2-bit
809351611Scy# value having following meaning:
810351611Scy# 0 = HE-MCS 0-7, 1 = HE-MCS 0-9, 2 = HE-MCS 0-11, 3 = not supported
811351611Scy#he_basic_mcs_nss_set
812351611Scy
813346981Scy#he_mu_edca_qos_info_param_count
814346981Scy#he_mu_edca_qos_info_q_ack
815346981Scy#he_mu_edca_qos_info_queue_request=1
816346981Scy#he_mu_edca_qos_info_txop_request
817346981Scy#he_mu_edca_ac_be_aifsn=0
818346981Scy#he_mu_edca_ac_be_ecwmin=15
819346981Scy#he_mu_edca_ac_be_ecwmax=15
820346981Scy#he_mu_edca_ac_be_timer=255
821346981Scy#he_mu_edca_ac_bk_aifsn=0
822346981Scy#he_mu_edca_ac_bk_aci=1
823346981Scy#he_mu_edca_ac_bk_ecwmin=15
824346981Scy#he_mu_edca_ac_bk_ecwmax=15
825346981Scy#he_mu_edca_ac_bk_timer=255
826346981Scy#he_mu_edca_ac_vi_ecwmin=15
827346981Scy#he_mu_edca_ac_vi_ecwmax=15
828346981Scy#he_mu_edca_ac_vi_aifsn=0
829346981Scy#he_mu_edca_ac_vi_aci=2
830346981Scy#he_mu_edca_ac_vi_timer=255
831346981Scy#he_mu_edca_ac_vo_aifsn=0
832346981Scy#he_mu_edca_ac_vo_aci=3
833346981Scy#he_mu_edca_ac_vo_ecwmin=15
834346981Scy#he_mu_edca_ac_vo_ecwmax=15
835346981Scy#he_mu_edca_ac_vo_timer=255
836346981Scy
837351611Scy# Spatial Reuse Parameter Set
838351611Scy#he_spr_sr_control
839351611Scy#he_spr_non_srg_obss_pd_max_offset
840351611Scy#he_spr_srg_obss_pd_min_offset
841351611Scy#he_spr_srg_obss_pd_max_offset
842351611Scy
843214503Srpaulo##### IEEE 802.1X-2004 related configuration ##################################
844214503Srpaulo
845214503Srpaulo# Require IEEE 802.1X authorization
846214503Srpaulo#ieee8021x=1
847214503Srpaulo
848214503Srpaulo# IEEE 802.1X/EAPOL version
849214503Srpaulo# hostapd is implemented based on IEEE Std 802.1X-2004 which defines EAPOL
850214503Srpaulo# version 2. However, there are many client implementations that do not handle
851214503Srpaulo# the new version number correctly (they seem to drop the frames completely).
852214503Srpaulo# In order to make hostapd interoperate with these clients, the version number
853214503Srpaulo# can be set to the older version (1) with this configuration value.
854351611Scy# Note: When using MACsec, eapol_version shall be set to 3, which is
855351611Scy# defined in IEEE Std 802.1X-2010.
856214503Srpaulo#eapol_version=2
857214503Srpaulo
858214503Srpaulo# Optional displayable message sent with EAP Request-Identity. The first \0
859214503Srpaulo# in this string will be converted to ASCII-0 (nul). This can be used to
860214503Srpaulo# separate network info (comma separated list of attribute=value pairs); see,
861214503Srpaulo# e.g., RFC 4284.
862214503Srpaulo#eap_message=hello
863214503Srpaulo#eap_message=hello\0networkid=netw,nasid=foo,portid=0,NAIRealms=example.com
864214503Srpaulo
865214503Srpaulo# WEP rekeying (disabled if key lengths are not set or are set to 0)
866214503Srpaulo# Key lengths for default/broadcast and individual/unicast keys:
867214503Srpaulo# 5 = 40-bit WEP (also known as 64-bit WEP with 40 secret bits)
868214503Srpaulo# 13 = 104-bit WEP (also known as 128-bit WEP with 104 secret bits)
869214503Srpaulo#wep_key_len_broadcast=5
870214503Srpaulo#wep_key_len_unicast=5
871214503Srpaulo# Rekeying period in seconds. 0 = do not rekey (i.e., set keys only once)
872214503Srpaulo#wep_rekey_period=300
873214503Srpaulo
874214503Srpaulo# EAPOL-Key index workaround (set bit7) for WinXP Supplicant (needed only if
875214503Srpaulo# only broadcast keys are used)
876214503Srpauloeapol_key_index_workaround=0
877214503Srpaulo
878214503Srpaulo# EAP reauthentication period in seconds (default: 3600 seconds; 0 = disable
879214503Srpaulo# reauthentication).
880214503Srpaulo#eap_reauth_period=3600
881214503Srpaulo
882214503Srpaulo# Use PAE group address (01:80:c2:00:00:03) instead of individual target
883214503Srpaulo# address when sending EAPOL frames with driver=wired. This is the most common
884214503Srpaulo# mechanism used in wired authentication, but it also requires that the port
885214503Srpaulo# is only used by one station.
886214503Srpaulo#use_pae_group_addr=1
887214503Srpaulo
888281806Srpaulo# EAP Re-authentication Protocol (ERP) authenticator (RFC 6696)
889281806Srpaulo#
890281806Srpaulo# Whether to initiate EAP authentication with EAP-Initiate/Re-auth-Start before
891281806Srpaulo# EAP-Identity/Request
892281806Srpaulo#erp_send_reauth_start=1
893281806Srpaulo#
894281806Srpaulo# Domain name for EAP-Initiate/Re-auth-Start. Omitted from the message if not
895281806Srpaulo# set (no local ER server). This is also used by the integrated EAP server if
896281806Srpaulo# ERP is enabled (eap_server_erp=1).
897281806Srpaulo#erp_domain=example.com
898281806Srpaulo
899351611Scy##### MACsec ##################################################################
900351611Scy
901351611Scy# macsec_policy: IEEE 802.1X/MACsec options
902351611Scy# This determines how sessions are secured with MACsec (only for MACsec
903351611Scy# drivers).
904351611Scy# 0: MACsec not in use (default)
905351611Scy# 1: MACsec enabled - Should secure, accept key server's advice to
906351611Scy#    determine whether to use a secure session or not.
907351611Scy#
908351611Scy# macsec_integ_only: IEEE 802.1X/MACsec transmit mode
909351611Scy# This setting applies only when MACsec is in use, i.e.,
910351611Scy#  - macsec_policy is enabled
911351611Scy#  - the key server has decided to enable MACsec
912351611Scy# 0: Encrypt traffic (default)
913351611Scy# 1: Integrity only
914351611Scy#
915351611Scy# macsec_replay_protect: IEEE 802.1X/MACsec replay protection
916351611Scy# This setting applies only when MACsec is in use, i.e.,
917351611Scy#  - macsec_policy is enabled
918351611Scy#  - the key server has decided to enable MACsec
919351611Scy# 0: Replay protection disabled (default)
920351611Scy# 1: Replay protection enabled
921351611Scy#
922351611Scy# macsec_replay_window: IEEE 802.1X/MACsec replay protection window
923351611Scy# This determines a window in which replay is tolerated, to allow receipt
924351611Scy# of frames that have been misordered by the network.
925351611Scy# This setting applies only when MACsec replay protection active, i.e.,
926351611Scy#  - macsec_replay_protect is enabled
927351611Scy#  - the key server has decided to enable MACsec
928351611Scy# 0: No replay window, strict check (default)
929351611Scy# 1..2^32-1: number of packets that could be misordered
930351611Scy#
931351611Scy# macsec_port: IEEE 802.1X/MACsec port
932351611Scy# Port component of the SCI
933351611Scy# Range: 1-65534 (default: 1)
934351611Scy#
935351611Scy# mka_priority (Priority of MKA Actor)
936351611Scy# Range: 0..255 (default: 255)
937351611Scy#
938351611Scy# mka_cak, mka_ckn, and mka_priority: IEEE 802.1X/MACsec pre-shared key mode
939351611Scy# This allows to configure MACsec with a pre-shared key using a (CAK,CKN) pair.
940351611Scy# In this mode, instances of hostapd can act as MACsec peers. The peer
941351611Scy# with lower priority will become the key server and start distributing SAKs.
942351611Scy# mka_cak (CAK = Secure Connectivity Association Key) takes a 16-byte (128-bit)
943351611Scy# hex-string (32 hex-digits) or a 32-byte (256-bit) hex-string (64 hex-digits)
944351611Scy# mka_ckn (CKN = CAK Name) takes a 1..32-bytes (8..256 bit) hex-string
945351611Scy# (2..64 hex-digits)
946351611Scy
947214503Srpaulo##### Integrated EAP server ###################################################
948214503Srpaulo
949214503Srpaulo# Optionally, hostapd can be configured to use an integrated EAP server
950214503Srpaulo# to process EAP authentication locally without need for an external RADIUS
951214503Srpaulo# server. This functionality can be used both as a local authentication server
952214503Srpaulo# for IEEE 802.1X/EAPOL and as a RADIUS server for other devices.
953214503Srpaulo
954214503Srpaulo# Use integrated EAP server instead of external RADIUS authentication
955214503Srpaulo# server. This is also needed if hostapd is configured to act as a RADIUS
956214503Srpaulo# authentication server.
957214503Srpauloeap_server=0
958214503Srpaulo
959214503Srpaulo# Path for EAP server user database
960252726Srpaulo# If SQLite support is included, this can be set to "sqlite:/path/to/sqlite.db"
961252726Srpaulo# to use SQLite database instead of a text file.
962214503Srpaulo#eap_user_file=/etc/hostapd.eap_user
963214503Srpaulo
964214503Srpaulo# CA certificate (PEM or DER file) for EAP-TLS/PEAP/TTLS
965214503Srpaulo#ca_cert=/etc/hostapd.ca.pem
966214503Srpaulo
967214503Srpaulo# Server certificate (PEM or DER file) for EAP-TLS/PEAP/TTLS
968214503Srpaulo#server_cert=/etc/hostapd.server.pem
969214503Srpaulo
970214503Srpaulo# Private key matching with the server certificate for EAP-TLS/PEAP/TTLS
971214503Srpaulo# This may point to the same file as server_cert if both certificate and key
972214503Srpaulo# are included in a single file. PKCS#12 (PFX) file (.p12/.pfx) can also be
973214503Srpaulo# used by commenting out server_cert and specifying the PFX file as the
974214503Srpaulo# private_key.
975214503Srpaulo#private_key=/etc/hostapd.server.prv
976214503Srpaulo
977214503Srpaulo# Passphrase for private key
978214503Srpaulo#private_key_passwd=secret passphrase
979214503Srpaulo
980351611Scy# An alternative server certificate and private key can be configured with the
981351611Scy# following parameters (with values just like the parameters above without the
982351611Scy# '2' suffix). The ca_cert file (in PEM encoding) is used to add the trust roots
983351611Scy# for both server certificates and/or client certificates).
984351611Scy#
985351611Scy# The main use case for this alternative server certificate configuration is to
986351611Scy# enable both RSA and ECC public keys. The server will pick which one to use
987351611Scy# based on the client preferences for the cipher suite (in the TLS ClientHello
988351611Scy# message). It should be noted that number of deployed EAP peer implementations
989351611Scy# do not filter out the cipher suite list based on their local configuration and
990351611Scy# as such, configuration of alternative types of certificates on the server may
991351611Scy# result in interoperability issues.
992351611Scy#server_cert2=/etc/hostapd.server-ecc.pem
993351611Scy#private_key2=/etc/hostapd.server-ecc.prv
994351611Scy#private_key_passwd2=secret passphrase
995351611Scy
996351611Scy
997281806Srpaulo# Server identity
998281806Srpaulo# EAP methods that provide mechanism for authenticated server identity delivery
999281806Srpaulo# use this value. If not set, "hostapd" is used as a default.
1000281806Srpaulo#server_id=server.example.com
1001281806Srpaulo
1002214503Srpaulo# Enable CRL verification.
1003214503Srpaulo# Note: hostapd does not yet support CRL downloading based on CDP. Thus, a
1004214503Srpaulo# valid CRL signed by the CA is required to be included in the ca_cert file.
1005214503Srpaulo# This can be done by using PEM format for CA certificate and CRL and
1006214503Srpaulo# concatenating these into one file. Whenever CRL changes, hostapd needs to be
1007346981Scy# restarted to take the new CRL into use. Alternatively, crl_reload_interval can
1008346981Scy# be used to configure periodic updating of the loaded CRL information.
1009214503Srpaulo# 0 = do not verify CRLs (default)
1010214503Srpaulo# 1 = check the CRL of the user certificate
1011214503Srpaulo# 2 = check all CRLs in the certificate path
1012214503Srpaulo#check_crl=1
1013214503Srpaulo
1014346981Scy# Specify whether to ignore certificate CRL validity time mismatches with
1015346981Scy# errors X509_V_ERR_CERT_HAS_EXPIRED and X509_V_ERR_CERT_NOT_YET_VALID.
1016346981Scy#
1017346981Scy# 0 = ignore errors
1018346981Scy# 1 = do not ignore errors (default)
1019346981Scy#check_crl_strict=1
1020346981Scy
1021346981Scy# CRL reload interval in seconds
1022346981Scy# This can be used to reload ca_cert file and the included CRL on every new TLS
1023346981Scy# session if difference between last reload and the current reload time in
1024346981Scy# seconds is greater than crl_reload_interval.
1025346981Scy# Note: If interval time is very short, CPU overhead may be negatively affected
1026346981Scy# and it is advised to not go below 300 seconds.
1027346981Scy# This is applicable only with check_crl values 1 and 2.
1028346981Scy# 0 = do not reload CRLs (default)
1029346981Scy# crl_reload_interval = 300
1030346981Scy
1031346981Scy# If check_cert_subject is set, the value of every field will be checked
1032346981Scy# against the DN of the subject in the client certificate. If the values do
1033346981Scy# not match, the certificate verification will fail, rejecting the user.
1034346981Scy# This option allows hostapd to match every individual field in the right order
1035346981Scy# against the DN of the subject in the client certificate.
1036346981Scy#
1037346981Scy# For example, check_cert_subject=C=US/O=XX/OU=ABC/OU=XYZ/CN=1234 will check
1038346981Scy# every individual DN field of the subject in the client certificate. If OU=XYZ
1039346981Scy# comes first in terms of the order in the client certificate (DN field of
1040346981Scy# client certificate C=US/O=XX/OU=XYZ/OU=ABC/CN=1234), hostapd will reject the
1041346981Scy# client because the order of 'OU' is not matching the specified string in
1042346981Scy# check_cert_subject.
1043346981Scy#
1044346981Scy# This option also allows '*' as a wildcard. This option has some limitation.
1045346981Scy# It can only be used as per the following example.
1046346981Scy#
1047346981Scy# For example, check_cert_subject=C=US/O=XX/OU=Production* and we have two
1048346981Scy# clients and DN of the subject in the first client certificate is
1049346981Scy# (C=US/O=XX/OU=Production Unit) and DN of the subject in the second client is
1050346981Scy# (C=US/O=XX/OU=Production Factory). In this case, hostapd will allow both
1051346981Scy# clients because the value of 'OU' field in both client certificates matches
1052346981Scy# 'OU' value in 'check_cert_subject' up to 'wildcard'.
1053346981Scy#
1054346981Scy# * (Allow all clients, e.g., check_cert_subject=*)
1055346981Scy#check_cert_subject=string
1056346981Scy
1057289549Srpaulo# TLS Session Lifetime in seconds
1058289549Srpaulo# This can be used to allow TLS sessions to be cached and resumed with an
1059289549Srpaulo# abbreviated handshake when using EAP-TLS/TTLS/PEAP.
1060289549Srpaulo# (default: 0 = session caching and resumption disabled)
1061289549Srpaulo#tls_session_lifetime=3600
1062289549Srpaulo
1063346981Scy# TLS flags
1064346981Scy# [ALLOW-SIGN-RSA-MD5] = allow MD5-based certificate signatures (depending on
1065346981Scy#	the TLS library, these may be disabled by default to enforce stronger
1066346981Scy#	security)
1067346981Scy# [DISABLE-TIME-CHECKS] = ignore certificate validity time (this requests
1068346981Scy#	the TLS library to accept certificates even if they are not currently
1069346981Scy#	valid, i.e., have expired or have not yet become valid; this should be
1070346981Scy#	used only for testing purposes)
1071346981Scy# [DISABLE-TLSv1.0] = disable use of TLSv1.0
1072346981Scy# [ENABLE-TLSv1.0] = explicitly enable use of TLSv1.0 (this allows
1073346981Scy#	systemwide TLS policies to be overridden)
1074346981Scy# [DISABLE-TLSv1.1] = disable use of TLSv1.1
1075346981Scy# [ENABLE-TLSv1.1] = explicitly enable use of TLSv1.1 (this allows
1076346981Scy#	systemwide TLS policies to be overridden)
1077346981Scy# [DISABLE-TLSv1.2] = disable use of TLSv1.2
1078346981Scy# [ENABLE-TLSv1.2] = explicitly enable use of TLSv1.2 (this allows
1079346981Scy#	systemwide TLS policies to be overridden)
1080346981Scy# [DISABLE-TLSv1.3] = disable use of TLSv1.3
1081346981Scy# [ENABLE-TLSv1.3] = enable TLSv1.3 (experimental - disabled by default)
1082346981Scy#tls_flags=[flag1][flag2]...
1083346981Scy
1084281806Srpaulo# Cached OCSP stapling response (DER encoded)
1085281806Srpaulo# If set, this file is sent as a certificate status response by the EAP server
1086281806Srpaulo# if the EAP peer requests certificate status in the ClientHello message.
1087281806Srpaulo# This cache file can be updated, e.g., by running following command
1088281806Srpaulo# periodically to get an update from the OCSP responder:
1089281806Srpaulo# openssl ocsp \
1090281806Srpaulo#	-no_nonce \
1091281806Srpaulo#	-CAfile /etc/hostapd.ca.pem \
1092281806Srpaulo#	-issuer /etc/hostapd.ca.pem \
1093281806Srpaulo#	-cert /etc/hostapd.server.pem \
1094281806Srpaulo#	-url http://ocsp.example.com:8888/ \
1095281806Srpaulo#	-respout /tmp/ocsp-cache.der
1096281806Srpaulo#ocsp_stapling_response=/tmp/ocsp-cache.der
1097281806Srpaulo
1098337817Scy# Cached OCSP stapling response list (DER encoded OCSPResponseList)
1099337817Scy# This is similar to ocsp_stapling_response, but the extended version defined in
1100337817Scy# RFC 6961 to allow multiple OCSP responses to be provided.
1101337817Scy#ocsp_stapling_response_multi=/tmp/ocsp-multi-cache.der
1102337817Scy
1103214503Srpaulo# dh_file: File path to DH/DSA parameters file (in PEM format)
1104214503Srpaulo# This is an optional configuration file for setting parameters for an
1105214503Srpaulo# ephemeral DH key exchange. In most cases, the default RSA authentication does
1106214503Srpaulo# not use this configuration. However, it is possible setup RSA to use
1107214503Srpaulo# ephemeral DH key exchange. In addition, ciphers with DSA keys always use
1108214503Srpaulo# ephemeral DH keys. This can be used to achieve forward secrecy. If the file
1109214503Srpaulo# is in DSA parameters format, it will be automatically converted into DH
1110214503Srpaulo# params. This parameter is required if anonymous EAP-FAST is used.
1111214503Srpaulo# You can generate DH parameters file with OpenSSL, e.g.,
1112289549Srpaulo# "openssl dhparam -out /etc/hostapd.dh.pem 2048"
1113214503Srpaulo#dh_file=/etc/hostapd.dh.pem
1114214503Srpaulo
1115281806Srpaulo# OpenSSL cipher string
1116281806Srpaulo#
1117281806Srpaulo# This is an OpenSSL specific configuration option for configuring the default
1118346981Scy# ciphers. If not set, the value configured at build time ("DEFAULT:!EXP:!LOW"
1119346981Scy# by default) is used.
1120281806Srpaulo# See https://www.openssl.org/docs/apps/ciphers.html for OpenSSL documentation
1121281806Srpaulo# on cipher suite configuration. This is applicable only if hostapd is built to
1122281806Srpaulo# use OpenSSL.
1123281806Srpaulo#openssl_ciphers=DEFAULT:!EXP:!LOW
1124281806Srpaulo
1125346981Scy# OpenSSL ECDH curves
1126346981Scy#
1127346981Scy# This is an OpenSSL specific configuration option for configuring the ECDH
1128346981Scy# curves for EAP-TLS/TTLS/PEAP/FAST server. If not set, automatic curve
1129346981Scy# selection is enabled. If set to an empty string, ECDH curve configuration is
1130346981Scy# not done (the exact library behavior depends on the library version).
1131346981Scy# Otherwise, this is a colon separated list of the supported curves (e.g.,
1132346981Scy# P-521:P-384:P-256). This is applicable only if hostapd is built to use
1133346981Scy# OpenSSL. This must not be used for Suite B cases since the same OpenSSL
1134346981Scy# parameter is set differently in those cases and this might conflict with that
1135346981Scy# design.
1136346981Scy#openssl_ecdh_curves=P-521:P-384:P-256
1137346981Scy
1138252726Srpaulo# Fragment size for EAP methods
1139252726Srpaulo#fragment_size=1400
1140252726Srpaulo
1141252726Srpaulo# Finite cyclic group for EAP-pwd. Number maps to group of domain parameters
1142252726Srpaulo# using the IANA repository for IKE (RFC 2409).
1143252726Srpaulo#pwd_group=19
1144252726Srpaulo
1145214503Srpaulo# Configuration data for EAP-SIM database/authentication gateway interface.
1146214503Srpaulo# This is a text string in implementation specific format. The example
1147214503Srpaulo# implementation in eap_sim_db.c uses this as the UNIX domain socket name for
1148214503Srpaulo# the HLR/AuC gateway (e.g., hlr_auc_gw). In this case, the path uses "unix:"
1149252726Srpaulo# prefix. If hostapd is built with SQLite support (CONFIG_SQLITE=y in .config),
1150252726Srpaulo# database file can be described with an optional db=<path> parameter.
1151214503Srpaulo#eap_sim_db=unix:/tmp/hlr_auc_gw.sock
1152252726Srpaulo#eap_sim_db=unix:/tmp/hlr_auc_gw.sock db=/tmp/hostapd.db
1153214503Srpaulo
1154337817Scy# EAP-SIM DB request timeout
1155337817Scy# This parameter sets the maximum time to wait for a database request response.
1156337817Scy# The parameter value is in seconds.
1157337817Scy#eap_sim_db_timeout=1
1158337817Scy
1159214503Srpaulo# Encryption key for EAP-FAST PAC-Opaque values. This key must be a secret,
1160214503Srpaulo# random value. It is configured as a 16-octet value in hex format. It can be
1161214503Srpaulo# generated, e.g., with the following command:
1162214503Srpaulo# od -tx1 -v -N16 /dev/random | colrm 1 8 | tr -d ' '
1163214503Srpaulo#pac_opaque_encr_key=000102030405060708090a0b0c0d0e0f
1164214503Srpaulo
1165214503Srpaulo# EAP-FAST authority identity (A-ID)
1166214503Srpaulo# A-ID indicates the identity of the authority that issues PACs. The A-ID
1167214503Srpaulo# should be unique across all issuing servers. In theory, this is a variable
1168214503Srpaulo# length field, but due to some existing implementations requiring A-ID to be
1169214503Srpaulo# 16 octets in length, it is strongly recommended to use that length for the
1170214503Srpaulo# field to provid interoperability with deployed peer implementations. This
1171214503Srpaulo# field is configured in hex format.
1172214503Srpaulo#eap_fast_a_id=101112131415161718191a1b1c1d1e1f
1173214503Srpaulo
1174214503Srpaulo# EAP-FAST authority identifier information (A-ID-Info)
1175214503Srpaulo# This is a user-friendly name for the A-ID. For example, the enterprise name
1176214503Srpaulo# and server name in a human-readable format. This field is encoded as UTF-8.
1177214503Srpaulo#eap_fast_a_id_info=test server
1178214503Srpaulo
1179214503Srpaulo# Enable/disable different EAP-FAST provisioning modes:
1180214503Srpaulo#0 = provisioning disabled
1181214503Srpaulo#1 = only anonymous provisioning allowed
1182214503Srpaulo#2 = only authenticated provisioning allowed
1183214503Srpaulo#3 = both provisioning modes allowed (default)
1184214503Srpaulo#eap_fast_prov=3
1185214503Srpaulo
1186214503Srpaulo# EAP-FAST PAC-Key lifetime in seconds (hard limit)
1187214503Srpaulo#pac_key_lifetime=604800
1188214503Srpaulo
1189214503Srpaulo# EAP-FAST PAC-Key refresh time in seconds (soft limit on remaining hard
1190214503Srpaulo# limit). The server will generate a new PAC-Key when this number of seconds
1191214503Srpaulo# (or fewer) of the lifetime remains.
1192214503Srpaulo#pac_key_refresh_time=86400
1193214503Srpaulo
1194351611Scy# EAP-TEAP authentication type
1195351611Scy# 0 = inner EAP (default)
1196351611Scy# 1 = Basic-Password-Auth
1197351611Scy#eap_teap_auth=0
1198351611Scy
1199351611Scy# EAP-TEAP authentication behavior when using PAC
1200351611Scy# 0 = perform inner authentication (default)
1201351611Scy# 1 = skip inner authentication (inner EAP/Basic-Password-Auth)
1202351611Scy#eap_teap_pac_no_inner=0
1203351611Scy
1204214503Srpaulo# EAP-SIM and EAP-AKA protected success/failure indication using AT_RESULT_IND
1205214503Srpaulo# (default: 0 = disabled).
1206214503Srpaulo#eap_sim_aka_result_ind=1
1207214503Srpaulo
1208351611Scy# EAP-SIM and EAP-AKA identity options
1209351611Scy# 0 = do not use pseudonyms or fast reauthentication
1210351611Scy# 1 = use pseudonyms, but not fast reauthentication
1211351611Scy# 2 = do not use pseudonyms, but use fast reauthentication
1212351611Scy# 3 = use pseudonyms and use fast reauthentication (default)
1213351611Scy#eap_sim_id=3
1214351611Scy
1215214503Srpaulo# Trusted Network Connect (TNC)
1216214503Srpaulo# If enabled, TNC validation will be required before the peer is allowed to
1217214503Srpaulo# connect. Note: This is only used with EAP-TTLS and EAP-FAST. If any other
1218214503Srpaulo# EAP method is enabled, the peer will be allowed to connect without TNC.
1219214503Srpaulo#tnc=1
1220214503Srpaulo
1221281806Srpaulo# EAP Re-authentication Protocol (ERP) - RFC 6696
1222281806Srpaulo#
1223281806Srpaulo# Whether to enable ERP on the EAP server.
1224281806Srpaulo#eap_server_erp=1
1225214503Srpaulo
1226214503Srpaulo##### IEEE 802.11f - Inter-Access Point Protocol (IAPP) #######################
1227214503Srpaulo
1228214503Srpaulo# Interface to be used for IAPP broadcast packets
1229214503Srpaulo#iapp_interface=eth0
1230214503Srpaulo
1231214503Srpaulo
1232214503Srpaulo##### RADIUS client configuration #############################################
1233214503Srpaulo# for IEEE 802.1X with external Authentication Server, IEEE 802.11
1234214503Srpaulo# authentication with external ACL for MAC addresses, and accounting
1235214503Srpaulo
1236214503Srpaulo# The own IP address of the access point (used as NAS-IP-Address)
1237214503Srpauloown_ip_addr=127.0.0.1
1238214503Srpaulo
1239337817Scy# NAS-Identifier string for RADIUS messages. When used, this should be unique
1240337817Scy# to the NAS within the scope of the RADIUS server. Please note that hostapd
1241337817Scy# uses a separate RADIUS client for each BSS and as such, a unique
1242337817Scy# nas_identifier value should be configured separately for each BSS. This is
1243337817Scy# particularly important for cases where RADIUS accounting is used
1244337817Scy# (Accounting-On/Off messages are interpreted as clearing all ongoing sessions
1245337817Scy# and that may get interpreted as applying to all BSSes if the same
1246337817Scy# NAS-Identifier value is used.) For example, a fully qualified domain name
1247337817Scy# prefixed with a unique identifier of the BSS (e.g., BSSID) can be used here.
1248337817Scy#
1249214503Srpaulo# When using IEEE 802.11r, nas_identifier must be set and must be between 1 and
1250214503Srpaulo# 48 octets long.
1251337817Scy#
1252337817Scy# It is mandatory to configure either own_ip_addr or nas_identifier to be
1253337817Scy# compliant with the RADIUS protocol. When using RADIUS accounting, it is
1254337817Scy# strongly recommended that nas_identifier is set to a unique value for each
1255337817Scy# BSS.
1256214503Srpaulo#nas_identifier=ap.example.com
1257214503Srpaulo
1258281806Srpaulo# RADIUS client forced local IP address for the access point
1259281806Srpaulo# Normally the local IP address is determined automatically based on configured
1260281806Srpaulo# IP addresses, but this field can be used to force a specific address to be
1261281806Srpaulo# used, e.g., when the device has multiple IP addresses.
1262281806Srpaulo#radius_client_addr=127.0.0.1
1263281806Srpaulo
1264214503Srpaulo# RADIUS authentication server
1265214503Srpaulo#auth_server_addr=127.0.0.1
1266214503Srpaulo#auth_server_port=1812
1267214503Srpaulo#auth_server_shared_secret=secret
1268214503Srpaulo
1269214503Srpaulo# RADIUS accounting server
1270214503Srpaulo#acct_server_addr=127.0.0.1
1271214503Srpaulo#acct_server_port=1813
1272214503Srpaulo#acct_server_shared_secret=secret
1273214503Srpaulo
1274214503Srpaulo# Secondary RADIUS servers; to be used if primary one does not reply to
1275214503Srpaulo# RADIUS packets. These are optional and there can be more than one secondary
1276214503Srpaulo# server listed.
1277214503Srpaulo#auth_server_addr=127.0.0.2
1278214503Srpaulo#auth_server_port=1812
1279214503Srpaulo#auth_server_shared_secret=secret2
1280214503Srpaulo#
1281214503Srpaulo#acct_server_addr=127.0.0.2
1282214503Srpaulo#acct_server_port=1813
1283214503Srpaulo#acct_server_shared_secret=secret2
1284214503Srpaulo
1285214503Srpaulo# Retry interval for trying to return to the primary RADIUS server (in
1286214503Srpaulo# seconds). RADIUS client code will automatically try to use the next server
1287214503Srpaulo# when the current server is not replying to requests. If this interval is set,
1288214503Srpaulo# primary server will be retried after configured amount of time even if the
1289214503Srpaulo# currently used secondary server is still working.
1290214503Srpaulo#radius_retry_primary_interval=600
1291214503Srpaulo
1292214503Srpaulo
1293214503Srpaulo# Interim accounting update interval
1294214503Srpaulo# If this is set (larger than 0) and acct_server is configured, hostapd will
1295214503Srpaulo# send interim accounting updates every N seconds. Note: if set, this overrides
1296214503Srpaulo# possible Acct-Interim-Interval attribute in Access-Accept message. Thus, this
1297214503Srpaulo# value should not be configured in hostapd.conf, if RADIUS server is used to
1298214503Srpaulo# control the interim interval.
1299214503Srpaulo# This value should not be less 600 (10 minutes) and must not be less than
1300214503Srpaulo# 60 (1 minute).
1301214503Srpaulo#radius_acct_interim_interval=600
1302214503Srpaulo
1303252726Srpaulo# Request Chargeable-User-Identity (RFC 4372)
1304252726Srpaulo# This parameter can be used to configure hostapd to request CUI from the
1305252726Srpaulo# RADIUS server by including Chargeable-User-Identity attribute into
1306252726Srpaulo# Access-Request packets.
1307252726Srpaulo#radius_request_cui=1
1308252726Srpaulo
1309214503Srpaulo# Dynamic VLAN mode; allow RADIUS authentication server to decide which VLAN
1310214503Srpaulo# is used for the stations. This information is parsed from following RADIUS
1311214503Srpaulo# attributes based on RFC 3580 and RFC 2868: Tunnel-Type (value 13 = VLAN),
1312214503Srpaulo# Tunnel-Medium-Type (value 6 = IEEE 802), Tunnel-Private-Group-ID (value
1313281806Srpaulo# VLANID as a string). Optionally, the local MAC ACL list (accept_mac_file) can
1314281806Srpaulo# be used to set static client MAC address to VLAN ID mapping.
1315346981Scy# Dynamic VLAN mode is also used with VLAN ID assignment based on WPA/WPA2
1316346981Scy# passphrase from wpa_psk_file or vlan_id parameter from sae_password.
1317346981Scy# 0 = disabled (default); only VLAN IDs from accept_mac_file will be used
1318346981Scy# 1 = optional; use default interface if RADIUS server does not include VLAN ID
1319214503Srpaulo# 2 = required; reject authentication if RADIUS server does not include VLAN ID
1320214503Srpaulo#dynamic_vlan=0
1321214503Srpaulo
1322337817Scy# Per-Station AP_VLAN interface mode
1323337817Scy# If enabled, each station is assigned its own AP_VLAN interface.
1324337817Scy# This implies per-station group keying and ebtables filtering of inter-STA
1325337817Scy# traffic (when passed through the AP).
1326337817Scy# If the sta is not assigned to any VLAN, then its AP_VLAN interface will be
1327337817Scy# added to the bridge given by the "bridge" configuration option (see above).
1328337817Scy# Otherwise, it will be added to the per-VLAN bridge.
1329337817Scy# 0 = disabled (default)
1330337817Scy# 1 = enabled
1331337817Scy#per_sta_vif=0
1332337817Scy
1333214503Srpaulo# VLAN interface list for dynamic VLAN mode is read from a separate text file.
1334214503Srpaulo# This list is used to map VLAN ID from the RADIUS server to a network
1335214503Srpaulo# interface. Each station is bound to one interface in the same way as with
1336214503Srpaulo# multiple BSSIDs or SSIDs. Each line in this text file is defining a new
1337214503Srpaulo# interface and the line must include VLAN ID and interface name separated by
1338214503Srpaulo# white space (space or tab).
1339281806Srpaulo# If no entries are provided by this file, the station is statically mapped
1340281806Srpaulo# to <bss-iface>.<vlan-id> interfaces.
1341346981Scy# Each line can optionally also contain the name of a bridge to add the VLAN to
1342214503Srpaulo#vlan_file=/etc/hostapd.vlan
1343214503Srpaulo
1344214503Srpaulo# Interface where 802.1q tagged packets should appear when a RADIUS server is
1345214503Srpaulo# used to determine which VLAN a station is on.  hostapd creates a bridge for
1346214503Srpaulo# each VLAN.  Then hostapd adds a VLAN interface (associated with the interface
1347214503Srpaulo# indicated by 'vlan_tagged_interface') and the appropriate wireless interface
1348214503Srpaulo# to the bridge.
1349214503Srpaulo#vlan_tagged_interface=eth0
1350214503Srpaulo
1351281806Srpaulo# Bridge (prefix) to add the wifi and the tagged interface to. This gets the
1352281806Srpaulo# VLAN ID appended. It defaults to brvlan%d if no tagged interface is given
1353281806Srpaulo# and br%s.%d if a tagged interface is given, provided %s = tagged interface
1354281806Srpaulo# and %d = VLAN ID.
1355281806Srpaulo#vlan_bridge=brvlan
1356281806Srpaulo
1357252726Srpaulo# When hostapd creates a VLAN interface on vlan_tagged_interfaces, it needs
1358252726Srpaulo# to know how to name it.
1359252726Srpaulo# 0 = vlan<XXX>, e.g., vlan1
1360252726Srpaulo# 1 = <vlan_tagged_interface>.<XXX>, e.g. eth0.1
1361252726Srpaulo#vlan_naming=0
1362214503Srpaulo
1363252726Srpaulo# Arbitrary RADIUS attributes can be added into Access-Request and
1364252726Srpaulo# Accounting-Request packets by specifying the contents of the attributes with
1365252726Srpaulo# the following configuration parameters. There can be multiple of these to
1366252726Srpaulo# add multiple attributes. These parameters can also be used to override some
1367252726Srpaulo# of the attributes added automatically by hostapd.
1368252726Srpaulo# Format: <attr_id>[:<syntax:value>]
1369252726Srpaulo# attr_id: RADIUS attribute type (e.g., 26 = Vendor-Specific)
1370252726Srpaulo# syntax: s = string (UTF-8), d = integer, x = octet string
1371252726Srpaulo# value: attribute value in format indicated by the syntax
1372252726Srpaulo# If syntax and value parts are omitted, a null value (single 0x00 octet) is
1373252726Srpaulo# used.
1374252726Srpaulo#
1375252726Srpaulo# Additional Access-Request attributes
1376252726Srpaulo# radius_auth_req_attr=<attr_id>[:<syntax:value>]
1377252726Srpaulo# Examples:
1378252726Srpaulo# Operator-Name = "Operator"
1379252726Srpaulo#radius_auth_req_attr=126:s:Operator
1380252726Srpaulo# Service-Type = Framed (2)
1381252726Srpaulo#radius_auth_req_attr=6:d:2
1382252726Srpaulo# Connect-Info = "testing" (this overrides the automatically generated value)
1383252726Srpaulo#radius_auth_req_attr=77:s:testing
1384252726Srpaulo# Same Connect-Info value set as a hexdump
1385252726Srpaulo#radius_auth_req_attr=77:x:74657374696e67
1386252726Srpaulo
1387252726Srpaulo#
1388252726Srpaulo# Additional Accounting-Request attributes
1389252726Srpaulo# radius_acct_req_attr=<attr_id>[:<syntax:value>]
1390252726Srpaulo# Examples:
1391252726Srpaulo# Operator-Name = "Operator"
1392252726Srpaulo#radius_acct_req_attr=126:s:Operator
1393252726Srpaulo
1394351611Scy# If SQLite support is included, path to a database from which additional
1395351611Scy# RADIUS request attributes are extracted based on the station MAC address.
1396351611Scy#
1397351611Scy# The schema for the radius_attributes table is:
1398351611Scy# id | sta | reqtype | attr   :   multi-key (sta, reqtype)
1399351611Scy# id   = autonumber
1400351611Scy# sta  = station MAC address in `11:22:33:44:55:66` format.
1401351611Scy# type = `auth` | `acct` | NULL (match any)
1402351611Scy# attr = existing config file format, e.g. `126:s:Test Operator`
1403351611Scy#radius_req_attr_sqlite=radius_attr.sqlite
1404351611Scy
1405252726Srpaulo# Dynamic Authorization Extensions (RFC 5176)
1406252726Srpaulo# This mechanism can be used to allow dynamic changes to user session based on
1407252726Srpaulo# commands from a RADIUS server (or some other disconnect client that has the
1408252726Srpaulo# needed session information). For example, Disconnect message can be used to
1409252726Srpaulo# request an associated station to be disconnected.
1410252726Srpaulo#
1411252726Srpaulo# This is disabled by default. Set radius_das_port to non-zero UDP port
1412252726Srpaulo# number to enable.
1413252726Srpaulo#radius_das_port=3799
1414252726Srpaulo#
1415252726Srpaulo# DAS client (the host that can send Disconnect/CoA requests) and shared secret
1416346981Scy# Format: <IP address> <shared secret>
1417346981Scy# IP address 0.0.0.0 can be used to allow requests from any address.
1418252726Srpaulo#radius_das_client=192.168.1.123 shared secret here
1419252726Srpaulo#
1420252726Srpaulo# DAS Event-Timestamp time window in seconds
1421252726Srpaulo#radius_das_time_window=300
1422252726Srpaulo#
1423252726Srpaulo# DAS require Event-Timestamp
1424252726Srpaulo#radius_das_require_event_timestamp=1
1425337817Scy#
1426337817Scy# DAS require Message-Authenticator
1427337817Scy#radius_das_require_message_authenticator=1
1428252726Srpaulo
1429214503Srpaulo##### RADIUS authentication server configuration ##############################
1430214503Srpaulo
1431214503Srpaulo# hostapd can be used as a RADIUS authentication server for other hosts. This
1432214503Srpaulo# requires that the integrated EAP server is also enabled and both
1433214503Srpaulo# authentication services are sharing the same configuration.
1434214503Srpaulo
1435214503Srpaulo# File name of the RADIUS clients configuration for the RADIUS server. If this
1436214503Srpaulo# commented out, RADIUS server is disabled.
1437214503Srpaulo#radius_server_clients=/etc/hostapd.radius_clients
1438214503Srpaulo
1439214503Srpaulo# The UDP port number for the RADIUS authentication server
1440214503Srpaulo#radius_server_auth_port=1812
1441214503Srpaulo
1442281806Srpaulo# The UDP port number for the RADIUS accounting server
1443281806Srpaulo# Commenting this out or setting this to 0 can be used to disable RADIUS
1444281806Srpaulo# accounting while still enabling RADIUS authentication.
1445281806Srpaulo#radius_server_acct_port=1813
1446281806Srpaulo
1447214503Srpaulo# Use IPv6 with RADIUS server (IPv4 will also be supported using IPv6 API)
1448214503Srpaulo#radius_server_ipv6=1
1449214503Srpaulo
1450214503Srpaulo
1451214503Srpaulo##### WPA/IEEE 802.11i configuration ##########################################
1452214503Srpaulo
1453214503Srpaulo# Enable WPA. Setting this variable configures the AP to require WPA (either
1454214503Srpaulo# WPA-PSK or WPA-RADIUS/EAP based on other configuration). For WPA-PSK, either
1455214503Srpaulo# wpa_psk or wpa_passphrase must be set and wpa_key_mgmt must include WPA-PSK.
1456252726Srpaulo# Instead of wpa_psk / wpa_passphrase, wpa_psk_radius might suffice.
1457214503Srpaulo# For WPA-RADIUS/EAP, ieee8021x must be set (but without dynamic WEP keys),
1458214503Srpaulo# RADIUS authentication server must be configured, and WPA-EAP must be included
1459214503Srpaulo# in wpa_key_mgmt.
1460214503Srpaulo# This field is a bit field that can be used to enable WPA (IEEE 802.11i/D3.0)
1461214503Srpaulo# and/or WPA2 (full IEEE 802.11i/RSN):
1462214503Srpaulo# bit0 = WPA
1463214503Srpaulo# bit1 = IEEE 802.11i/RSN (WPA2) (dot11RSNAEnabled)
1464346981Scy# Note that WPA3 is also configured with bit1 since it uses RSN just like WPA2.
1465346981Scy# In other words, for WPA3, wpa=2 is used the configuration (and
1466346981Scy# wpa_key_mgmt=SAE for WPA3-Personal instead of wpa_key_mgmt=WPA-PSK).
1467346981Scy#wpa=2
1468214503Srpaulo
1469214503Srpaulo# WPA pre-shared keys for WPA-PSK. This can be either entered as a 256-bit
1470214503Srpaulo# secret in hex format (64 hex digits), wpa_psk, or as an ASCII passphrase
1471214503Srpaulo# (8..63 characters) that will be converted to PSK. This conversion uses SSID
1472214503Srpaulo# so the PSK changes when ASCII passphrase is used and the SSID is changed.
1473214503Srpaulo# wpa_psk (dot11RSNAConfigPSKValue)
1474214503Srpaulo# wpa_passphrase (dot11RSNAConfigPSKPassPhrase)
1475214503Srpaulo#wpa_psk=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
1476214503Srpaulo#wpa_passphrase=secret passphrase
1477214503Srpaulo
1478214503Srpaulo# Optionally, WPA PSKs can be read from a separate text file (containing list
1479214503Srpaulo# of (PSK,MAC address) pairs. This allows more than one PSK to be configured.
1480214503Srpaulo# Use absolute path name to make sure that the files can be read on SIGHUP
1481214503Srpaulo# configuration reloads.
1482214503Srpaulo#wpa_psk_file=/etc/hostapd.wpa_psk
1483214503Srpaulo
1484252726Srpaulo# Optionally, WPA passphrase can be received from RADIUS authentication server
1485252726Srpaulo# This requires macaddr_acl to be set to 2 (RADIUS)
1486252726Srpaulo# 0 = disabled (default)
1487252726Srpaulo# 1 = optional; use default passphrase/psk if RADIUS server does not include
1488252726Srpaulo#	Tunnel-Password
1489252726Srpaulo# 2 = required; reject authentication if RADIUS server does not include
1490252726Srpaulo#	Tunnel-Password
1491252726Srpaulo#wpa_psk_radius=0
1492252726Srpaulo
1493214503Srpaulo# Set of accepted key management algorithms (WPA-PSK, WPA-EAP, or both). The
1494214503Srpaulo# entries are separated with a space. WPA-PSK-SHA256 and WPA-EAP-SHA256 can be
1495214503Srpaulo# added to enable SHA256-based stronger algorithms.
1496346981Scy# WPA-PSK = WPA-Personal / WPA2-Personal
1497346981Scy# WPA-PSK-SHA256 = WPA2-Personal using SHA256
1498346981Scy# WPA-EAP = WPA-Enterprise / WPA2-Enterprise
1499346981Scy# WPA-EAP-SHA256 = WPA2-Enterprise using SHA256
1500346981Scy# SAE = SAE (WPA3-Personal)
1501346981Scy# WPA-EAP-SUITE-B-192 = WPA3-Enterprise with 192-bit security/CNSA suite
1502346981Scy# FT-PSK = FT with passphrase/PSK
1503346981Scy# FT-EAP = FT with EAP
1504346981Scy# FT-EAP-SHA384 = FT with EAP using SHA384
1505346981Scy# FT-SAE = FT with SAE
1506346981Scy# FILS-SHA256 = Fast Initial Link Setup with SHA256
1507346981Scy# FILS-SHA384 = Fast Initial Link Setup with SHA384
1508346981Scy# FT-FILS-SHA256 = FT and Fast Initial Link Setup with SHA256
1509346981Scy# FT-FILS-SHA384 = FT and Fast Initial Link Setup with SHA384
1510346981Scy# OWE = Opportunistic Wireless Encryption (a.k.a. Enhanced Open)
1511346981Scy# DPP = Device Provisioning Protocol
1512346981Scy# OSEN = Hotspot 2.0 online signup with encryption
1513214503Srpaulo# (dot11RSNAConfigAuthenticationSuitesTable)
1514214503Srpaulo#wpa_key_mgmt=WPA-PSK WPA-EAP
1515214503Srpaulo
1516214503Srpaulo# Set of accepted cipher suites (encryption algorithms) for pairwise keys
1517214503Srpaulo# (unicast packets). This is a space separated list of algorithms:
1518346981Scy# CCMP = AES in Counter mode with CBC-MAC (CCMP-128)
1519346981Scy# TKIP = Temporal Key Integrity Protocol
1520346981Scy# CCMP-256 = AES in Counter mode with CBC-MAC with 256-bit key
1521346981Scy# GCMP = Galois/counter mode protocol (GCMP-128)
1522346981Scy# GCMP-256 = Galois/counter mode protocol with 256-bit key
1523214503Srpaulo# Group cipher suite (encryption algorithm for broadcast and multicast frames)
1524214503Srpaulo# is automatically selected based on this configuration. If only CCMP is
1525214503Srpaulo# allowed as the pairwise cipher, group cipher will also be CCMP. Otherwise,
1526346981Scy# TKIP will be used as the group cipher. The optional group_cipher parameter can
1527346981Scy# be used to override this automatic selection.
1528346981Scy#
1529214503Srpaulo# (dot11RSNAConfigPairwiseCiphersTable)
1530214503Srpaulo# Pairwise cipher for WPA (v1) (default: TKIP)
1531214503Srpaulo#wpa_pairwise=TKIP CCMP
1532214503Srpaulo# Pairwise cipher for RSN/WPA2 (default: use wpa_pairwise value)
1533214503Srpaulo#rsn_pairwise=CCMP
1534214503Srpaulo
1535346981Scy# Optional override for automatic group cipher selection
1536346981Scy# This can be used to select a specific group cipher regardless of which
1537346981Scy# pairwise ciphers were enabled for WPA and RSN. It should be noted that
1538346981Scy# overriding the group cipher with an unexpected value can result in
1539346981Scy# interoperability issues and in general, this parameter is mainly used for
1540346981Scy# testing purposes.
1541346981Scy#group_cipher=CCMP
1542346981Scy
1543214503Srpaulo# Time interval for rekeying GTK (broadcast/multicast encryption keys) in
1544214503Srpaulo# seconds. (dot11RSNAConfigGroupRekeyTime)
1545346981Scy# This defaults to 86400 seconds (once per day) when using CCMP/GCMP as the
1546346981Scy# group cipher and 600 seconds (once per 10 minutes) when using TKIP as the
1547346981Scy# group cipher.
1548346981Scy#wpa_group_rekey=86400
1549214503Srpaulo
1550214503Srpaulo# Rekey GTK when any STA that possesses the current GTK is leaving the BSS.
1551214503Srpaulo# (dot11RSNAConfigGroupRekeyStrict)
1552214503Srpaulo#wpa_strict_rekey=1
1553214503Srpaulo
1554346981Scy# The number of times EAPOL-Key Message 1/2 in the RSN Group Key Handshake is
1555346981Scy#retried per GTK Handshake attempt. (dot11RSNAConfigGroupUpdateCount)
1556346981Scy# This value should only be increased when stations are constantly
1557346981Scy# deauthenticated during GTK rekeying with the log message
1558346981Scy# "group key handshake failed...".
1559346981Scy# You should consider to also increase wpa_pairwise_update_count then.
1560346981Scy# Range 1..4294967295; default: 4
1561346981Scy#wpa_group_update_count=4
1562346981Scy
1563214503Srpaulo# Time interval for rekeying GMK (master key used internally to generate GTKs
1564214503Srpaulo# (in seconds).
1565214503Srpaulo#wpa_gmk_rekey=86400
1566214503Srpaulo
1567214503Srpaulo# Maximum lifetime for PTK in seconds. This can be used to enforce rekeying of
1568214503Srpaulo# PTK to mitigate some attacks against TKIP deficiencies.
1569214503Srpaulo#wpa_ptk_rekey=600
1570214503Srpaulo
1571346981Scy# The number of times EAPOL-Key Message 1/4 and Message 3/4 in the RSN 4-Way
1572346981Scy# Handshake are retried per 4-Way Handshake attempt.
1573346981Scy# (dot11RSNAConfigPairwiseUpdateCount)
1574346981Scy# Range 1..4294967295; default: 4
1575346981Scy#wpa_pairwise_update_count=4
1576346981Scy
1577346981Scy# Workaround for key reinstallation attacks
1578346981Scy#
1579346981Scy# This parameter can be used to disable retransmission of EAPOL-Key frames that
1580346981Scy# are used to install keys (EAPOL-Key message 3/4 and group message 1/2). This
1581346981Scy# is similar to setting wpa_group_update_count=1 and
1582346981Scy# wpa_pairwise_update_count=1, but with no impact to message 1/4 and with
1583346981Scy# extended timeout on the response to avoid causing issues with stations that
1584346981Scy# may use aggressive power saving have very long time in replying to the
1585346981Scy# EAPOL-Key messages.
1586346981Scy#
1587346981Scy# This option can be used to work around key reinstallation attacks on the
1588346981Scy# station (supplicant) side in cases those station devices cannot be updated
1589346981Scy# for some reason. By removing the retransmissions the attacker cannot cause
1590346981Scy# key reinstallation with a delayed frame transmission. This is related to the
1591346981Scy# station side vulnerabilities CVE-2017-13077, CVE-2017-13078, CVE-2017-13079,
1592346981Scy# CVE-2017-13080, and CVE-2017-13081.
1593346981Scy#
1594346981Scy# This workaround might cause interoperability issues and reduced robustness of
1595346981Scy# key negotiation especially in environments with heavy traffic load due to the
1596346981Scy# number of attempts to perform the key exchange is reduced significantly. As
1597346981Scy# such, this workaround is disabled by default (unless overridden in build
1598346981Scy# configuration). To enable this, set the parameter to 1.
1599346981Scy#wpa_disable_eapol_key_retries=1
1600346981Scy
1601214503Srpaulo# Enable IEEE 802.11i/RSN/WPA2 pre-authentication. This is used to speed up
1602214503Srpaulo# roaming be pre-authenticating IEEE 802.1X/EAP part of the full RSN
1603214503Srpaulo# authentication and key handshake before actually associating with a new AP.
1604214503Srpaulo# (dot11RSNAPreauthenticationEnabled)
1605214503Srpaulo#rsn_preauth=1
1606214503Srpaulo#
1607214503Srpaulo# Space separated list of interfaces from which pre-authentication frames are
1608214503Srpaulo# accepted (e.g., 'eth0' or 'eth0 wlan0wds0'. This list should include all
1609214503Srpaulo# interface that are used for connections to other APs. This could include
1610214503Srpaulo# wired interfaces and WDS links. The normal wireless data interface towards
1611214503Srpaulo# associated stations (e.g., wlan0) should not be added, since
1612214503Srpaulo# pre-authentication is only used with APs other than the currently associated
1613214503Srpaulo# one.
1614214503Srpaulo#rsn_preauth_interfaces=eth0
1615214503Srpaulo
1616214503Srpaulo# ieee80211w: Whether management frame protection (MFP) is enabled
1617214503Srpaulo# 0 = disabled (default)
1618214503Srpaulo# 1 = optional
1619214503Srpaulo# 2 = required
1620214503Srpaulo#ieee80211w=0
1621214503Srpaulo
1622281806Srpaulo# Group management cipher suite
1623281806Srpaulo# Default: AES-128-CMAC (BIP)
1624281806Srpaulo# Other options (depending on driver support):
1625281806Srpaulo# BIP-GMAC-128
1626281806Srpaulo# BIP-GMAC-256
1627281806Srpaulo# BIP-CMAC-256
1628281806Srpaulo# Note: All the stations connecting to the BSS will also need to support the
1629281806Srpaulo# selected cipher. The default AES-128-CMAC is the only option that is commonly
1630281806Srpaulo# available in deployed devices.
1631281806Srpaulo#group_mgmt_cipher=AES-128-CMAC
1632281806Srpaulo
1633214503Srpaulo# Association SA Query maximum timeout (in TU = 1.024 ms; for MFP)
1634214503Srpaulo# (maximum time to wait for a SA Query response)
1635214503Srpaulo# dot11AssociationSAQueryMaximumTimeout, 1...4294967295
1636214503Srpaulo#assoc_sa_query_max_timeout=1000
1637214503Srpaulo
1638214503Srpaulo# Association SA Query retry timeout (in TU = 1.024 ms; for MFP)
1639214503Srpaulo# (time between two subsequent SA Query requests)
1640214503Srpaulo# dot11AssociationSAQueryRetryTimeout, 1...4294967295
1641214503Srpaulo#assoc_sa_query_retry_timeout=201
1642214503Srpaulo
1643346981Scy# ocv: Operating Channel Validation
1644346981Scy# This is a countermeasure against multi-channel man-in-the-middle attacks.
1645346981Scy# Enabling this automatically also enables ieee80211w, if not yet enabled.
1646346981Scy# 0 = disabled (default)
1647346981Scy# 1 = enabled
1648346981Scy#ocv=1
1649346981Scy
1650252726Srpaulo# disable_pmksa_caching: Disable PMKSA caching
1651252726Srpaulo# This parameter can be used to disable caching of PMKSA created through EAP
1652252726Srpaulo# authentication. RSN preauthentication may still end up using PMKSA caching if
1653252726Srpaulo# it is enabled (rsn_preauth=1).
1654252726Srpaulo# 0 = PMKSA caching enabled (default)
1655252726Srpaulo# 1 = PMKSA caching disabled
1656252726Srpaulo#disable_pmksa_caching=0
1657214503Srpaulo
1658214503Srpaulo# okc: Opportunistic Key Caching (aka Proactive Key Caching)
1659214503Srpaulo# Allow PMK cache to be shared opportunistically among configured interfaces
1660214503Srpaulo# and BSSes (i.e., all configurations within a single hostapd process).
1661214503Srpaulo# 0 = disabled (default)
1662214503Srpaulo# 1 = enabled
1663214503Srpaulo#okc=1
1664214503Srpaulo
1665346981Scy# SAE password
1666346981Scy# This parameter can be used to set passwords for SAE. By default, the
1667346981Scy# wpa_passphrase value is used if this separate parameter is not used, but
1668346981Scy# wpa_passphrase follows the WPA-PSK constraints (8..63 characters) even though
1669346981Scy# SAE passwords do not have such constraints. If the BSS enabled both SAE and
1670346981Scy# WPA-PSK and both values are set, SAE uses the sae_password values and WPA-PSK
1671346981Scy# uses the wpa_passphrase value.
1672346981Scy#
1673346981Scy# Each sae_password entry is added to a list of available passwords. This
1674346981Scy# corresponds to the dot11RSNAConfigPasswordValueEntry. sae_password value
1675346981Scy# starts with the password (dot11RSNAConfigPasswordCredential). That value can
1676346981Scy# be followed by optional peer MAC address (dot11RSNAConfigPasswordPeerMac) and
1677346981Scy# by optional password identifier (dot11RSNAConfigPasswordIdentifier). In
1678346981Scy# addition, an optional VLAN ID specification can be used to bind the station
1679346981Scy# to the specified VLAN whenver the specific SAE password entry is used.
1680346981Scy#
1681346981Scy# If the peer MAC address is not included or is set to the wildcard address
1682346981Scy# (ff:ff:ff:ff:ff:ff), the entry is available for any station to use. If a
1683346981Scy# specific peer MAC address is included, only a station with that MAC address
1684346981Scy# is allowed to use the entry.
1685346981Scy#
1686346981Scy# If the password identifier (with non-zero length) is included, the entry is
1687346981Scy# limited to be used only with that specified identifier.
1688346981Scy
1689346981Scy# The last matching (based on peer MAC address and identifier) entry is used to
1690346981Scy# select which password to use. Setting sae_password to an empty string has a
1691346981Scy# special meaning of removing all previously added entries.
1692346981Scy#
1693346981Scy# sae_password uses the following encoding:
1694346981Scy#<password/credential>[|mac=<peer mac>][|vlanid=<VLAN ID>][|id=<identifier>]
1695346981Scy# Examples:
1696346981Scy#sae_password=secret
1697346981Scy#sae_password=really secret|mac=ff:ff:ff:ff:ff:ff
1698346981Scy#sae_password=example secret|mac=02:03:04:05:06:07|id=pw identifier
1699346981Scy#sae_password=example secret|vlanid=3|id=pw identifier
1700346981Scy
1701281806Srpaulo# SAE threshold for anti-clogging mechanism (dot11RSNASAEAntiCloggingThreshold)
1702281806Srpaulo# This parameter defines how many open SAE instances can be in progress at the
1703281806Srpaulo# same time before the anti-clogging mechanism is taken into use.
1704281806Srpaulo#sae_anti_clogging_threshold=5
1705214503Srpaulo
1706346981Scy# Maximum number of SAE synchronization errors (dot11RSNASAESync)
1707346981Scy# The offending SAe peer will be disconnected if more than this many
1708346981Scy# synchronization errors happen.
1709346981Scy#sae_sync=5
1710346981Scy
1711281806Srpaulo# Enabled SAE finite cyclic groups
1712281806Srpaulo# SAE implementation are required to support group 19 (ECC group defined over a
1713346981Scy# 256-bit prime order field). This configuration parameter can be used to
1714346981Scy# specify a set of allowed groups. If not included, only the mandatory group 19
1715346981Scy# is enabled.
1716346981Scy# The group values are listed in the IANA registry:
1717346981Scy# http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-9
1718346981Scy# Note that groups 1, 2, 5, 22, 23, and 24 should not be used in production
1719346981Scy# purposes due limited security (see RFC 8247). Groups that are not as strong as
1720346981Scy# group 19 (ECC, NIST P-256) are unlikely to be useful for production use cases
1721346981Scy# since all implementations are required to support group 19.
1722346981Scy#sae_groups=19 20 21
1723346981Scy
1724346981Scy# Require MFP for all associations using SAE
1725346981Scy# This parameter can be used to enforce negotiation of MFP for all associations
1726346981Scy# that negotiate use of SAE. This is used in cases where SAE-capable devices are
1727346981Scy# known to be MFP-capable and the BSS is configured with optional MFP
1728346981Scy# (ieee80211w=1) for legacy support. The non-SAE stations can connect without
1729346981Scy# MFP while SAE stations are required to negotiate MFP if sae_require_mfp=1.
1730346981Scy#sae_require_mfp=0
1731346981Scy
1732346981Scy# FILS Cache Identifier (16-bit value in hexdump format)
1733346981Scy#fils_cache_id=0011
1734346981Scy
1735346981Scy# FILS Realm Information
1736346981Scy# One or more FILS realms need to be configured when FILS is enabled. This list
1737346981Scy# of realms is used to define which realms (used in keyName-NAI by the client)
1738346981Scy# can be used with FILS shared key authentication for ERP.
1739346981Scy#fils_realm=example.com
1740346981Scy#fils_realm=example.org
1741346981Scy
1742346981Scy# FILS DH Group for PFS
1743346981Scy# 0 = PFS disabled with FILS shared key authentication (default)
1744346981Scy# 1-65535 DH Group to use for FILS PFS
1745346981Scy#fils_dh_group=0
1746346981Scy
1747346981Scy# OWE DH groups
1748346981Scy# OWE implementations are required to support group 19 (NIST P-256). All groups
1749346981Scy# that are supported by the implementation (e.g., groups 19, 20, and 21 when
1750346981Scy# using OpenSSL) are enabled by default. This configuration parameter can be
1751281806Srpaulo# used to specify a limited set of allowed groups. The group values are listed
1752281806Srpaulo# in the IANA registry:
1753346981Scy# http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-10
1754346981Scy#owe_groups=19 20 21
1755281806Srpaulo
1756346981Scy# OWE transition mode configuration
1757346981Scy# Pointer to the matching open/OWE BSS
1758346981Scy#owe_transition_bssid=<bssid>
1759346981Scy# SSID in same format as ssid2 described above.
1760346981Scy#owe_transition_ssid=<SSID>
1761346981Scy# Alternatively, OWE transition mode BSSID/SSID can be configured with a
1762346981Scy# reference to a BSS operated by this hostapd process.
1763346981Scy#owe_transition_ifname=<ifname>
1764346981Scy
1765346981Scy# DHCP server for FILS HLP
1766346981Scy# If configured, hostapd will act as a DHCP relay for all FILS HLP requests
1767346981Scy# that include a DHCPDISCOVER message and send them to the specific DHCP
1768346981Scy# server for processing. hostapd will then wait for a response from that server
1769346981Scy# before replying with (Re)Association Response frame that encapsulates this
1770346981Scy# DHCP response. own_ip_addr is used as the local address for the communication
1771346981Scy# with the DHCP server.
1772346981Scy#dhcp_server=127.0.0.1
1773346981Scy
1774346981Scy# DHCP server UDP port
1775346981Scy# Default: 67
1776346981Scy#dhcp_server_port=67
1777346981Scy
1778346981Scy# DHCP relay UDP port on the local device
1779346981Scy# Default: 67; 0 means not to bind any specific port
1780346981Scy#dhcp_relay_port=67
1781346981Scy
1782346981Scy# DHCP rapid commit proxy
1783346981Scy# If set to 1, this enables hostapd to act as a DHCP rapid commit proxy to
1784346981Scy# allow the rapid commit options (two message DHCP exchange) to be used with a
1785346981Scy# server that supports only the four message DHCP exchange. This is disabled by
1786346981Scy# default (= 0) and can be enabled by setting this to 1.
1787346981Scy#dhcp_rapid_commit_proxy=0
1788346981Scy
1789346981Scy# Wait time for FILS HLP (dot11HLPWaitTime) in TUs
1790346981Scy# default: 30 TUs (= 30.72 milliseconds)
1791346981Scy#fils_hlp_wait_time=30
1792346981Scy
1793214503Srpaulo##### IEEE 802.11r configuration ##############################################
1794214503Srpaulo
1795214503Srpaulo# Mobility Domain identifier (dot11FTMobilityDomainID, MDID)
1796214503Srpaulo# MDID is used to indicate a group of APs (within an ESS, i.e., sharing the
1797214503Srpaulo# same SSID) between which a STA can use Fast BSS Transition.
1798214503Srpaulo# 2-octet identifier as a hex string.
1799214503Srpaulo#mobility_domain=a1b2
1800214503Srpaulo
1801214503Srpaulo# PMK-R0 Key Holder identifier (dot11FTR0KeyHolderID)
1802214503Srpaulo# 1 to 48 octet identifier.
1803214503Srpaulo# This is configured with nas_identifier (see RADIUS client section above).
1804214503Srpaulo
1805346981Scy# Default lifetime of the PMK-R0 in seconds; range 60..4294967295
1806346981Scy# (default: 14 days / 1209600 seconds; 0 = disable timeout)
1807214503Srpaulo# (dot11FTR0KeyLifetime)
1808346981Scy#ft_r0_key_lifetime=1209600
1809214503Srpaulo
1810346981Scy# Maximum lifetime for PMK-R1; applied only if not zero
1811346981Scy# PMK-R1 is removed at latest after this limit.
1812346981Scy# Removing any PMK-R1 for expiry can be disabled by setting this to -1.
1813346981Scy# (default: 0)
1814346981Scy#r1_max_key_lifetime=0
1815346981Scy
1816214503Srpaulo# PMK-R1 Key Holder identifier (dot11FTR1KeyHolderID)
1817214503Srpaulo# 6-octet identifier as a hex string.
1818337817Scy# Defaults to BSSID.
1819214503Srpaulo#r1_key_holder=000102030405
1820214503Srpaulo
1821214503Srpaulo# Reassociation deadline in time units (TUs / 1.024 ms; range 1000..65535)
1822214503Srpaulo# (dot11FTReassociationDeadline)
1823214503Srpaulo#reassociation_deadline=1000
1824214503Srpaulo
1825214503Srpaulo# List of R0KHs in the same Mobility Domain
1826346981Scy# format: <MAC address> <NAS Identifier> <256-bit key as hex string>
1827214503Srpaulo# This list is used to map R0KH-ID (NAS Identifier) to a destination MAC
1828214503Srpaulo# address when requesting PMK-R1 key from the R0KH that the STA used during the
1829214503Srpaulo# Initial Mobility Domain Association.
1830346981Scy#r0kh=02:01:02:03:04:05 r0kh-1.example.com 000102030405060708090a0b0c0d0e0f000102030405060708090a0b0c0d0e0f
1831346981Scy#r0kh=02:01:02:03:04:06 r0kh-2.example.com 00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff
1832214503Srpaulo# And so on.. One line per R0KH.
1833346981Scy# Wildcard entry:
1834346981Scy# Upon receiving a response from R0KH, it will be added to this list, so
1835346981Scy# subsequent requests won't be broadcast. If R0KH does not reply, it will be
1836346981Scy# blacklisted.
1837346981Scy#r0kh=ff:ff:ff:ff:ff:ff * 00112233445566778899aabbccddeeff
1838214503Srpaulo
1839214503Srpaulo# List of R1KHs in the same Mobility Domain
1840346981Scy# format: <MAC address> <R1KH-ID> <256-bit key as hex string>
1841214503Srpaulo# This list is used to map R1KH-ID to a destination MAC address when sending
1842214503Srpaulo# PMK-R1 key from the R0KH. This is also the list of authorized R1KHs in the MD
1843214503Srpaulo# that can request PMK-R1 keys.
1844346981Scy#r1kh=02:01:02:03:04:05 02:11:22:33:44:55 000102030405060708090a0b0c0d0e0f000102030405060708090a0b0c0d0e0f
1845346981Scy#r1kh=02:01:02:03:04:06 02:11:22:33:44:66 00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff
1846214503Srpaulo# And so on.. One line per R1KH.
1847346981Scy# Wildcard entry:
1848346981Scy# Upon receiving a request from an R1KH not yet known, it will be added to this
1849346981Scy# list and thus will receive push notifications.
1850346981Scy#r1kh=00:00:00:00:00:00 00:00:00:00:00:00 00112233445566778899aabbccddeeff
1851214503Srpaulo
1852346981Scy# Timeout (seconds) for newly discovered R0KH/R1KH (see wildcard entries above)
1853346981Scy# Special values: 0 -> do not expire
1854346981Scy# Warning: do not cache implies no sequence number validation with wildcards
1855346981Scy#rkh_pos_timeout=86400 (default = 1 day)
1856346981Scy
1857346981Scy# Timeout (milliseconds) for requesting PMK-R1 from R0KH using PULL request
1858346981Scy# and number of retries.
1859346981Scy#rkh_pull_timeout=1000 (default = 1 second)
1860346981Scy#rkh_pull_retries=4 (default)
1861346981Scy
1862346981Scy# Timeout (seconds) for non replying R0KH (see wildcard entries above)
1863346981Scy# Special values: 0 -> do not cache
1864346981Scy# default: 60 seconds
1865346981Scy#rkh_neg_timeout=60
1866346981Scy
1867346981Scy# Note: The R0KH/R1KH keys used to be 128-bit in length before the message
1868346981Scy# format was changed. That shorter key length is still supported for backwards
1869346981Scy# compatibility of the configuration files. If such a shorter key is used, a
1870346981Scy# 256-bit key is derived from it. For new deployments, configuring the 256-bit
1871346981Scy# key is recommended.
1872346981Scy
1873214503Srpaulo# Whether PMK-R1 push is enabled at R0KH
1874214503Srpaulo# 0 = do not push PMK-R1 to all configured R1KHs (default)
1875214503Srpaulo# 1 = push PMK-R1 to all configured R1KHs whenever a new PMK-R0 is derived
1876214503Srpaulo#pmk_r1_push=1
1877214503Srpaulo
1878289549Srpaulo# Whether to enable FT-over-DS
1879289549Srpaulo# 0 = FT-over-DS disabled
1880289549Srpaulo# 1 = FT-over-DS enabled (default)
1881289549Srpaulo#ft_over_ds=1
1882289549Srpaulo
1883346981Scy# Whether to generate FT response locally for PSK networks
1884346981Scy# This avoids use of PMK-R1 push/pull from other APs with FT-PSK networks as
1885346981Scy# the required information (PSK and other session data) is already locally
1886346981Scy# available.
1887346981Scy# 0 = disabled (default)
1888346981Scy# 1 = enabled
1889346981Scy#ft_psk_generate_local=0
1890346981Scy
1891214503Srpaulo##### Neighbor table ##########################################################
1892214503Srpaulo# Maximum number of entries kept in AP table (either for neigbor table or for
1893214503Srpaulo# detecting Overlapping Legacy BSS Condition). The oldest entry will be
1894214503Srpaulo# removed when adding a new entry that would make the list grow over this
1895214503Srpaulo# limit. Note! WFA certification for IEEE 802.11g requires that OLBC is
1896214503Srpaulo# enabled, so this field should not be set to 0 when using IEEE 802.11g.
1897214503Srpaulo# default: 255
1898214503Srpaulo#ap_table_max_size=255
1899214503Srpaulo
1900214503Srpaulo# Number of seconds of no frames received after which entries may be deleted
1901214503Srpaulo# from the AP table. Since passive scanning is not usually performed frequently
1902214503Srpaulo# this should not be set to very small value. In addition, there is no
1903214503Srpaulo# guarantee that every scan cycle will receive beacon frames from the
1904214503Srpaulo# neighboring APs.
1905214503Srpaulo# default: 60
1906214503Srpaulo#ap_table_expiration_time=3600
1907214503Srpaulo
1908289549Srpaulo# Maximum number of stations to track on the operating channel
1909289549Srpaulo# This can be used to detect dualband capable stations before they have
1910289549Srpaulo# associated, e.g., to provide guidance on which colocated BSS to use.
1911289549Srpaulo# Default: 0 (disabled)
1912289549Srpaulo#track_sta_max_num=100
1913214503Srpaulo
1914289549Srpaulo# Maximum age of a station tracking entry in seconds
1915289549Srpaulo# Default: 180
1916289549Srpaulo#track_sta_max_age=180
1917289549Srpaulo
1918289549Srpaulo# Do not reply to group-addressed Probe Request from a station that was seen on
1919289549Srpaulo# another radio.
1920289549Srpaulo# Default: Disabled
1921289549Srpaulo#
1922289549Srpaulo# This can be used with enabled track_sta_max_num configuration on another
1923289549Srpaulo# interface controlled by the same hostapd process to restrict Probe Request
1924289549Srpaulo# frame handling from replying to group-addressed Probe Request frames from a
1925289549Srpaulo# station that has been detected to be capable of operating on another band,
1926289549Srpaulo# e.g., to try to reduce likelihood of the station selecting a 2.4 GHz BSS when
1927289549Srpaulo# the AP operates both a 2.4 GHz and 5 GHz BSS concurrently.
1928289549Srpaulo#
1929289549Srpaulo# Note: Enabling this can cause connectivity issues and increase latency for
1930289549Srpaulo# discovering the AP.
1931289549Srpaulo#no_probe_resp_if_seen_on=wlan1
1932289549Srpaulo
1933289549Srpaulo# Reject authentication from a station that was seen on another radio.
1934289549Srpaulo# Default: Disabled
1935289549Srpaulo#
1936289549Srpaulo# This can be used with enabled track_sta_max_num configuration on another
1937289549Srpaulo# interface controlled by the same hostapd process to reject authentication
1938289549Srpaulo# attempts from a station that has been detected to be capable of operating on
1939289549Srpaulo# another band, e.g., to try to reduce likelihood of the station selecting a
1940289549Srpaulo# 2.4 GHz BSS when the AP operates both a 2.4 GHz and 5 GHz BSS concurrently.
1941289549Srpaulo#
1942289549Srpaulo# Note: Enabling this can cause connectivity issues and increase latency for
1943289549Srpaulo# connecting with the AP.
1944289549Srpaulo#no_auth_if_seen_on=wlan1
1945289549Srpaulo
1946214503Srpaulo##### Wi-Fi Protected Setup (WPS) #############################################
1947214503Srpaulo
1948214503Srpaulo# WPS state
1949214503Srpaulo# 0 = WPS disabled (default)
1950214503Srpaulo# 1 = WPS enabled, not configured
1951214503Srpaulo# 2 = WPS enabled, configured
1952214503Srpaulo#wps_state=2
1953214503Srpaulo
1954281806Srpaulo# Whether to manage this interface independently from other WPS interfaces
1955281806Srpaulo# By default, a single hostapd process applies WPS operations to all configured
1956281806Srpaulo# interfaces. This parameter can be used to disable that behavior for a subset
1957281806Srpaulo# of interfaces. If this is set to non-zero for an interface, WPS commands
1958281806Srpaulo# issued on that interface do not apply to other interfaces and WPS operations
1959281806Srpaulo# performed on other interfaces do not affect this interface.
1960281806Srpaulo#wps_independent=0
1961281806Srpaulo
1962214503Srpaulo# AP can be configured into a locked state where new WPS Registrar are not
1963214503Srpaulo# accepted, but previously authorized Registrars (including the internal one)
1964214503Srpaulo# can continue to add new Enrollees.
1965214503Srpaulo#ap_setup_locked=1
1966214503Srpaulo
1967214503Srpaulo# Universally Unique IDentifier (UUID; see RFC 4122) of the device
1968214503Srpaulo# This value is used as the UUID for the internal WPS Registrar. If the AP
1969214503Srpaulo# is also using UPnP, this value should be set to the device's UPnP UUID.
1970214503Srpaulo# If not configured, UUID will be generated based on the local MAC address.
1971214503Srpaulo#uuid=12345678-9abc-def0-1234-56789abcdef0
1972214503Srpaulo
1973214503Srpaulo# Note: If wpa_psk_file is set, WPS is used to generate random, per-device PSKs
1974214503Srpaulo# that will be appended to the wpa_psk_file. If wpa_psk_file is not set, the
1975214503Srpaulo# default PSK (wpa_psk/wpa_passphrase) will be delivered to Enrollees. Use of
1976214503Srpaulo# per-device PSKs is recommended as the more secure option (i.e., make sure to
1977214503Srpaulo# set wpa_psk_file when using WPS with WPA-PSK).
1978214503Srpaulo
1979214503Srpaulo# When an Enrollee requests access to the network with PIN method, the Enrollee
1980214503Srpaulo# PIN will need to be entered for the Registrar. PIN request notifications are
1981214503Srpaulo# sent to hostapd ctrl_iface monitor. In addition, they can be written to a
1982214503Srpaulo# text file that could be used, e.g., to populate the AP administration UI with
1983214503Srpaulo# pending PIN requests. If the following variable is set, the PIN requests will
1984214503Srpaulo# be written to the configured file.
1985214503Srpaulo#wps_pin_requests=/var/run/hostapd_wps_pin_requests
1986214503Srpaulo
1987214503Srpaulo# Device Name
1988214503Srpaulo# User-friendly description of device; up to 32 octets encoded in UTF-8
1989214503Srpaulo#device_name=Wireless AP
1990214503Srpaulo
1991214503Srpaulo# Manufacturer
1992214503Srpaulo# The manufacturer of the device (up to 64 ASCII characters)
1993214503Srpaulo#manufacturer=Company
1994214503Srpaulo
1995214503Srpaulo# Model Name
1996214503Srpaulo# Model of the device (up to 32 ASCII characters)
1997214503Srpaulo#model_name=WAP
1998214503Srpaulo
1999214503Srpaulo# Model Number
2000214503Srpaulo# Additional device description (up to 32 ASCII characters)
2001214503Srpaulo#model_number=123
2002214503Srpaulo
2003214503Srpaulo# Serial Number
2004214503Srpaulo# Serial number of the device (up to 32 characters)
2005214503Srpaulo#serial_number=12345
2006214503Srpaulo
2007214503Srpaulo# Primary Device Type
2008214503Srpaulo# Used format: <categ>-<OUI>-<subcateg>
2009214503Srpaulo# categ = Category as an integer value
2010214503Srpaulo# OUI = OUI and type octet as a 4-octet hex-encoded value; 0050F204 for
2011214503Srpaulo#       default WPS OUI
2012214503Srpaulo# subcateg = OUI-specific Sub Category as an integer value
2013214503Srpaulo# Examples:
2014214503Srpaulo#   1-0050F204-1 (Computer / PC)
2015214503Srpaulo#   1-0050F204-2 (Computer / Server)
2016214503Srpaulo#   5-0050F204-1 (Storage / NAS)
2017214503Srpaulo#   6-0050F204-1 (Network Infrastructure / AP)
2018214503Srpaulo#device_type=6-0050F204-1
2019214503Srpaulo
2020214503Srpaulo# OS Version
2021214503Srpaulo# 4-octet operating system version number (hex string)
2022214503Srpaulo#os_version=01020300
2023214503Srpaulo
2024214503Srpaulo# Config Methods
2025214503Srpaulo# List of the supported configuration methods
2026214503Srpaulo# Available methods: usba ethernet label display ext_nfc_token int_nfc_token
2027252726Srpaulo#	nfc_interface push_button keypad virtual_display physical_display
2028252726Srpaulo#	virtual_push_button physical_push_button
2029252726Srpaulo#config_methods=label virtual_display virtual_push_button keypad
2030214503Srpaulo
2031252726Srpaulo# WPS capability discovery workaround for PBC with Windows 7
2032252726Srpaulo# Windows 7 uses incorrect way of figuring out AP's WPS capabilities by acting
2033252726Srpaulo# as a Registrar and using M1 from the AP. The config methods attribute in that
2034252726Srpaulo# message is supposed to indicate only the configuration method supported by
2035252726Srpaulo# the AP in Enrollee role, i.e., to add an external Registrar. For that case,
2036252726Srpaulo# PBC shall not be used and as such, the PushButton config method is removed
2037252726Srpaulo# from M1 by default. If pbc_in_m1=1 is included in the configuration file,
2038252726Srpaulo# the PushButton config method is left in M1 (if included in config_methods
2039252726Srpaulo# parameter) to allow Windows 7 to use PBC instead of PIN (e.g., from a label
2040252726Srpaulo# in the AP).
2041252726Srpaulo#pbc_in_m1=1
2042252726Srpaulo
2043214503Srpaulo# Static access point PIN for initial configuration and adding Registrars
2044214503Srpaulo# If not set, hostapd will not allow external WPS Registrars to control the
2045214503Srpaulo# access point. The AP PIN can also be set at runtime with hostapd_cli
2046214503Srpaulo# wps_ap_pin command. Use of temporary (enabled by user action) and random
2047214503Srpaulo# AP PIN is much more secure than configuring a static AP PIN here. As such,
2048214503Srpaulo# use of the ap_pin parameter is not recommended if the AP device has means for
2049214503Srpaulo# displaying a random PIN.
2050214503Srpaulo#ap_pin=12345670
2051214503Srpaulo
2052214503Srpaulo# Skip building of automatic WPS credential
2053214503Srpaulo# This can be used to allow the automatically generated Credential attribute to
2054214503Srpaulo# be replaced with pre-configured Credential(s).
2055214503Srpaulo#skip_cred_build=1
2056214503Srpaulo
2057214503Srpaulo# Additional Credential attribute(s)
2058214503Srpaulo# This option can be used to add pre-configured Credential attributes into M8
2059214503Srpaulo# message when acting as a Registrar. If skip_cred_build=1, this data will also
2060214503Srpaulo# be able to override the Credential attribute that would have otherwise been
2061214503Srpaulo# automatically generated based on network configuration. This configuration
2062214503Srpaulo# option points to an external file that much contain the WPS Credential
2063214503Srpaulo# attribute(s) as binary data.
2064214503Srpaulo#extra_cred=hostapd.cred
2065214503Srpaulo
2066214503Srpaulo# Credential processing
2067214503Srpaulo#   0 = process received credentials internally (default)
2068214503Srpaulo#   1 = do not process received credentials; just pass them over ctrl_iface to
2069214503Srpaulo#	external program(s)
2070214503Srpaulo#   2 = process received credentials internally and pass them over ctrl_iface
2071214503Srpaulo#	to external program(s)
2072214503Srpaulo# Note: With wps_cred_processing=1, skip_cred_build should be set to 1 and
2073214503Srpaulo# extra_cred be used to provide the Credential data for Enrollees.
2074214503Srpaulo#
2075214503Srpaulo# wps_cred_processing=1 will disabled automatic updates of hostapd.conf file
2076214503Srpaulo# both for Credential processing and for marking AP Setup Locked based on
2077214503Srpaulo# validation failures of AP PIN. An external program is responsible on updating
2078214503Srpaulo# the configuration appropriately in this case.
2079214503Srpaulo#wps_cred_processing=0
2080214503Srpaulo
2081346981Scy# Whether to enable SAE (WPA3-Personal transition mode) automatically for
2082346981Scy# WPA2-PSK credentials received using WPS.
2083346981Scy# 0 = only add the explicitly listed WPA2-PSK configuration (default)
2084346981Scy# 1 = add both the WPA2-PSK and SAE configuration and enable PMF so that the
2085346981Scy#     AP gets configured in WPA3-Personal transition mode (supports both
2086346981Scy#     WPA2-Personal (PSK) and WPA3-Personal (SAE) clients).
2087346981Scy#wps_cred_add_sae=0
2088346981Scy
2089214503Srpaulo# AP Settings Attributes for M7
2090214503Srpaulo# By default, hostapd generates the AP Settings Attributes for M7 based on the
2091214503Srpaulo# current configuration. It is possible to override this by providing a file
2092214503Srpaulo# with pre-configured attributes. This is similar to extra_cred file format,
2093214503Srpaulo# but the AP Settings attributes are not encapsulated in a Credential
2094214503Srpaulo# attribute.
2095214503Srpaulo#ap_settings=hostapd.ap_settings
2096214503Srpaulo
2097346981Scy# Multi-AP backhaul BSS config
2098346981Scy# Used in WPS when multi_ap=2 or 3. Defines "backhaul BSS" credentials.
2099346981Scy# These are passed in WPS M8 instead of the normal (fronthaul) credentials
2100346981Scy# if the Enrollee has the Multi-AP subelement set. Backhaul SSID is formatted
2101346981Scy# like ssid2. The key is set like wpa_psk or wpa_passphrase.
2102346981Scy#multi_ap_backhaul_ssid="backhaul"
2103346981Scy#multi_ap_backhaul_wpa_psk=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
2104346981Scy#multi_ap_backhaul_wpa_passphrase=secret passphrase
2105346981Scy
2106214503Srpaulo# WPS UPnP interface
2107214503Srpaulo# If set, support for external Registrars is enabled.
2108214503Srpaulo#upnp_iface=br0
2109214503Srpaulo
2110214503Srpaulo# Friendly Name (required for UPnP)
2111214503Srpaulo# Short description for end use. Should be less than 64 characters.
2112214503Srpaulo#friendly_name=WPS Access Point
2113214503Srpaulo
2114214503Srpaulo# Manufacturer URL (optional for UPnP)
2115214503Srpaulo#manufacturer_url=http://www.example.com/
2116214503Srpaulo
2117214503Srpaulo# Model Description (recommended for UPnP)
2118214503Srpaulo# Long description for end user. Should be less than 128 characters.
2119214503Srpaulo#model_description=Wireless Access Point
2120214503Srpaulo
2121214503Srpaulo# Model URL (optional for UPnP)
2122214503Srpaulo#model_url=http://www.example.com/model/
2123214503Srpaulo
2124214503Srpaulo# Universal Product Code (optional for UPnP)
2125214503Srpaulo# 12-digit, all-numeric code that identifies the consumer package.
2126214503Srpaulo#upc=123456789012
2127214503Srpaulo
2128289549Srpaulo# WPS RF Bands (a = 5G, b = 2.4G, g = 2.4G, ag = dual band, ad = 60 GHz)
2129252726Srpaulo# This value should be set according to RF band(s) supported by the AP if
2130252726Srpaulo# hw_mode is not set. For dual band dual concurrent devices, this needs to be
2131252726Srpaulo# set to ag to allow both RF bands to be advertized.
2132252726Srpaulo#wps_rf_bands=ag
2133252726Srpaulo
2134252726Srpaulo# NFC password token for WPS
2135252726Srpaulo# These parameters can be used to configure a fixed NFC password token for the
2136252726Srpaulo# AP. This can be generated, e.g., with nfc_pw_token from wpa_supplicant. When
2137252726Srpaulo# these parameters are used, the AP is assumed to be deployed with a NFC tag
2138252726Srpaulo# that includes the matching NFC password token (e.g., written based on the
2139252726Srpaulo# NDEF record from nfc_pw_token).
2140252726Srpaulo#
2141252726Srpaulo#wps_nfc_dev_pw_id: Device Password ID (16..65535)
2142252726Srpaulo#wps_nfc_dh_pubkey: Hexdump of DH Public Key
2143252726Srpaulo#wps_nfc_dh_privkey: Hexdump of DH Private Key
2144252726Srpaulo#wps_nfc_dev_pw: Hexdump of Device Password
2145252726Srpaulo
2146252726Srpaulo##### Wi-Fi Direct (P2P) ######################################################
2147252726Srpaulo
2148252726Srpaulo# Enable P2P Device management
2149252726Srpaulo#manage_p2p=1
2150252726Srpaulo
2151252726Srpaulo# Allow cross connection
2152252726Srpaulo#allow_cross_connection=1
2153252726Srpaulo
2154252726Srpaulo#### TDLS (IEEE 802.11z-2010) #################################################
2155252726Srpaulo
2156252726Srpaulo# Prohibit use of TDLS in this BSS
2157252726Srpaulo#tdls_prohibit=1
2158252726Srpaulo
2159252726Srpaulo# Prohibit use of TDLS Channel Switching in this BSS
2160252726Srpaulo#tdls_prohibit_chan_switch=1
2161252726Srpaulo
2162252726Srpaulo##### IEEE 802.11v-2011 #######################################################
2163252726Srpaulo
2164252726Srpaulo# Time advertisement
2165252726Srpaulo# 0 = disabled (default)
2166252726Srpaulo# 2 = UTC time at which the TSF timer is 0
2167252726Srpaulo#time_advertisement=2
2168252726Srpaulo
2169252726Srpaulo# Local time zone as specified in 8.3 of IEEE Std 1003.1-2004:
2170252726Srpaulo# stdoffset[dst[offset][,start[/time],end[/time]]]
2171252726Srpaulo#time_zone=EST5
2172252726Srpaulo
2173252726Srpaulo# WNM-Sleep Mode (extended sleep mode for stations)
2174252726Srpaulo# 0 = disabled (default)
2175252726Srpaulo# 1 = enabled (allow stations to use WNM-Sleep Mode)
2176252726Srpaulo#wnm_sleep_mode=1
2177252726Srpaulo
2178346981Scy# WNM-Sleep Mode GTK/IGTK workaround
2179346981Scy# Normally, WNM-Sleep Mode exit with management frame protection negotiated
2180346981Scy# would result in the current GTK/IGTK getting added into the WNM-Sleep Mode
2181346981Scy# Response frame. Some station implementations may have a vulnerability that
2182346981Scy# results in GTK/IGTK reinstallation based on this frame being replayed. This
2183346981Scy# configuration parameter can be used to disable that behavior and use EAPOL-Key
2184346981Scy# frames for GTK/IGTK update instead. This would likely be only used with
2185346981Scy# wpa_disable_eapol_key_retries=1 that enables a workaround for similar issues
2186346981Scy# with EAPOL-Key. This is related to station side vulnerabilities CVE-2017-13087
2187346981Scy# and CVE-2017-13088. To enable this AP-side workaround, set the parameter to 1.
2188346981Scy#wnm_sleep_mode_no_keys=0
2189346981Scy
2190252726Srpaulo# BSS Transition Management
2191252726Srpaulo# 0 = disabled (default)
2192252726Srpaulo# 1 = enabled
2193252726Srpaulo#bss_transition=1
2194252726Srpaulo
2195281806Srpaulo# Proxy ARP
2196281806Srpaulo# 0 = disabled (default)
2197281806Srpaulo# 1 = enabled
2198281806Srpaulo#proxy_arp=1
2199281806Srpaulo
2200289549Srpaulo# IPv6 Neighbor Advertisement multicast-to-unicast conversion
2201289549Srpaulo# This can be used with Proxy ARP to allow multicast NAs to be forwarded to
2202289549Srpaulo# associated STAs using link layer unicast delivery.
2203289549Srpaulo# 0 = disabled (default)
2204289549Srpaulo# 1 = enabled
2205289549Srpaulo#na_mcast_to_ucast=0
2206289549Srpaulo
2207252726Srpaulo##### IEEE 802.11u-2011 #######################################################
2208252726Srpaulo
2209252726Srpaulo# Enable Interworking service
2210252726Srpaulo#interworking=1
2211252726Srpaulo
2212252726Srpaulo# Access Network Type
2213252726Srpaulo# 0 = Private network
2214252726Srpaulo# 1 = Private network with guest access
2215252726Srpaulo# 2 = Chargeable public network
2216252726Srpaulo# 3 = Free public network
2217252726Srpaulo# 4 = Personal device network
2218252726Srpaulo# 5 = Emergency services only network
2219252726Srpaulo# 14 = Test or experimental
2220252726Srpaulo# 15 = Wildcard
2221252726Srpaulo#access_network_type=0
2222252726Srpaulo
2223252726Srpaulo# Whether the network provides connectivity to the Internet
2224252726Srpaulo# 0 = Unspecified
2225252726Srpaulo# 1 = Network provides connectivity to the Internet
2226252726Srpaulo#internet=1
2227252726Srpaulo
2228252726Srpaulo# Additional Step Required for Access
2229252726Srpaulo# Note: This is only used with open network, i.e., ASRA shall ne set to 0 if
2230252726Srpaulo# RSN is used.
2231252726Srpaulo#asra=0
2232252726Srpaulo
2233252726Srpaulo# Emergency services reachable
2234252726Srpaulo#esr=0
2235252726Srpaulo
2236252726Srpaulo# Unauthenticated emergency service accessible
2237252726Srpaulo#uesa=0
2238252726Srpaulo
2239252726Srpaulo# Venue Info (optional)
2240252726Srpaulo# The available values are defined in IEEE Std 802.11u-2011, 7.3.1.34.
2241252726Srpaulo# Example values (group,type):
2242252726Srpaulo# 0,0 = Unspecified
2243252726Srpaulo# 1,7 = Convention Center
2244252726Srpaulo# 1,13 = Coffee Shop
2245252726Srpaulo# 2,0 = Unspecified Business
2246252726Srpaulo# 7,1  Private Residence
2247252726Srpaulo#venue_group=7
2248252726Srpaulo#venue_type=1
2249252726Srpaulo
2250252726Srpaulo# Homogeneous ESS identifier (optional; dot11HESSID)
2251252726Srpaulo# If set, this shall be identifical to one of the BSSIDs in the homogeneous
2252252726Srpaulo# ESS and this shall be set to the same value across all BSSs in homogeneous
2253252726Srpaulo# ESS.
2254252726Srpaulo#hessid=02:03:04:05:06:07
2255252726Srpaulo
2256252726Srpaulo# Roaming Consortium List
2257252726Srpaulo# Arbitrary number of Roaming Consortium OIs can be configured with each line
2258252726Srpaulo# adding a new OI to the list. The first three entries are available through
2259252726Srpaulo# Beacon and Probe Response frames. Any additional entry will be available only
2260252726Srpaulo# through ANQP queries. Each OI is between 3 and 15 octets and is configured as
2261252726Srpaulo# a hexstring.
2262252726Srpaulo#roaming_consortium=021122
2263252726Srpaulo#roaming_consortium=2233445566
2264252726Srpaulo
2265252726Srpaulo# Venue Name information
2266252726Srpaulo# This parameter can be used to configure one or more Venue Name Duples for
2267252726Srpaulo# Venue Name ANQP information. Each entry has a two or three character language
2268252726Srpaulo# code (ISO-639) separated by colon from the venue name string.
2269252726Srpaulo# Note that venue_group and venue_type have to be set for Venue Name
2270252726Srpaulo# information to be complete.
2271252726Srpaulo#venue_name=eng:Example venue
2272252726Srpaulo#venue_name=fin:Esimerkkipaikka
2273281806Srpaulo# Alternative format for language:value strings:
2274281806Srpaulo# (double quoted string, printf-escaped string)
2275281806Srpaulo#venue_name=P"eng:Example\nvenue"
2276252726Srpaulo
2277346981Scy# Venue URL information
2278346981Scy# This parameter can be used to configure one or more Venue URL Duples to
2279346981Scy# provide additional information corresponding to Venue Name information.
2280346981Scy# Each entry has a Venue Number value separated by colon from the Venue URL
2281346981Scy# string. Venue Number indicates the corresponding venue_name entry (1 = 1st
2282346981Scy# venue_name, 2 = 2nd venue_name, and so on; 0 = no matching venue_name)
2283346981Scy#venue_url=1:http://www.example.com/info-eng
2284346981Scy#venue_url=2:http://www.example.com/info-fin
2285346981Scy
2286252726Srpaulo# Network Authentication Type
2287252726Srpaulo# This parameter indicates what type of network authentication is used in the
2288252726Srpaulo# network.
2289252726Srpaulo# format: <network auth type indicator (1-octet hex str)> [redirect URL]
2290252726Srpaulo# Network Authentication Type Indicator values:
2291252726Srpaulo# 00 = Acceptance of terms and conditions
2292252726Srpaulo# 01 = On-line enrollment supported
2293252726Srpaulo# 02 = http/https redirection
2294252726Srpaulo# 03 = DNS redirection
2295252726Srpaulo#network_auth_type=00
2296252726Srpaulo#network_auth_type=02http://www.example.com/redirect/me/here/
2297252726Srpaulo
2298252726Srpaulo# IP Address Type Availability
2299252726Srpaulo# format: <1-octet encoded value as hex str>
2300252726Srpaulo# (ipv4_type & 0x3f) << 2 | (ipv6_type & 0x3)
2301252726Srpaulo# ipv4_type:
2302252726Srpaulo# 0 = Address type not available
2303252726Srpaulo# 1 = Public IPv4 address available
2304252726Srpaulo# 2 = Port-restricted IPv4 address available
2305252726Srpaulo# 3 = Single NATed private IPv4 address available
2306252726Srpaulo# 4 = Double NATed private IPv4 address available
2307252726Srpaulo# 5 = Port-restricted IPv4 address and single NATed IPv4 address available
2308252726Srpaulo# 6 = Port-restricted IPv4 address and double NATed IPv4 address available
2309252726Srpaulo# 7 = Availability of the address type is not known
2310252726Srpaulo# ipv6_type:
2311252726Srpaulo# 0 = Address type not available
2312252726Srpaulo# 1 = Address type available
2313252726Srpaulo# 2 = Availability of the address type not known
2314252726Srpaulo#ipaddr_type_availability=14
2315252726Srpaulo
2316252726Srpaulo# Domain Name
2317252726Srpaulo# format: <variable-octet str>[,<variable-octet str>]
2318252726Srpaulo#domain_name=example.com,another.example.com,yet-another.example.com
2319252726Srpaulo
2320252726Srpaulo# 3GPP Cellular Network information
2321252726Srpaulo# format: <MCC1,MNC1>[;<MCC2,MNC2>][;...]
2322252726Srpaulo#anqp_3gpp_cell_net=244,91;310,026;234,56
2323252726Srpaulo
2324252726Srpaulo# NAI Realm information
2325252726Srpaulo# One or more realm can be advertised. Each nai_realm line adds a new realm to
2326252726Srpaulo# the set. These parameters provide information for stations using Interworking
2327252726Srpaulo# network selection to allow automatic connection to a network based on
2328252726Srpaulo# credentials.
2329252726Srpaulo# format: <encoding>,<NAI Realm(s)>[,<EAP Method 1>][,<EAP Method 2>][,...]
2330252726Srpaulo# encoding:
2331252726Srpaulo#	0 = Realm formatted in accordance with IETF RFC 4282
2332252726Srpaulo#	1 = UTF-8 formatted character string that is not formatted in
2333252726Srpaulo#	    accordance with IETF RFC 4282
2334252726Srpaulo# NAI Realm(s): Semi-colon delimited NAI Realm(s)
2335252726Srpaulo# EAP Method: <EAP Method>[:<[AuthParam1:Val1]>][<[AuthParam2:Val2]>][...]
2336281806Srpaulo# EAP Method types, see:
2337281806Srpaulo# http://www.iana.org/assignments/eap-numbers/eap-numbers.xhtml#eap-numbers-4
2338252726Srpaulo# AuthParam (Table 8-188 in IEEE Std 802.11-2012):
2339252726Srpaulo# ID 2 = Non-EAP Inner Authentication Type
2340252726Srpaulo#	1 = PAP, 2 = CHAP, 3 = MSCHAP, 4 = MSCHAPV2
2341252726Srpaulo# ID 3 = Inner authentication EAP Method Type
2342252726Srpaulo# ID 5 = Credential Type
2343252726Srpaulo#	1 = SIM, 2 = USIM, 3 = NFC Secure Element, 4 = Hardware Token,
2344252726Srpaulo#	5 = Softoken, 6 = Certificate, 7 = username/password, 9 = Anonymous,
2345252726Srpaulo#	10 = Vendor Specific
2346252726Srpaulo#nai_realm=0,example.com;example.net
2347252726Srpaulo# EAP methods EAP-TLS with certificate and EAP-TTLS/MSCHAPv2 with
2348252726Srpaulo# username/password
2349252726Srpaulo#nai_realm=0,example.org,13[5:6],21[2:4][5:7]
2350252726Srpaulo
2351337817Scy# Arbitrary ANQP-element configuration
2352337817Scy# Additional ANQP-elements with arbitrary values can be defined by specifying
2353337817Scy# their contents in raw format as a hexdump of the payload. Note that these
2354337817Scy# values will override ANQP-element contents that may have been specified in the
2355337817Scy# more higher layer configuration parameters listed above.
2356337817Scy# format: anqp_elem=<InfoID>:<hexdump of payload>
2357337817Scy# For example, AP Geospatial Location ANQP-element with unknown location:
2358337817Scy#anqp_elem=265:0000
2359337817Scy# For example, AP Civic Location ANQP-element with unknown location:
2360337817Scy#anqp_elem=266:000000
2361337817Scy
2362337817Scy# GAS Address 3 behavior
2363337817Scy# 0 = P2P specification (Address3 = AP BSSID) workaround enabled by default
2364337817Scy#     based on GAS request Address3
2365337817Scy# 1 = IEEE 802.11 standard compliant regardless of GAS request Address3
2366337817Scy# 2 = Force non-compliant behavior (Address3 = AP BSSID for all cases)
2367337817Scy#gas_address3=0
2368337817Scy
2369281806Srpaulo# QoS Map Set configuration
2370281806Srpaulo#
2371281806Srpaulo# Comma delimited QoS Map Set in decimal values
2372281806Srpaulo# (see IEEE Std 802.11-2012, 8.4.2.97)
2373281806Srpaulo#
2374281806Srpaulo# format:
2375281806Srpaulo# [<DSCP Exceptions[DSCP,UP]>,]<UP 0 range[low,high]>,...<UP 7 range[low,high]>
2376281806Srpaulo#
2377281806Srpaulo# There can be up to 21 optional DSCP Exceptions which are pairs of DSCP Value
2378281806Srpaulo# (0..63 or 255) and User Priority (0..7). This is followed by eight DSCP Range
2379281806Srpaulo# descriptions with DSCP Low Value and DSCP High Value pairs (0..63 or 255) for
2380281806Srpaulo# each UP starting from 0. If both low and high value are set to 255, the
2381281806Srpaulo# corresponding UP is not used.
2382281806Srpaulo#
2383281806Srpaulo# default: not set
2384281806Srpaulo#qos_map_set=53,2,22,6,8,15,0,7,255,255,16,31,32,39,255,255,40,47,255,255
2385281806Srpaulo
2386252726Srpaulo##### Hotspot 2.0 #############################################################
2387252726Srpaulo
2388252726Srpaulo# Enable Hotspot 2.0 support
2389252726Srpaulo#hs20=1
2390252726Srpaulo
2391252726Srpaulo# Disable Downstream Group-Addressed Forwarding (DGAF)
2392252726Srpaulo# This can be used to configure a network where no group-addressed frames are
2393252726Srpaulo# allowed. The AP will not forward any group-address frames to the stations and
2394252726Srpaulo# random GTKs are issued for each station to prevent associated stations from
2395252726Srpaulo# forging such frames to other stations in the BSS.
2396252726Srpaulo#disable_dgaf=1
2397252726Srpaulo
2398281806Srpaulo# OSU Server-Only Authenticated L2 Encryption Network
2399281806Srpaulo#osen=1
2400281806Srpaulo
2401281806Srpaulo# ANQP Domain ID (0..65535)
2402281806Srpaulo# An identifier for a set of APs in an ESS that share the same common ANQP
2403281806Srpaulo# information. 0 = Some of the ANQP information is unique to this AP (default).
2404281806Srpaulo#anqp_domain_id=1234
2405281806Srpaulo
2406281806Srpaulo# Deauthentication request timeout
2407281806Srpaulo# If the RADIUS server indicates that the station is not allowed to connect to
2408281806Srpaulo# the BSS/ESS, the AP can allow the station some time to download a
2409281806Srpaulo# notification page (URL included in the message). This parameter sets that
2410281806Srpaulo# timeout in seconds.
2411281806Srpaulo#hs20_deauth_req_timeout=60
2412281806Srpaulo
2413252726Srpaulo# Operator Friendly Name
2414252726Srpaulo# This parameter can be used to configure one or more Operator Friendly Name
2415252726Srpaulo# Duples. Each entry has a two or three character language code (ISO-639)
2416252726Srpaulo# separated by colon from the operator friendly name string.
2417252726Srpaulo#hs20_oper_friendly_name=eng:Example operator
2418252726Srpaulo#hs20_oper_friendly_name=fin:Esimerkkioperaattori
2419252726Srpaulo
2420252726Srpaulo# Connection Capability
2421252726Srpaulo# This can be used to advertise what type of IP traffic can be sent through the
2422252726Srpaulo# hotspot (e.g., due to firewall allowing/blocking protocols/ports).
2423252726Srpaulo# format: <IP Protocol>:<Port Number>:<Status>
2424252726Srpaulo# IP Protocol: 1 = ICMP, 6 = TCP, 17 = UDP
2425252726Srpaulo# Port Number: 0..65535
2426252726Srpaulo# Status: 0 = Closed, 1 = Open, 2 = Unknown
2427252726Srpaulo# Each hs20_conn_capab line is added to the list of advertised tuples.
2428252726Srpaulo#hs20_conn_capab=1:0:2
2429252726Srpaulo#hs20_conn_capab=6:22:1
2430252726Srpaulo#hs20_conn_capab=17:5060:0
2431252726Srpaulo
2432252726Srpaulo# WAN Metrics
2433252726Srpaulo# format: <WAN Info>:<DL Speed>:<UL Speed>:<DL Load>:<UL Load>:<LMD>
2434252726Srpaulo# WAN Info: B0-B1: Link Status, B2: Symmetric Link, B3: At Capabity
2435252726Srpaulo#    (encoded as two hex digits)
2436252726Srpaulo#    Link Status: 1 = Link up, 2 = Link down, 3 = Link in test state
2437252726Srpaulo# Downlink Speed: Estimate of WAN backhaul link current downlink speed in kbps;
2438252726Srpaulo#	1..4294967295; 0 = unknown
2439252726Srpaulo# Uplink Speed: Estimate of WAN backhaul link current uplink speed in kbps
2440252726Srpaulo#	1..4294967295; 0 = unknown
2441252726Srpaulo# Downlink Load: Current load of downlink WAN connection (scaled to 255 = 100%)
2442252726Srpaulo# Uplink Load: Current load of uplink WAN connection (scaled to 255 = 100%)
2443252726Srpaulo# Load Measurement Duration: Duration for measuring downlink/uplink load in
2444252726Srpaulo# tenths of a second (1..65535); 0 if load cannot be determined
2445252726Srpaulo#hs20_wan_metrics=01:8000:1000:80:240:3000
2446252726Srpaulo
2447252726Srpaulo# Operating Class Indication
2448252726Srpaulo# List of operating classes the BSSes in this ESS use. The Global operating
2449252726Srpaulo# classes in Table E-4 of IEEE Std 802.11-2012 Annex E define the values that
2450252726Srpaulo# can be used in this.
2451252726Srpaulo# format: hexdump of operating class octets
2452252726Srpaulo# for example, operating classes 81 (2.4 GHz channels 1-13) and 115 (5 GHz
2453252726Srpaulo# channels 36-48):
2454252726Srpaulo#hs20_operating_class=5173
2455252726Srpaulo
2456346981Scy# Terms and Conditions information
2457346981Scy#
2458346981Scy# hs20_t_c_filename contains the Terms and Conditions filename that the AP
2459346981Scy# indicates in RADIUS Access-Request messages.
2460346981Scy#hs20_t_c_filename=terms-and-conditions
2461346981Scy#
2462346981Scy# hs20_t_c_timestamp contains the Terms and Conditions timestamp that the AP
2463346981Scy# indicates in RADIUS Access-Request messages. Usually, this contains the number
2464346981Scy# of seconds since January 1, 1970 00:00 UTC showing the time when the file was
2465346981Scy# last modified.
2466346981Scy#hs20_t_c_timestamp=1234567
2467346981Scy#
2468346981Scy# hs20_t_c_server_url contains a template for the Terms and Conditions server
2469346981Scy# URL. This template is used to generate the URL for a STA that needs to
2470346981Scy# acknowledge Terms and Conditions. Unlike the other hs20_t_c_* parameters, this
2471346981Scy# parameter is used on the authentication server, not the AP.
2472346981Scy# Macros:
2473346981Scy# @1@ = MAC address of the STA (colon separated hex octets)
2474346981Scy#hs20_t_c_server_url=https://example.com/t_and_c?addr=@1@&ap=123
2475346981Scy
2476346981Scy# OSU and Operator icons
2477281806Srpaulo# <Icon Width>:<Icon Height>:<Language code>:<Icon Type>:<Name>:<file path>
2478281806Srpaulo#hs20_icon=32:32:eng:image/png:icon32:/tmp/icon32.png
2479281806Srpaulo#hs20_icon=64:64:eng:image/png:icon64:/tmp/icon64.png
2480281806Srpaulo
2481281806Srpaulo# OSU SSID (see ssid2 for format description)
2482281806Srpaulo# This is the SSID used for all OSU connections to all the listed OSU Providers.
2483281806Srpaulo#osu_ssid="example"
2484281806Srpaulo
2485281806Srpaulo# OSU Providers
2486281806Srpaulo# One or more sets of following parameter. Each OSU provider is started by the
2487281806Srpaulo# mandatory osu_server_uri item. The other parameters add information for the
2488346981Scy# last added OSU provider. osu_nai specifies the OSU_NAI value for OSEN
2489346981Scy# authentication when using a standalone OSU BSS. osu_nai2 specifies the OSU_NAI
2490346981Scy# value for OSEN authentication when using a shared BSS (Single SSID) for OSU.
2491281806Srpaulo#
2492281806Srpaulo#osu_server_uri=https://example.com/osu/
2493281806Srpaulo#osu_friendly_name=eng:Example operator
2494281806Srpaulo#osu_friendly_name=fin:Esimerkkipalveluntarjoaja
2495281806Srpaulo#osu_nai=anonymous@example.com
2496346981Scy#osu_nai2=anonymous@example.com
2497281806Srpaulo#osu_method_list=1 0
2498281806Srpaulo#osu_icon=icon32
2499281806Srpaulo#osu_icon=icon64
2500281806Srpaulo#osu_service_desc=eng:Example services
2501281806Srpaulo#osu_service_desc=fin:Esimerkkipalveluja
2502281806Srpaulo#
2503281806Srpaulo#osu_server_uri=...
2504281806Srpaulo
2505346981Scy# Operator Icons
2506346981Scy# Operator icons are specified using references to the hs20_icon entries
2507346981Scy# (Name subfield). This information, if present, is advertsised in the
2508346981Scy# Operator Icon Metadata ANQO-element.
2509346981Scy#operator_icon=icon32
2510346981Scy#operator_icon=icon64
2511346981Scy
2512346981Scy##### Multiband Operation (MBO) ###############################################
2513346981Scy#
2514346981Scy# MBO enabled
2515346981Scy# 0 = disabled (default)
2516346981Scy# 1 = enabled
2517346981Scy#mbo=1
2518346981Scy#
2519346981Scy# Cellular data connection preference
2520346981Scy# 0 = Excluded - AP does not want STA to use the cellular data connection
2521346981Scy# 1 = AP prefers the STA not to use cellular data connection
2522346981Scy# 255 = AP prefers the STA to use cellular data connection
2523346981Scy#mbo_cell_data_conn_pref=1
2524346981Scy
2525346981Scy##### Optimized Connectivity Experience (OCE) #################################
2526346981Scy#
2527346981Scy# Enable OCE specific features (bitmap)
2528346981Scy# BIT(0) - Reserved
2529346981Scy# Set BIT(1) (= 2) to enable OCE in STA-CFON mode
2530346981Scy# Set BIT(2) (= 4) to enable OCE in AP mode
2531346981Scy# Default is 0 = OCE disabled
2532346981Scy#oce=0
2533346981Scy
2534346981Scy# RSSI-based assocition rejection
2535346981Scy#
2536346981Scy# Reject STA association if RSSI is below given threshold (in dBm)
2537346981Scy# Allowed range: -60 to -90 dBm; default = 0 (rejection disabled)
2538346981Scy# Note: This rejection happens based on a signal strength detected while
2539346981Scy# receiving a single frame and as such, there is significant risk of the value
2540346981Scy# not being accurate and this resulting in valid stations being rejected. As
2541346981Scy# such, this functionality is not recommended to be used for purposes other than
2542346981Scy# testing.
2543346981Scy#rssi_reject_assoc_rssi=-75
2544346981Scy#
2545346981Scy# Association retry delay in seconds allowed by the STA if RSSI has not met the
2546346981Scy# threshold (range: 0..255, default=30).
2547346981Scy#rssi_reject_assoc_timeout=30
2548346981Scy
2549289549Srpaulo##### Fast Session Transfer (FST) support #####################################
2550289549Srpaulo#
2551289549Srpaulo# The options in this section are only available when the build configuration
2552289549Srpaulo# option CONFIG_FST is set while compiling hostapd. They allow this interface
2553289549Srpaulo# to be a part of FST setup.
2554289549Srpaulo#
2555289549Srpaulo# FST is the transfer of a session from a channel to another channel, in the
2556289549Srpaulo# same or different frequency bands.
2557289549Srpaulo#
2558289549Srpaulo# For detals, see IEEE Std 802.11ad-2012.
2559289549Srpaulo
2560289549Srpaulo# Identifier of an FST Group the interface belongs to.
2561289549Srpaulo#fst_group_id=bond0
2562289549Srpaulo
2563289549Srpaulo# Interface priority within the FST Group.
2564289549Srpaulo# Announcing a higher priority for an interface means declaring it more
2565289549Srpaulo# preferable for FST switch.
2566289549Srpaulo# fst_priority is in 1..255 range with 1 being the lowest priority.
2567289549Srpaulo#fst_priority=100
2568289549Srpaulo
2569289549Srpaulo# Default LLT value for this interface in milliseconds. The value used in case
2570289549Srpaulo# no value provided during session setup. Default is 50 ms.
2571289549Srpaulo# fst_llt is in 1..4294967 range (due to spec limitation, see 10.32.2.2
2572289549Srpaulo# Transitioning between states).
2573289549Srpaulo#fst_llt=100
2574289549Srpaulo
2575337817Scy##### Radio measurements / location ###########################################
2576337817Scy
2577337817Scy# The content of a LCI measurement subelement
2578337817Scy#lci=<Hexdump of binary data of the LCI report>
2579337817Scy
2580337817Scy# The content of a location civic measurement subelement
2581337817Scy#civic=<Hexdump of binary data of the location civic report>
2582337817Scy
2583337817Scy# Enable neighbor report via radio measurements
2584337817Scy#rrm_neighbor_report=1
2585337817Scy
2586346981Scy# Enable beacon report via radio measurements
2587346981Scy#rrm_beacon_report=1
2588346981Scy
2589337817Scy# Publish fine timing measurement (FTM) responder functionality
2590337817Scy# This parameter only controls publishing via Extended Capabilities element.
2591337817Scy# Actual functionality is managed outside hostapd.
2592337817Scy#ftm_responder=0
2593337817Scy
2594337817Scy# Publish fine timing measurement (FTM) initiator functionality
2595337817Scy# This parameter only controls publishing via Extended Capabilities element.
2596337817Scy# Actual functionality is managed outside hostapd.
2597337817Scy#ftm_initiator=0
2598346981Scy#
2599346981Scy# Stationary AP config indicates that the AP doesn't move hence location data
2600346981Scy# can be considered as always up to date. If configured, LCI data will be sent
2601346981Scy# as a radio measurement even if the request doesn't contain a max age element
2602346981Scy# that allows sending of such data. Default: 0.
2603346981Scy#stationary_ap=0
2604337817Scy
2605351611Scy##### Airtime policy configuration ###########################################
2606351611Scy
2607351611Scy# Set the airtime policy operating mode:
2608351611Scy# 0 = disabled (default)
2609351611Scy# 1 = static config
2610351611Scy# 2 = per-BSS dynamic config
2611351611Scy# 3 = per-BSS limit mode
2612351611Scy#airtime_mode=0
2613351611Scy
2614351611Scy# Interval (in milliseconds) to poll the kernel for updated station activity in
2615351611Scy# dynamic and limit modes
2616351611Scy#airtime_update_interval=200
2617351611Scy
2618351611Scy# Static configuration of station weights (when airtime_mode=1). Kernel default
2619351611Scy# weight is 256; set higher for larger airtime share, lower for smaller share.
2620351611Scy# Each entry is a MAC address followed by a weight.
2621351611Scy#airtime_sta_weight=02:01:02:03:04:05 256
2622351611Scy#airtime_sta_weight=02:01:02:03:04:06 512
2623351611Scy
2624351611Scy# Per-BSS airtime weight. In multi-BSS mode, set for each BSS and hostapd will
2625351611Scy# configure station weights to enforce the correct ratio between BSS weights
2626351611Scy# depending on the number of active stations. The *ratios* between different
2627351611Scy# BSSes is what's important, not the absolute numbers.
2628351611Scy# Must be set for all BSSes if airtime_mode=2 or 3, has no effect otherwise.
2629351611Scy#airtime_bss_weight=1
2630351611Scy
2631351611Scy# Whether the current BSS should be limited (when airtime_mode=3).
2632351611Scy#
2633351611Scy# If set, the BSS weight ratio will be applied in the case where the current BSS
2634351611Scy# would exceed the share defined by the BSS weight ratio. E.g., if two BSSes are
2635351611Scy# set to the same weights, and one is set to limited, the limited BSS will get
2636351611Scy# no more than half the available airtime, but if the non-limited BSS has more
2637351611Scy# stations active, that *will* be allowed to exceed its half of the available
2638351611Scy# airtime.
2639351611Scy#airtime_bss_limit=1
2640351611Scy
2641281806Srpaulo##### TESTING OPTIONS #########################################################
2642281806Srpaulo#
2643281806Srpaulo# The options in this section are only available when the build configuration
2644281806Srpaulo# option CONFIG_TESTING_OPTIONS is set while compiling hostapd. They allow
2645281806Srpaulo# testing some scenarios that are otherwise difficult to reproduce.
2646281806Srpaulo#
2647281806Srpaulo# Ignore probe requests sent to hostapd with the given probability, must be a
2648281806Srpaulo# floating point number in the range [0, 1).
2649281806Srpaulo#ignore_probe_probability=0.0
2650281806Srpaulo#
2651281806Srpaulo# Ignore authentication frames with the given probability
2652281806Srpaulo#ignore_auth_probability=0.0
2653281806Srpaulo#
2654281806Srpaulo# Ignore association requests with the given probability
2655281806Srpaulo#ignore_assoc_probability=0.0
2656281806Srpaulo#
2657281806Srpaulo# Ignore reassociation requests with the given probability
2658281806Srpaulo#ignore_reassoc_probability=0.0
2659281806Srpaulo#
2660281806Srpaulo# Corrupt Key MIC in GTK rekey EAPOL-Key frames with the given probability
2661281806Srpaulo#corrupt_gtk_rekey_mic_probability=0.0
2662337817Scy#
2663337817Scy# Include only ECSA IE without CSA IE where possible
2664337817Scy# (channel switch operating class is needed)
2665337817Scy#ecsa_ie_only=0
2666281806Srpaulo
2667214503Srpaulo##### Multiple BSSID support ##################################################
2668214503Srpaulo#
2669214503Srpaulo# Above configuration is using the default interface (wlan#, or multi-SSID VLAN
2670214503Srpaulo# interfaces). Other BSSIDs can be added by using separator 'bss' with
2671214503Srpaulo# default interface name to be allocated for the data packets of the new BSS.
2672214503Srpaulo#
2673214503Srpaulo# hostapd will generate BSSID mask based on the BSSIDs that are
2674214503Srpaulo# configured. hostapd will verify that dev_addr & MASK == dev_addr. If this is
2675214503Srpaulo# not the case, the MAC address of the radio must be changed before starting
2676214503Srpaulo# hostapd (ifconfig wlan0 hw ether <MAC addr>). If a BSSID is configured for
2677214503Srpaulo# every secondary BSS, this limitation is not applied at hostapd and other
2678214503Srpaulo# masks may be used if the driver supports them (e.g., swap the locally
2679214503Srpaulo# administered bit)
2680214503Srpaulo#
2681214503Srpaulo# BSSIDs are assigned in order to each BSS, unless an explicit BSSID is
2682214503Srpaulo# specified using the 'bssid' parameter.
2683214503Srpaulo# If an explicit BSSID is specified, it must be chosen such that it:
2684214503Srpaulo# - results in a valid MASK that covers it and the dev_addr
2685214503Srpaulo# - is not the same as the MAC address of the radio
2686214503Srpaulo# - is not the same as any other explicitly specified BSSID
2687214503Srpaulo#
2688337817Scy# Alternatively, the 'use_driver_iface_addr' parameter can be used to request
2689337817Scy# hostapd to use the driver auto-generated interface address (e.g., to use the
2690337817Scy# exact MAC addresses allocated to the device).
2691337817Scy#
2692281806Srpaulo# Not all drivers support multiple BSSes. The exact mechanism for determining
2693281806Srpaulo# the driver capabilities is driver specific. With the current (i.e., a recent
2694281806Srpaulo# kernel) drivers using nl80211, this information can be checked with "iw list"
2695281806Srpaulo# (search for "valid interface combinations").
2696281806Srpaulo#
2697214503Srpaulo# Please note that hostapd uses some of the values configured for the first BSS
2698214503Srpaulo# as the defaults for the following BSSes. However, it is recommended that all
2699214503Srpaulo# BSSes include explicit configuration of all relevant configuration items.
2700214503Srpaulo#
2701214503Srpaulo#bss=wlan0_0
2702214503Srpaulo#ssid=test2
2703214503Srpaulo# most of the above items can be used here (apart from radio interface specific
2704214503Srpaulo# items, like channel)
2705214503Srpaulo
2706214503Srpaulo#bss=wlan0_1
2707214503Srpaulo#bssid=00:13:10:95:fe:0b
2708214503Srpaulo# ...
2709