Struct SecretKey 

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

A secret key.

Implementations

impl SecretKey

pub fn from_ed25519(edsk: &EdSecretKey) -> Result<SecretKey, Error>

Convert an Ed25519 secret key to a X25519 secret key.

impl SecretKey

pub const BYTES: usize = 32

Number of bytes in a secret key.

pub fn new(sk: [u8; 32]) -> Self

Creates a secret key from raw bytes.

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

Creates a secret key from a slice.

pub fn clamped(&self) -> SecretKey

Perform the X25519 clamping magic

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

Recover the public key

pub fn validate_public_key(&self, pk: &PublicKey) -> Result<(), Error>

Returns Ok(()) if the given public key is the public counterpart of this secret key. Returns Err(Error::InvalidPublicKey) otherwise.

Trait Implementations

impl Clone for SecretKey

fn clone(&self) -> SecretKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretKey

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

Formats the value using the given formatter.

impl Deref for SecretKey

fn deref(&self) -> &Self::Target

Returns a secret key as bytes.

type Target = [u8; 32]

The resulting type after dereferencing.

impl DerefMut for SecretKey

fn deref_mut(&mut self) -> &mut Self::Target

Returns a secret key as mutable bytes.

impl Drop for SecretKey

fn drop(&mut self)

Executes the destructor for this type.

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.

impl Eq for SecretKey

impl From<DHOutput> for SecretKey

fn from(dh: DHOutput) -> Self

Converts to this type from the input type.

impl Hash for SecretKey

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

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 PartialEq for SecretKey

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