Struct SessionKey

pub struct SessionKey { /* private fields */ }

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

impl SessionKey

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

Serialize the SessionKey to a byte vector.

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

Deserialize the SessionKey from a byte slice.

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.

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

Deserialize the SessionKey from base64 encoded string.

Trait Implementations

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

fn deserialize<D>( deserializer: D, ) -> Result<SessionKey, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for SessionKey

fn drop(&mut self)

Executes the destructor for this type.

impl Serialize for SessionKey

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for SessionKey

type Error = SessionKeyDecodeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&str> for SessionKey

type Error = SessionKeyDecodeError

The type returned in the event of a conversion error.

fn try_from( value: &str, ) -> Result<SessionKey, <SessionKey as TryFrom<&str>>::Error>

Performs the conversion.

impl Zeroize for SessionKey

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.