Crate keyring_core 

Keyring-core

This crate provides a cross-platform library that supports storage and retrieval of passwords (or other secrets) in a variety of secure credential stores. Please see this document for an introduction to the keyring ecosystem and this document for a comprehensive treatment of this crate’s APIs.

This crate provides two cross-platform credential stores. These are provided to support client testing and as a guide for developers who would like to build keyring-compatible credential store modules. The stores in this crate are explicitly not warranted to be either secure or robust. See the mock and sample modules for details. (Note: the sample module is only built if the sample feature is specified.)

Thread Safety

While this crate’s code is thread-safe, and requires credential store objects to be both Send and Sync, the underlying credential stores may not handle access to a single credential from different threads reliably. See the documentation of each credential store for details.

Re-exports

pub use api::Credential;

pub use api::CredentialPersistence;

pub use api::CredentialStore;

pub use error::Error;

pub use error::Result;

Modules

api

Platform-independent secure storage model

attributes

Utility functions for attribute maps

error

Platform-independent error model.

mock

Mock credential store

sample

Sample Credential Store

Structs

Entry

A named entry in a credential store.

Functions

get_default_store

Get the default credential store.

set_default_store

Set the credential store used by default to create entries.

unset_default_store

Release the default credential store.