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

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§

source§

impl StaticSecret

source

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.

source

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.

source

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.

source

pub fn random() -> Self

Available on crate features static_secrets and getrandom only.

Generate a new StaticSecret.

source

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

Available on crate feature static_secrets only.

Extract this key’s bytes for serialization.

source

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

Available on crate feature static_secrets only.

View this key as a byte array.

Trait Implementations§

source§

impl AsRef<[u8]> for StaticSecret

Available on crate feature static_secrets only.
source§

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

View this key as a byte array.

source§

impl Clone for StaticSecret

source§

fn clone(&self) -> StaticSecret

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

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

Available on crate feature static_secrets only.
source§

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

Given an x25519 StaticSecret key, compute its corresponding PublicKey.

source§

impl From<[u8; 32]> for StaticSecret

Available on crate feature static_secrets only.
source§

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

Load a secret key from a byte array.

source§

impl Serialize for StaticSecret

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl Zeroize for StaticSecret

source§

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.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,