Struct SigningKey

pub struct SigningKey<T: LamportDigest> { /* private fields */ }

A one-time signing private key.

Implementations

impl<T: LamportDigest> SigningKey<T>

pub fn used(&self) -> bool

Has this key been used.

pub fn random(rng: impl RngCore + CryptoRng) -> SigningKey<T>

Constructs a SigningKey with Digest algorithm type and the specified RNG.

pub fn sign<B: AsRef<[u8]>>(&mut self, data: B) -> LamportResult<Signature<T>>

Signs the data.

Example

use sha2::Sha256;
use rand::SeedableRng;
use rand_chacha::ChaCha12Rng;
use lamport_signature_plus::{LamportFixedDigest, SigningKey};

const SEED: [u8; 32] = [0; 32];
let rng = ChaCha12Rng::from_seed(SEED);
let mut private_key = SigningKey::<LamportFixedDigest<Sha256>>::random(rng);
const MESSAGE: &[u8] = b"hello, world!";
assert!(private_key.sign(MESSAGE).is_ok());

pub fn to_bytes(&self) -> Vec<u8>

Converts the SigningKey to canonical bytes.

pub fn from_bytes<B: AsRef<[u8]>>(input: B) -> LamportResult<Self>

Constructs a SigningKey from canonical bytes.

pub fn split( &self, threshold: usize, shares: usize, rng: impl RngCore + CryptoRng, ) -> LamportResult<Vec<SigningKeyShare<T>>>

Create secret shares of the signing key where threshold are required to combine back into this secret.

pub fn combine(shares: &[SigningKeyShare<T>]) -> LamportResult<Self>

Reconstruct the signing key from the secret shares created by split

Trait Implementations

impl<T: Clone + LamportDigest> Clone for SigningKey<T>

fn clone(&self) -> SigningKey<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + LamportDigest> Debug for SigningKey<T>

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

Formats the value using the given formatter.

impl<'de, T: LamportDigest> Deserialize<'de> for SigningKey<T>

fn deserialize<D>(d: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: LamportDigest> From<&SigningKey<T>> for Vec<u8>

fn from(value: &SigningKey<T>) -> Vec<u8>

Converts to this type from the input type.

impl<T: LamportDigest> From<&SigningKey<T>> for VerifyingKey<T>

fn from(value: &SigningKey<T>) -> Self

Converts to this type from the input type.

impl<T: LamportDigest> From<SigningKey<T>> for Vec<u8>

fn from(value: SigningKey<T>) -> Vec<u8>

Converts to this type from the input type.

impl<T: Hash + LamportDigest> Hash for SigningKey<T>

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<T: Ord + LamportDigest> Ord for SigningKey<T>

fn cmp(&self, other: &SigningKey<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq + LamportDigest> PartialEq for SigningKey<T>

fn eq(&self, other: &SigningKey<T>) -> 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<T: PartialOrd + LamportDigest> PartialOrd for SigningKey<T>

fn partial_cmp(&self, other: &SigningKey<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: LamportDigest> Serialize for SigningKey<T>

fn serialize<S>(&self, s: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: LamportDigest> TryFrom<&[u8]> for SigningKey<T>

type Error = LamportError

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> LamportResult<Self>

Performs the conversion.

impl<T: LamportDigest> TryFrom<&Vec<u8>> for SigningKey<T>

type Error = LamportError

The type returned in the event of a conversion error.

fn try_from(value: &Vec<u8>) -> LamportResult<Self>

Performs the conversion.

impl<T: LamportDigest> TryFrom<Box<[u8]>> for SigningKey<T>

type Error = LamportError

The type returned in the event of a conversion error.

fn try_from(value: Box<[u8]>) -> LamportResult<Self>

Performs the conversion.

impl<T: LamportDigest> TryFrom<Vec<u8>> for SigningKey<T>

type Error = LamportError

The type returned in the event of a conversion error.

fn try_from(value: Vec<u8>) -> LamportResult<Self>

Performs the conversion.

impl<T: LamportDigest> Zeroize for SigningKey<T>

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<T: Eq + LamportDigest> Eq for SigningKey<T>

impl<T: LamportDigest> StructuralPartialEq for SigningKey<T>