Struct KeyRing 

pub struct KeyRing { /* private fields */ }

A keyring that maps identifiers to public keys. Used in web-bot-auth to retrieve verifying keys for verificiation.

Implementations

impl KeyRing

pub fn import_raw( &mut self, identifier: String, algorithm: Algorithm, public_key: Vec<u8>, ) -> bool

Insert a raw public key under a known identifier. If an identifier is already known, it will not be updated and this method will return false.

pub fn rename_key( &mut self, old_identifier: String, new_identifier: String, ) -> bool

Rename a public key from old_identifier to new_identifier. Returns false if the old key was not present.

pub fn get(&self, identifier: &String) -> Option<&(Algorithm, Vec<u8>)>

Retrieve a key. Semantics are identical to HashMap::get.

pub fn try_import_jwk( &mut self, jwk: &Thumbprintable, ) -> Result<(), KeyringError>

Import a single JSON Web Key. This method is fallible.

Errors

Unsupported keys will not be imported, as will keys that failed to be inserted

pub fn import_jwks(&mut self, jwks: JSONWebKeySet) -> Vec<Option<KeyringError>>

Import a JSON Web Key Set on a best-effort basis. This method returns a vector indicating whether or not the corresponding key in the key set could be imported.

Trait Implementations

impl Clone for KeyRing

fn clone(&self) -> KeyRing

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyRing

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

Formats the value using the given formatter.

impl Default for KeyRing

fn default() -> KeyRing

Returns the “default value” for a type.

impl FromIterator<(String, (Algorithm, Vec<u8>))> for KeyRing

fn from_iter<T: IntoIterator<Item = (String, (Algorithm, PublicKey))>>( iter: T, ) -> KeyRing

Creates a value from an iterator.