Struct schnorr::keys::Keypair

pub struct Keypair {
    pub secret: SecretKey,
    pub public: PublicKey,
}

An Schnorr keypair.

Fields

secret: SecretKey

The secret half of this keypair.

public: PublicKey

The public half of this keypair.

Methods

impl Keypair

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

Convert this keypair to bytes.

Returns

An array of bytes, [u8; KEYPAIR_LENGTH]. The first SECRET_KEY_LENGTH of bytes is the SecretKey, and the next PUBLIC_KEY_LENGTH bytes is the PublicKey

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

Construct a Keypair from the bytes of a PublicKey and SecretKey.

Inputs

• bytes: an &[u8] representing the scalar for the secret key, and a compressed Edwards-Y coordinate of a point on curve25519, both as bytes. (As obtained from Keypair::to_bytes().)

Warning

Absolutely no validation is done on the key. If you give this function bytes which do not represent a valid point, or which do not represent corresponding parts of the key, then your Keypair will be broken and it will be your fault.

Returns

A Result whose okay value is an Schnorr Keypair or whose error value is an SchnorrError describing the error that occurred.

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

Generate an schnorr keypair.

Example

extern crate rand;
extern crate schnorr;


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

let mut csprng: OsRng = OsRng;
let keypair: Keypair = Keypair::generate(&mut csprng);

Input

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

The caller must also supply a hash function which implements the Digest and Default traits, and which returns 512 bits of output. The standard hash function used is Blake2b-512,

pub fn from_secret(s: &SecretKey) -> Keypair

Derive the PublicKey corresponding to this SecretKey.

Trait Implementations

impl Clone for Keypair

fn clone(&self) -> Keypair

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Keypair

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

Formats the value using the given formatter.

impl Default for Keypair

fn default() -> Keypair

Returns the "default value" for a type.

impl<'d> Deserialize<'d> for Keypair

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

Deserialize this value from the given Serde deserializer.

impl Drop for Keypair

fn drop(&mut self)

Executes the destructor for this type.

impl From<SecretKey> for Keypair

fn from(secret: SecretKey) -> Keypair

Performs the conversion.

impl Readable for Keypair

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

Reads the data necessary to this Readable from the provided reader

impl Serialize for Keypair

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 Keypair

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

Write the data held by this Writeable to the provided writer

impl Zeroize for Keypair

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.