Struct SecretKey

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

The private/signing key.

Implementations

impl SecretKey

pub fn ecdh(&self, pk: &PublicKey) -> Result<[u8; 32], Error>

Elliptic-curve Diffie-Hellman.

Methods from Deref<Target = SecretKey>

pub const BYTES: usize = 64usize

pub fn public_key(&self) -> PublicKey

Returns the public counterpart of a secret key.

pub fn seed(&self) -> Seed

Returns the seed of a secret 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. The public key is recomputed (not just copied) from the secret key, so this will detect corruption of the secret key.

pub fn sign_incremental(&self, noise: Noise) -> SigningState

Sign a multi-part message (streaming API). It is critical for noise to never repeat.

pub fn sign(&self, message: impl AsRef<[u8]>, noise: Option<Noise>) -> Signature

Computes a signature for the message message using the secret key. The noise parameter is optional, but recommended in order to mitigate fault attacks.

pub fn to_der(&self) -> Vec<u8>

Export a secret key as an OpenSSL-compatible DER file.

pub fn to_pem(&self) -> String

Export a secret key as an OpenSSL-compatible PEM file.

Trait Implementations

impl AsRef<[u8]> for SecretKey

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

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

impl Clone for SecretKey

fn clone(&self) -> SecretKey

Returns a copy 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

type Target = SecretKey

The resulting type after dereferencing.

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

Dereferences the value.

impl From<[u8; 64]> for SecretKey

fn from(bytes: [u8; 64]) -> Self

Converts to this type from the input type.

impl From<SecretKey> for SecretKey

fn from(other: SecretKey) -> Self

Converts to this type from the input type.

impl From<SecretKey> for SecretKey

fn from(other: SecretKey) -> 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 Ord for SecretKey

fn cmp(&self, other: &Self) -> 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 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 PartialOrd for SecretKey

fn partial_cmp(&self, other: &Self) -> 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 TryFrom<&[u8]> for SecretKey

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: &[u8]) -> Result<Self, Error>

Performs the conversion.

impl Zeroize for SecretKey

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 SecretKey

impl StructuralPartialEq for SecretKey