sd-jwt-type-metadata/at.asitplus.wallet.sdjwt

Package-level declarations

Types

@Serializable(with = CaseInsensitiveString.InlineSerializer::class)

data class CaseInsensitiveString(val string: String)

DelegatingSdJwtTypeMetadataDocumentIntegrityChecker

data class DelegatingSdJwtTypeMetadataDocumentIntegrityChecker(val subresourceIntegrityChecker: W3cSubresourceIntegrityChecker) : SdJwtTypeMetadataDocumentIntegrityChecker

DelegatingSdJwtTypeMetadataDocumentResolver

data class DelegatingSdJwtTypeMetadataDocumentResolver(val documentRetriever: SdJwtTypeMetadataDocumentRetriever, val integrityChecker: SdJwtTypeMetadataDocumentIntegrityChecker = SdJwtTypeMetadataDocumentIntegrityChecker.DEFAULT) : SdJwtTypeMetadataDocumentResolver

DelegatingSdJwtTypeMetadataDocumentRetriever

@JvmInline

value class DelegatingSdJwtTypeMetadataDocumentRetriever(delegates: Collection<SdJwtTypeMetadataDocumentRetriever>) : Collection<SdJwtTypeMetadataDocumentRetriever> , SdJwtTypeMetadataDocumentRetriever

KtorSdJwtTypeMetadataDocumentRetriever

class KtorSdJwtTypeMetadataDocumentRetriever(val httpClient: HttpClient, val clock: Clock, val json: Json = Json.Default, val integrityChecker: SdJwtTypeMetadataDocumentIntegrityChecker = SdJwtTypeMetadataDocumentIntegrityChecker.DEFAULT) : SdJwtTypeMetadataDocumentRetriever

Rfc5646LanguageTag

@Serializable

@JvmInline

value class Rfc5646LanguageTag(val caseInsensitiveString: CaseInsensitiveString)

https://www.rfc-editor.org/rfc/rfc5646.html

SdJwtTypeMetadata

@Serializable

data class SdJwtTypeMetadata(val vct: SdJwtVcType, val name: String? = null, val description: String? = null, val display: SdJwtTypeMetadataTypeDisplayInformationList? = null, val claims: SdJwtTypeMetadataClaimInformationList? = null)

SdJwtTypeMetadataClaimInformation

@Serializable

data class SdJwtTypeMetadataClaimInformation(val path: SdJwtTypeMetadataClaimInformationPath, val display: SdJwtTypeMetadataClaimInformationDisplayMetadataList? = null, val isMandatory: Boolean? = null, val selectiveDisclosureConstraints: SelectiveDisclosureConstraints? = null, val svgId: SvgContentPlaceholder? = null)

4.6. Claim Metadata

SdJwtTypeMetadataClaimInformationDisplayMetadata

@Serializable

data class SdJwtTypeMetadataClaimInformationDisplayMetadata(val locale: Rfc5646LanguageTag, val label: String, val description: String? = null)

SdJwtTypeMetadataClaimInformationDisplayMetadataList

@Serializable

@JvmInline

value class SdJwtTypeMetadataClaimInformationDisplayMetadataList(list: UnorderedMultiSet<SdJwtTypeMetadataClaimInformationDisplayMetadata>) : Iterable<SdJwtTypeMetadataClaimInformationDisplayMetadata>

SdJwtTypeMetadataClaimInformationList

@Serializable

@JvmInline

value class SdJwtTypeMetadataClaimInformationList(collection: UnorderedMultiSet<SdJwtTypeMetadataClaimInformation>) : Iterable<SdJwtTypeMetadataClaimInformation>

SdJwtTypeMetadataClaimInformationPath

@JvmInline

@Serializable

value class SdJwtTypeMetadataClaimInformationPath(segments: List<@Serializable(with = SdJwtTypeMetadataClaimInformationPath.SegmentSerializer::class) SdJwtTypeMetadataClaimInformationPathSegment?>) : List<SdJwtTypeMetadataClaimInformationPathSegment?>

SdJwtTypeMetadataClaimInformationPathSegment

sealed interface SdJwtTypeMetadataClaimInformationPathSegment

