Struct SecretKey 

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

A r255b3 secret key to sign messages with.

This is a scalar mod the group order of Ristretto255, sligtly more than 2²⁵².

Implementations

impl SecretKey

pub fn parse_bytes(bits: [u8; 32]) -> Result<SecretKey, Error>

Parse a secret key from an externally provided byte array, ensuring that it is a valid key.

Use SecretKey::from_bytes for key generation.

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

Render the secret key into a byte array for external use.

pub fn from_bytes(value: [u8; 32]) -> SecretKey

Construct a secret key from 256 arbitrary bits,

Use SecretKey::parse_bytes if you are reading this key from storage or anything like that.

pub fn sign(&self, domain: Domain, msg: &[u8]) -> Signature

Sign a message, in a particular domain, with a derived nonce.

This is the primary signing method.

Non-application specific signatures may use empty Domain, “”.

pub fn derive_public(&self) -> PublicKey

Derive the public key from the secret key.

(Scales the base point by the secret key.)

pub fn derive_keys(&self) -> Keys

Derive a complete signing key from the secret key.

pub fn scale(&self, by: Scalar) -> Self

Scale by a public scalar to derive a subkey.

Scaling the corresponding public key by the same scalar produces a valid key pair.

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

fn ct_eq(&self, other: &Self) -> Choice

Determine if two items are equal.

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal.

impl Debug for SecretKey

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

impl PartialEq for SecretKey

This is constant time.

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