Struct PrivateKeyBase 

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

A secure foundation for deriving multiple cryptographic keys.

PrivateKeyBase serves as a root of cryptographic material from which various types of keys can be deterministically derived. It securely manages the underlying key material and provides methods to derive specific cryptographic keys for different purposes.

It supports:

• Deterministic derivation of signing keys (Schnorr, ECDSA, Ed25519)
• Deterministic derivation of encryption keys (X25519)
• SSH key generation for various algorithms (Ed25519, ECDSA, DSA, RSA)
• Key pair generation for both signing and encryption

This design allows a single master seed to generate multiple secure keys for different cryptographic operations, similar to the concept of an HD wallet in cryptocurrency systems.

Security

PrivateKeyBase implements ZeroizeOnDrop to securely erase the sensitive key material from memory when the object is dropped, reducing the risk of key extraction via memory attacks.

Examples

Creating and using a PrivateKeyBase:

use bc_components::{
    PrivateKeyBase, PrivateKeysProvider, PublicKeysProvider, Signer,
};

// Create a new random PrivateKeyBase
let key_base = PrivateKeyBase::new();

// Sign a message using the derived Schnorr key
let message = b"Hello, world!";
let signature = key_base.sign(message).unwrap();

// Generate a key pair for public/private key operations
let (private_keys, public_keys) =
    (key_base.private_keys(), key_base.public_keys());

Implementations

impl PrivateKeyBase

pub fn new() -> PrivateKeyBase

Generate a new random PrivateKeyBase.

pub fn from_data(data: impl AsRef<[u8]>) -> PrivateKeyBase

Restores a PrivateKeyBase from bytes.

pub fn from_optional_data(data: Option<impl AsRef<[u8]>>) -> PrivateKeyBase

Restores a PrivateKeyBase from an optional reference to an array of bytes.

If the data is None, a new random PrivateKeyBase is generated.

pub fn new_using(rng: &mut impl RandomNumberGenerator) -> PrivateKeyBase

Generate a new random PrivateKeyBase using the given random number generator.

pub fn new_with_provider( provider: impl PrivateKeyDataProvider, ) -> PrivateKeyBase

Create a new PrivateKeyBase from the given private keys data provider.

pub fn ecdsa_signing_private_key(&self) -> SigningPrivateKey

Derive a new ECDSA SigningPrivateKey from this PrivateKeyBase.

pub fn schnorr_signing_private_key(&self) -> SigningPrivateKey

Derive a new Schnorr SigningPrivateKey from this PrivateKeyBase.

pub fn ed25519_signing_private_key(&self) -> SigningPrivateKey

Derive a new Ed25519 SigningPrivateKey from this PrivateKeyBase.

pub fn ssh_signing_private_key( &self, algorithm: Algorithm, comment: impl Into<String>, ) -> Result<SigningPrivateKey, Error>

Derive a new SSH SigningPrivateKey from this PrivateKeyBase.

pub fn x25519_private_key(&self) -> X25519PrivateKey

Derive a new X25519PrivateKey from this PrivateKeyBase.

An X25519 key for public key encryption.

pub fn schnorr_private_keys(&self) -> PrivateKeys

Derive a new PrivateKeys from this PrivateKeyBase.

• Includes a Schnorr private key for signing.
• Includes an X25519 private key for encryption.

pub fn schnorr_public_keys(&self) -> PublicKeys

Derive a new PublicKeys from this PrivateKeyBase.

• Includes a Schnorr public key for signing.
• Includes an X25519 public key encryption.

pub fn ecdsa_private_keys(&self) -> PrivateKeys

Derive a new PrivateKeys from this PrivateKeyBase.

• Includes an ECDSA private key for signing.
• Includes an X25519 private key for encryption.

pub fn ecdsa_public_keys(&self) -> PublicKeys

Derive a new PublicKeys from this PrivateKeyBase.

• Includes an ECDSA public key for signing.
• Includes an X25519 public key for encryption.

pub fn ssh_private_keys( &self, algorithm: Algorithm, comment: impl Into<String>, ) -> Result<PrivateKeys, Error>

Derive a new PrivateKeys from this PrivateKeyBase.

• Includes an SSH private key for signing.
• Includes an X25519 private key for encryption.

pub fn ssh_public_keys( &self, algorithm: Algorithm, comment: impl Into<String>, ) -> Result<PublicKeys, Error>

Derive a new PublicKeys from this PrivateKeyBase.

• Includes an SSH public key for signing.
• Includes an X25519 public key for encryption.

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

Get the raw data of this PrivateKeyBase.

Trait Implementations

