embassy-crypto

Crates

git

Versions

default

Flavors

Skip to main content

SecretKey

Struct SecretKey 

Source
pub struct SecretKey(/* private fields */);
Expand description

An ECDH private key: a nonzero scalar.

Served by the curve’s ECDH driver. Zeroed on drop.

Implementations§

Source§

impl SecretKey

Source

pub fn generate() -> Result<Self, Error>

Generate a random private key.

Source

pub fn from_bytes(bytes: &[u8; 48]) -> Result<Self, Error>

Load a private key from its big-endian encoding. Fails if it is zero or not less than n.

Source

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

The private key as big-endian bytes.

Source

pub fn to_scalar(&self) -> Scalar

The private key as a scalar.

Source

pub fn public_key(&self) -> Result<PublicKey, Error>

The corresponding public key.

Source

pub fn diffie_hellman(&self, peer: &PublicKey) -> Result<SharedSecret, Error>

The shared secret with peer: the X coordinate of self * peer.

Trait Implementations§

Source§

impl Clone for SecretKey

Source§

fn clone(&self) -> SecretKey

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SecretKey

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for SecretKey

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl TryFrom<Scalar> for SecretKey

Source§

type Error = Error

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

fn try_from(k: Scalar) -> Result<Self, Error>

Performs the conversion.

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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>,

Source§

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.