Struct SecretKey 

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

The private key used for key encapsulation and encryption.

The X-Wing KEM is used which uses ML-KEM-768 (Kyber) and X25519 under the hood.

Implementations

impl SecretKey

pub fn from_seed(seed: &[u8; 32]) -> Self

Construct a secret key from a raw 32-byte X-Wing seed.

pub fn generate() -> Result<Self, Error>

Generate a new secret key from the operating system CSPRNG.

The randomness source is owned by the library rather than caller-supplied: a deterministic or repeated RNG would produce a predictable or duplicated key seed, exposing the secret key. For deterministic derivation from a known seed, use SecretKey::from_seed.

Errors

Error::Rng if the operating system CSPRNG is unavailable.

pub fn public_key(&self) -> PublicKey

Derive the corresponding PublicKey.

impl SecretKey

pub fn unseal( recipient: &SecretKey, ciphertext: &[u8], info: Option<&[u8]>, ) -> Result<Vec<u8>, Error>

Unseal ciphertext with the recipient’s secret key.

Returns

The opened plaintext.

Errors

• Error::EmptyCiphertext if the ciphertext is empty.
• Error::Decode if the ciphertext is invalid
• Error::UnsupportedVersion if the header specifies an unsupported version.
• Error::UnsupportedSuite if the header specifices an unsupported cryptographic suite.
• Error::Unseal if the ciphertext cannot be unsealed.

Trait Implementations

impl Clone for SecretKey

fn clone(&self) -> SecretKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretKey

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

Formats the value using the given formatter.

impl Eq for SecretKey

impl PartialEq for SecretKey

fn eq(&self, other: &SecretKey) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SecretKey

impl ZeroizeOnDrop for SecretKey

SecretKey wraps hpke’s X-Wing PrivateKey, which stores an x_wing::DecapsulationKey. That key implements ZeroizeOnDrop, so dropping a SecretKey wipes the only secret it holds.