Skip to content

Commit

Permalink
Add a security reporting address.
Browse files Browse the repository at this point in the history
Fixes #362.
  • Loading branch information
Jeff R. Allen committed Feb 21, 2019
1 parent 0289915 commit c97e3dd
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 12 deletions.
21 changes: 17 additions & 4 deletions README.md
Expand Up @@ -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
Expand All @@ -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.
20 changes: 12 additions & 8 deletions doc.go
Expand Up @@ -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
Expand All @@ -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

0 comments on commit c97e3dd

Please sign in to comment.