Struct InMemoryKeyStore 

pub struct InMemoryKeyStore { /* private fields */ }

Available on crate feature in-memory only.

A KeyStore holding its keys in memory.

Signs EdDSA, ES256 and (feature secp256k1) ES256K; generates and deletes. Keys are lost when the store is dropped, and zeroized then. Meant for tests, examples and development, not for production keys.

InMemoryKeyStore::with_seed makes key generation deterministic, so that a fixture’s keys, key ids and (for EdDSA and the RFC 6979 ECDSA signatures) signatures are stable across runs. A seeded store must never hold production keys: anyone with the seed has them.

The key id of a generated key is the spec’s label when set, the RFC 7638 thumbprint of its public key otherwise.

Examples

use identity_kit::jose::{JwsAlgorithm, KeyType};
use identity_kit::keys::{InMemoryKeyStore, KeySpec, KeyStore};

let store = InMemoryKeyStore::with_seed([7; 32]);
let key = store.generate(KeySpec::new(KeyType::Ed25519, JwsAlgorithm::EdDSA)).await?;
let signature = store.sign(&key, JwsAlgorithm::EdDSA, b"payload").await?;
assert_eq!(signature.len(), 64);

// The same seed gives the same key.
let again = InMemoryKeyStore::with_seed([7; 32]);
assert_eq!(again.generate(KeySpec::new(KeyType::Ed25519, JwsAlgorithm::EdDSA)).await?, key);

Implementations

impl InMemoryKeyStore

pub fn new() -> Self

An empty store generating keys from the operating system’s randomness.

pub fn with_seed(seed: [u8; 32]) -> Self

An empty store generating keys deterministically from seed.

The n-th key generated from a seed is always the same key. For fixtures only.

pub fn key_ids(&self) -> Vec<KeyId>

The ids of the keys in the store, in generation order.

pub fn is_seeded(&self) -> bool

Whether key generation is seeded.

Trait Implementations

impl Debug for InMemoryKeyStore

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for InMemoryKeyStore

fn default() -> Self

Returns the “default value” for a type.

impl KeyStore for InMemoryKeyStore

fn capabilities(&self) -> KeyStoreCapabilities

What this store can do.

fn public_jwk<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 KeyId, ) -> Pin<Box<dyn Future<Output = Result<Jwk, KeyStoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

The public key of key, without private parameters.

fn sign<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, key: &'life1 KeyId, alg: JwsAlgorithm, data: &'life2 [u8], ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, KeyStoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Signs data with key under alg, returning the signature in its JWS form.

fn exists<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 KeyId, ) -> Pin<Box<dyn Future<Output = Result<bool, KeyStoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Whether key exists.

fn generate<'life0, 'async_trait>( &'life0 self, spec: KeySpec, ) -> Pin<Box<dyn Future<Output = Result<KeyId, KeyStoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Generates a key as spec describes and returns its id.

fn delete<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 KeyId, ) -> Pin<Box<dyn Future<Output = Result<(), KeyStoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Deletes key.