openid-data-classes/at.asitplus.openid.dcql

Package-level declarations

Types

DCQLAmbiguousClaimsQuery

@Serializable

data class DCQLAmbiguousClaimsQuery(val id: DCQLClaimsQueryIdentifier? = null, val values: List<DCQLExpectedClaimValue>? = null, val path: DCQLClaimsPathPointer) : DCQLClaimsQuery

DCQLAuthorityKeyIdentifier

@Serializable(with = DCQLAuthorityKeyIdentifierInlineStringSerializer::class)

data class DCQLAuthorityKeyIdentifier(val byteArray: ByteArray)

DCQLAuthorityKeyIdentifierInlineStringSerializer

class DCQLAuthorityKeyIdentifierInlineStringSerializer : KSerializer<DCQLAuthorityKeyIdentifier>

DCQLClaimsPathPointer

@Serializable(with = DCQLClaimsPathPointerInlineSerializer::class)

class DCQLClaimsPathPointer(val segments: NonEmptyList<DCQLClaimsPathPointerSegment>) : List<DCQLClaimsPathPointerSegment>

6.4. Claims Path Pointer

DCQLClaimsPathPointerInlineSerializer

object DCQLClaimsPathPointerInlineSerializer : KSerializer<DCQLClaimsPathPointer>

DCQLClaimsPathPointerNullSegmentSerializer

object DCQLClaimsPathPointerNullSegmentSerializer : KSerializer<DCQLClaimsPathPointerSegment.NullSegment>

DCQLClaimsPathPointerSegment

@Serializable(with = DCQLClaimsPathPointerSegmentSerializer::class)

sealed interface DCQLClaimsPathPointerSegment

DCQLClaimsPathPointerSegmentSerializer

object DCQLClaimsPathPointerSegmentSerializer : KSerializer<DCQLClaimsPathPointerSegment>

DCQLClaimsQuery

@Serializable(with = DCQLClaimsQuerySerializer::class)

sealed interface DCQLClaimsQuery

DCQLClaimsQueryIdentifier

@Serializable

value class DCQLClaimsQueryIdentifier(val string: String)

A string identifying the particular claim. The value MUST be a non-empty string consisting of alphanumeric, underscore (_) or hyphen (-) characters. Within the particular claims array, the same id MUST NOT be present more than once.

DCQLClaimsQueryList

@Serializable

value class DCQLClaimsQueryList<out DCQLClaimsQueryType : DCQLClaimsQuery>(list: NonEmptyList<DCQLClaimsQueryType>) : List<DCQLClaimsQueryType>

A non-empty array of objects as defined in Section 6.3 that specifies claims in the requested Credential.

DCQLClaimsQueryResult

sealed interface DCQLClaimsQueryResult

DCQLClaimsQuerySerializer

object DCQLClaimsQuerySerializer : JsonContentPolymorphicSerializer<DCQLClaimsQuery>

sealed interface DCQLCredential

DCQLCredentialClaimStructure

sealed interface DCQLCredentialClaimStructure

DCQLCredentialMetadataAndValidityConstraints

@Serializable(with = DCQLCredentialMetadataAndValidityConstraintsSerializer::class)

sealed interface DCQLCredentialMetadataAndValidityConstraints

DCQLCredentialMetadataAndValidityConstraintsSerializer

object DCQLCredentialMetadataAndValidityConstraintsSerializer : JsonContentPolymorphicSerializer<DCQLCredentialMetadataAndValidityConstraints>

DCQLCredentialQuery

@Serializable(with = DCQLCredentialQuerySerializer::class)

sealed interface DCQLCredentialQuery

DCQLCredentialQueryIdentifier

@Serializable

value class DCQLCredentialQueryIdentifier(val string: String)

A string identifying the Credential in the response and, if provided, the constraints in credential_sets. The value MUST be a non-empty string consisting of alphanumeric, underscore (_) or hyphen (-) characters. Within the Authorization Request, the same id MUST NOT be present more than once.

DCQLCredentialQueryList

@Serializable

value class DCQLCredentialQueryList<out DCQLCredentialQueryType : DCQLCredentialQuery>(list: NonEmptyList<DCQLCredentialQueryType>) : List<DCQLCredentialQueryType>

Relevant references: OID4VP draft 23: A non-empty array of Credential Queries as defined in Section 6.1 that specify the requested Verifiable Credentials.

DCQLCredentialQueryMatchingResult

sealed interface DCQLCredentialQueryMatchingResult

DCQLCredentialQuerySerializer

object DCQLCredentialQuerySerializer : JsonContentPolymorphicSerializer<DCQLCredentialQuery>

