Browse Source

Add a README.md, update the package docs (No functional changes).

Yawning Angel 1 year ago
parent
commit
913f04249f
2 changed files with 29 additions and 0 deletions
  1. 24 0
      README.md
  2. 5 0
      doc.go

+ 24 - 0
README.md

@@ -0,0 +1,24 @@
+### Kyber - IND-CCA2-secure Key Encapsulation Mechanism
+#### Yawning Angel (yawning at schwanenlied dot me)
+
+[![GoDoc](https://godoc.org/git.schwanenlied.me/yawning/kyber.git?status.svg)](https://godoc.org/git.schwanenlied.me/yawning/kyber.git)
+
+This package implements the Kyber IND-CCA2-secure key encapsulation
+mechanism (KEM), based on the hardness of solving the learning-with-errors
+(LWE) problem over module lattices as submitted to the NIST Post-Quantum
+Cryptography project.
+
+This implementation is a port of the Public Domain reference implementation
+by Joppe Bos, Léo Ducas, Eike Kiltz , Tancrède Lepoint, Vadim Lyubashevsky,
+John Schanck, Peter Schwabe, Gregor Seiler, and Damien Stehlé.
+
+Additionally implementations of Kyber.AKE and Kyber.UAKE as presented in
+the Kyber paper are included for users that seek an authenticated key
+exchange.
+
+Note that the algorithm is not finalized yet, and may change in a backward
+incompatible manner in the future.  The designers currently recommend
+combining Kyber with an established pre-quantum algorithm like ECDH, and
+using the Kyber-768 parameter set.
+
+For more information, see the [project home page](https://pq-crystals.org/kyber/index.shtml).

+ 5 - 0
doc.go

@@ -18,5 +18,10 @@
 // the Kyber paper are included for users that seek an authenticated key
 // exchange.
 //
+// Note that the algorithm is not finalized yet, and may change in a backward
+// incompatible manner in the future.  The designers currently recommend
+// combining Kyber with an established pre-quantum algorithm like ECDH, and
+// using the Kyber-768 parameter set.
+//
 // For more information, see https://pq-crystals.org/kyber/index.shtml.
 package kyber