Struct x25519_dalek::StaticSecret

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

A Diffie-Hellman secret key that can be used to compute multiple SharedSecrets.

This type is identical to the EphemeralSecret type, except that the StaticSecret::diffie_hellman method does not consume the secret key, and the type provides serialization methods to save and load key material. This means that the secret may be used multiple times (but does not have to be).

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 StaticSecret

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

Available on crate feature static_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 static_secrets only.

Generate a new StaticSecret with the supplied RNG.

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

Available on crate feature static_secrets only.

Generate a new StaticSecret with the supplied RNG.

pub fn random() -> Self

Available on crate features static_secrets and getrandom only.

Generate a new StaticSecret.

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

Available on crate feature static_secrets only.

Extract this key’s bytes for serialization.

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

Available on crate feature static_secrets only.

View this key as a byte array.

Trait Implementations

impl AsRef<[u8]> for StaticSecret

Available on crate feature static_secrets only.

fn as_ref(&self) -> &[u8]

View this key as a byte array.

impl Clone for StaticSecret

fn clone(&self) -> StaticSecret

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for StaticSecret

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

Available on crate feature static_secrets only.

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

Given an x25519 StaticSecret key, compute its corresponding PublicKey.

impl From<[u8; 32]> for StaticSecret

Available on crate feature static_secrets only.

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

Load a secret key from a byte array.

impl Serialize for StaticSecret

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Zeroize for StaticSecret

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.