SdJwtTypeMetadataClaimInformationPathSegmentIndex

@JvmInline

value class SdJwtTypeMetadataClaimInformationPathSegmentIndex(val ulong: ULong) : SdJwtTypeMetadataClaimInformationPathSegment

SdJwtTypeMetadataClaimInformationPathSegmentName

@JvmInline

value class SdJwtTypeMetadataClaimInformationPathSegmentName(val string: String) : SdJwtTypeMetadataClaimInformationPathSegment

SdJwtTypeMetadataDefinition

@Serializable

data class SdJwtTypeMetadataDefinition(val vct: SdJwtVcType, val name: String? = null, val description: String? = null, val extends: SdJwtVcType? = null, val extendsIntegrity: W3cSubresourceIntegrityMetadata? = null, val display: SdJwtTypeMetadataTypeDisplayInformationList? = null, val claims: SdJwtTypeMetadataClaimInformationList? = null)

Metadata for an SD-JWT VC Type According to https://www.ietf.org/archive/id/draft-ietf-oauth-sd-jwt-vc-16.html#name-display-metadata

SdJwtTypeMetadataDocument

@Serializable(with = SdJwtTypeMetadataDocument.DefinitionSerializer::class)

data class SdJwtTypeMetadataDocument(val originalBytes: ByteArray, val definition: SdJwtTypeMetadataDefinition)

Separation between the originally received bytes and the decoded content allows for integrity verification against vct#integrity and extends#integrity.

SdJwtTypeMetadataDocumentIntegrityChecker

fun interface SdJwtTypeMetadataDocumentIntegrityChecker

SdJwtTypeMetadataDocumentRegistry

@JvmInline

value class SdJwtTypeMetadataDocumentRegistry(delegate: Map<SdJwtVcType, SdJwtTypeMetadataDocument>) : Map<SdJwtVcType, SdJwtTypeMetadataDocument> , SdJwtTypeMetadataDocumentRetriever

SdJwtTypeMetadataDocumentResolver

fun interface SdJwtTypeMetadataDocumentResolver

SdJwtTypeMetadataDocumentRetriever

fun interface SdJwtTypeMetadataDocumentRetriever

SdJwtTypeMetadataTypeDisplayInformation

@Serializable

data class SdJwtTypeMetadataTypeDisplayInformation(val locale: Rfc5646LanguageTag, val name: String, val description: String? = null, val rendering: SdJwtTypeMetadataTypeDisplayInformationRenderingMetadata? = null)

SdJwtTypeMetadataTypeDisplayInformationList

@Serializable

@JvmInline

value class SdJwtTypeMetadataTypeDisplayInformationList(collection: UnorderedMultiSet<SdJwtTypeMetadataTypeDisplayInformation>) : Iterable<SdJwtTypeMetadataTypeDisplayInformation>

SdJwtTypeMetadataTypeDisplayInformationRenderingMetadata

@Serializable

data class SdJwtTypeMetadataTypeDisplayInformationRenderingMetadata(val simple: SdJwtTypeMetadataTypeDisplayInformationRenderingMetadataSimple? = null, val svgTemplates: SdJwtTypeMetadataTypeDisplayInformationRenderingMetadataSvgTemplates? = null)

SdJwtTypeMetadataTypeDisplayInformationRenderingMetadataSimple

@Serializable

data class SdJwtTypeMetadataTypeDisplayInformationRenderingMetadataSimple(val logo: SdJwtTypeMetadataTypeDisplayInformationRenderingMetadataSimpleLogoMetadata? = null, val backgroundImage: SdJwtTypeMetadataTypeDisplayInformationRenderingMetadataSimpleBackgroundImageMetadata? = null, val backgroundColor: W3cCssRgbColor? = null, val textColor: W3cCssRgbColor? = null)

SdJwtTypeMetadataTypeDisplayInformationRenderingMetadataSimpleBackgroundImageMetadata

@Serializable

data class SdJwtTypeMetadataTypeDisplayInformationRenderingMetadataSimpleBackgroundImageMetadata(val uri: Rfc3986UniformResourceIdentifier, val uriIntegrity: W3cSubresourceIntegrityMetadata? = null)

