Struct PrivateKeys 

pub struct PrivateKeys { /* private fields */ }

A container for an entity’s private cryptographic keys.

PrivateKeys combines a signing key for creating digital signatures with an encapsulation key for decrypting messages, providing a complete private key package for cryptographic operations.

This type is typically used in conjunction with its public counterpart, PublicKeys, to enable secure communication between entities. The private keys remain with the owner, while the corresponding public keys can be freely shared.

Components

• signing_private_key - A private key used for creating digital signatures. Can be Schnorr, ECDSA, Ed25519, or SSH-based, depending on the security needs.

• encapsulation_private_key - A private key used for decrypting messages that were encrypted using the corresponding public key. Can be X25519 or ML-KEM based.

Security

This struct contains highly sensitive cryptographic material and should be handled with appropriate security measures:

• Minimize serialization and storage of private keys
• Ensure secure memory handling and proper zeroization
• Apply access controls and encryption when at rest
• Consider using hardware security modules for production systems

Examples

use bc_components::{Signer, Verifier, keypair};

// Generate a new key pair with default schemes
let (private_keys, public_keys) = keypair();

// Sign a message using the private keys
let message = b"Hello, world!";
let signature = private_keys.sign(message).unwrap();

// Verify the signature using the corresponding public keys
assert!(public_keys.verify(&signature, message));

Implementations

impl PrivateKeys

pub fn with_keys( signing_private_key: SigningPrivateKey, encapsulation_private_key: EncapsulationPrivateKey, ) -> Self

Restores a PrivateKeys from a SigningPrivateKey and an EncapsulationPrivateKey.

pub fn signing_private_key(&self) -> &SigningPrivateKey

Returns the SigningPrivateKey of this PrivateKeys.

pub fn enapsulation_private_key(&self) -> &EncapsulationPrivateKey

Returns the EncapsulationPrivateKey of this PrivateKeys.

pub fn public_keys(&self) -> Result<PublicKeys>

Trait Implementations

impl AsRef<EncapsulationPrivateKey> for PrivateKeys

fn as_ref(&self) -> &EncapsulationPrivateKey

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

impl AsRef<PrivateKeys> for PrivateKeys

fn as_ref(&self) -> &PrivateKeys

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

impl AsRef<SigningPrivateKey> for PrivateKeys

fn as_ref(&self) -> &SigningPrivateKey

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

impl CBORTagged for PrivateKeys

fn cbor_tags() -> Vec<Tag>

Returns the CBOR tags associated with this type.

impl CBORTaggedDecodable for PrivateKeys

fn from_untagged_cbor(untagged_cbor: CBOR) -> Result<Self>

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 PrivateKeys

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 PrivateKeys

fn clone(&self) -> PrivateKeys

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PrivateKeys

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

Formats the value using the given formatter.

impl Decrypter for PrivateKeys

fn encapsulation_private_key(&self) -> EncapsulationPrivateKey

Returns the encapsulation private key for this decrypter.

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

Decapsulates a shared secret from a ciphertext.

impl Display for PrivateKeys

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

Formats the value using the given formatter.

impl From<PrivateKeys> for CBOR

fn from(value: PrivateKeys) -> Self

Converts to this type from the input type.

impl Hash for PrivateKeys

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 PartialEq for PrivateKeys

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

fn private_keys(&self) -> PrivateKeys

Returns a complete set of private keys for cryptographic operations.

impl ReferenceProvider for PrivateKeys

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 PrivateKeys

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

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

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

Signs a message using default options.

impl TryFrom<CBOR> for PrivateKeys

type Error = Error

The type returned in the event of a conversion error.

fn try_from(cbor: CBOR) -> Result<Self>

Performs the conversion.

impl Eq for PrivateKeys

impl StructuralPartialEq for PrivateKeys