1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
// Copyright 2020 The Matrix.org Foundation C.I.C.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use std::{
cmp::max,
collections::{BTreeMap, BTreeSet},
fmt,
sync::{
atomic::{AtomicBool, AtomicU64, Ordering},
Arc, RwLock as StdRwLock,
},
time::Duration,
};
use ruma::{
events::{
room::{encryption::RoomEncryptionEventContent, history_visibility::HistoryVisibility},
AnyMessageLikeEventContent,
},
serde::Raw,
DeviceId, OwnedDeviceId, OwnedRoomId, OwnedTransactionId, OwnedUserId, RoomId,
SecondsSinceUnixEpoch, TransactionId, UserId,
};
use serde::{Deserialize, Serialize};
use tokio::sync::RwLock;
use tracing::{debug, error, info};
use vodozemac::{megolm::SessionConfig, Curve25519PublicKey};
pub use vodozemac::{
megolm::{GroupSession, GroupSessionPickle, MegolmMessage, SessionKey},
olm::IdentityKeys,
PickleError,
};
use super::SessionCreationError;
#[cfg(feature = "experimental-algorithms")]
use crate::types::events::room::encrypted::MegolmV2AesSha2Content;
use crate::{
session_manager::CollectStrategy,
store::caches::SequenceNumber,
types::{
events::{
room::encrypted::{
MegolmV1AesSha2Content, RoomEncryptedEventContent, RoomEventEncryptionScheme,
},
room_key::{MegolmV1AesSha2Content as MegolmV1AesSha2RoomKeyContent, RoomKeyContent},
room_key_withheld::{RoomKeyWithheldContent, WithheldCode},
},
EventEncryptionAlgorithm,
},
DeviceData, ToDeviceRequest,
};
const ONE_HOUR: Duration = Duration::from_secs(60 * 60);
const ONE_WEEK: Duration = Duration::from_secs(60 * 60 * 24 * 7);
const ROTATION_PERIOD: Duration = ONE_WEEK;
const ROTATION_MESSAGES: u64 = 100;
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
/// Information about whether a session was shared with a device.
pub(crate) enum ShareState {
/// The session was not shared with the device.
NotShared,
/// The session was shared with the device with the given device ID, but
/// with a different curve25519 key.
SharedButChangedSenderKey,
/// The session was shared with the device, at the given message index. The
/// `olm_wedging_index` is the value of the `olm_wedging_index` from the
/// [`DeviceData`] at the time that we last shared the session with the
/// device, and indicates whether we need to re-share the session with the
/// device.
Shared { message_index: u32, olm_wedging_index: SequenceNumber },
}
/// Settings for an encrypted room.
///
/// This determines the algorithm and rotation periods of a group session.
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct EncryptionSettings {
/// The encryption algorithm that should be used in the room.
pub algorithm: EventEncryptionAlgorithm,
/// How long the session should be used before changing it.
pub rotation_period: Duration,
/// How many messages should be sent before changing the session.
pub rotation_period_msgs: u64,
/// The history visibility of the room when the session was created.
pub history_visibility: HistoryVisibility,
/// The strategy used to distribute the room keys to participant.
/// Default will send to all devices.
#[serde(default)]
pub sharing_strategy: CollectStrategy,
}
impl Default for EncryptionSettings {
fn default() -> Self {
Self {
algorithm: EventEncryptionAlgorithm::MegolmV1AesSha2,
rotation_period: ROTATION_PERIOD,
rotation_period_msgs: ROTATION_MESSAGES,
history_visibility: HistoryVisibility::Shared,
sharing_strategy: CollectStrategy::default(),
}
}
}
impl EncryptionSettings {
/// Create new encryption settings using an `RoomEncryptionEventContent`,
/// a history visibility, and key sharing strategy.
pub fn new(
content: RoomEncryptionEventContent,
history_visibility: HistoryVisibility,
sharing_strategy: CollectStrategy,
) -> Self {
let rotation_period: Duration =
content.rotation_period_ms.map_or(ROTATION_PERIOD, |r| Duration::from_millis(r.into()));
let rotation_period_msgs: u64 =
content.rotation_period_msgs.map_or(ROTATION_MESSAGES, Into::into);
Self {
algorithm: EventEncryptionAlgorithm::from(content.algorithm.as_str()),
rotation_period,
rotation_period_msgs,
history_visibility,
sharing_strategy,
}
}
}
/// 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.
#[derive(Clone)]
pub struct OutboundGroupSession {
inner: Arc<RwLock<GroupSession>>,
device_id: OwnedDeviceId,
account_identity_keys: Arc<IdentityKeys>,
session_id: Arc<str>,
room_id: OwnedRoomId,
pub(crate) creation_time: SecondsSinceUnixEpoch,
message_count: Arc<AtomicU64>,
shared: Arc<AtomicBool>,
invalidated: Arc<AtomicBool>,
settings: Arc<EncryptionSettings>,
pub(crate) shared_with_set:
Arc<StdRwLock<BTreeMap<OwnedUserId, BTreeMap<OwnedDeviceId, ShareInfo>>>>,
#[allow(clippy::type_complexity)]
to_share_with_set:
Arc<StdRwLock<BTreeMap<OwnedTransactionId, (Arc<ToDeviceRequest>, ShareInfoSet)>>>,
}
/// A a map of userid/device it to a `ShareInfo`.
///
/// Holds the `ShareInfo` for all the user/device pairs that will receive the
/// room key.
pub type ShareInfoSet = BTreeMap<OwnedUserId, BTreeMap<OwnedDeviceId, ShareInfo>>;
/// Struct holding info about the share state of a outbound group session.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub enum ShareInfo {
/// When the key has been shared
Shared(SharedWith),
/// When the session has been withheld
Withheld(WithheldCode),
}
impl ShareInfo {
/// Helper to create a SharedWith info
pub fn new_shared(
sender_key: Curve25519PublicKey,
message_index: u32,
olm_wedging_index: SequenceNumber,
) -> Self {
ShareInfo::Shared(SharedWith { sender_key, message_index, olm_wedging_index })
}
/// Helper to create a Withheld info
pub fn new_withheld(code: WithheldCode) -> Self {
ShareInfo::Withheld(code)
}
}
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct SharedWith {
/// The sender key of the device that was used to encrypt the room key.
pub sender_key: Curve25519PublicKey,
/// The message index that the device received.
pub message_index: u32,
/// The Olm wedging index of the device at the time the session was shared.
#[serde(default)]
pub olm_wedging_index: SequenceNumber,
}
impl OutboundGroupSession {
pub(super) fn session_config(
algorithm: &EventEncryptionAlgorithm,
) -> Result<SessionConfig, SessionCreationError> {
match algorithm {
EventEncryptionAlgorithm::MegolmV1AesSha2 => Ok(SessionConfig::version_1()),
#[cfg(feature = "experimental-algorithms")]
EventEncryptionAlgorithm::MegolmV2AesSha2 => Ok(SessionConfig::version_2()),
_ => Err(SessionCreationError::Algorithm(algorithm.to_owned())),
}
}
/// 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.
pub fn new(
device_id: OwnedDeviceId,
identity_keys: Arc<IdentityKeys>,
room_id: &RoomId,
settings: EncryptionSettings,
) -> Result<Self, SessionCreationError> {
let config = Self::session_config(&settings.algorithm)?;
let session = GroupSession::new(config);
let session_id = session.session_id();
Ok(OutboundGroupSession {
inner: RwLock::new(session).into(),
room_id: room_id.into(),
device_id,
account_identity_keys: identity_keys,
session_id: session_id.into(),
creation_time: SecondsSinceUnixEpoch::now(),
message_count: Arc::new(AtomicU64::new(0)),
shared: Arc::new(AtomicBool::new(false)),
invalidated: Arc::new(AtomicBool::new(false)),
settings: Arc::new(settings),
shared_with_set: Default::default(),
to_share_with_set: Default::default(),
})
}
/// Add a to-device request that is sending the session key (or room key)
/// belonging to this [`OutboundGroupSession`] to other members of the
/// group.
///
/// The request will get persisted with the session which allows seamless
/// session reuse across application restarts.
///
/// **Warning** this method is only exposed to be used in integration tests
/// of crypto-store implementations. **Do not use this outside of tests**.
pub fn add_request(
&self,
request_id: OwnedTransactionId,
request: Arc<ToDeviceRequest>,
share_infos: ShareInfoSet,
) {
self.to_share_with_set.write().unwrap().insert(request_id, (request, share_infos));
}
/// Create a new `m.room_key.withheld` event content with the given code for
/// this outbound group session.
pub fn withheld_code(&self, code: WithheldCode) -> RoomKeyWithheldContent {
RoomKeyWithheldContent::new(
self.settings().algorithm.to_owned(),
code,
self.room_id().to_owned(),
self.session_id().to_owned(),
self.sender_key().to_owned(),
(*self.device_id).to_owned(),
)
}
/// This should be called if an the user wishes to rotate this session.
pub fn invalidate_session(&self) {
self.invalidated.store(true, Ordering::Relaxed)
}
/// Get the encryption settings of this outbound session.
pub fn settings(&self) -> &EncryptionSettings {
&self.settings
}
/// 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.
pub fn mark_request_as_sent(
&self,
request_id: &TransactionId,
) -> BTreeMap<OwnedUserId, BTreeSet<OwnedDeviceId>> {
let mut no_olm_devices = BTreeMap::new();
let removed = self.to_share_with_set.write().unwrap().remove(request_id);
if let Some((to_device, request)) = removed {
let recipients: BTreeMap<&UserId, BTreeSet<&DeviceId>> = request
.iter()
.map(|(u, d)| (u.as_ref(), d.keys().map(|d| d.as_ref()).collect()))
.collect();
info!(
?request_id,
?recipients,
?to_device.event_type,
"Marking to-device request carrying a room key or a withheld as sent"
);
for (user_id, info) in request {
let no_olms: BTreeSet<OwnedDeviceId> = info
.iter()
.filter(|(_, info)| matches!(info, ShareInfo::Withheld(WithheldCode::NoOlm)))
.map(|(d, _)| d.to_owned())
.collect();
no_olm_devices.insert(user_id.to_owned(), no_olms);
self.shared_with_set.write().unwrap().entry(user_id).or_default().extend(info);
}
if self.to_share_with_set.read().unwrap().is_empty() {
debug!(
session_id = self.session_id(),
room_id = ?self.room_id,
"All m.room_key and withheld to-device requests were sent out, marking \
session as shared.",
);
self.mark_as_shared();
}
} else {
let request_ids: Vec<String> =
self.to_share_with_set.read().unwrap().keys().map(|k| k.to_string()).collect();
error!(
all_request_ids = ?request_ids,
request_id = ?request_id,
"Marking to-device request carrying a room key as sent but no \
request found with the given id"
);
}
no_olm_devices
}
/// Encrypt the given plaintext using this session.
///
/// Returns the encrypted ciphertext.
///
/// # Arguments
///
/// * `plaintext` - The plaintext that should be encrypted.
pub(crate) async fn encrypt_helper(&self, plaintext: String) -> MegolmMessage {
let mut session = self.inner.write().await;
self.message_count.fetch_add(1, Ordering::SeqCst);
session.encrypt(&plaintext)
}
/// Encrypt a room message for the given room.
///
/// Beware that a room key needs to be shared before this method
/// can be called using the `share_room_key()` method.
///
/// # Arguments
///
/// * `event_type` - The plaintext type of the event, the outer type of the
/// event will become `m.room.encrypted`.
///
/// * `content` - The plaintext content of the message that should be
/// encrypted in raw JSON form.
///
/// # Panics
///
/// Panics if the content can't be serialized.
pub async fn encrypt(
&self,
event_type: &str,
content: &Raw<AnyMessageLikeEventContent>,
) -> Raw<RoomEncryptedEventContent> {
#[derive(Serialize)]
struct Payload<'a> {
#[serde(rename = "type")]
event_type: &'a str,
content: &'a Raw<AnyMessageLikeEventContent>,
room_id: &'a RoomId,
}
let payload = Payload { event_type, content, room_id: &self.room_id };
let payload_json =
serde_json::to_string(&payload).expect("payload serialization never fails");
let relates_to = content
.get_field::<serde_json::Value>("m.relates_to")
.expect("serde_json::Value deserialization with valid JSON input never fails");
let ciphertext = self.encrypt_helper(payload_json).await;
let scheme: RoomEventEncryptionScheme = match self.settings.algorithm {
EventEncryptionAlgorithm::MegolmV1AesSha2 => MegolmV1AesSha2Content {
ciphertext,
sender_key: self.account_identity_keys.curve25519,
session_id: self.session_id().to_owned(),
device_id: (*self.device_id).to_owned(),
}
.into(),
#[cfg(feature = "experimental-algorithms")]
EventEncryptionAlgorithm::MegolmV2AesSha2 => {
MegolmV2AesSha2Content { ciphertext, session_id: self.session_id().to_owned() }
.into()
}
_ => unreachable!(
"An outbound group session is always using one of the supported algorithms"
),
};
let content = RoomEncryptedEventContent { scheme, relates_to, other: Default::default() };
Raw::new(&content).expect("m.room.encrypted event content can always be serialized")
}
fn elapsed(&self) -> bool {
let creation_time = Duration::from_secs(self.creation_time.get().into());
let now = Duration::from_secs(SecondsSinceUnixEpoch::now().get().into());
now.checked_sub(creation_time)
.map(|elapsed| elapsed >= self.safe_rotation_period())
.unwrap_or(true)
}
/// Returns the rotation_period_ms that was set for this session, clamped
/// to be no less than one hour.
///
/// This is to prevent a malicious or careless user causing sessions to be
/// rotated very frequently.
///
/// The feature flag `_disable-minimum-rotation-period-ms` can
/// be used to prevent this behaviour (which can be useful for tests).
fn safe_rotation_period(&self) -> Duration {
if cfg!(feature = "_disable-minimum-rotation-period-ms") {
self.settings.rotation_period
} else {
max(self.settings.rotation_period, ONE_HOUR)
}
}
/// 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.
pub fn expired(&self) -> bool {
let count = self.message_count.load(Ordering::SeqCst);
// We clamp the rotation period for message counts to be between 1 and
// 10000. The Megolm session should be usable for at least 1 message,
// and at most 10000 messages. Realistically Megolm uses u32 for it's
// internal counter and one could use the Megolm session for up to
// u32::MAX messages, but we're staying on the safe side of things.
let rotation_period_msgs = self.settings.rotation_period_msgs.clamp(1, 10_000);
count >= rotation_period_msgs || self.elapsed()
}
/// Has the session been invalidated.
pub fn invalidated(&self) -> bool {
self.invalidated.load(Ordering::Relaxed)
}
/// Mark the session as shared.
///
/// Messages shouldn't be encrypted with the session before it has been
/// shared.
pub fn mark_as_shared(&self) {
self.shared.store(true, Ordering::Relaxed);
}
/// Check if the session has been marked as shared.
pub fn shared(&self) -> bool {
self.shared.load(Ordering::Relaxed)
}
/// Get the session key of this session.
///
/// A session key can be used to to create an `InboundGroupSession`.
pub async fn session_key(&self) -> SessionKey {
let session = self.inner.read().await;
session.session_key()
}
/// Gets the Sender Key
pub fn sender_key(&self) -> Curve25519PublicKey {
self.account_identity_keys.as_ref().curve25519.to_owned()
}
/// Get the room id of the room this session belongs to.
pub fn room_id(&self) -> &RoomId {
&self.room_id
}
/// Returns the unique identifier for this session.
pub fn session_id(&self) -> &str {
&self.session_id
}
/// 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.
pub async fn message_index(&self) -> u32 {
let session = self.inner.read().await;
session.message_index()
}
pub(crate) async fn as_content(&self) -> RoomKeyContent {
let session_key = self.session_key().await;
RoomKeyContent::MegolmV1AesSha2(
MegolmV1AesSha2RoomKeyContent::new(
self.room_id().to_owned(),
self.session_id().to_owned(),
session_key,
)
.into(),
)
}
/// Has or will the session be shared with the given user/device pair.
pub(crate) fn is_shared_with(&self, device: &DeviceData) -> ShareState {
// Check if we shared the session.
let shared_state =
self.shared_with_set.read().unwrap().get(device.user_id()).and_then(|d| {
d.get(device.device_id()).map(|s| match s {
ShareInfo::Shared(s) => {
if device.curve25519_key() == Some(s.sender_key) {
ShareState::Shared {
message_index: s.message_index,
olm_wedging_index: s.olm_wedging_index,
}
} else {
ShareState::SharedButChangedSenderKey
}
}
ShareInfo::Withheld(_) => ShareState::NotShared,
})
});
if let Some(state) = shared_state {
state
} else {
// If we haven't shared the session, check if we're going to share
// the session.
// Find the first request that contains the given user id and
// device ID.
let shared =
self.to_share_with_set.read().unwrap().values().find_map(|(_, share_info)| {
let d = share_info.get(device.user_id())?;
let info = d.get(device.device_id())?;
Some(match info {
ShareInfo::Shared(info) => {
if device.curve25519_key() == Some(info.sender_key) {
ShareState::Shared {
message_index: info.message_index,
olm_wedging_index: info.olm_wedging_index,
}
} else {
ShareState::SharedButChangedSenderKey
}
}
ShareInfo::Withheld(_) => ShareState::NotShared,
})
});
shared.unwrap_or(ShareState::NotShared)
}
}
pub(crate) fn is_withheld_to(&self, device: &DeviceData, code: &WithheldCode) -> bool {
self.shared_with_set
.read()
.unwrap()
.get(device.user_id())
.and_then(|d| {
let info = d.get(device.device_id())?;
Some(matches!(info, ShareInfo::Withheld(c) if c == code))
})
.unwrap_or_else(|| {
// If we haven't yet withheld, check if we're going to withheld
// the session.
// Find the first request that contains the given user id and
// device ID.
self.to_share_with_set.read().unwrap().values().any(|(_, share_info)| {
share_info
.get(device.user_id())
.and_then(|d| d.get(device.device_id()))
.is_some_and(|info| matches!(info, ShareInfo::Withheld(c) if c == code))
})
})
}
/// Mark the session as shared with the given user/device pair, starting
/// from some message index.
#[cfg(test)]
pub fn mark_shared_with_from_index(
&self,
user_id: &UserId,
device_id: &DeviceId,
sender_key: Curve25519PublicKey,
index: u32,
) {
self.shared_with_set.write().unwrap().entry(user_id.to_owned()).or_default().insert(
device_id.to_owned(),
ShareInfo::new_shared(sender_key, index, Default::default()),
);
}
/// Mark the session as shared with the given user/device pair, starting
/// from the current index.
#[cfg(test)]
pub async fn mark_shared_with(
&self,
user_id: &UserId,
device_id: &DeviceId,
sender_key: Curve25519PublicKey,
) {
let share_info =
ShareInfo::new_shared(sender_key, self.message_index().await, Default::default());
self.shared_with_set
.write()
.unwrap()
.entry(user_id.to_owned())
.or_default()
.insert(device_id.to_owned(), share_info);
}
/// Get the list of requests that need to be sent out for this session to be
/// marked as shared.
pub(crate) fn pending_requests(&self) -> Vec<Arc<ToDeviceRequest>> {
self.to_share_with_set.read().unwrap().values().map(|(req, _)| req.clone()).collect()
}
/// Get the list of request ids this session is waiting for to be sent out.
pub(crate) fn pending_request_ids(&self) -> Vec<OwnedTransactionId> {
self.to_share_with_set.read().unwrap().keys().cloned().collect()
}
/// 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.
pub fn from_pickle(
device_id: OwnedDeviceId,
identity_keys: Arc<IdentityKeys>,
pickle: PickledOutboundGroupSession,
) -> Result<Self, PickleError> {
let inner: GroupSession = pickle.pickle.into();
let session_id = inner.session_id();
Ok(Self {
inner: Arc::new(RwLock::new(inner)),
device_id,
account_identity_keys: identity_keys,
session_id: session_id.into(),
room_id: pickle.room_id,
creation_time: pickle.creation_time,
message_count: AtomicU64::from(pickle.message_count).into(),
shared: AtomicBool::from(pickle.shared).into(),
invalidated: AtomicBool::from(pickle.invalidated).into(),
settings: pickle.settings,
shared_with_set: Arc::new(StdRwLock::new(pickle.shared_with_set)),
to_share_with_set: Arc::new(StdRwLock::new(pickle.requests)),
})
}
/// Store the group session as a base64 encoded string and associated data
/// belonging to the session.
///
/// # Arguments
///
/// * `pickle_mode` - The mode that should be used to pickle the group
/// session, either an unencrypted mode or an encrypted using passphrase.
pub async fn pickle(&self) -> PickledOutboundGroupSession {
let pickle = self.inner.read().await.pickle();
PickledOutboundGroupSession {
pickle,
room_id: self.room_id.clone(),
settings: self.settings.clone(),
creation_time: self.creation_time,
message_count: self.message_count.load(Ordering::SeqCst),
shared: self.shared(),
invalidated: self.invalidated(),
shared_with_set: self.shared_with_set.read().unwrap().clone(),
requests: self.to_share_with_set.read().unwrap().clone(),
}
}
}
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct OutboundGroupSessionPickle(String);
impl From<String> for OutboundGroupSessionPickle {
fn from(p: String) -> Self {
Self(p)
}
}
#[cfg(not(tarpaulin_include))]
impl fmt::Debug for OutboundGroupSession {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("OutboundGroupSession")
.field("session_id", &self.session_id)
.field("room_id", &self.room_id)
.field("creation_time", &self.creation_time)
.field("message_count", &self.message_count)
.finish()
}
}
/// A pickled version of an `InboundGroupSession`.
///
/// Holds all the information that needs to be stored in a database to restore
/// an InboundGroupSession.
#[derive(Deserialize, Serialize)]
#[allow(missing_debug_implementations)]
pub struct PickledOutboundGroupSession {
/// The pickle string holding the OutboundGroupSession.
pub pickle: GroupSessionPickle,
/// The settings this session adheres to.
pub settings: Arc<EncryptionSettings>,
/// The room id this session is used for.
pub room_id: OwnedRoomId,
/// The timestamp when this session was created.
pub creation_time: SecondsSinceUnixEpoch,
/// The number of messages this session has already encrypted.
pub message_count: u64,
/// Is the session shared.
pub shared: bool,
/// Has the session been invalidated.
pub invalidated: bool,
/// The set of users the session has been already shared with.
pub shared_with_set: BTreeMap<OwnedUserId, BTreeMap<OwnedDeviceId, ShareInfo>>,
/// Requests that need to be sent out to share the session.
pub requests: BTreeMap<OwnedTransactionId, (Arc<ToDeviceRequest>, ShareInfoSet)>,
}
#[cfg(test)]
mod tests {
use std::time::Duration;
use ruma::{
events::room::{
encryption::RoomEncryptionEventContent, history_visibility::HistoryVisibility,
},
uint, EventEncryptionAlgorithm,
};
use super::{EncryptionSettings, ROTATION_MESSAGES, ROTATION_PERIOD};
use crate::CollectStrategy;
#[test]
fn test_encryption_settings_conversion() {
let mut content =
RoomEncryptionEventContent::new(EventEncryptionAlgorithm::MegolmV1AesSha2);
let settings = EncryptionSettings::new(
content.clone(),
HistoryVisibility::Joined,
CollectStrategy::DeviceBasedStrategy {
only_allow_trusted_devices: false,
error_on_verified_user_problem: false,
},
);
assert_eq!(settings.rotation_period, ROTATION_PERIOD);
assert_eq!(settings.rotation_period_msgs, ROTATION_MESSAGES);
content.rotation_period_ms = Some(uint!(3600));
content.rotation_period_msgs = Some(uint!(500));
let settings = EncryptionSettings::new(
content,
HistoryVisibility::Shared,
CollectStrategy::DeviceBasedStrategy {
only_allow_trusted_devices: false,
error_on_verified_user_problem: false,
},
);
assert_eq!(settings.rotation_period, Duration::from_millis(3600));
assert_eq!(settings.rotation_period_msgs, 500);
}
#[cfg(any(target_os = "linux", target_os = "macos", target_arch = "wasm32"))]
mod expiration {
use std::{sync::atomic::Ordering, time::Duration};
use matrix_sdk_test::async_test;
use ruma::{
device_id, events::room::message::RoomMessageEventContent, room_id, serde::Raw, uint,
user_id, SecondsSinceUnixEpoch,
};
use crate::{
olm::{OutboundGroupSession, SenderData},
Account, EncryptionSettings, MegolmError,
};
const TWO_HOURS: Duration = Duration::from_secs(60 * 60 * 2);
#[async_test]
async fn test_session_is_not_expired_if_no_messages_sent_and_no_time_passed() {
// Given a session that expires after one message
let session = create_session(EncryptionSettings {
rotation_period_msgs: 1,
..Default::default()
})
.await;
// When we send no messages at all
// Then it is not expired
assert!(!session.expired());
}
#[async_test]
async fn test_session_is_expired_if_we_rotate_every_message_and_one_was_sent(
) -> Result<(), MegolmError> {
// Given a session that expires after one message
let session = create_session(EncryptionSettings {
rotation_period_msgs: 1,
..Default::default()
})
.await;
// When we send a message
let _ = session
.encrypt(
"m.room.message",
&Raw::new(&RoomMessageEventContent::text_plain("Test message"))?.cast(),
)
.await;
// Then the session is expired
assert!(session.expired());
Ok(())
}
#[async_test]
async fn test_session_with_rotation_period_is_not_expired_after_no_time() {
// Given a session with a 2h expiration
let session = create_session(EncryptionSettings {
rotation_period: TWO_HOURS,
..Default::default()
})
.await;
// When we don't allow any time to pass
// Then it is not expired
assert!(!session.expired());
}
#[async_test]
async fn test_session_is_expired_after_rotation_period() {
// Given a session with a 2h expiration
let mut session = create_session(EncryptionSettings {
rotation_period: TWO_HOURS,
..Default::default()
})
.await;
// When 3 hours have passed
let now = SecondsSinceUnixEpoch::now();
session.creation_time = SecondsSinceUnixEpoch(now.get() - uint!(10800));
// Then the session is expired
assert!(session.expired());
}
#[async_test]
#[cfg(not(feature = "_disable-minimum-rotation-period-ms"))]
async fn test_session_does_not_expire_under_one_hour_even_if_we_ask_for_shorter() {
// Given a session with a 100ms expiration
let mut session = create_session(EncryptionSettings {
rotation_period: Duration::from_millis(100),
..Default::default()
})
.await;
// When less than an hour has passed
let now = SecondsSinceUnixEpoch::now();
session.creation_time = SecondsSinceUnixEpoch(now.get() - uint!(1800));
// Then the session is not expired: we enforce a minimum of 1 hour
assert!(!session.expired());
// But when more than an hour has passed
session.creation_time = SecondsSinceUnixEpoch(now.get() - uint!(3601));
// Then the session is expired
assert!(session.expired());
}
#[async_test]
#[cfg(feature = "_disable-minimum-rotation-period-ms")]
async fn test_with_disable_minrotperiod_feature_sessions_can_expire_quickly() {
// Given a session with a 100ms expiration
let mut session = create_session(EncryptionSettings {
rotation_period: Duration::from_millis(100),
..Default::default()
})
.await;
// When less than an hour has passed
let now = SecondsSinceUnixEpoch::now();
session.creation_time = SecondsSinceUnixEpoch(now.get() - uint!(1800));
// Then the session is expired: the feature flag has prevented us enforcing a
// minimum
assert!(session.expired());
}
#[async_test]
async fn test_session_with_zero_msgs_rotation_is_not_expired_initially() {
// Given a session that is supposed to expire after zero messages
let session = create_session(EncryptionSettings {
rotation_period_msgs: 0,
..Default::default()
})
.await;
// When we send no messages
// Then the session is not expired: we are protected against this nonsensical
// setup
assert!(!session.expired());
}
#[async_test]
async fn test_session_with_zero_msgs_rotation_expires_after_one_message(
) -> Result<(), MegolmError> {
// Given a session that is supposed to expire after zero messages
let session = create_session(EncryptionSettings {
rotation_period_msgs: 0,
..Default::default()
})
.await;
// When we send a message
let _ = session
.encrypt(
"m.room.message",
&Raw::new(&RoomMessageEventContent::text_plain("Test message"))?.cast(),
)
.await;
// Then the session is expired: we treated rotation_period_msgs=0 as if it were
// =1
assert!(session.expired());
Ok(())
}
#[async_test]
async fn test_session_expires_after_10k_messages_even_if_we_ask_for_more() {
// Given we asked to expire after 100K messages
let session = create_session(EncryptionSettings {
rotation_period_msgs: 100_000,
..Default::default()
})
.await;
// Sanity: it does not expire after <10K messages
assert!(!session.expired());
session.message_count.store(1000, Ordering::SeqCst);
assert!(!session.expired());
session.message_count.store(9999, Ordering::SeqCst);
assert!(!session.expired());
// When we have sent >= 10K messages
session.message_count.store(10_000, Ordering::SeqCst);
// Then it is considered expired: we enforce a maximum of 10K messages before
// rotation.
assert!(session.expired());
}
async fn create_session(settings: EncryptionSettings) -> OutboundGroupSession {
let account =
Account::with_device_id(user_id!("@alice:example.org"), device_id!("DEVICEID"))
.static_data;
let (session, _) = account
.create_group_session_pair(
room_id!("!test_room:example.org"),
settings,
SenderData::unknown(),
)
.await
.unwrap();
session
}
}
}