Getting started

Introduction

What tauri-plugin-keyring-store does, how it stores data, and how it relates to tauri-plugin-stronghold.

tauri-plugin-keyring-store keeps secrets in the credential store of the operating system: macOS Keychain, Windows Credential Manager, Linux Secret Service, the Android keystore and the iOS data-protection keychain. It is built on keyring-core 1.x and the official backend crates for each platform.

Two packages:

PackageWhereWhat
tauri-plugin-keyring-storesrc-tauriThe plugin, Tauri commands and the Rust KeyringStore.
tauri-plugin-keyring-store-apifrontendThe JavaScript API.

Two APIs in one plugin

Password accounts. getPasswords, setPasswords, … read and write UTF-8 secrets by an account name you choose (app.api_token). One account is one OS keyring entry under your app's service name. Backups can be exported in plain text or encrypted with a passphrase.

Stronghold-shaped sessions. KeyringSession, KeyringClient, the store and the vault mirror the API of tauri-plugin-stronghold, including the SLIP10 / BIP39 / Ed25519 procedures. The names you pass (session path, client, vault, record) are hashed into account names of the form kp:v1:….

What is different from Stronghold

There is no snapshot file. Every record is written to the OS store at once, save() writes nothing, and the session password is not used for encryption: the OS store and the plugin permissions protect the data. See Coming from Stronghold.

Where to go next