Struct matrix_sdk_crypto::olm::OutboundGroupSession

source · [−]

pub struct OutboundGroupSession { /* private fields */ }

Expand description

Outbound group session.

Outbound group sessions are used to exchange room messages between a group of participants. Outbound group sessions are used to encrypt the room messages.

Implementations

source

impl OutboundGroupSession

source

pub fn new(
 device_id: Arc<DeviceId>,
 identity_keys: Arc<IdentityKeys>,
 room_id: &RoomId,
 settings: EncryptionSettings
) -> Self

Create a new outbound group session for the given room.

Outbound group sessions are used to encrypt room messages.

Arguments

device_id - The id of the device that created this session.
identity_keys - The identity keys of the account that created this session.
room_id - The id of the room that the session is used in.
settings - Settings determining the algorithm and rotation period of the outbound group session.

source

pub fn invalidate_session(&self)

This should be called if an the user wishes to rotate this session.

source

pub fn settings(&self) -> &EncryptionSettings

Get the encryption settings of this outbound session.

source

pub fn mark_request_as_sent(&self, request_id: &TransactionId)

Mark the request with the given request id as sent.

This removes the request from the queue and marks the set of users/devices that received the session.

source

pub async fn encrypt(
    &self,
    content: Value,
    event_type: &str
) -> RoomEncryptedEventContent

Encrypt a room message for the given room.

Beware that a group session needs to be shared before this method can be called using the share_group_session() method.

Since group sessions can expire or become invalid if the room membership changes client authors should check with the should_share_group_session() method if a new group session needs to be shared.

Arguments

content - The plaintext content of the message that should be encrypted in raw json Value form.
event_type - The plaintext type of the event, the outer type of the event will become m.room.encrypted.

Panics

Panics if the content can’t be serialized.

source

pub fn expired(&self) -> bool

Check if the session has expired and if it should be rotated.

A session will expire after some time or if enough messages have been encrypted using it.

source

pub fn invalidated(&self) -> bool

Has the session been invalidated.

source

pub fn mark_as_shared(&self)

Mark the session as shared.

Messages shouldn’t be encrypted with the session before it has been shared.

source

pub fn shared(&self) -> bool

Check if the session has been marked as shared.

source

pub async fn session_key(&self) -> SessionKey

Get the session key of this session.

A session key can be used to to create an InboundGroupSession.

source

pub fn room_id(&self) -> &RoomId

Get the room id of the room this session belongs to.

source

pub fn session_id(&self) -> &str

Returns the unique identifier for this session.

source

pub async fn message_index(&self) -> u32

Get the current message index for this session.

Each message is sent with an increasing index. This returns the message index that will be used for the next encrypted message.

source

pub fn from_pickle(
 device_id: Arc<DeviceId>,
 identity_keys: Arc<IdentityKeys>,
 pickle: PickledOutboundGroupSession
) -> Result<Self, PickleError>

Restore a Session from a previously pickled string.

Returns the restored group session or a OlmGroupSessionError if there was an error.

Arguments

device_id - The device id of the device that created this session. Put differently, our own device id.
identity_keys - The identity keys of the device that created this session, our own identity keys.
pickle - The pickled version of the OutboundGroupSession.
pickle_mode - The mode that was used to pickle the session, either an unencrypted mode or an encrypted using passphrase.