Struct SecretKeyFactory

pub struct SecretKeyFactory(/* private fields */);

This class handles keyring material for Umbral, by allowing deterministic derivation of SecretKey objects based on labels.

Implementations

impl SecretKeyFactory

pub fn random_with_rng(rng: &mut (impl CryptoRng + RngCore)) -> Self

Creates a secret key factory using the given RNG.

pub fn random() -> Self

Available on crate feature default-rng only.

Creates a secret key factory using the default RNG.

pub fn seed_size() -> usize

Returns the seed size required by from_secure_randomness.

pub fn from_secure_randomness(seed: &[u8]) -> Result<Self, SizeMismatchError>

Creates a secret key factory using the given random bytes.

Warning: make sure the given seed has been obtained from a cryptographically secure source of randomness!

pub fn make_secret(&self, label: &[u8]) -> SecretBox<GenericArray<u8, U64>>

Creates an untyped bytestring deterministically from the given label. This can be used externally to seed some kind of a secret key.

pub fn make_key(&self, label: &[u8]) -> SecretKey

Creates a SecretKey deterministically from the given label.

pub fn make_factory(&self, label: &[u8]) -> Self

Creates a SecretKeyFactory deterministically from the given label.

Trait Implementations

impl Clone for SecretKeyFactory

fn clone(&self) -> SecretKeyFactory

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Display for SecretKeyFactory

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

Formats the value using the given formatter.

impl Drop for SecretKeyFactory

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq for SecretKeyFactory

fn eq(&self, other: &SecretKeyFactory) -> 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 StructuralPartialEq for SecretKeyFactory