Struct EncapsulationKey 

pub struct EncapsulationKey<P>
where
    P: KemParams,
{
    ek_pke: MaybeBox<EncryptionKey<P>>,
    h: B32,
}

An EncapsulationKey provides the ability to encapsulate a shared key so that it can only be decapsulated by the holder of the corresponding decapsulation key.

Fields

ek_pke: MaybeBox<EncryptionKey<P>>

h: B32

Implementations

impl<P> EncapsulationKey<P>

where P: Kem<SharedKeySize = U32> + KemParams,

pub fn new(encapsulation_key: &Key<Self>) -> Result<Self, InvalidKey>

Create a new EncapsulationKey from its serialized form.

Errors

If the key failed validation during decoding.

pub fn encapsulate_deterministic(&self, m: &B32) -> (Ciphertext<P>, SharedKey)

Encapsulates with the given randomness. This is useful for testing against known vectors.

Warning

Do NOT use this function unless you know what you’re doing. If you fail to use all uniform random bytes even once, you can have catastrophic security failure.

pub(crate) fn from_encryption_key(ek_pke: EncryptionKey<P>) -> Self

Convert from an EncryptionKey.

pub(crate) fn ek_pke(&self) -> &EncryptionKey<P>

Borrow the encryption key.

pub(crate) fn h(&self) -> B32

Retrieve the hash of the encryption key.

Trait Implementations

impl<P> AssociatedAlgorithmIdentifier for EncapsulationKey<P>

where P: KemParams + AssociatedAlgorithmIdentifier<Params = AnyRef<'static>>,

const ALGORITHM_IDENTIFIER: AlgorithmIdentifier<Self::Params> = P::ALGORITHM_IDENTIFIER

AlgorithmIdentifier for this structure.

type Params = <P as AssociatedAlgorithmIdentifier>::Params

Algorithm parameters.

impl<P> Clone for EncapsulationKey<P>

where P: KemParams + Clone,

fn clone(&self) -> EncapsulationKey<P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P> Debug for EncapsulationKey<P>

where P: KemParams + Debug,

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

Formats the value using the given formatter.

impl<P> Encapsulate for EncapsulationKey<P>

where P: Kem + KemParams,

type Kem = P

KEM algorithm this encapsulator is for.

fn encapsulate_with_rng<R>(&self, rng: &mut R) -> (Ciphertext<P>, SharedKey)

where R: CryptoRng + ?Sized,

Encapsulates a fresh SharedKey generated using the supplied random number generator R.

fn encapsulate( &self, ) -> (Array<u8, <Self::Kem as Kem>::CiphertextSize>, Array<u8, <Self::Kem as Kem>::SharedKeySize>)

Encapsulate a fresh shared secret generated using the system’s secure RNG.

impl<P> EncodePublicKey for EncapsulationKey<P>

where P: KemParams + AssociatedAlgorithmIdentifier<Params = AnyRef<'static>>,

Available on crate feature alloc only.

fn to_public_key_der(&self) -> Result<Document>

Serialize the given EncapsulationKey into DER format. Returns a Document which wraps the DER document in case of success.

fn to_public_key_pem(&self, line_ending: LineEnding) -> Result<String, Error>

Serialize this public key as PEM-encoded SPKI with the given LineEnding.

fn write_public_key_der_file(&self, path: impl AsRef<Path>) -> Result<(), Error>

Write ASN.1 DER-encoded public key to the given path.

fn write_public_key_pem_file( &self, path: impl AsRef<Path>, line_ending: LineEnding, ) -> Result<(), Error>

Write ASN.1 PEM-encoded public key to the given path.

impl<P> KeyExport for EncapsulationKey<P>

where P: KemParams,

fn to_bytes(&self) -> Key<Self>

Serialize this key as a byte array.

impl<P> KeySizeUser for EncapsulationKey<P>

where P: KemParams,

type KeySize = <P as PkeParams>::EncryptionKeySize

Key size in bytes.

fn key_size() -> usize

Return key size in bytes.

impl<P> PartialEq for EncapsulationKey<P>

where P: KemParams,

fn eq(&self, other: &Self) -> 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<P> TryFrom<SubjectPublicKeyInfo<AnyRef<'_>, BitStringRef<'_>>> for EncapsulationKey<P>

where P: KemParams + AssociatedAlgorithmIdentifier<Params = AnyRef<'static>>,

fn try_from(spki: SubjectPublicKeyInfoRef<'_>) -> Result<Self, Error>

Deserialize the encapsulation key from DER format found in spki.subject_public_key. Returns an EncapsulationKey containing ek_{pke} and h in case of success.

type Error = Error

The type returned in the event of a conversion error.

impl<P> TryKeyInit for EncapsulationKey<P>

where P: KemParams,

fn new(encapsulation_key: &Key<Self>) -> Result<Self, InvalidKey>

Create new value from a fixed-size key.

fn new_from_slice(key: &[u8]) -> Result<Self, InvalidKey>

Create new value from a variable size key.

impl<P> Eq for EncapsulationKey<P>

where P: KemParams,