secret_service_get ()

void
secret_service_get (SecretServiceFlags flags,
                    GCancellable *cancellable,
                    GAsyncReadyCallback callback,
                    gpointer user_data);

Get a SecretService proxy for the Secret Service. If such a proxy object already exists, then the same proxy is returned.

If flags contains any flags of which parts of the secret service to ensure are initialized, then those will be initialized before completing.

This method will return immediately and complete asynchronously.

secret_service_get_sync ()

SecretService *
secret_service_get_sync (SecretServiceFlags flags,
                         GCancellable *cancellable,
                         GError **error);

Get a SecretService proxy for the Secret Service. If such a proxy object already exists, then the same proxy is returned.

If flags contains any flags of which parts of the secret service to ensure are initialized, then those will be initialized before returning.

This method may block indefinitely and should not be used in user interface threads.

secret_service_get_finish ()

SecretService *
secret_service_get_finish (GAsyncResult *result,
                           GError **error);

Complete an asynchronous operation to get a SecretService proxy for the Secret Service.

secret_service_disconnect ()

void
secret_service_disconnect (void);

Disconnect the default SecretService proxy returned by secret_service_get() and secret_service_get_sync().

It is not necessary to call this function, but you may choose to do so at program exit. It is useful for testing that memory is not leaked.

This function is safe to call at any time. But if other objects in this library are still referenced, then this will not result in all memory being freed.

secret_service_open ()

void
secret_service_open (GType service_gtype,
                     const gchar *service_bus_name,
                     SecretServiceFlags flags,
                     GCancellable *cancellable,
                     GAsyncReadyCallback callback,
                     gpointer user_data);

Create a new SecretService proxy for the Secret Service.

This function is rarely used, see secret_service_get() instead.

The service_gtype argument should be set to SECRET_TYPE_SERVICE or a the type of a derived class.

If flags contains any flags of which parts of the secret service to ensure are initialized, then those will be initialized before returning.

If service_bus_name is NULL then the default is used.

This method will return immediately and complete asynchronously.

secret_service_open_finish ()

SecretService *
secret_service_open_finish (GAsyncResult *result,
                            GError **error);

Complete an asynchronous operation to create a new SecretService proxy for the Secret Service.

secret_service_open_sync ()

SecretService *
secret_service_open_sync (GType service_gtype,
                          const gchar *service_bus_name,
                          SecretServiceFlags flags,
                          GCancellable *cancellable,
                          GError **error);

Create a new SecretService proxy for the Secret Service.

This function is rarely used, see secret_service_get_sync() instead.

The service_gtype argument should be set to SECRET_TYPE_SERVICE or a the type of a derived class.

If flags contains any flags of which parts of the secret service to ensure are initialized, then those will be initialized before returning.

If service_bus_name is NULL then the default is used.

This method may block indefinitely and should not be used in user interface threads.

secret_service_get_collections ()

GList *
secret_service_get_collections (SecretService *self);

Get a list of SecretCollection objects representing all the collections in the secret service.

If the SECRET_SERVICE_LOAD_COLLECTIONS flag was not specified when initializing SecretService proxy object, then this method will return NULL. Use secret_service_load_collections() to load the collections.

secret_service_get_flags ()

SecretServiceFlags
secret_service_get_flags (SecretService *self);

Get the flags representing what features of the SecretService proxy have been initialized.

Use secret_service_ensure_session() or secret_service_load_collections() to initialize further features and change the flags.

secret_service_get_session_algorithms ()

const gchar *
secret_service_get_session_algorithms (SecretService *self);

Get the set of algorithms being used to transfer secrets between this secret service proxy and the Secret Service itself.

This will be NULL if no session has been established. Use secret_service_ensure_session() to establish a session.

secret_service_ensure_session ()

void
secret_service_ensure_session (SecretService *self,
                               GCancellable *cancellable,
                               GAsyncReadyCallback callback,
                               gpointer user_data);

Ensure that the SecretService proxy has established a session with the Secret Service. This session is used to transfer secrets.

