Struct DomainLinkageConfiguration 

#[non_exhaustive]
pub struct DomainLinkageConfiguration {
    pub context: String,
    pub linked_dids: Vec<LinkedDid>,
}

Available on crate feature domain-linkage only.

The DID configuration resource: @context and the domain linkage credentials.

Examples

use identity_kit::domain_linkage::{DomainLinkageConfiguration, LinkedDid};
use serde_json::json;

let configuration: DomainLinkageConfiguration = serde_json::from_value(json!({
  "@context": "https://identity.foundation/.well-known/did-configuration/v1",
  "linked_dids": [
    "eyJhbGciOiJFZERTQSJ9.RXhhbXBsZSBvZiBFZDI1NTE5IHNpZ25pbmc.hgyY0il_MGCjP0JzlnLWG1PPOt7-09PGcvMg3AIbQR6dWbhijcNR4ki4iylGjg5BhVsPt9g7sVvpAr_MuM0KAg"
  ]
}))?;
assert_eq!(configuration.jwts().count(), 1);
assert!(serde_json::from_value::<DomainLinkageConfiguration>(json!({
  "@context": "https://example.com/other", "linked_dids": []
})).is_err());

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.

context: String

@context, CONTEXT.

linked_dids: Vec<LinkedDid>

The domain linkage credentials, one per linked DID.

Implementations

impl DomainLinkageConfiguration

pub fn new() -> Self

An empty configuration.

pub fn with_credential(self, credential: Jwt) -> Self

This configuration with credential added.

pub fn jwts(&self) -> impl Iterator<Item = (usize, &Jwt)>

The credentials in the JSON Web Token proof format, with their positions.

pub fn entries( &self, ) -> impl Iterator<Item = (usize, Result<UnverifiedLinkage, DomainLinkageError>)> + '_

The credentials in the JSON Web Token proof format, with their positions, each read without verifying it (UnverifiedLinkage::from_jwt), or why it does not read. Linked Data Proof entries are not among them.

For the controller of the origin, maintaining the configuration it publishes; a verifier validates with DomainLinkageValidator.

pub fn earliest_expiry(&self) -> Option<DateTime<Utc>>

The earliest expiry among the JWT credentials that read (entries), or None when none reads or none expires: when the configuration needs renewing at the latest.

pub fn remove_origin( &mut self, origin: &Url, ) -> Result<usize, DomainLinkageError>

Removes the JWT credentials linking origin, compared normalized (normalize_origin), and returns how many it removed. Credentials that do not read (entries) and Linked Data Proof entries are kept; remove them from linked_dids directly.

Errors

DomainLinkageError::InvalidOrigin when origin has no host.

pub fn check(&self) -> Result<(), DomainLinkageError>

Checks that @context is CONTEXT.

Errors

DomainLinkageError::InvalidContext.

Trait Implementations

impl Clone for DomainLinkageConfiguration

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 DomainLinkageConfiguration

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

Formats the value using the given formatter.

impl Default for DomainLinkageConfiguration

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DomainLinkageConfiguration

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for DomainLinkageConfiguration

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

Formats the value using the given formatter.

impl Eq for DomainLinkageConfiguration

impl PartialEq for DomainLinkageConfiguration

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

Equality operator ==.

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

Inequality operator !=.

impl PartialSchema for DomainLinkageConfiguration

Available on crate feature utoipa only.

fn schema() -> RefOr<Schema>

Return ref or schema of implementing type that can then be used to construct combined schemas.

impl Serialize for DomainLinkageConfiguration

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DomainLinkageConfiguration

impl ToSchema for DomainLinkageConfiguration

Available on crate feature utoipa only.

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.