WPA Supplicant / dbus-based control interface. More...

Functions
DBusMessage *	wpas_dbus_new_invalid_iface_error (DBusMessage *message)
	Return a new invalid interface error message. More...

DBusMessage *	wpas_dbus_new_invalid_network_error (DBusMessage *message)
	Return a new invalid network error message. More...

DBusMessage *	wpas_dbus_global_add_interface (DBusMessage message, struct wpa_global global)
	Request registration of a network interface. More...

DBusMessage *	wpas_dbus_global_remove_interface (DBusMessage message, struct wpa_global global)
	Request deregistration of an interface. More...

DBusMessage *	wpas_dbus_global_get_interface (DBusMessage message, struct wpa_global global)
	Get the object path for an interface name. More...

DBusMessage *	wpas_dbus_global_set_debugparams (DBusMessage message, struct wpa_global global)
	wpas_dbus_global_set_debugparams- Set the debug params More...

DBusMessage *	wpas_dbus_iface_scan (DBusMessage message, struct wpa_supplicant wpa_s)
	Request a wireless scan on an interface. More...

DBusMessage *	wpas_dbus_iface_scan_results (DBusMessage message, struct wpa_supplicant wpa_s)
	Get the results of a recent scan request. More...

DBusMessage *	wpas_dbus_bssid_properties (DBusMessage message, struct wpa_supplicant wpa_s, struct wpa_bss *bss)
	Return the properties of a scanned network. More...

DBusMessage *	wpas_dbus_iface_capabilities (DBusMessage message, struct wpa_supplicant wpa_s)
	Return interface capabilities. More...

DBusMessage *	wpas_dbus_iface_add_network (DBusMessage message, struct wpa_supplicant wpa_s)
	Add a new configured network. More...

DBusMessage *	wpas_dbus_iface_remove_network (DBusMessage message, struct wpa_supplicant wpa_s)
	Remove a configured network. More...

DBusMessage *	wpas_dbus_iface_set_network (DBusMessage message, struct wpa_supplicant wpa_s, struct wpa_ssid *ssid)
	Set options for a configured network. More...

DBusMessage *	wpas_dbus_iface_enable_network (DBusMessage message, struct wpa_supplicant wpa_s, struct wpa_ssid *ssid)
	Mark a configured network as enabled. More...

DBusMessage *	wpas_dbus_iface_disable_network (DBusMessage message, struct wpa_supplicant wpa_s, struct wpa_ssid *ssid)
	Mark a configured network as disabled. More...

DBusMessage *	wpas_dbus_iface_select_network (DBusMessage message, struct wpa_supplicant wpa_s)
	Attempt association with a configured network. More...

DBusMessage *	wpas_dbus_iface_disconnect (DBusMessage message, struct wpa_supplicant wpa_s)
	Terminate the current connection. More...

DBusMessage *	wpas_dbus_iface_set_ap_scan (DBusMessage message, struct wpa_supplicant wpa_s)
	Control roaming mode. More...

DBusMessage *	wpas_dbus_iface_set_smartcard_modules (DBusMessage message, struct wpa_supplicant wpa_s)
	Set smartcard related module paths. More...

DBusMessage *	wpas_dbus_iface_get_state (DBusMessage message, struct wpa_supplicant wpa_s)
	Get interface state. More...

DBusMessage *	wpas_dbus_iface_get_scanning (DBusMessage message, struct wpa_supplicant wpa_s)
	Get interface scanning state. More...

DBusMessage *	wpas_dbus_iface_set_blobs (DBusMessage message, struct wpa_supplicant wpa_s)
	Store named binary blobs (ie, for certificates) More...

DBusMessage *	wpas_dbus_iface_remove_blobs (DBusMessage message, struct wpa_supplicant wpa_s)
	Remove named binary blobs. More...

DBusMessage *	wpas_dbus_iface_wps_pbc (DBusMessage message, struct wpa_supplicant wpa_s)
	Request credentials using WPS PBC method. More...

DBusMessage *	wpas_dbus_iface_wps_pin (DBusMessage message, struct wpa_supplicant wpa_s)
	Establish the PIN number of the enrollee. More...

DBusMessage *	wpas_dbus_iface_wps_reg (DBusMessage message, struct wpa_supplicant wpa_s)
	Request credentials using the PIN of the AP. More...

DBusMessage *	wpas_dbus_iface_flush (DBusMessage message, struct wpa_supplicant wpa_s)
	Clear BSS of old or all inactive entries. More...

DBusMessage *	wpas_dbus_new_success_reply (DBusMessage *message)
	Return a new success reply message. More...

DBusMessage *	wpas_dbus_new_invalid_opts_error (DBusMessage message, const char arg)
	Return a new invalid options error message. More...

Detailed Description

WPA Supplicant / dbus-based control interface.

Function Documentation

DBusMessage* wpas_dbus_bssid_properties	(	DBusMessage *	message,
		struct wpa_supplicant *	wpa_s,
		struct wpa_bss *	bss
	)

