aws_lc_rs::kem

Struct EncapsulationKey

Source
pub struct EncapsulationKey<Id = AlgorithmId>{ /* private fields */ }
Expand description

A serializable encapsulation key usable with KEM algorithms. Constructed from either a DecapsulationKey or raw bytes.

Implementations§

Source§

impl<Id> EncapsulationKey<Id>

Source

pub fn algorithm(&self) -> &'static Algorithm<Id>

Return the algorithm associated with the given KEM encapsulation key.

Source

pub fn encapsulate( &self, ) -> Result<(Ciphertext<'static>, SharedSecret), Unspecified>

Performs the encapsulate operation using this KEM encapsulation key, generating a ciphertext and associated shared secret.

§Errors

error::Unspecified when operation fails due to internal error.

Source

pub fn key_bytes(&self) -> Result<EncapsulationKeyBytes<'static>, Unspecified>

Returns the EnscapsulationKey bytes.

§Errors
  • Unspecified: Any failure to retrieve the EnscapsulationKey bytes.
Source

pub fn new( alg: &'static Algorithm<Id>, bytes: &[u8], ) -> Result<Self, KeyRejected>

Creates a new KEM encapsulation key from raw bytes. This method MUST NOT be used to generate a new encapsulation key, rather it MUST be used to construct EncapsulationKey previously serialized to raw bytes.

alg is the Algorithm to be associated with the generated EncapsulationKey.

bytes is a slice of raw bytes representing a EncapsulationKey.

§Errors

error::KeyRejected when operation fails during key creation.

Trait Implementations§

Source§

impl<Id> Debug for EncapsulationKey<Id>

Source§

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

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

impl<Id> Send for EncapsulationKey<Id>

Source§

impl<Id> Sync for EncapsulationKey<Id>

Auto Trait Implementations§

§

impl<Id> Freeze for EncapsulationKey<Id>

§

impl<Id> RefUnwindSafe for EncapsulationKey<Id>
where Id: RefUnwindSafe,

§

impl<Id> Unpin for EncapsulationKey<Id>

§

impl<Id> UnwindSafe for EncapsulationKey<Id>
where Id: RefUnwindSafe,

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.