mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager
synced 2024-10-04 23:31:19 +00:00
287 lines
13 KiB
C
287 lines
13 KiB
C
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the
|
|
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
* Boston, MA 02110-1301 USA.
|
|
*
|
|
* (C) Copyright 2010 - 2011 Red Hat, Inc.
|
|
*/
|
|
|
|
#ifndef NM_SECRET_AGENT_H
|
|
#define NM_SECRET_AGENT_H
|
|
|
|
#include <nm-connection.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
#define NM_SECRET_AGENT_ERROR (nm_secret_agent_error_quark ())
|
|
|
|
GQuark nm_secret_agent_error_quark (void);
|
|
|
|
/**
|
|
* NMSecretAgentError:
|
|
* @NM_SECRET_AGENT_ERROR_NOT_AUTHORIZED: the caller (ie, NetworkManager) is not
|
|
* authorized to make this request
|
|
* @NM_SECRET_AGENT_ERROR_INVALID_CONNECTION: the connection for which secrets
|
|
* were requested could not be found
|
|
* @NM_SECRET_AGENT_ERROR_USER_CANCELED: the request was canceled by the user
|
|
* @NM_SECRET_AGENT_ERROR_AGENT_CANCELED: the agent canceled the request
|
|
* because it was requested to do so by NetworkManager
|
|
* @NM_SECRET_AGENT_ERROR_INTERNAL_ERROR: some internal error in the agent caused
|
|
* the request to fail
|
|
* @NM_SECRET_AGENT_ERROR_NO_SECRETS: the agent cannot find any secrets for this
|
|
* connection
|
|
*
|
|
* #NMSecretAgentError values are passed by secret agents back to NetworkManager
|
|
* when they encounter problems retrieving secrets on behalf of NM.
|
|
*/
|
|
typedef enum {
|
|
NM_SECRET_AGENT_ERROR_NOT_AUTHORIZED = 0, /*< nick=NotAuthorized >*/
|
|
NM_SECRET_AGENT_ERROR_INVALID_CONNECTION, /*< nick=InvalidConnection >*/
|
|
NM_SECRET_AGENT_ERROR_USER_CANCELED, /*< nick=UserCanceled >*/
|
|
NM_SECRET_AGENT_ERROR_AGENT_CANCELED, /*< nick=AgentCanceled >*/
|
|
NM_SECRET_AGENT_ERROR_INTERNAL_ERROR, /*< nick=InternalError >*/
|
|
NM_SECRET_AGENT_ERROR_NO_SECRETS, /*< nick=NoSecrets >*/
|
|
} NMSecretAgentError;
|
|
|
|
/**
|
|
* NMSecretAgentGetSecretsFlags:
|
|
* @NM_SECRET_AGENT_GET_SECRETS_FLAG_NONE: no special behavior; by default no
|
|
* user interaction is allowed and requests for secrets are fulfilled from
|
|
* persistent storage, or if no secrets are available an error is returned.
|
|
* @NM_SECRET_AGENT_GET_SECRETS_FLAG_ALLOW_INTERACTION: allows the request to
|
|
* interact with the user, possibly prompting via UI for secrets if any are
|
|
* required, or if none are found in persistent storage.
|
|
* @NM_SECRET_AGENT_GET_SECRETS_FLAG_REQUEST_NEW: explicitly prompt for new
|
|
* secrets from the user. This flag signals that NetworkManager thinks any
|
|
* existing secrets are invalid or wrong. This flag implies that interaction
|
|
* is allowed.
|
|
* @NM_SECRET_AGENT_GET_SECRETS_FLAG_USER_REQUESTED: set if the request was
|
|
* initiated by user-requested action via the D-Bus interface, as opposed to
|
|
* automatically initiated by NetworkManager in response to (for example) scan
|
|
* results or carrier changes.
|
|
*
|
|
* #NMSecretAgentGetSecretsFlags values modify the behavior of a GetSecrets request.
|
|
*/
|
|
typedef enum /*< flags >*/ {
|
|
NM_SECRET_AGENT_GET_SECRETS_FLAG_NONE = 0x0,
|
|
NM_SECRET_AGENT_GET_SECRETS_FLAG_ALLOW_INTERACTION = 0x1,
|
|
NM_SECRET_AGENT_GET_SECRETS_FLAG_REQUEST_NEW = 0x2,
|
|
NM_SECRET_AGENT_GET_SECRETS_FLAG_USER_REQUESTED = 0x4
|
|
} NMSecretAgentGetSecretsFlags;
|
|
|
|
#define NM_TYPE_SECRET_AGENT (nm_secret_agent_get_type ())
|
|
#define NM_SECRET_AGENT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), NM_TYPE_SECRET_AGENT, NMSecretAgent))
|
|
#define NM_SECRET_AGENT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), NM_TYPE_SECRET_AGENT, NMSecretAgentClass))
|
|
#define NM_IS_SECRET_AGENT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NM_TYPE_SECRET_AGENT))
|
|
#define NM_IS_SECRET_AGENT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), NM_TYPE_SECRET_AGENT))
|
|
#define NM_SECRET_AGENT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), NM_TYPE_SECRET_AGENT, NMSecretAgentClass))
|
|
|
|
#define NM_SECRET_AGENT_IDENTIFIER "identifier"
|
|
#define NM_SECRET_AGENT_AUTO_REGISTER "auto-register"
|
|
#define NM_SECRET_AGENT_REGISTERED "registered"
|
|
|
|
#define NM_SECRET_AGENT_REGISTRATION_RESULT "registration-result"
|
|
|
|
typedef struct {
|
|
GObject parent;
|
|
} NMSecretAgent;
|
|
|
|
/**
|
|
* NMSecretAgentGetSecretsFunc:
|
|
* @agent: the secret agent object
|
|
* @connection: (transfer none): 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
|
|
* @secrets: (element-type utf8 GLib.HashTable): the #GHashTable containing
|
|
* the requested secrets in the same format as an #NMConnection hash (as
|
|
* created by nm_connection_to_hash() for example). Each key in @secrets
|
|
* should be the name of a #NMSetting object (like "802-11-wireless-security")
|
|
* and each value should be a #GHashTable. The sub-hashes map string:#GValue
|
|
* 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
|
|
*
|
|
* 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 WiFi PSK, you could do
|
|
* something like this:
|
|
* <example>
|
|
* <title>Creating a secrets hash</title>
|
|
* <programlisting>
|
|
* 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);
|
|
* </programlisting>
|
|
* </example>
|
|
*/
|
|
typedef void (*NMSecretAgentGetSecretsFunc) (NMSecretAgent *agent,
|
|
NMConnection *connection,
|
|
GHashTable *secrets,
|
|
GError *error,
|
|
gpointer user_data);
|
|
|
|
/**
|
|
* NMSecretAgentSaveSecretsFunc:
|
|
* @agent: the secret agent object
|
|
* @connection: (transfer none): 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
|
|
* @error: if the saving secrets failed, give a descriptive error here
|
|
* @user_data: caller-specific data to be passed to the function
|
|
*
|
|
* 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.
|
|
*/
|
|
typedef void (*NMSecretAgentSaveSecretsFunc) (NMSecretAgent *agent,
|
|
NMConnection *connection,
|
|
GError *error,
|
|
gpointer user_data);
|
|
|
|
/**
|
|
* NMSecretAgentDeleteSecretsFunc:
|
|
* @agent: the secret agent object
|
|
* @connection: (transfer none): 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
|
|
* @error: if the deleting secrets failed, give a descriptive error here
|
|
* @user_data: caller-specific data to be passed to the function
|
|
*
|
|
* 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.
|
|
*/
|
|
typedef void (*NMSecretAgentDeleteSecretsFunc) (NMSecretAgent *agent,
|
|
NMConnection *connection,
|
|
GError *error,
|
|
gpointer user_data);
|
|
|
|
typedef struct {
|
|
GObjectClass parent;
|
|
|
|
/* Virtual methods for subclasses */
|
|
|
|
/* Called when the subclass should retrieve and return secrets. Subclass
|
|
* must copy or reference any arguments it may require after returning from
|
|
* this method, as the arguments will freed (except for 'agent', 'callback',
|
|
* and 'user_data' of course). If the request is canceled, the callback
|
|
* should still be called, but with the NM_SECRET_AGENT_ERROR_AGENT_CANCELED
|
|
* error.
|
|
*/
|
|
void (*get_secrets) (NMSecretAgent *agent,
|
|
NMConnection *connection,
|
|
const char *connection_path,
|
|
const char *setting_name,
|
|
const char **hints,
|
|
NMSecretAgentGetSecretsFlags flags,
|
|
NMSecretAgentGetSecretsFunc callback,
|
|
gpointer user_data);
|
|
|
|
/* Called when the subclass should cancel an outstanding request to
|
|
* get secrets for a given connection. Canceling the request MUST
|
|
* call the callback that was passed along with the initial get_secrets
|
|
* call, sending the NM_SECRET_AGENT_ERROR/NM_SECRET_AGENT_ERROR_AGENT_CANCELED
|
|
* error to that callback.
|
|
*/
|
|
void (*cancel_get_secrets) (NMSecretAgent *agent,
|
|
const char *connection_path,
|
|
const char *setting_name);
|
|
|
|
/* Called when the subclass should save the secrets contained in the
|
|
* connection to backing storage. Subclass must copy or reference any
|
|
* arguments it may require after returning from this method, as the
|
|
* arguments will freed (except for 'agent', 'callback', and 'user_data'
|
|
* of course).
|
|
*/
|
|
void (*save_secrets) (NMSecretAgent *agent,
|
|
NMConnection *connection,
|
|
const char *connection_path,
|
|
NMSecretAgentSaveSecretsFunc callback,
|
|
gpointer user_data);
|
|
|
|
/* Called when the subclass should delete the secrets contained in the
|
|
* connection from backing storage. Subclass must copy or reference any
|
|
* arguments it may require after returning from this method, as the
|
|
* arguments will freed (except for 'agent', 'callback', and 'user_data'
|
|
* of course).
|
|
*/
|
|
void (*delete_secrets) (NMSecretAgent *agent,
|
|
NMConnection *connection,
|
|
const char *connection_path,
|
|
NMSecretAgentDeleteSecretsFunc callback,
|
|
gpointer user_data);
|
|
|
|
/* Signals */
|
|
void (*registration_result) (NMSecretAgent *agent, GError *error);
|
|
|
|
/* Padding for future expansion */
|
|
void (*_reserved1) (void);
|
|
void (*_reserved2) (void);
|
|
void (*_reserved3) (void);
|
|
void (*_reserved4) (void);
|
|
void (*_reserved5) (void);
|
|
void (*_reserved6) (void);
|
|
} NMSecretAgentClass;
|
|
|
|
GType nm_secret_agent_get_type (void);
|
|
|
|
gboolean nm_secret_agent_register (NMSecretAgent *self);
|
|
|
|
gboolean nm_secret_agent_unregister (NMSecretAgent *self);
|
|
|
|
gboolean nm_secret_agent_get_registered (NMSecretAgent *self);
|
|
|
|
void nm_secret_agent_get_secrets (NMSecretAgent *self,
|
|
NMConnection *connection,
|
|
const char *setting_name,
|
|
const char **hints,
|
|
NMSecretAgentGetSecretsFlags flags,
|
|
NMSecretAgentGetSecretsFunc callback,
|
|
gpointer user_data);
|
|
|
|
void nm_secret_agent_save_secrets (NMSecretAgent *self,
|
|
NMConnection *connection,
|
|
NMSecretAgentSaveSecretsFunc callback,
|
|
gpointer user_data);
|
|
|
|
void nm_secret_agent_delete_secrets (NMSecretAgent *self,
|
|
NMConnection *connection,
|
|
NMSecretAgentDeleteSecretsFunc callback,
|
|
gpointer user_data);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* NM_SECRET_AGENT_H */
|