Return the properties of a scanned network.

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant structure for a network interface
res	wpa_supplicant scan result for which to get properties

Returns: a dbus message containing the properties for the requested network

Handler function for "properties" method call of a scanned network. Returns a dbus message containing the the properties.

DBusMessage* wpas_dbus_global_add_interface	(	DBusMessage *	message,
		struct wpa_global *	global
	)

Request registration of a network interface.

Parameters

message	Pointer to incoming dbus message
global	wpa_supplicant global data structure

Returns: The object path of the new interface object, or a dbus error message with more information

Handler function for "addInterface" method call. Handles requests by dbus clients to register a network interface that wpa_supplicant will manage.

DBusMessage* wpas_dbus_global_get_interface	(	DBusMessage *	message,
		struct wpa_global *	global
	)

Get the object path for an interface name.

Parameters

message	Pointer to incoming dbus message
global	wpa_supplicant global data structure

Returns: The object path of the interface object, or a dbus error message with more information

Handler function for "getInterface" method call. Handles requests by dbus clients for the object path of an specific network interface.

DBusMessage* wpas_dbus_global_remove_interface	(	DBusMessage *	message,
		struct wpa_global *	global
	)

Request deregistration of an interface.

Parameters

message	Pointer to incoming dbus message
global	wpa_supplicant global data structure

Returns: a dbus message containing a UINT32 indicating success (1) or failure (0), or returns a dbus error message with more information

Handler function for "removeInterface" method call. Handles requests by dbus clients to deregister a network interface that wpa_supplicant currently manages.

DBusMessage* wpas_dbus_global_set_debugparams	(	DBusMessage *	message,
		struct wpa_global *	global
	)

wpas_dbus_global_set_debugparams- Set the debug params

Parameters

message	Pointer to incoming dbus message
global	wpa_supplicant global data structure

Returns: a dbus message containing a UINT32 indicating success (1) or failure (0), or returns a dbus error message with more information

Handler function for "setDebugParams" method call. Handles requests by dbus clients for the object path of an specific network interface.

DBusMessage* wpas_dbus_iface_add_network	(	DBusMessage *	message,
		struct wpa_supplicant *	wpa_s
	)

Add a new configured network.

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant structure for a network interface

Returns: A dbus message containing the object path of the new network

Handler function for "addNetwork" method call of a network interface.

DBusMessage* wpas_dbus_iface_capabilities	(	DBusMessage *	message,
		struct wpa_supplicant *	wpa_s
	)

Return interface capabilities.

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant structure for a network interface

Returns: A dbus message containing a dict of strings

Handler function for "capabilities" method call of an interface.

DBusMessage* wpas_dbus_iface_disable_network	(	DBusMessage *	message,
		struct wpa_supplicant *	wpa_s,
		struct wpa_ssid *	ssid
	)

Mark a configured network as disabled.

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant structure for a network interface
ssid	wpa_ssid structure for a configured network

Returns: A dbus message containing a UINT32 indicating success (1) or failure (0)

Handler function for "disable" method call of a configured network.

DBusMessage* wpas_dbus_iface_disconnect	(	DBusMessage *	message,
		struct wpa_supplicant *	wpa_s
	)

Terminate the current connection.

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant structure for a network interface

Returns: A dbus message containing a UINT32 indicating success (1) or failure (0)

Handler function for "disconnect" method call of network interface.

DBusMessage* wpas_dbus_iface_enable_network	(	DBusMessage *	message,
		struct wpa_supplicant *	wpa_s,
		struct wpa_ssid *	ssid
	)

Mark a configured network as enabled.

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant structure for a network interface
ssid	wpa_ssid structure for a configured network

Returns: A dbus message containing a UINT32 indicating success (1) or failure (0)

Handler function for "enable" method call of a configured network.

DBusMessage* wpas_dbus_iface_flush	(	DBusMessage *	message,
		struct wpa_supplicant *	wpa_s
	)

Clear BSS of old or all inactive entries.

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant data structure

Returns: a dbus message containing a UINT32 indicating success (1) or failure (0), or returns a dbus error message with more information

Handler function for "flush" method call. Handles requests for an interface with an optional "age" parameter that specifies the minimum age of a BSS to be flushed.

DBusMessage* wpas_dbus_iface_get_scanning	(	DBusMessage *	message,
		struct wpa_supplicant *	wpa_s
	)

Get interface scanning state.

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant structure for a network interface

Returns: A dbus message containing whether the interface is scanning

Handler function for "scanning" method call.

DBusMessage* wpas_dbus_iface_get_state	(	DBusMessage *	message,
		struct wpa_supplicant *	wpa_s
	)

Get interface state.

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant structure for a network interface

Returns: A dbus message containing a STRING representing the current interface state

Handler function for "state" method call.

DBusMessage* wpas_dbus_iface_remove_blobs	(	DBusMessage *	message,
		struct wpa_supplicant *	wpa_s
	)

Remove named binary blobs.

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant data structure

Returns: A dbus message containing a UINT32 indicating success (1) or failure (0)

