Module credential

Verifiable Credentials

Specification

Modules

• status_list_2021
  Implementation of StatusList2021.
• validity_timeframe_2024
  Implementation of a new Revocation mechanism for ZK Verifiable Credentials.

Structs

• CompoundCredentialValidationError
  Errors caused by a failure to validate a Credential.
• CompoundJwtPresentationValidationError
  Errors caused by a failure to validate a Presentation.
• Credential
  Represents a set of claims describing an entity.
• CredentialBuilder
  A CredentialBuilder is used to create a customized Credential.
• DecodedJptCredential
  Decoded Credential from a cryptographically verified JWP.
• DecodedJptPresentation
  Decoded Credential from a cryptographically verified JWP.
• DecodedJwtCredential
  Decoded Credential from a cryptographically verified JWS.
• DecodedJwtPresentation
  Decoded Presentation from a cryptographically verified JWS.
• DomainLinkageConfiguration
  DID Configuration Resource which contains Domain Linkage Credentials.
• DomainLinkageCredentialBuilder
  Convenient builder to create a spec compliant Domain Linkage Credential.
• DomainLinkageValidationError
  An error caused by a failure to verify a Domain Linkage configuration or credential.
• Evidence
  Information used to increase confidence in the claims of a Credential
• Jpt
  This JSON Proof Token could represent a JWP both in the Issued and Presented forms.
• JptCredentialValidationOptions
  Options to declare validation criteria for Credentials.
• JptCredentialValidator
  A type for decoding and validating Credentials in JPT format.
• JptCredentialValidatorUtils
  Utility functions for verifying JPT credentials.
• JptPresentationValidationOptions
  Criteria for validating a Presentation.
• JptPresentationValidator
  A type for decoding and validating Presented Credentials in JPT format.
• JptPresentationValidatorUtils
  Utility functions for verifying JPT credentials.
• JwpCredentialOptions
  Options for creating a JSON Web Proof.
• JwpPresentationOptions
  Options to be set in the JWT claims of a verifiable presentation.
• Jws
  A wrapper around a JSON Web Signature (JWS).
• Jwt
  A wrapper around a JSON Web Token (JWK).
• JwtCredential
  A JWT representing a Verifiable Credential.
• JwtCredentialValidationOptions
  Options to declare validation criteria for Credentials.
• JwtCredentialValidator
  A type for decoding and validating Credentials.
• JwtCredentialValidatorUtils
  Utility functions for verifying JWT credentials.
• JwtDomainLinkageValidator
  A validator for a Domain Linkage Configuration and Credentials.
• JwtPresentationOptions
  Options to be set in the JWT claims of a verifiable presentation.
• JwtPresentationValidationOptions
  Criteria for validating a Presentation.
• JwtPresentationValidator
  Struct for validating Presentation.
• JwtPresentationValidatorUtils
  Utility functions for verifying JWT presentations.
• KeyBindingJWTValidationOptions
  Criteria for validating a Key Binding JWT (KB-JWT).
• LinkedDomainService
  A service wrapper for a Linked Domain Service Endpoint.
• LinkedVerifiablePresentationService
  A service wrapper for a Linked Verifiable Presentation Service Endpoint.
• Policy
  Information used to express obligations, prohibitions, and permissions about a Credential or Presentation.
• Presentation
  Represents a bundle of one or more Credentials.
• PresentationBuilder
  A PresentationBuilder is used to create a customized Presentation.
• Proof
  Represents a cryptographic proof that can be used to validate verifiable credentials and presentations.
• RefreshService
  Information used to refresh or assert the status of a Credential.
• RevocationBitmap
  A compressed bitmap for managing credential revocation.
• RevocationBitmapStatus
  Information used to determine the current status of a Credential using the RevocationBitmap2022 specification.
• RevocationTimeframeStatus
  Information used to determine the current status of a Credential
• Schema
  Information used to validate the structure of a Credential.
• SdJwtCredentialValidator
  A type for decoding and validating SdJwts.
• SelectiveDisclosurePresentation
  Used to construct a JwpPresentedBuilder and handle the selective disclosure of attributes.
• Status
  Information used to determine the current status of a Credential.
• Subject
  An entity who is the target of a set of claims.
• VerifierRevocationTimeframeStatus
  Verifier

Enums

• DomainLinkageValidationErrorCause
  The causes for why domain linkage validation can fail.
• Error
  This type represents errors that can occur when constructing credentials and presentations or their serializations.
• FailFast
  Declares when validation should return if an error occurs.
• Issuer
  An identifier representing the issuer of a Credential.
• JwtValidationError
  An error associated with validating credentials and presentations.
• KeyBindingJwtError
  An error associated with validating KB-JWT.
• RevocationError
  Errors occurring when creating or extracting a Service of type RevocationBitmap2022
• SignerContext
  Specifies whether an error is related to a credential issuer or the presentation holder.
• StatusCheck
  Controls validation behaviour when checking whether or not a credential has been revoked by its credentialStatus.
• SubjectHolderRelationship
  Declares how credential subjects must relate to the presentation holder during validation.

Traits

• RevocationDocumentExt
  Extension trait providing convenience methods to update a RevocationBitmap2022 service in a CoreDocument.

Functions

• try_index_to_u32
  Attempts to convert the given index string to a u32.

Type Aliases

• Result
  Alias for a Result with the error type Error.
• RevocationResult
  A result type designed for RevocationBitmap2022 handling.