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::Samplestore. - 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.