Struct keybear_core::crypto::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>(csprng: T) -> StaticSecret where
    T: RngCore + CryptoRng, 

Generate an x25519 key.

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

Extract this key's bytes for serialization.

Trait Implementations

impl Clone for StaticSecret

pub fn clone(&self) -> StaticSecret

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Deserialize this value from the given Serde deserializer.

impl Drop for StaticSecret

pub fn drop(&mut self)

Executes the destructor for this type.

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

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

Given an x25519 StaticSecret key, compute its corresponding PublicKey.

impl From<[u8; 32]> for StaticSecret

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

Load a secret key from a byte array.

impl Serialize for StaticSecret

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

Serialize this value into the given Serde serializer.

impl StaticSecretExt for StaticSecret

pub fn verify_file<P>(file: P) -> bool where
    P: AsRef<Path>, 

Check whether there is a file containing the crypto keys.

pub fn new_with_os_rand() -> StaticSecret

Generate a new secret key with the OS random number generator.

pub fn from_file<P>(file: P) -> Result<StaticSecret> where
    P: AsRef<Path>, 

Try to load the crypto keys from our file on the disk.

pub fn save<P>(&self, file: P) -> Result<()> where
    P: AsRef<Path>, 

Save the crypto keys to the file on the disk.

pub fn from_file_or_generate<P>(file: P) -> Result<StaticSecret> where
    P: AsRef<Path>, 

Try to load the crypto key or generate a new one.

impl Zeroize for StaticSecret

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