Struct sequoia_openpgp::crypto::SessionKey

pub struct SessionKey(_);

Holds a session key.

The session key is cleared when dropped. Sequoia uses this type to ensure that session keys are not left in memory returned to the allocator.

Session keys can be generated using SessionKey::new, or converted from various types using From.

Implementations

impl SessionKey

pub fn new(size: usize) -> Self

Creates a new session key.

Creates a new session key size bytes in length initialized using a strong cryptographic number generator.

Examples

This creates a session key and encrypts it for a given recipient key producing a PKESK packet.

use sequoia_openpgp as openpgp;
use openpgp::types::{Curve, SymmetricAlgorithm};
use openpgp::crypto::SessionKey;
use openpgp::packet::prelude::*;

let cipher = SymmetricAlgorithm::AES256;
let sk = SessionKey::new(cipher.key_size().unwrap());

let key: Key<key::SecretParts, key::UnspecifiedRole> =
    Key4::generate_ecc(false, Curve::Cv25519)?.into();

let pkesk: PKESK =
    PKESK3::for_recipient(cipher, &sk, &key)?.into();

Trait Implementations

impl AsMut<[u8]> for SessionKey

fn as_mut(&mut self) -> &mut [u8]

Performs the conversion.

impl AsRef<[u8]> for SessionKey

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl Clone for SessionKey

fn clone(&self) -> SessionKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SessionKey

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

Formats the value using the given formatter.

impl Deref for SessionKey

type Target = [u8]

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for SessionKey

fn deref_mut(&mut self) -> &mut [u8]

Mutably dereferences the value.

impl From<&'_ [u8]> for SessionKey

fn from(v: &[u8]) -> Self

Performs the conversion.

impl From<Box<[u8], Global>> for SessionKey

fn from(v: Box<[u8]>) -> Self

Performs the conversion.

impl From<Protected> for SessionKey

fn from(v: Protected) -> Self

Performs the conversion.

impl From<Vec<u8, Global>> for SessionKey

fn from(v: Vec<u8>) -> Self

Performs the conversion.

impl PartialEq<SessionKey> for SessionKey

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

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

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

This method tests for !=.

impl Eq for SessionKey

impl StructuralEq for SessionKey

impl StructuralPartialEq for SessionKey