Class

SecretService

Description [src]

class Secret.Service : Gio.DBusProxy {
  parent: GDBusProxy
}

A proxy object representing the Secret Service.

A SecretService object represents the Secret Service implementation which runs as a D-Bus service.

Normally a single SecretService object can be shared between multiple callers. The secret_service_get() method is used to access this SecretService object. If a new independent SecretService object is required, use secret_service_open().

In order to securely transfer secrets to the Sercret Service, a session is established. This session can be established while initializing a SecretService object by passing the SECRET_SERVICE_OPEN_SESSION flag to the secret_service_get() or secret_service_open() functions. In order to establish a session on an already existing SecretService, use the secret_service_ensure_session() function.

To search for items, use the secret_service_search() method.

Multiple collections can exist in the Secret Service, each of which contains secret items. In order to instantiate SecretCollection objects which represent those collections while initializing a SecretService then pass the SECRET_SERVICE_LOAD_COLLECTIONS flag to the secret_service_get() or secret_service_open() functions. In order to establish a session on an already existing SecretService, use the secret_service_load_collections() function. To access the list of collections use secret_service_get_collections().

Certain actions on the Secret Service require user prompting to complete, such as creating a collection, or unlocking a collection. When such a prompt is necessary, then a SecretPrompt object is created by this library, and passed to the secret_service_prompt() method. In this way it is handled automatically.

In order to customize prompt handling, override the Secret.ServiceClass.prompt_async and Secret.ServiceClass.prompt_finish virtual methods of the SecretService class.

Stability:

Stable

Ancestors

GDBusProxy
GObject

Implements

GAsyncInitable
GDBusInterface
GInitable
SecretBackend

Properties

Secret.Service:collections

A list of SecretCollection objects representing the collections in the Secret Service.

Properties inherited from SecretBackend (1)

Secret.Backend:flags

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

Available since: 0.19.0

Class structure

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
  );
  
}

Class members

`parent_class`	`GDBusProxyClass`
	The parent class.
`collection_gtype`	`GType`
	The `GType` of the `SecretCollection` objects instantiated by the `SecretService` proxy.
`item_gtype`	`GType`
	The `GType` of the `SecretItem` objects instantiated by the `SecretService` proxy.
`prompt_sync`	`GVariant* (* prompt_sync) ( SecretService* self, SecretPrompt* prompt, GCancellable* cancellable, const GVariantType* return_type, GError** error )`
	No description available.
`prompt_async`	`void (* prompt_async) ( SecretService* self, SecretPrompt* prompt, const GVariantType* return_type, GCancellable* cancellable, GAsyncReadyCallback callback, gpointer user_data )`
	No description available.
`prompt_finish`	`GVariant* (* prompt_finish) ( SecretService* self, GAsyncResult* result, GError** error )`
	No description available.
`get_collection_gtype`	`GType (* get_collection_gtype) ( SecretService* self )`
	No description available.
`get_item_gtype`	`GType (* get_item_gtype) ( SecretService* self )`
	No description available.