Skip to content

Latest commit

 

History

History
45 lines (36 loc) · 1.73 KB

README.md

File metadata and controls

45 lines (36 loc) · 1.73 KB

QKD API

More can be found here:

uint32_t QKD_OPEN(ip_address_t destination, qos_t qos, key_handle_t key_handle);

Establishes a set of parameters that define the expected levels of key service.

  • :param destination: address of peer application
  • :param qos: a structure describing the characteristics of the requested key source
  • :param key_handle: a unique handle to identify the group of synchronized bits provided by the QKD key manager to the application
  • :return: status of operation
uint32_t QKD_CONNECT_NONBLOCK(key_handle_t key_handle, uint32_t timeout);
uint32_t QKD_CONNECT_BLOCKING(key_handle_t key_handle, uint32_t timeout);
  • :param key_handle: a unique handle to identify the group of synchronized bits provided by the QKD key manager to the application
  • :param timeout:
  • :return: status of operation
uint32_t QKD_GET_KEY(key_handle_t key_handle, char *key_buffer);

Obtains the required amount of key material requested for this key_handle. Each call returns the fixed amount of requested key stored in key_buffer.

  • :param key_handle: a unique handle to identify the group of synchronized bits provided by the QKD key manager to the application
  • :param key_buffer: buffer containing the current stream of keys
  • :return: status of operation
uint32_t QKD_CLOSE(key_handle_t key_handle);

Terminates the association established for this key_handle.

  • :param key_handle: a unique handle to identify the group of synchronized bits provided by the QKD key manager to the application
  • :return: status of operation