It is not normally necessary to call this method, as the session is established as necessary. You can also pass the SECRET_SERVICE_OPEN_SESSION to secret_service_get() in order to ensure that a session has been established by the time you get the SecretService proxy.

This method will return immediately and complete asynchronously.

secret_service_ensure_session_finish ()

gboolean
secret_service_ensure_session_finish (SecretService *self,
                                      GAsyncResult *result,
                                      GError **error);

Finish an asynchronous operation to ensure that the SecretService proxy has established a session with the Secret Service.

secret_service_ensure_session_sync ()

gboolean
secret_service_ensure_session_sync (SecretService *self,
                                    GCancellable *cancellable,
                                    GError **error);

Ensure that the SecretService proxy has established a session with the Secret Service. This session is used to transfer secrets.

It is not normally necessary to call this method, as the session is established as necessary. You can also pass the SECRET_SERVICE_OPEN_SESSION to secret_service_get_sync() in order to ensure that a session has been established by the time you get the SecretService proxy.

This method may block indefinitely and should not be used in user interface threads.

secret_service_load_collections ()

void
secret_service_load_collections (SecretService *self,
                                 GCancellable *cancellable,
                                 GAsyncReadyCallback callback,
                                 gpointer user_data);

Ensure that the SecretService proxy has loaded all the collections present in the Secret Service. This affects the result of secret_service_get_collections().

You can also pass the SECRET_SERVICE_LOAD_COLLECTIONS to secret_service_get_sync() in order to ensure that the collections have been loaded by the time you get the SecretService proxy.

This method will return immediately and complete asynchronously.

secret_service_load_collections_finish ()

gboolean
secret_service_load_collections_finish
                               (SecretService *self,
                                GAsyncResult *result,
                                GError **error);

Complete an asynchronous operation to ensure that the SecretService proxy has loaded all the collections present in the Secret Service.

secret_service_load_collections_sync ()

gboolean
secret_service_load_collections_sync (SecretService *self,
                                      GCancellable *cancellable,
                                      GError **error);

Ensure that the SecretService proxy has loaded all the collections present in the Secret Service. This affects the result of secret_service_get_collections().

You can also pass the SECRET_SERVICE_LOAD_COLLECTIONS to secret_service_get_sync() in order to ensure that the collections have been loaded by the time you get the SecretService proxy.

This method may block indefinitely and should not be used in user interface threads.

secret_service_search ()

void
secret_service_search (SecretService *service,
                       const SecretSchema *schema,
                       GHashTable *attributes,
                       SecretSearchFlags flags,
                       GCancellable *cancellable,
                       GAsyncReadyCallback callback,
                       gpointer user_data);

Search for items matching the attributes . All collections are searched. The attributes should be a table of string keys and string values.

If service is NULL, then secret_service_get() will be called to get the default SecretService proxy.

If SECRET_SEARCH_ALL is set in flags , then all the items matching the search will be returned. Otherwise only the first item will be returned. This is almost always the unlocked item that was most recently stored.

If SECRET_SEARCH_UNLOCK is set in flags , then items will be unlocked if necessary. In either case, locked and unlocked items will match the search and be returned. If the unlock fails, the search does not fail.

If SECRET_SEARCH_LOAD_SECRETS is set in flags , then the items will have their secret values loaded and available via secret_item_get_secret().

This function returns immediately and completes asynchronously.

secret_service_search_finish ()

GList *
secret_service_search_finish (SecretService *service,
                              GAsyncResult *result,
                              GError **error);

Complete asynchronous operation to search for items.

secret_service_search_sync ()

GList *
secret_service_search_sync (SecretService *service,
                            const SecretSchema *schema,
                            GHashTable *attributes,
                            SecretSearchFlags flags,
                            GCancellable *cancellable,
                            GError **error);

Search for items matching the attributes . All collections are searched. The attributes should be a table of string keys and string values.

If service is NULL, then secret_service_get_sync() will be called to get the default SecretService proxy.

