Struct DomainLinkageClient 

pub struct DomainLinkageClient<C, R, V = DefaultVerifier> { /* private fields */ }

Available on crate feature domain-linkage only.

Fetches DID configuration resources with an HttpClient and validates them with a DomainLinkageValidator: for an origin, for one DID at an origin, or for every origin a DID document lists.

Origins come from callers and from DID documents, so the client fetches whatever a DID controller names, and validating a whole configuration resolves every DID it names: http, and the did:web client of the resolver, must enforce the protections ReqwestClient (feature reqwest) does (HTTPS only, no redirects, no non-public addresses after name resolution, a body limit and a timeout), or fetching becomes a request forgery primitive. A DID document can also list any number of origins, so validate_document fetches at most max_origins of them.

Implementations

impl<C, R, V> DomainLinkageClient<C, R, V>

pub const DEFAULT_MAX_ORIGINS: usize = 32

The most origins new fetches for one DID document: 32.

impl<C: HttpClient, R: KeyResolver, V: JwsVerifier> DomainLinkageClient<C, R, V>

pub fn new(http: C, validator: DomainLinkageValidator<R, V>) -> Self

A client fetching with http and validating with validator, fetching at most DEFAULT_MAX_ORIGINS origins of a DID document.

pub fn with_max_origins(self, max_origins: usize) -> Self

This client fetching at most max_origins origins of a DID document.

pub fn max_origins(&self) -> usize

The most origins validate_document fetches for one document.

pub fn http(&self) -> &C

The HTTP client.

pub fn validator(&self) -> &DomainLinkageValidator<R, V>

The validator.

pub async fn fetch_configuration( &self, origin: &Url, ) -> Result<DomainLinkageConfiguration, DomainLinkageError>

The DID configuration resource of origin, unvalidated.

Errors

As fetch_configuration.

pub async fn validate_origin( &self, origin: &Url, options: &CredentialValidationOptions, ) -> Result<DomainLinkageReport, DomainLinkageError>

Fetches the configuration of origin and validates every JWT entry, as DomainLinkageValidator::validate_configuration.

Errors

As fetch_configuration and validate_configuration.

pub async fn validate_linkage( &self, did: &Did, origin: &Url, options: &CredentialValidationOptions, ) -> Result<DecodedCredential, DomainLinkageError>

Fetches the configuration of origin and validates the credential linking did, as DomainLinkageValidator::validate_linkage. Only did is resolved.

Errors

As fetch_configuration and validate_linkage.

pub async fn validate_document( &self, document: &DidDocument, options: &CredentialValidationOptions, ) -> Vec<LinkedDomainReport>

Validates the linkage of the DID of document to every origin of its LinkedDomains services: one report per origin in document order, and one for each invalid service entry. Origins past the first max_origins are not fetched and report DomainLinkageError::TooManyOrigins.

impl<C: HttpClient, V: JwsVerifier> DomainLinkageClient<C, Resolver, V>

pub async fn validate_did( &self, did: &Did, options: &CredentialValidationOptions, ) -> Result<Vec<LinkedDomainReport>, DomainLinkageError>

Resolves did with the validator’s resolver, then validates its linkage to every origin its document lists, as validate_document.

Errors

DomainLinkageError::Resolution when did does not resolve to a document.

Trait Implementations

impl<C: Debug, R: Debug, V: Debug> Debug for DomainLinkageClient<C, R, V>

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

Formats the value using the given formatter.