NMSecretAgentOld

NMSecretAgentOld

Functions

Properties

gboolean auto-register Read / Write / Construct
NMSecretAgentCapabilities capabilities Read / Write / Construct
gchar * identifier Read / Write / Construct Only
gboolean registered Read

Types and Values

Object Hierarchy

    GObject
    ╰── NMSecretAgentOld

Implemented Interfaces

NMSecretAgentOld implements GInitable and GAsyncInitable.

Description

Functions

NMSecretAgentOldGetSecretsFunc ()

void
(*NMSecretAgentOldGetSecretsFunc) (NMSecretAgentOld *agent,
                                   NMConnection *connection,
                                   GVariant *secrets,
                                   GError *error,
                                   gpointer user_data);

Called as a result of a request by NM to retrieve secrets. When the NMSecretAgentOld subclass has finished retrieving secrets and is ready to return them, or to return an error, this function should be called with those secrets or the error.

To easily create the dictionary to return the Wi-Fi PSK, you could do something like this:

Example 1. Creating a secrets dictionary

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
NMConnection *secrets;
NMSettingWirelessSecurity *s_wsec;
GVariant *secrets_dict;

secrets = nm_simple_connection_new ();
s_wsec = (NMSettingWirelessSecurity *) nm_setting_wireless_security_new ();
g_object_set (G_OBJECT (s_wsec),
              NM_SETTING_WIRELESS_SECURITY_PSK, "my really cool PSK",
              NULL);
nm_connection_add_setting (secrets, NM_SETTING (s_wsec));
secrets_dict = nm_connection_to_dbus (secrets, NM_CONNECTION_SERIALIZE_ALL);

(call the NMSecretAgentOldGetSecretsFunc with secrets_dict)

g_object_unref (secrets);
g_variant_unref (secrets_dict);

Parameters

agent

the secret agent object

 

connection

the connection for which secrets were requested, note that this object will be unrefed after the callback has returned, use g_object_ref()/g_object_unref() if you want to use this object after the callback has returned.

[transfer none]

secrets

the GVariant of type NM_VARIANT_TYPE_CONNECTION containing the requested secrets (as created by nm_connection_to_dbus() for example). Each key in secrets should be the name of a NMSetting object (like "802-11-wireless-security") and each value should be an NM_VARIANT_TYPE_SETTING variant. The sub-dicts map string:value, where the string is the setting property name (like "psk") and the value is the secret

 

error

if the secrets request failed, give a descriptive error here

 

user_data

caller-specific data to be passed to the function

 

NMSecretAgentOldSaveSecretsFunc ()

void
(*NMSecretAgentOldSaveSecretsFunc) (NMSecretAgentOld *agent,
                                    NMConnection *connection,
                                    GError *error,
                                    gpointer user_data);

Called as a result of a request by NM to save secrets. When the NMSecretAgentOld subclass has finished saving the secrets, this function should be called.

Parameters

agent

the secret agent object

 

connection

the connection for which secrets were to be saved, note that this object will be unrefed after the callback has returned, use g_object_ref()/g_object_unref() if you want to use this object after the callback has returned.

[transfer none]

error

if the saving secrets failed, give a descriptive error here

 

user_data

caller-specific data to be passed to the function

 

NMSecretAgentOldDeleteSecretsFunc ()

void
(*NMSecretAgentOldDeleteSecretsFunc) (NMSecretAgentOld *agent,
                                      NMConnection *connection,
                                      GError *error,
                                      gpointer user_data);

Called as a result of a request by NM to delete secrets. When the NMSecretAgentOld subclass has finished deleting the secrets, this function should be called.

Parameters

agent

the secret agent object

 

connection

the connection for which secrets were to be deleted, note that this object will be unrefed after the callback has returned, use g_object_ref()/g_object_unref() if you want to use this object after the callback has returned.

[transfer none]

error

if the deleting secrets failed, give a descriptive error here

 

user_data

caller-specific data to be passed to the function

 

nm_secret_agent_old_register ()

gboolean
nm_secret_agent_old_register (NMSecretAgentOld *self,
                              GCancellable *cancellable,
                              GError **error);

Registers the NMSecretAgentOld with the NetworkManager secret manager, indicating to NetworkManager that the agent is able to provide and save secrets for connections on behalf of its user.

It is a programmer error to attempt to register an agent that is already registered, or in the process of registering.

Parameters

self

a NMSecretAgentOld

 

cancellable

a GCancellable, or NULL

 

error

return location for a GError, or NULL

 

Returns

TRUE if registration was successful, FALSE on error.


nm_secret_agent_old_register_async ()

void
nm_secret_agent_old_register_async (NMSecretAgentOld *self,
                                    GCancellable *cancellable,
                                    GAsyncReadyCallback callback,
                                    gpointer user_data);

Asynchronously registers the NMSecretAgentOld with the NetworkManager secret manager, indicating to NetworkManager that the agent is able to provide and save secrets for connections on behalf of its user.

It is a programmer error to attempt to register an agent that is already registered, or in the process of registering.

Parameters

self

a NMSecretAgentOld

 

cancellable

a GCancellable, or NULL

 

callback

callback to call when the agent is registered

 

user_data

data for callback

 

nm_secret_agent_old_register_finish ()

gboolean
nm_secret_agent_old_register_finish (NMSecretAgentOld *self,
                                     GAsyncResult *result,
                                     GError **error);

Gets the result of a call to nm_secret_agent_old_register_async().

Parameters

self

a NMSecretAgentOld

 

result

the result passed to the GAsyncReadyCallback

 

error

return location for a GError, or NULL

 

Returns

TRUE if registration was successful, FALSE on error.


nm_secret_agent_old_unregister ()

gboolean
nm_secret_agent_old_unregister (NMSecretAgentOld *self,
                                GCancellable *cancellable,
                                GError **error);

Unregisters the NMSecretAgentOld with the NetworkManager secret manager, indicating to NetworkManager that the agent will no longer provide or store secrets on behalf of this user.

Parameters

self

a NMSecretAgentOld

 

cancellable

a GCancellable, or NULL

 

error

return location for a GError, or NULL

 

Returns

TRUE if unregistration was successful, FALSE on error


nm_secret_agent_old_unregister_async ()

void
nm_secret_agent_old_unregister_async (NMSecretAgentOld *self,
                                      GCancellable *cancellable,
                                      GAsyncReadyCallback callback,
                                      gpointer user_data);

Asynchronously unregisters the NMSecretAgentOld with the NetworkManager secret manager, indicating to NetworkManager that the agent will no longer provide or store secrets on behalf of this user.

Parameters

self

a NMSecretAgentOld

 

cancellable

a GCancellable, or NULL

 

callback

callback to call when the agent is unregistered

 

user_data

data for callback

 

nm_secret_agent_old_unregister_finish ()

gboolean
nm_secret_agent_old_unregister_finish (NMSecretAgentOld *self,
                                       GAsyncResult *result,
                                       GError **error);

Gets the result of a call to nm_secret_agent_old_unregister_async().

Parameters

self

a NMSecretAgentOld

 

result

the result passed to the GAsyncReadyCallback

 

error

return location for a GError, or NULL

 

Returns

TRUE if unregistration was successful, FALSE on error.


nm_secret_agent_old_get_registered ()

gboolean
nm_secret_agent_old_get_registered (NMSecretAgentOld *self);

Parameters