/** \page dbus %wpa_supplicant D-Bus API This section documents the %wpa_supplicant D-Bus API. Every D-Bus interface implemented by %wpa_supplicant is described here including their methods, signals, and properties with arguments, returned values, and possible errors. Interfaces: - \ref dbus_main - \ref dbus_interface - \ref dbus_wps - \ref dbus_bss - \ref dbus_network \section dbus_main fi.w1.wpa_supplicant1 Interface implemented by the main %wpa_supplicant D-Bus object registered in the bus with fi.w1.wpa_supplicant1 name. \subsection dbus_main_methods Methods
Registers a wireless interface in %wpa_supplicant.
Key | Value type | Description | Required |
---|---|---|---|
Ifname | s | Name of the network interface to control, e.g., wlan0 | Yes |
BridgeIfname | s | Name of the bridge interface to control, e.g., br0 | No |
Driver | s | Driver name which the interface uses, e.g., nl80211 | No |
ConfigFile | s | Configuration file path | No |
Deregisters a wireless interface from %wpa_supplicant.
Returns a D-Bus path to an object related to an interface which %wpa_supplicant already controls.
Global %wpa_supplicant debugging level. Possible values are "msgdump" (verbose debugging), "debug" (debugging), "info" (informative), "warning" (warnings), and "error" (errors).
Global %wpa_supplicant debugging parameter. Determines if timestamps are shown in debug logs.
Global %wpa_supplicant debugging parameter. Determines if secrets are shown in debug logs.
An array with paths to D-Bus objects representing controlled interfaces each.
An array with supported EAP methods names.
An array with supported capabilities (e.g., "ap", "ibss-rsn", "p2p", "interworking").
A new interface was added to %wpa_supplicant.
An interface was removed from %wpa_supplicant.
Some properties have changed.
Triggers a scan.
Key | Value type | Description | Required |
---|---|---|---|
Type | s | Type of the scan. Possible values: "active", "passive" | Yes |
SSIDs | aay | Array of SSIDs to scan for (applies only if scan type is active) | No |
IEs | aay | Information elements to used in active scan (applies only if scan type is active) | No |
Channels | a(uu) | Array of frequencies to scan in form of (center, width) in MHz. | No |
AllowRoam | b | TRUE (or absent) to allow a roaming decision based on the results of this scan, FALSE to prevent a roaming decision. | No |
Disassociates the interface from current network.
Adds a new network to the interface.
Removes a configured network from the interface.
Attempt association with a configured network.
Attempt reassociation.
Attempt reassociation back to the current BSS.
Adds a blob to the interface.
Removes the blob from the interface.
Returns the blob data of a previously added blob.
Set autoscan parameters for the interface.
Initiate a TDLS discovery for a peer.
Setup a TDLS session for a peer.
Return TDLS status with respect to a peer.
Tear down a TDLS session with a peer.
IEEE 802.1X EAPOL state machine logoff.
IEEE 802.1X EAPOL state machine logon.
Set PKCS #11 engine and module path.
Fetch signal properties for the current connection.
Key | Value type | Description | Required |
---|---|---|---|
linkspeed | i | Link speed (Mbps) | No |
noise | i | Noise (dBm) | No |
width | s | Channel width | No |
frequency | u | Frequency (MHz) | No |
rssi | i | RSSI (dBm) | No |
avg-rssi | i | Average RSSI (dBm) | No |
center-frq1 | i | VHT segment 1 frequency (MHz) | No |
center-frq2 | i | VHT segment 2 frequency (MHz) | No |
Capabilities of the interface. Dictionary contains following entries:
Key | Value type | Description |
---|---|---|
Pairwise | as | Possible array elements: "ccmp", "tkip", "none" |
Group | as | Possible array elements: "ccmp", "tkip", "wep104", "wep40" |
KeyMgmt | as | Possible array elements: "wpa-psk", "wpa-ft-psk", "wpa-psk-sha256", "wpa-eap", "wpa-ft-eap", "wpa-eap-sha256", "ieee8021x", "wpa-none", "wps", "none" |
Protocol | as | Possible array elements: "rsn", "wpa" |
AuthAlg | as | Possible array elements: "open", "shared", "leap" |
Scan | as | Possible array elements: "active", "passive", "ssid" |
Modes | as | Possible array elements: "infrastructure", "ad-hoc", "ap" |
A state of the interface. Possible values are: return "disconnected", "inactive", "scanning", "authenticating", "associating", "associated", "4way_handshake", "group_handshake", "completed","unknown".
Determines if the interface is already scanning or not
Identical to ap_scan entry in %wpa_supplicant configuration file. Possible values are 0, 1 or 2.
Identical to bss_expiration_age entry in %wpa_supplicant configuration file.
Identical to bss_expiration_scan_count entry in %wpa_supplicant configuration file.
Identical to country entry in %wpa_supplicant configuration file.
Name of network interface controlled by the interface, e.g., wlan0.
Name of bridge network interface controlled by the interface, e.g., br0.
Name of driver used by the interface, e.g., nl80211.
Path to D-Bus object representing BSS which %wpa_supplicant is associated with, or "/" if is not associated at all.
Path to D-Bus object representing configured network which %wpa_supplicant uses at the moment, or "/" if doesn't use any.
List of blobs names added to the Interface.
List of D-Bus objects paths representing BSSs known to the interface, i.e., scan results.
List of D-Bus objects paths representing configured networks.
Identical to fast_reauth entry in %wpa_supplicant configuration file.
Time (in seconds) between scans for a suitable AP. Must be >= 0.
PKCS #11 engine path.
PKCS #11 module path.
Scanning finished.
Interface became aware of a new BSS.
BSS disappeared.
A new blob has been added to the interface.
A blob has been removed from the interface.
A new network has been added to the interface.
The network has been removed from the interface.
The network has been selected.
A new station has been authorized to the interface.
A station has been deauthorized to the interface.
Some properties have changed.
Starts WPS configuration.
Key | Value type | Description | Required |
---|---|---|---|
Role | s | The device's role. Possible values are "enrollee" and "registrar". | Yes |
Type | s | WPS authentication type. Applies only for enrollee role. Possible values are "pin" and "pbc". | Yes, for enrollee role; otherwise no |
Pin | s | WPS Pin. | Yes, for registrar role; otherwise optional |
Bssid | ay | No |
Key | Value type | Description | Required |
---|---|---|---|
Pin | s | Newly generated PIN, if not specified for enrollee role and pin authentication type. | No |
Determines if the interface will process the credentials (credentials_processed configuration file parameter).
WPS event occurred.
config_methods | Value type |
---|---|
manufacturer | q |
model_name | ay |
model_number | ay |
serial_number | ay |
dev_name | ay |
primary_dev_type | ay |
config_error | q |
dev_password_id | q |
WPS credentials. Dictionary contains:
Key | Value type | Description |
---|---|---|
BSSID | ay | |
SSID | s | |
AuthType | as | Possible array elements: "open", "shared", "wpa-psk", "wpa-eap", "wpa2-eap", "wpa2-psk" |
EncrType | as | Possible array elements: "none", "wep", "tkip", "aes" |
Key | ay | Key data |
KeyIndex | u | Key index |
Some properties have changed.
BSSID of the BSS.
SSID of the BSS.
WPA information of the BSS. Empty dictionary indicates no WPA support. Dictionary entries are:
KeyMgmt | as | Key management suite. Possible array elements: "wpa-psk", "wpa-eap", "wpa-none" |
Pairwise | as | Pairwise cipher suites. Possible array elements: "ccmp", "tkip" |
Group | s | Group cipher suite. Possible values are: "ccmp", "tkip", "wep104", "wep40" |
RSN information of the BSS. Empty dictionary indicates no RSN support. Dictionary entries are:
KeyMgmt | as | Key management suite. Possible array elements: "wpa-psk", "wpa-eap", "wpa-ft-psk", "wpa-ft-eap", "wpa-psk-sha256", "wpa-eap-sha256", |
Pairwise | as | Pairwise cipher suites. Possible array elements: "ccmp", "tkip" |
Group | s | Group cipher suite. Possible values are: "ccmp", "tkip", "wep104", "wep40" |
MgmtGroup | s | Mangement frames cipher suite. Possible values are: "aes128cmac" |
All IEs of the BSS as a chain of TLVs
Indicates if BSS supports privacy.
Describes mode of the BSS. Possible values are: "ad-hoc" and "infrastructure".
Frequency of the BSS in MHz.
Descending ordered array of rates supported by the BSS in bits per second.
Signal strength of the BSS.
Some properties have changed.
Determines if the configured network is enabled or not.
Properties of the configured network. Dictionary contains entries from "network" block of %wpa_supplicant configuration file. All values are string type, e.g., frequency is "2437", not 2437.
Some properties have changed.