Struct SharedSecret

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

Enables two parties to create a shared secret without revealing their own secrets.

Examples

let s = Secp256k1::new();
let (sk1, pk1) = s.generate_keypair(&mut rand::thread_rng());
let (sk2, pk2) = s.generate_keypair(&mut rand::thread_rng());
let sec1 = SharedSecret::new(&pk2, &sk1);
let sec2 = SharedSecret::new(&pk1, &sk2);
assert_eq!(sec1, sec2);

Implementations

impl SharedSecret

pub fn display_secret(&self) -> DisplaySecret

Formats the explicit byte value of the shared secret kept inside the type as a little-endian hexadecimal string using the provided formatter.

This is the only method that outputs the actual shared secret value, and, thus, should be used with extreme caution.

Examples

use secp256k1::{SecretKey, PublicKey};
use secp256k1::ecdh::SharedSecret;


let secret = SharedSecret::new(&pk, &sk);
// Here we explicitly display the secret value:
assert_eq!(
    format!("{}", secret.display_secret()),
    "cf05ae7da039ddce6d56dd57d3000c6dd91c6f1695eae47e05389f11e2467043"
);
// Also, we can explicitly display with `Debug`:
assert_eq!(
    format!("{:?}", secret.display_secret()),
    format!("DisplaySecret(\"{}\")", secret.display_secret())
);

impl SharedSecret

pub fn non_secure_erase(&mut self)

Attempts to erase the contents of the underlying array.

Note, however, that the compiler is allowed to freely copy or move the contents of this array to other places in memory. Preventing this behavior is very subtle. For more discussion on this, please see the documentation of the zeroize crate.

impl SharedSecret

pub fn new(point: &PublicKey, scalar: &SecretKey) -> SharedSecret

Creates a new shared secret from a pubkey and secret key.

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

Returns the shared secret as a byte value.

pub fn from_bytes(bytes: [u8; 32]) -> SharedSecret

Creates a shared secret from bytes array.

pub fn from_slice(bytes: &[u8]) -> Result<SharedSecret, Error>

Creates a shared secret from bytes slice.

Trait Implementations

impl AsRef<[u8]> for SharedSecret

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

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<[u8]> for SharedSecret

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

Immutably borrows from an owned value.

impl Clone for SharedSecret

fn clone(&self) -> SharedSecret

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SharedSecret

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SharedSecret

fn deserialize<D>(d: D) -> Result<SharedSecret, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for SharedSecret

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<SharedSecret, Error>

Parses a string s to return a value of this type.

impl Hash for SharedSecret

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SharedSecret

fn cmp(&self, other: &SharedSecret) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SharedSecret

fn eq(&self, other: &SharedSecret) -> 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 PartialOrd for SharedSecret

fn partial_cmp(&self, other: &SharedSecret) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for SharedSecret

fn serialize<S>( &self, s: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for SharedSecret

impl Eq for SharedSecret

impl StructuralPartialEq for SharedSecret