rqes-data-classes/at.asitplus.rqes/SignHashRequestParameters

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(source)

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.

Constructors

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

Properties

clientData

@SerialName(value = "clientData")

open override val clientData: String? = null

OPTIONAL. Arbitrary data from the signature application. It can be used to handle a transaction identifier or other application-spe cific data that may be useful for debugging purposes

credentialId

@SerialName(value = "credentialID")

open override val credentialId: String

REQUIRED. The credentialID as defined in the Input parameter table in /credentials/info

hashAlgorithm

@Transient

val hashAlgorithm: Digest

hashAlgorithmOid

@SerialName(value = "hashAlgorithmOID")

val hashAlgorithmOid: ObjectIdentifier? = null

REQUIRED-CONDITIONAL. String containing the OID of the hash algorithm used to generate the hashes

hashes

@SerialName(value = "hashes")

val hashes: Hashes

REQUIRED. Input-type is JsonArray - do not use HashesSerializer! One or more base64-encoded hash values to be signed

operationMode

@SerialName(value = "operationMode")

open override val operationMode: OperationMode?

OPTIONAL. The type of operation mode requested to the remote signing server The default value is “S”, so if the parameter is omitted then the remote signing server will manage the request in synchronous operation mode.

responseUri

@SerialName(value = "response_uri")

open override val responseUri: String? = null

OPTIONAL-CONDITIONAL. Value of one location where the server will notify the signature creation operation completion, as an URI value. This parameter MAY be specified only if the parameter operationMode is “A”.

sad

@SerialName(value = "SAD")

open override val sad: String? = null

REQUIRED-CONDITIONAL. The Signature Activation Data returned by the Credential Authorization methods. Not needed if the signing application has passed an access token in the “Authorization” HTTP header with scope “credential”, which is also good for the credential identified by credentialID. Note: For backward compatibility, signing applications MAY pass access tokens with scope “credential” in this parameter.

signAlgoOid

@SerialName(value = "signAlgo")

val signAlgoOid: ObjectIdentifier

REQUIRED. The OID of the algorithm to use for signing. It SHALL be one of the values allowed by the credential as returned in keyAlgo as defined in credentials/info or as defined in credentials/list

signAlgoParams

@SerialName(value = "signAlgoParams")

@Serializable(with = Asn1EncodableBase64Serializer::class)

val signAlgoParams: Asn1Element? = null

REQUIRED-CONDIIONAL. The Base64-encoded DER-encoded ASN.1 signature algorithm parameters if required by the signature algorithm - Necessary for RSASSA-PSS for example

signAlgorithm

@Transient

val signAlgorithm: SignatureAlgorithm?

validityPeriod

@SerialName(value = "validity_period")

open override val validityPeriod: Int? = null

OPTIONAL-CONDITIONAL. Maximum period of time, expressed in milliseconds, until which the server SHALL keep the request outcome(s) available for the client application retrieval. This parameter MAY be specified only if the parameter operationMode is “A”.

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int