Struct SecretKey 

pub struct SecretKey { /* private fields */ }

X25519 Diffie-Hellman key exchange private key (RFC 7748).

Generating a key

use crypto::curve25519::x25519::SecretKey;

let alice = SecretKey::generate();
let bob = SecretKey::generate();

Diffie-Hellman key exchange

use crypto::curve25519::x25519::SecretKey;

let alice = SecretKey::generate();
let bob = SecretKey::generate();
let alice_shared = alice.ecdh(&bob.public_key());
let bob_shared = bob.ecdh(&alice.public_key());
assert_eq!(alice_shared, bob_shared);

Conversion from Ed25519

An Ed25519 SecretKey can be converted to an X25519 key via From<&ed25519::SecretKey>.

Security

The shared secret produced by ecdh must not be used directly as an encryption key. Apply a KDF (e.g. HKDF) first.

Implementations

impl SecretKey

pub fn generate() -> SecretKey

pub fn from_bytes(bytes: &[u8; 32]) -> SecretKey

pub fn to_bytes(&self) -> [u8; 32]

pub fn public_key(&self) -> PublicKey

pub fn ecdh(&self, peer: &PublicKey) -> [u8; 32]

Perform a Diffie-Hellman key exchange to derive a shared secret. The shared secret IS NOT SAFE to use directly as an encryption key and an additional key derivation operation must be applied to it.

Trait Implementations

impl Clone for SecretKey

fn clone(&self) -> SecretKey

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SecretKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for SecretKey

impl From<&SecretKey> for SecretKey

fn from(ed25519_key: &SecretKey) -> Self

Converts to this type from the input type.

impl From<&[u8; 32]> for SecretKey

fn from(bytes: &[u8; 32]) -> Self

Converts to this type from the input type.

impl PartialEq for SecretKey

fn eq(&self, other: &SecretKey) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SecretKey

impl TryFrom<&[u8]> for SecretKey

type Error = EllipticCurveError

The type returned in the event of a conversion error.

fn try_from(bytes: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.