dbus_new_handlers.h File Reference

WPA Supplicant / dbus-based control interface Copyright (c) 2009-2010, Witold Sowa witol.nosp@m.d.so.nosp@m.wa@gm.nosp@m.ail..nosp@m.com More...

Go to the source code of this file.

Data Structures
struct	network_handler_args
struct	bss_handler_args

Functions
dbus_bool_t	wpas_dbus_simple_property_getter (DBusMessageIter *iter, const int type, const void *val, DBusError *error)
	Get basic type property. More...
dbus_bool_t	wpas_dbus_simple_property_setter (DBusMessageIter *iter, DBusError *error, const int type, void *val)
	Set basic type property. More...
dbus_bool_t	wpas_dbus_simple_array_property_getter (DBusMessageIter *iter, const int type, const void *array, size_t array_len, DBusError *error)
	Get array type property. More...
dbus_bool_t	wpas_dbus_simple_array_array_property_getter (DBusMessageIter *iter, const int type, struct wpabuf **array, size_t array_len, DBusError *error)
	Get array array type property. More...
DBusMessage *	wpas_dbus_handler_create_interface (DBusMessage *message, struct wpa_global *global)
	Request registration of a network iface. More...
DBusMessage *	wpas_dbus_handler_remove_interface (DBusMessage *message, struct wpa_global *global)
	Request deregistration of an interface. More...
DBusMessage *	wpas_dbus_handler_get_interface (DBusMessage *message, struct wpa_global *global)
	Get the object path for an interface name. More...
dbus_bool_t	wpas_dbus_getter_debug_level (DBusMessageIter *iter, DBusError *error, void *user_data)
	Get debug level. More...
dbus_bool_t	wpas_dbus_getter_debug_timestamp (DBusMessageIter *iter, DBusError *error, void *user_data)
	Get debug timestamp. More...
dbus_bool_t	wpas_dbus_getter_debug_show_keys (DBusMessageIter *iter, DBusError *error, void *user_data)
	Get debug show keys. More...
dbus_bool_t	wpas_dbus_setter_debug_level (DBusMessageIter *iter, DBusError *error, void *user_data)
	Set debug level. More...
dbus_bool_t	wpas_dbus_setter_debug_timestamp (DBusMessageIter *iter, DBusError *error, void *user_data)
	Set debug timestamp. More...
dbus_bool_t	wpas_dbus_setter_debug_show_keys (DBusMessageIter *iter, DBusError *error, void *user_data)
	Set debug show keys. More...
dbus_bool_t	wpas_dbus_getter_interfaces (DBusMessageIter *iter, DBusError *error, void *user_data)
	Request registered interfaces list. More...
dbus_bool_t	wpas_dbus_getter_eap_methods (DBusMessageIter *iter, DBusError *error, void *user_data)
	Request supported EAP methods list. More...
dbus_bool_t	wpas_dbus_getter_global_capabilities (DBusMessageIter *iter, DBusError *error, void *user_data)
	Request supported global capabilities. More...
DBusMessage *	wpas_dbus_handler_scan (DBusMessage *message, struct wpa_supplicant *wpa_s)
	Request a wireless scan on an interface. More...
DBusMessage *	wpas_dbus_handler_signal_poll (DBusMessage *message, struct wpa_supplicant *wpa_s)
	Request immediate signal properties. More...
DBusMessage *	wpas_dbus_handler_disconnect (DBusMessage *message, struct wpa_supplicant *wpa_s)
dbus_bool_t	set_network_properties (struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid, DBusMessageIter *iter, DBusError *error)
	Set properties of a configured network. More...
DBusMessage *	wpas_dbus_handler_add_network (DBusMessage *message, struct wpa_supplicant *wpa_s)
	Add a new configured network. More...
DBusMessage *	wpas_dbus_handler_reassociate (DBusMessage *message, struct wpa_supplicant *wpa_s)
	Reassociate. More...
DBusMessage *	wpas_dbus_handler_reattach (DBusMessage *message, struct wpa_supplicant *wpa_s)
	Reattach to current AP. More...
DBusMessage *	wpas_dbus_handler_reconnect (DBusMessage *message, struct wpa_supplicant *wpa_s)
	Reconnect if disconnected. More...