If SECRET_SEARCH_ALL is set in flags , then all the items matching the search will be returned. Otherwise only the first item will be returned. This is almost always the unlocked item that was most recently stored.

If SECRET_SEARCH_UNLOCK is set in flags , then items will be unlocked if necessary. In either case, locked and unlocked items will match the search and be returned. If the unlock fails, the search does not fail.

If SECRET_SEARCH_LOAD_SECRETS is set in flags , then the items' secret values will be loaded for any unlocked items. Loaded item secret values are available via secret_item_get_secret(). If the load of a secret values fail, then the

This function may block indefinitely. Use the asynchronous version in user interface threads.

secret_service_lock ()

void
secret_service_lock (SecretService *service,
                     GList *objects,
                     GCancellable *cancellable,
                     GAsyncReadyCallback callback,
                     gpointer user_data);

Lock items or collections in the secret service.

The secret service may not be able to lock items individually, and may lock an entire collection instead.

If service is NULL, then secret_service_get() will be called to get the default SecretService proxy.

This method returns immediately and completes asynchronously. The secret service may prompt the user. secret_service_prompt() will be used to handle any prompts that show up.

secret_service_lock_finish ()

gint
secret_service_lock_finish (SecretService *service,
                            GAsyncResult *result,
                            GList **locked,
                            GError **error);

Complete asynchronous operation to lock items or collections in the secret service.

The secret service may not be able to lock items individually, and may lock an entire collection instead.

secret_service_lock_sync ()

gint
secret_service_lock_sync (SecretService *service,
                          GList *objects,
                          GCancellable *cancellable,
                          GList **locked,
                          GError **error);

Lock items or collections in the secret service.

The secret service may not be able to lock items individually, and may lock an entire collection instead.

If service is NULL, then secret_service_get_sync() will be called to get the default SecretService proxy.

This method may block indefinitely and should not be used in user interface threads. The secret service may prompt the user. secret_service_prompt() will be used to handle any prompts that show up.

secret_service_unlock ()

void
secret_service_unlock (SecretService *service,
                       GList *objects,
                       GCancellable *cancellable,
                       GAsyncReadyCallback callback,
                       gpointer user_data);

Unlock items or collections in the secret service.

The secret service may not be able to unlock items individually, and may unlock an entire collection instead.

If service is NULL, then secret_service_get() will be called to get the default SecretService proxy.

This method may block indefinitely and should not be used in user interface threads. The secret service may prompt the user. secret_service_prompt() will be used to handle any prompts that show up.

secret_service_unlock_finish ()

gint
secret_service_unlock_finish (SecretService *service,
                              GAsyncResult *result,
                              GList **unlocked,
                              GError **error);

Complete asynchronous operation to unlock items or collections in the secret service.

The secret service may not be able to unlock items individually, and may unlock an entire collection instead.

secret_service_unlock_sync ()

gint
secret_service_unlock_sync (SecretService *service,
                            GList *objects,
                            GCancellable *cancellable,
                            GList **unlocked,
                            GError **error);

Unlock items or collections in the secret service.

The secret service may not be able to unlock items individually, and may unlock an entire collection instead.

If service is NULL, then secret_service_get_sync() will be called to get the default SecretService proxy.

This method may block indefinitely and should not be used in user interface threads. The secret service may prompt the user. secret_service_prompt() will be used to handle any prompts that show up.

secret_service_store ()

void
secret_service_store (SecretService *service,
                      const SecretSchema *schema,
                      GHashTable *attributes,
                      const gchar *collection,
                      const gchar *label,
                      SecretValue *value,
                      GCancellable *cancellable,
                      GAsyncReadyCallback callback,
                      gpointer user_data);

Store a secret value in the secret service.

The attributes should be a set of key and value string pairs.

If the attributes match a secret item already stored in the collection, then the item will be updated with these new values.

If service is NULL, then secret_service_get() will be called to get the default SecretService proxy.

If collection is not specified, then the default collection will be used. Use SECRET_COLLECTION_SESSION to store the password in the session collection, which doesn't get stored across login sessions.

This method will return immediately and complete asynchronously.

