matrix_sdk_crypto::store

Struct BackupDecryptionKey

Source
pub struct BackupDecryptionKey { /* private fields */ }
Expand description

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§

Source§

impl BackupDecryptionKey

Source

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.

Source

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

Get the decryption key as a raw byte representation.

Source

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

Try to create a BackupDecryptionKey from a base64 export.

Source

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

Try to create a BackupDecryptionKey from a base58 export.

Source

pub fn to_base58(&self) -> String

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

Source

pub fn megolm_v1_public_key(&self) -> MegolmV1BackupKey

Extract the megolm.v1 public key from this BackupDecryptionKey.

Source

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.

Source

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.

Source

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

Try to decrypt the given EncryptedSessionData using this BackupDecryptionKey.

Source

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

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

Source§

impl BackupDecryptionKey

Source

pub const KEY_SIZE: usize = 32usize

The number of bytes the decryption key will hold.

Source

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

Create a new random decryption key.

Source

pub fn to_base64(&self) -> String

Export the BackupDecryptionKey as a base64 encoded string.

Trait Implementations§

Source§

impl Clone for BackupDecryptionKey

Source§

fn clone(&self) -> BackupDecryptionKey

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BackupDecryptionKey

Available on non-tarpaulin_include only.
Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for BackupDecryptionKey

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for BackupDecryptionKey

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Serialize for BackupDecryptionKey

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl TryFrom<String> for BackupDecryptionKey

Source§

type Error = DecodeError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl Zeroize for BackupDecryptionKey

Source§

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.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> CompatExt for T

§

fn compat(self) -> Compat<T>

Applies the [Compat] adapter by value. Read more
§

fn compat_ref(&self) -> Compat<&T>

Applies the [Compat] adapter by shared reference. Read more
§

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the [Compat] adapter by mutable reference. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

Source§

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more
Source§

fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more
Source§

fn consume_handle(handle: Handle) -> Arc<T>

Consume a handle, getting back the initial Arc<>
Source§

fn get_arc(handle: Handle) -> Arc<Self>

Get a clone of the Arc<> using a “borrowed” handle. Read more
Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

impl<T> Identity for T
where T: ?Sized,

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

impl<T> AsyncTraitDeps for T

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T

Source§

impl<T> SendOutsideWasm for T
where T: Send,

Source§

impl<T> SyncOutsideWasm for T
where T: Sync,