vck-openid/at.asitplus.wallet.lib.openid/OpenId4VpHolder

OpenId4VpHolder

class OpenId4VpHolder( holder: Holder, agentPublicKey: CryptoPublicKey, jwsService: JwsService, coseService: CoseService, clock: Clock = Clock.System, clientId: String = "https://wallet.a-sit.at/", remoteResourceRetriever: RemoteResourceRetrieverFunction, requestObjectJwsVerifier: RequestObjectJwsVerifier, walletNonceMapStore: MapStore<String, String> = DefaultMapStore())(source)

Combines Verifiable Presentations with OpenId Connect. Implements OpenID for VP (2024-12-02) as well as SIOP V2 (2023-11-28).

The holder creates the Authentication Response, see OpenId4VpVerifier for the verifier.

Constructors

OpenId4VpHolder

constructor( holder: Holder, agentPublicKey: CryptoPublicKey, jwsService: JwsService, coseService: CoseService, clock: Clock = Clock.System, clientId: String = "https://wallet.a-sit.at/", remoteResourceRetriever: RemoteResourceRetrieverFunction, requestObjectJwsVerifier: RequestObjectJwsVerifier, walletNonceMapStore: MapStore<String, String> = DefaultMapStore())

constructor( keyMaterial: KeyMaterial = EphemeralKeyWithoutCert(), holder: Holder = HolderAgent(keyMaterial), jwsService: JwsService = DefaultJwsService(DefaultCryptoService(keyMaterial)), coseService: CoseService = DefaultCoseService(DefaultCryptoService(keyMaterial)), clock: Clock = Clock.System, clientId: String = "https://wallet.a-sit.at/", remoteResourceRetriever: RemoteResourceRetrieverFunction = { null }, requestObjectJwsVerifier: RequestObjectJwsVerifier = RequestObjectJwsVerifier { _ -> true }, walletNonceMapStore: MapStore<String, String> = DefaultMapStore())

Properties

metadata

val metadata: OAuth2AuthorizationServerMetadata

Functions

createAuthnResponse

suspend fun createAuthnResponse( request: RequestParametersFrom<AuthenticationRequestParameters>): KmmResult<AuthenticationResponseResult>

Pass in the deserialized AuthenticationRequestParameters, which were either encoded as query params, or JSON serialized as a JWT Request Object.

suspend fun createAuthnResponse(input: String): KmmResult<AuthenticationResponseResult>

Pass in the URL sent by the Verifier (containing the at.asitplus.openid.AuthenticationRequestParameters as query parameters), to create AuthenticationResponseResult that can be sent back to the Verifier, see AuthenticationResponseResult.

createAuthnResponseParams

suspend fun createAuthnResponseParams( params: RequestParametersFrom<AuthenticationRequestParameters>): KmmResult<AuthenticationResponse>

Creates the authentication response from the RP's params

finalizeAuthorizationResponse

suspend fun finalizeAuthorizationResponse( request: RequestParametersFrom<AuthenticationRequestParameters>, clientMetadata: RelyingPartyMetadata?, credentialPresentation: CredentialPresentation?): KmmResult<AuthenticationResponseResult>

Finalize the authorization response

finalizeAuthorizationResponseParameters

suspend fun <T : RequestParameters> finalizeAuthorizationResponseParameters( request: RequestParametersFrom<T>, clientMetadata: RelyingPartyMetadata?, credentialPresentation: CredentialPresentation?): KmmResult<AuthenticationResponse>

Finalize the authorization response parameters

parseAuthenticationRequestParameters

suspend fun parseAuthenticationRequestParameters(input: String): KmmResult<RequestParametersFrom<AuthenticationRequestParameters>>

Pass in the URL sent by the Verifier (containing the at.asitplus.openid.AuthenticationRequestParameters as query parameters), to create at.asitplus.openid.AuthenticationResponseParameters that can be sent back to the Verifier, see AuthenticationResponseResult.

startAuthorizationResponsePreparation

suspend fun startAuthorizationResponsePreparation( params: RequestParametersFrom<AuthenticationRequestParameters>): KmmResult<AuthorizationResponsePreparationState>

Starts the authorization response building process from the RP's authentication request in params

suspend fun startAuthorizationResponsePreparation(input: String): KmmResult<AuthorizationResponsePreparationState>

Starts the authorization response building process from the RP's authentication request in input