diff --git a/README.md b/README.md index 6eb606bb2..e6d544d82 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ main package is. Installing ---------- -First make sure you have [Go](https://golang.org) version 1.8 or newer installed. +First make sure you have [Go](https://golang.org) version 1.11 or newer installed. The basic crypto library requires only Go and a few third-party Go-language dependencies that can be installed automatically @@ -58,6 +58,19 @@ Traditionally, ECDH (Elliptic curve Diffie-Hellman) derives the shared secret from the x point only. In this framework, you can either manually retrieve the value or use the MarshalBinary method to take the combined (x, y) value as the shared secret. We recommend the latter process for new softare/protocols using -this framework as it is cleaner and generalizes across different types of -groups (e.g., both integer and elliptic curves), although it will likely be -incompatible with other implementations of ECDH. See [the Wikipedia page](http://en.wikipedia.org/wiki/Elliptic_curve_Diffie%E2%80%93Hellman) on ECDH. +this framework as it is cleaner and generalizes across different types of groups +(e.g., both integer and elliptic curves), although it will likely be +incompatible with other implementations of ECDH. See [the Wikipedia +page](http://en.wikipedia.org/wiki/Elliptic_curve_Diffie%E2%80%93Hellman) on +ECDH. + +Reporting security problems +--------------------------- + +This library is offered as-is, and without a guarantee. It will need an +independent security review before it should be considered ready for use in +security-critical applications. If you integrate Kyber into your application it +is YOUR RESPONSIBILITY to arrange for that audit. + +If you notice a possible security problem, please report it +to dedis-security@epfl.ch. diff --git a/doc.go b/doc.go index 6e1637e0e..b20959ef6 100644 --- a/doc.go +++ b/doc.go @@ -91,14 +91,7 @@ that keep the sources of individual votes or bids private without anyone having to trust more than one of the shuffler(s) to shuffle votes/bids honestly. -Disclaimer - -For now this library should currently be considered experimental: it will -definitely be changing in non-backward-compatible ways, and it will need -independent security review before it should be considered ready for use in -security-critical applications. However, we intend to bring the library closer -to stability and real-world usability as quickly as development resources -permit, and as interest and application demand dictates. +Target Use-cases As should be obvious, this library is intended to be used by developers who are at least moderately knowledgeable about @@ -115,5 +108,16 @@ to is the Charm rapid prototyping library for Python This library incorporates and/or builds on existing code from a variety of sources, as documented in the relevant sub-packages. + +Reporting Security Problems + +This library is offered as-is, and without a guarantee. It will need an +independent security review before it should be considered ready for use in +security-critical applications. If you integrate Kyber into your application it +is YOUR RESPONSIBILITY to arrange for that audit. + +If you notice a possible security problem, please report it +to dedis-security@epfl.ch. + */ package kyber