Struct schnorr::keys::XSecretKey

pub struct XSecretKey { /* fields omitted */ }

An Extended seceret key for use with Ristretto Schnorr signatures.

Methods

impl XSecretKey

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

Convert this SecretKey into an array of 64 bytes, corresponding to an Ristrettp expanded secreyt key.

Returns

An array of 64 bytes. The first 32 bytes represent the "expanded" secret key, and the last 32 bytes represent the "domain-separation" "nonce".

Examples

use schnorr::*;

let mut csprng = mohan::mohan_rand();
let mini_secret_key: SecretKey = SecretKey::generate(&mut csprng);
let secret_key: XSecretKey = XSecretKey::from(&mini_secret_key);
let secret_key_bytes: [u8; 64] = secret_key.to_bytes();

assert!(&secret_key_bytes[..] != &[0u8; 64][..]);

pub fn from_bytes(bytes: &[u8]) -> Result<XSecretKey, SchnorrError>

Construct an SecretKey from a slice of bytes.

Returns

A Result whose okay value is an EdDSA SecretKey or whose error value is an SignatureError describing the error that occurred.

Examples

use schnorr::*;

let mut csprng = mohan::mohan_rand();
let secret_key: SecretKey = SecretKey::generate(&mut csprng);
let ex_secret_key: XSecretKey = XSecretKey::from(&secret_key);
let bytes: [u8; 64] = ex_secret_key.to_bytes();
let secret_key_again = XSecretKey::from_bytes(&bytes) ?;

pub fn generate<R>(csprng: R) -> XSecretKey where
    R: CryptoRng + Rng, 

Generate an Extended SecretKey directly,

pub fn to_public(&self) -> XPublicKey

Derive the XPublicKey corresponding to this SecretKey.

pub fn as_public(&self) -> &XPublicKey

Return Reference the XPublicKey corresponding to this SecretKey.

pub fn from_secret(secret: &SecretKey) -> XSecretKey

Derive the XSecretKey from given SecretKey.

pub fn derive_intermediate_key(
    &self,
    customize: impl FnOnce(&mut Transcript)
) -> XSecretKey

Returns a intermediate child xprv. Users must provide customize, in order to separate sibling keys from one another through unique derivation paths.

pub fn derive_key(&self, customize: impl FnOnce(&mut Transcript)) -> SecretKey

Returns a leaf private key. Users must provide customize, in order to separate sibling keys from one another through unique derivation paths.

Trait Implementations

impl Clone for XSecretKey

fn clone(&self) -> XSecretKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConstantTimeEq for XSecretKey

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

Determine if two items are equal.

impl Debug for XSecretKey

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

Formats the value using the given formatter.

impl Default for XSecretKey

fn default() -> XSecretKey

Returns the "default value" for a type.

impl Drop for XSecretKey

fn drop(&mut self)

Executes the destructor for this type.

impl Eq for XSecretKey

impl<'_> From<&'_ SecretKey> for XSecretKey

fn from(msk: &SecretKey) -> XSecretKey

Construct an SecretKey from a MiniSecretKey.

Examples

use schnorr::*;

let mini_secret_key: SecretKey = SecretKey::generate(&mut mohan::mohan_rand());
let secret_key: XSecretKey = XSecretKey::from(&mini_secret_key);

impl PartialEq<XSecretKey> for XSecretKey

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Zeroize for XSecretKey

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.