Struct matrix_sdk_crypto::store::PickleKey

pub struct PickleKey { /* fields omitted */ }

A pickle key that will be used to encrypt all the private keys for Olm.

Olm uses AES256 to encrypt accounts, sessions, inbound group sessions. We also implement our own pickling for the cross-signing types using AES256-GCM so the key sizes match.

Implementations

impl PickleKey

pub fn new() -> Self

Generate a new random pickle key.

pub fn pickle_mode(&self) -> PicklingMode

Get a PicklingMode version of this pickle key.

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

Get the raw AES256 key.

pub fn encrypt(&self, passphrase: &str) -> EncryptedPickleKey

Encrypt and export our pickle key using the given passphrase.

Arguments

• passphrase - The passphrase that should be used to encrypt the pickle key.

pub fn from_encrypted(
    passphrase: &str,
    encrypted: EncryptedPickleKey
) -> Result<Self, DecryptionError>

Restore a pickle key from an encrypted export.

Arguments

• passphrase - The passphrase that should be used to encrypt the pickle key.

• encrypted - The exported and encrypted version of the pickle key.

Trait Implementations

impl Debug for PickleKey

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

Formats the value using the given formatter.

impl Default for PickleKey

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<PickleKey> for PickleKey

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

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

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

This method tests for !=.

impl TryFrom<Vec<u8, Global>> for PickleKey

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl Zeroize for PickleKey

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl StructuralPartialEq for PickleKey