Skip to main content

Crate tauri_plugin_keyring_store

Crate tauri_plugin_keyring_store 

Source
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 KeyringPlugin before mounting (service name defaults to the app identifier).
DurationDto
Stronghold-compatible duration (ignored for OS keyring persistence).
KeyringPlugin
Root plugin state registered with Tauri (tauri::Manager::manage).
KeyringStore
OS-backed credential storage scoped to one service identifier (bundle id / custom).
PasswordBackupEncryptedDto
Argon2id + ChaCha20-Poly1305 backup envelope (always built).
PasswordBackupEntryDto
Single entry in a plaintext password backup (export/import).
PasswordBackupPlainDto
Plaintext backup blob shared by export/import JSON over IPC.
PasswordEntryDto
One row for the bulk set passwords IPC command (account + plaintext secret).
PingRequest
IPC ping request (health / round-trip).
PingResponse
IPC ping response.
SessionRegistry
Managed snapshot sessions (Stronghold-compatible “initialized paths”).

Enums§

BytesDto
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 PublicKey procedure (string JSON: ed25519 / x25519).
LocationDto
Logical storage location inside a snapshot (vault + record or counter row).
ProcedureDto
Stronghold-shaped crypto or signing operation (requires the crypto crate feature).
Slip10DeriveInputDto
SLIP10 derive input: either a seed blob or an extended parent key.

Traits§

KeyringExt
Access managed KeyringPlugin state from tauri::App, tauri::AppHandle, or tauri::WebviewWindow.

Functions§

init
Registers the plugin with default options (service = bundle identifier).

Type Aliases§

Result
Result alias using this crate’s Error.