3:52 a.m.
---
Makefile.am | 6 +++--
src/iwd.ap.rst | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 66 insertions(+), 2 deletions(-)
create mode 100644 src/iwd.ap.rst
diff --git a/Makefile.am b/Makefile.am
index d49833b7..1f0b0d30 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -171,7 +171,8 @@ man_MANS =
endif
manual_pages = src/iwd.8 src/iwd.debug.7 src/iwd.config.5 src/iwd.network.5 \
- client/iwctl.1 monitor/iwmon.1 wired/ead.8 tools/hwsim.1
+ src/iwd.ap.5 client/iwctl.1 monitor/iwmon.1 wired/ead.8 \
+ tools/hwsim.1
eap_sources = src/eap.c src/eap.h src/eap-private.h \
src/eap-md5.c \
@@ -263,7 +264,8 @@ systemd_network_DATA += src/80-iwd.link
endif
if MANUAL_PAGES
-man_MANS += src/iwd.8 src/iwd.debug.7 src/iwd.config.5 src/iwd.network.5
+man_MANS += src/iwd.8 src/iwd.debug.7 src/iwd.config.5 src/iwd.network.5 \
+ src/iwd.ap.5
endif
endif
diff --git a/src/iwd.ap.rst b/src/iwd.ap.rst
new file mode 100644
index 00000000..939bf99d
--- /dev/null
+++ b/src/iwd.ap.rst
@@ -0,0 +1,62 @@
+============
+ iwd.ap
+============
+
+--------------------------------------
+Configuration of IWD access point
+--------------------------------------
+
+:Author: James Prestwood <prestwoj(a)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
+===========
+
+An access point provisioning files define the configuration of an IWD access
+point. These files live in *$STATE_DIRECTORY*/ap (/var/lib/iwd/ap by default).
+
+FILE FORMAT
+===========
+
+See *iwd.network* for details on the file format.
+
+SETTINGS
+========
+
+The settings are split into several categories. Each category has a group
+associated with it and described in separate tables below.
+
+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
+
+ Passphrase to be used with this access point.
+
+SEE ALSO
+========
+
+iwd(8), iwd.network(5)
--
2.26.2
3:52 a.m.
New subject: [PATCH 2/4] doc: document AP StartProfile
---
doc/access-point-api.txt | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/doc/access-point-api.txt b/doc/access-point-api.txt
index 9ee06baa..9682b3c7 100644
--- a/doc/access-point-api.txt
+++ b/doc/access-point-api.txt
@@ -25,6 +25,18 @@ Methods void Start(string ssid, string psk)
net.connman.iwd.Failed
net.connman.iwd.InvalidArguments
+ void StartProfile(string ssid)
+
+ Start a profile based access point. A profile must exist
+ in IWD's AP configuration directory (/var/lib/iwd/ap/
+ by default) of the name <ssid>.ap.
+
+ Possible errors: net.connman.iwd.Busy
+ net.connman.iwd.Failed
+ net.connman.iwd.InvalidArguments
+ net.connman.iwd.AlreadyExists
+ net.connman.iwd.NotFound
+
Properties boolean Started [readonly]
Reflects whether an access point has been started.
--
2.26.2
3:52 a.m.
New subject: [PATCH 3/4] doc: add APRanges documentation
---
src/iwd.config.rst | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/src/iwd.config.rst b/src/iwd.config.rst
index 96774092..5d3cfb3a 100644
--- a/src/iwd.config.rst
+++ b/src/iwd.config.rst
@@ -67,10 +67,23 @@ 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.
+
The network configuration feature is disabled by default. See
``[Network]`` settings for additional settings related to network
configuration.
+ * - APRanges
+ - Values: <IP in prefix notation>
+
+ Sets the range of IP's used for DHCP server (AP mode). The IP should be
+ in prefix notation e.g. aaa.bbb.ccc.ddd/xx. 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**
--
2.26.2
3:52 a.m.
New subject: [PATCH 4/4] doc: document DHCP server options in AP profiles
---
src/iwd.ap.rst | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 48 insertions(+)
diff --git a/src/iwd.ap.rst b/src/iwd.ap.rst
index 939bf99d..52312855 100644
--- a/src/iwd.ap.rst
+++ b/src/iwd.ap.rst
@@ -56,6 +56,54 @@ configuration.
Passphrase to be used with this access point.
+DHCP Server Settings
+--------------------
+
+The group ``[IPv4]`` contains settings for IWD's built in DHCP server. All
+settings are optional.
+
+.. list-table::
+ :header-rows: 0
+ :stub-columns: 0
+ :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.
+
+ * - Gateway
+ - IP Address of gateway
+
+ IP address of gateway. This will inherit from [IPv4].Address if not
+ provided.
+
+ * - Netmask
+ - Netmask of DHCP server
+
+ This will be generated from [IPv4].Address if not provided.
+
+ * - DNSList
+ - List of DNS servers
+
+ 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
+
+ Override the default lease time.
+
+ * - IPRange
+ - Range of IPs to use for the DHCP server
+
+ If not provided a default range will be chosen which is the DHCP server
+ address + 1 to 254.
+
SEE ALSO
========
--
2.26.2
683
days inactive
683
days old
4 comments
2 participants
participants (2)
-
Denis Kenzior -
James Prestwood