identity_credential/domain_linkage/
error.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
// Copyright 2020-2023 IOTA Stiftung
// SPDX-License-Identifier: Apache-2.0

use std::error::Error;

pub(crate) type DomainLinkageValidationResult = Result<(), DomainLinkageValidationError>;

/// An error caused by a failure to verify a Domain Linkage configuration or credential.
#[derive(Debug, thiserror::Error)]
pub struct DomainLinkageValidationError {
  /// Cause of the error.
  pub cause: DomainLinkageValidationErrorCause,
  /// Source of the error.
  pub source: Option<Box<dyn Error + Send + Sync + 'static>>,
}

impl std::fmt::Display for DomainLinkageValidationError {
  fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
    write!(f, "{}", self.cause)
  }
}

impl From<DomainLinkageValidationError> for &str {
  fn from(value: DomainLinkageValidationError) -> Self {
    value.cause.into()
  }
}

/// The causes for why domain linkage validation can fail.
#[derive(Debug, thiserror::Error, strum::IntoStaticStr)]
#[non_exhaustive]
pub enum DomainLinkageValidationErrorCause {
  /// Caused when a Domain Linkage Credential cannot be successfully validated.
  #[error("invalid credential")]
  CredentialValidationError,
  /// Caused by an invalid JWT.
  #[error("invalid JWT")]
  InvalidJwt,
  /// Caused by a missing expiration date.
  #[error("the expiration date is missing")]
  MissingExpirationDate,
  /// Caused by the presence of an id property on a Domain Linkage Credential.
  #[error("id property is not allowed")]
  ImpermissibleIdProperty,
  /// Caused by a mismatch of the issuer and subject of the Domain Linkage Credential.
  #[error("issuer DID does not match the subject")]
  IssuerSubjectMismatch,
  /// Caused by an invalid Domain Linkage Credential subject.
  #[error("subject id is invalid")]
  InvalidSubjectId,
  /// Caused by the presence of multiple subjects on a Domain Linkage Credential.
  #[error("credential contains multiple subjects")]
  MultipleCredentialSubjects,
  /// Caused by an invalid issuer DID.
  #[error("invalid issuer DID")]
  InvalidIssuer,
  /// Caused by a missing id property on the Domain Linkage Credential subject.
  #[error("subject id property is missing")]
  MissingSubjectId,
  /// Caused by an invalid `type` property on the Domain Linkage Credential.
  #[error("credential type is invalid")]
  InvalidTypeProperty,
  /// Caused by a mismatch between the Domain Linkage Credential subject's origin and the provided domain origin.
  #[error("the subject's origin does not match the provided domain origin")]
  OriginMismatch,
  /// Caused by a missing or invalid Domain Linkage Credential subject's origin.
  #[error("the subject's origin property is either invalid or missing")]
  InvalidSubjectOrigin,
  /// Caused by an invalid semantic structure of the Domain Linkage Configuration.
  #[error("invalid semantic structure of the domain linkage configuration")]
  InvalidStructure,
}