Skip to main content

openid4vci_issuer/
lib.rs

1// SPDX-FileCopyrightText: Copyright © 2026 ReallyMe Technologies Limited. All rights reserved
2//
3// SPDX-License-Identifier: MIT OR Apache-2.0
4
5//! Transport-agnostic OpenID4VCI issuer endpoint engine.
6//!
7//! The functions in this crate accept already-parsed wire objects and injected
8//! traits for storage, proof verification, and credential issuance. HTTP
9//! headers, bearer-token validation, request routing, and TLS live in adapters.
10
11mod authorization;
12mod credential_policy;
13pub mod encode;
14pub mod encrypt;
15#[cfg(feature = "identity-jose")]
16pub mod encrypt_jwe;
17pub mod endpoint;
18pub mod error;
19mod generate_identifier;
20#[cfg(feature = "identity-jose")]
21pub mod jose;
22pub mod metadata;
23pub mod nonce;
24pub mod proof;
25pub mod store;
26mod validate_credential_request;
27pub mod verify_attestation;
28
29pub use authorization::IssuanceAuthorization;
30pub use credential_policy::{CredentialEndpointConfig, ProofTypeEndpointPolicy};
31pub use encode::{
32    encode_immediate_response, encode_immediate_response_with_verified_proofs,
33    expected_credential_count, validate_issued_credential_count,
34    validate_issued_credential_count_with_verified_proofs, validate_response_credential_count,
35    validate_response_credential_count_with_verified_proofs, CommonRootCredentialEncoder,
36    CommonRootIssuanceRequestBinding, CommonRootIssuedCredential, CommonRootProofBinding,
37    CredentialEncoder, IssuanceStatusEvidence, IssuedCredential, PassThroughCredentialEncoder,
38    COMMON_ROOT_POSEIDON2_HASH_SUITE, COMMON_ROOT_PROFILE, COMMON_ROOT_SHA256_HASH_SUITE,
39    REALLYME_ZK_V1_FORMAT,
40};
41pub use encrypt::{
42    decrypt_credential_request_json, require_encrypted_request_for_response_encryption,
43    select_response_encryption_parameters, validate_response_encryption_parameters,
44    CredentialRequestDecryptor, CredentialRequestInput, CredentialRequestJson,
45    CredentialResponseBody, CredentialResponseEncryptor, DecryptedCredentialRequestJson,
46    DeferredCredentialRequestInput, EncryptedCredentialResponse,
47    DEFAULT_MAX_CREDENTIAL_REQUEST_JSON_BYTES, DEFAULT_MAX_ENCRYPTED_RESPONSE_BYTES,
48};
49#[cfg(feature = "identity-jose")]
50pub use encrypt_jwe::{
51    JoseJweCredentialRequestDecryptor, JoseJweCredentialResponseEncryptor, JoseJwePrivateKey,
52};
53pub use endpoint::{
54    handle_credential_request, handle_credential_request_body,
55    handle_deferred_credential_request_body, handle_nonce_request, handle_notification_request,
56    preflight_credential_request, CredentialIssuer, CredentialRequestPreflight, DeferredIssuer,
57    DeferredResolution, IssuanceOutcome, NotificationHandler,
58};
59pub use error::{IssuerError, IssuerResult, IssuerStatus};
60pub use generate_identifier::{
61    NotificationIdGenerator, OsNotificationIdGenerator, OsTransactionIdGenerator,
62    TransactionIdGenerator,
63};
64#[cfg(feature = "identity-jose")]
65pub use jose::{JoseJwtProofVerifier, ProofKeyBinding, ProofKeyResolver};
66pub use metadata::{
67    IssuerMetadataSigner, SignedIssuerMetadataJwt, MAX_SIGNED_ISSUER_METADATA_JWT_BYTES,
68};
69pub use nonce::{
70    AuthenticatedNonceManager, NonceCapacitySnapshot, NonceManager, MAX_NONCE_TTL_SECONDS,
71};
72pub use proof::{
73    validate_common_proof_claims, CompactProofJwtParser, ConfirmationJwk, CredentialRequestProfile,
74    KeyAttestationLocalPolicy, KeyAttestationPolicy, ProofAlgorithm, ProofKind,
75    ProofVerificationContext, ProofVerifier, UnverifiedProofClaims, VerifiedProof,
76    VerifiedProofSet, DEFAULT_MAX_PROOF_JWT_BYTES, PROOF_JWT_TYP,
77};
78pub use store::{
79    DeferredIssuance, DeferredStore, InMemoryDeferredStore, InMemoryNotificationStore,
80    NotificationRecord, NotificationStore,
81};
82pub use verify_attestation::KeyAttestationProofVerifier;