DBusMessage *	wpas_dbus_handler_remove_network (DBusMessage *message, struct wpa_supplicant *wpa_s)
	Remove a configured network. More...
DBusMessage *	wpas_dbus_handler_remove_all_networks (DBusMessage *message, struct wpa_supplicant *wpa_s)
	Remove all configured networks. More...
DBusMessage *	wpas_dbus_handler_select_network (DBusMessage *message, struct wpa_supplicant *wpa_s)
	Attempt association with a network. More...
DBusMessage *	wpas_dbus_handler_network_reply (DBusMessage *message, struct wpa_supplicant *wpa_s)
	Reply to a NetworkRequest signal. More...
DBusMessage *	wpas_dbus_handler_add_blob (DBusMessage *message, struct wpa_supplicant *wpa_s)
	Store named binary blob (ie, for certificates) More...
DBusMessage *	wpas_dbus_handler_get_blob (DBusMessage *message, struct wpa_supplicant *wpa_s)
	Get named binary blob (ie, for certificates) More...
DBusMessage *	wpas_dbus_handler_remove_blob (DBusMessage *message, struct wpa_supplicant *wpa_s)
	Remove named binary blob. More...
DBusMessage *	wpas_dbus_handler_set_pkcs11_engine_and_module_path (DBusMessage *message, struct wpa_supplicant *wpa_s)
	Set PKCS #11 engine and module path. More...
DBusMessage *	wpas_dbus_handler_flush_bss (DBusMessage *message, struct wpa_supplicant *wpa_s)
DBusMessage *	wpas_dbus_handler_autoscan (DBusMessage *message, struct wpa_supplicant *wpa_s)
DBusMessage *	wpas_dbus_handler_eap_logoff (DBusMessage *message, struct wpa_supplicant *wpa_s)
DBusMessage *	wpas_dbus_handler_eap_logon (DBusMessage *message, struct wpa_supplicant *wpa_s)
dbus_bool_t	wpas_dbus_getter_capabilities (DBusMessageIter *iter, DBusError *error, void *user_data)
	Return interface capabilities. More...
dbus_bool_t	wpas_dbus_getter_state (DBusMessageIter *iter, DBusError *error, void *user_data)
	Get interface state. More...
dbus_bool_t	wpas_dbus_getter_scanning (DBusMessageIter *iter, DBusError *error, void *user_data)
	Get interface scanning state. More...
dbus_bool_t	wpas_dbus_getter_ap_scan (DBusMessageIter *iter, DBusError *error, void *user_data)
	Control roaming mode. More...
dbus_bool_t	wpas_dbus_setter_ap_scan (DBusMessageIter *iter, DBusError *error, void *user_data)
	Control roaming mode. More...
dbus_bool_t	wpas_dbus_getter_fast_reauth (DBusMessageIter *iter, DBusError *error, void *user_data)
	Control fast reauthentication (TLS session resumption) More...
dbus_bool_t	wpas_dbus_setter_fast_reauth (DBusMessageIter *iter, DBusError *error, void *user_data)
	Control fast reauthentication (TLS session resumption) More...
dbus_bool_t	wpas_dbus_getter_disconnect_reason (DBusMessageIter *iter, DBusError *error, void *user_data)
	Get most recent reason for disconnect. More...
dbus_bool_t	wpas_dbus_getter_bss_expire_age (DBusMessageIter *iter, DBusError *error, void *user_data)
	Get BSS entry expiration age. More...
dbus_bool_t	wpas_dbus_setter_bss_expire_age (DBusMessageIter *iter, DBusError *error, void *user_data)
	Control BSS entry expiration age. More...
dbus_bool_t	wpas_dbus_getter_bss_expire_count (DBusMessageIter *iter, DBusError *error, void *user_data)
	Get BSS entry expiration scan count. More...
dbus_bool_t	wpas_dbus_setter_bss_expire_count (DBusMessageIter *iter, DBusError *error, void *user_data)
	Control BSS entry expiration scan count. More...
dbus_bool_t	wpas_dbus_getter_country (DBusMessageIter *iter, DBusError *error, void *user_data)
	Control country code. More...
dbus_bool_t	wpas_dbus_setter_country (DBusMessageIter *iter, DBusError *error, void *user_data)
	Control country code. More...
