Struct KeyPair 

pub struct KeyPair<PublicKey: ByteArray<{ CRYPTO_KEM_XWING_PUBLICKEYBYTES }> + Zeroize, SecretKey: ByteArray<{ CRYPTO_KEM_XWING_SECRETKEYBYTES }> + Zeroize> {
    pub public_key: PublicKey,
    pub secret_key: SecretKey,
}

An X-Wing key pair.

Fields

public_key: PublicKey

Public key, shared with senders.

secret_key: SecretKey

Secret key.

Implementations

impl KeyPair<Protected<HeapByteArray<{ $pk_bytes }>, ReadWrite, Locked>, Protected<HeapByteArray<{ $sk_bytes }>, ReadWrite, Locked>>

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

Available on crate feature protected only.

Returns a new randomly generated locked key pair.

Errors

Returns Error::Io if an allocation cannot be locked.

impl KeyPair<Protected<HeapByteArray<{ $pk_bytes }>, ReadOnly, Locked>, Protected<HeapByteArray<{ $sk_bytes }>, ReadOnly, Locked>>

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

Available on crate feature protected only.

Returns a new randomly generated locked, read-only key pair.

Errors

Returns Error::Io if an allocation cannot be locked or made read-only.

impl<PublicKey: NewByteArray<{ CRYPTO_KEM_XWING_PUBLICKEYBYTES }> + Zeroize, SecretKey: NewByteArray<{ CRYPTO_KEM_XWING_SECRETKEYBYTES }> + Zeroize> KeyPair<PublicKey, SecretKey>

pub fn generate() -> Self

Generates a random key pair.

pub fn from_seed<Seed: ByteArray<{ CRYPTO_KEM_XWING_SEEDBYTES }>>( seed: &Seed, ) -> Self

Deterministically derives a key pair from seed.

impl<PublicKey: NewByteArray<{ CRYPTO_KEM_XWING_PUBLICKEYBYTES }> + Zeroize, SecretKey: ByteArray<{ CRYPTO_KEM_XWING_SECRETKEYBYTES }> + Zeroize> KeyPair<PublicKey, SecretKey>

pub fn from_secret_key(secret_key: SecretKey) -> Self

Returns the key pair for secret_key, deriving its public key.

impl<PublicKey: ByteArray<{ CRYPTO_KEM_XWING_PUBLICKEYBYTES }> + Zeroize, SecretKey: ByteArray<{ CRYPTO_KEM_XWING_SECRETKEYBYTES }> + Zeroize> KeyPair<PublicKey, SecretKey>

pub fn decapsulate<SharedSecret: NewByteArray<{ CRYPTO_KEM_XWING_SHAREDSECRETBYTES }>, Ciphertext: ByteArray<{ CRYPTO_KEM_XWING_CIPHERTEXTBYTES }>>( &self, ciphertext: &Ciphertext, ) -> Result<SharedSecret, Error>

Recovers the shared secret that ciphertext encapsulates for this key pair.

A ciphertext that was not created for this key pair yields an unrelated pseudorandom secret rather than an error, so the result reveals nothing about why it differs.

Errors

For X-Wing, returns Error::InvalidKey if the X25519 part of ciphertext is a low-order point. ML-KEM-768 decapsulation does not fail.

Trait Implementations

impl<PublicKey: Clone + ByteArray<{ CRYPTO_KEM_XWING_PUBLICKEYBYTES }> + Zeroize, SecretKey: Clone + ByteArray<{ CRYPTO_KEM_XWING_SECRETKEYBYTES }> + Zeroize> Clone for KeyPair<PublicKey, SecretKey>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<PublicKey: ByteArray<{ CRYPTO_KEM_XWING_PUBLICKEYBYTES }> + Zeroize, SecretKey: ByteArray<{ CRYPTO_KEM_XWING_SECRETKEYBYTES }> + Zeroize> Debug for KeyPair<PublicKey, SecretKey>

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

Formats the value using the given formatter.

impl<'de, PublicKey, SecretKey> Deserialize<'de> for KeyPair<PublicKey, SecretKey>

where PublicKey: Deserialize<'de> + ByteArray<{ CRYPTO_KEM_XWING_PUBLICKEYBYTES }> + Zeroize, SecretKey: Deserialize<'de> + ByteArray<{ CRYPTO_KEM_XWING_SECRETKEYBYTES }> + Zeroize,

Available on crate feature serde only.

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<PublicKey: ByteArray<{ CRYPTO_KEM_XWING_PUBLICKEYBYTES }> + Zeroize, SecretKey: ByteArray<{ CRYPTO_KEM_XWING_SECRETKEYBYTES }> + Zeroize> Drop for KeyPair<PublicKey, SecretKey>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<PublicKey, SecretKey> Serialize for KeyPair<PublicKey, SecretKey>

where PublicKey: Serialize + ByteArray<{ CRYPTO_KEM_XWING_PUBLICKEYBYTES }> + Zeroize, SecretKey: Serialize + ByteArray<{ CRYPTO_KEM_XWING_SECRETKEYBYTES }> + Zeroize,

Available on crate feature serde only.

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<PublicKey, SecretKey> Zeroize for KeyPair<PublicKey, SecretKey>

where PublicKey: Zeroize + ByteArray<{ CRYPTO_KEM_XWING_PUBLICKEYBYTES }>, SecretKey: Zeroize + ByteArray<{ CRYPTO_KEM_XWING_SECRETKEYBYTES }>,

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.