Struct vodozemac::megolm::SessionKey

source ·
pub struct SessionKey { /* private fields */ }
Expand description

The session key, can be used to create a InboundGroupSession.

Uses the session-sharing format described in the Olm spec.

+—+––+––––+––––+––––+––––+——+———–+ | V | i | R(i,0) | R(i,1) | R(i,2) | R(i,3) | Kpub | Signature | +—+––+––––+––––+––––+––––+——+———–+ 0 1 5 37 69 101 133 165 229 bytes

The version byte, V, is “\x02”. This is followed by the ratchet index, iii, which is encoded as a big-endian 32-bit integer; the 128 bytes of the ratchet; and the public part of the Ed25519 keypair.

The data is then signed using the Ed25519 key, and the 64-byte signature is appended.

Implementations§

source§

impl SessionKey

source

pub fn to_bytes(&self) -> Vec<u8>

Serialize the SessionKey to a byte vector.

source

pub fn from_bytes(bytes: &[u8]) -> Result<Self, SessionKeyDecodeError>

Deserialize the SessionKey from a byte slice.

source

pub fn to_base64(&self) -> String

Serialize the SessionKey to a base64 encoded string.

This method will first use the SessionKey::to_bytes() to convert the session key to a byte vector and then encode the byte vector to a string using unpadded base64 as the encoding.

source

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

Deserialize the SessionKey from base64 encoded string.

Trait Implementations§

source§

impl<'de> Deserialize<'de> for SessionKey

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 Drop for SessionKey

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl Serialize for SessionKey

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<&[u8]> for SessionKey

§

type Error = SessionKeyDecodeError

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

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl TryFrom<&str> for SessionKey

§

type Error = SessionKeyDecodeError

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

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

Performs the conversion.
source§

impl Zeroize for SessionKey

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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

source§

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