Struct x25519_dalek::StaticSecret

pub struct StaticSecret(_);

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).

Some protocols, such as Noise, already handle the static/ephemeral distinction, so the additional guarantees provided by EphemeralSecret are not helpful or would cause duplicate code paths. In this case, it may be useful to

use x25519_dalek::StaticSecret as SecretKey;

since the only difference between the two is that StaticSecret does not enforce at compile-time that the key is only used once.

Implementations

impl StaticSecret

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

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

Generate an x25519 key.

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

Extract this key’s bytes for serialization.

Trait Implementations

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 Drop for StaticSecret

fn drop(&mut self)

Executes the destructor for this type.

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

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

Given an x25519 StaticSecret key, compute its corresponding PublicKey.

impl From<[u8; 32]> for StaticSecret

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.