Asks wpa_supplicant to remove one or more previously stored binary blobs.

DBusMessage* wpas_dbus_iface_remove_network	(	DBusMessage *	message,
		struct wpa_supplicant *	wpa_s
	)

Remove a configured network.

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant structure for a network interface

Returns: A dbus message containing a UINT32 indicating success (1) or failure (0)

Handler function for "removeNetwork" method call of a network interface.

DBusMessage* wpas_dbus_iface_scan	(	DBusMessage *	message,
		struct wpa_supplicant *	wpa_s
	)

Request a wireless scan on an interface.

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant structure for a network interface

Returns: a dbus message containing a UINT32 indicating success (1) or failure (0)

Handler function for "scan" method call of a network device. Requests that wpa_supplicant perform a wireless scan as soon as possible on a particular wireless interface.

DBusMessage* wpas_dbus_iface_scan_results	(	DBusMessage *	message,
		struct wpa_supplicant *	wpa_s
	)

Get the results of a recent scan request.

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant structure for a network interface

Returns: a dbus message containing a dbus array of objects paths, or returns a dbus error message if not scan results could be found

Handler function for "scanResults" method call of a network device. Returns a dbus message containing the object paths of wireless networks found.

DBusMessage* wpas_dbus_iface_select_network	(	DBusMessage *	message,
		struct wpa_supplicant *	wpa_s
	)

Attempt association with a configured network.

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant structure for a network interface

Returns: A dbus message containing a UINT32 indicating success (1) or failure (0)

Handler function for "selectNetwork" method call of network interface.

DBusMessage* wpas_dbus_iface_set_ap_scan	(	DBusMessage *	message,
		struct wpa_supplicant *	wpa_s
	)

Control roaming mode.

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant structure for a network interface

Returns: A dbus message containing a UINT32 indicating success (1) or failure (0)

Handler function for "setAPScan" method call.

DBusMessage* wpas_dbus_iface_set_blobs	(	DBusMessage *	message,
		struct wpa_supplicant *	wpa_s
	)

Store named binary blobs (ie, for certificates)

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant data structure

Returns: A dbus message containing a UINT32 indicating success (1) or failure (0)

Asks wpa_supplicant to internally store a one or more binary blobs.

DBusMessage* wpas_dbus_iface_set_network	(	DBusMessage *	message,
		struct wpa_supplicant *	wpa_s,
		struct wpa_ssid *	ssid
	)

Set options for a configured network.

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant structure for a network interface
ssid	wpa_ssid structure for a configured network

Returns: a dbus message containing a UINT32 indicating success (1) or failure (0)

Handler function for "set" method call of a configured network.

DBusMessage* wpas_dbus_iface_set_smartcard_modules	(	DBusMessage *	message,
		struct wpa_supplicant *	wpa_s
	)

Set smartcard related module paths.

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant structure for a network interface

Returns: A dbus message containing a UINT32 indicating success (1) or failure (0)

Handler function for "setSmartcardModules" method call.

DBusMessage* wpas_dbus_iface_wps_pbc	(	DBusMessage *	message,
		struct wpa_supplicant *	wpa_s
	)

Request credentials using WPS PBC method.

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant data structure

Returns: A dbus message containing a UINT32 indicating success (1) or failure (0)

Handler function for "wpsPbc" method call

DBusMessage* wpas_dbus_iface_wps_pin	(	DBusMessage *	message,
		struct wpa_supplicant *	wpa_s
	)

Establish the PIN number of the enrollee.

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant data structure

Returns: A dbus message containing a UINT32 indicating success (1) or failure (0)

Handler function for "wpsPin" method call

DBusMessage* wpas_dbus_iface_wps_reg	(	DBusMessage *	message,
		struct wpa_supplicant *	wpa_s
	)

Request credentials using the PIN of the AP.

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant data structure

Returns: A dbus message containing a UINT32 indicating success (1) or failure (0)

Handler function for "wpsReg" method call

DBusMessage* wpas_dbus_new_invalid_iface_error ( DBusMessage * message )

Return a new invalid interface error message.

Parameters

message Pointer to incoming dbus message this error refers to

Returns: A dbus error message

Convenience function to create and return an invalid interface error

DBusMessage* wpas_dbus_new_invalid_network_error ( DBusMessage * message )

Return a new invalid network error message.

Parameters

message Pointer to incoming dbus message this error refers to

Returns: a dbus error message

Convenience function to create and return an invalid network error

DBusMessage* wpas_dbus_new_invalid_opts_error	(	DBusMessage *	message,
		const char *	arg
	)

Return a new invalid options error message.

Parameters

message Pointer to incoming dbus message this error refers to

Returns: a dbus error message

Convenience function to create and return an invalid options error

DBusMessage* wpas_dbus_new_success_reply ( DBusMessage * message )

Return a new success reply message.

Parameters

message Pointer to incoming dbus message this reply refers to

Returns: a dbus message containing a single UINT32 that indicates success (ie, a value of 1)

Convenience function to create and return a success reply message

Functions

Detailed Description

Function Documentation