hostapd.conf revision 1.1.1.7 1 1.1 christos ##### hostapd configuration file ##############################################
2 1.1 christos # Empty lines and lines starting with # are ignored
3 1.1 christos
4 1.1 christos # AP netdevice name (without 'ap' postfix, i.e., wlan0 uses wlan0ap for
5 1.1.1.6 christos # management frames with the Host AP driver); wlan0 with many nl80211 drivers
6 1.1.1.7 christos # Note: This attribute can be overridden by the values supplied with the '-i'
7 1.1.1.7 christos # command line parameter.
8 1.1 christos interface=wlan0
9 1.1 christos
10 1.1.1.6 christos # In case of atheros and nl80211 driver interfaces, an additional
11 1.1 christos # configuration parameter, bridge, may be used to notify hostapd if the
12 1.1 christos # interface is included in a bridge. This parameter is not used with Host AP
13 1.1 christos # driver. If the bridge parameter is not set, the drivers will automatically
14 1.1 christos # figure out the bridge interface (assuming sysfs is enabled and mounted to
15 1.1 christos # /sys) and this parameter may not be needed.
16 1.1 christos #
17 1.1 christos # For nl80211, this parameter can be used to request the AP interface to be
18 1.1 christos # added to the bridge automatically (brctl may refuse to do this before hostapd
19 1.1 christos # has been started to change the interface mode). If needed, the bridge
20 1.1 christos # interface is also created.
21 1.1 christos #bridge=br0
22 1.1 christos
23 1.1.1.6 christos # Driver interface type (hostap/wired/none/nl80211/bsd);
24 1.1 christos # default: hostap). nl80211 is used with all Linux mac80211 drivers.
25 1.1 christos # Use driver=none if building hostapd as a standalone RADIUS server that does
26 1.1 christos # not control any wireless/wired driver.
27 1.1 christos # driver=hostap
28 1.1 christos
29 1.1.1.6 christos # Driver interface parameters (mainly for development testing use)
30 1.1.1.6 christos # driver_params=<params>
31 1.1.1.6 christos
32 1.1 christos # hostapd event logger configuration
33 1.1 christos #
34 1.1 christos # Two output method: syslog and stdout (only usable if not forking to
35 1.1 christos # background).
36 1.1 christos #
37 1.1 christos # Module bitfield (ORed bitfield of modules that will be logged; -1 = all
38 1.1 christos # modules):
39 1.1 christos # bit 0 (1) = IEEE 802.11
40 1.1 christos # bit 1 (2) = IEEE 802.1X
41 1.1 christos # bit 2 (4) = RADIUS
42 1.1 christos # bit 3 (8) = WPA
43 1.1 christos # bit 4 (16) = driver interface
44 1.1 christos # bit 5 (32) = IAPP
45 1.1 christos # bit 6 (64) = MLME
46 1.1 christos #
47 1.1 christos # Levels (minimum value for logged events):
48 1.1 christos # 0 = verbose debugging
49 1.1 christos # 1 = debugging
50 1.1 christos # 2 = informational messages
51 1.1 christos # 3 = notification
52 1.1 christos # 4 = warning
53 1.1 christos #
54 1.1 christos logger_syslog=-1
55 1.1 christos logger_syslog_level=2
56 1.1 christos logger_stdout=-1
57 1.1 christos logger_stdout_level=2
58 1.1 christos
59 1.1 christos # Interface for separate control program. If this is specified, hostapd
60 1.1 christos # will create this directory and a UNIX domain socket for listening to requests
61 1.1 christos # from external programs (CLI/GUI, etc.) for status information and
62 1.1 christos # configuration. The socket file will be named based on the interface name, so
63 1.1 christos # multiple hostapd processes/interfaces can be run at the same time if more
64 1.1 christos # than one interface is used.
65 1.1 christos # /var/run/hostapd is the recommended directory for sockets and by default,
66 1.1 christos # hostapd_cli will use it when trying to connect with hostapd.
67 1.1 christos ctrl_interface=/var/run/hostapd
68 1.1 christos
69 1.1 christos # Access control for the control interface can be configured by setting the
70 1.1 christos # directory to allow only members of a group to use sockets. This way, it is
71 1.1 christos # possible to run hostapd as root (since it needs to change network
72 1.1 christos # configuration and open raw sockets) and still allow GUI/CLI components to be
73 1.1 christos # run as non-root users. However, since the control interface can be used to
74 1.1 christos # change the network configuration, this access needs to be protected in many
75 1.1 christos # cases. By default, hostapd is configured to use gid 0 (root). If you
76 1.1 christos # want to allow non-root users to use the contron interface, add a new group
77 1.1 christos # and change this value to match with that group. Add users that should have
78 1.1 christos # control interface access to this group.
79 1.1 christos #
80 1.1 christos # This variable can be a group name or gid.
81 1.1 christos #ctrl_interface_group=wheel
82 1.1 christos ctrl_interface_group=0
83 1.1 christos
84 1.1 christos
85 1.1 christos ##### IEEE 802.11 related configuration #######################################
86 1.1 christos
87 1.1 christos # SSID to be used in IEEE 802.11 management frames
88 1.1 christos ssid=test
89 1.1.1.4 christos # Alternative formats for configuring SSID
90 1.1.1.4 christos # (double quoted string, hexdump, printf-escaped string)
91 1.1.1.4 christos #ssid2="test"
92 1.1.1.4 christos #ssid2=74657374
93 1.1.1.4 christos #ssid2=P"hello\nthere"
94 1.1.1.4 christos
95 1.1.1.4 christos # UTF-8 SSID: Whether the SSID is to be interpreted using UTF-8 encoding
96 1.1.1.4 christos #utf8_ssid=1
97 1.1 christos
98 1.1 christos # Country code (ISO/IEC 3166-1). Used to set regulatory domain.
99 1.1 christos # Set as needed to indicate country in which device is operating.
100 1.1 christos # This can limit available channels and transmit power.
101 1.1 christos #country_code=US
102 1.1 christos
103 1.1 christos # Enable IEEE 802.11d. This advertises the country_code and the set of allowed
104 1.1 christos # channels and transmit power levels based on the regulatory limits. The
105 1.1 christos # country_code setting must be configured with the correct country for
106 1.1 christos # IEEE 802.11d functions.
107 1.1 christos # (default: 0 = disabled)
108 1.1 christos #ieee80211d=1
109 1.1 christos
110 1.1.1.5 christos # Enable IEEE 802.11h. This enables radar detection and DFS support if
111 1.1.1.5 christos # available. DFS support is required on outdoor 5 GHz channels in most countries
112 1.1.1.5 christos # of the world. This can be used only with ieee80211d=1.
113 1.1.1.5 christos # (default: 0 = disabled)
114 1.1.1.5 christos #ieee80211h=1
115 1.1.1.5 christos
116 1.1.1.5 christos # Add Power Constraint element to Beacon and Probe Response frames
117 1.1.1.5 christos # This config option adds Power Constraint element when applicable and Country
118 1.1.1.5 christos # element is added. Power Constraint element is required by Transmit Power
119 1.1.1.5 christos # Control. This can be used only with ieee80211d=1.
120 1.1.1.5 christos # Valid values are 0..255.
121 1.1.1.5 christos #local_pwr_constraint=3
122 1.1.1.5 christos
123 1.1.1.5 christos # Set Spectrum Management subfield in the Capability Information field.
124 1.1.1.5 christos # This config option forces the Spectrum Management bit to be set. When this
125 1.1.1.5 christos # option is not set, the value of the Spectrum Management bit depends on whether
126 1.1.1.5 christos # DFS or TPC is required by regulatory authorities. This can be used only with
127 1.1.1.5 christos # ieee80211d=1 and local_pwr_constraint configured.
128 1.1.1.5 christos #spectrum_mgmt_required=1
129 1.1.1.5 christos
130 1.1.1.7 christos # Operation mode (a = IEEE 802.11a (5 GHz), b = IEEE 802.11b (2.4 GHz),
131 1.1.1.7 christos # g = IEEE 802.11g (2.4 GHz), ad = IEEE 802.11ad (60 GHz); a/g options are used
132 1.1.1.7 christos # with IEEE 802.11n (HT), too, to specify band). For IEEE 802.11ac (VHT), this
133 1.1.1.7 christos # needs to be set to hw_mode=a. When using ACS (see channel parameter), a
134 1.1.1.7 christos # special value "any" can be used to indicate that any support band can be used.
135 1.1.1.7 christos # This special case is currently supported only with drivers with which
136 1.1.1.7 christos # offloaded ACS is used.
137 1.1 christos # Default: IEEE 802.11b
138 1.1.1.3 christos hw_mode=g
139 1.1 christos
140 1.1 christos # Channel number (IEEE 802.11)
141 1.1 christos # (default: 0, i.e., not set)
142 1.1.1.3 christos # Please note that some drivers do not use this value from hostapd and the
143 1.1.1.3 christos # channel will need to be configured separately with iwconfig.
144 1.1.1.5 christos #
145 1.1.1.5 christos # If CONFIG_ACS build option is enabled, the channel can be selected
146 1.1.1.5 christos # automatically at run time by setting channel=acs_survey or channel=0, both of
147 1.1.1.5 christos # which will enable the ACS survey based algorithm.
148 1.1.1.3 christos channel=1
149 1.1 christos
150 1.1.1.5 christos # ACS tuning - Automatic Channel Selection
151 1.1.1.5 christos # See: http://wireless.kernel.org/en/users/Documentation/acs
152 1.1.1.5 christos #
153 1.1.1.5 christos # You can customize the ACS survey algorithm with following variables:
154 1.1.1.5 christos #
155 1.1.1.5 christos # acs_num_scans requirement is 1..100 - number of scans to be performed that
156 1.1.1.5 christos # are used to trigger survey data gathering of an underlying device driver.
157 1.1.1.5 christos # Scans are passive and typically take a little over 100ms (depending on the
158 1.1.1.5 christos # driver) on each available channel for given hw_mode. Increasing this value
159 1.1.1.5 christos # means sacrificing startup time and gathering more data wrt channel
160 1.1.1.5 christos # interference that may help choosing a better channel. This can also help fine
161 1.1.1.5 christos # tune the ACS scan time in case a driver has different scan dwell times.
162 1.1.1.5 christos #
163 1.1.1.6 christos # acs_chan_bias is a space-separated list of <channel>:<bias> pairs. It can be
164 1.1.1.6 christos # used to increase (or decrease) the likelihood of a specific channel to be
165 1.1.1.6 christos # selected by the ACS algorithm. The total interference factor for each channel
166 1.1.1.6 christos # gets multiplied by the specified bias value before finding the channel with
167 1.1.1.6 christos # the lowest value. In other words, values between 0.0 and 1.0 can be used to
168 1.1.1.6 christos # make a channel more likely to be picked while values larger than 1.0 make the
169 1.1.1.6 christos # specified channel less likely to be picked. This can be used, e.g., to prefer
170 1.1.1.6 christos # the commonly used 2.4 GHz band channels 1, 6, and 11 (which is the default
171 1.1.1.6 christos # behavior on 2.4 GHz band if no acs_chan_bias parameter is specified).
172 1.1.1.6 christos #
173 1.1.1.5 christos # Defaults:
174 1.1.1.5 christos #acs_num_scans=5
175 1.1.1.6 christos #acs_chan_bias=1:0.8 6:0.8 11:0.8
176 1.1.1.5 christos
177 1.1.1.5 christos # Channel list restriction. This option allows hostapd to select one of the
178 1.1.1.6 christos # provided channels when a channel should be automatically selected.
179 1.1.1.7 christos # Channel list can be provided as range using hyphen ('-') or individual
180 1.1.1.7 christos # channels can be specified by space (' ') separated values
181 1.1.1.7 christos # Default: all channels allowed in selected hw_mode
182 1.1.1.5 christos #chanlist=100 104 108 112 116
183 1.1.1.7 christos #chanlist=1 6 11-13
184 1.1.1.5 christos
185 1.1 christos # Beacon interval in kus (1.024 ms) (default: 100; range 15..65535)
186 1.1 christos beacon_int=100
187 1.1 christos
188 1.1.1.3 christos # DTIM (delivery traffic information message) period (range 1..255):
189 1.1 christos # number of beacons between DTIMs (1 = every beacon includes DTIM element)
190 1.1 christos # (default: 2)
191 1.1 christos dtim_period=2
192 1.1 christos
193 1.1 christos # Maximum number of stations allowed in station table. New stations will be
194 1.1 christos # rejected after the station table is full. IEEE 802.11 has a limit of 2007
195 1.1 christos # different association IDs, so this number should not be larger than that.
196 1.1 christos # (default: 2007)
197 1.1 christos max_num_sta=255
198 1.1 christos
199 1.1.1.7 christos # RTS/CTS threshold; -1 = disabled (default); range -1..65535
200 1.1 christos # If this field is not included in hostapd.conf, hostapd will not control
201 1.1 christos # RTS threshold and 'iwconfig wlan# rts <val>' can be used to set it.
202 1.1.1.7 christos rts_threshold=-1
203 1.1 christos
204 1.1.1.7 christos # Fragmentation threshold; -1 = disabled (default); range -1, 256..2346
205 1.1 christos # If this field is not included in hostapd.conf, hostapd will not control
206 1.1 christos # fragmentation threshold and 'iwconfig wlan# frag <val>' can be used to set
207 1.1 christos # it.
208 1.1.1.7 christos fragm_threshold=-1
209 1.1 christos
210 1.1 christos # Rate configuration
211 1.1 christos # Default is to enable all rates supported by the hardware. This configuration
212 1.1 christos # item allows this list be filtered so that only the listed rates will be left
213 1.1 christos # in the list. If the list is empty, all rates are used. This list can have
214 1.1 christos # entries that are not in the list of rates the hardware supports (such entries
215 1.1 christos # are ignored). The entries in this list are in 100 kbps, i.e., 11 Mbps = 110.
216 1.1 christos # If this item is present, at least one rate have to be matching with the rates
217 1.1 christos # hardware supports.
218 1.1 christos # default: use the most common supported rate setting for the selected
219 1.1 christos # hw_mode (i.e., this line can be removed from configuration file in most
220 1.1 christos # cases)
221 1.1 christos #supported_rates=10 20 55 110 60 90 120 180 240 360 480 540
222 1.1 christos
223 1.1 christos # Basic rate set configuration
224 1.1 christos # List of rates (in 100 kbps) that are included in the basic rate set.
225 1.1 christos # If this item is not included, usually reasonable default set is used.
226 1.1 christos #basic_rates=10 20
227 1.1 christos #basic_rates=10 20 55 110
228 1.1 christos #basic_rates=60 120 240
229 1.1 christos
230 1.1 christos # Short Preamble
231 1.1 christos # This parameter can be used to enable optional use of short preamble for
232 1.1 christos # frames sent at 2 Mbps, 5.5 Mbps, and 11 Mbps to improve network performance.
233 1.1 christos # This applies only to IEEE 802.11b-compatible networks and this should only be
234 1.1 christos # enabled if the local hardware supports use of short preamble. If any of the
235 1.1 christos # associated STAs do not support short preamble, use of short preamble will be
236 1.1 christos # disabled (and enabled when such STAs disassociate) dynamically.
237 1.1 christos # 0 = do not allow use of short preamble (default)
238 1.1 christos # 1 = allow use of short preamble
239 1.1 christos #preamble=1
240 1.1 christos
241 1.1 christos # Station MAC address -based authentication
242 1.1 christos # Please note that this kind of access control requires a driver that uses
243 1.1 christos # hostapd to take care of management frame processing and as such, this can be
244 1.1.1.6 christos # used with driver=hostap or driver=nl80211, but not with driver=atheros.
245 1.1 christos # 0 = accept unless in deny list
246 1.1 christos # 1 = deny unless in accept list
247 1.1 christos # 2 = use external RADIUS server (accept/deny lists are searched first)
248 1.1 christos macaddr_acl=0
249 1.1 christos
250 1.1 christos # Accept/deny lists are read from separate files (containing list of
251 1.1 christos # MAC addresses, one per line). Use absolute path name to make sure that the
252 1.1 christos # files can be read on SIGHUP configuration reloads.
253 1.1 christos #accept_mac_file=/etc/hostapd.accept
254 1.1 christos #deny_mac_file=/etc/hostapd.deny
255 1.1 christos
256 1.1 christos # IEEE 802.11 specifies two authentication algorithms. hostapd can be
257 1.1 christos # configured to allow both of these or only one. Open system authentication
258 1.1 christos # should be used with IEEE 802.1X.
259 1.1 christos # Bit fields of allowed authentication algorithms:
260 1.1 christos # bit 0 = Open System Authentication
261 1.1 christos # bit 1 = Shared Key Authentication (requires WEP)
262 1.1 christos auth_algs=3
263 1.1 christos
264 1.1 christos # Send empty SSID in beacons and ignore probe request frames that do not
265 1.1 christos # specify full SSID, i.e., require stations to know SSID.
266 1.1 christos # default: disabled (0)
267 1.1 christos # 1 = send empty (length=0) SSID in beacon and ignore probe request for
268 1.1 christos # broadcast SSID
269 1.1 christos # 2 = clear SSID (ASCII 0), but keep the original length (this may be required
270 1.1 christos # with some clients that do not support empty SSID) and ignore probe
271 1.1 christos # requests for broadcast SSID
272 1.1 christos ignore_broadcast_ssid=0
273 1.1 christos
274 1.1.1.7 christos # Do not reply to broadcast Probe Request frames from unassociated STA if there
275 1.1.1.7 christos # is no room for additional stations (max_num_sta). This can be used to
276 1.1.1.7 christos # discourage a STA from trying to associate with this AP if the association
277 1.1.1.7 christos # would be rejected due to maximum STA limit.
278 1.1.1.7 christos # Default: 0 (disabled)
279 1.1.1.7 christos #no_probe_resp_if_max_sta=0
280 1.1.1.7 christos
281 1.1.1.7 christos # Additional vendor specific elements for Beacon and Probe Response frames
282 1.1.1.4 christos # This parameter can be used to add additional vendor specific element(s) into
283 1.1.1.4 christos # the end of the Beacon and Probe Response frames. The format for these
284 1.1.1.4 christos # element(s) is a hexdump of the raw information elements (id+len+payload for
285 1.1.1.4 christos # one or more elements)
286 1.1.1.4 christos #vendor_elements=dd0411223301
287 1.1.1.4 christos
288 1.1.1.7 christos # Additional vendor specific elements for (Re)Association Response frames
289 1.1.1.7 christos # This parameter can be used to add additional vendor specific element(s) into
290 1.1.1.7 christos # the end of the (Re)Association Response frames. The format for these
291 1.1.1.7 christos # element(s) is a hexdump of the raw information elements (id+len+payload for
292 1.1.1.7 christos # one or more elements)
293 1.1.1.7 christos #assocresp_elements=dd0411223301
294 1.1.1.7 christos
295 1.1 christos # TX queue parameters (EDCF / bursting)
296 1.1 christos # tx_queue_<queue name>_<param>
297 1.1 christos # queues: data0, data1, data2, data3, after_beacon, beacon
298 1.1 christos # (data0 is the highest priority queue)
299 1.1 christos # parameters:
300 1.1 christos # aifs: AIFS (default 2)
301 1.1.1.7 christos # cwmin: cwMin (1, 3, 7, 15, 31, 63, 127, 255, 511, 1023, 2047, 4095, 8191,
302 1.1.1.7 christos # 16383, 32767)
303 1.1.1.7 christos # cwmax: cwMax (same values as cwMin, cwMax >= cwMin)
304 1.1 christos # burst: maximum length (in milliseconds with precision of up to 0.1 ms) for
305 1.1 christos # bursting
306 1.1 christos #
307 1.1 christos # Default WMM parameters (IEEE 802.11 draft; 11-03-0504-03-000e):
308 1.1 christos # These parameters are used by the access point when transmitting frames
309 1.1 christos # to the clients.
310 1.1 christos #
311 1.1 christos # Low priority / AC_BK = background
312 1.1 christos #tx_queue_data3_aifs=7
313 1.1 christos #tx_queue_data3_cwmin=15
314 1.1 christos #tx_queue_data3_cwmax=1023
315 1.1 christos #tx_queue_data3_burst=0
316 1.1 christos # Note: for IEEE 802.11b mode: cWmin=31 cWmax=1023 burst=0
317 1.1 christos #
318 1.1 christos # Normal priority / AC_BE = best effort
319 1.1 christos #tx_queue_data2_aifs=3
320 1.1 christos #tx_queue_data2_cwmin=15
321 1.1 christos #tx_queue_data2_cwmax=63
322 1.1 christos #tx_queue_data2_burst=0
323 1.1 christos # Note: for IEEE 802.11b mode: cWmin=31 cWmax=127 burst=0
324 1.1 christos #
325 1.1 christos # High priority / AC_VI = video
326 1.1 christos #tx_queue_data1_aifs=1
327 1.1 christos #tx_queue_data1_cwmin=7
328 1.1 christos #tx_queue_data1_cwmax=15
329 1.1 christos #tx_queue_data1_burst=3.0
330 1.1 christos # Note: for IEEE 802.11b mode: cWmin=15 cWmax=31 burst=6.0
331 1.1 christos #
332 1.1 christos # Highest priority / AC_VO = voice
333 1.1 christos #tx_queue_data0_aifs=1
334 1.1 christos #tx_queue_data0_cwmin=3
335 1.1 christos #tx_queue_data0_cwmax=7
336 1.1 christos #tx_queue_data0_burst=1.5
337 1.1 christos # Note: for IEEE 802.11b mode: cWmin=7 cWmax=15 burst=3.3
338 1.1 christos
339 1.1 christos # 802.1D Tag (= UP) to AC mappings
340 1.1 christos # WMM specifies following mapping of data frames to different ACs. This mapping
341 1.1 christos # can be configured using Linux QoS/tc and sch_pktpri.o module.
342 1.1 christos # 802.1D Tag 802.1D Designation Access Category WMM Designation
343 1.1 christos # 1 BK AC_BK Background
344 1.1 christos # 2 - AC_BK Background
345 1.1 christos # 0 BE AC_BE Best Effort
346 1.1 christos # 3 EE AC_BE Best Effort
347 1.1 christos # 4 CL AC_VI Video
348 1.1 christos # 5 VI AC_VI Video
349 1.1 christos # 6 VO AC_VO Voice
350 1.1 christos # 7 NC AC_VO Voice
351 1.1 christos # Data frames with no priority information: AC_BE
352 1.1 christos # Management frames: AC_VO
353 1.1 christos # PS-Poll frames: AC_BE
354 1.1 christos
355 1.1 christos # Default WMM parameters (IEEE 802.11 draft; 11-03-0504-03-000e):
356 1.1 christos # for 802.11a or 802.11g networks
357 1.1 christos # These parameters are sent to WMM clients when they associate.
358 1.1 christos # The parameters will be used by WMM clients for frames transmitted to the
359 1.1 christos # access point.
360 1.1 christos #
361 1.1 christos # note - txop_limit is in units of 32microseconds
362 1.1 christos # note - acm is admission control mandatory flag. 0 = admission control not
363 1.1 christos # required, 1 = mandatory
364 1.1.1.7 christos # note - Here cwMin and cmMax are in exponent form. The actual cw value used
365 1.1.1.7 christos # will be (2^n)-1 where n is the value given here. The allowed range for these
366 1.1.1.7 christos # wmm_ac_??_{cwmin,cwmax} is 0..15 with cwmax >= cwmin.
367 1.1 christos #
368 1.1 christos wmm_enabled=1
369 1.1 christos #
370 1.1 christos # WMM-PS Unscheduled Automatic Power Save Delivery [U-APSD]
371 1.1 christos # Enable this flag if U-APSD supported outside hostapd (eg., Firmware/driver)
372 1.1 christos #uapsd_advertisement_enabled=1
373 1.1 christos #
374 1.1 christos # Low priority / AC_BK = background
375 1.1 christos wmm_ac_bk_cwmin=4
376 1.1 christos wmm_ac_bk_cwmax=10
377 1.1 christos wmm_ac_bk_aifs=7
378 1.1 christos wmm_ac_bk_txop_limit=0
379 1.1 christos wmm_ac_bk_acm=0
380 1.1 christos # Note: for IEEE 802.11b mode: cWmin=5 cWmax=10
381 1.1 christos #
382 1.1 christos # Normal priority / AC_BE = best effort
383 1.1 christos wmm_ac_be_aifs=3
384 1.1 christos wmm_ac_be_cwmin=4
385 1.1 christos wmm_ac_be_cwmax=10
386 1.1 christos wmm_ac_be_txop_limit=0
387 1.1 christos wmm_ac_be_acm=0
388 1.1 christos # Note: for IEEE 802.11b mode: cWmin=5 cWmax=7
389 1.1 christos #
390 1.1 christos # High priority / AC_VI = video
391 1.1 christos wmm_ac_vi_aifs=2
392 1.1 christos wmm_ac_vi_cwmin=3
393 1.1 christos wmm_ac_vi_cwmax=4
394 1.1 christos wmm_ac_vi_txop_limit=94
395 1.1 christos wmm_ac_vi_acm=0
396 1.1 christos # Note: for IEEE 802.11b mode: cWmin=4 cWmax=5 txop_limit=188
397 1.1 christos #
398 1.1 christos # Highest priority / AC_VO = voice
399 1.1 christos wmm_ac_vo_aifs=2
400 1.1 christos wmm_ac_vo_cwmin=2
401 1.1 christos wmm_ac_vo_cwmax=3
402 1.1 christos wmm_ac_vo_txop_limit=47
403 1.1 christos wmm_ac_vo_acm=0
404 1.1 christos # Note: for IEEE 802.11b mode: cWmin=3 cWmax=4 burst=102
405 1.1 christos
406 1.1 christos # Static WEP key configuration
407 1.1 christos #
408 1.1 christos # The key number to use when transmitting.
409 1.1 christos # It must be between 0 and 3, and the corresponding key must be set.
410 1.1 christos # default: not set
411 1.1 christos #wep_default_key=0
412 1.1 christos # The WEP keys to use.
413 1.1 christos # A key may be a quoted string or unquoted hexadecimal digits.
414 1.1 christos # The key length should be 5, 13, or 16 characters, or 10, 26, or 32
415 1.1 christos # digits, depending on whether 40-bit (64-bit), 104-bit (128-bit), or
416 1.1 christos # 128-bit (152-bit) WEP is used.
417 1.1 christos # Only the default key must be supplied; the others are optional.
418 1.1 christos # default: not set
419 1.1 christos #wep_key0=123456789a
420 1.1 christos #wep_key1="vwxyz"
421 1.1 christos #wep_key2=0102030405060708090a0b0c0d
422 1.1 christos #wep_key3=".2.4.6.8.0.23"
423 1.1 christos
424 1.1 christos # Station inactivity limit
425 1.1 christos #
426 1.1 christos # If a station does not send anything in ap_max_inactivity seconds, an
427 1.1 christos # empty data frame is sent to it in order to verify whether it is
428 1.1 christos # still in range. If this frame is not ACKed, the station will be
429 1.1 christos # disassociated and then deauthenticated. This feature is used to
430 1.1 christos # clear station table of old entries when the STAs move out of the
431 1.1 christos # range.
432 1.1 christos #
433 1.1 christos # The station can associate again with the AP if it is still in range;
434 1.1 christos # this inactivity poll is just used as a nicer way of verifying
435 1.1 christos # inactivity; i.e., client will not report broken connection because
436 1.1 christos # disassociation frame is not sent immediately without first polling
437 1.1 christos # the STA with a data frame.
438 1.1 christos # default: 300 (i.e., 5 minutes)
439 1.1 christos #ap_max_inactivity=300
440 1.1.1.4 christos #
441 1.1.1.4 christos # The inactivity polling can be disabled to disconnect stations based on
442 1.1.1.4 christos # inactivity timeout so that idle stations are more likely to be disconnected
443 1.1.1.4 christos # even if they are still in range of the AP. This can be done by setting
444 1.1.1.4 christos # skip_inactivity_poll to 1 (default 0).
445 1.1.1.4 christos #skip_inactivity_poll=0
446 1.1 christos
447 1.1.1.3 christos # Disassociate stations based on excessive transmission failures or other
448 1.1.1.3 christos # indications of connection loss. This depends on the driver capabilities and
449 1.1.1.3 christos # may not be available with all drivers.
450 1.1.1.3 christos #disassoc_low_ack=1
451 1.1.1.3 christos
452 1.1 christos # Maximum allowed Listen Interval (how many Beacon periods STAs are allowed to
453 1.1 christos # remain asleep). Default: 65535 (no limit apart from field size)
454 1.1 christos #max_listen_interval=100
455 1.1 christos
456 1.1 christos # WDS (4-address frame) mode with per-station virtual interfaces
457 1.1 christos # (only supported with driver=nl80211)
458 1.1 christos # This mode allows associated stations to use 4-address frames to allow layer 2
459 1.1 christos # bridging to be used.
460 1.1 christos #wds_sta=1
461 1.1 christos
462 1.1.1.3 christos # If bridge parameter is set, the WDS STA interface will be added to the same
463 1.1.1.3 christos # bridge by default. This can be overridden with the wds_bridge parameter to
464 1.1.1.3 christos # use a separate bridge.
465 1.1.1.3 christos #wds_bridge=wds-br0
466 1.1.1.3 christos
467 1.1.1.5 christos # Start the AP with beaconing disabled by default.
468 1.1.1.5 christos #start_disabled=0
469 1.1.1.5 christos
470 1.1.1.3 christos # Client isolation can be used to prevent low-level bridging of frames between
471 1.1.1.3 christos # associated stations in the BSS. By default, this bridging is allowed.
472 1.1.1.3 christos #ap_isolate=1
473 1.1.1.3 christos
474 1.1.1.6 christos # BSS Load update period (in BUs)
475 1.1.1.6 christos # This field is used to enable and configure adding a BSS Load element into
476 1.1.1.6 christos # Beacon and Probe Response frames.
477 1.1.1.6 christos #bss_load_update_period=50
478 1.1.1.6 christos
479 1.1.1.5 christos # Fixed BSS Load value for testing purposes
480 1.1.1.5 christos # This field can be used to configure hostapd to add a fixed BSS Load element
481 1.1.1.5 christos # into Beacon and Probe Response frames for testing purposes. The format is
482 1.1.1.5 christos # <station count>:<channel utilization>:<available admission capacity>
483 1.1.1.5 christos #bss_load_test=12:80:20000
484 1.1.1.5 christos
485 1.1 christos ##### IEEE 802.11n related configuration ######################################
486 1.1 christos
487 1.1 christos # ieee80211n: Whether IEEE 802.11n (HT) is enabled
488 1.1 christos # 0 = disabled (default)
489 1.1 christos # 1 = enabled
490 1.1 christos # Note: You will also need to enable WMM for full HT functionality.
491 1.1.1.7 christos # Note: hw_mode=g (2.4 GHz) and hw_mode=a (5 GHz) is used to specify the band.
492 1.1 christos #ieee80211n=1
493 1.1 christos
494 1.1 christos # ht_capab: HT capabilities (list of flags)
495 1.1 christos # LDPC coding capability: [LDPC] = supported
496 1.1 christos # Supported channel width set: [HT40-] = both 20 MHz and 40 MHz with secondary
497 1.1 christos # channel below the primary channel; [HT40+] = both 20 MHz and 40 MHz
498 1.1.1.5 christos # with secondary channel above the primary channel
499 1.1 christos # (20 MHz only if neither is set)
500 1.1 christos # Note: There are limits on which channels can be used with HT40- and
501 1.1 christos # HT40+. Following table shows the channels that may be available for
502 1.1 christos # HT40- and HT40+ use per IEEE 802.11n Annex J:
503 1.1 christos # freq HT40- HT40+
504 1.1 christos # 2.4 GHz 5-13 1-7 (1-9 in Europe/Japan)
505 1.1 christos # 5 GHz 40,48,56,64 36,44,52,60
506 1.1 christos # (depending on the location, not all of these channels may be available
507 1.1 christos # for use)
508 1.1 christos # Please note that 40 MHz channels may switch their primary and secondary
509 1.1 christos # channels if needed or creation of 40 MHz channel maybe rejected based
510 1.1 christos # on overlapping BSSes. These changes are done automatically when hostapd
511 1.1 christos # is setting up the 40 MHz channel.
512 1.1 christos # Spatial Multiplexing (SM) Power Save: [SMPS-STATIC] or [SMPS-DYNAMIC]
513 1.1 christos # (SMPS disabled if neither is set)
514 1.1 christos # HT-greenfield: [GF] (disabled if not set)
515 1.1 christos # Short GI for 20 MHz: [SHORT-GI-20] (disabled if not set)
516 1.1 christos # Short GI for 40 MHz: [SHORT-GI-40] (disabled if not set)
517 1.1 christos # Tx STBC: [TX-STBC] (disabled if not set)
518 1.1 christos # Rx STBC: [RX-STBC1] (one spatial stream), [RX-STBC12] (one or two spatial
519 1.1 christos # streams), or [RX-STBC123] (one, two, or three spatial streams); Rx STBC
520 1.1 christos # disabled if none of these set
521 1.1 christos # HT-delayed Block Ack: [DELAYED-BA] (disabled if not set)
522 1.1 christos # Maximum A-MSDU length: [MAX-AMSDU-7935] for 7935 octets (3839 octets if not
523 1.1 christos # set)
524 1.1 christos # DSSS/CCK Mode in 40 MHz: [DSSS_CCK-40] = allowed (not allowed if not set)
525 1.1.1.5 christos # 40 MHz intolerant [40-INTOLERANT] (not advertised if not set)
526 1.1 christos # L-SIG TXOP protection support: [LSIG-TXOP-PROT] (disabled if not set)
527 1.1 christos #ht_capab=[HT40-][SHORT-GI-20][SHORT-GI-40]
528 1.1 christos
529 1.1.1.3 christos # Require stations to support HT PHY (reject association if they do not)
530 1.1.1.3 christos #require_ht=1
531 1.1.1.3 christos
532 1.1.1.5 christos # If set non-zero, require stations to perform scans of overlapping
533 1.1.1.5 christos # channels to test for stations which would be affected by 40 MHz traffic.
534 1.1.1.6 christos # This parameter sets the interval in seconds between these scans. Setting this
535 1.1.1.6 christos # to non-zero allows 2.4 GHz band AP to move dynamically to a 40 MHz channel if
536 1.1.1.6 christos # no co-existence issues with neighboring devices are found.
537 1.1.1.5 christos #obss_interval=0
538 1.1.1.5 christos
539 1.1.1.4 christos ##### IEEE 802.11ac related configuration #####################################
540 1.1.1.4 christos
541 1.1.1.4 christos # ieee80211ac: Whether IEEE 802.11ac (VHT) is enabled
542 1.1.1.4 christos # 0 = disabled (default)
543 1.1.1.4 christos # 1 = enabled
544 1.1.1.4 christos # Note: You will also need to enable WMM for full VHT functionality.
545 1.1.1.7 christos # Note: hw_mode=a is used to specify that 5 GHz band is used with VHT.
546 1.1.1.4 christos #ieee80211ac=1
547 1.1.1.4 christos
548 1.1.1.4 christos # vht_capab: VHT capabilities (list of flags)
549 1.1.1.4 christos #
550 1.1.1.4 christos # vht_max_mpdu_len: [MAX-MPDU-7991] [MAX-MPDU-11454]
551 1.1.1.4 christos # Indicates maximum MPDU length
552 1.1.1.4 christos # 0 = 3895 octets (default)
553 1.1.1.4 christos # 1 = 7991 octets
554 1.1.1.4 christos # 2 = 11454 octets
555 1.1.1.4 christos # 3 = reserved
556 1.1.1.4 christos #
557 1.1.1.4 christos # supported_chan_width: [VHT160] [VHT160-80PLUS80]
558 1.1.1.4 christos # Indicates supported Channel widths
559 1.1.1.4 christos # 0 = 160 MHz & 80+80 channel widths are not supported (default)
560 1.1.1.4 christos # 1 = 160 MHz channel width is supported
561 1.1.1.4 christos # 2 = 160 MHz & 80+80 channel widths are supported
562 1.1.1.4 christos # 3 = reserved
563 1.1.1.4 christos #
564 1.1.1.4 christos # Rx LDPC coding capability: [RXLDPC]
565 1.1.1.4 christos # Indicates support for receiving LDPC coded pkts
566 1.1.1.4 christos # 0 = Not supported (default)
567 1.1.1.4 christos # 1 = Supported
568 1.1.1.4 christos #
569 1.1.1.4 christos # Short GI for 80 MHz: [SHORT-GI-80]
570 1.1.1.4 christos # Indicates short GI support for reception of packets transmitted with TXVECTOR
571 1.1.1.4 christos # params format equal to VHT and CBW = 80Mhz
572 1.1.1.4 christos # 0 = Not supported (default)
573 1.1.1.4 christos # 1 = Supported
574 1.1.1.4 christos #
575 1.1.1.4 christos # Short GI for 160 MHz: [SHORT-GI-160]
576 1.1.1.4 christos # Indicates short GI support for reception of packets transmitted with TXVECTOR
577 1.1.1.4 christos # params format equal to VHT and CBW = 160Mhz
578 1.1.1.4 christos # 0 = Not supported (default)
579 1.1.1.4 christos # 1 = Supported
580 1.1.1.4 christos #
581 1.1.1.4 christos # Tx STBC: [TX-STBC-2BY1]
582 1.1.1.4 christos # Indicates support for the transmission of at least 2x1 STBC
583 1.1.1.4 christos # 0 = Not supported (default)
584 1.1.1.4 christos # 1 = Supported
585 1.1.1.4 christos #
586 1.1.1.4 christos # Rx STBC: [RX-STBC-1] [RX-STBC-12] [RX-STBC-123] [RX-STBC-1234]
587 1.1.1.4 christos # Indicates support for the reception of PPDUs using STBC
588 1.1.1.4 christos # 0 = Not supported (default)
589 1.1.1.4 christos # 1 = support of one spatial stream
590 1.1.1.4 christos # 2 = support of one and two spatial streams
591 1.1.1.4 christos # 3 = support of one, two and three spatial streams
592 1.1.1.4 christos # 4 = support of one, two, three and four spatial streams
593 1.1.1.4 christos # 5,6,7 = reserved
594 1.1.1.4 christos #
595 1.1.1.4 christos # SU Beamformer Capable: [SU-BEAMFORMER]
596 1.1.1.4 christos # Indicates support for operation as a single user beamformer
597 1.1.1.4 christos # 0 = Not supported (default)
598 1.1.1.4 christos # 1 = Supported
599 1.1.1.4 christos #
600 1.1.1.4 christos # SU Beamformee Capable: [SU-BEAMFORMEE]
601 1.1.1.4 christos # Indicates support for operation as a single user beamformee
602 1.1.1.4 christos # 0 = Not supported (default)
603 1.1.1.4 christos # 1 = Supported
604 1.1.1.4 christos #
605 1.1.1.7 christos # Compressed Steering Number of Beamformer Antennas Supported:
606 1.1.1.7 christos # [BF-ANTENNA-2] [BF-ANTENNA-3] [BF-ANTENNA-4]
607 1.1.1.4 christos # Beamformee's capability indicating the maximum number of beamformer
608 1.1.1.4 christos # antennas the beamformee can support when sending compressed beamforming
609 1.1.1.4 christos # feedback
610 1.1.1.4 christos # If SU beamformer capable, set to maximum value minus 1
611 1.1.1.4 christos # else reserved (default)
612 1.1.1.4 christos #
613 1.1.1.7 christos # Number of Sounding Dimensions:
614 1.1.1.7 christos # [SOUNDING-DIMENSION-2] [SOUNDING-DIMENSION-3] [SOUNDING-DIMENSION-4]
615 1.1.1.4 christos # Beamformer's capability indicating the maximum value of the NUM_STS parameter
616 1.1.1.4 christos # in the TXVECTOR of a VHT NDP
617 1.1.1.4 christos # If SU beamformer capable, set to maximum value minus 1
618 1.1.1.4 christos # else reserved (default)
619 1.1.1.4 christos #
620 1.1.1.4 christos # MU Beamformer Capable: [MU-BEAMFORMER]
621 1.1.1.4 christos # Indicates support for operation as an MU beamformer
622 1.1.1.4 christos # 0 = Not supported or sent by Non-AP STA (default)
623 1.1.1.4 christos # 1 = Supported
624 1.1.1.4 christos #
625 1.1.1.4 christos # VHT TXOP PS: [VHT-TXOP-PS]
626 1.1.1.4 christos # Indicates whether or not the AP supports VHT TXOP Power Save Mode
627 1.1.1.4 christos # or whether or not the STA is in VHT TXOP Power Save mode
628 1.1.1.7 christos # 0 = VHT AP doesn't support VHT TXOP PS mode (OR) VHT STA not in VHT TXOP PS
629 1.1.1.4 christos # mode
630 1.1.1.7 christos # 1 = VHT AP supports VHT TXOP PS mode (OR) VHT STA is in VHT TXOP power save
631 1.1.1.4 christos # mode
632 1.1.1.4 christos #
633 1.1.1.4 christos # +HTC-VHT Capable: [HTC-VHT]
634 1.1.1.4 christos # Indicates whether or not the STA supports receiving a VHT variant HT Control
635 1.1.1.4 christos # field.
636 1.1.1.4 christos # 0 = Not supported (default)
637 1.1.1.4 christos # 1 = supported
638 1.1.1.4 christos #
639 1.1.1.4 christos # Maximum A-MPDU Length Exponent: [MAX-A-MPDU-LEN-EXP0]..[MAX-A-MPDU-LEN-EXP7]
640 1.1.1.4 christos # Indicates the maximum length of A-MPDU pre-EOF padding that the STA can recv
641 1.1.1.4 christos # This field is an integer in the range of 0 to 7.
642 1.1.1.4 christos # The length defined by this field is equal to
643 1.1.1.4 christos # 2 pow(13 + Maximum A-MPDU Length Exponent) -1 octets
644 1.1.1.4 christos #
645 1.1.1.4 christos # VHT Link Adaptation Capable: [VHT-LINK-ADAPT2] [VHT-LINK-ADAPT3]
646 1.1.1.4 christos # Indicates whether or not the STA supports link adaptation using VHT variant
647 1.1.1.4 christos # HT Control field
648 1.1.1.4 christos # If +HTC-VHTcapable is 1
649 1.1.1.4 christos # 0 = (no feedback) if the STA does not provide VHT MFB (default)
650 1.1.1.4 christos # 1 = reserved
651 1.1.1.4 christos # 2 = (Unsolicited) if the STA provides only unsolicited VHT MFB
652 1.1.1.4 christos # 3 = (Both) if the STA can provide VHT MFB in response to VHT MRQ and if the
653 1.1.1.4 christos # STA provides unsolicited VHT MFB
654 1.1.1.4 christos # Reserved if +HTC-VHTcapable is 0
655 1.1.1.4 christos #
656 1.1.1.4 christos # Rx Antenna Pattern Consistency: [RX-ANTENNA-PATTERN]
657 1.1.1.4 christos # Indicates the possibility of Rx antenna pattern change
658 1.1.1.4 christos # 0 = Rx antenna pattern might change during the lifetime of an association
659 1.1.1.4 christos # 1 = Rx antenna pattern does not change during the lifetime of an association
660 1.1.1.4 christos #
661 1.1.1.4 christos # Tx Antenna Pattern Consistency: [TX-ANTENNA-PATTERN]
662 1.1.1.4 christos # Indicates the possibility of Tx antenna pattern change
663 1.1.1.4 christos # 0 = Tx antenna pattern might change during the lifetime of an association
664 1.1.1.4 christos # 1 = Tx antenna pattern does not change during the lifetime of an association
665 1.1.1.4 christos #vht_capab=[SHORT-GI-80][HTC-VHT]
666 1.1.1.4 christos #
667 1.1.1.4 christos # Require stations to support VHT PHY (reject association if they do not)
668 1.1.1.4 christos #require_vht=1
669 1.1.1.4 christos
670 1.1.1.4 christos # 0 = 20 or 40 MHz operating Channel width
671 1.1.1.4 christos # 1 = 80 MHz channel width
672 1.1.1.4 christos # 2 = 160 MHz channel width
673 1.1.1.4 christos # 3 = 80+80 MHz channel width
674 1.1.1.4 christos #vht_oper_chwidth=1
675 1.1.1.4 christos #
676 1.1.1.4 christos # center freq = 5 GHz + (5 * index)
677 1.1.1.4 christos # So index 42 gives center freq 5.210 GHz
678 1.1.1.4 christos # which is channel 42 in 5G band
679 1.1.1.4 christos #
680 1.1.1.4 christos #vht_oper_centr_freq_seg0_idx=42
681 1.1.1.4 christos #
682 1.1.1.4 christos # center freq = 5 GHz + (5 * index)
683 1.1.1.4 christos # So index 159 gives center freq 5.795 GHz
684 1.1.1.4 christos # which is channel 159 in 5G band
685 1.1.1.4 christos #
686 1.1.1.4 christos #vht_oper_centr_freq_seg1_idx=159
687 1.1.1.4 christos
688 1.1.1.7 christos # Workaround to use station's nsts capability in (Re)Association Response frame
689 1.1.1.7 christos # This may be needed with some deployed devices as an interoperability
690 1.1.1.7 christos # workaround for beamforming if the AP's capability is greater than the
691 1.1.1.7 christos # station's capability. This is disabled by default and can be enabled by
692 1.1.1.7 christos # setting use_sta_nsts=1.
693 1.1.1.7 christos #use_sta_nsts=0
694 1.1.1.7 christos
695 1.1 christos ##### IEEE 802.1X-2004 related configuration ##################################
696 1.1 christos
697 1.1 christos # Require IEEE 802.1X authorization
698 1.1 christos #ieee8021x=1
699 1.1 christos
700 1.1 christos # IEEE 802.1X/EAPOL version
701 1.1 christos # hostapd is implemented based on IEEE Std 802.1X-2004 which defines EAPOL
702 1.1 christos # version 2. However, there are many client implementations that do not handle
703 1.1 christos # the new version number correctly (they seem to drop the frames completely).
704 1.1 christos # In order to make hostapd interoperate with these clients, the version number
705 1.1 christos # can be set to the older version (1) with this configuration value.
706 1.1 christos #eapol_version=2
707 1.1 christos
708 1.1 christos # Optional displayable message sent with EAP Request-Identity. The first \0
709 1.1 christos # in this string will be converted to ASCII-0 (nul). This can be used to
710 1.1 christos # separate network info (comma separated list of attribute=value pairs); see,
711 1.1 christos # e.g., RFC 4284.
712 1.1 christos #eap_message=hello
713 1.1 christos #eap_message=hello\0networkid=netw,nasid=foo,portid=0,NAIRealms=example.com
714 1.1 christos
715 1.1 christos # WEP rekeying (disabled if key lengths are not set or are set to 0)
716 1.1 christos # Key lengths for default/broadcast and individual/unicast keys:
717 1.1 christos # 5 = 40-bit WEP (also known as 64-bit WEP with 40 secret bits)
718 1.1 christos # 13 = 104-bit WEP (also known as 128-bit WEP with 104 secret bits)
719 1.1 christos #wep_key_len_broadcast=5
720 1.1 christos #wep_key_len_unicast=5
721 1.1 christos # Rekeying period in seconds. 0 = do not rekey (i.e., set keys only once)
722 1.1 christos #wep_rekey_period=300
723 1.1 christos
724 1.1 christos # EAPOL-Key index workaround (set bit7) for WinXP Supplicant (needed only if
725 1.1 christos # only broadcast keys are used)
726 1.1 christos eapol_key_index_workaround=0
727 1.1 christos
728 1.1 christos # EAP reauthentication period in seconds (default: 3600 seconds; 0 = disable
729 1.1 christos # reauthentication).
730 1.1 christos #eap_reauth_period=3600
731 1.1 christos
732 1.1 christos # Use PAE group address (01:80:c2:00:00:03) instead of individual target
733 1.1 christos # address when sending EAPOL frames with driver=wired. This is the most common
734 1.1 christos # mechanism used in wired authentication, but it also requires that the port
735 1.1 christos # is only used by one station.
736 1.1 christos #use_pae_group_addr=1
737 1.1 christos
738 1.1.1.6 christos # EAP Re-authentication Protocol (ERP) authenticator (RFC 6696)
739 1.1.1.6 christos #
740 1.1.1.6 christos # Whether to initiate EAP authentication with EAP-Initiate/Re-auth-Start before
741 1.1.1.6 christos # EAP-Identity/Request
742 1.1.1.6 christos #erp_send_reauth_start=1
743 1.1.1.6 christos #
744 1.1.1.6 christos # Domain name for EAP-Initiate/Re-auth-Start. Omitted from the message if not
745 1.1.1.6 christos # set (no local ER server). This is also used by the integrated EAP server if
746 1.1.1.6 christos # ERP is enabled (eap_server_erp=1).
747 1.1.1.6 christos #erp_domain=example.com
748 1.1.1.6 christos
749 1.1 christos ##### Integrated EAP server ###################################################
750 1.1 christos
751 1.1 christos # Optionally, hostapd can be configured to use an integrated EAP server
752 1.1 christos # to process EAP authentication locally without need for an external RADIUS
753 1.1 christos # server. This functionality can be used both as a local authentication server
754 1.1 christos # for IEEE 802.1X/EAPOL and as a RADIUS server for other devices.
755 1.1 christos
756 1.1 christos # Use integrated EAP server instead of external RADIUS authentication
757 1.1 christos # server. This is also needed if hostapd is configured to act as a RADIUS
758 1.1 christos # authentication server.
759 1.1 christos eap_server=0
760 1.1 christos
761 1.1 christos # Path for EAP server user database
762 1.1.1.4 christos # If SQLite support is included, this can be set to "sqlite:/path/to/sqlite.db"
763 1.1.1.4 christos # to use SQLite database instead of a text file.
764 1.1 christos #eap_user_file=/etc/hostapd.eap_user
765 1.1 christos
766 1.1 christos # CA certificate (PEM or DER file) for EAP-TLS/PEAP/TTLS
767 1.1 christos #ca_cert=/etc/hostapd.ca.pem
768 1.1 christos
769 1.1 christos # Server certificate (PEM or DER file) for EAP-TLS/PEAP/TTLS
770 1.1 christos #server_cert=/etc/hostapd.server.pem
771 1.1 christos
772 1.1 christos # Private key matching with the server certificate for EAP-TLS/PEAP/TTLS
773 1.1 christos # This may point to the same file as server_cert if both certificate and key
774 1.1 christos # are included in a single file. PKCS#12 (PFX) file (.p12/.pfx) can also be
775 1.1 christos # used by commenting out server_cert and specifying the PFX file as the
776 1.1 christos # private_key.
777 1.1 christos #private_key=/etc/hostapd.server.prv
778 1.1 christos
779 1.1 christos # Passphrase for private key
780 1.1 christos #private_key_passwd=secret passphrase
781 1.1 christos
782 1.1.1.5 christos # Server identity
783 1.1.1.5 christos # EAP methods that provide mechanism for authenticated server identity delivery
784 1.1.1.5 christos # use this value. If not set, "hostapd" is used as a default.
785 1.1.1.5 christos #server_id=server.example.com
786 1.1.1.5 christos
787 1.1 christos # Enable CRL verification.
788 1.1 christos # Note: hostapd does not yet support CRL downloading based on CDP. Thus, a
789 1.1 christos # valid CRL signed by the CA is required to be included in the ca_cert file.
790 1.1 christos # This can be done by using PEM format for CA certificate and CRL and
791 1.1 christos # concatenating these into one file. Whenever CRL changes, hostapd needs to be
792 1.1 christos # restarted to take the new CRL into use.
793 1.1 christos # 0 = do not verify CRLs (default)
794 1.1 christos # 1 = check the CRL of the user certificate
795 1.1 christos # 2 = check all CRLs in the certificate path
796 1.1 christos #check_crl=1
797 1.1 christos
798 1.1.1.7 christos # TLS Session Lifetime in seconds
799 1.1.1.7 christos # This can be used to allow TLS sessions to be cached and resumed with an
800 1.1.1.7 christos # abbreviated handshake when using EAP-TLS/TTLS/PEAP.
801 1.1.1.7 christos # (default: 0 = session caching and resumption disabled)
802 1.1.1.7 christos #tls_session_lifetime=3600
803 1.1.1.7 christos
804 1.1.1.5 christos # Cached OCSP stapling response (DER encoded)
805 1.1.1.5 christos # If set, this file is sent as a certificate status response by the EAP server
806 1.1.1.5 christos # if the EAP peer requests certificate status in the ClientHello message.
807 1.1.1.5 christos # This cache file can be updated, e.g., by running following command
808 1.1.1.5 christos # periodically to get an update from the OCSP responder:
809 1.1.1.5 christos # openssl ocsp \
810 1.1.1.5 christos # -no_nonce \
811 1.1.1.5 christos # -CAfile /etc/hostapd.ca.pem \
812 1.1.1.5 christos # -issuer /etc/hostapd.ca.pem \
813 1.1.1.5 christos # -cert /etc/hostapd.server.pem \
814 1.1.1.5 christos # -url http://ocsp.example.com:8888/ \
815 1.1.1.5 christos # -respout /tmp/ocsp-cache.der
816 1.1.1.5 christos #ocsp_stapling_response=/tmp/ocsp-cache.der
817 1.1.1.5 christos
818 1.1.1.7 christos # Cached OCSP stapling response list (DER encoded OCSPResponseList)
819 1.1.1.7 christos # This is similar to ocsp_stapling_response, but the extended version defined in
820 1.1.1.7 christos # RFC 6961 to allow multiple OCSP responses to be provided.
821 1.1.1.7 christos #ocsp_stapling_response_multi=/tmp/ocsp-multi-cache.der
822 1.1.1.7 christos
823 1.1 christos # dh_file: File path to DH/DSA parameters file (in PEM format)
824 1.1 christos # This is an optional configuration file for setting parameters for an
825 1.1 christos # ephemeral DH key exchange. In most cases, the default RSA authentication does
826 1.1 christos # not use this configuration. However, it is possible setup RSA to use
827 1.1 christos # ephemeral DH key exchange. In addition, ciphers with DSA keys always use
828 1.1 christos # ephemeral DH keys. This can be used to achieve forward secrecy. If the file
829 1.1 christos # is in DSA parameters format, it will be automatically converted into DH
830 1.1 christos # params. This parameter is required if anonymous EAP-FAST is used.
831 1.1 christos # You can generate DH parameters file with OpenSSL, e.g.,
832 1.1.1.7 christos # "openssl dhparam -out /etc/hostapd.dh.pem 2048"
833 1.1 christos #dh_file=/etc/hostapd.dh.pem
834 1.1 christos
835 1.1.1.6 christos # OpenSSL cipher string
836 1.1.1.6 christos #
837 1.1.1.6 christos # This is an OpenSSL specific configuration option for configuring the default
838 1.1.1.6 christos # ciphers. If not set, "DEFAULT:!EXP:!LOW" is used as the default.
839 1.1.1.6 christos # See https://www.openssl.org/docs/apps/ciphers.html for OpenSSL documentation
840 1.1.1.6 christos # on cipher suite configuration. This is applicable only if hostapd is built to
841 1.1.1.6 christos # use OpenSSL.
842 1.1.1.6 christos #openssl_ciphers=DEFAULT:!EXP:!LOW
843 1.1.1.6 christos
844 1.1.1.3 christos # Fragment size for EAP methods
845 1.1.1.3 christos #fragment_size=1400
846 1.1.1.3 christos
847 1.1.1.4 christos # Finite cyclic group for EAP-pwd. Number maps to group of domain parameters
848 1.1.1.4 christos # using the IANA repository for IKE (RFC 2409).
849 1.1.1.4 christos #pwd_group=19
850 1.1.1.4 christos
851 1.1 christos # Configuration data for EAP-SIM database/authentication gateway interface.
852 1.1 christos # This is a text string in implementation specific format. The example
853 1.1 christos # implementation in eap_sim_db.c uses this as the UNIX domain socket name for
854 1.1 christos # the HLR/AuC gateway (e.g., hlr_auc_gw). In this case, the path uses "unix:"
855 1.1.1.4 christos # prefix. If hostapd is built with SQLite support (CONFIG_SQLITE=y in .config),
856 1.1.1.4 christos # database file can be described with an optional db=<path> parameter.
857 1.1 christos #eap_sim_db=unix:/tmp/hlr_auc_gw.sock
858 1.1.1.4 christos #eap_sim_db=unix:/tmp/hlr_auc_gw.sock db=/tmp/hostapd.db
859 1.1 christos
860 1.1.1.7 christos # EAP-SIM DB request timeout
861 1.1.1.7 christos # This parameter sets the maximum time to wait for a database request response.
862 1.1.1.7 christos # The parameter value is in seconds.
863 1.1.1.7 christos #eap_sim_db_timeout=1
864 1.1.1.7 christos
865 1.1 christos # Encryption key for EAP-FAST PAC-Opaque values. This key must be a secret,
866 1.1 christos # random value. It is configured as a 16-octet value in hex format. It can be
867 1.1 christos # generated, e.g., with the following command:
868 1.1 christos # od -tx1 -v -N16 /dev/random | colrm 1 8 | tr -d ' '
869 1.1 christos #pac_opaque_encr_key=000102030405060708090a0b0c0d0e0f
870 1.1 christos
871 1.1 christos # EAP-FAST authority identity (A-ID)
872 1.1 christos # A-ID indicates the identity of the authority that issues PACs. The A-ID
873 1.1 christos # should be unique across all issuing servers. In theory, this is a variable
874 1.1 christos # length field, but due to some existing implementations requiring A-ID to be
875 1.1 christos # 16 octets in length, it is strongly recommended to use that length for the
876 1.1 christos # field to provid interoperability with deployed peer implementations. This
877 1.1 christos # field is configured in hex format.
878 1.1 christos #eap_fast_a_id=101112131415161718191a1b1c1d1e1f
879 1.1 christos
880 1.1 christos # EAP-FAST authority identifier information (A-ID-Info)
881 1.1 christos # This is a user-friendly name for the A-ID. For example, the enterprise name
882 1.1 christos # and server name in a human-readable format. This field is encoded as UTF-8.
883 1.1 christos #eap_fast_a_id_info=test server
884 1.1 christos
885 1.1 christos # Enable/disable different EAP-FAST provisioning modes:
886 1.1 christos #0 = provisioning disabled
887 1.1 christos #1 = only anonymous provisioning allowed
888 1.1 christos #2 = only authenticated provisioning allowed
889 1.1 christos #3 = both provisioning modes allowed (default)
890 1.1 christos #eap_fast_prov=3
891 1.1 christos
892 1.1 christos # EAP-FAST PAC-Key lifetime in seconds (hard limit)
893 1.1 christos #pac_key_lifetime=604800
894 1.1 christos
895 1.1 christos # EAP-FAST PAC-Key refresh time in seconds (soft limit on remaining hard
896 1.1 christos # limit). The server will generate a new PAC-Key when this number of seconds
897 1.1 christos # (or fewer) of the lifetime remains.
898 1.1 christos #pac_key_refresh_time=86400
899 1.1 christos
900 1.1 christos # EAP-SIM and EAP-AKA protected success/failure indication using AT_RESULT_IND
901 1.1 christos # (default: 0 = disabled).
902 1.1 christos #eap_sim_aka_result_ind=1
903 1.1 christos
904 1.1 christos # Trusted Network Connect (TNC)
905 1.1 christos # If enabled, TNC validation will be required before the peer is allowed to
906 1.1 christos # connect. Note: This is only used with EAP-TTLS and EAP-FAST. If any other
907 1.1 christos # EAP method is enabled, the peer will be allowed to connect without TNC.
908 1.1 christos #tnc=1
909 1.1 christos
910 1.1.1.6 christos # EAP Re-authentication Protocol (ERP) - RFC 6696
911 1.1.1.6 christos #
912 1.1.1.6 christos # Whether to enable ERP on the EAP server.
913 1.1.1.6 christos #eap_server_erp=1
914 1.1 christos
915 1.1 christos ##### IEEE 802.11f - Inter-Access Point Protocol (IAPP) #######################
916 1.1 christos
917 1.1 christos # Interface to be used for IAPP broadcast packets
918 1.1 christos #iapp_interface=eth0
919 1.1 christos
920 1.1 christos
921 1.1 christos ##### RADIUS client configuration #############################################
922 1.1 christos # for IEEE 802.1X with external Authentication Server, IEEE 802.11
923 1.1 christos # authentication with external ACL for MAC addresses, and accounting
924 1.1 christos
925 1.1 christos # The own IP address of the access point (used as NAS-IP-Address)
926 1.1 christos own_ip_addr=127.0.0.1
927 1.1 christos
928 1.1.1.7 christos # NAS-Identifier string for RADIUS messages. When used, this should be unique
929 1.1.1.7 christos # to the NAS within the scope of the RADIUS server. Please note that hostapd
930 1.1.1.7 christos # uses a separate RADIUS client for each BSS and as such, a unique
931 1.1.1.7 christos # nas_identifier value should be configured separately for each BSS. This is
932 1.1.1.7 christos # particularly important for cases where RADIUS accounting is used
933 1.1.1.7 christos # (Accounting-On/Off messages are interpreted as clearing all ongoing sessions
934 1.1.1.7 christos # and that may get interpreted as applying to all BSSes if the same
935 1.1.1.7 christos # NAS-Identifier value is used.) For example, a fully qualified domain name
936 1.1.1.7 christos # prefixed with a unique identifier of the BSS (e.g., BSSID) can be used here.
937 1.1.1.7 christos #
938 1.1 christos # When using IEEE 802.11r, nas_identifier must be set and must be between 1 and
939 1.1 christos # 48 octets long.
940 1.1.1.7 christos #
941 1.1.1.7 christos # It is mandatory to configure either own_ip_addr or nas_identifier to be
942 1.1.1.7 christos # compliant with the RADIUS protocol. When using RADIUS accounting, it is
943 1.1.1.7 christos # strongly recommended that nas_identifier is set to a unique value for each
944 1.1.1.7 christos # BSS.
945 1.1 christos #nas_identifier=ap.example.com
946 1.1 christos
947 1.1.1.6 christos # RADIUS client forced local IP address for the access point
948 1.1.1.6 christos # Normally the local IP address is determined automatically based on configured
949 1.1.1.6 christos # IP addresses, but this field can be used to force a specific address to be
950 1.1.1.6 christos # used, e.g., when the device has multiple IP addresses.
951 1.1.1.6 christos #radius_client_addr=127.0.0.1
952 1.1.1.6 christos
953 1.1 christos # RADIUS authentication server
954 1.1 christos #auth_server_addr=127.0.0.1
955 1.1 christos #auth_server_port=1812
956 1.1 christos #auth_server_shared_secret=secret
957 1.1 christos
958 1.1 christos # RADIUS accounting server
959 1.1 christos #acct_server_addr=127.0.0.1
960 1.1 christos #acct_server_port=1813
961 1.1 christos #acct_server_shared_secret=secret
962 1.1 christos
963 1.1 christos # Secondary RADIUS servers; to be used if primary one does not reply to
964 1.1 christos # RADIUS packets. These are optional and there can be more than one secondary
965 1.1 christos # server listed.
966 1.1 christos #auth_server_addr=127.0.0.2
967 1.1 christos #auth_server_port=1812
968 1.1 christos #auth_server_shared_secret=secret2
969 1.1 christos #
970 1.1 christos #acct_server_addr=127.0.0.2
971 1.1 christos #acct_server_port=1813
972 1.1 christos #acct_server_shared_secret=secret2
973 1.1 christos
974 1.1 christos # Retry interval for trying to return to the primary RADIUS server (in
975 1.1 christos # seconds). RADIUS client code will automatically try to use the next server
976 1.1 christos # when the current server is not replying to requests. If this interval is set,
977 1.1 christos # primary server will be retried after configured amount of time even if the
978 1.1 christos # currently used secondary server is still working.
979 1.1 christos #radius_retry_primary_interval=600
980 1.1 christos
981 1.1 christos
982 1.1 christos # Interim accounting update interval
983 1.1 christos # If this is set (larger than 0) and acct_server is configured, hostapd will
984 1.1 christos # send interim accounting updates every N seconds. Note: if set, this overrides
985 1.1 christos # possible Acct-Interim-Interval attribute in Access-Accept message. Thus, this
986 1.1 christos # value should not be configured in hostapd.conf, if RADIUS server is used to
987 1.1 christos # control the interim interval.
988 1.1 christos # This value should not be less 600 (10 minutes) and must not be less than
989 1.1 christos # 60 (1 minute).
990 1.1 christos #radius_acct_interim_interval=600
991 1.1 christos
992 1.1.1.4 christos # Request Chargeable-User-Identity (RFC 4372)
993 1.1.1.4 christos # This parameter can be used to configure hostapd to request CUI from the
994 1.1.1.4 christos # RADIUS server by including Chargeable-User-Identity attribute into
995 1.1.1.4 christos # Access-Request packets.
996 1.1.1.4 christos #radius_request_cui=1
997 1.1.1.4 christos
998 1.1 christos # Dynamic VLAN mode; allow RADIUS authentication server to decide which VLAN
999 1.1 christos # is used for the stations. This information is parsed from following RADIUS
1000 1.1 christos # attributes based on RFC 3580 and RFC 2868: Tunnel-Type (value 13 = VLAN),
1001 1.1 christos # Tunnel-Medium-Type (value 6 = IEEE 802), Tunnel-Private-Group-ID (value
1002 1.1.1.5 christos # VLANID as a string). Optionally, the local MAC ACL list (accept_mac_file) can
1003 1.1.1.5 christos # be used to set static client MAC address to VLAN ID mapping.
1004 1.1 christos # 0 = disabled (default)
1005 1.1 christos # 1 = option; use default interface if RADIUS server does not include VLAN ID
1006 1.1 christos # 2 = required; reject authentication if RADIUS server does not include VLAN ID
1007 1.1 christos #dynamic_vlan=0
1008 1.1 christos
1009 1.1.1.7 christos # Per-Station AP_VLAN interface mode
1010 1.1.1.7 christos # If enabled, each station is assigned its own AP_VLAN interface.
1011 1.1.1.7 christos # This implies per-station group keying and ebtables filtering of inter-STA
1012 1.1.1.7 christos # traffic (when passed through the AP).
1013 1.1.1.7 christos # If the sta is not assigned to any VLAN, then its AP_VLAN interface will be
1014 1.1.1.7 christos # added to the bridge given by the "bridge" configuration option (see above).
1015 1.1.1.7 christos # Otherwise, it will be added to the per-VLAN bridge.
1016 1.1.1.7 christos # 0 = disabled (default)
1017 1.1.1.7 christos # 1 = enabled
1018 1.1.1.7 christos #per_sta_vif=0
1019 1.1.1.7 christos
1020 1.1 christos # VLAN interface list for dynamic VLAN mode is read from a separate text file.
1021 1.1 christos # This list is used to map VLAN ID from the RADIUS server to a network
1022 1.1 christos # interface. Each station is bound to one interface in the same way as with
1023 1.1 christos # multiple BSSIDs or SSIDs. Each line in this text file is defining a new
1024 1.1 christos # interface and the line must include VLAN ID and interface name separated by
1025 1.1 christos # white space (space or tab).
1026 1.1.1.5 christos # If no entries are provided by this file, the station is statically mapped
1027 1.1.1.5 christos # to <bss-iface>.<vlan-id> interfaces.
1028 1.1 christos #vlan_file=/etc/hostapd.vlan
1029 1.1 christos
1030 1.1 christos # Interface where 802.1q tagged packets should appear when a RADIUS server is
1031 1.1 christos # used to determine which VLAN a station is on. hostapd creates a bridge for
1032 1.1 christos # each VLAN. Then hostapd adds a VLAN interface (associated with the interface
1033 1.1 christos # indicated by 'vlan_tagged_interface') and the appropriate wireless interface
1034 1.1 christos # to the bridge.
1035 1.1 christos #vlan_tagged_interface=eth0
1036 1.1 christos
1037 1.1.1.5 christos # Bridge (prefix) to add the wifi and the tagged interface to. This gets the
1038 1.1.1.5 christos # VLAN ID appended. It defaults to brvlan%d if no tagged interface is given
1039 1.1.1.5 christos # and br%s.%d if a tagged interface is given, provided %s = tagged interface
1040 1.1.1.5 christos # and %d = VLAN ID.
1041 1.1.1.5 christos #vlan_bridge=brvlan
1042 1.1.1.5 christos
1043 1.1.1.4 christos # When hostapd creates a VLAN interface on vlan_tagged_interfaces, it needs
1044 1.1.1.4 christos # to know how to name it.
1045 1.1.1.4 christos # 0 = vlan<XXX>, e.g., vlan1
1046 1.1.1.4 christos # 1 = <vlan_tagged_interface>.<XXX>, e.g. eth0.1
1047 1.1.1.4 christos #vlan_naming=0
1048 1.1.1.4 christos
1049 1.1.1.4 christos # Arbitrary RADIUS attributes can be added into Access-Request and
1050 1.1.1.4 christos # Accounting-Request packets by specifying the contents of the attributes with
1051 1.1.1.4 christos # the following configuration parameters. There can be multiple of these to
1052 1.1.1.4 christos # add multiple attributes. These parameters can also be used to override some
1053 1.1.1.4 christos # of the attributes added automatically by hostapd.
1054 1.1.1.4 christos # Format: <attr_id>[:<syntax:value>]
1055 1.1.1.4 christos # attr_id: RADIUS attribute type (e.g., 26 = Vendor-Specific)
1056 1.1.1.4 christos # syntax: s = string (UTF-8), d = integer, x = octet string
1057 1.1.1.4 christos # value: attribute value in format indicated by the syntax
1058 1.1.1.4 christos # If syntax and value parts are omitted, a null value (single 0x00 octet) is
1059 1.1.1.4 christos # used.
1060 1.1.1.4 christos #
1061 1.1.1.4 christos # Additional Access-Request attributes
1062 1.1.1.4 christos # radius_auth_req_attr=<attr_id>[:<syntax:value>]
1063 1.1.1.4 christos # Examples:
1064 1.1.1.4 christos # Operator-Name = "Operator"
1065 1.1.1.4 christos #radius_auth_req_attr=126:s:Operator
1066 1.1.1.4 christos # Service-Type = Framed (2)
1067 1.1.1.4 christos #radius_auth_req_attr=6:d:2
1068 1.1.1.4 christos # Connect-Info = "testing" (this overrides the automatically generated value)
1069 1.1.1.4 christos #radius_auth_req_attr=77:s:testing
1070 1.1.1.4 christos # Same Connect-Info value set as a hexdump
1071 1.1.1.4 christos #radius_auth_req_attr=77:x:74657374696e67
1072 1.1.1.4 christos
1073 1.1.1.4 christos #
1074 1.1.1.4 christos # Additional Accounting-Request attributes
1075 1.1.1.4 christos # radius_acct_req_attr=<attr_id>[:<syntax:value>]
1076 1.1.1.4 christos # Examples:
1077 1.1.1.4 christos # Operator-Name = "Operator"
1078 1.1.1.4 christos #radius_acct_req_attr=126:s:Operator
1079 1.1.1.4 christos
1080 1.1.1.4 christos # Dynamic Authorization Extensions (RFC 5176)
1081 1.1.1.4 christos # This mechanism can be used to allow dynamic changes to user session based on
1082 1.1.1.4 christos # commands from a RADIUS server (or some other disconnect client that has the
1083 1.1.1.4 christos # needed session information). For example, Disconnect message can be used to
1084 1.1.1.4 christos # request an associated station to be disconnected.
1085 1.1.1.4 christos #
1086 1.1.1.4 christos # This is disabled by default. Set radius_das_port to non-zero UDP port
1087 1.1.1.4 christos # number to enable.
1088 1.1.1.4 christos #radius_das_port=3799
1089 1.1.1.4 christos #
1090 1.1.1.4 christos # DAS client (the host that can send Disconnect/CoA requests) and shared secret
1091 1.1.1.4 christos #radius_das_client=192.168.1.123 shared secret here
1092 1.1.1.4 christos #
1093 1.1.1.4 christos # DAS Event-Timestamp time window in seconds
1094 1.1.1.4 christos #radius_das_time_window=300
1095 1.1.1.4 christos #
1096 1.1.1.4 christos # DAS require Event-Timestamp
1097 1.1.1.4 christos #radius_das_require_event_timestamp=1
1098 1.1.1.7 christos #
1099 1.1.1.7 christos # DAS require Message-Authenticator
1100 1.1.1.7 christos #radius_das_require_message_authenticator=1
1101 1.1 christos
1102 1.1 christos ##### RADIUS authentication server configuration ##############################
1103 1.1 christos
1104 1.1 christos # hostapd can be used as a RADIUS authentication server for other hosts. This
1105 1.1 christos # requires that the integrated EAP server is also enabled and both
1106 1.1 christos # authentication services are sharing the same configuration.
1107 1.1 christos
1108 1.1 christos # File name of the RADIUS clients configuration for the RADIUS server. If this
1109 1.1 christos # commented out, RADIUS server is disabled.
1110 1.1 christos #radius_server_clients=/etc/hostapd.radius_clients
1111 1.1 christos
1112 1.1 christos # The UDP port number for the RADIUS authentication server
1113 1.1 christos #radius_server_auth_port=1812
1114 1.1 christos
1115 1.1.1.5 christos # The UDP port number for the RADIUS accounting server
1116 1.1.1.5 christos # Commenting this out or setting this to 0 can be used to disable RADIUS
1117 1.1.1.5 christos # accounting while still enabling RADIUS authentication.
1118 1.1.1.5 christos #radius_server_acct_port=1813
1119 1.1.1.5 christos
1120 1.1 christos # Use IPv6 with RADIUS server (IPv4 will also be supported using IPv6 API)
1121 1.1 christos #radius_server_ipv6=1
1122 1.1 christos
1123 1.1 christos
1124 1.1 christos ##### WPA/IEEE 802.11i configuration ##########################################
1125 1.1 christos
1126 1.1 christos # Enable WPA. Setting this variable configures the AP to require WPA (either
1127 1.1 christos # WPA-PSK or WPA-RADIUS/EAP based on other configuration). For WPA-PSK, either
1128 1.1 christos # wpa_psk or wpa_passphrase must be set and wpa_key_mgmt must include WPA-PSK.
1129 1.1.1.4 christos # Instead of wpa_psk / wpa_passphrase, wpa_psk_radius might suffice.
1130 1.1 christos # For WPA-RADIUS/EAP, ieee8021x must be set (but without dynamic WEP keys),
1131 1.1 christos # RADIUS authentication server must be configured, and WPA-EAP must be included
1132 1.1 christos # in wpa_key_mgmt.
1133 1.1 christos # This field is a bit field that can be used to enable WPA (IEEE 802.11i/D3.0)
1134 1.1 christos # and/or WPA2 (full IEEE 802.11i/RSN):
1135 1.1 christos # bit0 = WPA
1136 1.1 christos # bit1 = IEEE 802.11i/RSN (WPA2) (dot11RSNAEnabled)
1137 1.1 christos #wpa=1
1138 1.1 christos
1139 1.1 christos # WPA pre-shared keys for WPA-PSK. This can be either entered as a 256-bit
1140 1.1 christos # secret in hex format (64 hex digits), wpa_psk, or as an ASCII passphrase
1141 1.1 christos # (8..63 characters) that will be converted to PSK. This conversion uses SSID
1142 1.1 christos # so the PSK changes when ASCII passphrase is used and the SSID is changed.
1143 1.1 christos # wpa_psk (dot11RSNAConfigPSKValue)
1144 1.1 christos # wpa_passphrase (dot11RSNAConfigPSKPassPhrase)
1145 1.1 christos #wpa_psk=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
1146 1.1 christos #wpa_passphrase=secret passphrase
1147 1.1 christos
1148 1.1 christos # Optionally, WPA PSKs can be read from a separate text file (containing list
1149 1.1 christos # of (PSK,MAC address) pairs. This allows more than one PSK to be configured.
1150 1.1 christos # Use absolute path name to make sure that the files can be read on SIGHUP
1151 1.1 christos # configuration reloads.
1152 1.1 christos #wpa_psk_file=/etc/hostapd.wpa_psk
1153 1.1 christos
1154 1.1.1.4 christos # Optionally, WPA passphrase can be received from RADIUS authentication server
1155 1.1.1.4 christos # This requires macaddr_acl to be set to 2 (RADIUS)
1156 1.1.1.4 christos # 0 = disabled (default)
1157 1.1.1.4 christos # 1 = optional; use default passphrase/psk if RADIUS server does not include
1158 1.1.1.4 christos # Tunnel-Password
1159 1.1.1.4 christos # 2 = required; reject authentication if RADIUS server does not include
1160 1.1.1.4 christos # Tunnel-Password
1161 1.1.1.4 christos #wpa_psk_radius=0
1162 1.1.1.4 christos
1163 1.1 christos # Set of accepted key management algorithms (WPA-PSK, WPA-EAP, or both). The
1164 1.1 christos # entries are separated with a space. WPA-PSK-SHA256 and WPA-EAP-SHA256 can be
1165 1.1 christos # added to enable SHA256-based stronger algorithms.
1166 1.1 christos # (dot11RSNAConfigAuthenticationSuitesTable)
1167 1.1 christos #wpa_key_mgmt=WPA-PSK WPA-EAP
1168 1.1 christos
1169 1.1 christos # Set of accepted cipher suites (encryption algorithms) for pairwise keys
1170 1.1 christos # (unicast packets). This is a space separated list of algorithms:
1171 1.1 christos # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
1172 1.1 christos # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
1173 1.1 christos # Group cipher suite (encryption algorithm for broadcast and multicast frames)
1174 1.1 christos # is automatically selected based on this configuration. If only CCMP is
1175 1.1 christos # allowed as the pairwise cipher, group cipher will also be CCMP. Otherwise,
1176 1.1 christos # TKIP will be used as the group cipher.
1177 1.1 christos # (dot11RSNAConfigPairwiseCiphersTable)
1178 1.1 christos # Pairwise cipher for WPA (v1) (default: TKIP)
1179 1.1 christos #wpa_pairwise=TKIP CCMP
1180 1.1 christos # Pairwise cipher for RSN/WPA2 (default: use wpa_pairwise value)
1181 1.1 christos #rsn_pairwise=CCMP
1182 1.1 christos
1183 1.1 christos # Time interval for rekeying GTK (broadcast/multicast encryption keys) in
1184 1.1 christos # seconds. (dot11RSNAConfigGroupRekeyTime)
1185 1.1 christos #wpa_group_rekey=600
1186 1.1 christos
1187 1.1 christos # Rekey GTK when any STA that possesses the current GTK is leaving the BSS.
1188 1.1 christos # (dot11RSNAConfigGroupRekeyStrict)
1189 1.1 christos #wpa_strict_rekey=1
1190 1.1 christos
1191 1.1 christos # Time interval for rekeying GMK (master key used internally to generate GTKs
1192 1.1 christos # (in seconds).
1193 1.1 christos #wpa_gmk_rekey=86400
1194 1.1 christos
1195 1.1 christos # Maximum lifetime for PTK in seconds. This can be used to enforce rekeying of
1196 1.1 christos # PTK to mitigate some attacks against TKIP deficiencies.
1197 1.1 christos #wpa_ptk_rekey=600
1198 1.1 christos
1199 1.1 christos # Enable IEEE 802.11i/RSN/WPA2 pre-authentication. This is used to speed up
1200 1.1 christos # roaming be pre-authenticating IEEE 802.1X/EAP part of the full RSN
1201 1.1 christos # authentication and key handshake before actually associating with a new AP.
1202 1.1 christos # (dot11RSNAPreauthenticationEnabled)
1203 1.1 christos #rsn_preauth=1
1204 1.1 christos #
1205 1.1 christos # Space separated list of interfaces from which pre-authentication frames are
1206 1.1 christos # accepted (e.g., 'eth0' or 'eth0 wlan0wds0'. This list should include all
1207 1.1 christos # interface that are used for connections to other APs. This could include
1208 1.1 christos # wired interfaces and WDS links. The normal wireless data interface towards
1209 1.1 christos # associated stations (e.g., wlan0) should not be added, since
1210 1.1 christos # pre-authentication is only used with APs other than the currently associated
1211 1.1 christos # one.
1212 1.1 christos #rsn_preauth_interfaces=eth0
1213 1.1 christos
1214 1.1 christos # peerkey: Whether PeerKey negotiation for direct links (IEEE 802.11e) is
1215 1.1 christos # allowed. This is only used with RSN/WPA2.
1216 1.1 christos # 0 = disabled (default)
1217 1.1 christos # 1 = enabled
1218 1.1 christos #peerkey=1
1219 1.1 christos
1220 1.1 christos # ieee80211w: Whether management frame protection (MFP) is enabled
1221 1.1 christos # 0 = disabled (default)
1222 1.1 christos # 1 = optional
1223 1.1 christos # 2 = required
1224 1.1 christos #ieee80211w=0
1225 1.1 christos
1226 1.1.1.5 christos # Group management cipher suite
1227 1.1.1.5 christos # Default: AES-128-CMAC (BIP)
1228 1.1.1.5 christos # Other options (depending on driver support):
1229 1.1.1.5 christos # BIP-GMAC-128
1230 1.1.1.5 christos # BIP-GMAC-256
1231 1.1.1.5 christos # BIP-CMAC-256
1232 1.1.1.5 christos # Note: All the stations connecting to the BSS will also need to support the
1233 1.1.1.5 christos # selected cipher. The default AES-128-CMAC is the only option that is commonly
1234 1.1.1.5 christos # available in deployed devices.
1235 1.1.1.5 christos #group_mgmt_cipher=AES-128-CMAC
1236 1.1.1.5 christos
1237 1.1 christos # Association SA Query maximum timeout (in TU = 1.024 ms; for MFP)
1238 1.1 christos # (maximum time to wait for a SA Query response)
1239 1.1 christos # dot11AssociationSAQueryMaximumTimeout, 1...4294967295
1240 1.1 christos #assoc_sa_query_max_timeout=1000
1241 1.1 christos
1242 1.1 christos # Association SA Query retry timeout (in TU = 1.024 ms; for MFP)
1243 1.1 christos # (time between two subsequent SA Query requests)
1244 1.1 christos # dot11AssociationSAQueryRetryTimeout, 1...4294967295
1245 1.1 christos #assoc_sa_query_retry_timeout=201
1246 1.1 christos
1247 1.1.1.3 christos # disable_pmksa_caching: Disable PMKSA caching
1248 1.1.1.3 christos # This parameter can be used to disable caching of PMKSA created through EAP
1249 1.1.1.3 christos # authentication. RSN preauthentication may still end up using PMKSA caching if
1250 1.1.1.3 christos # it is enabled (rsn_preauth=1).
1251 1.1.1.3 christos # 0 = PMKSA caching enabled (default)
1252 1.1.1.3 christos # 1 = PMKSA caching disabled
1253 1.1.1.3 christos #disable_pmksa_caching=0
1254 1.1 christos
1255 1.1 christos # okc: Opportunistic Key Caching (aka Proactive Key Caching)
1256 1.1 christos # Allow PMK cache to be shared opportunistically among configured interfaces
1257 1.1 christos # and BSSes (i.e., all configurations within a single hostapd process).
1258 1.1 christos # 0 = disabled (default)
1259 1.1 christos # 1 = enabled
1260 1.1 christos #okc=1
1261 1.1 christos
1262 1.1.1.5 christos # SAE threshold for anti-clogging mechanism (dot11RSNASAEAntiCloggingThreshold)
1263 1.1.1.5 christos # This parameter defines how many open SAE instances can be in progress at the
1264 1.1.1.5 christos # same time before the anti-clogging mechanism is taken into use.
1265 1.1.1.5 christos #sae_anti_clogging_threshold=5
1266 1.1.1.5 christos
1267 1.1.1.5 christos # Enabled SAE finite cyclic groups
1268 1.1.1.5 christos # SAE implementation are required to support group 19 (ECC group defined over a
1269 1.1.1.5 christos # 256-bit prime order field). All groups that are supported by the
1270 1.1.1.5 christos # implementation are enabled by default. This configuration parameter can be
1271 1.1.1.5 christos # used to specify a limited set of allowed groups. The group values are listed
1272 1.1.1.5 christos # in the IANA registry:
1273 1.1.1.5 christos # http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-9
1274 1.1.1.5 christos #sae_groups=19 20 21 25 26
1275 1.1 christos
1276 1.1 christos ##### IEEE 802.11r configuration ##############################################
1277 1.1 christos
1278 1.1 christos # Mobility Domain identifier (dot11FTMobilityDomainID, MDID)
1279 1.1 christos # MDID is used to indicate a group of APs (within an ESS, i.e., sharing the
1280 1.1 christos # same SSID) between which a STA can use Fast BSS Transition.
1281 1.1 christos # 2-octet identifier as a hex string.
1282 1.1 christos #mobility_domain=a1b2
1283 1.1 christos
1284 1.1 christos # PMK-R0 Key Holder identifier (dot11FTR0KeyHolderID)
1285 1.1 christos # 1 to 48 octet identifier.
1286 1.1 christos # This is configured with nas_identifier (see RADIUS client section above).
1287 1.1 christos
1288 1.1 christos # Default lifetime of the PMK-RO in minutes; range 1..65535
1289 1.1 christos # (dot11FTR0KeyLifetime)
1290 1.1 christos #r0_key_lifetime=10000
1291 1.1 christos
1292 1.1 christos # PMK-R1 Key Holder identifier (dot11FTR1KeyHolderID)
1293 1.1 christos # 6-octet identifier as a hex string.
1294 1.1.1.7 christos # Defaults to BSSID.
1295 1.1 christos #r1_key_holder=000102030405
1296 1.1 christos
1297 1.1 christos # Reassociation deadline in time units (TUs / 1.024 ms; range 1000..65535)
1298 1.1 christos # (dot11FTReassociationDeadline)
1299 1.1 christos #reassociation_deadline=1000
1300 1.1 christos
1301 1.1 christos # List of R0KHs in the same Mobility Domain
1302 1.1 christos # format: <MAC address> <NAS Identifier> <128-bit key as hex string>
1303 1.1 christos # This list is used to map R0KH-ID (NAS Identifier) to a destination MAC
1304 1.1 christos # address when requesting PMK-R1 key from the R0KH that the STA used during the
1305 1.1 christos # Initial Mobility Domain Association.
1306 1.1 christos #r0kh=02:01:02:03:04:05 r0kh-1.example.com 000102030405060708090a0b0c0d0e0f
1307 1.1 christos #r0kh=02:01:02:03:04:06 r0kh-2.example.com 00112233445566778899aabbccddeeff
1308 1.1 christos # And so on.. One line per R0KH.
1309 1.1 christos
1310 1.1 christos # List of R1KHs in the same Mobility Domain
1311 1.1 christos # format: <MAC address> <R1KH-ID> <128-bit key as hex string>
1312 1.1 christos # This list is used to map R1KH-ID to a destination MAC address when sending
1313 1.1 christos # PMK-R1 key from the R0KH. This is also the list of authorized R1KHs in the MD
1314 1.1 christos # that can request PMK-R1 keys.
1315 1.1 christos #r1kh=02:01:02:03:04:05 02:11:22:33:44:55 000102030405060708090a0b0c0d0e0f
1316 1.1 christos #r1kh=02:01:02:03:04:06 02:11:22:33:44:66 00112233445566778899aabbccddeeff
1317 1.1 christos # And so on.. One line per R1KH.
1318 1.1 christos
1319 1.1 christos # Whether PMK-R1 push is enabled at R0KH
1320 1.1 christos # 0 = do not push PMK-R1 to all configured R1KHs (default)
1321 1.1 christos # 1 = push PMK-R1 to all configured R1KHs whenever a new PMK-R0 is derived
1322 1.1 christos #pmk_r1_push=1
1323 1.1 christos
1324 1.1.1.7 christos # Whether to enable FT-over-DS
1325 1.1.1.7 christos # 0 = FT-over-DS disabled
1326 1.1.1.7 christos # 1 = FT-over-DS enabled (default)
1327 1.1.1.7 christos #ft_over_ds=1
1328 1.1.1.7 christos
1329 1.1 christos ##### Neighbor table ##########################################################
1330 1.1 christos # Maximum number of entries kept in AP table (either for neigbor table or for
1331 1.1 christos # detecting Overlapping Legacy BSS Condition). The oldest entry will be
1332 1.1 christos # removed when adding a new entry that would make the list grow over this
1333 1.1 christos # limit. Note! WFA certification for IEEE 802.11g requires that OLBC is
1334 1.1 christos # enabled, so this field should not be set to 0 when using IEEE 802.11g.
1335 1.1 christos # default: 255
1336 1.1 christos #ap_table_max_size=255
1337 1.1 christos
1338 1.1 christos # Number of seconds of no frames received after which entries may be deleted
1339 1.1 christos # from the AP table. Since passive scanning is not usually performed frequently
1340 1.1 christos # this should not be set to very small value. In addition, there is no
1341 1.1 christos # guarantee that every scan cycle will receive beacon frames from the
1342 1.1 christos # neighboring APs.
1343 1.1 christos # default: 60
1344 1.1 christos #ap_table_expiration_time=3600
1345 1.1 christos
1346 1.1.1.7 christos # Maximum number of stations to track on the operating channel
1347 1.1.1.7 christos # This can be used to detect dualband capable stations before they have
1348 1.1.1.7 christos # associated, e.g., to provide guidance on which colocated BSS to use.
1349 1.1.1.7 christos # Default: 0 (disabled)
1350 1.1.1.7 christos #track_sta_max_num=100
1351 1.1.1.7 christos
1352 1.1.1.7 christos # Maximum age of a station tracking entry in seconds
1353 1.1.1.7 christos # Default: 180
1354 1.1.1.7 christos #track_sta_max_age=180
1355 1.1.1.7 christos
1356 1.1.1.7 christos # Do not reply to group-addressed Probe Request from a station that was seen on
1357 1.1.1.7 christos # another radio.
1358 1.1.1.7 christos # Default: Disabled
1359 1.1.1.7 christos #
1360 1.1.1.7 christos # This can be used with enabled track_sta_max_num configuration on another
1361 1.1.1.7 christos # interface controlled by the same hostapd process to restrict Probe Request
1362 1.1.1.7 christos # frame handling from replying to group-addressed Probe Request frames from a
1363 1.1.1.7 christos # station that has been detected to be capable of operating on another band,
1364 1.1.1.7 christos # e.g., to try to reduce likelihood of the station selecting a 2.4 GHz BSS when
1365 1.1.1.7 christos # the AP operates both a 2.4 GHz and 5 GHz BSS concurrently.
1366 1.1.1.7 christos #
1367 1.1.1.7 christos # Note: Enabling this can cause connectivity issues and increase latency for
1368 1.1.1.7 christos # discovering the AP.
1369 1.1.1.7 christos #no_probe_resp_if_seen_on=wlan1
1370 1.1.1.7 christos
1371 1.1.1.7 christos # Reject authentication from a station that was seen on another radio.
1372 1.1.1.7 christos # Default: Disabled
1373 1.1.1.7 christos #
1374 1.1.1.7 christos # This can be used with enabled track_sta_max_num configuration on another
1375 1.1.1.7 christos # interface controlled by the same hostapd process to reject authentication
1376 1.1.1.7 christos # attempts from a station that has been detected to be capable of operating on
1377 1.1.1.7 christos # another band, e.g., to try to reduce likelihood of the station selecting a
1378 1.1.1.7 christos # 2.4 GHz BSS when the AP operates both a 2.4 GHz and 5 GHz BSS concurrently.
1379 1.1.1.7 christos #
1380 1.1.1.7 christos # Note: Enabling this can cause connectivity issues and increase latency for
1381 1.1.1.7 christos # connecting with the AP.
1382 1.1.1.7 christos #no_auth_if_seen_on=wlan1
1383 1.1 christos
1384 1.1 christos ##### Wi-Fi Protected Setup (WPS) #############################################
1385 1.1 christos
1386 1.1 christos # WPS state
1387 1.1 christos # 0 = WPS disabled (default)
1388 1.1 christos # 1 = WPS enabled, not configured
1389 1.1 christos # 2 = WPS enabled, configured
1390 1.1 christos #wps_state=2
1391 1.1 christos
1392 1.1.1.5 christos # Whether to manage this interface independently from other WPS interfaces
1393 1.1.1.5 christos # By default, a single hostapd process applies WPS operations to all configured
1394 1.1.1.5 christos # interfaces. This parameter can be used to disable that behavior for a subset
1395 1.1.1.5 christos # of interfaces. If this is set to non-zero for an interface, WPS commands
1396 1.1.1.5 christos # issued on that interface do not apply to other interfaces and WPS operations
1397 1.1.1.5 christos # performed on other interfaces do not affect this interface.
1398 1.1.1.5 christos #wps_independent=0
1399 1.1.1.5 christos
1400 1.1 christos # AP can be configured into a locked state where new WPS Registrar are not
1401 1.1 christos # accepted, but previously authorized Registrars (including the internal one)
1402 1.1 christos # can continue to add new Enrollees.
1403 1.1 christos #ap_setup_locked=1
1404 1.1 christos
1405 1.1 christos # Universally Unique IDentifier (UUID; see RFC 4122) of the device
1406 1.1 christos # This value is used as the UUID for the internal WPS Registrar. If the AP
1407 1.1 christos # is also using UPnP, this value should be set to the device's UPnP UUID.
1408 1.1 christos # If not configured, UUID will be generated based on the local MAC address.
1409 1.1 christos #uuid=12345678-9abc-def0-1234-56789abcdef0
1410 1.1 christos
1411 1.1 christos # Note: If wpa_psk_file is set, WPS is used to generate random, per-device PSKs
1412 1.1 christos # that will be appended to the wpa_psk_file. If wpa_psk_file is not set, the
1413 1.1 christos # default PSK (wpa_psk/wpa_passphrase) will be delivered to Enrollees. Use of
1414 1.1 christos # per-device PSKs is recommended as the more secure option (i.e., make sure to
1415 1.1 christos # set wpa_psk_file when using WPS with WPA-PSK).
1416 1.1 christos
1417 1.1 christos # When an Enrollee requests access to the network with PIN method, the Enrollee
1418 1.1 christos # PIN will need to be entered for the Registrar. PIN request notifications are
1419 1.1 christos # sent to hostapd ctrl_iface monitor. In addition, they can be written to a
1420 1.1 christos # text file that could be used, e.g., to populate the AP administration UI with
1421 1.1 christos # pending PIN requests. If the following variable is set, the PIN requests will
1422 1.1 christos # be written to the configured file.
1423 1.1 christos #wps_pin_requests=/var/run/hostapd_wps_pin_requests
1424 1.1 christos
1425 1.1 christos # Device Name
1426 1.1 christos # User-friendly description of device; up to 32 octets encoded in UTF-8
1427 1.1 christos #device_name=Wireless AP
1428 1.1 christos
1429 1.1 christos # Manufacturer
1430 1.1 christos # The manufacturer of the device (up to 64 ASCII characters)
1431 1.1 christos #manufacturer=Company
1432 1.1 christos
1433 1.1 christos # Model Name
1434 1.1 christos # Model of the device (up to 32 ASCII characters)
1435 1.1 christos #model_name=WAP
1436 1.1 christos
1437 1.1 christos # Model Number
1438 1.1 christos # Additional device description (up to 32 ASCII characters)
1439 1.1 christos #model_number=123
1440 1.1 christos
1441 1.1 christos # Serial Number
1442 1.1 christos # Serial number of the device (up to 32 characters)
1443 1.1 christos #serial_number=12345
1444 1.1 christos
1445 1.1 christos # Primary Device Type
1446 1.1 christos # Used format: <categ>-<OUI>-<subcateg>
1447 1.1 christos # categ = Category as an integer value
1448 1.1 christos # OUI = OUI and type octet as a 4-octet hex-encoded value; 0050F204 for
1449 1.1 christos # default WPS OUI
1450 1.1 christos # subcateg = OUI-specific Sub Category as an integer value
1451 1.1 christos # Examples:
1452 1.1 christos # 1-0050F204-1 (Computer / PC)
1453 1.1 christos # 1-0050F204-2 (Computer / Server)
1454 1.1 christos # 5-0050F204-1 (Storage / NAS)
1455 1.1 christos # 6-0050F204-1 (Network Infrastructure / AP)
1456 1.1 christos #device_type=6-0050F204-1
1457 1.1 christos
1458 1.1 christos # OS Version
1459 1.1 christos # 4-octet operating system version number (hex string)
1460 1.1 christos #os_version=01020300
1461 1.1 christos
1462 1.1 christos # Config Methods
1463 1.1 christos # List of the supported configuration methods
1464 1.1 christos # Available methods: usba ethernet label display ext_nfc_token int_nfc_token
1465 1.1.1.3 christos # nfc_interface push_button keypad virtual_display physical_display
1466 1.1.1.3 christos # virtual_push_button physical_push_button
1467 1.1.1.3 christos #config_methods=label virtual_display virtual_push_button keypad
1468 1.1.1.3 christos
1469 1.1.1.3 christos # WPS capability discovery workaround for PBC with Windows 7
1470 1.1.1.3 christos # Windows 7 uses incorrect way of figuring out AP's WPS capabilities by acting
1471 1.1.1.3 christos # as a Registrar and using M1 from the AP. The config methods attribute in that
1472 1.1.1.3 christos # message is supposed to indicate only the configuration method supported by
1473 1.1.1.3 christos # the AP in Enrollee role, i.e., to add an external Registrar. For that case,
1474 1.1.1.3 christos # PBC shall not be used and as such, the PushButton config method is removed
1475 1.1.1.3 christos # from M1 by default. If pbc_in_m1=1 is included in the configuration file,
1476 1.1.1.3 christos # the PushButton config method is left in M1 (if included in config_methods
1477 1.1.1.3 christos # parameter) to allow Windows 7 to use PBC instead of PIN (e.g., from a label
1478 1.1.1.3 christos # in the AP).
1479 1.1.1.3 christos #pbc_in_m1=1
1480 1.1 christos
1481 1.1.1.2 christos # Static access point PIN for initial configuration and adding Registrars
1482 1.1 christos # If not set, hostapd will not allow external WPS Registrars to control the
1483 1.1.1.2 christos # access point. The AP PIN can also be set at runtime with hostapd_cli
1484 1.1.1.2 christos # wps_ap_pin command. Use of temporary (enabled by user action) and random
1485 1.1.1.2 christos # AP PIN is much more secure than configuring a static AP PIN here. As such,
1486 1.1.1.2 christos # use of the ap_pin parameter is not recommended if the AP device has means for
1487 1.1.1.2 christos # displaying a random PIN.
1488 1.1 christos #ap_pin=12345670
1489 1.1 christos
1490 1.1 christos # Skip building of automatic WPS credential
1491 1.1 christos # This can be used to allow the automatically generated Credential attribute to
1492 1.1 christos # be replaced with pre-configured Credential(s).
1493 1.1 christos #skip_cred_build=1
1494 1.1 christos
1495 1.1 christos # Additional Credential attribute(s)
1496 1.1 christos # This option can be used to add pre-configured Credential attributes into M8
1497 1.1 christos # message when acting as a Registrar. If skip_cred_build=1, this data will also
1498 1.1 christos # be able to override the Credential attribute that would have otherwise been
1499 1.1 christos # automatically generated based on network configuration. This configuration
1500 1.1 christos # option points to an external file that much contain the WPS Credential
1501 1.1 christos # attribute(s) as binary data.
1502 1.1 christos #extra_cred=hostapd.cred
1503 1.1 christos
1504 1.1 christos # Credential processing
1505 1.1 christos # 0 = process received credentials internally (default)
1506 1.1 christos # 1 = do not process received credentials; just pass them over ctrl_iface to
1507 1.1 christos # external program(s)
1508 1.1 christos # 2 = process received credentials internally and pass them over ctrl_iface
1509 1.1 christos # to external program(s)
1510 1.1 christos # Note: With wps_cred_processing=1, skip_cred_build should be set to 1 and
1511 1.1 christos # extra_cred be used to provide the Credential data for Enrollees.
1512 1.1 christos #
1513 1.1 christos # wps_cred_processing=1 will disabled automatic updates of hostapd.conf file
1514 1.1 christos # both for Credential processing and for marking AP Setup Locked based on
1515 1.1 christos # validation failures of AP PIN. An external program is responsible on updating
1516 1.1 christos # the configuration appropriately in this case.
1517 1.1 christos #wps_cred_processing=0
1518 1.1 christos
1519 1.1 christos # AP Settings Attributes for M7
1520 1.1 christos # By default, hostapd generates the AP Settings Attributes for M7 based on the
1521 1.1 christos # current configuration. It is possible to override this by providing a file
1522 1.1 christos # with pre-configured attributes. This is similar to extra_cred file format,
1523 1.1 christos # but the AP Settings attributes are not encapsulated in a Credential
1524 1.1 christos # attribute.
1525 1.1 christos #ap_settings=hostapd.ap_settings
1526 1.1 christos
1527 1.1 christos # WPS UPnP interface
1528 1.1 christos # If set, support for external Registrars is enabled.
1529 1.1 christos #upnp_iface=br0
1530 1.1 christos
1531 1.1 christos # Friendly Name (required for UPnP)
1532 1.1 christos # Short description for end use. Should be less than 64 characters.
1533 1.1 christos #friendly_name=WPS Access Point
1534 1.1 christos
1535 1.1 christos # Manufacturer URL (optional for UPnP)
1536 1.1 christos #manufacturer_url=http://www.example.com/
1537 1.1 christos
1538 1.1 christos # Model Description (recommended for UPnP)
1539 1.1 christos # Long description for end user. Should be less than 128 characters.
1540 1.1 christos #model_description=Wireless Access Point
1541 1.1 christos
1542 1.1 christos # Model URL (optional for UPnP)
1543 1.1 christos #model_url=http://www.example.com/model/
1544 1.1 christos
1545 1.1 christos # Universal Product Code (optional for UPnP)
1546 1.1 christos # 12-digit, all-numeric code that identifies the consumer package.
1547 1.1 christos #upc=123456789012
1548 1.1 christos
1549 1.1.1.7 christos # WPS RF Bands (a = 5G, b = 2.4G, g = 2.4G, ag = dual band, ad = 60 GHz)
1550 1.1.1.4 christos # This value should be set according to RF band(s) supported by the AP if
1551 1.1.1.4 christos # hw_mode is not set. For dual band dual concurrent devices, this needs to be
1552 1.1.1.4 christos # set to ag to allow both RF bands to be advertized.
1553 1.1.1.4 christos #wps_rf_bands=ag
1554 1.1.1.4 christos
1555 1.1.1.4 christos # NFC password token for WPS
1556 1.1.1.4 christos # These parameters can be used to configure a fixed NFC password token for the
1557 1.1.1.4 christos # AP. This can be generated, e.g., with nfc_pw_token from wpa_supplicant. When
1558 1.1.1.4 christos # these parameters are used, the AP is assumed to be deployed with a NFC tag
1559 1.1.1.4 christos # that includes the matching NFC password token (e.g., written based on the
1560 1.1.1.4 christos # NDEF record from nfc_pw_token).
1561 1.1.1.4 christos #
1562 1.1.1.4 christos #wps_nfc_dev_pw_id: Device Password ID (16..65535)
1563 1.1.1.4 christos #wps_nfc_dh_pubkey: Hexdump of DH Public Key
1564 1.1.1.4 christos #wps_nfc_dh_privkey: Hexdump of DH Private Key
1565 1.1.1.4 christos #wps_nfc_dev_pw: Hexdump of Device Password
1566 1.1.1.4 christos
1567 1.1.1.3 christos ##### Wi-Fi Direct (P2P) ######################################################
1568 1.1.1.3 christos
1569 1.1.1.3 christos # Enable P2P Device management
1570 1.1.1.3 christos #manage_p2p=1
1571 1.1.1.3 christos
1572 1.1.1.3 christos # Allow cross connection
1573 1.1.1.3 christos #allow_cross_connection=1
1574 1.1.1.3 christos
1575 1.1.1.3 christos #### TDLS (IEEE 802.11z-2010) #################################################
1576 1.1.1.3 christos
1577 1.1.1.3 christos # Prohibit use of TDLS in this BSS
1578 1.1.1.3 christos #tdls_prohibit=1
1579 1.1.1.3 christos
1580 1.1.1.3 christos # Prohibit use of TDLS Channel Switching in this BSS
1581 1.1.1.3 christos #tdls_prohibit_chan_switch=1
1582 1.1.1.3 christos
1583 1.1.1.3 christos ##### IEEE 802.11v-2011 #######################################################
1584 1.1.1.3 christos
1585 1.1.1.3 christos # Time advertisement
1586 1.1.1.3 christos # 0 = disabled (default)
1587 1.1.1.3 christos # 2 = UTC time at which the TSF timer is 0
1588 1.1.1.3 christos #time_advertisement=2
1589 1.1.1.3 christos
1590 1.1.1.3 christos # Local time zone as specified in 8.3 of IEEE Std 1003.1-2004:
1591 1.1.1.3 christos # stdoffset[dst[offset][,start[/time],end[/time]]]
1592 1.1.1.3 christos #time_zone=EST5
1593 1.1.1.3 christos
1594 1.1.1.4 christos # WNM-Sleep Mode (extended sleep mode for stations)
1595 1.1.1.4 christos # 0 = disabled (default)
1596 1.1.1.4 christos # 1 = enabled (allow stations to use WNM-Sleep Mode)
1597 1.1.1.4 christos #wnm_sleep_mode=1
1598 1.1.1.4 christos
1599 1.1.1.4 christos # BSS Transition Management
1600 1.1.1.4 christos # 0 = disabled (default)
1601 1.1.1.4 christos # 1 = enabled
1602 1.1.1.4 christos #bss_transition=1
1603 1.1.1.4 christos
1604 1.1.1.6 christos # Proxy ARP
1605 1.1.1.6 christos # 0 = disabled (default)
1606 1.1.1.6 christos # 1 = enabled
1607 1.1.1.6 christos #proxy_arp=1
1608 1.1.1.6 christos
1609 1.1.1.7 christos # IPv6 Neighbor Advertisement multicast-to-unicast conversion
1610 1.1.1.7 christos # This can be used with Proxy ARP to allow multicast NAs to be forwarded to
1611 1.1.1.7 christos # associated STAs using link layer unicast delivery.
1612 1.1.1.7 christos # 0 = disabled (default)
1613 1.1.1.7 christos # 1 = enabled
1614 1.1.1.7 christos #na_mcast_to_ucast=0
1615 1.1.1.7 christos
1616 1.1.1.3 christos ##### IEEE 802.11u-2011 #######################################################
1617 1.1.1.3 christos
1618 1.1.1.3 christos # Enable Interworking service
1619 1.1.1.3 christos #interworking=1
1620 1.1.1.3 christos
1621 1.1.1.3 christos # Access Network Type
1622 1.1.1.3 christos # 0 = Private network
1623 1.1.1.3 christos # 1 = Private network with guest access
1624 1.1.1.3 christos # 2 = Chargeable public network
1625 1.1.1.3 christos # 3 = Free public network
1626 1.1.1.3 christos # 4 = Personal device network
1627 1.1.1.3 christos # 5 = Emergency services only network
1628 1.1.1.3 christos # 14 = Test or experimental
1629 1.1.1.3 christos # 15 = Wildcard
1630 1.1.1.3 christos #access_network_type=0
1631 1.1.1.3 christos
1632 1.1.1.3 christos # Whether the network provides connectivity to the Internet
1633 1.1.1.3 christos # 0 = Unspecified
1634 1.1.1.3 christos # 1 = Network provides connectivity to the Internet
1635 1.1.1.3 christos #internet=1
1636 1.1.1.3 christos
1637 1.1.1.3 christos # Additional Step Required for Access
1638 1.1.1.3 christos # Note: This is only used with open network, i.e., ASRA shall ne set to 0 if
1639 1.1.1.3 christos # RSN is used.
1640 1.1.1.3 christos #asra=0
1641 1.1.1.3 christos
1642 1.1.1.3 christos # Emergency services reachable
1643 1.1.1.3 christos #esr=0
1644 1.1.1.3 christos
1645 1.1.1.3 christos # Unauthenticated emergency service accessible
1646 1.1.1.3 christos #uesa=0
1647 1.1.1.3 christos
1648 1.1.1.3 christos # Venue Info (optional)
1649 1.1.1.3 christos # The available values are defined in IEEE Std 802.11u-2011, 7.3.1.34.
1650 1.1.1.3 christos # Example values (group,type):
1651 1.1.1.3 christos # 0,0 = Unspecified
1652 1.1.1.3 christos # 1,7 = Convention Center
1653 1.1.1.3 christos # 1,13 = Coffee Shop
1654 1.1.1.3 christos # 2,0 = Unspecified Business
1655 1.1.1.3 christos # 7,1 Private Residence
1656 1.1.1.3 christos #venue_group=7
1657 1.1.1.3 christos #venue_type=1
1658 1.1.1.3 christos
1659 1.1.1.3 christos # Homogeneous ESS identifier (optional; dot11HESSID)
1660 1.1.1.3 christos # If set, this shall be identifical to one of the BSSIDs in the homogeneous
1661 1.1.1.3 christos # ESS and this shall be set to the same value across all BSSs in homogeneous
1662 1.1.1.3 christos # ESS.
1663 1.1.1.3 christos #hessid=02:03:04:05:06:07
1664 1.1.1.3 christos
1665 1.1.1.3 christos # Roaming Consortium List
1666 1.1.1.3 christos # Arbitrary number of Roaming Consortium OIs can be configured with each line
1667 1.1.1.3 christos # adding a new OI to the list. The first three entries are available through
1668 1.1.1.3 christos # Beacon and Probe Response frames. Any additional entry will be available only
1669 1.1.1.4 christos # through ANQP queries. Each OI is between 3 and 15 octets and is configured as
1670 1.1.1.3 christos # a hexstring.
1671 1.1.1.3 christos #roaming_consortium=021122
1672 1.1.1.3 christos #roaming_consortium=2233445566
1673 1.1.1.3 christos
1674 1.1.1.4 christos # Venue Name information
1675 1.1.1.4 christos # This parameter can be used to configure one or more Venue Name Duples for
1676 1.1.1.4 christos # Venue Name ANQP information. Each entry has a two or three character language
1677 1.1.1.4 christos # code (ISO-639) separated by colon from the venue name string.
1678 1.1.1.4 christos # Note that venue_group and venue_type have to be set for Venue Name
1679 1.1.1.4 christos # information to be complete.
1680 1.1.1.4 christos #venue_name=eng:Example venue
1681 1.1.1.4 christos #venue_name=fin:Esimerkkipaikka
1682 1.1.1.5 christos # Alternative format for language:value strings:
1683 1.1.1.5 christos # (double quoted string, printf-escaped string)
1684 1.1.1.5 christos #venue_name=P"eng:Example\nvenue"
1685 1.1.1.4 christos
1686 1.1.1.4 christos # Network Authentication Type
1687 1.1.1.4 christos # This parameter indicates what type of network authentication is used in the
1688 1.1.1.4 christos # network.
1689 1.1.1.4 christos # format: <network auth type indicator (1-octet hex str)> [redirect URL]
1690 1.1.1.4 christos # Network Authentication Type Indicator values:
1691 1.1.1.4 christos # 00 = Acceptance of terms and conditions
1692 1.1.1.4 christos # 01 = On-line enrollment supported
1693 1.1.1.4 christos # 02 = http/https redirection
1694 1.1.1.4 christos # 03 = DNS redirection
1695 1.1.1.4 christos #network_auth_type=00
1696 1.1.1.4 christos #network_auth_type=02http://www.example.com/redirect/me/here/
1697 1.1.1.4 christos
1698 1.1.1.4 christos # IP Address Type Availability
1699 1.1.1.4 christos # format: <1-octet encoded value as hex str>
1700 1.1.1.4 christos # (ipv4_type & 0x3f) << 2 | (ipv6_type & 0x3)
1701 1.1.1.4 christos # ipv4_type:
1702 1.1.1.4 christos # 0 = Address type not available
1703 1.1.1.4 christos # 1 = Public IPv4 address available
1704 1.1.1.4 christos # 2 = Port-restricted IPv4 address available
1705 1.1.1.4 christos # 3 = Single NATed private IPv4 address available
1706 1.1.1.4 christos # 4 = Double NATed private IPv4 address available
1707 1.1.1.4 christos # 5 = Port-restricted IPv4 address and single NATed IPv4 address available
1708 1.1.1.4 christos # 6 = Port-restricted IPv4 address and double NATed IPv4 address available
1709 1.1.1.4 christos # 7 = Availability of the address type is not known
1710 1.1.1.4 christos # ipv6_type:
1711 1.1.1.4 christos # 0 = Address type not available
1712 1.1.1.4 christos # 1 = Address type available
1713 1.1.1.4 christos # 2 = Availability of the address type not known
1714 1.1.1.4 christos #ipaddr_type_availability=14
1715 1.1.1.4 christos
1716 1.1.1.4 christos # Domain Name
1717 1.1.1.4 christos # format: <variable-octet str>[,<variable-octet str>]
1718 1.1.1.4 christos #domain_name=example.com,another.example.com,yet-another.example.com
1719 1.1.1.4 christos
1720 1.1.1.4 christos # 3GPP Cellular Network information
1721 1.1.1.4 christos # format: <MCC1,MNC1>[;<MCC2,MNC2>][;...]
1722 1.1.1.4 christos #anqp_3gpp_cell_net=244,91;310,026;234,56
1723 1.1.1.4 christos
1724 1.1.1.4 christos # NAI Realm information
1725 1.1.1.4 christos # One or more realm can be advertised. Each nai_realm line adds a new realm to
1726 1.1.1.4 christos # the set. These parameters provide information for stations using Interworking
1727 1.1.1.4 christos # network selection to allow automatic connection to a network based on
1728 1.1.1.4 christos # credentials.
1729 1.1.1.4 christos # format: <encoding>,<NAI Realm(s)>[,<EAP Method 1>][,<EAP Method 2>][,...]
1730 1.1.1.4 christos # encoding:
1731 1.1.1.4 christos # 0 = Realm formatted in accordance with IETF RFC 4282
1732 1.1.1.4 christos # 1 = UTF-8 formatted character string that is not formatted in
1733 1.1.1.4 christos # accordance with IETF RFC 4282
1734 1.1.1.4 christos # NAI Realm(s): Semi-colon delimited NAI Realm(s)
1735 1.1.1.4 christos # EAP Method: <EAP Method>[:<[AuthParam1:Val1]>][<[AuthParam2:Val2]>][...]
1736 1.1.1.5 christos # EAP Method types, see:
1737 1.1.1.5 christos # http://www.iana.org/assignments/eap-numbers/eap-numbers.xhtml#eap-numbers-4
1738 1.1.1.4 christos # AuthParam (Table 8-188 in IEEE Std 802.11-2012):
1739 1.1.1.4 christos # ID 2 = Non-EAP Inner Authentication Type
1740 1.1.1.4 christos # 1 = PAP, 2 = CHAP, 3 = MSCHAP, 4 = MSCHAPV2
1741 1.1.1.4 christos # ID 3 = Inner authentication EAP Method Type
1742 1.1.1.4 christos # ID 5 = Credential Type
1743 1.1.1.4 christos # 1 = SIM, 2 = USIM, 3 = NFC Secure Element, 4 = Hardware Token,
1744 1.1.1.4 christos # 5 = Softoken, 6 = Certificate, 7 = username/password, 9 = Anonymous,
1745 1.1.1.4 christos # 10 = Vendor Specific
1746 1.1.1.4 christos #nai_realm=0,example.com;example.net
1747 1.1.1.4 christos # EAP methods EAP-TLS with certificate and EAP-TTLS/MSCHAPv2 with
1748 1.1.1.4 christos # username/password
1749 1.1.1.4 christos #nai_realm=0,example.org,13[5:6],21[2:4][5:7]
1750 1.1.1.4 christos
1751 1.1.1.7 christos # Arbitrary ANQP-element configuration
1752 1.1.1.7 christos # Additional ANQP-elements with arbitrary values can be defined by specifying
1753 1.1.1.7 christos # their contents in raw format as a hexdump of the payload. Note that these
1754 1.1.1.7 christos # values will override ANQP-element contents that may have been specified in the
1755 1.1.1.7 christos # more higher layer configuration parameters listed above.
1756 1.1.1.7 christos # format: anqp_elem=<InfoID>:<hexdump of payload>
1757 1.1.1.7 christos # For example, AP Geospatial Location ANQP-element with unknown location:
1758 1.1.1.7 christos #anqp_elem=265:0000
1759 1.1.1.7 christos # For example, AP Civic Location ANQP-element with unknown location:
1760 1.1.1.7 christos #anqp_elem=266:000000
1761 1.1.1.7 christos
1762 1.1.1.7 christos # GAS Address 3 behavior
1763 1.1.1.7 christos # 0 = P2P specification (Address3 = AP BSSID) workaround enabled by default
1764 1.1.1.7 christos # based on GAS request Address3
1765 1.1.1.7 christos # 1 = IEEE 802.11 standard compliant regardless of GAS request Address3
1766 1.1.1.7 christos # 2 = Force non-compliant behavior (Address3 = AP BSSID for all cases)
1767 1.1.1.7 christos #gas_address3=0
1768 1.1.1.7 christos
1769 1.1.1.5 christos # QoS Map Set configuration
1770 1.1.1.5 christos #
1771 1.1.1.5 christos # Comma delimited QoS Map Set in decimal values
1772 1.1.1.5 christos # (see IEEE Std 802.11-2012, 8.4.2.97)
1773 1.1.1.5 christos #
1774 1.1.1.5 christos # format:
1775 1.1.1.5 christos # [<DSCP Exceptions[DSCP,UP]>,]<UP 0 range[low,high]>,...<UP 7 range[low,high]>
1776 1.1.1.5 christos #
1777 1.1.1.5 christos # There can be up to 21 optional DSCP Exceptions which are pairs of DSCP Value
1778 1.1.1.5 christos # (0..63 or 255) and User Priority (0..7). This is followed by eight DSCP Range
1779 1.1.1.5 christos # descriptions with DSCP Low Value and DSCP High Value pairs (0..63 or 255) for
1780 1.1.1.5 christos # each UP starting from 0. If both low and high value are set to 255, the
1781 1.1.1.5 christos # corresponding UP is not used.
1782 1.1.1.5 christos #
1783 1.1.1.5 christos # default: not set
1784 1.1.1.5 christos #qos_map_set=53,2,22,6,8,15,0,7,255,255,16,31,32,39,255,255,40,47,255,255
1785 1.1.1.5 christos
1786 1.1.1.4 christos ##### Hotspot 2.0 #############################################################
1787 1.1.1.4 christos
1788 1.1.1.4 christos # Enable Hotspot 2.0 support
1789 1.1.1.4 christos #hs20=1
1790 1.1.1.4 christos
1791 1.1.1.4 christos # Disable Downstream Group-Addressed Forwarding (DGAF)
1792 1.1.1.4 christos # This can be used to configure a network where no group-addressed frames are
1793 1.1.1.4 christos # allowed. The AP will not forward any group-address frames to the stations and
1794 1.1.1.4 christos # random GTKs are issued for each station to prevent associated stations from
1795 1.1.1.4 christos # forging such frames to other stations in the BSS.
1796 1.1.1.4 christos #disable_dgaf=1
1797 1.1.1.4 christos
1798 1.1.1.5 christos # OSU Server-Only Authenticated L2 Encryption Network
1799 1.1.1.5 christos #osen=1
1800 1.1.1.5 christos
1801 1.1.1.5 christos # ANQP Domain ID (0..65535)
1802 1.1.1.5 christos # An identifier for a set of APs in an ESS that share the same common ANQP
1803 1.1.1.5 christos # information. 0 = Some of the ANQP information is unique to this AP (default).
1804 1.1.1.5 christos #anqp_domain_id=1234
1805 1.1.1.5 christos
1806 1.1.1.5 christos # Deauthentication request timeout
1807 1.1.1.5 christos # If the RADIUS server indicates that the station is not allowed to connect to
1808 1.1.1.5 christos # the BSS/ESS, the AP can allow the station some time to download a
1809 1.1.1.5 christos # notification page (URL included in the message). This parameter sets that
1810 1.1.1.5 christos # timeout in seconds.
1811 1.1.1.5 christos #hs20_deauth_req_timeout=60
1812 1.1.1.5 christos
1813 1.1.1.4 christos # Operator Friendly Name
1814 1.1.1.4 christos # This parameter can be used to configure one or more Operator Friendly Name
1815 1.1.1.4 christos # Duples. Each entry has a two or three character language code (ISO-639)
1816 1.1.1.4 christos # separated by colon from the operator friendly name string.
1817 1.1.1.4 christos #hs20_oper_friendly_name=eng:Example operator
1818 1.1.1.4 christos #hs20_oper_friendly_name=fin:Esimerkkioperaattori
1819 1.1.1.4 christos
1820 1.1.1.4 christos # Connection Capability
1821 1.1.1.4 christos # This can be used to advertise what type of IP traffic can be sent through the
1822 1.1.1.4 christos # hotspot (e.g., due to firewall allowing/blocking protocols/ports).
1823 1.1.1.4 christos # format: <IP Protocol>:<Port Number>:<Status>
1824 1.1.1.4 christos # IP Protocol: 1 = ICMP, 6 = TCP, 17 = UDP
1825 1.1.1.4 christos # Port Number: 0..65535
1826 1.1.1.4 christos # Status: 0 = Closed, 1 = Open, 2 = Unknown
1827 1.1.1.4 christos # Each hs20_conn_capab line is added to the list of advertised tuples.
1828 1.1.1.4 christos #hs20_conn_capab=1:0:2
1829 1.1.1.4 christos #hs20_conn_capab=6:22:1
1830 1.1.1.4 christos #hs20_conn_capab=17:5060:0
1831 1.1.1.4 christos
1832 1.1.1.4 christos # WAN Metrics
1833 1.1.1.4 christos # format: <WAN Info>:<DL Speed>:<UL Speed>:<DL Load>:<UL Load>:<LMD>
1834 1.1.1.4 christos # WAN Info: B0-B1: Link Status, B2: Symmetric Link, B3: At Capabity
1835 1.1.1.4 christos # (encoded as two hex digits)
1836 1.1.1.4 christos # Link Status: 1 = Link up, 2 = Link down, 3 = Link in test state
1837 1.1.1.4 christos # Downlink Speed: Estimate of WAN backhaul link current downlink speed in kbps;
1838 1.1.1.4 christos # 1..4294967295; 0 = unknown
1839 1.1.1.4 christos # Uplink Speed: Estimate of WAN backhaul link current uplink speed in kbps
1840 1.1.1.4 christos # 1..4294967295; 0 = unknown
1841 1.1.1.4 christos # Downlink Load: Current load of downlink WAN connection (scaled to 255 = 100%)
1842 1.1.1.4 christos # Uplink Load: Current load of uplink WAN connection (scaled to 255 = 100%)
1843 1.1.1.4 christos # Load Measurement Duration: Duration for measuring downlink/uplink load in
1844 1.1.1.4 christos # tenths of a second (1..65535); 0 if load cannot be determined
1845 1.1.1.4 christos #hs20_wan_metrics=01:8000:1000:80:240:3000
1846 1.1.1.4 christos
1847 1.1.1.4 christos # Operating Class Indication
1848 1.1.1.4 christos # List of operating classes the BSSes in this ESS use. The Global operating
1849 1.1.1.4 christos # classes in Table E-4 of IEEE Std 802.11-2012 Annex E define the values that
1850 1.1.1.4 christos # can be used in this.
1851 1.1.1.4 christos # format: hexdump of operating class octets
1852 1.1.1.4 christos # for example, operating classes 81 (2.4 GHz channels 1-13) and 115 (5 GHz
1853 1.1.1.4 christos # channels 36-48):
1854 1.1.1.4 christos #hs20_operating_class=5173
1855 1.1.1.4 christos
1856 1.1.1.5 christos # OSU icons
1857 1.1.1.5 christos # <Icon Width>:<Icon Height>:<Language code>:<Icon Type>:<Name>:<file path>
1858 1.1.1.5 christos #hs20_icon=32:32:eng:image/png:icon32:/tmp/icon32.png
1859 1.1.1.5 christos #hs20_icon=64:64:eng:image/png:icon64:/tmp/icon64.png
1860 1.1.1.5 christos
1861 1.1.1.5 christos # OSU SSID (see ssid2 for format description)
1862 1.1.1.5 christos # This is the SSID used for all OSU connections to all the listed OSU Providers.
1863 1.1.1.5 christos #osu_ssid="example"
1864 1.1.1.5 christos
1865 1.1.1.5 christos # OSU Providers
1866 1.1.1.5 christos # One or more sets of following parameter. Each OSU provider is started by the
1867 1.1.1.5 christos # mandatory osu_server_uri item. The other parameters add information for the
1868 1.1.1.5 christos # last added OSU provider.
1869 1.1.1.5 christos #
1870 1.1.1.5 christos #osu_server_uri=https://example.com/osu/
1871 1.1.1.5 christos #osu_friendly_name=eng:Example operator
1872 1.1.1.5 christos #osu_friendly_name=fin:Esimerkkipalveluntarjoaja
1873 1.1.1.5 christos #osu_nai=anonymous (at] example.com
1874 1.1.1.5 christos #osu_method_list=1 0
1875 1.1.1.5 christos #osu_icon=icon32
1876 1.1.1.5 christos #osu_icon=icon64
1877 1.1.1.5 christos #osu_service_desc=eng:Example services
1878 1.1.1.5 christos #osu_service_desc=fin:Esimerkkipalveluja
1879 1.1.1.5 christos #
1880 1.1.1.5 christos #osu_server_uri=...
1881 1.1.1.5 christos
1882 1.1.1.7 christos ##### Fast Session Transfer (FST) support #####################################
1883 1.1.1.7 christos #
1884 1.1.1.7 christos # The options in this section are only available when the build configuration
1885 1.1.1.7 christos # option CONFIG_FST is set while compiling hostapd. They allow this interface
1886 1.1.1.7 christos # to be a part of FST setup.
1887 1.1.1.7 christos #
1888 1.1.1.7 christos # FST is the transfer of a session from a channel to another channel, in the
1889 1.1.1.7 christos # same or different frequency bands.
1890 1.1.1.7 christos #
1891 1.1.1.7 christos # For detals, see IEEE Std 802.11ad-2012.
1892 1.1.1.7 christos
1893 1.1.1.7 christos # Identifier of an FST Group the interface belongs to.
1894 1.1.1.7 christos #fst_group_id=bond0
1895 1.1.1.7 christos
1896 1.1.1.7 christos # Interface priority within the FST Group.
1897 1.1.1.7 christos # Announcing a higher priority for an interface means declaring it more
1898 1.1.1.7 christos # preferable for FST switch.
1899 1.1.1.7 christos # fst_priority is in 1..255 range with 1 being the lowest priority.
1900 1.1.1.7 christos #fst_priority=100
1901 1.1.1.7 christos
1902 1.1.1.7 christos # Default LLT value for this interface in milliseconds. The value used in case
1903 1.1.1.7 christos # no value provided during session setup. Default is 50 ms.
1904 1.1.1.7 christos # fst_llt is in 1..4294967 range (due to spec limitation, see 10.32.2.2
1905 1.1.1.7 christos # Transitioning between states).
1906 1.1.1.7 christos #fst_llt=100
1907 1.1.1.7 christos
1908 1.1.1.7 christos ##### Radio measurements / location ###########################################
1909 1.1.1.7 christos
1910 1.1.1.7 christos # The content of a LCI measurement subelement
1911 1.1.1.7 christos #lci=<Hexdump of binary data of the LCI report>
1912 1.1.1.7 christos
1913 1.1.1.7 christos # The content of a location civic measurement subelement
1914 1.1.1.7 christos #civic=<Hexdump of binary data of the location civic report>
1915 1.1.1.7 christos
1916 1.1.1.7 christos # Enable neighbor report via radio measurements
1917 1.1.1.7 christos #rrm_neighbor_report=1
1918 1.1.1.7 christos
1919 1.1.1.7 christos # Publish fine timing measurement (FTM) responder functionality
1920 1.1.1.7 christos # This parameter only controls publishing via Extended Capabilities element.
1921 1.1.1.7 christos # Actual functionality is managed outside hostapd.
1922 1.1.1.7 christos #ftm_responder=0
1923 1.1.1.7 christos
1924 1.1.1.7 christos # Publish fine timing measurement (FTM) initiator functionality
1925 1.1.1.7 christos # This parameter only controls publishing via Extended Capabilities element.
1926 1.1.1.7 christos # Actual functionality is managed outside hostapd.
1927 1.1.1.7 christos #ftm_initiator=0
1928 1.1.1.7 christos
1929 1.1.1.5 christos ##### TESTING OPTIONS #########################################################
1930 1.1.1.5 christos #
1931 1.1.1.5 christos # The options in this section are only available when the build configuration
1932 1.1.1.5 christos # option CONFIG_TESTING_OPTIONS is set while compiling hostapd. They allow
1933 1.1.1.5 christos # testing some scenarios that are otherwise difficult to reproduce.
1934 1.1.1.5 christos #
1935 1.1.1.5 christos # Ignore probe requests sent to hostapd with the given probability, must be a
1936 1.1.1.5 christos # floating point number in the range [0, 1).
1937 1.1.1.5 christos #ignore_probe_probability=0.0
1938 1.1.1.5 christos #
1939 1.1.1.5 christos # Ignore authentication frames with the given probability
1940 1.1.1.5 christos #ignore_auth_probability=0.0
1941 1.1.1.5 christos #
1942 1.1.1.5 christos # Ignore association requests with the given probability
1943 1.1.1.5 christos #ignore_assoc_probability=0.0
1944 1.1.1.5 christos #
1945 1.1.1.5 christos # Ignore reassociation requests with the given probability
1946 1.1.1.5 christos #ignore_reassoc_probability=0.0
1947 1.1.1.5 christos #
1948 1.1.1.5 christos # Corrupt Key MIC in GTK rekey EAPOL-Key frames with the given probability
1949 1.1.1.5 christos #corrupt_gtk_rekey_mic_probability=0.0
1950 1.1.1.7 christos #
1951 1.1.1.7 christos # Include only ECSA IE without CSA IE where possible
1952 1.1.1.7 christos # (channel switch operating class is needed)
1953 1.1.1.7 christos #ecsa_ie_only=0
1954 1.1.1.5 christos
1955 1.1 christos ##### Multiple BSSID support ##################################################
1956 1.1 christos #
1957 1.1 christos # Above configuration is using the default interface (wlan#, or multi-SSID VLAN
1958 1.1 christos # interfaces). Other BSSIDs can be added by using separator 'bss' with
1959 1.1 christos # default interface name to be allocated for the data packets of the new BSS.
1960 1.1 christos #
1961 1.1 christos # hostapd will generate BSSID mask based on the BSSIDs that are
1962 1.1 christos # configured. hostapd will verify that dev_addr & MASK == dev_addr. If this is
1963 1.1 christos # not the case, the MAC address of the radio must be changed before starting
1964 1.1 christos # hostapd (ifconfig wlan0 hw ether <MAC addr>). If a BSSID is configured for
1965 1.1 christos # every secondary BSS, this limitation is not applied at hostapd and other
1966 1.1 christos # masks may be used if the driver supports them (e.g., swap the locally
1967 1.1 christos # administered bit)
1968 1.1 christos #
1969 1.1 christos # BSSIDs are assigned in order to each BSS, unless an explicit BSSID is
1970 1.1 christos # specified using the 'bssid' parameter.
1971 1.1 christos # If an explicit BSSID is specified, it must be chosen such that it:
1972 1.1 christos # - results in a valid MASK that covers it and the dev_addr
1973 1.1 christos # - is not the same as the MAC address of the radio
1974 1.1 christos # - is not the same as any other explicitly specified BSSID
1975 1.1 christos #
1976 1.1.1.7 christos # Alternatively, the 'use_driver_iface_addr' parameter can be used to request
1977 1.1.1.7 christos # hostapd to use the driver auto-generated interface address (e.g., to use the
1978 1.1.1.7 christos # exact MAC addresses allocated to the device).
1979 1.1.1.7 christos #
1980 1.1.1.5 christos # Not all drivers support multiple BSSes. The exact mechanism for determining
1981 1.1.1.5 christos # the driver capabilities is driver specific. With the current (i.e., a recent
1982 1.1.1.5 christos # kernel) drivers using nl80211, this information can be checked with "iw list"
1983 1.1.1.5 christos # (search for "valid interface combinations").
1984 1.1.1.5 christos #
1985 1.1 christos # Please note that hostapd uses some of the values configured for the first BSS
1986 1.1 christos # as the defaults for the following BSSes. However, it is recommended that all
1987 1.1 christos # BSSes include explicit configuration of all relevant configuration items.
1988 1.1 christos #
1989 1.1 christos #bss=wlan0_0
1990 1.1 christos #ssid=test2
1991 1.1 christos # most of the above items can be used here (apart from radio interface specific
1992 1.1 christos # items, like channel)
1993 1.1 christos
1994 1.1 christos #bss=wlan0_1
1995 1.1 christos #bssid=00:13:10:95:fe:0b
1996 1.1 christos # ...
1997