Commit Graph

218 Commits

Author SHA1 Message Date
Ram Subramanian c0058c07bf doc: document channel field in station diagnostics 2024-02-26 09:44:38 -06:00
James Prestwood 98ae3d4197 doc: document use of l_log APIs
With the introduction of l_notice in IWD some guidelines need to be
set for l_info, l_warn, l_error, l_debug and l_notice.
2024-02-22 10:15:02 -06:00
James Prestwood 5e1f19fca7 doc: document additional NotSupported shared code return 2023-11-17 10:51:23 -06:00
James Prestwood 9dbfac2756 doc: document Stop() correctly for both DPP interfaces
Stop() was separated more clearly between the two interfaces and will
now return NotFound if called on an interface that isn't currently
running.
2023-11-09 10:21:14 -06:00
James Prestwood 20f13184f2 doc: PKEX support for DPP
PKEX is part of the WFA EasyConnect specification and is
an additional boostrapping method (like QR codes) for
exchanging public keys between a configurator and enrollee.

PKEX operates over wifi and requires a key/code be exchanged
prior to the protocol. The key is used to encrypt the exchange
of the boostrapping information, then DPP authentication is
started immediately aftewards.

This can be useful for devices which don't have the ability to
scan a QR code, or even as a more convenient way to share
wireless credentials if the PSK is very secure (i.e. not a
human readable string).

PKEX would be used via the three DBus APIs on a new interface
SharedCodeDeviceProvisioning.

ConfigureEnrollee(a{sv}) will start a configurator with a
static shared code (optionally identifier) passed in as the
argument to this method.

StartEnrollee(a{sv}) will start a PKEX enrollee using a static
shared code (optionally identifier) passed as the argument to
the method.

StartConfigurator(o) will start a PKEX configurator and use the
agent specified by the path argument. The configurator will query
the agent for a specific code when an enrollee sends the initial
exchange message.

After the PKEX protocol is finished, DPP bootstrapping keys have
been exchanged and DPP Authentication will start, followed by
configuration.
2023-11-07 20:24:38 -06:00
Denis Kenzior c866f8dc9a doc: Add document describing code coverage testing 2023-06-19 15:35:25 -05:00
Denis Kenzior dba29c1bfb doc: Update EnableIPv6 description in sample main.conf
The description incorrectly stated that EnableIPv6 defaulted to
disabled.
2023-06-18 14:06:24 -05:00
Denis Kenzior f0ae46916f doc: Add 'none' NameResolvingService in sample main.conf 2023-06-18 14:06:24 -05:00
James Prestwood 91c6dea57b doc: document AP properties PairwiseCiphers/GroupCipher 2022-11-04 12:04:05 -05:00
Denis Kenzior d129c54364 doc: Add Frequency property to Access Point 2022-11-01 15:48:56 -05:00
Denis Kenzior 2f64f0d080 doc: Document GCMP|CCMP-256 ciphers 2022-10-24 11:05:24 -05:00
Denis Kenzior bf4ad7a6e7 doc: Document PairwiseCipher property
Add an additional optional PairwiseCipher property on
net.connman.iwd.StationDiagnostic interface that will hold the current
pairwise cipher in use for the connection.
2022-10-24 11:05:24 -05:00
Andrew Zaborowski afa9a1261c doc: Drop proposed and unimplemented API doc 2022-10-03 10:29:21 -05:00
Andrew Zaborowski 49d098b434 doc: Update Netconfig Agent API doc
Update ConfigureIPv{4,6}() parameters to simplify mapping our sets of
addresses and routes directly to D-Bus dictionaries.  Split Cancel()
into CancelIPv{4,6}().
2022-09-13 08:44:02 -05:00
James Prestwood 9ae4b959a2 doc: add documentation for StationDebug 2022-08-11 15:46:35 -05:00
Jesse Lentz fb014268d5 doc: Mention "wep" network type
Document "wep" as a possible Network Type. Mention that connections to WEP
networks are unsupported.
2022-07-20 12:34:55 -05:00
Jesse Lentz 03cc7a5f79 doc: Add new DeviceProvisioning API properties
Document the Started, Role, and URI properties of the DeviceProvisioning
API.
2022-06-27 11:06:49 -05:00
Jesse Lentz 8115105835 doc: Document initial signal level notification
Document the initial "Changed" method call following SignalLevelAgent
registration.
2022-05-20 16:57:42 -05:00
Denis Kenzior f370b1b960 doc: Require scapy for test-runner 2022-05-11 17:26:56 -05:00
James Prestwood c5f44f8d38 doc: Update the test-runner documentation
Includes instructions for UML, which is now the preferred way to use
test-runner.
2022-04-08 10:48:17 -05:00
James Prestwood 87345b4c14 doc: update hwsim documentation
This was quite dated and needed to be updated both to
reflect the API change to a dictionary argument, as well
as document NoVirtualInterface.
2022-04-05 13:50:40 -05:00
James Prestwood be2e1faa31 doc: document access point scanning 2022-02-28 11:43:48 -06:00
James Prestwood 6a4a3086ce doc: document DPP ConfigureEnrollee() 2022-02-22 16:25:58 -06:00
Denis Kenzior 4a3792da7e doc: Rename device-provisioning.txt
device-provisioning.txt is an API file, so name it accordingly.
2022-01-20 14:22:32 -06:00
Denis Kenzior 04fccea63b doc: Add sample main.conf file
This file is meant as a sample and contains only the most typically
changed settings.  For other settings users should refer to the
iwd.config manual page.
2022-01-03 14:24:19 -06:00
James Prestwood 7691e859d1 doc: document StartConfigurator 2021-12-20 18:13:44 -06:00
James Prestwood ae52ab2cfb doc: document DPP interface 2021-12-16 13:53:14 -06:00
Denis Kenzior 83cfaee59a doc: Mark NetworkConfigurationAgent API experimental 2021-11-11 14:35:25 -06:00
Torsten Schmitz 22c77cc037 auto-t: replace ifconfig with ip commands
ifconfig has long been deprecated in favor of ip from iproute2.
It is usually no longer installed by default.
2021-11-11 14:29:54 -06:00
Andrew Zaborowski 9cd1f8a7df doc: Add NetworkConfigurationAgent API description
Document the new API that clients can use to get notified of new network
configuration and be responsible for committing it to the netdev, the
resolver, etc.
2021-11-10 12:03:31 -06:00
Denis Kenzior 76c41775fb doc: Bump test-runner python requirement to 3.9 2021-11-10 09:22:25 -06:00
Andrew Zaborowski 005198bf07 doc: Document autotest radvd dependency 2021-11-09 14:32:54 -06:00
Andrew Zaborowski 04773eaa2c doc: Update agent-api.txt to match code and clarify 2021-10-22 12:10:48 -05:00
Andrew Zaborowski f9edb5e605 doc: Document the p2p.Peer.Address property 2021-10-06 15:59:39 -05:00
James Prestwood 9da9c5a63f doc: add testing option to hostapd.config
This is required to be built in for hostapd to rekey on command.
2021-09-28 17:39:45 -05:00
Andrew Zaborowski 97587e399f doc: Add net.connman.iwd.IPv{4,6}Configuration API doc 2021-09-14 15:12:10 -05:00
Denis Kenzior 049cb701d0 doc: No reply expected/wanted from Cancel/Release 2021-06-09 10:35:35 -05:00
Denis Kenzior 051a911840 doc: Fix SignalLevelAgent API signatures
The Changed() method did not actually return anything, and in fact the
no_reply flag for that message was set.

