csc-data-classes/at.asitplus.csc

Package-level declarations

Types

@Serializable

data class CredentialInfo(val credentialID: String? = null, val description: String? = null, val signatureQualifier: SignatureQualifier? = null, val keyParameters: KeyParameters, val certParameters: CertificateParameters? = null, val authParameters: AuthParameters? = null, val scal: CredentialInfo.ScalOptions? = ScalOptions.SCAL1, val multisign: UInt, val lang: String? = null)

Data class that implements credentialInfo class defined in CSC-API v2.0.0.2 Ch. 11.4 "credentials/list" and Ch. 11.5 "credentials/info"

CredentialInfoRequest

@Serializable

data class CredentialInfoRequest(val credentialID: String, val certificates: CertificateOptions? = CertificateOptions.SINGLE, val certInfo: Boolean? = false, val authInfo: Boolean? = false, val lang: String? = null, val clientData: String? = null)

Data class that implements request data class defined in CSC-API v2.0.0.2 Ch. 11.5 "credentials/info"

CredentialListRequest

@Serializable

data class CredentialListRequest(val userID: String? = null, val credentialInfo: Boolean? = false, val certificates: CertificateOptions? = CertificateOptions.SINGLE, val certInfo: Boolean? = false, val authInfo: Boolean? = false, val onlyValid: Boolean? = false, val lang: String? = null, val clientData: String? = null)

Data class that implements credentialInfo defined in CSC-API v2.0.0.2 Ch. 11.4 "credentials/list" and Ch. 11.5 "credentials/info"

CredentialListResponse

@Serializable

data class CredentialListResponse(val credentialIDs: List<String>, val credentialInfos: List<CredentialInfo>? = null, val onlyValid: Boolean? = null)

Hashes

typealias Hashes = List<@Serializable(with = ByteArrayBase64Serializer::class) ByteArray>

Method

@Serializable

@SerialName(value = "method")

sealed class Method

After D3.1: UC Specification WP3. Describes the restrictions/way of accessing a document

QtspSignatureRequest

@Serializable(with = QtspSignatureRequestSerializer::class)

sealed interface QtspSignatureRequest

QtspSignatureResponse

@Serializable(with = QtspSignatureResponseSerializer::class)

sealed interface QtspSignatureResponse

SignDocRequestParameters

@Serializable

data class SignDocRequestParameters(val credentialId: String? = null, val sad: String? = null, val operationMode: OperationMode? = OperationMode.SYNCHRONOUS, val validityPeriod: Int? = null, val responseUri: String? = null, val clientData: String? = null, val signatureQualifier: SignatureQualifier? = null, val documentDigests: Collection<DocumentDigest>? = null, val documents: Collection<Document>? = null, val returnValidationInformation: Boolean? = false) : QtspSignatureRequest

CSC API v2.0.0.2 Data class defined in Ch. 11.11 Used to request the creation of one or more AdES signature(s).

SignDocResponseParameters

@Serializable

data class SignDocResponseParameters(val documentWithSignature: List<String>? = null, val signatureObject: List<String>? = null, val responseId: String? = null, val validationInfo: JsonObject? = null) : QtspSignatureResponse

CSC API v2.0.0.2 Data class defined in Ch. 11.11 Response to SignDocRequestParameters.

SignHashRequestParameters

@Serializable

data class SignHashRequestParameters(val credentialId: String, val sad: String? = null, val operationMode: OperationMode? = OperationMode.SYNCHRONOUS, val validityPeriod: Int? = null, val responseUri: String? = null, val clientData: String? = null, val hashes: Hashes, val hashAlgorithmOid: ObjectIdentifier? = null, val signAlgoOid: ObjectIdentifier, val signAlgoParams: Asn1Element? = null) : QtspSignatureRequest

CSC API v2.0.0.2 Data class defined in Ch. 11.10 Used to request the calculation of remote digital signature(s) of one or multiple hash values.

SignHashResponseParameters

@Serializable

data class SignHashResponseParameters(val signatures: List<String>? = null, val responseId: String? = null) : QtspSignatureResponse

CSC API v2.0.0.2 Data class defined in Ch. 11.10 Holds response to SignHashRequestParameters.

Functions

contentEquals

fun Hashes?.contentEquals(other: Hashes?): Boolean

contentHashCode

fun Hashes.contentHashCode(): Int

iff

infix fun Any?.iff(other: Any?): Boolean

Checks if either both are present or null

infix fun Any?.or(other: Any?): Boolean

Checks if at least one Element is present