Expand description
OS keychain / credential-manager storage with a Stronghold-shaped API (sessions, vault locations, optional SLIP10/BIP39 procedures). See the crate README for IPC and guest-js.
§Rust usage
use tauri::Manager;
use tauri_plugin_keyring_store::KeyringExt;
fn example<R: tauri::Runtime>(app: &tauri::AppHandle<R>) {
let _svc = app.keyring().store.service();
}§Examples (naming helpers)
use tauri_plugin_keyring_store::{join_prefix, split_prefixed};
let account = join_prefix("billing", "stripe_sk")?;
assert_eq!(split_prefixed(&account)?, ("billing".into(), "stripe_sk".into()));Re-exports§
pub use naming::join_prefix;pub use naming::split_prefixed;pub use naming::PREFIX_SEPARATOR;
Modules§
- naming
- Helpers for application-level account naming (
prefix.name).
Structs§
- Builder
- Configure
KeyringPluginbefore mounting (service name defaults to the app identifier). - Duration
Dto - Stronghold-compatible duration (ignored for OS keyring persistence).
- Keyring
Plugin - Root plugin state registered with Tauri (
tauri::Manager::manage). - Keyring
Store - OS-backed credential storage scoped to one service identifier (bundle id / custom).
- Password
Backup Encrypted Dto - Argon2id + ChaCha20-Poly1305 backup envelope (always built).
- Password
Backup Entry Dto - Single entry in a plaintext password backup (export/import).
- Password
Backup Plain Dto - Plaintext backup blob shared by export/import JSON over IPC.
- Password
Entry Dto - One row for the bulk set passwords IPC command (
account+ plaintextsecret). - Ping
Request - IPC ping request (health / round-trip).
- Ping
Response - IPC ping response.
- Session
Registry - Managed snapshot sessions (Stronghold-compatible “initialized paths”).
Enums§
- Bytes
Dto - Bytes payload compatible with Stronghold’s JS API (
string | bytes). - Error
- Errors surfaced to the frontend and backend helpers (serializes as a plain string over IPC).
- KeyType
- Asymmetric key kind for
PublicKeyprocedure (string JSON:ed25519/x25519). - Location
Dto - Logical storage location inside a snapshot (vault + record or counter row).
- Procedure
Dto - Stronghold-shaped crypto or signing operation (requires the
cryptocrate feature). - Slip10
Derive Input Dto - SLIP10 derive input: either a seed blob or an extended parent key.
Traits§
- Keyring
Ext - Access managed
KeyringPluginstate fromtauri::App,tauri::AppHandle, ortauri::WebviewWindow.
Functions§
- init
- Registers the plugin with default options (
service= bundle identifier).