nm_secret_agent_error_quark ()

GQuark
nm_secret_agent_error_quark (void);

NMSecretAgentGetSecretsFunc ()

void
(*NMSecretAgentGetSecretsFunc) (NMSecretAgent *agent,
                                NMConnection *connection,
                                GHashTable *secrets,
                                GError *error,
                                gpointer user_data);

Called as a result of a request by NM to retrieve secrets. When the NMSecretAgent 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 hash table to return the Wi-Fi PSK, you could do something like this:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

NMConnection *secrets;
NMSettingWirelessSecurity *s_wsec;
GHashTable *secrets_hash;

secrets = nm_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_hash = nm_connection_to_hash (secrets, NM_SETTING_HASH_FLAG_ALL);

(call the NMSecretAgentGetSecretsFunc with secrets_hash)

g_object_unref (secrets);
g_hash_table_unref (secrets_hash);

NMSecretAgentSaveSecretsFunc ()

void
(*NMSecretAgentSaveSecretsFunc) (NMSecretAgent *agent,
                                 NMConnection *connection,
                                 GError *error,
                                 gpointer user_data);

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

NMSecretAgentDeleteSecretsFunc ()

void
(*NMSecretAgentDeleteSecretsFunc) (NMSecretAgent *agent,
                                   NMConnection *connection,
                                   GError *error,
                                   gpointer user_data);

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

nm_secret_agent_register ()

gboolean
nm_secret_agent_register (NMSecretAgent *self);

Registers the NMSecretAgent 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. Registration is an asynchronous operation and its success or failure is indicated via the 'registration-result' signal.

nm_secret_agent_unregister ()

gboolean
nm_secret_agent_unregister (NMSecretAgent *self);

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

nm_secret_agent_get_registered ()

gboolean
nm_secret_agent_get_registered (NMSecretAgent *self);

nm_secret_agent_get_secrets ()

void
nm_secret_agent_get_secrets (NMSecretAgent *self,
                             NMConnection *connection,
                             const char *setting_name,
                             const char **hints,
                             NMSecretAgentGetSecretsFlags flags,
                             NMSecretAgentGetSecretsFunc callback,
                             gpointer user_data);

nm_secret_agent_save_secrets ()

void
nm_secret_agent_save_secrets (NMSecretAgent *self,
                              NMConnection *connection,
                              NMSecretAgentSaveSecretsFunc callback,
                              gpointer user_data);

nm_secret_agent_delete_secrets ()

void
nm_secret_agent_delete_secrets (NMSecretAgent *self,
                                NMConnection *connection,
                                NMSecretAgentDeleteSecretsFunc callback,
                                gpointer user_data);

NM_SECRET_AGENT_ERROR

#define NM_SECRET_AGENT_ERROR         (nm_secret_agent_error_quark ())

enum NMSecretAgentError

NMSecretAgentError values are passed by secret agents back to NetworkManager when they encounter problems retrieving secrets on behalf of NM.

enum NMSecretAgentCapabilities

NMSecretAgentCapabilities indicate various capabilities of the agent.

Since: 0.9.10

enum NMSecretAgentGetSecretsFlags

NMSecretAgentGetSecretsFlags values modify the behavior of a GetSecrets request.

NM_SECRET_AGENT_IDENTIFIER

#define NM_SECRET_AGENT_IDENTIFIER          "identifier"

NM_SECRET_AGENT_AUTO_REGISTER

#define NM_SECRET_AGENT_AUTO_REGISTER       "auto-register"

NM_SECRET_AGENT_REGISTERED

#define NM_SECRET_AGENT_REGISTERED          "registered"

NM_SECRET_AGENT_CAPABILITIES

#define NM_SECRET_AGENT_CAPABILITIES        "capabilities"

NM_SECRET_AGENT_REGISTRATION_RESULT

#define NM_SECRET_AGENT_REGISTRATION_RESULT "registration-result"

The “auto-register” property

  “auto-register”            gboolean

If TRUE, the agent will attempt to automatically register itself after it is created (via an idle handler) and to re-register itself if NetworkManager restarts. If FALSE, the agent does not automatically register with NetworkManager, and nm_secret_agent_register() must be called. If 'auto-register' is TRUE, calling nm_secret_agent_unregister() will suppress auto-registration until nm_secret_agent_register() is called, which re-enables auto-registration.

Owner: NMSecretAgent

Flags: Read / Write / Construct

Default value: TRUE

The “capabilities” property

  “capabilities”             NMSecretAgentCapabilities

A bitfield of NMSecretAgentCapabilities.

Owner: NMSecretAgent

Flags: Read / Write / Construct

The “identifier” property

  “identifier”               gchar *

Identifies this agent; only one agent in each user session may use the same identifier. Identifier formatting follows the same rules as D-Bus bus names with the exception that the ':' character is not allowed. The valid set of characters is "A-Z[0-9]_-." and the identifier is limited in length to 255 characters with a minimum of 3 characters. An example valid identifier is 'org.gnome.nm-applet' (without quotes).

Owner: NMSecretAgent

Flags: Read / Write / Construct Only

Default value: NULL

The “registered” property

  “registered”               gboolean

TRUE if the agent is registered with NetworkManager, FALSE if not.

Owner: NMSecretAgent

Flags: Read

Default value: FALSE

The “registration-result” signal

void
user_function (NMSecretAgent *agent,
               gpointer       error,
               gpointer       user_data)

Indicates the result of a registration request; if error is NULL the request was successful.

Flags: Run First