IO Wallet SDK
    Preparing search index...

    Module @pagopa/io-wallet-oid4vp

    OpenID4VP helpers for IT-Wallet relying parties and wallets, including authorization request retrieval/parsing, authorization response creation, JARM parsing/verification, and VP token parsing.

    Detailed function documentation is maintained in source JSDoc and surfaced by TypeScript declarations and IDEs.

    pnpm add @pagopa/io-wallet-oid4vp
    

    The package keeps cryptographic and HTTP operations injectable through callbacks so it can run in Node.js, browsers, and React Native.

    Enumerations

    ClientIdPrefix
    JarmMode

    Classes

    CreateAuthorizationResponseError
    FetchAuthorizationResponseError
    InvalidRequestUriMethodError
    Oid4vpError
    ParseAuthorizeRequestError

    Interfaces

    CertificateEndpoint
    ClientIdParts
    CreateAuthorizationResponseResult
    CreateOpenid4vpAuthorizationResponseOptions
    CreateOpenid4vpAuthorizationResponseResult
    FetchAuthorizationRequestOptions
    FetchAuthorizationRequestResult
    FetchAuthorizationResponseOptions
    ParseAuthorizationResponseOptions
    ParseAuthorizeRequestOptions
    ParsedAuthorizeRequestResult
    ParsedQrCode
    ParseJarmAuthorizationResponseOptions
    ValidateCertificateEndpointsOptions
    ValidateOpenid4vpAuthorizationResponseOptions
    ValidateOpenid4vpAuthorizationResponseResult
    VerifyJarmAuthorizationResponseOptions
    VerifyJarmAuthorizationResponseResult
    X509CertificateBinding
    X509CertificateMetadata

    Type Aliases

    AuthorizationRequestUrlParams
    CreateAuthorizationRequestOptions
    CreateAuthorizationRequestOptionsV1_0
    CreateAuthorizationRequestOptionsV1_3
    CreateAuthorizationRequestOptionsV1_4
    CreateAuthorizationRequestResult
    CreateAuthorizationRequestResultV1_0
    CreateAuthorizationRequestResultV1_3
    CreateAuthorizationRequestResultV1_4
    CreateAuthorizationResponseOptionsV1_0
    CreateAuthorizationResponseOptionsV1_3
    CreateAuthorizationResponseOptionsV1_4
    CreateAuthorizationResponseVersionedOptions
    EncryptedJarmHeader
    GetX509CertificateMetadataCallback
    JarmAuthorizationResponse
    JarmAuthorizationResponseEncryptedOnly
    JarmHeader
    JarOptionsV1_0
    JarOptionsV1_3
    JarOptionsV1_4
    Openid4vpAuthorizationRequestHeader
    Openid4vpAuthorizationRequestHeaderV1_0
    Openid4vpAuthorizationRequestHeaderV1_3
    Openid4vpAuthorizationRequestPayload
    Openid4vpAuthorizationResponse
    Openid4vpAuthorizationResponseResult
    ParseAuthorizationResponseResult
    VpToken

    Variables

    zAuthorizationRequestUrlParams
    zEncryptedJarmHeader
    zJarmAuthorizationResponse
    zJarmAuthorizationResponseEncryptedOnly
    zJarmHeader
    zOpenid4vpAuthorizationRequestHeaderV1_0
    zOpenid4vpAuthorizationRequestHeaderV1_3
    zOpenid4vpAuthorizationRequestPayload
    zOpenid4vpAuthorizationResponse
    zOpenid4vpAuthorizationResponseResult
    zVpToken

    Functions

    createAuthorizationRequest
    createAuthorizationResponse
    createOpenid4vpAuthorizationResponse
    createParsedQrCode
    createX509HashClientId
    extractClientIdPrefix
    extractEncryptionJwkFromJwks
    fetchAuthorizationRequest
    fetchAuthorizationResponse
    fetchRequestObjectJwt
    parseAuthorizationResponse
    parseAuthorizeRequest
    parseJarmAuthorizationResponse
    parseVpToken
    validateAuthorizationRequestParams
    validateCertificateEndpoints
    validateOpenid4vpAuthorizationResponsePayload
    verifyJarmAuthorizationResponse