Struct PreKeyMessage

pub struct PreKeyMessage { /* private fields */ }

An encrypted Olm pre-key message.

Contains metadata that is required to establish a Session and a normal Olm Message.

Implementations

impl PreKeyMessage

pub const fn one_time_key(&self) -> Curve25519PublicKey

The single-use key that was uploaded to a public key directory by the receiver of the message. Should be used to establish a Session.

pub const fn base_key(&self) -> Curve25519PublicKey

The base key, a single use key that was created just in time by the sender of the message. Should be used to establish a Session.

pub const fn identity_key(&self) -> Curve25519PublicKey

The long term identity key of the sender of the message. Should be used to establish a Session

pub const fn session_keys(&self) -> SessionKeys

The collection of all keys required for establishing an Olm Session from this pre-key message.

Other methods on this struct (like PreKeyMessage::identity_key()) can be used to retrieve individual keys from this collection.

pub fn session_id(&self) -> String

Returns the globally unique session ID, in base64-encoded form.

This is a shorthand helper of the SessionKeys::session_id() method.

pub const fn message(&self) -> &Message

The actual message that contains the ciphertext.

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

Try to decode the given byte slice as a Olm Message.

The expected format of the byte array is described in the PreKeyMessage::to_bytes() method.

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

Encode the PreKeyMessage as an array of bytes.

Olm PreKeyMessages consist of a one-byte version, followed by a variable length payload.

+--------------+------------------------------------+
| Version Byte | Payload Bytes                      |
+--------------+------------------------------------+

The payload uses a format based on the Protocol Buffers encoding. It consists of the following key-value pairs:

Name	Tag	Type	Meaning
One-Time-Key	0x0A	String	The public part of Bob’s single-use key
Base-Key	0x12	String	The public part of Alice’s single-use key
Identity-Key	0x1A	String	The public part of Alice’s identity key
Message	0x22	String	An embedded Olm message

The last key/value pair in a PreKeyMessage is a normal Olm Message.

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

Try to decode the given string as a Olm PreKeyMessage.

The string needs to be a base64 encoded byte array that follows the format described in the PreKeyMessage::to_bytes() method.

pub fn to_base64(&self) -> String

Encode the PreKeyMessage as a string.

This method first calls PreKeyMessage::to_bytes() and then encodes the resulting byte array as a string using base64 encoding.

Trait Implementations

impl Clone for PreKeyMessage

fn clone(&self) -> PreKeyMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PreKeyMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PreKeyMessage

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl From<PreKeyMessage> for OlmMessage

fn from(m: PreKeyMessage) -> Self

Converts to this type from the input type.

impl PartialEq for PreKeyMessage

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PreKeyMessage

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for PreKeyMessage

type Error = DecodeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&str> for PreKeyMessage

type Error = DecodeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Vec<u8>> for PreKeyMessage

type Error = DecodeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for PreKeyMessage

impl StructuralPartialEq for PreKeyMessage