DCQLCredentialSetQuery

@Serializable

data class DCQLCredentialSetQuery(val options: NonEmptyList<List<DCQLCredentialQueryIdentifier>>, val required: Boolean = true)

6.2. Credential Set Query

DCQLCredentialSetQueryPurpose

@Serializable(with = DCQLCredentialSetQueryPurposeSerializer::class)

sealed interface DCQLCredentialSetQueryPurpose

DCQLCredentialSetQueryPurposeSerializer

object DCQLCredentialSetQueryPurposeSerializer : KSerializer<DCQLCredentialSetQueryPurpose>

DCQLCredentialSubmissionOption

@Serializable

data class DCQLCredentialSubmissionOption<Credential : Any>(val credential: Credential, val matchingResult: DCQLCredentialQueryMatchingResult)

DCQLEmptyCredentialMetadataAndValidityConstraints

@Serializable

object DCQLEmptyCredentialMetadataAndValidityConstraints : DCQLCredentialMetadataAndValidityConstraints

Passes an empty constraint object as per https://github.com/openid/OpenID4VP/issues/590

DCQLExpectedClaimValue

@Serializable(with = DCQLExpectedClaimValueSerializer::class)

sealed interface DCQLExpectedClaimValue

DCQLExpectedClaimValueSerializer

object DCQLExpectedClaimValueSerializer : KSerializer<DCQLExpectedClaimValue>

DCQLIsoMdocClaimsQuery

@Serializable

data class DCQLIsoMdocClaimsQuery(val id: DCQLClaimsQueryIdentifier? = null, val values: List<DCQLExpectedClaimValue>? = null, val path: DCQLClaimsPathPointer, val intentToRetain: Boolean? = null) : DCQLClaimsQuery

DCQLIsoMdocCredential

data class DCQLIsoMdocCredential(val claimStructure: DCQLCredentialClaimStructure.IsoMdocStructure, val documentType: String, val satisfiesCryptographicHolderBinding: Boolean, val authorityKeyIdentifiers: Collection<DCQLAuthorityKeyIdentifier>) : DCQLCredential

DCQLIsoMdocCredentialMetadataAndValidityConstraints

@Serializable

data class DCQLIsoMdocCredentialMetadataAndValidityConstraints(val doctypeValue: String) : DCQLCredentialMetadataAndValidityConstraints

DCQLIsoMdocCredentialQuery

@Serializable

data class DCQLIsoMdocCredentialQuery(val id: DCQLCredentialQueryIdentifier, val meta: DCQLIsoMdocCredentialMetadataAndValidityConstraints, val claims: DCQLClaimsQueryList<DCQLIsoMdocClaimsQuery>? = null, val claimSets: NonEmptyList<List<DCQLClaimsQueryIdentifier>>? = null, val multiple: Boolean = DCQLCredentialQuery.Defaults.MULTIPLE, val trustedAuthorities: NonEmptyList<DCQLTrustedAuthorityQueryEntry>? = null, val requireCryptographicHolderBinding: Boolean = DCQLCredentialQuery.Defaults.REQUIRE_CRYPTOGRAPHIC_HOLDER_BINDING, val format: CredentialFormatEnum = CREDENTIAL_FORMAT) : DCQLCredentialQuery

DCQLJsonClaimsQuery

@Serializable

data class DCQLJsonClaimsQuery(val id: DCQLClaimsQueryIdentifier? = null, val values: List<DCQLExpectedClaimValue>? = null, val path: DCQLClaimsPathPointer) : DCQLClaimsQuery

DCQLJwtVcCredentialMetadataAndValidityConstraints

@Serializable

data class DCQLJwtVcCredentialMetadataAndValidityConstraints(val typeValues: NonEmptyList<List<String>>) : DCQLCredentialMetadataAndValidityConstraints

DCQLJwtVcCredentialQuery

@Serializable

data class DCQLJwtVcCredentialQuery(val id: DCQLCredentialQueryIdentifier, val meta: DCQLJwtVcCredentialMetadataAndValidityConstraints, val claims: DCQLClaimsQueryList<DCQLJsonClaimsQuery>? = null, val claimSets: NonEmptyList<List<DCQLClaimsQueryIdentifier>>? = null, val multiple: Boolean = DCQLCredentialQuery.Defaults.MULTIPLE, val trustedAuthorities: NonEmptyList<DCQLTrustedAuthorityQueryEntry>? = null, val requireCryptographicHolderBinding: Boolean = DCQLCredentialQuery.Defaults.REQUIRE_CRYPTOGRAPHIC_HOLDER_BINDING, val format: CredentialFormatEnum = CREDENTIAL_FORMAT) : DCQLCredentialQuery

