Skip to main content

Crate keyring

Crate keyring 

Source
Expand description

Connections to available keyring stores.

This library provides sample code for each available credential store, a convenience function for choosing a default credential store by name, and a convenience function for releasing the default credential store.

For each available keyring-compatible credential store (other than mock), this module defines a use_... function which sets that store as the default credential store. It also gives that store a name in the use_named_store convenience function.

As developers make new credential store modules available, they are encouraged to submit a pull request that adds a connection here for their module, both via a use_... function and via [use_named store]. (In doing so, they will also extend both the Rust-based CLI and the Python-based REPL client to support the new store.)

Constants§

NAMED_STORES
An alphabetic list of known credential stores.

Functions§

internalize
Given an (optional) HashMap of strings, return a HashMap of references to those strings.
release_store
Release the current default store.
store_info
Returns a debug description of the current default store.
use_android_native_store
Use the Android Shared Preferences store.
use_apple_keychain_store
Use the macOS Keychain Services store.
use_apple_protected_store
Use the iOS/macOS Protected Data store.
use_dbus_secret_service_store
Use the dbus-based Secret Service store via libdbus.
use_linux_keyutils_store
Use the Linux Keyutils store.
use_named_store
Set the default store to one of the known stores (default configuration).
use_named_store_with_modifiers
Set the default store to one of the known stores (specified configuration).
use_native_store
Set the default store to the platform’s OS-provided credential store.
use_sample_store
Set the default store to the keyring-core::Sample store.
use_sqlite_store
Use a cross-platform encrypted sqlite (Turso) database.
use_windows_native_store
Use the Windows Credential store.
use_zbus_secret_service_store
Use the dbus-based Secret Service store via zbus.