secret_service_store_finish ()

gboolean
secret_service_store_finish (SecretService *service,
                             GAsyncResult *result,
                             GError **error);

Finish asynchronous operation to store a secret value in the secret service.

secret_service_store_sync ()

gboolean
secret_service_store_sync (SecretService *service,
                           const SecretSchema *schema,
                           GHashTable *attributes,
                           const gchar *collection,
                           const gchar *label,
                           SecretValue *value,
                           GCancellable *cancellable,
                           GError **error);

Store a secret value in the secret service.

The attributes should be a set of key and value string pairs.

If the attributes match a secret item already stored in the collection, then the item will be updated with these new values.

If collection is NULL, then the default collection will be used. Use SECRET_COLLECTION_SESSION to store the password in the session collection, which doesn't get stored across login sessions.

If service is NULL, then secret_service_get_sync() will be called to get the default SecretService proxy.

This method may block indefinitely and should not be used in user interface threads.

secret_service_lookup ()

void
secret_service_lookup (SecretService *service,
                       const SecretSchema *schema,
                       GHashTable *attributes,
                       GCancellable *cancellable,
                       GAsyncReadyCallback callback,
                       gpointer user_data);

Lookup a secret value in the secret service.

The attributes should be a set of key and value string pairs.

If service is NULL, then secret_service_get() will be called to get the default SecretService proxy.

This method will return immediately and complete asynchronously.

secret_service_lookup_finish ()

SecretValue *
secret_service_lookup_finish (SecretService *service,
                              GAsyncResult *result,
                              GError **error);

Finish asynchronous operation to lookup a secret value in the secret service.

If no secret is found then NULL is returned.

secret_service_lookup_sync ()

SecretValue *
secret_service_lookup_sync (SecretService *service,
                            const SecretSchema *schema,
                            GHashTable *attributes,
                            GCancellable *cancellable,
                            GError **error);

Lookup a secret value in the secret service.

The attributes should be a set of key and value string pairs.

If service is NULL, then secret_service_get_sync() will be called to get the default SecretService proxy.

This method may block indefinitely and should not be used in user interface threads.

secret_service_clear ()

void
secret_service_clear (SecretService *service,
                      const SecretSchema *schema,
                      GHashTable *attributes,
                      GCancellable *cancellable,
                      GAsyncReadyCallback callback,
                      gpointer user_data);

Remove unlocked items which match the attributes from the secret service.

The attributes should be a set of key and value string pairs.

If service is NULL, then secret_service_get() will be called to get the default SecretService proxy.

This method will return immediately and complete asynchronously.

secret_service_clear_finish ()

gboolean
secret_service_clear_finish (SecretService *service,
                             GAsyncResult *result,
                             GError **error);

Finish asynchronous operation to remove items from the secret service.

secret_service_clear_sync ()

gboolean
secret_service_clear_sync (SecretService *service,
                           const SecretSchema *schema,
                           GHashTable *attributes,
                           GCancellable *cancellable,
                           GError **error);

Remove unlocked items which match the attributes from the secret service.

The attributes should be a set of key and value string pairs.

If service is NULL, then secret_service_get_sync() will be called to get the default SecretService proxy.

This method may block indefinitely and should not be used in user interface threads.

secret_service_prompt ()

void
secret_service_prompt (SecretService *self,
                       SecretPrompt *prompt,
                       const GVariantType *return_type,
                       GCancellable *cancellable,
                       GAsyncReadyCallback callback,
                       gpointer user_data);

Perform prompting for a SecretPrompt.

This function is called by other parts of this library to handle prompts for the various actions that can require prompting.

Override the SecretServiceClass prompt_async virtual method to change the behavior of the prompting. The default behavior is to simply run secret_prompt_perform() on the prompt.

secret_service_prompt_finish ()

GVariant *
secret_service_prompt_finish (SecretService *self,
                              GAsyncResult *result,
                              GError **error);

Complete asynchronous operation to perform prompting for a SecretPrompt.

