Struct Credential

pub struct Credential {

    pub context: Contexts,
    pub id: Option<StringOrURI>,
    pub type_: OneOrMany<String>,
    pub credential_subject: OneOrMany<CredentialSubject>,
    pub issuer: Option<Issuer>,
    pub issuance_date: Option<VCDateTime>,
    pub proof: Option<OneOrMany<Proof>>,
    pub expiration_date: Option<VCDateTime>,
    pub credential_status: Option<Status>,
    pub terms_of_use: Option<Vec<TermsOfUse>>,
    pub evidence: Option<OneOrMany<Evidence>>,
    pub credential_schema: Option<OneOrMany<Schema>>,
    pub refresh_service: Option<OneOrMany<RefreshService>>,
    pub property_set: Option<HashMap<String, Value>>,
}

Fields

context: Contexts

id: Option<StringOrURI>

type_: OneOrMany<String>

credential_subject: OneOrMany<CredentialSubject>

issuer: Option<Issuer>

issuance_date: Option<VCDateTime>

proof: Option<OneOrMany<Proof>>

expiration_date: Option<VCDateTime>

credential_status: Option<Status>

terms_of_use: Option<Vec<TermsOfUse>>

evidence: Option<OneOrMany<Evidence>>

credential_schema: Option<OneOrMany<Schema>>

refresh_service: Option<OneOrMany<RefreshService>>

property_set: Option<HashMap<String, Value>>

Implementations

impl Credential

pub fn from_json(s: &str) -> Result<Credential, Error>

pub fn from_json_unsigned(s: &str) -> Result<Credential, Error>

pub fn from_jwt_keys(jwt: &str, keys: &JWTKeys) -> Result<Credential, Error>

👎Deprecated: Use decode_verify_jwt

pub fn from_jwt(jwt: &str, key: &JWK) -> Result<Credential, Error>

pub fn from_jwt_unsigned(jwt: &str) -> Result<Credential, Error>

pub fn from_jwt_claims(claims: JWTClaims) -> Result<Credential, Error>

pub fn to_jwt_claims(&self) -> Result<JWTClaims, Error>

pub fn encode_jwt_unsigned(&self, aud: &str) -> Result<String, Error>

👎Deprecated: Use generate_jwt

pub fn encode_sign_jwt( &self, keys: &JWTKeys, aud: &str, ) -> Result<String, Error>

👎Deprecated: Use generate_jwt

pub async fn generate_jwt( &self, jwk: Option<&JWK>, options: &LinkedDataProofOptions, resolver: &dyn DIDResolver, ) -> Result<String, Error>

Encode the Verifiable Credential as JWT. If JWK is passed, sign it, otherwise it is unsigned. Linked data proof options are translated into JWT claims if possible.

pub async fn verify_jwt( jwt: &str, options_opt: Option<LinkedDataProofOptions>, resolver: &dyn DIDResolver, context_loader: &mut ContextLoader, ) -> VerificationResult

pub async fn decode_verify_jwt( jwt: &str, options_opt: Option<LinkedDataProofOptions>, resolver: &dyn DIDResolver, context_loader: &mut ContextLoader, ) -> (Option<Credential>, VerificationResult)

pub fn validate_unsigned(&self) -> Result<(), Error>

pub fn is_zkp(&self) -> bool

pub fn validate(&self) -> Result<(), Error>

pub async fn verify( &self, options: Option<LinkedDataProofOptions>, resolver: &dyn DIDResolver, context_loader: &mut ContextLoader, ) -> VerificationResult

pub async fn generate_proof( &self, jwk: &JWK, options: &LinkedDataProofOptions, resolver: &dyn DIDResolver, context_loader: &mut ContextLoader, ) -> Result<Proof, Error>

pub async fn prepare_proof( &self, public_key: &JWK, options: &LinkedDataProofOptions, resolver: &dyn DIDResolver, context_loader: &mut ContextLoader, ) -> Result<ProofPreparation, Error>

Prepare to generate a linked data proof. Returns the signing input for the caller to sign and then pass to [ProofPreparation::complete] to complete the proof.

pub fn add_proof(&mut self, proof: Proof)

pub async fn check_status( &self, resolver: &dyn DIDResolver, context_loader: &mut ContextLoader, ) -> VerificationResult

Check the credentials status

Trait Implementations

impl Clone for Credential

fn clone(&self) -> Credential

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Credential

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Credential

fn deserialize<__D>( __deserializer: __D, ) -> Result<Credential, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl LinkedDataDocument for Credential

fn get_contexts(&self) -> Result<Option<String>, Error>

fn to_dataset_for_signing<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, parent: Option<&'life1 (dyn LinkedDataDocument + Sync)>, context_loader: &'life2 mut ContextLoader, ) -> Pin<Box<dyn Future<Output = Result<HashDataset<Subject, IriBuf, Term>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Credential: 'async_trait,

fn to_value(&self) -> Result<Value, Error>

fn get_issuer(&self) -> Option<&str>

fn get_default_proof_purpose(&self) -> Option<VerificationRelationship>

impl PartialEq for Credential

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Credential

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<RevocationList2020Credential> for Credential

type Error = CredentialConversionError

The type returned in the event of a conversion error.

fn try_from( credential: RevocationList2020Credential, ) -> Result<Credential, <Credential as TryFrom<RevocationList2020Credential>>::Error>

Performs the conversion.

impl TryFrom<StatusList2021Credential> for Credential

type Error = CredentialConversionError

The type returned in the event of a conversion error.

fn try_from( credential: StatusList2021Credential, ) -> Result<Credential, <Credential as TryFrom<StatusList2021Credential>>::Error>

Performs the conversion.

impl StructuralPartialEq for Credential