Struct BackupDecryptionKey

pub struct BackupDecryptionKey { /* private fields */ }

The private part of a backup key.

The private part of the key is not used on a regular basis. Rather, it is used only when we need to recover the backup.

Typically, this private key is itself encrypted and stored in server-side secret storage (SSSS), whence it can be retrieved when it is needed for a recovery operation. Alternatively, the key can be “gossiped” between devices via “secret sharing”.

Implementations

impl BackupDecryptionKey

pub fn from_bytes(key: &[u8; 32]) -> Self

Create a new decryption key from the given byte array.

Warning: You need to make sure that the byte array contains correct random data, either by using a random number generator or by using an exported version of a previously created BackupDecryptionKey.

pub fn as_bytes(&self) -> &[u8; 32]

Get the decryption key as a raw byte representation.

pub fn from_base64(key: &str) -> Result<Self, DecodeError>

Try to create a BackupDecryptionKey from a base64 export.

pub fn from_base58(value: &str) -> Result<Self, DecodeError>

Try to create a BackupDecryptionKey from a base58 export.

pub fn to_base58(&self) -> String

Export the [BackupDecryptionKey`] as a base58 encoded string.

pub fn megolm_v1_public_key(&self) -> MegolmV1BackupKey

Extract the megolm.v1 public key from this BackupDecryptionKey.

pub fn to_backup_info(&self) -> RoomKeyBackupInfo

Get the RoomKeyBackupInfo for this BackupDecryptionKey.

The RoomKeyBackupInfo can be uploaded to the homeserver to activate a new backup version.

pub fn decrypt_v1( &self, ephemeral_key: &str, mac: &str, ciphertext: &str, ) -> Result<String, DecryptionError>

Try to decrypt the given ciphertext using this BackupDecryptionKey.

This will use the m.megolm_backup.v1.curve25519-aes-sha2 algorithm to decrypt the given ciphertext.

pub fn decrypt_session_data( &self, session_data: EncryptedSessionData, ) -> Result<BackedUpRoomKey, DecryptionError>

Try to decrypt the given EncryptedSessionData using this BackupDecryptionKey.

pub fn backup_key_matches(&self, info: &RoomKeyBackupInfo) -> bool

Check if the given public key from the RoomKeyBackupInfo matches to this BackupDecryptionKey.

impl BackupDecryptionKey

pub const KEY_SIZE: usize = 32usize

The number of bytes the decryption key will hold.

pub fn new() -> Result<Self, Error>

Create a new random decryption key.

pub fn to_base64(&self) -> String

Export the BackupDecryptionKey as a base64 encoded string.

Trait Implementations

impl Clone for BackupDecryptionKey

fn clone(&self) -> BackupDecryptionKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BackupDecryptionKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BackupDecryptionKey

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BackupDecryptionKey

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

Formats the value using the given formatter.

impl Drop for BackupDecryptionKey

fn drop(&mut self)

Executes the destructor for this type.

impl Serialize for BackupDecryptionKey

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<String> for BackupDecryptionKey

type Error = DecodeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Zeroize for BackupDecryptionKey

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.