dbus_bool_t	wpas_dbus_getter_scan_interval (DBusMessageIter *iter, DBusError *error, void *user_data)
	Get scan interval. More...
dbus_bool_t	wpas_dbus_setter_scan_interval (DBusMessageIter *iter, DBusError *error, void *user_data)
	Control scan interval. More...
dbus_bool_t	wpas_dbus_getter_ifname (DBusMessageIter *iter, DBusError *error, void *user_data)
	Get interface name. More...
dbus_bool_t	wpas_dbus_getter_driver (DBusMessageIter *iter, DBusError *error, void *user_data)
	Get interface name. More...
dbus_bool_t	wpas_dbus_getter_bridge_ifname (DBusMessageIter *iter, DBusError *error, void *user_data)
	Get interface name. More...
dbus_bool_t	wpas_dbus_getter_current_bss (DBusMessageIter *iter, DBusError *error, void *user_data)
	Get current bss object path. More...
dbus_bool_t	wpas_dbus_getter_current_network (DBusMessageIter *iter, DBusError *error, void *user_data)
	Get current network object path. More...
dbus_bool_t	wpas_dbus_getter_current_auth_mode (DBusMessageIter *iter, DBusError *error, void *user_data)
	Get current authentication type. More...
dbus_bool_t	wpas_dbus_getter_bsss (DBusMessageIter *iter, DBusError *error, void *user_data)
	Get array of BSSs objects. More...
dbus_bool_t	wpas_dbus_getter_networks (DBusMessageIter *iter, DBusError *error, void *user_data)
	Get array of networks objects. More...
dbus_bool_t	wpas_dbus_getter_pkcs11_engine_path (DBusMessageIter *iter, DBusError *error, void *user_data)
	Get PKCS #11 engine path. More...
dbus_bool_t	wpas_dbus_getter_pkcs11_module_path (DBusMessageIter *iter, DBusError *error, void *user_data)
	Get PKCS #11 module path. More...
dbus_bool_t	wpas_dbus_getter_blobs (DBusMessageIter *iter, DBusError *error, void *user_data)
	Get all blobs defined for this interface. More...
dbus_bool_t	wpas_dbus_getter_bss_bssid (DBusMessageIter *iter, DBusError *error, void *user_data)
	Return the BSSID of a BSS. More...
dbus_bool_t	wpas_dbus_getter_bss_ssid (DBusMessageIter *iter, DBusError *error, void *user_data)
	Return the SSID of a BSS. More...
dbus_bool_t	wpas_dbus_getter_bss_privacy (DBusMessageIter *iter, DBusError *error, void *user_data)
	Return the privacy flag of a BSS. More...
dbus_bool_t	wpas_dbus_getter_bss_mode (DBusMessageIter *iter, DBusError *error, void *user_data)
	Return the mode of a BSS. More...
dbus_bool_t	wpas_dbus_getter_bss_signal (DBusMessageIter *iter, DBusError *error, void *user_data)
	Return the signal strength of a BSS. More...
dbus_bool_t	wpas_dbus_getter_bss_frequency (DBusMessageIter *iter, DBusError *error, void *user_data)
	Return the frequency of a BSS. More...
dbus_bool_t	wpas_dbus_getter_bss_rates (DBusMessageIter *iter, DBusError *error, void *user_data)
	Return available bit rates of a BSS. More...
dbus_bool_t	wpas_dbus_getter_bss_wpa (DBusMessageIter *iter, DBusError *error, void *user_data)
	Return the WPA options of a BSS. More...
dbus_bool_t	wpas_dbus_getter_bss_rsn (DBusMessageIter *iter, DBusError *error, void *user_data)
	Return the RSN options of a BSS. More...
dbus_bool_t	wpas_dbus_getter_bss_wps (DBusMessageIter *iter, DBusError *error, void *user_data)
	Return the WPS options of a BSS. More...
dbus_bool_t	wpas_dbus_getter_bss_ies (DBusMessageIter *iter, DBusError *error, void *user_data)
	Return all IEs of a BSS. More...
dbus_bool_t	wpas_dbus_getter_bss_age (DBusMessageIter *iter, DBusError *error, void *user_data)
	Return time in seconds since BSS was last seen. More...
