Struct SecretKey

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

A secret key.

Implementations

impl SecretKey

pub const BYTES: usize = 64usize

Number of bytes in a secret key.

pub fn new(sk: [u8; 64]) -> 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 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.

impl SecretKey

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.

impl SecretKey

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

Import a secret key from an OpenSSL-compatible DER file.

pub fn from_pem(pem: &str) -> Result<Self, Error>

Import a secret key from an OpenSSL-compatible PEM file.

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

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

Returns a secret key as bytes.

type Target = [u8; 64]

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.

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

impl StructuralPartialEq for SecretKey