Returns a variant result if the prompt was completed and not dismissed. The type of result depends on the action the prompt is completing, and is defined in the Secret Service DBus API specification.

secret_service_prompt_sync ()

GVariant *
secret_service_prompt_sync (SecretService *self,
                            SecretPrompt *prompt,
                            GCancellable *cancellable,
                            const GVariantType *return_type,
                            GError **error);

Perform prompting for a SecretPrompt.

Runs a prompt and performs the prompting. Returns a variant result if the prompt was completed and not dismissed. The type of result depends on the action the prompt is completing, and is defined in the Secret Service DBus API specification.

This function is called by other parts of this library to handle prompts for the various actions that can require prompting.

Override the SecretServiceClass prompt_sync virtual method to change the behavior of the prompting. The default behavior is to simply run secret_prompt_perform_sync() on the prompt with a NULL window_id.

secret_service_set_alias ()

void
secret_service_set_alias (SecretService *service,
                          const gchar *alias,
                          SecretCollection *collection,
                          GCancellable *cancellable,
                          GAsyncReadyCallback callback,
                          gpointer user_data);

Assign a collection to this alias. Aliases help determine well known collections, such as 'default'.

If service is NULL, then secret_service_get() will be called to get the default SecretService proxy.

This method will return immediately and complete asynchronously.

secret_service_set_alias_finish ()

gboolean
secret_service_set_alias_finish (SecretService *service,
                                 GAsyncResult *result,
                                 GError **error);

Finish an asynchronous operation to assign a collection to an alias.

secret_service_set_alias_sync ()

gboolean
secret_service_set_alias_sync (SecretService *service,
                               const gchar *alias,
                               SecretCollection *collection,
                               GCancellable *cancellable,
                               GError **error);

Assign a collection to this alias. Aliases help determine well known collections, such as 'default'.

If service is NULL, then secret_service_get_sync() will be called to get the default SecretService proxy.

This method may block and should not be used in user interface threads.

secret_service_get_collection_gtype ()

GType
secret_service_get_collection_gtype (SecretService *self);

Get the GObject type for collections instantiated by this service. This will always be either SecretCollection or derived from it.

secret_service_get_item_gtype ()

GType
secret_service_get_item_gtype (SecretService *self);

Get the GObject type for items instantiated by this service. This will always be either SecretItem or derived from it.

struct SecretService

struct SecretService;

A proxy object representing the Secret Service.

struct SecretServiceClass

struct SecretServiceClass {
	GDBusProxyClass parent_class;

	GType collection_gtype;
	GType item_gtype;

	GVariant *  (* prompt_sync)      (SecretService *self,
	                                  SecretPrompt *prompt,
	                                  GCancellable *cancellable,
	                                  const GVariantType *return_type,
	                                  GError **error);

	void        (* prompt_async)     (SecretService *self,
	                                  SecretPrompt *prompt,
	                                  const GVariantType *return_type,
	                                  GCancellable *cancellable,
	                                  GAsyncReadyCallback callback,
	                                  gpointer user_data);

	GVariant *  (* prompt_finish)    (SecretService *self,
	                                  GAsyncResult *result,
	                                  GError **error);

	GType       (* get_collection_gtype)  (SecretService *self);

	GType       (* get_item_gtype)        (SecretService *self);
};

The class for SecretService.

enum SecretServiceFlags

Flags which determine which parts of the SecretService proxy are initialized during a secret_service_get() or secret_service_open() operation.

enum SecretSearchFlags

Various flags to be used with secret_service_search() and secret_service_search_sync().

The “collections” property

  “collections”              SecretObjectList *

A list of SecretCollection objects representing the collections in the Secret Service. This list may be NULL if the collections have not been loaded.

To load the collections, specify the SECRET_SERVICE_LOAD_COLLECTIONS initialization flag when calling the secret_service_get() or secret_service_open() functions. Or call the secret_service_load_collections() method.

Flags: Read

The “flags” property

  “flags”                    SecretServiceFlags

A set of flags describing which parts of the secret service have been initialized.

Flags: Read / Write / Construct Only