Struct DecapsulationKey 

pub struct DecapsulationKey<P>
where
    P: KemParams,
{ /* private fields */ }

A DecapsulationKey provides the ability to generate a new key pair, and decapsulate an encapsulated shared key.

Implementations

impl<P> DecapsulationKey<P>

where P: KemParams,

pub fn from_seed(seed: Seed) -> Self

Create a DecapsulationKey instance from a 64-byte random seed value.

pub fn from_expanded( enc: &ExpandedDecapsulationKey<P>, ) -> Result<Self, InvalidKey>

👎Deprecated since 0.3.0:

use DecapsulationKey::from_seed instead

Initialize a DecapsulationKey from the serialized expanded key form.

Note that this form is deprecated in practice; prefer to use DecapsulationKey::from_seed. See ExpandedKeyEncoding for more information.

Errors

• Returns InvalidKey in the event the expanded key failed validation

pub fn to_seed(&self) -> Option<Seed>

Serialize the Seed value: 64-bytes which can be used to reconstruct the DecapsulationKey.

Warning!

This value is key material. Please treat it with care.

Returns

• Some if the DecapsulationKey was initialized using from_seed or generate.
• None if the DecapsulationKey was initialized from the expanded form.

pub fn encapsulation_key(&self) -> &EncapsulationKey<P>

Get the EncapsulationKey which corresponds to this DecapsulationKey.

Trait Implementations

impl<P> ExpandedKeyEncoding for DecapsulationKey<P>

where P: KemParams,

type EncodedSize = <P as KemParams>::DecapsulationKeySize

👎Deprecated since 0.3.0:

use DecapsulationKey::from_seed instead

The size of an expanded decapsulation key.

fn from_expanded_bytes( expanded: &ExpandedDecapsulationKey<P>, ) -> Result<Self, InvalidKey>

👎Deprecated since 0.3.0:

use DecapsulationKey::from_seed instead

Parse a DecapsulationKey from its legacy expanded form.

fn to_expanded_bytes(&self) -> ExpandedDecapsulationKey<P>

👎Deprecated since 0.3.0:

use DecapsulationKey::from_seed instead

Serialize a DecapsulationKey to its legacy expanded form.

impl<P> AssociatedAlgorithmIdentifier for DecapsulationKey<P>

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

Available on crate feature pkcs8 only.

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 DecapsulationKey<P>

where P: KemParams + Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P> Debug for DecapsulationKey<P>

where P: KemParams + Debug,

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

Formats the value using the given formatter.

impl<P> Decapsulate for DecapsulationKey<P>

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

fn decapsulate(&self, encapsulated_key: &Ciphertext<P>) -> SharedKey

Decapsulates the given Ciphertext a.k.a. “encapsulated key”.

fn decapsulate_slice( &self, ct: &[u8], ) -> Result<Array<u8, <Self::Kem as Kem>::SharedKeySize>, TryFromSliceError>

Decapsulate the given byte slice containing a Ciphertext a.k.a. “encapsulated key”.

impl<P> Decapsulator for DecapsulationKey<P>

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

type Kem = P

KEM algorithm this decapsulator is for.

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

Encapsulation key which can encrypt ciphertexts this decapsulator can decrypt.

impl<P> Drop for DecapsulationKey<P>

where P: KemParams,

Available on crate feature zeroize only.

fn drop(&mut self)

Executes the destructor for this type.

impl<P> EncodePrivateKey for DecapsulationKey<P>

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

Available on crate features pkcs8 and alloc only.

fn to_pkcs8_der(&self) -> Result<SecretDocument>

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

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

Available on crate feature pem only.

Serialize this private key as PEM-encoded PKCS#8 with the given LineEnding.

impl<P> From<Array<u8, UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>> for DecapsulationKey<P>

where P: KemParams,

fn from(seed: Seed) -> Self

Converts to this type from the input type.

impl<P> Generate for DecapsulationKey<P>

where P: KemParams,

fn try_generate_from_rng<R>(rng: &mut R) -> Result<Self, <R as TryRng>::Error>

where R: TryCryptoRng + ?Sized,

Generate random key using the provided TryCryptoRng.

fn generate_from_rng<R>(rng: &mut R) -> Self

where R: CryptoRng + ?Sized,

Generate random key using the provided CryptoRng.

fn try_generate() -> Result<Self, Error>

Available on crate feature getrandom only.

Randomly generate a value of this type using the system’s ambient cryptographically secure random number generator.

fn generate() -> Self

Available on crate feature getrandom only.

Randomly generate a value of this type using the system’s ambient cryptographically secure random number generator.

impl<P> KeyExport for DecapsulationKey<P>

where P: KemParams,

Serialize the 64-byte Seed value used to initialize this DecapsulationKey.

Panics

If this DecapsulationKey was initialized using legacy expanded key support (see ExpandedKeyEncoding).

fn to_bytes(&self) -> Seed

Serialize this key as a byte array.

impl<P> KeyInit for DecapsulationKey<P>

where P: KemParams,

Initialize DecapsulationKey from a 64-byte uniformly random Seed value.

fn new(seed: &Seed) -> Self

Create new value from fixed size key.

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

Create new value from variable size key.

fn generate_key<R>(rng: &mut R) -> Array<u8, Self::KeySize>

where R: CryptoRng,

👎Deprecated since 0.2.0:

use the Generate trait impl on Key instead

Available on crate feature rand_core only.

DEPRECATED: generate random key using the provided CryptoRng.

impl<P> KeySizeUser for DecapsulationKey<P>

where P: KemParams,

type KeySize = UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>

Key size in bytes.

fn key_size() -> usize

Return key size in bytes.

impl<P> PartialEq for DecapsulationKey<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<PrivateKeyInfo<AnyRef<'_>, &OctetStringRef, BitStringRef<'_>>> for DecapsulationKey<P>

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

Available on crate feature pkcs8 only.

fn try_from( private_key_info_ref: PrivateKeyInfoRef<'_>, ) -> Result<Self, Self::Error>

Deserialize the decapsulation key from DER format found in spki.private_key. Returns a DecapsulationKey containing dk_{pke}, ek, and z in case of success.

type Error = Error

The type returned in the event of a conversion error.

impl<P> ZeroizeOnDrop for DecapsulationKey<P>

where P: KemParams,

Available on crate feature zeroize only.