Struct sequoia_openpgp::packet::pkesk::PKESK3
source · pub struct PKESK3 { /* private fields */ }
Expand description
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§
source§impl PKESK3
impl PKESK3
sourcepub fn new(
recipient: KeyID,
pk_algo: PublicKeyAlgorithm,
encrypted_session_key: Ciphertext
) -> Result<PKESK3>
pub fn new( recipient: KeyID, pk_algo: PublicKeyAlgorithm, encrypted_session_key: Ciphertext ) -> Result<PKESK3>
Creates a new PKESK3 packet.
sourcepub fn for_recipient<P, R>(
algo: SymmetricAlgorithm,
session_key: &SessionKey,
recipient: &Key<P, R>
) -> Result<PKESK3>
pub fn for_recipient<P, R>( algo: SymmetricAlgorithm, session_key: &SessionKey, recipient: &Key<P, R> ) -> Result<PKESK3>
Creates a new PKESK3 packet for the given recipient.
The given symmetric algorithm must match the algorithm that is used to encrypt the payload.
sourcepub fn set_recipient(&mut self, recipient: KeyID) -> KeyID
pub fn set_recipient(&mut self, recipient: KeyID) -> KeyID
Sets the recipient.
sourcepub fn pk_algo(&self) -> PublicKeyAlgorithm
pub fn pk_algo(&self) -> PublicKeyAlgorithm
Gets the public key algorithm.
sourcepub fn set_pk_algo(&mut self, algo: PublicKeyAlgorithm) -> PublicKeyAlgorithm
pub fn set_pk_algo(&mut self, algo: PublicKeyAlgorithm) -> PublicKeyAlgorithm
Sets the public key algorithm.
sourcepub fn esk(&self) -> &Ciphertext
pub fn esk(&self) -> &Ciphertext
Gets the encrypted session key.
sourcepub fn set_esk(&mut self, esk: Ciphertext) -> Ciphertext
pub fn set_esk(&mut self, esk: Ciphertext) -> Ciphertext
Sets the encrypted session key.
sourcepub fn decrypt(
&self,
decryptor: &mut dyn Decryptor,
sym_algo_hint: Option<SymmetricAlgorithm>
) -> Option<(SymmetricAlgorithm, SessionKey)>
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.