zecfoundation
/
ristretto255-dh
mirror of https://github.com/ZcashFoundation/ristretto255-dh.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update readme

This commit is contained in:
Deirdre Connolly 2020-05-07 03:22:16 -04:00 committed by Deirdre Connolly
parent e8221a6331
commit 5149329038
1 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,25 +1,23 @@
# ristretto255-dh
Diffie-Hellman key exchange using the [Ristretto255][ristretto] group, in pure Rust.
This crate provides a high-level API for static and ephemeral Diffie-Hellman in the Ristretto255 prime order group, as specified the [IETF draft][ietf-draft], implemented internally over Curve25519 using [curve25519-dalek].
This crate provides a high-level API for static and ephemeral Diffie-Hellman in the Ristretto255 prime order group, as specified the [IETF draft][ietf-draft], implemented internally over Curve25519 using [curve25519-dalek].
## Example
```
use rand_os::OsRng;
use rand::rngs::OsRng;
use ristretto255_dh::EphemeralSecret;
use ristretto255_dh::PublicKey;
// Alice's side
let mut alice_csprng = OsRng::new().unwrap();
let alice_secret = EphemeralSecret::new(&mut alice_csprng);
let alice_secret = EphemeralSecret::new(&mut OsRng);
let alice_public = PublicKey::from(&alice_secret);
// Bob's side
let mut bob_csprng = OsRng::new().unwrap();
let bob_secret = EphemeralSecret::new(&mut bob_csprng);
let bob_secret = EphemeralSecret::new(&mut OsRng);
let bob_public = PublicKey::from(&bob_secret);
// Alice again
@ -29,7 +27,7 @@ let alice_shared_secret = alice_secret.diffie_hellman(&bob_public);
let bob_shared_secret = bob_secret.diffie_hellman(&alice_public);
// Each peer's computed shared secret should be the same.
assert_eq!(alice_shared_secret.as_bytes(), bob_shared_secret.as_bytes());
assert_eq!(<[u8; 32]>::from(alice_shared_secret), <[u8; 32]>::from(bob_shared_secret));
```
# Installation
@ -43,7 +41,7 @@ version = "0.1.0"
## About
The high-level Diffie-Hellman API is inspired by [x25519-dalek].
The high-level Diffie-Hellman API is inspired by [x25519-dalek].
[curve25519-dalek]: https://github.com/dalek-cryptography/curve25519-dalek
[ietf-draft]: https://ietf.org/id/draft-irtf-cfrg-ristretto255-00.html