identity-kit 0.3.0

DID, key management and verifiable credential primitives
Documentation 
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

//! The commonly used types and traits of each layer, for glob import.
//!
//! The crate has two layers (see the [crate documentation](crate)). This module is the lower
//! layer's prelude: DIDs and DID documents, JOSE keys and signatures, key stores, the signing
//! party, DID resolution and the methods the enabled features provide. [`credentials`] is the upper
//! layer's: verifiable credentials as JWTs, SD-JWT VCs and domain linkage.
//!
//! ```
//! use identity_kit::prelude::*;
//!
//! let did = Did::parse("did:example:123")?;
//! let url = did.join("#key-1")?;
//! assert_eq!(url.fragment(), Some("key-1"));
//! # Ok::<(), DidError>(())
//! ```

pub use crate::did::{
    Context, Did, DidDocument, DidDocumentBuilder, DidError, DidMethod, DidUrl, DidUrlReference,
    DocumentMetadata, MethodRef, MethodType, OneOrMany, ResolutionError, ResolutionErrorKind,
    ResolutionMetadata, ResolutionOptions, ResolutionResult, Service, ServiceEndpoint, Uri,
    VerificationMaterial, VerificationMethod, VerificationRelationship,
};
pub use crate::identity::{Identifier, Identity, IdentityError, IdentityKind, KeyStoreIdentity};
pub use crate::jose::{
    CompactJws, DefaultVerifier, Jwk, JwsAlgorithm, JwsHeader, JwsVerifier, JwtClaims, KeyType,
    Signer, encode_compact,
};
#[cfg(feature = "in-memory")]
#[cfg_attr(docsrs, doc(cfg(feature = "in-memory")))]
pub use crate::keys::InMemoryKeyStore;
pub use crate::keys::{KeyId, KeySigner, KeySpec, KeyStore, KeyStoreCapabilities, KeyStoreError};
#[cfg(feature = "software")]
#[cfg_attr(docsrs, doc(cfg(feature = "software")))]
pub use crate::keys::{SoftwareKeyStore, SoftwareKeyStoreOptions};
#[cfg(feature = "did-jwk")]
#[cfg_attr(docsrs, doc(cfg(feature = "did-jwk")))]
pub use crate::methods::DidJwk;
#[cfg(feature = "did-key")]
#[cfg_attr(docsrs, doc(cfg(feature = "did-key")))]
pub use crate::methods::DidKey;
#[cfg(feature = "did-web")]
#[cfg_attr(docsrs, doc(cfg(feature = "did-web")))]
pub use crate::methods::DidWeb;
#[cfg(feature = "jwks")]
#[cfg_attr(docsrs, doc(cfg(feature = "jwks")))]
pub use crate::resolver::JwksResolver;
pub use crate::resolver::{
    CompositeKeyResolver, DereferenceError, Dereferenced, DidProducer, DidResolver, DocumentCache,
    Hosting, JwkResolver, JwtValidationError, JwtValidationOptions, JwtValidator, KeyReference,
    KeyReferenceError, KeyResolutionError, KeyResolver, KeyRole, MethodCapabilities, ProduceError,
    Resolver, ResolverBuilder,
};

/// The upper layer's prelude: credentials and presentations as JWTs (feature `vc`), SD-JWT
/// VCs (feature `sd-jwt`), domain linkage (feature `domain-linkage`) and linked presentations
/// (feature `linked-vp`).
///
/// It does not repeat the lower layer; import both.
///
/// ```
/// use identity_kit::prelude::*;
/// use identity_kit::prelude::credentials::*;
///
/// let holder = Did::parse("did:example:holder")?;
/// let subject = Subject::new(holder);
/// assert_eq!(subject.id.as_ref().map(Uri::as_str), Some("did:example:holder"));
/// # Ok::<(), DidError>(())
/// ```
#[cfg(feature = "vc")]
#[cfg_attr(docsrs, doc(cfg(feature = "vc")))]
pub mod credentials {
    #[cfg(feature = "domain-linkage")]
    #[cfg_attr(docsrs, doc(cfg(feature = "domain-linkage")))]
    pub use crate::domain_linkage::{
        DomainLinkageClient, DomainLinkageConfiguration, DomainLinkageCredentialBuilder,
        DomainLinkageError, DomainLinkageReport, DomainLinkageValidator, LinkedDid,
        LinkedDomainReport, LinkedDomainsService, UnverifiedLinkage,
    };
    #[cfg(feature = "linked-vp")]
    #[cfg_attr(docsrs, doc(cfg(feature = "linked-vp")))]
    pub use crate::linked_vp::{
        LinkedPresentationBuilder, LinkedPresentationReport, LinkedVpClient, LinkedVpError,
        LinkedVpService, LinkedVpValidationOptions, LinkedVpValidator,
    };
    #[cfg(feature = "sd-jwt")]
    #[cfg_attr(docsrs, doc(cfg(feature = "sd-jwt")))]
    pub use crate::sd_jwt_vc::{
        Disclosure, HashAlgorithm, KeyBinding, KeyBindingOptions, Processed, SdJwt, SdJwtBuilder,
        SdJwtCredentialV2, SdJwtCredentialV2Builder, SdJwtCredentialV2Error,
        SdJwtCredentialValidator, SdJwtError, SdJwtValidationError, SdJwtValidationOptions,
        SdJwtVc, SdJwtVcBuilder, SdJwtVcClaims, SdJwtVcError, TypeMetadata,
        ValidatedSdJwtCredentialV2, ValidatedSdJwtVc,
    };
    #[cfg(feature = "status-list")]
    #[cfg_attr(docsrs, doc(cfg(feature = "status-list")))]
    pub use crate::status_list::{Status, StatusList, StatusListToken};
    pub use crate::vc::validation::{
        CredentialStatus, CredentialValidationOptions, DecodedCredential, DecodedCredentialV2,
        DecodedPresentation, DecodedPresentationV2, FailFast, JwtCredentialValidator,
        JwtPresentationValidator, PresentationValidationOptions, PresentedCredentialV2,
        StatusCheck, StatusPolicy, SubjectHolderRelationship, TimeOptions, ValidationError,
    };
    pub use crate::vc::{
        ClaimPath, Credential, CredentialError, CredentialV2, EnvelopedVc, EnvelopedVp, Jwt,
        JwtClaims, Party, Presentation, PresentationV2, Subject,
    };
}