Similarly, the Release method does not expect a reply.
2021-06-09 10:32:32 -05:00
Andrew Zaborowski f9907cdaac doc: Document autotests' wpa_supplicant dependency 2021-06-04 11:56:55 -05:00
Andrew Zaborowski 48ddd52ced doc: Document NetworkConfigurationEnabled in Daemon.GetInfo() 2021-05-11 10:08:42 -05:00
Andrew Zaborowski 73d98d8875 doc: Daemon DBus interface documentation 2021-05-07 08:42:37 -05:00
James Prestwood c66ade2eac doc: document Security diagnostic value 2021-03-29 13:14:56 -05:00
James Prestwood f6801be8a3 doc: document new AverageRSSI diagnostics key 2021-03-16 11:25:28 -05:00
James Prestwood 3ce1e053f0 doc: add Frequency to station diagnostics 2021-02-03 12:54:59 -06:00
Denis Kenzior 078a41b011 doc: Rename files for consistency 2021-02-02 15:58:10 -06:00
James Prestwood d51529bef5 doc: document Name property on AP interface 2021-02-02 15:53:08 -06:00
Alvin Šipraga 30e7bf5f0d doc: update test-runner invocation documentation
The test-runner no longer recognizes -t to specify an autotest. Instead
it uses -A.
2021-01-27 13:20:29 -06:00
Alvin Šipraga 5e7ec20057 doc: add python package requirements for test-runner 2021-01-27 13:19:42 -06:00
Alvin Šipraga d83b4a4597 doc: update kernel configuration instructions for KVM guests
The kvmguest shorthand was removed after the release of Linux 5.10. It
was just shorthand for kvm_guest.config anyway, so update the
test-runner documentation accordingly.
2021-01-27 13:19:26 -06:00
James Prestwood 0b3b644c55 doc: document AccessPointDiagnostic interface 2021-01-20 13:59:38 -06:00