Update the AP-mode address logic documentation, change some of the wording and add some references. --- src/iwd.ap.rst | 69 +++++++++++++++++++++++++++++----------------- src/iwd.config.rst | 31 +++++++++++++-------- 2 files changed, 63 insertions(+), 37 deletions(-) diff --git a/src/iwd.ap.rst b/src/iwd.ap.rst index 52312855..e2ec01e6 100644 --- a/src/iwd.ap.rst +++ b/src/iwd.ap.rst @@ -3,7 +3,7 @@ ============ -------------------------------------- -Configuration of IWD access point +Configuration of IWD access points -------------------------------------- :Author: James Prestwood @@ -25,19 +25,21 @@ Description of access point provisioning files. DESCRIPTION =========== -An access point provisioning files define the configuration of an IWD access +An access point provisioning file defines the configuration of an IWD access point. These files live in *$STATE_DIRECTORY*/ap (/var/lib/iwd/ap by default). +They are read when the `net.connman.iwd.AccessPoint.StartProfile(ssid)` DBus +method is used. FILE FORMAT =========== -See *iwd.network* for details on the file format. +See *iwd.network* for details on the settings file syntax. SETTINGS ======== The settings are split into several categories. Each category has a group -associated with it and described in separate tables below. +associated with it and is described in the corresponding table below. Network Authentication Settings ------------------------------- @@ -54,13 +56,15 @@ configuration. * - Passphrase - 8..63 character string - Passphrase to be used with this access point. + WPA PSK Passphrase to be used with this access point. -DHCP Server Settings --------------------- +IPv4 Network Configuration +-------------------------- -The group ``[IPv4]`` contains settings for IWD's built in DHCP server. All -settings are optional. +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 and the DHCP server for this access point. .. list-table:: :header-rows: 0 @@ -68,41 +72,56 @@ settings are optional. :widths: 20 80 * - Address - - IP Address of AP - - Optional address for the DHCP server/access point. If provided this - address will be set on the AP interface and any other DHCP server options - will be derived from this address, unless they are overriden inside the - AP profile. If [IPv4].Address is not provided and no IP address is set - on the interface prior to calling StartProfile the IP pool will be used. + - Local IP address or a comma-separated list of prefix-notation addresses + + Optional local address pool for the access point and the DHCP server. + If a single address is provided this address will be set on the AP + interface and any other DHCP server options will be derived from it, + unless they are overriden by other settings. If a list of addresses and + prefix lengths is given (in the `/` format), a single + subnet address will be selected from the available space each time this + profile is started. The subnet size will still be based on the + ``[IPv4].Netmask`` setting. If ``[IPv4].Address`` is not provided and + no IP address is set on the interface prior to calling `StartProfile` + the value of the main.conf ``[IPv4].APAddressPool`` setting will be + inherited, which in turn defaults to 192.168.0.0/16. + + For example, if ``[IPv4].Netmask`` is set the 255.255.255.0 and this + setting, or the global ``APAddressPool`` fallback, is set to + ``192.168.0.0/16, 10.0.0.0/22``, IWD will select one of the 256 subnets + with addresses in the 192.168.<0-255>.0/24 range or one of the 4 subnets + with addresses in the 10.0.<0-3>.0/24 range, allowing 270 possible + subnets. Defining an address pool larger than the subnet may be + desired if other interfaces on the system use dynamically assigned + addresses giving IWD a chance to avoid conflicts. * - Gateway - IP Address of gateway - IP address of gateway. This will inherit from [IPv4].Address if not - provided. + IP address of the gateway to be advertised by DHCP. This will fall back + to the local IP address if not provided. * - Netmask - - Netmask of DHCP server + - Local netmask of the AP - This will be generated from [IPv4].Address if not provided. + Defaults to a 28-bit netmask if not provided. * - DNSList - - List of DNS servers + - List of DNS servers as a comma-separated IP address list 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 - - Time limit for DHCP leases + - Time limit for DHCP leases in seconds Override the default lease time. * - IPRange - - Range of IPs to use for the DHCP server + - Range of IPs given as two addresses separated by a comma - If not provided a default range will be chosen which is the DHCP server - address + 1 to 254. + 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. SEE ALSO ======== diff --git a/src/iwd.config.rst b/src/iwd.config.rst index 478bd616..e3dc2827 100644 --- a/src/iwd.config.rst +++ b/src/iwd.config.rst @@ -67,23 +67,13 @@ The group ``[General]`` contains general settings. obtain the dynamic addresses from the network through the built-in DHCP client. - This also enables DHCP server when in AP mode when either - [General].APRanges is set or an AP profile is being used. + This also enables network configuration and the DHCP server when in AP + mode and the AP profile being activated does does not override it. The network configuration feature is disabled by default. See ``[Network]`` settings for additional settings related to network configuration. - * - APRanges - - Values: - - Sets the range of IP's used for DHCP server (AP mode). The IP should be - in prefix notation e.g. 192.168.1.0/24. AP's which are started in a - profile-less configuration will use this pool of IP's to set the AP's - interface address as well as default DHCP server options. Each AP will - get a new subnet from the range and clients will be addressed in that - subnet to avoid IP conflicts if multiple AP's are started. - * - UseDefaultInterface - Values: true, **false** @@ -312,6 +302,23 @@ No modification from defaults is normally required. prevent **iwd** from roaming properly, but can be useful for networks operating under extremely low rssi levels where roaming isn't possible. +IPv4 +---- + +The group ``[IPv4]`` contains settings related to IPv4 address configuration. + + * - APAddressPool + - Values: comma-separated list of prefix-notation IPv4 address strings + + Defines the space of IPs used for the Access Point-mode subnet addresses + and the DHCP server. Defaults to 192.168.0.0/16. The prefix length + decides the size of the pool from which an address is selected but the + actual subnet size (netmask) is based on the AP profile being activated + and defaults to 28 bits. The AP profile's ``[IPv4].Address`` setting + overrides the global value set here. Setting a too small address space + will limit the number of access points that can be running + simultaneously on different interfaces. + SEE ALSO ======== -- 2.27.0