6.1. Credential Query

@Serializable

data class DCQLQuery(val credentials: DCQLCredentialQueryList<DCQLCredentialQuery>, val credentialSets: NonEmptyList<DCQLCredentialSetQuery>? = null)

DCQLQueryMatchingResult

data class DCQLQueryMatchingResult(val credentialMatchingResults: Map<DCQLCredentialQueryIdentifier, List<KmmResult<DCQLCredentialQueryMatchingResult>>>)

DCQLQueryResponse

data class DCQLQueryResponse<DCQLCredentialQueryResponse : Any>(val submissions: Map<DCQLCredentialQueryIdentifier, List<DCQLCredentialQueryResponse>>)

DCQLQueryResult

typealias ~~DCQLQueryResult~~<Any> = DCQLQueryMatchingResult

DCQLSdJwtCredential

data class DCQLSdJwtCredential(val claimStructure: DCQLCredentialClaimStructure.JsonBasedStructure, val type: String, val satisfiesCryptographicHolderBinding: Boolean, val authorityKeyIdentifiers: Collection<DCQLAuthorityKeyIdentifier>) : DCQLCredential

DCQLSdJwtCredentialMetadataAndValidityConstraints

@Serializable

data class DCQLSdJwtCredentialMetadataAndValidityConstraints(val vctValues: List<String>) : DCQLCredentialMetadataAndValidityConstraints

DCQLSdJwtCredentialQuery

@Serializable

data class DCQLSdJwtCredentialQuery(val id: DCQLCredentialQueryIdentifier, val meta: DCQLSdJwtCredentialMetadataAndValidityConstraints, val claims: DCQLClaimsQueryList<DCQLJsonClaimsQuery>? = null, val claimSets: NonEmptyList<List<DCQLClaimsQueryIdentifier>>? = null, val multiple: Boolean = DCQLCredentialQuery.Defaults.MULTIPLE, val trustedAuthorities: NonEmptyList<DCQLTrustedAuthorityQueryEntry>? = null, val requireCryptographicHolderBinding: Boolean = DCQLCredentialQuery.Defaults.REQUIRE_CRYPTOGRAPHIC_HOLDER_BINDING, val format: CredentialFormatEnum = CREDENTIAL_FORMAT) : DCQLCredentialQuery

6.1. Credential Query

DCQLTrustedAuthority

@Serializable

data class DCQLTrustedAuthority(val type: DCQLTrustedAuthorityType, val values: List<String>)

DCQLTrustedAuthorityQueryEntry

@Serializable(with = DCQLTrustedAuthorityQueryEntrySerializer::class)

sealed interface DCQLTrustedAuthorityQueryEntry

DCQLTrustedAuthorityQueryEntryAuthorityKeyIdentifier

@Serializable

data class DCQLTrustedAuthorityQueryEntryAuthorityKeyIdentifier(val values: NonEmptyList<String>, val type: DCQLTrustedAuthorityType = DCQL_TRUSTED_AUTHORITY_TYPE) : DCQLTrustedAuthorityQueryEntry

DCQLTrustedAuthorityQueryEntryETSITrustedList

@Serializable

data class DCQLTrustedAuthorityQueryEntryETSITrustedList(val values: NonEmptyList<String>, val type: DCQLTrustedAuthorityType = DCQL_TRUSTED_AUTHORITY_TYPE) : DCQLTrustedAuthorityQueryEntry

DCQLTrustedAuthorityQueryEntryOpenIDFederation

@Serializable

data class DCQLTrustedAuthorityQueryEntryOpenIDFederation(val values: NonEmptyList<String>, val type: DCQLTrustedAuthorityType = DCQL_TRUSTED_AUTHORITY_TYPE) : DCQLTrustedAuthorityQueryEntry

DCQLTrustedAuthorityQueryEntrySerializer

class DCQLTrustedAuthorityQueryEntrySerializer : JsonContentPolymorphicSerializer<DCQLTrustedAuthorityQueryEntry>

DCQLTrustedAuthorityType

enum DCQLTrustedAuthorityType : Enum<DCQLTrustedAuthorityType>

DCQLVcJwsCredential

data class DCQLVcJwsCredential(val claimStructure: DCQLCredentialClaimStructure.JsonBasedStructure, val satisfiesCryptographicHolderBinding: Boolean, val authorityKeyIdentifiers: Collection<DCQLAuthorityKeyIdentifier>, val types: Collection<String>) : DCQLCredential