csc-data-classes/at.asitplus.csc.datamodel.documents

Package-level declarations

Types

@Serializable

CSC Data Model 1.0.0 section 8.3: REQUIRED Access method for a document referenced by URI; type is the required discriminator.

ChecksumSerializer

object ChecksumSerializer : KSerializer<Hash>

Codec for the SRI checksum string specified by CSC Data Model Bindings 1.0.0 §7.1.2, for example sha256-BwgJ (digest name, hyphen, Base64 without padding). It is retained to document and expose the CSC wire representation. VC-K's QES wire models follow the conflicting structured Hash representation from ETSI TS 119 432 instead, so this serializer intentionally has no call sites in the project (yet).

DocumentData

@Serializable

data class DocumentData(val label: String? = null, val document: ByteArray, val documentType: DocumentType = DocumentType.SOD, val circumstantialData: ByteArray? = null) : SignatureCreationRequestContent, SignatureRequestContent

Full document content, CSC Data Model 1.0.0 section 8.1.

DocumentInfo

@Serializable

data class DocumentInfo(val label: String? = null, val hash: ByteArray, val hashType: HashType? = null, val signedProps: List<Attribute>? = null, val circumstantialData: ByteArray? = null)

Document digest and authorization metadata, CSC Data Model 1.0.0 section 8.2.

DocumentReference

@Serializable

data class DocumentReference(val label: String? = null, val access: AccessControlMethod? = null, val href: String, val checksum: Hash? = null, val circumstantialData: ByteArray? = null) : SignatureCreationRequestContent, SignatureRequestContent

Remote document reference, CSC Data Model 1.0.0 section 8.3.

DocumentRepresentations

@Serializable

data class DocumentRepresentations(val label: String? = null, val hashes: Hashes) : SignatureCreationRequestContent

One or more signer-document representations, CSC Data Model 1.0.0 section 8.4.

DocumentType

@Serializable

enum DocumentType : Enum<DocumentType>

CSC Data Model 1.0.0 section 8.1: Identifies original or formatted document bytes.

HashType

@Serializable

enum HashType : Enum<HashType>

CSC Data Model 1.0.0 section 8.2: Identifies the meaning of DocumentInfo.hash.

SignatureCreationRequestContent

@Serializable(with = SignatureCreationRequestContent.JsonPolymorphicSerializer::class)

sealed interface SignatureCreationRequestContent

CSC Data Model 1.0.0 section 9.3: Document forms allowed in SignatureCreationRequest.

SignatureRequestContent

@Serializable(with = SignatureRequestContent.JsonPolymorphicSerializer::class)

sealed interface SignatureRequestContent

CSC Data Model 1.0.0 section 9.4: Document forms allowed in SignatureRequest.