Skip to main content

DocumentKeyResolver

Struct DocumentKeyResolver 

Source
pub struct DocumentKeyResolver { /* private fields */ }
Expand description

Resolves a KeyReference::DidUrl against DID documents supplied by the caller, without resolving the DID again: a document resolved to read its services, or one the caller fetched or publishes itself.

A DID URL of one of the documents’ DIDs resolves to the verification method its fragment names, which must be usable for the relationship of the role, as Resolver would: publicKeyJwk as it is, publicKeyMultibase decoded as a Multikey. Every other reference is Unsupported, so that a CompositeKeyResolver tries the next resolver: a DID URL of another DID, and one with a path or query, such as a versionId, which names a document other than the one supplied.

§Examples

The caller supplies a presentation’s holder document; issuers’ keys still resolve over the network.

use identity_kit::did::{DidDocument, DidUrl};
use identity_kit::jose::Jwk;
use identity_kit::methods::DidKey;
use identity_kit::resolver::{
    CompositeKeyResolver, DocumentKeyResolver, KeyReference, KeyResolver as _, KeyRole,
    Resolver,
};

// The holder's `did:web` document, already resolved; its key is RFC 7515 Appendix A.3's.
let holder: DidDocument = serde_json::from_str(r##"{
  "id": "did:web:holder.example",
  "verificationMethod": [{
    "id": "did:web:holder.example#key-1",
    "type": "JsonWebKey",
    "controller": "did:web:holder.example",
    "publicKeyJwk": {
      "kty": "EC", "crv": "P-256",
      "x": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU",
      "y": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0"
    }
  }],
  "authentication": ["#key-1"]
}"##)?;
let resolver = CompositeKeyResolver::new()
    .with(DocumentKeyResolver::new(holder))
    .with(Resolver::builder().with(DidKey::default()).build());

let holder_key = KeyReference::DidUrl("did:web:holder.example#key-1".parse()?);
let jwk = resolver.resolve_key(&holder_key, KeyRole::Subject).await?;
assert_eq!(jwk.kty(), "EC");
// Listed under `authentication` only: not a key the holder issues with.
assert!(resolver.resolve_key(&holder_key, KeyRole::Issuer).await.is_err());

// An issuer's `did:key` falls through to the `Resolver`: RFC 8037 Appendix A.2's key.
let issuer = DidKey::did(&serde_json::from_str::<Jwk>(
    r#"{"kty":"OKP","crv":"Ed25519","x":"11qYAYKxCrfVS_7TyWQHOg7hcvPapiMlrwIaaPcHURo"}"#,
)?)?;
let issuer_key: DidUrl = issuer.join(&format!("#{}", issuer.method_specific_id()))?;
assert!(resolver.resolve_key(&KeyReference::DidUrl(issuer_key), KeyRole::Issuer).await.is_ok());

Implementations§

Source§

impl DocumentKeyResolver

Source

pub fn new(document: DidDocument) -> Self

A resolver over document.

Source

pub fn with(self, document: DidDocument) -> Self

This resolver over document as well. A document of a DID already supplied replaces the earlier one.

Source

pub fn documents(&self) -> &[DidDocument]

The documents it resolves against.

Trait Implementations§

Source§

impl Clone for DocumentKeyResolver

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DocumentKeyResolver

Source§

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

Formats the value using the given formatter. Read more
Source§

impl KeyResolver for DocumentKeyResolver

Source§

fn resolve_key<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 KeyReference, role: KeyRole, ) -> Pin<Box<dyn Future<Output = Result<Jwk, KeyResolutionError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

The public key key names, usable in role. Read more
Source§

impl PartialEq for DocumentKeyResolver

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for DocumentKeyResolver

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more