Struct elliptic_curve::ecdh::SharedSecret

pub struct SharedSecret<C: Curve> { /* private fields */ }

Shared secret value computed via ECDH key agreement.

Implementations

impl<C: Curve> SharedSecret<C>

pub fn extract<D>(&self, salt: Option<&[u8]>) -> Hkdf<D, SimpleHmac<D>>

where D: BlockSizeUser + Clone + Digest,

Use HKDF (HMAC-based Extract-and-Expand Key Derivation Function) to extract entropy from this shared secret.

This method can be used to transform the shared secret into uniformly random values which are suitable as key material.

The D type parameter is a cryptographic digest function. sha2::Sha256 is a common choice for use with HKDF.

The salt parameter can be used to supply additional randomness. Some examples include:

• randomly generated (but authenticated) string
• fixed application-specific value
• previous shared secret used for rekeying (as in TLS 1.3 and Noise)

After initializing HKDF, use Hkdf::expand to obtain output key material.

pub fn raw_secret_bytes(&self) -> &FieldBytes<C>

This value contains the raw serialized x-coordinate of the elliptic curve point computed from a Diffie-Hellman exchange, serialized as bytes.

When in doubt, use SharedSecret::extract instead.

⚠️ WARNING: NOT UNIFORMLY RANDOM! ⚠️

This value is not uniformly random and should not be used directly as a cryptographic key for anything which requires that property (e.g. symmetric ciphers).

Instead, the resulting value should be used as input to a Key Derivation Function (KDF) or cryptographic hash function to produce a symmetric key. The SharedSecret::extract function will do this for you.

Trait Implementations

impl<C: Curve> Drop for SharedSecret<C>

fn drop(&mut self)

Executes the destructor for this type.

impl<C: Curve> From<GenericArray<u8, <<C as Curve>::UInt as ArrayEncoding>::ByteSize>> for SharedSecret<C>

fn from(secret_bytes: FieldBytes<C>) -> Self

NOTE: this impl is intended to be used by curve implementations to instantiate a SharedSecret value from their respective AffinePoint type.

Curve implementations should provide the field element representing the affine x-coordinate as secret_bytes.

impl<C: Curve> ZeroizeOnDrop for SharedSecret<C>