https://github.com/nanoy42/etsi-qkd-014-client

Python client for ETSI QKD 014 standard
https://github.com/nanoy42/etsi-qkd-014-client

Last synced: about 1 month ago
JSON representation

Python client for ETSI QKD 014 standard

• Host: GitHub
• URL: https://github.com/nanoy42/etsi-qkd-014-client
• Owner: nanoy42
• License: lgpl-3.0
• Created: 2022-11-26T16:09:53.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-26T08:48:40.000Z (10 months ago)
• Last Synced: 2024-10-12T13:44:24.890Z (2 months ago)
• Language: Python
• Size: 44.9 KB
• Stars: 1
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
# etsi_qkd_014_client

[![Documentation Status](https://readthedocs.org/projects/dinomail/badge/?version=latest)](https://dinomail.readthedocs.io/en/latest/?badge=latest)

[![License: GPL v3](https://img.shields.io/badge/License-LGPLv3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)

[![Code style black](https://img.shields.io/badge/code%20style-black-000000.svg)]("https://github.com/psf/black)

[![GitHub release](https://img.shields.io/github/release/nanoy42/etsi-qkd-014-client.svg)](https://github.com/nanoy42/etsi-qkd-014-client/releases/)

The ETSI GS QKD 014 specification is a specification for communication between a client and a QKD module to retrieve cryptographic keys that have been exchanged using a Quantum Key Distribution protocol.

The specifications can be found at the following address : 

The current version of the software uses the version V1.1.1 of the specifications (version from 2019-02).

## Features

* Connect to a QKD server, using a custom CA, key and cert;

* Retrieve status of the QKD server with the `get_status` command;

* Retrieve a secure key using the `get_key` command;

* Retrieve a secure key knowing the key's ID using the `get_key_with_key_IDs` command.

## Documentation

The full documentation can be found at https://etsi-qkd-014-client.readthedocs.io/en/latest/.

## License

This software is distributed under the GNU Lesser General Public License v3 ([GNU LGPLv3](https://www.gnu.org/licenses/lgpl-3.0.en.html)). A copy of the complete text of the license is included with the software (the LICENSE file).

The header of the license can be found below :

> Copyright (C) 2022 Yoann Piétri

> Copyright (C) 2022 LIP6 - Sorbonne Université

>

> etsi-qkd-14-client is free software: you can redistribute it and/or modify

> it under the terms of the GNU Lesser General Public License as published > by

> the Free Software Foundation, either version 3 of the License, or

> (at your option) any later version.

>

> etsi-qkd-14-client is distributed in the hope that it will be useful,

> but WITHOUT ANY WARRANTY; without even the implied warranty of

> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

> GNU Lesser General Public License for more details.

>

> You should have received a copy of the GNU Lesser General Public License

> along with etsi-qkd-14-client. If not, see .

## Citation

If you use this software, please consider citation. Here is the biblatex entry :

```latex

@software{etsi_qkd_014_client,

  author = {{Yoann Piétri}},

  title = {ETSI QKD 014 client},

  url = {https://github.com/nanoy42/etsi_qkd_014_client},

  version = {0.9.0},

  date = {2022-11-27},

}

```

If `@software` is not available, you can also use

```latex

@misc{etsi_qkd_014_client,

  author = {{Yoann Piétri}},

  title = {ETSI QKD 014 client},

  url = {https://github.com/nanoy42/etsi_qkd_014_client},

  date = {2022-11-27},

}

```

Plain text citation :

> Yoann Piétri. (2022). ETSI QKD 014 client (0.9.0) [Computer software].