API docs by Redocly

ETSI GS QKD 004 push mode specification, KMS server (1.0.1)

Download OpenAPI specification:

URL: https://qkd-kms.ait.ac.at

Server description of the KMS endpoint processing ETSI GS QKD 004 push mode requests

etsi004

Endpoint for pushing key material.

According to the sequence, after receiving a successful get-key the QKD can push the keys it generates to this endpoint.

Request Body schema: application/json
required
status
required
integer <uint32> (status)
Enum: 0 1 2 3 4 5 6 7 8

Status code:

0 = Successful; HTTP code 200.

1 = Successful connection, but peer not connected; HTTP code 200.

2 = GET_KEY failed because insufficient key available; HTTP code 500.

3 = GET_KEY failed because peer application is not yet connected; HTTP code 400.

4 = No QKD connection available; HTTP code 500.

5 = OPEN_CONNECT failed because the KSID is already in use; HTTP code 400.

6 = TIMEOUT_ERROR: The call failed because the specified TIMEOUT; HTTP code 500.

7 = OPEN failed because requested QoS settings could not be met, counter proposal included in return has occurred; HTTP code 500.

8 = GET_KEY failed because metadata field size insufficient. Returned Metadata_size value holds minimum needed size of metadata; HTTP code 400.

index
required
integer <uint32>

increasing index of the key chunk in the key stream. Wrapping at UINT_MAX.

key_buffer
required
string <base64>
object

Responses

Request samples

Content type
application/json
{
  • "status": 0,
  • "index": 0,
  • "key_buffer": "string",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "metadata": {
    }
}