Struct DidKey 

pub struct DidKey { /* private fields */ }

Available on crate feature did-key and (crate features did-jwk or did-key or did-web) only.

The did:key method: a DidResolver that expands the DID and a DidProducer that encodes one public key.

The resolver’s options are those the specification defines: the KeyFormat (publicKeyFormat) and whether to derive an X25519 key agreement method from an Ed25519 key (enableEncryptionKeyDerivation). Both are set here as defaults and may be overridden per resolution through ResolutionOptions::properties under those names, with a string and a boolean respectively.

Examples

use identity_kit::did::Did;
use identity_kit::jose::Jwk;
use identity_kit::methods::DidKey;
use identity_kit::methods::key::KeyFormat;

let jwk: Jwk = serde_json::from_str(
    r#"{"kty":"OKP","crv":"Ed25519","x":"Lm_M42cB3HkUiODQsXRcweM6TByfzEHGO9ND274JcOY"}"#,
)?;
let did = DidKey::did(&jwk)?;
assert_eq!(did.as_str(), "did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK");

let document = DidKey::new().with_format(KeyFormat::JsonWebKey).document(&did)?;
let method = &document.verification_method[0];
assert_eq!(method.id.fragment(), Some("z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK"));
assert_eq!(method.public_key_jwk(), Some(&jwk));

Implementations

impl DidKey

pub const METHOD: &'static str = "key"

The method name, key.

pub const MAX_DID_LEN: usize

The longest did:key this method can produce: the verification method id did#multikey repeats the Multikey string, and must fit DEFAULT_MAX_LEN bytes.

pub const CONTEXT: [&'static str; 1]

The @context of every did:key document.

pub const fn new() -> Self

The method with KeyFormat::Multikey and no key agreement derivation.

pub const fn with_format(self, format: KeyFormat) -> Self

This method expressing keys as format.

pub const fn with_key_agreement(self, derive: bool) -> Self

This method deriving an X25519 key agreement method from an Ed25519 key when derive is set (enableEncryptionKeyDerivation). The derived method is embedded under keyAgreement, as in the specification’s examples.

pub const fn format(&self) -> KeyFormat

The key format.

pub const fn key_agreement(&self) -> bool

Whether an X25519 key agreement method is derived from an Ed25519 key.

pub fn did(jwk: &Jwk) -> Result<Did, DidKeyError>

The did:key of the public part of jwk.

Errors

• DidKeyError::Key with the errors of Jwk::to_multikey: an unsupported key type or undecodable material.
• DidKeyError::TooLong when the Multikey string is so long that the DID exceeds MAX_DID_LEN bytes, as a very large RSA key is; base58btc is otherwise valid DID syntax.

pub fn document(&self, did: &Did) -> Result<DidDocument, ResolutionError>

The DID document did expands to with this method’s options (the method’s Read operation).

Errors

A ResolutionError whose kind is:

• MethodNotSupported when did is not a did:key.
• InvalidDid when the method-specific id is not a Multikey string (optionally preceded by a positive integer version) with a known multicodec header, or the DID is so long that the verification method id did#multikey would not fit DEFAULT_MAX_LEN bytes.
• Other with the method’s own error names otherwise: unsupportedPublicKeyType for a key type this crate cannot read, invalidPublicKeyLength when the raw key has the wrong length, and invalidPublicKey when it is not a valid key.

A failure to decode the Multikey string has the JwkError as its source.

Trait Implementations

impl Clone for DidKey

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DidKey

impl Debug for DidKey

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

Formats the value using the given formatter.

impl Default for DidKey

fn default() -> Self

Returns the “default value” for a type.

impl DidProducer for DidKey

fn capabilities(&self) -> MethodCapabilities

Embedded, one key, never updated; the fragment is the Multikey string of the key.

fn produce<'life0, 'life1, 'async_trait>( &'life0 self, keys: &'life1 [Jwk], __arg2: (), ) -> Pin<Box<dyn Future<Output = Result<DidDocument, ProduceError>> + Send + 'async_trait>>

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

The document of DidKey::did for the one key in keys, with this method’s options.

type Params = ()

Method-specific parameters.

fn method(&self) -> &'static str

The method name: web for did:web.

impl DidResolver for DidKey

fn resolve<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, did: &'life1 Did, options: &'life2 ResolutionOptions, ) -> Pin<Box<dyn Future<Output = Result<ResolutionResult, ResolutionError>> + Send + 'async_trait>>

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

Expands did with DidKey::document, with the publicKeyFormat and enableEncryptionKeyDerivation options of options overriding this method’s defaults.

fn method(&self) -> &'static str

The method name this resolver handles: web for did:web.

impl Eq for DidKey

impl Hash for DidKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DidKey

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DidKey