SAK REST Interface: /digest/create-signature(s)

Purpose

This operation is called to request the creation of a signature with a qualified signature key.

Interface

SAK REST Interface (siehe [IF_SAK])

Method of use

The operation is called by a client software according to the specification as a POST method on the SAK REST interface (see [IF_SAK]).

Input

Parameter

Type

Description

keyObject

keyObject

Signature key

documents

Document[]

To Signer files

proofReport

ProofReport

Check result of the files

hashAlgorithm

HashAlgorithm

Hash algorithm to use

signatureContainerFormat

String

Signature type

Output

Parameter

Type

Description

signature(s)

String

Created signature(s), e.g.:

{ "123": "MIIHtQYJKoZIhvcNAQcC...

dxteY7b0vcjCgk1aFnxd"}

Error messages

Type

Reason

500

SecureFrameworkException

Table 27: Operation /digest/create-signature(s)

The 'Document' type has the following structure:

Component

Type

Description

JSON definition

id

String

Identifier (uuid) of the document to be checked

{"id":"[STRING]"}

fileName

String

Name of the document to be checked

{"fileName":"[STRING]"}

data

String

Data representation of the document to be checked

{"data":"[STRING]"}

Table 28: Datentyp 'Document'

The type 'ProofReport' has the following structure:

Component

Type

Description

JSON definition

checkedDocuments

checkDocument []

Checking information for a document to be checked

{"checkedDocuments":" [checkDocument[]]"}

creationTime

Number

Name of the document to be checked

{"creationtime":[NUMBER]}

signature

String

Data representation of the document to be checked

{"signature":"[STRING]"}

Table 29: Data type 'ProofReport'

The type 'HashAlgorithm' has the following structure:

Component

Type

Description

JSON definition

oid

String

OID of the hash algorithm to be used

{"oid":"[STRING]"}

name

String

Name of the hash algorithm to be used

{"name":"[STRING]"}

Table 30: Datentyp 'HashAlgorithm'