Struct sequoia_openpgp::packet::skesk::SKESK5

pub struct SKESK5 { /* fields omitted */ }

Holds an symmetrically encrypted session key version 5.

Holds an symmetrically encrypted session key. The session key is needed to decrypt the actual ciphertext. See [Section 5.3 of RFC 4880bis] for details.

This feature is experimental.

Implementations

impl SKESK5

pub fn new(
    esk_algo: SymmetricAlgorithm,
    esk_aead: AEADAlgorithm,
    s2k: S2K,
    iv: Box<[u8]>,
    esk: Box<[u8]>,
    digest: Box<[u8]>
) -> Result<Self>

Creates a new SKESK version 5 packet.

The given symmetric algorithm is the one used to encrypt the session key.

pub fn with_password(
    payload_algo: SymmetricAlgorithm,
    esk_algo: SymmetricAlgorithm,
    esk_aead: AEADAlgorithm,
    s2k: S2K,
    session_key: &SessionKey,
    password: &Password
) -> Result<Self>

Creates a new SKESK version 5 packet with the given password.

This function takes two SymmetricAlgorithm arguments: The first, payload_algo, is the algorithm used to encrypt the message’s payload (i.e. the one used in the SEIP or AED packet), and the second, esk_algo, is used to encrypt the session key. Usually, one should use the same algorithm, but if they differ, the esk_algo should be at least as strong as the payload_algo as not to weaken the security of the payload encryption.

pub fn decrypt(
    &self,
    password: &Password
) -> Result<(SymmetricAlgorithm, SessionKey)>

Derives the key inside this SKESK5 from password.

Returns a tuple containing a placeholder symmetric cipher and the key itself. SKESK5 packets do not contain the symmetric cipher algorithm and instead rely on the AED packet that contains it.

pub fn aead_algo(&self) -> AEADAlgorithm

Gets the AEAD algorithm.

pub fn set_aead_algo(&mut self, algo: AEADAlgorithm) -> AEADAlgorithm

Sets the AEAD algorithm.

pub fn aead_iv(&self) -> Result<&[u8]>

Gets the AEAD initialization vector.

If the S2K mechanism is not supported by Sequoia, this function will fail. Note that the information is not lost, but stored in the packet. If the packet is serialized again, it is written out.

pub fn set_aead_iv(&mut self, iv: Box<[u8]>) -> Option<Box<[u8]>>

Sets the AEAD initialization vector.

pub fn aead_digest(&self) -> &[u8]

Gets the AEAD digest.

pub fn set_aead_digest(&mut self, digest: Box<[u8]>) -> Box<[u8]>

Sets the AEAD digest.

Methods from Deref<Target = SKESK4>

pub fn symmetric_algo(&self) -> SymmetricAlgorithm

Gets the symmetric encryption algorithm.

pub fn set_symmetric_algo(
    &mut self,
    algo: SymmetricAlgorithm
) -> SymmetricAlgorithm

Sets the symmetric encryption algorithm.

pub fn s2k(&self) -> &S2K

Gets the key derivation method.

pub fn set_s2k(&mut self, s2k: S2K) -> S2K

Sets the key derivation method.

pub fn esk(&self) -> Result<Option<&[u8]>>

Gets the encrypted session key.

If the S2K mechanism is not supported by Sequoia, this function will fail. Note that the information is not lost, but stored in the packet. If the packet is serialized again, it is written out.

pub fn set_esk(&mut self, esk: Option<Box<[u8]>>) -> Option<Box<[u8]>>

Sets the encrypted session key.

pub fn decrypt(
    &self,
    password: &Password
) -> Result<(SymmetricAlgorithm, SessionKey)>

Derives the key inside this SKESK4 from password.

Returns a tuple of the symmetric cipher to use with the key and the key itself.

Trait Implementations

impl Clone for SKESK5

fn clone(&self) -> SKESK5

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SKESK5

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

Formats the value using the given formatter.

impl Deref for SKESK5

type Target = SKESK4

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for SKESK5

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

Mutably dereferences the value.

impl From<SKESK5> for SKESK

fn from(p: SKESK5) -> Self

Performs the conversion.

impl From<SKESK5> for Packet

fn from(s: SKESK5) -> Self

Performs the conversion.

impl Hash for SKESK5

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 SKESK5

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 SKESK5

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 PartialEq<SKESK5> for SKESK5

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

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

#[must_use]

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

This method tests for !=.

impl Eq for SKESK5