Struct Secret

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

A secret key used to perform key agreement using the counterparty’s public key.

Implementations

impl Secret

pub fn new<R: RngCore + CryptoRng>(rng: &mut R) -> Self

Generate a new secret key using rng.

pub fn new_from_field(sk: Fr) -> Self

Use the supplied field element as the secret key directly.

Warning

This function exists to allow custom key derivation; it’s the caller’s responsibility to ensure that the input was generated securely.

pub fn public(&self) -> Public

Derive a public key for this secret key, using the conventional decaf377 generator.

pub fn diversified_public(&self, diversified_generator: &Element) -> Public

Derive a diversified public key for this secret key, using the provided diversified_generator.

Since key agreement does not depend on the basepoint, only on the secret key and the public key, a single secret key can correspond to many different (unlinkable) public keys.

pub fn key_agreement_with(&self, other: &Public) -> Result<SharedSecret, Error>

Perform key agreement with the provided public key.

Fails if the provided public key is invalid.

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

Convert this shared secret to bytes.

Convenience wrapper around an Into impl.

Trait Implementations

impl Clone for Secret

fn clone(&self) -> Secret

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Secret

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<&Secret> for [u8; 32]

fn from(s: &Secret) -> Self

Converts to this type from the input type.

impl PartialEq for Secret

fn eq(&self, other: &Secret) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&[u8]> for Secret

type Error = Error

The type returned in the event of a conversion error.

fn try_from(slice: &[u8]) -> Result<Secret, Error>

Performs the conversion.

impl TryFrom<[u8; 32]> for Secret

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: [u8; 32]) -> Result<Secret, Error>

Performs the conversion.

impl Zeroize for Secret

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.

impl Eq for Secret

impl StructuralPartialEq for Secret