vexahub/opaque-vx
5
0
Fork 0
Code Issues 1 Pull Requests 3 Actions Releases 3 Activity

Merge pull request #5 from kevinlewi/add_readme_precaution

Browse Source 
Adding note on draft status in doc comments
This commit is contained in:
Kevin Lewi
2020-06-10 14:53:06 -07:00
committed by GitHub
parent 88696763cc af22bfa54f
commit 05fb76d5b7
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/lib.rs
+4 -3
View File
@@ -5,6 +5,9 @@
//! An implementation of the OPAQUE asymmetric password authentication key exchange protocol //! An implementation of the OPAQUE asymmetric password authentication key exchange protocol
//! //!
//! Note: This implementation is in sync with [draft-krawczyk-cfrg-opaque-05](https://tools.ietf.org/html/draft-krawczyk-cfrg-opaque-05),
//! but this specification is subject to change, until the final version published by the IETF.
//!
//! # Overview //! # Overview
//! //!
//! OPAQUE is a protocol between a client and a server. They must first agree on a collection of primitives //! OPAQUE is a protocol between a client and a server. They must first agree on a collection of primitives
@@ -20,11 +23,9 @@
//! use opaque_ke::keypair::X25519KeyPair; //! use opaque_ke::keypair::X25519KeyPair;
//! ``` //! ```
//! //!
//! This implementation is in sync with [draft-krawczyk-cfrg-opaque-05](https://tools.ietf.org/html/draft-krawczyk-cfrg-opaque-05), //! We have included a concrete instantiation of the authenticated key exchange protocol using 3DH. In the future, we plan to
//! with a concrete instantiation of the authenticated key exchange protocol using 3DH. In the future, we plan to
//! add support for other KE protocols as well. //! add support for other KE protocols as well.
//! //!
//!
//! ## Setup //! ## Setup
//! To setup the protocol, the server begins by generating a static keypair: //! To setup the protocol, the server begins by generating a static keypair:
//! ``` //! ```