Struct ExportedRoomKey

pub struct ExportedRoomKey {
    pub algorithm: EventEncryptionAlgorithm,
    pub room_id: OwnedRoomId,
    pub sender_key: Curve25519PublicKey,
    pub session_id: String,
    pub session_key: ExportedSessionKey,
    pub sender_claimed_keys: SigningKeys<DeviceKeyAlgorithm>,
    pub forwarding_curve25519_key_chain: Vec<Curve25519PublicKey>,
    pub shared_history: bool,
}

An exported version of an InboundGroupSession

This can be used to share the InboundGroupSession in an exported file.

Fields

algorithm: EventEncryptionAlgorithm

The encryption algorithm that the session uses.

room_id: OwnedRoomId

The room where the session is used.

sender_key: Curve25519PublicKey

The Curve25519 key of the device which initiated the session originally.

session_id: String

The ID of the session that the key is for.

session_key: ExportedSessionKey

The key for the session.

sender_claimed_keys: SigningKeys<DeviceKeyAlgorithm>

The Ed25519 key of the device which initiated the session originally.

forwarding_curve25519_key_chain: Vec<Curve25519PublicKey>

Chain of Curve25519 keys through which this session was forwarded, via m.forwarded_room_key events.

shared_history: bool

Whether this ExportedRoomKey can be shared with users who are invited to the room in the future, allowing access to history, as defined in MSC3061.

Implementations

impl ExportedRoomKey

pub fn from_backed_up_room_key( room_id: OwnedRoomId, session_id: String, room_key: BackedUpRoomKey, ) -> Self

Create an ExportedRoomKey from a BackedUpRoomKey.

This can be used when importing the keys from a backup into the store.

Trait Implementations

impl<'de> Deserialize<'de> for ExportedRoomKey

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ExportedRoomKey> for BackedUpRoomKey

fn from(value: ExportedRoomKey) -> Self

Converts to this type from the input type.

impl Serialize for ExportedRoomKey

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&ExportedRoomKey> for InboundGroupSession

type Error = SessionCreationError

The type returned in the event of a conversion error.

fn try_from(key: &ExportedRoomKey) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ExportedRoomKey> for ForwardedRoomKeyContent

fn try_from( room_key: ExportedRoomKey, ) -> Result<ForwardedRoomKeyContent, Self::Error>

Convert an exported room key into a content for a forwarded room key event.

This will fail if the exported room key doesn’t contain an Ed25519 claimed sender key.

type Error = SessionExportError

The type returned in the event of a conversion error.

impl TryFrom<ForwardedRoomKeyContent> for ExportedRoomKey

fn try_from(forwarded_key: ForwardedRoomKeyContent) -> Result<Self, Self::Error>

Convert the content of a forwarded room key into a exported room key.

type Error = SessionExportError

The type returned in the event of a conversion error.