Struct matrix_sdk_crypto::olm::InboundGroupSession

source · [−]

pub struct InboundGroupSession {
    pub session_id: Arc<str>,
    pub sender_key: Arc<str>,
    pub signing_keys: Arc<BTreeMap<DeviceKeyAlgorithm, String>>,
    pub room_id: Arc<RoomId>,
    /* private fields */
}

Expand description

Inbound group session.

Inbound group sessions are used to exchange room messages between a group of participants. Inbound group sessions are used to decrypt the room messages.

Fields

session_id: Arc<str>

The SessionId associated to this GroupSession

sender_key: Arc<str>

The sender_key associated to this GroupSession

signing_keys: Arc<BTreeMap<DeviceKeyAlgorithm, String>>

Map of DeviceKeyAlgorithm to the public ed25519 key of the account

room_id: Arc<RoomId>

The Room this GroupSession belongs to

Implementations

source

impl InboundGroupSession

source

pub fn new(
 sender_key: &str,
 signing_key: &str,
 room_id: &RoomId,
 session_key: SessionKey,
 history_visibility: Option<HistoryVisibility>
) -> Self

Create a new inbound group session for the given room.

These sessions are used to decrypt room messages.

Arguments

sender_key - The public curve25519 key of the account that sent us the session
signing_key - The public ed25519 key of the account that sent us the session.
room_id - The id of the room that the session is used in.
session_key - The private session key that is used to decrypt messages.

source

pub fn from_export(exported_session: ExportedRoomKey) -> Self

Create a InboundGroupSession from an exported version of the group session.

Most notably this can be called with an ExportedRoomKey from a previous export() call.

source

pub fn from_forwarded_key(
sender_key: &str,
content: &mut ToDeviceForwardedRoomKeyEventContent
) -> Result<Self, SessionKeyDecodeError>

Create a new inbound group session from a forwarded room key content.

Arguments

sender_key - The public curve25519 key of the account that sent us the session
content - A forwarded room key content that contains the session key to create the InboundGroupSession.

source

pub async fn pickle(&self) -> PickledInboundGroupSession

Store the group session as a base64 encoded string.

Arguments

pickle_mode - The mode that was used to pickle the group session, either an unencrypted mode or an encrypted using passphrase.

source

pub async fn export(&self) -> ExportedRoomKey

Export this session at the first known message index.

If only a limited part of this session should be exported use export_at_index().

source

pub fn sender_key(&self) -> &str

Get the sender key that this session was received from.

source

pub fn backed_up(&self) -> bool

Has the session been backed up to the server.

source

pub fn reset_backup_state(&self)

Reset the backup state of the inbound group session.

source

pub fn mark_as_backed_up(&self)

For testing, allow to manually mark this GroupSession to have been backed up

source

pub fn signing_keys(&self) -> &BTreeMap<DeviceKeyAlgorithm, String>

Get the map of signing keys this session was received from.

source

pub fn forwarding_key_chain(&self) -> &[String ]

Get the list of ed25519 keys that this session was forwarded through.

Each ed25519 key represents a single device. If device A forwards the session to device B and device B to C this list will contain the ed25519 keys of A and B.

source

pub async fn export_at_index(&self, message_index: u32) -> ExportedRoomKey

Export this session at the given message index.

source

pub fn from_pickle(
pickle: PickledInboundGroupSession
) -> Result<Self, PickleError>

Restore a Session from a previously pickled string.

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

Arguments

pickle - The pickled version of the InboundGroupSession.
pickle_mode - The mode that was used to pickle the session, either an unencrypted mode or an encrypted using passphrase.

source