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. Only the │
37 │ │ 2.4GHz-band channels are │
38 │ │ currently allowed. │
39 └────────┴────────────────────────────┘
40 Network Authentication Settings
42 The group [Security] contains settings for Wi-Fi security and authenti‐
43 cation configuration.
44 ┌─────────────┬────────────────────────────┐
46 │Passphrase │ 8..63 character string │
47 │ │ │
48 │ │ WPA-PSK Passphrase to be │
49 │ │ used with this access │
50 │ │ point. At least one of │
51 │ │ Passphrase, PreSharedKey │
52 │ │ must be present. │
53 ├─────────────┼────────────────────────────┤
54 │PreSharedKey │ 64-character hex-string │
55 │ │ │
56 │ │ Processed passphrase for │
57 │ │ this network in the form │
58 │ │ of a hex-encoded 32-byte │
59 │ │ pre-shared key. Either │
60 │ │ this or Passphrase must be │
61 │ │ present. │
62 └─────────────┴────────────────────────────┘
63 IPv4 Network Configuration
65 The group [IPv4] contains settings for IWD's built-in DHCP server. All
66 settings are optional. They're used if network configuration was en‐
67 abled as described in iwd.config(5). Omitting the [IPv4] group dis‐
68 ables network configuration for this access point so if an all-defaults
69 DHCP setup is desired, the group header line must still be present:
70 # Enable network configuration
72 [IPv4]
73 [other groups follow]
75 ┌──────────┬────────────────────────────┐
77 │Address │ Local IP address │
78 │ │ │
79 │ │ Optional local address │
80 │ │ pool for the access point │
81 │ │ and the DHCP server. If │
82 │ │ provided this addresss │
83 │ │ will be set on the AP in‐ │
84 │ │ terface and any other DHCP │
85 │ │ server options will be de‐ │
86 │ │ rived from it, unless they │
87 │ │ are overridden by other │
88 │ │ settings below. If Ad‐ │
89 │ │ dress is not provided and │
90 │ │ no IP address is set on │
91 │ │ the interface prior to │
92 │ │ calling StartProfile, the │
93 │ │ IP pool defined by the │
94 │ │ global [General].APRanges │
95 │ │ setting will be used. │
96 ├──────────┼────────────────────────────┤
97 │Gateway │ IP Address of gateway │
98 │ │ │
99 │ │ IP address of the gateway │
100 │ │ to be advertised by DHCP. │
101 │ │ This will fall back to the │
102 │ │ local IP address if not │
103 │ │ provided. │
104 ├──────────┼────────────────────────────┤
105 │Netmask │ Local netmask of the AP │
106 │ │ │
107 │ │ This will be generated │
108 │ │ from [IPv4].Address if not │
109 │ │ provided. │
110 ├──────────┼────────────────────────────┤
111 │DNSList │ List of DNS servers as a │
112 │ │ comma-separated IP address │
113 │ │ list │
114 │ │ │
115 │ │ A list of DNS servers │
116 │ │ which will be advertised │
117 │ │ by the DHCP server. If not │
118 │ │ provided no DNS servers │
119 │ │ will be sent by the DHCP │
120 │ │ server. │
121 ├──────────┼────────────────────────────┤
122 │LeaseTime │ Time limit for DHCP leases │
123 │ │ in seconds │
124 │ │ │
125 │ │ Override the default lease │
126 │ │ time. │
127 └──────────┴────────────────────────────┘
128 │IPRange │ Range of IPs given as two │
134 │ │ addresses separated by a │
135 │ │ comma │
136 │ │ │
137 │ │ From and to addresses of │
138 │ │ the range assigned to │
139 │ │ clients through DHCP. If │
140 │ │ not provided the range │
141 │ │ from local address + 1 to │
142 │ │ .254 will be used. │
143 └──────────┴────────────────────────────┘
144 Wi-Fi Simple Configuration
146 The group [WSC] fine-tunes some Wi-Fi Simple Configuration local param‐
147 eters (formerly known as WPS, Wi-Fi Protected Setup.)
148 ┌──────────────────┬────────────────────────────┐
150 │DeviceName │ 1..32-character string │
151 │ │ │
152 │ │ Optional Device Name │
153 │ │ string for the AP to ad‐ │
154 │ │ vertise as. Defaults to │
155 │ │ the SSID. │
156 ├──────────────────┼────────────────────────────┤
157 │PrimaryDeviceType │ Subcategory string or a │
158 │ │ 64-bit integer │
159 │ │ │
160 │ │ Optional Primary Device │
161 │ │ Type for the AP to adver‐ │
162 │ │ tise as. Defaults to PC │
163 │ │ computer. Can be speci‐ │
164 │ │ fied as a lower-case WSC │
165 │ │ v2.0.5 subcategory string │
166 │ │ or a 64-bit integer encod‐ │
167 │ │ ing, from MSB to LSB: the │
168 │ │ 16-bit category ID, the │
169 │ │ 24-bit OUI, the 8-bit OUI │
170 │ │ type and the 16-bit sub‐ │
171 │ │ category ID. │
172 ├──────────────────┼────────────────────────────┤
173 │AuthorizedMACs │ Comma-separated MAC ad‐ │
174 │ │ dress list │
175 │ │ │
176 │ │ Optional list of Autho‐ │
177 │ │ rized MAC addresses for │
178 │ │ the WSC registrar to check │
179 │ │ on association. Each ad‐ │
180 │ │ dress is specified in the │
181 │ │ colon-hexadecimal nota‐ │
182 │ │ tion. Defaults to no │
183 │ │ MAC-based checks. │
184 └──────────────────┴────────────────────────────┘
185
187 iwd(8), iwd.network(5)
188
190 James Prestwood <prestwoj@gmail.com>
191
193 2020 Intel Corporation
194iwd 20 October 2020 IWD.AP(5)