Update organization of README.md.

This commit is contained in:
Douglas Stebila 2016-10-03 21:26:30 -04:00 committed by GitHub
parent 8546d5a3e7
commit 76b1904791

View File

@ -1,10 +1,12 @@
[![Build Status](https://travis-ci.org/open-quantum-safe/liboqs.svg?branch=master)](https://travis-ci.org/open-quantum-safe/liboqs)
# liboqs
liboqs
======
liboqs is a C library for quantum-safe cryptographic algorithms.
## Overview
Overview
--------
The **Open Quantum Safe (OQS) project** has the goal of developing and prototyping quantum-resistant cryptography.
@ -16,16 +18,20 @@ OQS will also include integrations into application-level protocols to provide e
More information on OQS can be found in slides 6467 of [this presentation](https://www.douglas.stebila.ca/files/research/presentations/20160812-SAC.pdf) by Douglas Stebila.
## Contents
Contents
--------
liboqs currently contains:
- `rand_urandom_chacha20`: pseudorandom number generator seeded from /dev/urandom and expanded using the ChaCha20 stream cipher
- `kex_rlwe_bcns15`: key exchange from the ring learning with errors problem (Bos, Costello, Naehrig, Stebila, *IEEE Symposium on Security & Privacy 2015*, [https://eprint.iacr.org/2014/599](https://eprint.iacr.org/2014/599))
## Building and Running
Building and Running
--------------------
Builds have been tested on Mac OS X 10.11.6, Ubuntu 16.04.1, and Windows 10.
Builds have been tested on Mac OS X 10.11.6, macOS 10.12, Ubuntu 16.04.1, and Windows 10.
### Linux and macOS
To build, clone or download the source from GitHub, then simply type:
@ -41,9 +47,12 @@ To run the tests, simply type:
make check
### Windows
Windows binaries can be generated using the Visual Studio solution in the VisualStudio folder.
## Documentation
Documentation
-------------
Some source files contain inline Doxygen-formatted documentation. The documentation can be generated by running:
@ -51,7 +60,8 @@ Some source files contain inline Doxygen-formatted documentation. The documenta
This will generate the `docs/html` directory.
## Contributing and using
Contributing and using
----------------------
We hope OQS will provide a framework for many post-quantum implementations.
@ -65,8 +75,8 @@ We are also interested in assistance from code reviewers.
Please contact Douglas Stebila <[stebilad@mcmaster.ca](mailto:stebilad@mcmaster.ca)>.
## Current status and plans
Current status and plans
------------------------
Our initial launch was on August 11, 2016, containing a single key exchange algorithm (`kex_rlwe_bcns15`) with a basic test harness.
@ -98,22 +108,25 @@ Over the next few months, we plan to be making the following updates:
In the long term, we are also interested in including post-quantum signature schemes.
## License
License
-------
liboqs is licensed under the MIT License; see [https://github.com/open-quantum-safe/liboqs/blob/master/LICENSE.txt](LICENSE.txt) for details. liboqs includes some third party libraries or modules that are licensed differently; the corresponding subfolder contains the license that applies in that case. In particular:
- `src/kex_rlwe_bcns15`: public domain ([http://unlicense.org](http://unlicense.org))
- `src/rand_urandom_chacha20/external`: public domain
## Team
Team
----
The Open Quantum Safe project is lead by [Michele Mosca](http://faculty.iqc.uwaterloo.ca/mmosca/) (University of Waterloo) and [Douglas Stebila](https://www.douglas.stebila.ca/research/) (McMaster University).
### Contributors
- Tancrède Lepoint (SRI)
- Shravan Mishra (University of Waterloo)
- Alex Parent (University of Waterloo)
- Christian Paquin (Microsoft Research)
- Alex Parent (University of Waterloo)
### Support