Struct schnorr::keys::SecretKey

pub struct SecretKey(_);

An Schnorr secret key.

Methods

impl SecretKey

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

Convert this secret key to a byte array.

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

View this secret key as a byte array.

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

Construct a SecretKey from a slice of bytes.

Example

use schnorr::*;

let secret_key_bytes: [u8; SECRET_KEY_LENGTH] = [
   157, 097, 177, 157, 239, 253, 090, 096,
   186, 132, 074, 244, 146, 236, 044, 196,
   068, 073, 197, 105, 123, 050, 105, 025,
   112, 059, 172, 003, 028, 174, 127, 096, ];

let secret_key: SecretKey = SecretKey::from_bytes(&secret_key_bytes)?;

Returns

A Result whose okay value is an Schnorr SecretKey or whose error value is an SchnorrError wrapping the internal error that occurred.

pub fn generate<T>(csprng: &mut T) -> SecretKey where
    T: CryptoRng + RngCore, 

Generate a SecretKey from a csprng.

Example

extern crate rand;
extern crate schnorr;

use rand::Rng;
use rand::OsRng;
use schnorr::*;

let mut csprng: OsRng = OsRng::new().unwrap();
let secret_key: SecretKey = SecretKey::generate(&mut csprng);

Afterwards, you can generate the corresponding public—provided you also supply a hash function which implements the Digest and Default traits, and which returns 512 bits of output—via:

let public_key: PublicKey = PublicKey::from_secret(&secret_key);

Input

A CSPRNG with a fill_bytes() method, e.g. rand::ChaChaRng

pub fn to_scalar(&self) -> Scalar

Helper Method to Convert key to scalar

pub fn as_scalar<'a>(&'a self) -> &'a Scalar

View this scalaras a byte array.

pub fn from_scalar(s: Scalar) -> SecretKey

Helper Method to Convert Scalar to Key

Trait Implementations

impl Borrow<Scalar> for SecretKey

fn borrow(&self) -> &Scalar

Immutably borrows from an owned value.

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

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

Determine if two items are equal.

impl Debug for SecretKey

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

Formats the value using the given formatter.

impl Default for SecretKey

fn default() -> SecretKey

Returns the "default value" for a type.

impl<'d> Deserialize<'d> for SecretKey

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'d>, 

Deserialize this value from the given Serde deserializer.

impl Drop for SecretKey

Overwrite secret key material with null bytes when it goes out of scope.

fn drop(&mut self)

Executes the destructor for this type.

impl Eq for SecretKey

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 From<SecretKey> for PublicKey

fn from(source: SecretKey) -> PublicKey

Performs the conversion.

impl From<SecretKey> for Keypair

fn from(secret: SecretKey) -> Keypair

Performs the conversion.

impl PartialEq<SecretKey> for SecretKey

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

fn read(reader: &mut dyn Reader) -> Result<SecretKey, Error>

Reads the data necessary to this Readable from the provided reader

impl Serialize for SecretKey

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl Writeable for SecretKey

fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error>

Write the data held by this Writeable to the provided writer

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.