IO Wallet SDK
    Preparing search index...

    Module @pagopa/io-wallet-oauth2

    OAuth 2.0 helpers for IT-Wallet flows, including Pushed Authorization Requests, PKCE, DPoP, JAR/JARM utilities, access-token handling, wallet/client attestation helpers, and MRTD proof-of-possession support.

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

    pnpm add @pagopa/io-wallet-oauth2
    

    The package is environment-agnostic: provide cryptographic and HTTP operations through callbacks instead of relying on runtime globals.

    Enumerations

    HashAlgorithm

    Classes

    ClientAttestationError
    CreateTokenDPoPError
    CreateTokenResponseError
    FetchTokenResponseError
    MrtdPopError
    Oauth2Error
    Oauth2JwtParseError
    PushedAuthorizationRequestError

    Interfaces

    BaseVerifyWalletAttestationJwtOptions
    BaseWalletAttestationOptions
    CallbackContext
    ClientAttestationOptions
    ClientAuthenticationCallbackOptions
    ClientAuthenticationWalletAttestationJwtOptions
    CreateAccessTokenResponseOptions
    CreateJarRequestOptions
    CreateJarRequestResult
    CreateMrtdValidationJwtOptions
    CreatePkceOptions
    CreatePkceReturn
    CreatePushedAuthorizationRequestOptionsV1_0
    CreateTokenDPoPOptions
    DecodeJwtHeaderOptions
    DecodeJwtHeaderResult
    DecodeJwtOptions
    DecodeJwtResult
    FetchMrtdPopInitOptions
    FetchMrtdPopInitResult
    FetchMrtdPopVerifyOptions
    FetchMrtdPopVerifyResult
    fetchPushedAuthorizationResponseOptions
    FetchTokenResponseOptions
    GetJwtFromFormPostOptions
    IsClientAttestationSupportedOptions
    JwtSignerCustom
    JwtSignerDid
    JwtSignerFederation
    JwtSignerX5c
    MrtdDocumentData
    ParseAccessTokenRequestOptions
    ParseAccessTokenRequestResult
    ParseAuthorizationRequestOptions
    ParseAuthorizationRequestResult
    ParsedAccessTokenAuthorizationCodeRequestGrant
    ParsedAccessTokenRefreshTokenRequestGrant
    ParsedJarRequest
    ParsedJarRequestOptions
    ParseMrtdChallengeOptions
    ParseMrtdChallengeResult
    ParsePushedAuthorizationRequestOptions
    ParsePushedAuthorizationRequestResult
    RequestDpopOptions
    RequestLike
    RetrieveAuthorizationCodeAccessTokenOptions
    VerifiedJarRequest
    VerifyAccessTokenRequestDpop
    VerifyAccessTokenRequestOptions
    VerifyAccessTokenRequestPkce
    VerifyAccessTokenRequestResult
    VerifyAuthorizationRequestDPoP
    VerifyAuthorizationRequestOptions
    VerifyAuthorizationRequestResult
    VerifyClientAttestationOptions
    VerifyClientAttestationPopJwtOptions
    VerifyJarRequestOptions
    VerifyMrtdChallengeOptions
    VerifyMrtdChallengeResult
    VerifyPkceOptions
    VerifyPushedAuthorizationRequestOptions
    VerifyPushedAuthorizationRequestReturn
    VerifyTokenDPoPOptions
    VerifyWalletAttestationJwtOptionsV1_0
    VerifyWalletAttestationJwtOptionsV1_3
    VerifyWalletAttestationJwtOptionsV1_4
    WalletAttestationOptionsV1_0
    WalletAttestationOptionsV1_3
    WalletAttestationOptionsV1_4

    Type Aliases

    AccessTokenProfileJwtHeader
    AccessTokenProfileJwtPayload
    AccessTokenRequest
    AccessTokenResponse
    AuthorizationCodeGrantIdentifier
    AuthorizationCodeGrantType
    AuthorizationRequestV1_0
    AuthorizationRequestV1_3
    CertificateChain
    ClientAttestationPopJwtHeader
    ClientAttestationPopJwtPayload
    ClientAuthenticationCallback
    CreateClientAttestationPopJwtOptions
    CreateClientAttestationPopJwtOptionsForVersion
    CreateClientAttestationPopJwtOptionsV1_0
    CreateClientAttestationPopJwtOptionsV1_3
    CreateClientAttestationPopJwtOptionsV1_4
    CreatePushedAuthorizationRequestOptions
    CreatePushedAuthorizationRequestOptionsV1_3
    CreatePushedAuthorizationRequestOptionsV1_4
    DecryptJweCallback
    DpopJwtHeader
    DpopJwtPayload
    EncryptJweCallback
    GenerateRandomCallback
    InferSchemaOrDefaultOutput
    ItWalletClientAttestationPopJwtAlg
    ItWalletClientAttestationPopJwtHeader
    ItWalletClientAttestationPopJwtPayload
    JarAuthorizationRequest
    JarRequestObjectHeader
    JarRequestObjectPayload
    JweEncryptor
    Jwk
    JwkSet
    JwtHeader
    JwtPayload
    JwtSigner
    JwtSignerJwk
    JwtSignerWithJwk
    MrtdChallengeJwtHeader
    MrtdChallengeJwtPayload
    MrtdPopInitResponseJwtHeader
    MrtdPopInitResponseJwtPayload
    MrtdPopVerifyResponse
    MrtdValidationJwtHeader
    MrtdValidationJwtPayload
    PkceCodeChallengeMethod
    PushedAuthorizationRequest
    PushedAuthorizationRequestSigned
    PushedAuthorizationRequestUnsignedV1_0
    PushedAuthorizationRequestUnsignedV1_3
    PushedAuthorizationResponse
    RefreshTokenGrantIdentifier
    RefreshTokenGrantType
    RefreshTokenProfileJwtHeader
    RefreshTokenProfileJwtPayload
    SignJwtCallback
    SupportedClientAuthenticationMethod
    TrustChain
    VerifiedClientAttestationPopJwt
    VerifiedWalletAttestationJwt
    VerifiedWalletAttestationJwtV1_0
    VerifiedWalletAttestationJwtV1_3
    VerifiedWalletAttestationJwtV1_4
    VerifyJwtCallback
    VerifyWalletAttestationJwtOptions
    WalletAttestationJwtV1_0
    WalletAttestationJwtV1_3
    WalletAttestationJwtV1_4

    Variables

    authorizationCodeGrantIdentifier
    IT_WALLET_CLIENT_ATTESTATION_POP_ALLOWED_ALG_VALUES
    jwtAuthorizationRequestJwtHeaderTyp
    MAX_JTI_LENGTH
    oauthClientAttestationHeader
    oauthClientAttestationPopHeader
    PkceCodeChallengeMethod
    refreshTokenGrantIdentifier
    signedAuthorizationRequestJwtHeaderTyp
    SupportedClientAuthenticationMethod
    zAccessTokenProfileJwtHeader
    zAccessTokenProfileJwtPayload
    zAccessTokenRequest
    zAccessTokenResponse
    zAlgValueNotNone
    zAuthorizationCodeGrantIdentifier
    zAuthorizationRequestV1_0
    zAuthorizationRequestV1_3
    zCertificateChain
    zCompactJwe
    zCompactJwt
    zDpopJwtHeader
    zDpopJwtPayload
    zItWalletClientAttestationPopJwtAlg
    zItWalletClientAttestationPopJwtHeader
    zItWalletClientAttestationPopJwtPayload
    zItWalletClientAttestationPopJwtTyp
    zJarAuthorizationRequest
    zJarRequestObjectHeader
    zJarRequestObjectPayload
    zJwk
    zJwkSet
    zJwtConfirmationPayload
    zJwtHeader
    zJwtPayload
    zMrtdChallengeJwtHeader
    zMrtdChallengeJwtPayload
    zMrtdPopInitResponseJwtHeader
    zMrtdPopInitResponseJwtPayload
    zMrtdPopVerifyResponse
    zMrtdValidationJwtHeader
    zMrtdValidationJwtPayload
    zOauthClientAttestationHeader
    zOauthClientAttestationPopHeader
    zPushedAuthorizationRequestSigned
    zPushedAuthorizationRequestUnsignedV1_0
    zPushedAuthorizationRequestUnsignedV1_3
    zPushedAuthorizationResponse
    zRefreshTokenGrantIdentifier
    zRefreshTokenProfileJwtHeader
    zRefreshTokenProfileJwtPayload
    zSignedAuthorizationRequestJwtHeaderTyp
    zTrustChain
    zWalletAttestationJwtHeaderV1_0
    zWalletAttestationJwtHeaderV1_3
    zWalletAttestationJwtHeaderV1_4
    zWalletAttestationJwtPayloadV1_0
    zWalletAttestationJwtPayloadV1_3
    zWalletAttestationJwtPayloadV1_4
    zWalletAttestationJwtV1_0
    zWalletAttestationJwtV1_3
    zWalletAttestationJwtV1_4

    Functions

    clientAuthenticationAnonymous
    clientAuthenticationWalletAttestationJwt
    createAccessTokenResponse
    createClientAttestationPopJwt
    createJarRequest
    createMrtdValidationJwt
    createPkce
    createPushedAuthorizationRequest
    createTokenDPoP
    createTokenRequest
    createWalletAttestationJwtV1_0
    createWalletAttestationJwtV1_3
    createWalletAttestationJwtV1_4
    decodeJwt
    decodeJwtHeader
    extractClientAttestationJwtsFromHeaders
    extractDpopJwtFromHeaders
    fetchJarRequestObject
    fetchMrtdPopInit
    fetchMrtdPopVerify
    fetchPushedAuthorizationResponse
    fetchTokenResponse
    getJwtFromFormPost
    htuFromRequestUrl
    isClientAttestationSupported
    isJarAuthorizationRequest
    isPushedAuthorizationRequestSigned
    isPushedAuthorizationRequestUnsigned
    jwtHeaderFromJwtSigner
    parseAccessTokenRequest
    parseAuthorizationRequest
    parseJarRequest
    parseMrtdChallenge
    parsePushedAuthorizationRequest
    toURLSearchParams
    validateJarRequestParams
    verifyAccessTokenRequest
    verifyAuthorizationRequest
    verifyClientAttestation
    verifyClientAttestationPopJwt
    verifyJarRequest
    verifyJwt
    verifyMrtdChallenge
    verifyPkce
    verifyPushedAuthorizationRequest
    verifyTokenDPoP
    verifyWalletAttestationJwt
    verifyWalletAttestationJwtV1_0
    verifyWalletAttestationJwtV1_3
    verifyWalletAttestationJwtV1_4