Struct KeyStoreCapabilities 

#[non_exhaustive]
pub struct KeyStoreCapabilities {
    pub can_generate: bool,
    pub can_delete: bool,
    pub remote: bool,
    pub algorithms: Vec<JwsAlgorithm>,
}

What a KeyStore can do.

A backend’s declaration must be truthful: every algorithm listed signs, and generate and delete succeed only when advertised. testsuite checks both directions.

Examples

use identity_kit::jose::JwsAlgorithm;
use identity_kit::keys::KeyStoreCapabilities;

let hsm = KeyStoreCapabilities::new([JwsAlgorithm::ES256, JwsAlgorithm::RS256]).remote();
assert!(hsm.supports(JwsAlgorithm::ES256));
assert!(!hsm.supports(JwsAlgorithm::EdDSA));
assert!(!hsm.can_generate && !hsm.can_delete && hsm.remote);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

can_generate: bool

Whether KeyStore::generate is implemented.

can_delete: bool

Whether KeyStore::delete is implemented.

remote: bool

Whether signing leaves the process (an HSM, a network service), so that callers should expect latency and transient failures.

algorithms: Vec<JwsAlgorithm>

The algorithms the store signs with, without duplicates.

Implementations

impl KeyStoreCapabilities

pub fn new(algorithms: impl IntoIterator<Item = JwsAlgorithm>) -> Self

A local store that signs with algorithms and can neither generate nor delete.

pub fn with_generate(self) -> Self

With can_generate set.

pub fn with_delete(self) -> Self

With can_delete set.

pub fn remote(self) -> Self

With remote set.

pub fn supports(&self, alg: JwsAlgorithm) -> bool

Whether the store signs with alg.

Trait Implementations

impl Clone for KeyStoreCapabilities

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KeyStoreCapabilities

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

Formats the value using the given formatter.

impl Eq for KeyStoreCapabilities

impl PartialEq for KeyStoreCapabilities

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for KeyStoreCapabilities