[][src]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[src]

pub fn version(&self) -> u8[src]

Gets the version.

Methods from Deref<Target = PKESK3>

pub fn recipient(&self) -> &KeyID[src]

Gets the recipient.

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

Sets the recipient.

pub fn pk_algo(&self) -> PublicKeyAlgorithm[src]

Gets the public key algorithm.

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

Sets the public key algorithm.

pub fn esk(&self) -> &Ciphertext[src]

Gets the encrypted session key.

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

Sets the encrypted session key.

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

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 PKESK[src]

impl Debug for PKESK[src]

impl Deref for PKESK[src]

type Target = PKESK3

The resulting type after dereferencing.

impl DerefMut for PKESK[src]

impl Eq for PKESK[src]

impl From<PKESK> for Packet[src]

impl From<PKESK3> for PKESK[src]

impl Hash for PKESK[src]

impl IntoIterator for PKESK[src]

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?

impl Marshal for PKESK[src]

impl MarshalInto for PKESK[src]

impl<'a> Parse<'a, PKESK> for PKESK[src]

impl PartialEq<PKESK> for PKESK[src]

impl StructuralEq for PKESK[src]

impl StructuralPartialEq for PKESK[src]

Auto Trait Implementations

impl RefUnwindSafe for PKESK

impl Send for PKESK

impl Sync for PKESK

impl Unpin for PKESK

impl UnwindSafe for PKESK

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> DynClone for T where
    T: Clone
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<I> IntoIterator for I where
    I: Iterator
[src]

type Item = <I as Iterator>::Item

The type of the elements being iterated over.

type IntoIter = I

Which kind of iterator are we turning this into?

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.