Struct sequoia_openpgp::packet::skesk::SKESK5 [−][src]
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
[src]
impl SKESK5
[src]pub fn new(
esk_algo: SymmetricAlgorithm,
esk_aead: AEADAlgorithm,
s2k: S2K,
iv: Box<[u8]>,
esk: Box<[u8]>,
digest: Box<[u8]>
) -> Result<Self>
[src]
pub fn new(
esk_algo: SymmetricAlgorithm,
esk_aead: AEADAlgorithm,
s2k: S2K,
iv: Box<[u8]>,
esk: Box<[u8]>,
digest: Box<[u8]>
) -> Result<Self>
[src]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>
[src]
pub fn with_password(
payload_algo: SymmetricAlgorithm,
esk_algo: SymmetricAlgorithm,
esk_aead: AEADAlgorithm,
s2k: S2K,
session_key: &SessionKey,
password: &Password
) -> Result<Self>
[src]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)>
[src]
pub fn decrypt(
&self,
password: &Password
) -> Result<(SymmetricAlgorithm, SessionKey)>
[src]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
[src]
pub fn aead_algo(&self) -> AEADAlgorithm
[src]Gets the AEAD algorithm.
pub fn set_aead_algo(&mut self, algo: AEADAlgorithm) -> AEADAlgorithm
[src]
pub fn set_aead_algo(&mut self, algo: AEADAlgorithm) -> AEADAlgorithm
[src]Sets the AEAD algorithm.
pub fn aead_iv(&self) -> Result<&[u8]>
[src]
pub fn aead_iv(&self) -> Result<&[u8]>
[src]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]>>
[src]
pub fn set_aead_iv(&mut self, iv: Box<[u8]>) -> Option<Box<[u8]>>
[src]Sets the AEAD initialization vector.
pub fn aead_digest(&self) -> &[u8]ⓘ
[src]
pub fn aead_digest(&self) -> &[u8]ⓘ
[src]Gets the AEAD digest.
pub fn set_aead_digest(&mut self, digest: Box<[u8]>) -> Box<[u8]>ⓘNotable traits for Box<R, Global>
impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<F, A> Future for Box<F, A> where
A: Allocator + 'static,
F: Future + Unpin + ?Sized, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
[src]
pub fn set_aead_digest(&mut self, digest: Box<[u8]>) -> Box<[u8]>ⓘNotable traits for Box<R, Global>
impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<F, A> Future for Box<F, A> where
A: Allocator + 'static,
F: Future + Unpin + ?Sized, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
[src]Sets the AEAD digest.
Methods from Deref<Target = SKESK4>
pub fn symmetric_algo(&self) -> SymmetricAlgorithm
[src]
pub fn symmetric_algo(&self) -> SymmetricAlgorithm
[src]Gets the symmetric encryption algorithm.
pub fn set_symmetric_algo(
&mut self,
algo: SymmetricAlgorithm
) -> SymmetricAlgorithm
[src]
pub fn set_symmetric_algo(
&mut self,
algo: SymmetricAlgorithm
) -> SymmetricAlgorithm
[src]Sets the symmetric encryption algorithm.
pub fn esk(&self) -> Result<Option<&[u8]>>
[src]
pub fn esk(&self) -> Result<Option<&[u8]>>
[src]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]>>
[src]
pub fn set_esk(&mut self, esk: Option<Box<[u8]>>) -> Option<Box<[u8]>>
[src]Sets the encrypted session key.
pub fn decrypt(
&self,
password: &Password
) -> Result<(SymmetricAlgorithm, SessionKey)>
[src]
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.
Trait Implementations
impl MarshalInto for SKESK5
[src]
impl MarshalInto for SKESK5
[src]impl Eq for SKESK5
[src]
Auto Trait Implementations
impl RefUnwindSafe for SKESK5
impl Send for SKESK5
impl Sync for SKESK5
impl Unpin for SKESK5
impl UnwindSafe for SKESK5
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more