Enum sequoia_openpgp::packet::PKESK

#[non_exhaustive]
pub enum PKESK {
    V3(PKESK3),
}

Holds an asymmetrically encrypted session key.

The session key is used to decrypt the actual ciphertext, which is typically stored in a SEIP or AED packet. See Section 5.1 of RFC 4880 for details.

A PKESK packet is not normally instantiated directly. In most cases, you’ll create one as a side-effect of encrypting a message using the streaming serializer, or parsing an encrypted message using the PacketParser.

Note: This enum cannot be exhaustively matched to allow future extensions.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

V3(PKESK3)

PKESK packet version 3.

Implementations

impl PKESK

pub fn version(&self) -> u8

Gets the version.

Methods from Deref<Target = PKESK3>

pub fn recipient(&self) -> &KeyID

Gets the recipient.

pub fn set_recipient(&mut self, recipient: KeyID) -> KeyID

Sets the recipient.

pub fn pk_algo(&self) -> PublicKeyAlgorithm

Gets the public key algorithm.

pub fn set_pk_algo(&mut self, algo: PublicKeyAlgorithm) -> PublicKeyAlgorithm

Sets the public key algorithm.

pub fn esk(&self) -> &Ciphertext

Gets the encrypted session key.

pub fn set_esk(&mut self, esk: Ciphertext) -> Ciphertext

Sets the encrypted session key.

pub fn decrypt(
    &self,
    decryptor: &mut dyn Decryptor,
    sym_algo_hint: Option<SymmetricAlgorithm>
) -> Option<(SymmetricAlgorithm, SessionKey)>

Decrypts the encrypted session key.

If the symmetric algorithm used to encrypt the message is known in advance, it should be given as argument. This allows us to reduce the side-channel leakage of the decryption operation for RSA.

Returns the session key and symmetric algorithm used to encrypt the following payload.

Returns None on errors. This prevents leaking information to an attacker, which could lead to compromise of secret key material with certain algorithms (RSA). See Section 14 of RFC 4880.

Trait Implementations

impl Any<PKESK> for Packet

fn downcast(self) -> Result<PKESK, Packet>

Attempts to downcast to T, returning the packet if it fails.

fn downcast_ref(&self) -> Option<&PKESK>

Attempts to downcast to &T, returning None if it fails.

fn downcast_mut(&mut self) -> Option<&mut PKESK>

Attempts to downcast to &mut T, returning None if it fails.

impl Clone for PKESK

fn clone(&self) -> PKESK

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PKESK

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

Formats the value using the given formatter.

impl Deref for PKESK

type Target = PKESK3

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for PKESK

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<PKESK> for Packet

fn from(p: PKESK) -> Self

Converts to this type from the input type.

impl From<PKESK3> for PKESK

fn from(p: PKESK3) -> Self

Converts to this type from the input type.

impl Hash for PKESK

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl IntoIterator for PKESK

Implement IntoIterator so that cert::insert_packets(sig) just works.

type Item = PKESK

The type of the elements being iterated over.

type IntoIter = Once<PKESK>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Marshal for PKESK

fn serialize(&self, o: &mut dyn Write) -> Result<()>

Writes a serialized version of the object to o.

fn export(&self, o: &mut dyn Write) -> Result<()>

Exports a serialized version of the object to o.

impl MarshalInto for PKESK

fn serialized_len(&self) -> usize

Computes the maximal length of the serialized representation.

fn serialize_into(&self, buf: &mut [u8]) -> Result<usize>

Serializes into the given buffer.

fn to_vec(&self) -> Result<Vec<u8>>

Serializes the packet to a vector.

fn export_into(&self, buf: &mut [u8]) -> Result<usize>

Exports into the given buffer.

fn export_to_vec(&self) -> Result<Vec<u8>>

Exports to a vector.

impl<'a> Parse<'a, PKESK> for PKESK

fn from_reader<R: 'a + Read + Send + Sync>(reader: R) -> Result<Self>

Reads from the given reader.

fn from_bytes<D: AsRef<[u8]> + ?Sized + Send + Sync>(
    data: &'a D
) -> Result<Self>

Reads from the given slice.

fn from_file<P: AsRef<Path>>(path: P) -> Result<T>

Reads from the given file.

impl PartialEq<PKESK> for PKESK

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for PKESK

impl StructuralEq for PKESK

impl StructuralPartialEq for PKESK