Struct sequoia_openpgp::packet::pkesk::PKESK3

pub struct PKESK3 { /* private fields */ }

Holds an asymmetrically encrypted session key.

The session key is needed to decrypt the actual ciphertext. See Section 5.1 of RFC 4880 for details.

Implementations

impl PKESK3

pub fn new(
    recipient: KeyID,
    pk_algo: PublicKeyAlgorithm,
    encrypted_session_key: Ciphertext
) -> Result<PKESK3>

Creates a new PKESK3 packet.

pub fn for_recipient<P, R>(
    algo: SymmetricAlgorithm,
    session_key: &SessionKey,
    recipient: &Key<P, R>
) -> Result<PKESK3> where
    P: KeyParts,
    R: KeyRole, 

Creates a new PKESK3 packet for the given recipient.

The given symmetric algorithm must match the algorithm that is used to encrypt the payload.

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 Clone for PKESK3

fn clone(&self) -> PKESK3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PKESK3

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

Formats the value using the given formatter.

impl From<PKESK3> for PKESK

fn from(p: PKESK3) -> Self

Converts to this type from the input type.

impl From<PKESK3> for Packet

fn from(p: PKESK3) -> Self

Converts to this type from the input type.

impl Hash for PKESK3

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 Marshal for PKESK3

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 PKESK3

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, PKESK3> for PKESK3

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

Reads from the given reader.

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

Reads from the given file.

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

Reads from the given slice.

impl PartialEq<PKESK3> for PKESK3

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

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

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

This method tests for !=.

impl Eq for PKESK3

impl StructuralEq for PKESK3

impl StructuralPartialEq for PKESK3