2020-11-04 17:52:24 +01:00
|
|
|
============
|
|
|
|
iwd.ap
|
|
|
|
============
|
|
|
|
|
|
|
|
--------------------------------------
|
2021-04-27 01:34:07 +02:00
|
|
|
Configuration of IWD access points
|
2020-11-04 17:52:24 +01:00
|
|
|
--------------------------------------
|
|
|
|
|
|
|
|
:Author: James Prestwood <prestwoj@gmail.com>
|
|
|
|
:Copyright: 2020 Intel Corporation
|
|
|
|
:Version: iwd
|
|
|
|
:Date: 20 October 2020
|
|
|
|
:Manual section: 5
|
|
|
|
:Manual group: Linux Connectivity
|
|
|
|
|
|
|
|
NAME
|
|
|
|
====
|
|
|
|
iwd.ap - Access point provisioning files
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
========
|
|
|
|
|
|
|
|
Description of access point provisioning files.
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
===========
|
|
|
|
|
2021-04-27 01:34:07 +02:00
|
|
|
An access point provisioning file defines the configuration of an IWD access
|
2020-11-04 17:52:24 +01:00
|
|
|
point. These files live in *$STATE_DIRECTORY*/ap (/var/lib/iwd/ap by default).
|
2021-04-27 01:34:07 +02:00
|
|
|
They are read when the `net.connman.iwd.AccessPoint.StartProfile(ssid)` DBus
|
|
|
|
method is used.
|
2020-11-04 17:52:24 +01:00
|
|
|
|
|
|
|
FILE FORMAT
|
|
|
|
===========
|
|
|
|
|
2021-04-27 01:34:07 +02:00
|
|
|
See *iwd.network* for details on the settings file syntax.
|
2020-11-04 17:52:24 +01:00
|
|
|
|
|
|
|
SETTINGS
|
|
|
|
========
|
|
|
|
|
|
|
|
The settings are split into several categories. Each category has a group
|
2021-04-27 01:34:07 +02:00
|
|
|
associated with it and is described in the corresponding table below.
|
2020-11-04 17:52:24 +01:00
|
|
|
|
2021-04-27 01:34:08 +02:00
|
|
|
General Settings
|
|
|
|
----------------
|
|
|
|
|
|
|
|
The group ``[General]`` contains general AP configuration.
|
|
|
|
|
|
|
|
.. list-table::
|
|
|
|
:header-rows: 0
|
|
|
|
:stub-columns: 0
|
|
|
|
:widths: 20 80
|
|
|
|
:align: left
|
|
|
|
|
|
|
|
* - Channel
|
|
|
|
- Channel number
|
|
|
|
|
|
|
|
Optional channel number for the access point to operate on. Only the
|
|
|
|
2.4GHz-band channels are currently allowed.
|
|
|
|
|
2020-11-04 17:52:24 +01:00
|
|
|
Network Authentication Settings
|
|
|
|
-------------------------------
|
|
|
|
|
|
|
|
The group ``[Security]`` contains settings for Wi-Fi security and authentication
|
|
|
|
configuration.
|
|
|
|
|
|
|
|
.. list-table::
|
|
|
|
:header-rows: 0
|
|
|
|
:stub-columns: 0
|
|
|
|
:widths: 20 80
|
|
|
|
:align: left
|
|
|
|
|
|
|
|
* - Passphrase
|
|
|
|
- 8..63 character string
|
|
|
|
|
2021-04-27 01:34:08 +02:00
|
|
|
WPA-PSK Passphrase to be used with this access point. At least one of
|
|
|
|
*Passphrase*, *PreSharedKey* must be present.
|
|
|
|
|
|
|
|
* - PreSharedKey
|
|
|
|
- 64-character hex-string
|
|
|
|
|
|
|
|
Processed passphrase for this network in the form of a hex-encoded
|
|
|
|
32-byte pre-shared key. Either this or *Passphrase* must be present.
|
2020-11-04 17:52:24 +01:00
|
|
|
|
2021-04-27 01:34:07 +02:00
|
|
|
IPv4 Network Configuration
|
|
|
|
--------------------------
|
2020-11-04 17:52:27 +01:00
|
|
|
|
2021-04-27 01:34:07 +02:00
|
|
|
The group ``[IPv4]`` contains settings for IWD's built-in DHCP server. All
|
|
|
|
settings are optional. They're used if network configuration was enabled as
|
|
|
|
described in ``iwd.config(5)``. Omitting the ``[IPv4]`` group disables
|
|
|
|
network configuration for this access point so if an all-defaults DHCP setup
|
|
|
|
is desired, the group header line must still be present:
|
|
|
|
|
|
|
|
.. code-block::
|
|
|
|
|
|
|
|
# Enable network configuration
|
|
|
|
[IPv4]
|
|
|
|
|
|
|
|
[other groups follow]
|
2020-11-04 17:52:27 +01:00
|
|
|
|
|
|
|
.. list-table::
|
|
|
|
:header-rows: 0
|
|
|
|
:stub-columns: 0
|
|
|
|
:widths: 20 80
|
|
|
|
|
|
|
|
* - Address
|
2021-04-27 01:34:07 +02:00
|
|
|
- Local IP address
|
2020-11-04 17:52:27 +01:00
|
|
|
|
2021-04-27 01:34:07 +02:00
|
|
|
Optional local address pool for the access point and the DHCP server.
|
|
|
|
If provided this addresss will be set on the AP interface and any other
|
|
|
|
DHCP server options will be derived from it, unless they are overridden
|
|
|
|
by other settings below. If *Address* is not provided and no IP
|
|
|
|
address is set on the interface prior to calling `StartProfile`, the IP
|
|
|
|
pool defined by the global ``[General].APRanges`` setting will be used.
|
2020-11-04 17:52:27 +01:00
|
|
|
|
|
|
|
* - Gateway
|
|
|
|
- IP Address of gateway
|
|
|
|
|
2021-04-27 01:34:07 +02:00
|
|
|
IP address of the gateway to be advertised by DHCP. This will fall back
|
|
|
|
to the local IP address if not provided.
|
2020-11-04 17:52:27 +01:00
|
|
|
|
|
|
|
* - Netmask
|
2021-04-27 01:34:07 +02:00
|
|
|
- Local netmask of the AP
|
2020-11-04 17:52:27 +01:00
|
|
|
|
2021-04-27 01:34:07 +02:00
|
|
|
This will be generated from ``[IPv4].Address`` if not provided.
|
2020-11-04 17:52:27 +01:00
|
|
|
|
|
|
|
* - DNSList
|
2021-04-27 01:34:07 +02:00
|
|
|
- List of DNS servers as a comma-separated IP address list
|
2020-11-04 17:52:27 +01:00
|
|
|
|
|
|
|
A list of DNS servers which will be advertised by the DHCP server. If
|
|
|
|
not provided no DNS servers will be sent by the DHCP server.
|
|
|
|
|
|
|
|
* - LeaseTime
|
2021-04-27 01:34:07 +02:00
|
|
|
- Time limit for DHCP leases in seconds
|
2020-11-04 17:52:27 +01:00
|
|
|
|
|
|
|
Override the default lease time.
|
|
|
|
|
|
|
|
* - IPRange
|
2021-04-27 01:34:07 +02:00
|
|
|
- Range of IPs given as two addresses separated by a comma
|
2020-11-04 17:52:27 +01:00
|
|
|
|
2021-04-27 01:34:07 +02:00
|
|
|
From and to addresses of the range assigned to clients through DHCP.
|
|
|
|
If not provided the range from local address + 1 to .254 will be used.
|
2020-11-04 17:52:27 +01:00
|
|
|
|
2021-04-27 01:34:08 +02:00
|
|
|
Wi-Fi Simple Configuration
|
|
|
|
--------------------------
|
|
|
|
|
|
|
|
The group ``[WSC]`` fine-tunes some Wi-Fi Simple Configuration local parameters
|
|
|
|
(formerly known as WPS, Wi-Fi Protected Setup.)
|
|
|
|
|
|
|
|
.. list-table::
|
|
|
|
:header-rows: 0
|
|
|
|
:stub-columns: 0
|
|
|
|
:widths: 20 80
|
|
|
|
:align: left
|
|
|
|
|
|
|
|
* - DeviceName
|
|
|
|
- 1..32-character string
|
|
|
|
|
|
|
|
Optional Device Name string for the AP to advertise as. Defaults to
|
|
|
|
the SSID.
|
|
|
|
|
|
|
|
* - PrimaryDeviceType
|
|
|
|
- Subcategory string or a 64-bit integer
|
|
|
|
|
|
|
|
Optional Primary Device Type for the AP to advertise as. Defaults to
|
|
|
|
PC computer. Can be specified as a lower-case WSC v2.0.5 subcategory
|
|
|
|
string or a 64-bit integer encoding, from MSB to LSB: the 16-bit
|
|
|
|
category ID, the 24-bit OUI, the 8-bit OUI type and the 16-bit
|
|
|
|
subcategory ID.
|
|
|
|
|
|
|
|
* - AuthorizedMACs
|
|
|
|
- Comma-separated MAC address list
|
|
|
|
|
|
|
|
Optional list of Authorized MAC addresses for the WSC registrar to
|
|
|
|
check on association. Each address is specified in the
|
|
|
|
colon-hexadecimal notation. Defaults to no MAC-based checks.
|
|
|
|
|
2020-11-04 17:52:24 +01:00
|
|
|
SEE ALSO
|
|
|
|
========
|
|
|
|
|
|
|
|
iwd(8), iwd.network(5)
|