Struct x25519_dalek::ReusableSecret

pub struct ReusableSecret(/* private fields */);

A Diffie-Hellman secret key which may be used more than once, but is purposefully not serialiseable in order to discourage key-reuse. This is implemented to facilitate protocols such as Noise (e.g. Noise IK key usage, etc.) and X3DH which require an “ephemeral” key to conduct the Diffie-Hellman operation multiple times throughout the protocol, while the protocol run at a higher level is only conducted once per key.

Similarly to EphemeralSecret, this type does not have serialisation methods, in order to discourage long-term usage of secret key material. (For long-term secret keys, see StaticSecret.)

Warning

If you’re uncertain about whether you should use this, then you likely should not be using this. Our strongly recommended advice is to use EphemeralSecret at all times, as that type enforces at compile-time that secret keys are never reused, which can have very serious security implications for many protocols.

Implementations

impl ReusableSecret

pub fn diffie_hellman(&self, their_public: &PublicKey) -> SharedSecret

Available on crate feature reusable_secrets only.

Perform a Diffie-Hellman key agreement between self and their_public key to produce a SharedSecret.

pub fn new<T: RngCore + CryptoRng>(csprng: T) -> Self

👎Deprecated since 2.0.0: Renamed to random_from_rng. This will be removed in 2.1.0.

Available on crate feature reusable_secrets only.

Generate a new ReusableSecret with the supplied RNG.

pub fn random_from_rng<T: RngCore + CryptoRng>(csprng: T) -> Self

Available on crate feature reusable_secrets only.

Generate a new ReusableSecret with the supplied RNG.

pub fn random() -> Self

Available on crate features reusable_secrets and getrandom only.

Generate a new ReusableSecret.

Trait Implementations

impl Clone for ReusableSecret

fn clone(&self) -> ReusableSecret

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> From<&'a ReusableSecret> for PublicKey

Available on crate feature reusable_secrets only.

fn from(secret: &'a ReusableSecret) -> PublicKey

Given an x25519 ReusableSecret key, compute its corresponding PublicKey.

impl Zeroize for ReusableSecret

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.