dbus_bool_t	wpas_dbus_getter_enabled (DBusMessageIter *iter, DBusError *error, void *user_data)
	Check whether network is enabled or disabled. More...
dbus_bool_t	wpas_dbus_setter_enabled (DBusMessageIter *iter, DBusError *error, void *user_data)
	Mark a configured network as enabled or disabled. More...
dbus_bool_t	wpas_dbus_getter_network_properties (DBusMessageIter *iter, DBusError *error, void *user_data)
	Get options for a configured network. More...
dbus_bool_t	wpas_dbus_setter_network_properties (DBusMessageIter *iter, DBusError *error, void *user_data)
	Set options for a configured network. More...
DBusMessage *	wpas_dbus_handler_wps_start (DBusMessage *message, struct wpa_supplicant *wpa_s)
	Start WPS configuration. More...
DBusMessage *	wpas_dbus_handler_wps_cancel (DBusMessage *message, struct wpa_supplicant *wpa_s)
	Cancel ongoing WPS configuration. More...
dbus_bool_t	wpas_dbus_getter_process_credentials (DBusMessageIter *iter, DBusError *error, void *user_data)
	Check if credentials are processed. More...
dbus_bool_t	wpas_dbus_setter_process_credentials (DBusMessageIter *iter, DBusError *error, void *user_data)
	Set credentials_processed conf param. More...
dbus_bool_t	wpas_dbus_getter_config_methods (DBusMessageIter *iter, DBusError *error, void *user_data)
	Get current WPS configuration methods. More...
dbus_bool_t	wpas_dbus_setter_config_methods (DBusMessageIter *iter, DBusError *error, void *user_data)
	Set WPS configuration methods. More...
DBusMessage *	wpas_dbus_handler_tdls_discover (DBusMessage *message, struct wpa_supplicant *wpa_s)
DBusMessage *	wpas_dbus_handler_tdls_setup (DBusMessage *message, struct wpa_supplicant *wpa_s)
DBusMessage *	wpas_dbus_handler_tdls_status (DBusMessage *message, struct wpa_supplicant *wpa_s)
DBusMessage *	wpas_dbus_handler_tdls_teardown (DBusMessage *message, struct wpa_supplicant *wpa_s)
DBusMessage *	wpas_dbus_error_invalid_args (DBusMessage *message, const char *arg)
	Return a new InvalidArgs error message. More...
DBusMessage *	wpas_dbus_error_unknown_error (DBusMessage *message, const char *arg)
	Return a new UnknownError error message. More...
DBusMessage *	wpas_dbus_error_no_memory (DBusMessage *message)
DBusMessage *	wpas_dbus_handler_subscribe_preq (DBusMessage *message, struct wpa_supplicant *wpa_s)
DBusMessage *	wpas_dbus_handler_unsubscribe_preq (DBusMessage *message, struct wpa_supplicant *wpa_s)

Detailed Description

WPA Supplicant / dbus-based control interface Copyright (c) 2009-2010, Witold Sowa witol.nosp@m.d.so.nosp@m.wa@gm.nosp@m.ail..nosp@m.com

Function Documentation

dbus_bool_t set_network_properties	(	struct wpa_supplicant *	wpa_s,
		struct wpa_ssid *	ssid,
		DBusMessageIter *	iter,
		DBusError *	error
	)

Set properties of a configured network.

Parameters

wpa_s	wpa_supplicant structure for a network interface
ssid	wpa_ssid structure for a configured network
iter	DBus message iterator containing dictionary of network properties to set.
error	On failure, an error describing the failure

Returns

TRUE if the request succeeds, FALSE if it failed

Sets network configuration with parameters given id DBus dictionary

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

Return a new InvalidArgs 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_error_unknown_error	(	DBusMessage *	message,
		const char *	arg
	)

Return a new UnknownError error message.

Parameters

message	Pointer to incoming dbus message this error refers to
arg	Optional string appended to error message

Returns

a dbus error message

Convenience function to create and return an UnknownError

dbus_bool_t wpas_dbus_getter_ap_scan	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Control roaming mode.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter function for "ApScan" property.

dbus_bool_t wpas_dbus_getter_blobs	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Get all blobs defined for this interface.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "Blobs" property.

