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

OpenIdRequestOptions

data class OpenIdRequestOptions( val credentials: Set<RequestOptionsCredential>, val responseMode: OpenIdConstants.ResponseMode = OpenIdConstants.ResponseMode.Fragment, val responseUrl: String? = null, val responseType: String = VP_TOKEN, val state: String = uuid4().toString(), val clientMetadataUrl: String? = null, val encryption: Boolean = false, val presentationMechanism: PresentationMechanismEnum = PresentationMechanismEnum.PresentationExchange, val transactionData: Set<TransactionData>? = null) : RequestOptions(source)

Constructors

constructor( credentials: Set<RequestOptionsCredential>, responseMode: OpenIdConstants.ResponseMode = OpenIdConstants.ResponseMode.Fragment, responseUrl: String? = null, responseType: String = VP_TOKEN, state: String = uuid4().toString(), clientMetadataUrl: String? = null, encryption: Boolean = false, presentationMechanism: PresentationMechanismEnum = PresentationMechanismEnum.PresentationExchange, transactionData: Set<TransactionData>? = null)

Properties

clientMetadataUrl

open override val clientMetadataUrl: String? = null

Optional URL to include metadata by reference (see AuthenticationRequestParameters.clientMetadataUri) instead of by value (see AuthenticationRequestParameters.clientMetadata)

credentials

open override val credentials: Set<RequestOptionsCredential>

Requested credentials, should be at least one.

encryption

open override val encryption: Boolean = false

Set this value to include metadata with encryption parameters set. Beware if setting this value and also clientMetadataUrl, that the URL shall point to OpenId4VpVerifier.metadataWithEncryption.

isAnyDirectPost

open val isAnyDirectPost: Boolean

isDcql

open val isDcql: Boolean

isPresentationExchange

open val isPresentationExchange: Boolean

isSiop

open val isSiop: Boolean

presentationMechanism

open override val presentationMechanism: PresentationMechanismEnum

Presentation mechanism to be used for requesting credentials.

responseMode

open override val responseMode: OpenIdConstants.ResponseMode

Response mode to request, see OpenIdConstants.ResponseMode, by default OpenIdConstants.ResponseMode.Fragment. Setting this to any other value may require setting responseUrl too.

responseType

open override val responseType: String

Response type to set in AuthenticationRequestParameters.responseType, by default only vp_token (as per OpenID4VP spec, see OpenIdConstants.VP_TOKEN). Be sure to separate values by a space, e.g. vp_token id_token (see OpenIdConstants.ID_TOKEN).

responseUrl

open override val responseUrl: String? = null

Response URL to set in the AuthenticationRequestParameters.responseUrl, required if responseMode is set to OpenIdConstants.ResponseMode.DirectPost or OpenIdConstants.ResponseMode.DirectPostJwt.

state

open override val state: String

Opaque value which will be returned by the OpenId Provider and also in AuthnResponseResult.

transactionData

open override val transactionData: Set<TransactionData>? = null

Functions

buildScope

open fun buildScope(): String

toDCQLQuery

open override fun toDCQLQuery(): DCQLQuery?

toInputDescriptor

open override fun toInputDescriptor(containerJwt: FormatContainerJwt, containerSdJwt: FormatContainerSdJwt): List<InputDescriptor>

toPresentationDefinition

open override fun toPresentationDefinition(containerJwt: FormatContainerJwt, containerSdJwt: FormatContainerSdJwt): PresentationDefinition