Struct KeySpec 

#[non_exhaustive]
pub struct KeySpec {
    pub key_type: KeyType,
    pub alg: JwsAlgorithm,
    pub label: Option<String>,
}

What to generate: a key type, the one algorithm the key will sign with, and an optional label.

The algorithm must fit the key type (KeySpec::validate); backends reject a spec that does not. How a backend uses the label is its own business; the software backends use it as the key id when set and the RFC 7638 thumbprint of the public key otherwise.

Examples

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

let spec = KeySpec::new(KeyType::P256, JwsAlgorithm::ES256).with_label("issuer");
assert!(spec.validate().is_ok());

let wrong = KeySpec::new(KeyType::P256, JwsAlgorithm::EdDSA);
assert!(matches!(wrong.validate(), Err(KeyStoreError::InvalidSpec { .. })));

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.

key_type: KeyType

The kind of key.

alg: JwsAlgorithm

The algorithm the key signs with.

label: Option<String>

A label for the backend: the key id for the software backends, a PKCS#11 label, a display name.

Implementations

impl KeySpec

pub fn new(key_type: KeyType, alg: JwsAlgorithm) -> Self

A spec without a label.

pub fn with_label(self, label: impl Into<String>) -> Self

This spec with a label.

pub fn validate(&self) -> Result<(), KeyStoreError>

Checks that the algorithm fits the key type.

Errors

KeyStoreError::InvalidSpec when it does not: EdDSA needs an Ed25519 key, ES256 a P-256 key, ES256K a secp256k1 key and RS256 or PS256 an RSA key. ES384 fits no KeyType this crate has.

Trait Implementations

impl Clone for KeySpec

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 KeySpec

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

Formats the value using the given formatter.

impl Eq for KeySpec

impl PartialEq for KeySpec

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for KeySpec