1IWD.AP(5) Linux Connectivity IWD.AP(5)
2
6 iwd.ap - Configuration of IWD access points
7
9 iwd.ap - Access point provisioning files
10
12 Description of access point provisioning files.
13
15 An access point provisioning file defines the configuration of an IWD
16 access point. These files live in $STATE_DIRECTORY/ap (/var/lib/iwd/ap
17 by default). They are read when the net.connman.iwd.AccessPoint.Start‐
18 Profile(ssid) DBus method is used.
19
21 See iwd.network for details on the settings file syntax.
22
24 The settings are split into several categories. Each category has a
25 group associated with it and is described in the corresponding table
26 below.
27 General Settings
29 The group [General] contains general AP configuration.
30 ┌─────────────┬────────────────────────────┐
32 │Channel │ Channel number │
33 │ │ │
34 │ │ Optional channel number │
35 │ │ for the access point to │
36 │ │ operate on. If omitted the │
37 │ │ channel will be chosen au‐ │
38 │ │ tomatically. Channels │
39 │ │ greater than or equal to │
40 │ │ 36 will select the 5GHz │
41 │ │ band for the AP to operate │
42 │ │ on. │
43 │ │ │
44 │ │ Note: Due to regulatory │
45 │ │ requirements the linux │
46 │ │ kernel does not allow or │
47 │ │ strictly limits 5GHz use │
48 │ │ in AP mode while in world │
49 │ │ roaming. These frequencies │
50 │ │ become available once the │
51 │ │ country is set, either via │
52 │ │ IWD's main.conf option │
53 │ │ [General].Country (see man │
54 │ │ iwd.config) or externally │
55 │ │ (e.g. iw reg set <CC>). If │
56 │ │ you are having trouble us‐ │
57 │ │ ing 5GHz ensure the coun‐ │
58 │ │ try is set, and that the │
59 │ │ desired frequency/channel │
60 │ │ is unrestricted. │
61 └─────────────┴────────────────────────────┘
62 │RekeyTimeout │ Timeout for PTK rekeys │
68 │ │ (seconds) │
69 │ │ │
70 │ │ The time interval at which │
71 │ │ the AP starts a rekey for │
72 │ │ a given station. If not │
73 │ │ provided a default value │
74 │ │ of 0 is used (rekeying is │
75 │ │ disabled). │
76 ├─────────────┼────────────────────────────┤
77 │DisableHT │ Boolean value │
78 │ │ │
79 │ │ Explicitly disable HT ca‐ │
80 │ │ pabilities for this AP. │
81 └─────────────┴────────────────────────────┘
82 Network Authentication Settings
84 The group [Security] contains settings for Wi-Fi security and authenti‐
85 cation configuration.
86 ┌────────────────┬────────────────────────────┐
88 │Passphrase │ 8..63 character string │
89 │ │ │
90 │ │ WPA-PSK Passphrase to be │
91 │ │ used with this access │
92 │ │ point. At least one of │
93 │ │ Passphrase, PreSharedKey │
94 │ │ must be present. │
95 ├────────────────┼────────────────────────────┤
96 │PreSharedKey │ 64-character hex-string │
97 │ │ │
98 │ │ Processed passphrase for │
99 │ │ this network in the form │
100 │ │ of a hex-encoded 32-byte │
101 │ │ pre-shared key. Either │
102 │ │ this or Passphrase must be │
103 │ │ present. │
104 ├────────────────┼────────────────────────────┤
105 │PairwiseCiphers │ Comma separated list of │
106 │ │ pairwise ciphers for the │
107 │ │ AP supports. │
108 │ │ │
109 │ │ Values can include: TKIP, │
110 │ │ CCMP, GCMP, GCMP-256, │
111 │ │ CCMP-256 │
112 │ │ │
113 │ │ The underlying hardware │
114 │ │ and IWD's AP implementa‐ │
115 │ │ tion must also support the │
116 │ │ ciphers listed │
117 ├────────────────┼────────────────────────────┤
118 │GroupCipher │ Group cipher the AP uses │
119 │ │ │
120 │ │ A single cipher value the │
121 │ │ AP can use as the group │
122 │ │ cipher. Values are the │
123 │ │ same as pairwise ciphers │
124 │ │ and the same restrictions │
125 │ │ apply (hardware and IWD │
126 │ │ implementation must sup‐ │
127 │ │ port the cipher) │
128 └────────────────┴────────────────────────────┘
129 IPv4 Network Configuration
131 The group [IPv4] contains settings for IWD's built-in DHCP server. All
132 settings are optional. They're used if network configuration was en‐
133 abled as described in iwd.config(5). Omitting the [IPv4] group dis‐
134 ables network configuration for this access point so if an all-defaults
135 DHCP setup is desired, the group header line must still be present:
136 # Enable network configuration
138 [IPv4]
139 [other groups follow]
141 ┌──────────┬────────────────────────────┐
200 │Address │ Local IP address or a │
201 │ │ comma-separated list of │
202 │ │ prefix-notation addresses │
203 │ │ │
204 │ │ Optional local address │
205 │ │ pool for the access point │
206 │ │ and the DHCP server. If a │
207 │ │ single address is provided │
208 │ │ this address will be set │
209 │ │ on the AP interface and │
210 │ │ any other DHCP server op‐ │
211 │ │ tions will be derived from │
212 │ │ it if not overridden by │
213 │ │ other settings below. │
214 │ │ │
215 │ │ If a list of addresses and │
216 │ │ prefix lengths is speci‐ │
217 │ │ fied (in the <IP>/<pre‐ │
218 │ │ fix-len> format), a single │
219 │ │ subnet address will be se‐ │
220 │ │ lected from the available │
221 │ │ space each time this pro‐ │
222 │ │ file is started. The sub‐ │
223 │ │ net size is based on the │
224 │ │ [IPv4].Netmask setting. │
225 │ │ │
226 │ │ If Address is not provided │
227 │ │ and no IP address is set │
228 │ │ on the interface prior to │
229 │ │ calling StartProfile the │
230 │ │ value of the main.conf │
231 │ │ [IPv4].APAddressPool set‐ │
232 │ │ ting will be inherited, │
233 │ │ which in turn defaults to │
234 │ │ 192.168.0.0/16. │
235 │ │ │
236 │ │ For example, if │
237 │ │ [IPv4].Netmask is set to │
238 │ │ 255.255.255.0 and this │
239 │ │ setting, or the global │
240 │ │ APAddressPool fallback, is │
241 │ │ set to 192.168.0.0/16, │
242 │ │ 10.0.0.0/22, IWD will se‐ │
243 │ │ lect one of the 256 sub‐ │
244 │ │ nets with addresses in the │
245 │ │ 192.168.<0-255>.0/24 range │
246 │ │ or one of the 4 subnets │
247 │ │ with addresses in the │
248 │ │ 10.0.<0-3>.0/24 range, al‐ │
249 │ │ lowing 270 possible sub‐ │
250 │ │ nets. Defining an address │
251 │ │ pool larger than the de‐ │
252 │ │ sired subnet gives IWD a │
253 │ │ chance to avoid conflicts │
254 │ │ if other interfaces on the │
255 │ │ system use dynamically as‐ │
256 │ │ signed addresses. │
257 └──────────┴────────────────────────────┘
258 │Gateway │ IP Address of gateway │
266 │ │ │
267 │ │ IP address of the gateway │
268 │ │ to be advertised by DHCP. │
269 │ │ This will fall back to the │
270 │ │ local IP address if not │
271 │ │ provided. │
272 ├──────────┼────────────────────────────┤
273 │Netmask │ Local netmask of the AP │
274 │ │ │
275 │ │ Defaults to a 28-bit net‐ │
276 │ │ mask if not provided. │
277 ├──────────┼────────────────────────────┤
278 │DNSList │ List of DNS servers as a │
279 │ │ comma-separated IP address │
280 │ │ list │
281 │ │ │
282 │ │ A list of DNS servers │
283 │ │ which will be advertised │
284 │ │ by the DHCP server. If not │
285 │ │ provided no DNS servers │
286 │ │ will be sent by the DHCP │
287 │ │ server. │
288 ├──────────┼────────────────────────────┤
289 │LeaseTime │ Time limit for DHCP leases │
290 │ │ in seconds │
291 │ │ │
292 │ │ Override the default lease │
293 │ │ time. │
294 ├──────────┼────────────────────────────┤
295 │IPRange │ Range of IPs given as two │
296 │ │ addresses separated by a │
297 │ │ comma │
298 │ │ │
299 │ │ From and to addresses of │
300 │ │ the range assigned to │
301 │ │ clients through DHCP. If │
302 │ │ not provided the range │
303 │ │ from local address + 1 to │
304 │ │ .254 will be used. │
305 └──────────┴────────────────────────────┘
306 Wi-Fi Simple Configuration
308 The group [WSC] fine-tunes some Wi-Fi Simple Configuration local param‐
309 eters (formerly known as WPS, Wi-Fi Protected Setup.)
310 ┌──────────────────┬────────────────────────────┐
312 │DeviceName │ 1..32-character string │
313 │ │ │
314 │ │ Optional Device Name │
315 │ │ string for the AP to ad‐ │
316 │ │ vertise as. Defaults to │
317 │ │ the SSID. │
318 └──────────────────┴────────────────────────────┘
319 │PrimaryDeviceType │ Subcategory string or a │
332 │ │ 64-bit integer │
333 │ │ │
334 │ │ Optional Primary Device │
335 │ │ Type for the AP to adver‐ │
336 │ │ tise as. Defaults to PC │
337 │ │ computer. Can be speci‐ │
338 │ │ fied as a lower-case WSC │
339 │ │ v2.0.5 subcategory string │
340 │ │ or a 64-bit integer encod‐ │
341 │ │ ing, from MSB to LSB: the │
342 │ │ 16-bit category ID, the │
343 │ │ 24-bit OUI, the 8-bit OUI │
344 │ │ type and the 16-bit sub‐ │
345 │ │ category ID. │
346 ├──────────────────┼────────────────────────────┤
347 │AuthorizedMACs │ Comma-separated MAC ad‐ │
348 │ │ dress list │
349 │ │ │
350 │ │ Optional list of Autho‐ │
351 │ │ rized MAC addresses for │
352 │ │ the WSC registrar to check │
353 │ │ on association. Each ad‐ │
354 │ │ dress is specified in the │
355 │ │ colon-hexadecimal nota‐ │
356 │ │ tion. Defaults to no │
357 │ │ MAC-based checks. │
358 └──────────────────┴────────────────────────────┘
359
361 iwd(8), iwd.network(5)
362
364 James Prestwood <prestwoj@gmail.com>
365
367 2020 Intel Corporation
368iwd 20 October 2020 IWD.AP(5)