Struct Keypair

Source
pub struct Keypair {
    pub secret: SecretKey,
    pub public: PublicKey,
}
Expand description

An WOTS keypair.

Fields§

§secret: SecretKey

The secret half of this keypair.

§public: PublicKey

The public half of this keypair.

Implementations§

Source§

impl Keypair

Source

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

Generate an WOTS keypair.

§Example
use rand::rngs::OsRng;
use wots_rs::Keypair;

let mut csprng = OsRng{};
let keypair: Keypair = Keypair::generate(&mut csprng);
§Input

A CSPRNG with a fill_bytes() method, e.g. rand_os::OsRng.

Source

pub fn sign(&self, message: &[u8]) -> Signature

Sign a message with this Keypair using the WOTS algorithm.

§Inputs
  • message in bytes representation.
§Returns

An WOTS Signature on the message.

§Example
use rand::rngs::OsRng;
use wots_rs::Keypair;

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

let message = b"hello";
let signature = keypair.sign(message);
Source

pub fn verify(&self, message: &[u8], signature: Signature) -> bool

Verify a signature on a message using the WOTS algorithm.

§Inputs
  • message in bytes representation.
  • signature is a purported WOTS Signature on the message.
§Returns

Returns true if the signature was a valid signature created by this Keypair on the message.

§Example
use rand::rngs::OsRng;
use wots_rs::Keypair;

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

let message = b"hello";
let signature = keypair.sign(message);

assert!(keypair.verify(message, signature));

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V