Skip to content

Contributing Guide

xvzcf edited this page Sep 23, 2019 · 3 revisions

Contributing to OQS-OpenSSH

Adding a key exchange/authentication algorithm

We use a templating system to generate code that adds support for quantum-safe algorithms in OpenSSH. Adding a new algorithm, whether it be key-exchange or authentication, from liboqs means simply adding algorithm metadata to oqs-template/generate.yml (following the conventions established therein), then running python3 oqs-template/generate.py.

Lifecycle

Release cycle: We aim to make releases of OQS-OpenSSH on a bi-monthly basis, either when there has been a new release of OpenSSH or when we have made changes to our fork.

See the README.md files of liboqs for information about the algorithm lifecycle within the corresponding libraries.

SSH compatibility: The message format used in this fork is not standardized, and is subject to unilateral change at any time without regards to backwards compatibility with previous versions of this fork.

Integration tests

Integration tests are available under the oqs_test directory; see the corresponding README.md for details on how to run the tests locally.

Clone this wiki locally