Skip to main content

PublicKey

Struct PublicKey 

Source
pub struct PublicKey(/* private fields */);
Expand description

The public component of the encapsulation key. This is usually the key of the recipient.

For X-Wing, the key is 1216 bytes (1184 bytes for ML-KEM-768 and 32 bytes for X25519).

Implementations§

Source§

impl PublicKey

Source

pub fn to_bytes(&self) -> Vec<u8>

The raw 1216-byte encapsulation key.

Source

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

Parse a raw 1216-byte encapsulation key.

§Errors

Returns Error::KeyFormat if the length is wrong or the key is invalid.

Source§

impl PublicKey

Source

pub fn seal( recipient: &PublicKey, plaintext: &[u8], info: Option<&[u8]>, ) -> Result<Vec<u8>, Error>

Seal plaintext to the recipient’s public key. This is analogous to libsodium’s Sealed Box where a message is sent anonymously to a recipient’s public key. The important difference is that a hybrid KEM is used.

With the choice of X-Wing, the ciphertext remains IND-CCA secure as long as either the security properties of X25519 or ML-KEM-768 (Kyber768) holds.

§Arguments
  • recipient: The public key of the recipient.
  • plaintext: The plaintext message to be encrypted.
  • info: Optional application-supplied information. This is usually global context (e.g. “a backup of X app”). The exact same info must be provided for sealing and unsealing, otherwise unsealing will fail.
§Errors
§Panics

An unavailable OS CSPRNG is reported as Error::Rng via an internal readiness check. A panic is only reachable in the residual window where the CSPRNG passes that check and then fails mid-encapsulation.

§Wire Format
HEADER || ENCAPSULATED_KEY || CIPHERTEXT

Trait Implementations§

Source§

impl Clone for PublicKey

Source§

fn clone(&self) -> PublicKey

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PublicKey

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for PublicKey

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for PublicKey

Source§

impl PartialEq for PublicKey

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PublicKey

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.