Struct KeySigner 

pub struct KeySigner<'a> { /* private fields */ }

A Signer over one key of a KeyStore.

The signer looks the key up once, when it is created, and keeps the public Jwk so that a caller building a DID document or a JWS header never round-trips to the store for it (KeySigner::public_jwk). Signing goes to the store on every call.

Signer::kid is the key id, unless KeySigner::with_kid set another value, such as the DID URL of the verification method the key backs.

Examples

use identity_kit::jose::{CompactJws, DefaultVerifier, JwsAlgorithm, JwsHeader, KeyType, encode_compact};
use identity_kit::keys::{InMemoryKeyStore, KeySigner, KeySpec, KeyStore};

let store = InMemoryKeyStore::new();
let key = store.generate(KeySpec::new(KeyType::Ed25519, JwsAlgorithm::EdDSA)).await?;
let signer = KeySigner::new(&store, key, JwsAlgorithm::EdDSA).await?;

let header = JwsHeader::new(JwsAlgorithm::EdDSA).with_kid(signer.key_id().as_str());
let token = encode_compact(&header, b"{}", &signer).await?;
let jws = CompactJws::decode(&token)?;
jws.verify(&DefaultVerifier, signer.public_jwk())?;

Implementations

impl<'a> KeySigner<'a>

pub async fn new( store: &'a dyn KeyStore, key: KeyId, alg: JwsAlgorithm, ) -> Result<Self, KeyStoreError>

A signer over key of store, signing with alg.

Errors

KeyStoreError::UnsupportedAlgorithm when the store does not advertise alg, KeyStoreError::NotFound when the key does not exist, KeyStoreError::AlgorithmMismatch when the key’s public JWK names another algorithm, and whatever else the store reports.

pub fn with_kid(self, kid: impl Into<String>) -> Self

This signer with Signer::kid set to kid instead of the key id.

pub fn store(&self) -> &'a dyn KeyStore

The store the key lives in.

pub fn key_id(&self) -> &KeyId

The key this signer signs with.

pub fn public_jwk(&self) -> &Jwk

The public key, as the store reported it when the signer was created.

Trait Implementations

impl Debug for KeySigner<'_>

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

Formats the value using the given formatter.

impl Signer for KeySigner<'_>

fn alg(&self) -> JwsAlgorithm

The algorithm every signature of this signer uses.

fn kid(&self) -> Option<&str>

The key id to put in a header, if the signer has one.

fn sign<'life0, 'life1, 'async_trait>( &'life0 self, signing_input: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, SignError>> + Send + 'async_trait>>

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

Signs signing_input.