Struct hkd32::KeyMaterial

pub struct KeyMaterial(_);

Cryptographic key material: 256-bit (32-byte) uniformly random bytestring generated either via a CSRNG or via hierarchical derivation.

This type provides the main key derivation functionality and is used to represent both input and output key material.

Methods

impl KeyMaterial

pub fn random() -> Self

Create random key material using the operating system CSRNG

pub fn from_bech32<S>(encoded: S) -> Result<(String, Self), Error> where
    S: AsRef<str>, 

Decode key material from a Bech32 representation

pub fn from_mnemonic<S>(phrase: S, language: Language) -> Result<Self, Error> where
    S: AsRef<str>, 

Create key material from a 24-word BIP39 mnemonic phrase

pub fn from_bytes(slice: &[u8]) -> Result<Self, Error>

Create new key material from a byte slice.

Byte slice is expected to have been generated by a cryptographically secure random number generator.

pub fn new(bytes: [u8; 32]) -> KeyMaterial

Import existing key material - must be uniformly random!

pub fn as_bytes(&self) -> &[u8]

Borrow the key material as a byte slice

pub fn derive_subkey<P>(self, path: P) -> Self where
    P: AsRef<Path>, 

Derive an output key from the given input key material

pub fn to_bech32<S>(&self, hrp: S) -> Zeroizing<String> where
    S: AsRef<str>, 

Serialize this KeyMaterial as a self-zeroizing Bech32 string

Trait Implementations

impl From<[u8; 32]> for KeyMaterial

fn from(bytes: [u8; 32]) -> Self

Performs the conversion.

impl From<Phrase> for KeyMaterial

fn from(phrase: Phrase) -> KeyMaterial

Convert to KeyMaterial using an empty password

impl<'a> TryFrom<&'a [u8]> for KeyMaterial

type Error = Error

The type returned in the event of a conversion error.

fn try_from(slice: &'a [u8]) -> Result<Self, Error>

Performs the conversion.

impl Drop for KeyMaterial

fn drop(&mut self)

Executes the destructor for this type.

impl Clone for KeyMaterial

fn clone(&self) -> KeyMaterial

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Zeroize for KeyMaterial

fn zeroize(&mut self)

Zero out this object from memory (using Rust or OS intrinsics which ensure the zeroization operation is not "optimized away")