fdc15123b0
Some types used for encryption related tasks need to be used across more internal crates than expected, so a few have been moved and renamed for clarity. * Rename the key_algorithms module in ruma-identifiers-validation to crypto_algorithms * Move ruma_events::Algorithm to ruma-identifiers-validation and rename it EventEncryptionAlgorithm * Move DeviceKeys from ruma-client-api to ruma-common
67 lines
2.1 KiB
Rust
67 lines
2.1 KiB
Rust
//! Types for the *m.room_key_request* event.
|
|
|
|
use ruma_events_macros::BasicEventContent;
|
|
use ruma_identifiers::{DeviceId, EventEncryptionAlgorithm, RoomId};
|
|
use serde::{Deserialize, Serialize};
|
|
use strum::{Display, EnumString};
|
|
|
|
use crate::BasicEvent;
|
|
|
|
/// This event type is used to request keys for end-to-end encryption.
|
|
///
|
|
/// It is sent as an unencrypted to-device event.
|
|
pub type RoomKeyRequestEvent = BasicEvent<RoomKeyRequestEventContent>;
|
|
|
|
/// The payload for `RoomKeyRequestEvent`.
|
|
#[derive(Clone, Debug, Deserialize, Serialize, BasicEventContent)]
|
|
#[ruma_event(type = "m.room_key_request")]
|
|
pub struct RoomKeyRequestEventContent {
|
|
/// Whether this is a new key request or a cancellation of a previous request.
|
|
pub action: Action,
|
|
|
|
/// Information about the requested key.
|
|
///
|
|
/// Required when action is `request`.
|
|
pub body: Option<RequestedKeyInfo>,
|
|
|
|
/// ID of the device requesting the key.
|
|
pub requesting_device_id: Box<DeviceId>,
|
|
|
|
/// A random string uniquely identifying the request for a key.
|
|
///
|
|
/// If the key is requested multiple times, it should be reused. It should also reused
|
|
/// in order to cancel a request.
|
|
pub request_id: String,
|
|
}
|
|
|
|
/// A new key request or a cancellation of a previous request.
|
|
#[derive(Clone, Copy, Debug, PartialEq, Display, EnumString, Deserialize, Serialize)]
|
|
#[non_exhaustive]
|
|
#[serde(rename_all = "snake_case")]
|
|
#[strum(serialize_all = "snake_case")]
|
|
pub enum Action {
|
|
/// Request a key.
|
|
Request,
|
|
|
|
/// Cancel a request for a key.
|
|
#[serde(rename = "request_cancellation")]
|
|
#[strum(serialize = "request_cancellation")]
|
|
CancelRequest,
|
|
}
|
|
|
|
/// Information about a requested key.
|
|
#[derive(Clone, Debug, Deserialize, Serialize)]
|
|
pub struct RequestedKeyInfo {
|
|
/// The encryption algorithm the requested key in this event is to be used with.
|
|
pub algorithm: EventEncryptionAlgorithm,
|
|
|
|
/// The room where the key is used.
|
|
pub room_id: RoomId,
|
|
|
|
/// The Curve25519 key of the device which initiated the session originally.
|
|
pub sender_key: String,
|
|
|
|
/// The ID of the session that the key is for.
|
|
pub session_id: String,
|
|
}
|