Skip to content

Commit

Permalink
Updates README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Kris Kwiatkowski authored and kriskwiatkowski committed Oct 7, 2018
1 parent 0e1ed31 commit 6943ec9
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
# `p751sidh`
# `sidh`

Project provides a Go implementation of (ephemeral) supersingular isogeny Diffie-Hellman (SIDH) and supersingular isogeny key exchange (SIKE), as specified in [SIDH-spec, PQC NIST Submission](http://sike.org/files/SIDH-spec.pdf) (Nov 30, 2017).

The implementation is intended for use on the `amd64` architecture only -- no
generic field arithmetic implementation is provided. Portions of the field
arithmetic were ported from the Microsoft Research implementation.
Portions of the field arithmetic were ported from the Microsoft Research implementation.

The SIDH package does NOT implement key validation. It means that it should only be
used for ephemeral DH. Each keypair should be used at most once.
Expand All @@ -13,7 +11,8 @@ If you feel that SIDH may be appropriate for you, consult your cryptographer.

## Source code
Project provides following packages:
* ``p751toolbox``: P751 field arithmetic, curve computation and isogeny internal functions
* ``p503``: P503 field arithmetic
* ``p751``: P751 field arithmetic
* ``sidh``: Implementation of SIDH key agreement
* ``sike``: Implementation of SIKE PKE and KEM, based on ``sidh`` package

Expand All @@ -23,7 +22,7 @@ At development time following make targets may come handy:
* ``make bench``: benchmarking
* ``make cover``: produces code coverage as txt file (used by travis)

It is possible to add one of following postfixes to each of the targets above, in order to run tests specific to ``-p751toolbox``, ``-sidh`` or ``-sike``.
It is possible to add one of following postfixes to each of the targets above, in order to run tests specific to ``-p503``, ``-p751``, ``-sidh`` or ``-sike``.

## Acknowledgements

Expand Down

0 comments on commit 6943ec9

Please sign in to comment.