dbus_bool_t wpas_dbus_getter_bridge_ifname	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Get interface name.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "BridgeIfname" property.

dbus_bool_t wpas_dbus_getter_bss_age	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Return time in seconds since BSS was last seen.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for BSS age

dbus_bool_t wpas_dbus_getter_bss_bssid	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Return the BSSID of a BSS.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "BSSID" property.

dbus_bool_t wpas_dbus_getter_bss_expire_age	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Get BSS entry expiration age.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter function for "BSSExpireAge" property.

dbus_bool_t wpas_dbus_getter_bss_expire_count	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Get BSS entry expiration scan count.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter function for "BSSExpireCount" property.

dbus_bool_t wpas_dbus_getter_bss_frequency	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Return the frequency of a BSS.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "Frequency" property.

dbus_bool_t wpas_dbus_getter_bss_ies	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Return all IEs of a BSS.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "IEs" property.

dbus_bool_t wpas_dbus_getter_bss_mode	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Return the mode of a BSS.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "Mode" property.

dbus_bool_t wpas_dbus_getter_bss_privacy	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Return the privacy flag of a BSS.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "Privacy" property.

dbus_bool_t wpas_dbus_getter_bss_rates	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Return available bit rates of a BSS.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "Rates" property.

dbus_bool_t wpas_dbus_getter_bss_rsn	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Return the RSN options of a BSS.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "RSN" property.

dbus_bool_t wpas_dbus_getter_bss_signal	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Return the signal strength of a BSS.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "Level" property.

dbus_bool_t wpas_dbus_getter_bss_ssid	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Return the SSID of a BSS.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "SSID" property.

dbus_bool_t wpas_dbus_getter_bss_wpa	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Return the WPA options of a BSS.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "WPA" property.

dbus_bool_t wpas_dbus_getter_bss_wps	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Return the WPS options of a BSS.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "WPS" property.

dbus_bool_t wpas_dbus_getter_bsss	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Get array of BSSs objects.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "BSSs" property.

dbus_bool_t wpas_dbus_getter_capabilities	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Return interface capabilities.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "Capabilities" property of an interface.

dbus_bool_t wpas_dbus_getter_config_methods	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Get current WPS configuration methods.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "ConfigMethods" property. Returned boolean will be true if providing the relevant string worked, or false otherwise.

dbus_bool_t wpas_dbus_getter_country	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Control country code.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter function for "Country" property.

dbus_bool_t wpas_dbus_getter_current_auth_mode	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Get current authentication type.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "CurrentAuthMode" property.

dbus_bool_t wpas_dbus_getter_current_bss	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Get current bss object path.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "CurrentBSS" property.

dbus_bool_t wpas_dbus_getter_current_network	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Get current network object path.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "CurrentNetwork" property.

dbus_bool_t wpas_dbus_getter_debug_level	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Get debug level.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "DebugLevel" property.

dbus_bool_t wpas_dbus_getter_debug_show_keys	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Get debug show keys.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "DebugShowKeys" property.

dbus_bool_t wpas_dbus_getter_debug_timestamp	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Get debug timestamp.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "DebugTimestamp" property.

dbus_bool_t wpas_dbus_getter_disconnect_reason	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Get most recent reason for disconnect.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "DisconnectReason" property. The reason is negative if it is locally generated.

dbus_bool_t wpas_dbus_getter_driver	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Get interface name.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "Driver" property.

dbus_bool_t wpas_dbus_getter_eap_methods	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Request supported EAP methods list.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "EapMethods" property. Handles requests by dbus clients to return list of strings with supported EAP methods

dbus_bool_t wpas_dbus_getter_enabled	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Check whether network is enabled or disabled.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "enabled" property of a configured network.

dbus_bool_t wpas_dbus_getter_fast_reauth	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Control fast reauthentication (TLS session resumption)

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter function for "FastReauth" property.

dbus_bool_t wpas_dbus_getter_global_capabilities	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Request supported global capabilities.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "Capabilities" property. Handles requests by dbus clients to return a list of strings with supported capabilities like AP, RSN IBSS, and P2P that are determined at compile time.

dbus_bool_t wpas_dbus_getter_ifname	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Get interface name.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "Ifname" property.

