saymrwulf/curve25519-dalek-source
1
0
Fork 0
mirror of https://github.com/saymrwulf/curve25519-dalek-source.git synced 2026-09-06 20:41:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

summarize how types are used & how they relate to one another

Browse source
This commit is contained in:
DebugSteven 2019-02-16 10:57:42 -07:00
parent 29edaa17ac
commit 6797c0969f
1 changed files with 9 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
src/x25519.rs
View file

@ -23,7 +23,8 @@ use curve25519_dalek::scalar::Scalar;
use rand_core::RngCore; use rand_core::RngCore;
use rand_core::CryptoRng; use rand_core::CryptoRng;
/// A DH public key. /// A `PublicKey` is the corresponding public key converted from
/// an `EphemeralSecret` or a `StaticSecret` key.
pub struct PublicKey(pub (crate) MontgomeryPoint); pub struct PublicKey(pub (crate) MontgomeryPoint);
impl From<[u8; 32]> for PublicKey { impl From<[u8; 32]> for PublicKey {
@ -41,7 +42,8 @@ impl PublicKey {
} }
} }
/// A DH ephemeral secret key. /// A `EphemeralSecret` is a short lived Diffie-Hellman secret key
/// used to create a `SharedSecret` when given their `PublicKey`.
pub struct EphemeralSecret(pub (crate) Scalar); pub struct EphemeralSecret(pub (crate) Scalar);
/// Overwrite ephemeral secret key material with null bytes when it goes out of scope. /// Overwrite ephemeral secret key material with null bytes when it goes out of scope.
@ -80,9 +82,9 @@ impl<'a> From<&'a EphemeralSecret> for PublicKey {
} }
/// A static secret key for Diffie-Hellman. Unlike an EphemeralSecret, this key /// A `StaticSecret` is a static Diffie-Hellman secret key that
/// does not enforce that it's used only once, and can be saved and loaded from /// can be saved and loaded to create a `SharedSecret` when given
/// a byte array. /// their `PublicKey`.
pub struct StaticSecret(pub (crate) Scalar); pub struct StaticSecret(pub (crate) Scalar);
/// Overwrite static secret key material with null bytes when it goes out of scope. /// Overwrite static secret key material with null bytes when it goes out of scope.
@ -133,7 +135,8 @@ impl<'a> From<&'a StaticSecret> for PublicKey {
} }
/// A DH SharedSecret /// A `SharedSecret` is a Diffie-Hellman shared secret that’s generated
/// from your `EphemeralSecret` or `StaticSecret` and their `PublicKey`.
pub struct SharedSecret(pub (crate) MontgomeryPoint); pub struct SharedSecret(pub (crate) MontgomeryPoint);
/// Overwrite shared secret material with null bytes when it goes out of scope. /// Overwrite shared secret material with null bytes when it goes out of scope.