SdJwtTypeMetadataTypeDisplayInformationRenderingMetadataSimpleLogoMetadata

@Serializable

data class SdJwtTypeMetadataTypeDisplayInformationRenderingMetadataSimpleLogoMetadata(val uri: Rfc3986UniformResourceIdentifier, val uriIntegrity: W3cSubresourceIntegrityMetadata? = null, val alternativeText: String? = null)

SdJwtTypeMetadataTypeDisplayInformationRenderingMetadataSvgTemplates

@Serializable(with = SdJwtTypeMetadataTypeDisplayInformationRenderingMetadataSvgTemplates.InlineSerializer::class)

data class SdJwtTypeMetadataTypeDisplayInformationRenderingMetadataSvgTemplates(templates: List<SvgTemplate>) : List<SvgTemplate>

SdJwtVcType

@Serializable

@JvmInline

value class SdJwtVcType(val string: String)

This specification defines the new JWT claim vct (for verifiable credential type). Its value MUST be a case-sensitive string serving as an identifier for the type of the SD-JWT VC. The vct value MUST be a Collision-Resistant Name as defined in Section 2 of RFC7515.

SelectiveDisclosureConstraints

@Serializable(with = SelectiveDisclosureConstraints.SelectiveDisclosureConstraintsSerializer::class)

enum SelectiveDisclosureConstraints : Enum<SelectiveDisclosureConstraints>

SignumSdJwtTypeMetadataDocumentIntegrityChecker

object SignumSdJwtTypeMetadataDocumentIntegrityChecker : SdJwtTypeMetadataDocumentIntegrityChecker

SignumW3cSubresourceIntegrityMetadataBuilder

object SignumW3cSubresourceIntegrityMetadataBuilder : W3cSubresourceIntegrityMetadataBuilder

SvgContentPlaceholder

@Serializable

@JvmInline

value class SvgContentPlaceholder(val string: String)

SvgTemplate

@Serializable

data class SvgTemplate(val uri: Rfc3986UniformResourceIdentifier, val uriIntegrity: W3cSubresourceIntegrityMetadata? = null, val properties: SvgTemplateProperties? = null)

SvgTemplateProperties

@Serializable

data class SvgTemplateProperties(val imageOrientation: SvgTemplatePropertyImageOrientation? = null, val colorScheme: SvgTemplatePropertyColorScheme? = null, val contrast: SvgTemplatePropertyContrast? = null)

SvgTemplatePropertyColorScheme

@Serializable

enum SvgTemplatePropertyColorScheme : Enum<SvgTemplatePropertyColorScheme>

SvgTemplatePropertyContrast

@Serializable

enum SvgTemplatePropertyContrast : Enum<SvgTemplatePropertyContrast>

SvgTemplatePropertyImageOrientation

@Serializable

enum SvgTemplatePropertyImageOrientation : Enum<SvgTemplatePropertyImageOrientation>

UnorderedMultiSet

data class UnorderedMultiSet<T>(list: List<T>) : Iterable<T>

Basically used as proxy for equality check in data classes, where the order of a list does not impact equality, but the number of occurances does.

W3cCssRgbColor

@Serializable

@JvmInline

value class W3cCssRgbColor(val string: String)

Basic syntax validation for https://www.w3.org/TR/css-color-3/#rgb-color

W3cSubresourceIntegrityChecker

fun interface W3cSubresourceIntegrityChecker

W3cSubresourceIntegrityMetadata

@Serializable(with = W3cSubresourceIntegrityMetadata.InlineSerializer::class)

@JvmInline

value class W3cSubresourceIntegrityMetadata(val expression: ContentSecurityPolicySourceExpressionHash)

The value MUST be an "integrity metadata" string as defined in Section 3 of W3C.SRI. If an integrity property is present for a particular claim, the Consumer of the respective document MUST verify the integrity of the retrieved document as defined in Section 3.3.5 of W3C.SRI.

W3cSubresourceIntegrityMetadataBuilder

interface W3cSubresourceIntegrityMetadataBuilder : W3cSubresourceIntegrityChecker