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

RequestOptions

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

Constructors

RequestOptions

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

Properties

credentials

val credentials: Set<RequestOptionsCredential>

Requested credentials, should be at least one.

encryption

val encryption: Boolean = false

Set this value to include metadata with encryption parameters set.

isAnyDirectPost

val isAnyDirectPost: Boolean

isDcql

val isDcql: Boolean

isPresentationExchange

val isPresentationExchange: Boolean

isSiop

val isSiop: Boolean

presentationMechanism

val presentationMechanism: PresentationMechanismEnum

Presentation mechanism to be used for requesting credentials.

responseMode

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

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

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

val state: String

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

transactionData

val transactionData: List<TransactionData>? = null

Non-empty array of strings, where each string is a base64url-encoded JSON object that contains a typed parameter set with details about the transaction that the Verifier is requesting the End-User to authorize.

Functions

buildScope

fun buildScope(): String

toDCQLQuery

fun toDCQLQuery(): DCQLQuery?

toInputDescriptor

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

toPresentationDefinition

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