vck-openid/at.asitplus.wallet.lib.oauth2/OAuth2Client

OAuth2Client

class OAuth2Client(val clientId: String = "https://wallet.a-sit.at/app", val redirectUrl: String = "/callback", stateToCodeStore: MapStore<String, String> = DefaultMapStore(), val signPushedAuthorizationRequest: SignJwtFun<AuthenticationRequestParameters>? = SignJwt(EphemeralKeyWithSelfSignedCert(), JwsHeaderCertOrJwk()), randomSource: RandomSource = RandomSource.Default)(source)

Simple OAuth 2.0 client to authorize the client against an OAuth 2.0 Authorization Server and request tokens.

Builds the request parameters only; OAuth2ProtocolClient builds the HTTP requests from them, including DPoP proofs and attestation-based client authentication.

Can be used in OID4VCI flows, e.g. OpenId4VciClient.

Constructors

OAuth2Client

constructor(clientId: String = "https://wallet.a-sit.at/app", redirectUrl: String = "/callback", stateToCodeStore: MapStore<String, String> = DefaultMapStore(), signPushedAuthorizationRequest: SignJwtFun<AuthenticationRequestParameters>? = SignJwt(EphemeralKeyWithSelfSignedCert(), JwsHeaderCertOrJwk()), randomSource: RandomSource = RandomSource.Default)

Types

AuthorizationForToken

sealed class AuthorizationForToken

Authorization input used to request or refresh an OAuth2 access token. Use to indicate which grant or token exchange flow should be performed.

Properties

clientId

val clientId: String

Used to create AuthenticationRequestParameters, TokenRequestParameters and at.asitplus.openid.CredentialRequestProofContainer, typically a URI.

redirectUrl

val redirectUrl: String

Used to create AuthenticationRequestParameters and TokenRequestParameters.

signPushedAuthorizationRequest

val signPushedAuthorizationRequest: SignJwtFun<AuthenticationRequestParameters>?

Set this variable to use JAR (JWT-secured authorization requests, RFC 9101), as mandated by OpenID4VC HAIP.

Functions

createAuthRequest

suspend fun createAuthRequest(state: String, authorizationDetails: Set<AuthorizationDetails>? = null, scope: String? = null, resource: String? = null, issuerState: String? = null): AuthenticationRequestParameters

Send the result as parameters to the server at OAuth2AuthorizationServerMetadata.authorizationEndpoint. Use POST if OAuth2AuthorizationServerMetadata.pushedAuthorizationRequestEndpoint is available.

createAuthRequestAfterPar

suspend fun createAuthRequestAfterPar(parResponse: PushedAuthenticationResponseParameters): JarRequestParameters

Send the result as parameters to the server at OAuth2AuthorizationServerMetadata.authorizationEndpoint. Use this method if the previous authn request was sent as a pushed authorization request (RFC 9126), and the server has answered with PushedAuthenticationResponseParameters.

createAuthRequestJar

suspend fun createAuthRequestJar(state: String, authorizationDetails: Set<AuthorizationDetails>? = null, scope: String? = null, resource: String? = null, issuerState: String? = null, audience: String? = null): JarRequestParameters

createTokenRequestParameters

suspend fun createTokenRequestParameters(authorization: OAuth2Client.AuthorizationForToken, state: String? = null, authorizationDetails: Set<AuthorizationDetails>? = null, scope: String? = null, resource: String? = null): TokenRequestParameters

Request token with an authorization code, e.g. from createAuthRequest, or pre-auth code.

generateCodeVerifier

suspend fun generateCodeVerifier(state: String): String