API docs by Redocly

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

Download OpenAPI specification:

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

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

etsi004

open key stream

The open-connect message connects a KMS to the QKD Device. As per sequence definition, the QKD device will assign the key_stream_id at the source node, therefore null has to be given as key_stream_id input parameter. At the destination, the key_stream_id has to be specified to the same value given at the source. The QKD can suggest alternative QoS due to its capabilities.

Request Body schema: application/json
required
source
required
string <uri>

the source URI of the request.

destination
required
string <uri>

the destination URI of the request.

key_stream_id
required
string <uuid>

ID of the key stream. If null specified it is up to the QKD device to define the UUID. At the destination it should match the source key_stream_id.

required
object (qos)

All values according to ETSI GS QKD 004 specification. If KMS does not want to specify a parameter, it is up to the choice of the QKD. Either the value is given as "null" or not present.

Responses

Request samples

Content type
application/json
{
  • "source": "http://kms-1.net",
  • "destination": "http://kms-2.net",
  • "key_stream_id": "4eb81a5c-031f-4d1f-881d-309bee44fc20",
  • "qos": {
    }
}

Response samples

Content type
application/json
{
  • "key_stream_id": "4eb81a5c-031f-4d1f-881d-309bee44fc20",
  • "qos": {
    },
  • "status": 0
}

Start the pushed key retrieval process.

The get-key message informs the QKD device that it can start pushing keys.

Request Body schema: application/json
required
key_stream_id
required
string <uuid>

corresponding to the one given in open-connect.

index
integer <uint32>

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

object (metadata)

Responses

Request samples

Content type
application/json
{
  • "key_stream_id": "4eb81a5c-031f-4d1f-881d-309bee44fc20",
  • "index": 0,
  • "metadata": {
    }
}

Response samples

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

close the key stream

The close message disconnects the KMS from the QKD device.

Request Body schema: application/json
required
key_stream_id
required
string <uuid>

corresponding to the one given in open-connect.

Responses

Request samples

Content type
application/json
{
  • "key_stream_id": "4eb81a5c-031f-4d1f-881d-309bee44fc20"
}

Response samples

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