Struct DidWeb 

pub struct DidWeb<C> { /* private fields */ }

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

The did:web method: a DidResolver fetching documents through an HttpClient, and a DidProducer building the document to publish.

Examples

use identity_kit::did::Did;
use identity_kit::methods::web::{DidWeb, HttpClient, HttpError, HttpResponse};
use identity_kit::resolver::Resolver;
use url::Url;

/// Serves one document from memory.
struct Static(String);

#[async_trait::async_trait]
impl HttpClient for Static {
    async fn get(&self, url: &Url) -> Result<HttpResponse, HttpError> {
        Ok(if url.as_str() == "https://example.com/.well-known/did.json" {
            HttpResponse::new(200, self.0.as_bytes())
        } else {
            HttpResponse::new(404, Vec::new())
        })
    }
}

let document = r#"{"id": "did:web:example.com"}"#.to_owned();
let resolver = Resolver::builder().with(DidWeb::new(Static(document))).build();
let did = Did::parse("did:web:example.com")?;
assert_eq!(resolver.resolve_document(&did).await?.id, did);

Implementations

impl<C: HttpClient> DidWeb<C>

pub const fn new(client: C) -> Self

The method fetching documents with client.

pub const fn client(&self) -> &C

The HTTP client.

Trait Implementations

impl<C: Clone> Clone for DidWeb<C>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug> Debug for DidWeb<C>

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

Formats the value using the given formatter.

impl<C: HttpClient> DidProducer for DidWeb<C>

type Params = Url

The HTTPS URL the document will be served under, as did_from_url reads it.

fn capabilities(&self) -> MethodCapabilities

Hosted on the web, any number of keys, updated by republishing; fragments come from the keys.

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

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

The document to publish at url for keys.

Each key becomes a JsonWebKey2020 verification method whose fragment is the key’s kid, or key-<index> when it has none. A key with use enc, or an X25519 key, is referenced from keyAgreement; every other key from authentication, assertionMethod, capabilityInvocation and capabilityDelegation. The document’s @context is CONTEXT.

Errors

• ProduceError::NoKeys without a key.
• ProduceError::InvalidParams when url has no did:web (see did_from_url).
• ProduceError::UnsupportedKey for a kid that is not a valid fragment.
• ProduceError::Document for two keys with the same kid.

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

The method name: web for did:web.

impl<C: HttpClient> DidResolver for DidWeb<C>

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,

Fetches the document of did from document_url and checks that its id is did.

Errors

• ResolutionError::InvalidDid when did has no document URL.
• ResolutionError::NotFound on a 404 or 410 response.
• ResolutionError::InternalError when the client fails or returns any other non-success status.
• ResolutionError::InvalidDidDocument when the body is not a DID document, or is the document of another DID.
• ResolutionError::RepresentationNotSupported for an accept that is not JSON.

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

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