[][src]Struct sequoia_openpgp::packet::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.

Methods

impl SKESK5[src]

pub fn new(
    version: u8,
    cipher: SymmetricAlgorithm,
    aead: AEADAlgorithm,
    s2k: S2K,
    iv: Box<[u8]>,
    esk: Vec<u8>,
    digest: Box<[u8]>
) -> Result<Self>
[src]

Creates a new SKESK version 5 packet.

The given symmetric algorithm must match the algorithm that is used to encrypt the payload, and is also used to encrypt the given session key.

pub fn with_password(
    cipher: SymmetricAlgorithm,
    aead: AEADAlgorithm,
    s2k: S2K,
    session_key: &SessionKey,
    password: &Password
) -> Result<Self>
[src]

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

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

Derives the key inside this SKESK4 from password. Returns a tuple of the symmetric cipher to use with the key and the key itself.

pub fn aead_algo(&self) -> AEADAlgorithm[src]

Gets the AEAD algorithm.

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

Sets the AEAD algorithm.

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

Gets the AEAD initialization vector.

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

Sets the AEAD initialization vector.

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

Gets the AEAD digest.

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

Sets the AEAD digest.

Methods from Deref<Target = SKESK4>

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

Gets the version.

pub fn symmetric_algo(&self) -> SymmetricAlgorithm[src]

Gets the symmetric encryption algorithm.

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

Sets the symmetric encryption algorithm.

pub fn s2k(&self) -> &S2K[src]

Gets the key derivation method.

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

Sets the key derivation method.

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

Gets the encrypted session key.

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

Sets the encrypted session key.

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

Convert the SKESK4 struct to a Packet. 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 Serialize for SKESK5[src]

impl SerializeInto for SKESK5[src]

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

Serializes the packet to a vector.

impl From<SKESK5> for Packet[src]

impl Eq for SKESK5[src]

impl PartialEq<SKESK5> for SKESK5[src]

impl Clone for SKESK5[src]

fn clone_from(&mut self, source: &Self)
1.0.0
[src]

Performs copy-assignment from source. Read more

impl Deref for SKESK5[src]

type Target = SKESK4

The resulting type after dereferencing.

impl Hash for SKESK5[src]

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

Feeds a slice of this type into the given [Hasher]. Read more

impl DerefMut for SKESK5[src]

impl Debug for SKESK5[src]

impl Arbitrary for SKESK5[src]

fn shrink(&self) -> Box<dyn Iterator<Item = Self> + 'static>

Auto Trait Implementations

impl Send for SKESK5

impl !Sync for SKESK5

Blanket Implementations

impl<T> From for T[src]

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

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

type Owned = T

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

type Error = Infallible

The type returned in the event of a conversion error.

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

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

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

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

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

The type returned in the event of a conversion error.