Keyring management: Libsecret Library Reference Manual

Keyring management

In libsecret keyrings are called 'collections'. This is the same lingo as the underlying Secret Service DBus API. Keyrings are no longer identified by simple keyring names. Normally applications just use the default keyrings and these are identified by the aliases SECRET_COLLECTION_DEFAULT and SECRET_COLLECTION_SESSION. It is also possible to identify collections by their DBus object paths.

Replacements for related libgnome-keyring functions and types are described below:

Table 7.

libgnome-keyring	libsecret
`gnome_keyring_create()`	`secret_collection_create()`
`gnome_keyring_create_sync()`	`secret_collection_create_sync()`
`gnome_keyring_delete()`	`secret_collection_delete()`
`gnome_keyring_delete_sync()`	`secret_collection_delete_sync()`
`gnome_keyring_change_password()`	no equivalent, use platform specific DBus APIs
`gnome_keyring_change_password_sync()`	no equivalent, use platform specific DBus APIs
`gnome_keyring_list_keyring_names()`	`secret_service_load_collections()` and `secret_service_get_collections()`
`gnome_keyring_list_keyring_names_sync()`	`secret_service_load_collections_sync()` and `secret_service_get_collections()`
`gnome_keyring_set_default_keyring()`	`secret_service_set_alias()`
`gnome_keyring_set_default_keyring_sync()`	`secret_service_set_alias_sync()`
`gnome_keyring_get_default_keyring()`	`secret_collection_for_alias()` with `SECRET_COLLECTION_DEFAULT`
`gnome_keyring_get_default_keyring_sync()`	`secret_collection_for_alias_sync()` with `SECRET_COLLECTION_DEFAULT`
`gnome_keyring_list_item_ids()`	`secret_collection_load_items()` and `secret_collection_get_items()`
`gnome_keyring_list_item_ids_sync()`	`secret_collection_load_items_sync()` and `secret_collection_get_items()`
GnomeKeyringInfo	SecretCollection and properties
`gnome_keyring_get_info()`	no equivalent
`gnome_keyring_get_info_sync()`	no equivalent
`gnome_keyring_set_info()`	no equivalent, use property setters on SecretCollection
`gnome_keyring_set_info_sync()`	no equivalent, use property setters on SecretCollection
`gnome_keyring_info_free()`	no equivalent
`gnome_keyring_info_copy()`	no equivalent
`gnome_keyring_info_set_lock_on_idle()`	no equivalent
`gnome_keyring_info_get_lock_on_idle()`	no equivalent
`gnome_keyring_info_set_lock_timeout()`	no equivalent
`gnome_keyring_info_get_lock_timeout()`	no equivalent
`gnome_keyring_info_get_mtime()`	`secret_collection_get_modified()`
`gnome_keyring_info_get_ctime()`	`secret_collection_get_created()`
`gnome_keyring_info_get_is_locked()`	`secret_collection_get_locked()`