dbus_bool_t wpas_dbus_getter_interfaces	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Request registered interfaces list.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "Interfaces" property. Handles requests by dbus clients to return list of registered interfaces objects paths

dbus_bool_t wpas_dbus_getter_network_properties	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Get options for a configured network.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "Properties" property of a configured network.

dbus_bool_t wpas_dbus_getter_networks	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Get array of networks objects.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "Networks" property.

dbus_bool_t wpas_dbus_getter_pkcs11_engine_path	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Get PKCS #11 engine path.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

A dbus message containing the PKCS #11 engine path

Getter for "PKCS11EnginePath" property.

dbus_bool_t wpas_dbus_getter_pkcs11_module_path	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Get PKCS #11 module path.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

A dbus message containing the PKCS #11 module path

Getter for "PKCS11ModulePath" property.

dbus_bool_t wpas_dbus_getter_process_credentials	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Check if credentials are processed.

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant data structure

Returns

TRUE on success, FALSE on failure

Getter for "ProcessCredentials" property. Returns returned boolean will be true if wps_cred_processing configuration field is not equal to 1 or false if otherwise.

dbus_bool_t wpas_dbus_getter_scan_interval	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Get scan interval.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter function for "ScanInterval" property.

dbus_bool_t wpas_dbus_getter_scanning	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Get interface scanning state.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "scanning" property.

dbus_bool_t wpas_dbus_getter_state	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Get interface state.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Getter for "State" property.

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

Store named binary blob (ie, for certificates)

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant data structure

Returns

A dbus message containing an error on failure or NULL on success

Asks wpa_supplicant to internally store a binary blobs.

DBusMessage* wpas_dbus_handler_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_handler_create_interface	(	DBusMessage *	message,
		struct wpa_global *	global
	)

Request registration of a network iface.

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 "CreateInterface" method call. Handles requests by dbus clients to register a network interface that wpa_supplicant will manage.

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

Get named binary blob (ie, for certificates)

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant data structure

Returns

A dbus message containing array of bytes (blob)

Gets one wpa_supplicant's binary blobs.

DBusMessage* wpas_dbus_handler_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.

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

Reply to a NetworkRequest signal.

Parameters

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

Returns

NULL on success or dbus error on failure

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

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

Reassociate.

Parameters

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

Returns

InterfaceDisabled DBus error message if disabled or NULL otherwise.

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

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

Reattach to current AP.

Parameters

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

Returns

NotConnected DBus error message if not connected or NULL otherwise.

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

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

Reconnect if disconnected.

Parameters

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

Returns

InterfaceDisabled DBus error message if disabled or NULL otherwise.

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

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

Remove all configured networks.

Parameters

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

Returns

NULL on success or dbus error on failure

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

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

Remove named binary blob.

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant data structure

Returns

NULL on success or dbus error

Asks wpa_supplicant to internally remove a binary blobs.

DBusMessage* wpas_dbus_handler_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_handler_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

NULL on success or dbus error on failure

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

DBusMessage* wpas_dbus_handler_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

NULL indicating success or DBus error message on failure

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_handler_select_network	(	DBusMessage *	message,
		struct wpa_supplicant *	wpa_s
	)

Attempt association with a network.

Parameters

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

Returns

NULL on success or dbus error on failure

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

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

Set PKCS #11 engine and module path.

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant data structure

Returns

A dbus message containing an error on failure or NULL on success

Sets the PKCS #11 engine and module path.

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

Request immediate signal properties.

Parameters

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

Returns

NULL indicating success or DBus error message on failure

Handler function for "SignalPoll" method call of a network device. Requests that wpa_supplicant read signal properties like RSSI, noise, and link speed and return them.

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

Cancel ongoing WPS configuration.

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant data structure

Returns

NULL on success or DBus error on failure

Handler for "Cancel" method call. Returns NULL if WPS cancel successfull or DBus error on WPS cancel failure

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

Start WPS configuration.

Parameters

message	Pointer to incoming dbus message
wpa_s	wpa_supplicant data structure

Returns

DBus message dictionary on success or DBus error on failure

Handler for "Start" method call. DBus dictionary argument contains information about role (enrollee or registrar), authorization method (pin or push button) and optionally pin and bssid. Returned message has a dictionary argument which may contain newly generated pin (optional).