impl AsRef<[u8]> for PrivateKeyBase

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<PrivateKeyBase> for PrivateKeyBase

fn as_ref(&self) -> &PrivateKeyBase

Converts this type into a shared reference of the (usually inferred) input type.

impl CBORTagged for PrivateKeyBase

fn cbor_tags() -> Vec<Tag>

Returns the CBOR tags associated with this type.

impl CBORTaggedDecodable for PrivateKeyBase

fn from_untagged_cbor(untagged_cbor: CBOR) -> Result<PrivateKeyBase, Error>

Creates an instance of this type by decoding it from untagged CBOR.

fn from_tagged_cbor(cbor: CBOR) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from tagged CBOR.

fn from_tagged_cbor_data(data: impl AsRef<[u8]>) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from binary encoded tagged CBOR.

fn from_untagged_cbor_data(data: impl AsRef<[u8]>) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from binary encoded untagged CBOR.

impl CBORTaggedEncodable for PrivateKeyBase

fn untagged_cbor(&self) -> CBOR

Returns the untagged CBOR encoding of this instance.

fn tagged_cbor(&self) -> CBOR

Returns the tagged CBOR encoding of this instance.

fn tagged_cbor_data(&self) -> Vec<u8>

Returns the tagged value in CBOR binary representation.

impl Clone for PrivateKeyBase

fn clone(&self) -> PrivateKeyBase

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PrivateKeyBase

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

Formats the value using the given formatter.

impl Decrypter for PrivateKeyBase

fn encapsulation_private_key(&self) -> EncapsulationPrivateKey

Returns the encapsulation private key for this decrypter.

fn decapsulate_shared_secret( &self, ciphertext: &EncapsulationCiphertext, ) -> Result<SymmetricKey, Error>

Decapsulates a shared secret from a ciphertext.

impl Default for PrivateKeyBase

fn default() -> PrivateKeyBase

Returns the “default value” for a type.

impl Display for PrivateKeyBase

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

Formats the value using the given formatter.

impl Drop for PrivateKeyBase

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> From<&'a PrivateKeyBase> for &'a [u8]

fn from(value: &'a PrivateKeyBase) -> &'a [u8]

Converts to this type from the input type.

impl From<PrivateKeyBase> for CBOR

fn from(value: PrivateKeyBase) -> CBOR

Converts to this type from the input type.

impl From<PrivateKeyBase> for Envelope

fn from(value: PrivateKeyBase) -> Self

Converts this value into an envelope.

impl PartialEq for PrivateKeyBase

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

Available on crate feature secp256k1 only.

fn private_keys(&self) -> PrivateKeys

Returns a complete set of private keys for cryptographic operations.

impl PublicKeysProvider for PrivateKeyBase

Available on crate feature secp256k1 only.

fn public_keys(&self) -> PublicKeys

Returns a complete set of public keys for cryptographic operations.

impl ReferenceProvider for PrivateKeyBase

fn reference(&self) -> Reference

Returns a cryptographic reference that uniquely identifies this object.

fn ref_hex(&self) -> String

Returns the reference data as a hexadecimal string.

fn ref_data_short(&self) -> [u8; 4]

Returns the first four bytes of the reference.

fn ref_hex_short(&self) -> String

Returns the first four bytes of the reference as a hexadecimal string.

fn ref_bytewords(&self, prefix: Option<&str>) -> String

Returns the first four bytes of the reference as upper-case ByteWords.

fn ref_bytemoji(&self, prefix: Option<&str>) -> String

Returns the first four bytes of the reference as Bytemoji.

impl Signer for PrivateKeyBase

Available on crate feature secp256k1 only.

fn sign_with_options( &self, message: &dyn AsRef<[u8]>, options: Option<SigningOptions>, ) -> Result<Signature, Error>

Signs a message with additional options specific to the signature scheme.

fn sign(&self, message: &dyn AsRef<[u8]>) -> Result<Signature, Error>

Signs a message using default options.

impl TryFrom<CBOR> for PrivateKeyBase

type Error = Error

The type returned in the event of a conversion error.

fn try_from( cbor: CBOR, ) -> Result<PrivateKeyBase, <PrivateKeyBase as TryFrom<CBOR>>::Error>

Performs the conversion.

impl TryFrom<Envelope> for PrivateKeyBase

type Error = Error

The type returned in the event of a conversion error.

fn try_from(envelope: Envelope) -> Result<Self>

Performs the conversion.

impl Verifier for PrivateKeyBase

Available on crate feature secp256k1 only.

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

Verifies a signature against a message.

impl Eq for PrivateKeyBase

impl StructuralPartialEq for PrivateKeyBase