dbus_bool_t wpas_dbus_setter_ap_scan	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Control roaming mode.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Setter function for "ApScan" property.

dbus_bool_t wpas_dbus_setter_bss_expire_age	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Control BSS entry expiration age.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Setter function for "BSSExpireAge" property.

dbus_bool_t wpas_dbus_setter_bss_expire_count	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Control BSS entry expiration scan count.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Setter function for "BSSExpireCount" property.

dbus_bool_t wpas_dbus_setter_config_methods	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Set WPS configuration methods.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Setter for "ConfigMethods" property. Sets the methods string, apply such change and returns true on success. Returns false otherwise.

dbus_bool_t wpas_dbus_setter_country	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Control country code.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Setter function for "Country" property.

dbus_bool_t wpas_dbus_setter_debug_level	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Set debug level.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Setter for "DebugLevel" property.

dbus_bool_t wpas_dbus_setter_debug_show_keys	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Set debug show keys.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Setter for "DebugShowKeys" property.

dbus_bool_t wpas_dbus_setter_debug_timestamp	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Set debug timestamp.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Setter for "DebugTimestamp" property.

dbus_bool_t wpas_dbus_setter_enabled	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Mark a configured network as enabled or disabled.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Setter for "Enabled" property of a configured network.

dbus_bool_t wpas_dbus_setter_fast_reauth	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Control fast reauthentication (TLS session resumption)

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Setter function for "FastReauth" property.

dbus_bool_t wpas_dbus_setter_network_properties	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Set options for a configured network.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Setter for "Properties" property of a configured network.

dbus_bool_t wpas_dbus_setter_process_credentials	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Set credentials_processed conf param.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Setter for "ProcessCredentials" property. Sets credentials_processed on 2 if boolean argument is true or on 1 if otherwise.

dbus_bool_t wpas_dbus_setter_scan_interval	(	DBusMessageIter *	iter,
		DBusError *	error,
		void *	user_data
	)

Control scan interval.

Parameters

iter	Pointer to incoming dbus message iter
error	Location to store error on failure
user_data	Function specific data

Returns

TRUE on success, FALSE on failure

Setter function for "ScanInterval" property.

dbus_bool_t wpas_dbus_simple_array_array_property_getter	(	DBusMessageIter *	iter,
		const int	type,
		struct wpabuf **	array,
		size_t	array_len,
		DBusError *	error
	)

Get array array type property.

Parameters

iter	Pointer to incoming dbus message iterator
type	DBus type of property array elements (must be basic type)
array	pointer to array of elements to put into response message
array_len	length of above array
error	a pointer to an error to fill on failure

Returns

TRUE if the request succeeded, FALSE if it failed

Generic getter for array type properties. Array elements type is required to be basic.

dbus_bool_t wpas_dbus_simple_array_property_getter	(	DBusMessageIter *	iter,
		const int	type,
		const void *	array,
		size_t	array_len,
		DBusError *	error
	)

Get array type property.

Parameters

iter	Pointer to incoming dbus message iterator
type	DBus type of property array elements (must be basic type)
array	pointer to array of elements to put into response message
array_len	length of above array
error	a pointer to an error to fill on failure

Returns

TRUE if the request succeeded, FALSE if it failed

Generic getter for array type properties. Array elements type is required to be basic.

dbus_bool_t wpas_dbus_simple_property_getter	(	DBusMessageIter *	iter,
		const int	type,
		const void *	val,
		DBusError *	error
	)

Get basic type property.

Parameters

iter	Message iter to use when appending arguments
type	DBus type of property (must be basic type)
val	pointer to place holding property value
error	On failure an error describing the failure

Returns

TRUE if the request was successful, FALSE if it failed

Generic getter for basic type properties. Type is required to be basic.

dbus_bool_t wpas_dbus_simple_property_setter	(	DBusMessageIter *	iter,
		DBusError *	error,
		const int	type,
		void *	val
	)

Set basic type property.

Parameters

message	Pointer to incoming dbus message
type	DBus type of property (must be basic type)
val	pointer to place where value being set will be stored

Returns

TRUE if the request was successful, FALSE if it failed

Generic setter for basic type properties. Type is required to be basic.