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 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021
// Copyright 2021 The Matrix.org Foundation C.I.C.
// Copyright 2021 Damir Jelić
//
// 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.
#![doc = include_str!("../docs/encryption.md")]
#![cfg_attr(target_arch = "wasm32", allow(unused_imports))]
use std::{
collections::{BTreeMap, HashSet},
io::{Cursor, Read, Write},
iter,
path::PathBuf,
sync::{Arc, Mutex as StdMutex},
};
use eyeball::{SharedObservable, Subscriber};
use futures_core::Stream;
use futures_util::{
future::try_join,
stream::{self, StreamExt},
};
use matrix_sdk_base::crypto::{
CrossSigningBootstrapRequests, OlmMachine, OutgoingRequest, RoomMessageRequest, ToDeviceRequest,
};
use matrix_sdk_common::executor::spawn;
use ruma::{
api::client::{
keys::{
get_keys, upload_keys, upload_signatures::v3::Request as UploadSignaturesRequest,
upload_signing_keys::v3::Request as UploadSigningKeysRequest,
},
message::send_message_event,
to_device::send_event_to_device::v3::{
Request as RumaToDeviceRequest, Response as ToDeviceResponse,
},
uiaa::{AuthData, UiaaInfo},
},
assign,
events::room::{MediaSource, ThumbnailInfo},
DeviceId, OwnedDeviceId, OwnedUserId, TransactionId, UserId,
};
use serde::Deserialize;
use tokio::sync::{Mutex, RwLockReadGuard};
use tracing::{debug, error, instrument, trace, warn};
use url::Url;
use vodozemac::Curve25519PublicKey;
use self::{
backups::{types::BackupClientState, Backups},
futures::UploadEncryptedFile,
identities::{Device, DeviceUpdates, IdentityUpdates, UserDevices, UserIdentity},
recovery::{Recovery, RecoveryState},
secret_storage::SecretStorage,
tasks::{BackupDownloadTask, BackupUploadingTask, ClientTasks},
verification::{SasVerification, Verification, VerificationRequest},
};
use crate::{
attachment::Thumbnail,
client::{ClientInner, WeakClient},
error::HttpResult,
store_locks::CrossProcessStoreLockGuard,
Client, Error, HttpError, Result, Room, TransmissionProgress,
};
pub mod backups;
pub mod futures;
pub mod identities;
pub mod recovery;
pub mod secret_storage;
pub(crate) mod tasks;
pub mod verification;
pub use matrix_sdk_base::crypto::{
olm::{
SessionCreationError as MegolmSessionCreationError,
SessionExportError as OlmSessionExportError,
},
vodozemac, CrossSigningStatus, CryptoStoreError, DecryptorError, EventError, KeyExportError,
LocalTrust, MediaEncryptionInfo, MegolmError, OlmError, RoomKeyImportResult, SecretImportError,
SessionCreationError, SignatureError, VERSION,
};
pub use crate::error::RoomKeyImportError;
/// All the data related to the encryption state.
pub(crate) struct EncryptionData {
/// Background tasks related to encryption (key backup, initialization
/// tasks, etc.).
pub tasks: StdMutex<ClientTasks>,
/// End-to-end encryption settings.
pub encryption_settings: EncryptionSettings,
/// All state related to key backup.
pub backup_state: BackupClientState,
/// All state related to secret storage recovery.
pub recovery_state: SharedObservable<RecoveryState>,
}
impl EncryptionData {
pub fn new(encryption_settings: EncryptionSettings) -> Self {
Self {
encryption_settings,
tasks: StdMutex::new(Default::default()),
backup_state: Default::default(),
recovery_state: Default::default(),
}
}
pub fn initialize_room_key_tasks(&self, client: &Arc<ClientInner>) {
let weak_client = WeakClient::from_inner(client);
let mut tasks = self.tasks.lock().unwrap();
tasks.upload_room_keys = Some(BackupUploadingTask::new(weak_client.clone()));
if self.encryption_settings.backup_download_strategy
== BackupDownloadStrategy::AfterDecryptionFailure
{
tasks.download_room_keys = Some(BackupDownloadTask::new(weak_client));
}
}
/// Initialize the background task which listens for changes in the
/// [`backups::BackupState`] and updataes the [`recovery::RecoveryState`].
///
/// This should happen after the usual tasks have been set up and after the
/// E2EE initialization tasks have been set up.
pub fn initialize_recovery_state_update_task(&self, client: &Client) {
let mut guard = self.tasks.lock().unwrap();
let future = Recovery::update_state_after_backup_state_change(client);
let join_handle = spawn(future);
guard.update_recovery_state_after_backup = Some(join_handle);
}
}
/// Settings for end-to-end encryption features.
#[derive(Clone, Copy, Debug, Default)]
pub struct EncryptionSettings {
/// Automatically bootstrap cross-signing for a user once they're logged, in
/// case it's not already done yet.
///
/// This requires to login with a username and password, or that MSC3967 is
/// enabled on the server, as of 2023-10-20.
pub auto_enable_cross_signing: bool,
/// Select a strategy to download room keys from the backup, by default room
/// keys won't be downloaded from the backup automatically.
///
/// Take a look at the [`BackupDownloadStrategy`] enum for more options.
pub backup_download_strategy: BackupDownloadStrategy,
/// Automatically create a backup version if no backup exists.
pub auto_enable_backups: bool,
}
/// Settings for end-to-end encryption features.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
#[cfg_attr(feature = "uniffi", derive(uniffi::Enum))]
pub enum BackupDownloadStrategy {
/// Automatically download all room keys from the backup when the backup
/// recovery key has been received. The backup recovery key can be received
/// in two ways:
///
/// 1. Received as a `m.secret.send` to-device event, after a successful
/// interactive verification.
/// 2. Imported from secret storage (4S) using the
/// [`SecretStore::import_secrets()`] method.
///
/// [`SecretStore::import_secrets()`]: crate::encryption::secret_storage::SecretStore::import_secrets
OneShot,
/// Attempt to download a single room key if an event fails to be decrypted.
AfterDecryptionFailure,
/// Don't download any room keys automatically. The user can manually
/// download room keys using the [`Backups::download_room_key()`] methods.
///
/// This is the default option.
#[default]
Manual,
}
/// The verification state of our own device
///
/// This enum tells us if our own user identity trusts these devices, in other
/// words it tells us if the user identity has signed the device.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum VerificationState {
/// The verification state is unknown for now.
Unknown,
/// The device is considered to be verified, it has been signed by its user
/// identity.
Verified,
/// The device is unverified.
Unverified,
}
/// Wraps together a `CrossProcessLockStoreGuard` and a generation number.
#[derive(Debug)]
pub struct CrossProcessLockStoreGuardWithGeneration {
_guard: CrossProcessStoreLockGuard,
generation: u64,
}
impl CrossProcessLockStoreGuardWithGeneration {
/// Return the Crypto Store generation associated with this store lock.
pub fn generation(&self) -> u64 {
self.generation
}
}
/// A stateful struct remembering the cross-signing keys we need to upload.
///
/// Since the `/_matrix/client/v3/keys/device_signing/upload` might require
/// additional authentication, this struct will contain information on the type
/// of authentication the user needs to complete before the upload might be
/// continued.
///
/// More info can be found in the [spec].
///
/// [spec]: https://spec.matrix.org/v1.11/client-server-api/#post_matrixclientv3keysdevice_signingupload
#[derive(Debug)]
pub struct CrossSigningResetHandle {
client: Client,
upload_request: UploadSigningKeysRequest,
signatures_request: UploadSignaturesRequest,
auth_type: CrossSigningResetAuthType,
is_cancelled: Mutex<bool>,
}
impl CrossSigningResetHandle {
/// Set up a new `CrossSigningResetHandle`.
pub fn new(
client: Client,
upload_request: UploadSigningKeysRequest,
signatures_request: UploadSignaturesRequest,
auth_type: CrossSigningResetAuthType,
) -> Self {
Self {
client,
upload_request,
signatures_request,
auth_type,
is_cancelled: Mutex::new(false),
}
}
/// Get the [`CrossSigningResetAuthType`] this cross-signing reset process
/// is using.
pub fn auth_type(&self) -> &CrossSigningResetAuthType {
&self.auth_type
}
/// Continue the cross-signing reset by either waiting for the
/// authentication to be done on the side of the OIDC issuer or by
/// providing additional [`AuthData`] the homeserver requires.
pub async fn auth(&self, auth: Option<AuthData>) -> Result<()> {
let mut upload_request = self.upload_request.clone();
upload_request.auth = auth;
while let Err(e) = self.client.send(upload_request.clone(), None).await {
if *self.is_cancelled.lock().await {
return Ok(());
}
if e.as_uiaa_response().is_none() {
return Err(e.into());
}
}
self.client.send(self.signatures_request.clone(), None).await?;
Ok(())
}
/// Cancel the ongoing identity reset process
pub async fn cancel(&self) {
*self.is_cancelled.lock().await = true;
}
}
/// information about the additional authentication that is required before the
/// cross-signing keys can be uploaded.
#[derive(Debug, Clone)]
pub enum CrossSigningResetAuthType {
/// The homeserver requires user-interactive authentication.
Uiaa(UiaaInfo),
/// OIDC is used for authentication and the user needs to open a URL to
/// approve the upload of cross-signing keys.
Oidc(OidcCrossSigningResetInfo),
}
impl CrossSigningResetAuthType {
#[allow(clippy::unused_async)]
async fn new(
#[allow(unused_variables)] client: &Client,
error: &HttpError,
) -> Result<Option<Self>> {
if let Some(auth_info) = error.as_uiaa_response() {
#[cfg(feature = "experimental-oidc")]
if client.oidc().issuer().is_some() {
OidcCrossSigningResetInfo::from_auth_info(client, auth_info)
.map(|t| Some(CrossSigningResetAuthType::Oidc(t)))
} else {
Ok(Some(CrossSigningResetAuthType::Uiaa(auth_info.clone())))
}
#[cfg(not(feature = "experimental-oidc"))]
Ok(Some(CrossSigningResetAuthType::Uiaa(auth_info.clone())))
} else {
Ok(None)
}
}
}
/// OIDC specific information about the required authentication for the upload
/// of cross-signing keys.
#[derive(Debug, Clone, Deserialize)]
pub struct OidcCrossSigningResetInfo {
/// The URL where the user can approve the reset of the cross-signing keys.
pub approval_url: Url,
}
impl OidcCrossSigningResetInfo {
#[cfg(feature = "experimental-oidc")]
fn from_auth_info(
// This is used if the OIDC feature is enabled.
#[allow(unused_variables)] client: &Client,
auth_info: &UiaaInfo,
) -> Result<Self> {
let parameters =
serde_json::from_str::<OidcCrossSigningResetUiaaParameters>(auth_info.params.get())?;
Ok(OidcCrossSigningResetInfo { approval_url: parameters.reset.url })
}
}
/// The parsed `parameters` part of a [`ruma::api::client::uiaa::UiaaInfo`]
/// response
#[cfg(feature = "experimental-oidc")]
#[derive(Debug, Deserialize)]
struct OidcCrossSigningResetUiaaParameters {
/// The URL where the user can approve the reset of the cross-signing keys.
#[serde(rename = "org.matrix.cross_signing_reset")]
reset: OidcCrossSigningResetUiaaResetParameter,
}
/// The `org.matrix.cross_signing_reset` part of the Uiaa response `parameters``
/// dictionary.
#[cfg(feature = "experimental-oidc")]
#[derive(Debug, Deserialize)]
struct OidcCrossSigningResetUiaaResetParameter {
/// The URL where the user can approve the reset of the cross-signing keys.
url: Url,
}
impl Client {
pub(crate) async fn olm_machine(&self) -> RwLockReadGuard<'_, Option<OlmMachine>> {
self.base_client().olm_machine().await
}
pub(crate) async fn mark_request_as_sent(
&self,
request_id: &TransactionId,
response: impl Into<matrix_sdk_base::crypto::IncomingResponse<'_>>,
) -> Result<(), matrix_sdk_base::Error> {
Ok(self
.olm_machine()
.await
.as_ref()
.expect(
"We should have an olm machine once we try to mark E2EE related requests as sent",
)
.mark_request_as_sent(request_id, response)
.await?)
}
/// Query the server for users device keys.
///
/// # Panics
///
/// Panics if no key query needs to be done.
#[instrument(skip(self))]
pub(crate) async fn keys_query(
&self,
request_id: &TransactionId,
device_keys: BTreeMap<OwnedUserId, Vec<OwnedDeviceId>>,
) -> Result<get_keys::v3::Response> {
let request = assign!(get_keys::v3::Request::new(), { device_keys });
let response = self.send(request, None).await?;
self.mark_request_as_sent(request_id, &response).await?;
self.encryption().update_state_after_keys_query(&response).await;
Ok(response)
}
/// Construct a [`EncryptedFile`][ruma::events::room::EncryptedFile] by
/// encrypting and uploading a provided reader.
///
/// # Arguments
///
/// * `content_type` - The content type of the file.
/// * `reader` - The reader that should be encrypted and uploaded.
///
/// # Examples
///
/// ```no_run
/// # use matrix_sdk::Client;
/// # use url::Url;
/// # use matrix_sdk::ruma::{room_id, OwnedRoomId};
/// use serde::{Deserialize, Serialize};
/// use matrix_sdk::ruma::events::{macros::EventContent, room::EncryptedFile};
///
/// #[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
/// #[ruma_event(type = "com.example.custom", kind = MessageLike)]
/// struct CustomEventContent {
/// encrypted_file: EncryptedFile,
/// }
///
/// # async {
/// # let homeserver = Url::parse("http://example.com")?;
/// # let client = Client::new(homeserver).await?;
/// # let room = client.get_room(&room_id!("!test:example.com")).unwrap();
/// let mut reader = std::io::Cursor::new(b"Hello, world!");
/// let encrypted_file = client.upload_encrypted_file(&mime::TEXT_PLAIN, &mut reader).await?;
///
/// room.send(CustomEventContent { encrypted_file }).await?;
/// # anyhow::Ok(()) };
/// ```
pub fn upload_encrypted_file<'a, R: Read + ?Sized + 'a>(
&'a self,
content_type: &'a mime::Mime,
reader: &'a mut R,
) -> UploadEncryptedFile<'a, R> {
UploadEncryptedFile::new(self, content_type, reader)
}
/// Encrypt and upload the file and thumbnails, and return the source
/// information.
pub(crate) async fn upload_encrypted_media_and_thumbnail(
&self,
content_type: &mime::Mime,
data: &[u8],
thumbnail: Option<Thumbnail>,
send_progress: SharedObservable<TransmissionProgress>,
) -> Result<(MediaSource, Option<MediaSource>, Option<Box<ThumbnailInfo>>)> {
let upload_thumbnail =
self.upload_encrypted_thumbnail(thumbnail, content_type, send_progress.clone());
let upload_attachment = async {
let mut cursor = Cursor::new(data);
self.upload_encrypted_file(content_type, &mut cursor)
.with_send_progress_observable(send_progress)
.await
};
let ((thumbnail_source, thumbnail_info), file) =
try_join(upload_thumbnail, upload_attachment).await?;
Ok((MediaSource::Encrypted(Box::new(file)), thumbnail_source, thumbnail_info))
}
/// Uploads an encrypted thumbnail to the media repository, and returns
/// its source and extra information.
async fn upload_encrypted_thumbnail(
&self,
thumbnail: Option<Thumbnail>,
content_type: &mime::Mime,
send_progress: SharedObservable<TransmissionProgress>,
) -> Result<(Option<MediaSource>, Option<Box<ThumbnailInfo>>)> {
let Some(thumbnail) = thumbnail else {
return Ok((None, None));
};
let mut cursor = Cursor::new(thumbnail.data);
let file = self
.upload_encrypted_file(content_type, &mut cursor)
.with_send_progress_observable(send_progress)
.await?;
#[rustfmt::skip]
let thumbnail_info =
assign!(thumbnail.info.map(ThumbnailInfo::from).unwrap_or_default(), {
mimetype: Some(thumbnail.content_type.as_ref().to_owned())
});
Ok((Some(MediaSource::Encrypted(Box::new(file))), Some(Box::new(thumbnail_info))))
}
/// Claim one-time keys creating new Olm sessions.
///
/// # Arguments
///
/// * `users` - The list of user/device pairs that we should claim keys for.
pub(crate) async fn claim_one_time_keys(
&self,
users: impl Iterator<Item = &UserId>,
) -> Result<()> {
let _lock = self.locks().key_claim_lock.lock().await;
if let Some((request_id, request)) = self
.olm_machine()
.await
.as_ref()
.ok_or(Error::NoOlmMachine)?
.get_missing_sessions(users)
.await?
{
let response = self.send(request, None).await?;
self.mark_request_as_sent(&request_id, &response).await?;
}
Ok(())
}
/// Upload the E2E encryption keys.
///
/// This uploads the long lived device keys as well as the required amount
/// of one-time keys.
///
/// # Panics
///
/// Panics if the client isn't logged in, or if no encryption keys need to
/// be uploaded.
#[instrument(skip(self, request))]
pub(crate) async fn keys_upload(
&self,
request_id: &TransactionId,
request: &upload_keys::v3::Request,
) -> Result<upload_keys::v3::Response> {
debug!(
device_keys = request.device_keys.is_some(),
one_time_key_count = request.one_time_keys.len(),
"Uploading public encryption keys",
);
let response = self.send(request.clone(), None).await?;
self.mark_request_as_sent(request_id, &response).await?;
Ok(response)
}
pub(crate) async fn room_send_helper(
&self,
request: &RoomMessageRequest,
) -> Result<send_message_event::v3::Response> {
let content = request.content.clone();
let txn_id = request.txn_id.clone();
let room_id = &request.room_id;
self.get_room(room_id)
.expect("Can't send a message to a room that isn't known to the store")
.send(content)
.with_transaction_id(txn_id)
.await
}
pub(crate) async fn send_to_device(
&self,
request: &ToDeviceRequest,
) -> HttpResult<ToDeviceResponse> {
let request = RumaToDeviceRequest::new_raw(
request.event_type.clone(),
request.txn_id.clone(),
request.messages.clone(),
);
self.send(request, None).await
}
pub(crate) async fn send_verification_request(
&self,
request: matrix_sdk_base::crypto::OutgoingVerificationRequest,
) -> Result<()> {
match request {
matrix_sdk_base::crypto::OutgoingVerificationRequest::ToDevice(t) => {
self.send_to_device(&t).await?;
}
matrix_sdk_base::crypto::OutgoingVerificationRequest::InRoom(r) => {
self.room_send_helper(&r).await?;
}
}
Ok(())
}
/// Get the existing DM room with the given user, if any.
pub fn get_dm_room(&self, user_id: &UserId) -> Option<Room> {
let rooms = self.joined_rooms();
// Find the room we share with the `user_id` and only with `user_id`
let room = rooms.into_iter().find(|r| {
let targets = r.direct_targets();
targets.len() == 1 && targets.contains(user_id)
});
trace!(?room, "Found room");
room
}
async fn send_outgoing_request(&self, r: OutgoingRequest) -> Result<()> {
use matrix_sdk_base::crypto::OutgoingRequests;
match r.request() {
OutgoingRequests::KeysQuery(request) => {
self.keys_query(r.request_id(), request.device_keys.clone()).await?;
}
OutgoingRequests::KeysUpload(request) => {
self.keys_upload(r.request_id(), request).await?;
}
OutgoingRequests::ToDeviceRequest(request) => {
let response = self.send_to_device(request).await?;
self.mark_request_as_sent(r.request_id(), &response).await?;
}
OutgoingRequests::SignatureUpload(request) => {
let response = self.send(request.clone(), None).await?;
self.mark_request_as_sent(r.request_id(), &response).await?;
}
OutgoingRequests::RoomMessage(request) => {
let response = self.room_send_helper(request).await?;
self.mark_request_as_sent(r.request_id(), &response).await?;
}
OutgoingRequests::KeysClaim(request) => {
let response = self.send(request.clone(), None).await?;
self.mark_request_as_sent(r.request_id(), &response).await?;
}
}
Ok(())
}
pub(crate) async fn send_outgoing_requests(&self) -> Result<()> {
const MAX_CONCURRENT_REQUESTS: usize = 20;
// This is needed because sometimes we need to automatically
// claim some one-time keys to unwedge an existing Olm session.
if let Err(e) = self.claim_one_time_keys(iter::empty()).await {
warn!("Error while claiming one-time keys {:?}", e);
}
let outgoing_requests = stream::iter(
self.olm_machine()
.await
.as_ref()
.ok_or(Error::NoOlmMachine)?
.outgoing_requests()
.await?,
)
.map(|r| self.send_outgoing_request(r));
let requests = outgoing_requests.buffer_unordered(MAX_CONCURRENT_REQUESTS);
requests
.for_each(|r| async move {
match r {
Ok(_) => (),
Err(e) => warn!(error = ?e, "Error when sending out an outgoing E2EE request"),
}
})
.await;
Ok(())
}
}
#[cfg(any(feature = "testing", test))]
impl Client {
/// Get the olm machine, for testing purposes only.
pub async fn olm_machine_for_testing(&self) -> RwLockReadGuard<'_, Option<OlmMachine>> {
self.olm_machine().await
}
}
/// A high-level API to manage the client's encryption.
///
/// To get this, use [`Client::encryption()`].
#[derive(Debug, Clone)]
pub struct Encryption {
/// The underlying client.
client: Client,
}
impl Encryption {
pub(crate) fn new(client: Client) -> Self {
Self { client }
}
/// Returns the current encryption settings for this client.
pub(crate) fn settings(&self) -> EncryptionSettings {
self.client.inner.e2ee.encryption_settings
}
/// Get the public ed25519 key of our own device. This is usually what is
/// called the fingerprint of the device.
pub async fn ed25519_key(&self) -> Option<String> {
self.client.olm_machine().await.as_ref().map(|o| o.identity_keys().ed25519.to_base64())
}
/// Get the public Curve25519 key of our own device.
pub async fn curve25519_key(&self) -> Option<Curve25519PublicKey> {
self.client.olm_machine().await.as_ref().map(|o| o.identity_keys().curve25519)
}
#[cfg(feature = "experimental-oidc")]
pub(crate) async fn import_secrets_bundle(
&self,
bundle: &matrix_sdk_base::crypto::types::SecretsBundle,
) -> Result<(), SecretImportError> {
let olm_machine = self.client.olm_machine().await;
let olm_machine =
olm_machine.as_ref().expect("This should only be called once we have an OlmMachine");
olm_machine.store().import_secrets_bundle(bundle).await
}
/// Get the status of the private cross signing keys.
///
/// This can be used to check which private cross signing keys we have
/// stored locally.
pub async fn cross_signing_status(&self) -> Option<CrossSigningStatus> {
let olm = self.client.olm_machine().await;
let machine = olm.as_ref()?;
Some(machine.cross_signing_status().await)
}
/// Get all the tracked users we know about
///
/// Tracked users are users for which we keep the device list of E2EE
/// capable devices up to date.
pub async fn tracked_users(&self) -> Result<HashSet<OwnedUserId>, CryptoStoreError> {
if let Some(machine) = self.client.olm_machine().await.as_ref() {
machine.tracked_users().await
} else {
Ok(HashSet::new())
}
}
/// Get a [`Subscriber`] for the [`VerificationState`].
///
/// # Examples
///
/// ```no_run
/// use matrix_sdk::{encryption, Client};
/// use url::Url;
///
/// # async {
/// let homeserver = Url::parse("http://example.com")?;
/// let client = Client::new(homeserver).await?;
/// let mut subscriber = client.encryption().verification_state();
///
/// let current_value = subscriber.get();
///
/// println!("The current verification state is: {current_value:?}");
///
/// if let Some(verification_state) = subscriber.next().await {
/// println!("Received verification state update {:?}", verification_state)
/// }
/// # anyhow::Ok(()) };
/// ```
pub fn verification_state(&self) -> Subscriber<VerificationState> {
self.client.inner.verification_state.subscribe()
}
/// Get a verification object with the given flow id.
pub async fn get_verification(&self, user_id: &UserId, flow_id: &str) -> Option<Verification> {
let olm = self.client.olm_machine().await;
let olm = olm.as_ref()?;
#[allow(clippy::bind_instead_of_map)]
olm.get_verification(user_id, flow_id).and_then(|v| match v {
matrix_sdk_base::crypto::Verification::SasV1(s) => {
Some(SasVerification { inner: s, client: self.client.clone() }.into())
}
#[cfg(feature = "qrcode")]
matrix_sdk_base::crypto::Verification::QrV1(qr) => {
Some(verification::QrVerification { inner: qr, client: self.client.clone() }.into())
}
_ => None,
})
}
/// Get a `VerificationRequest` object for the given user with the given
/// flow id.
pub async fn get_verification_request(
&self,
user_id: &UserId,
flow_id: impl AsRef<str>,
) -> Option<VerificationRequest> {
let olm = self.client.olm_machine().await;
let olm = olm.as_ref()?;
olm.get_verification_request(user_id, flow_id)
.map(|r| VerificationRequest { inner: r, client: self.client.clone() })
}
/// Get a specific device of a user.
///
/// # Arguments
///
/// * `user_id` - The unique id of the user that the device belongs to.
///
/// * `device_id` - The unique id of the device.
///
/// Returns a `Device` if one is found and the crypto store didn't throw an
/// error.
///
/// This will always return None if the client hasn't been logged in.
///
/// # Examples
///
/// ```no_run
/// # use matrix_sdk::{Client, ruma::{device_id, user_id}};
/// # use url::Url;
/// # async {
/// # let alice = user_id!("@alice:example.org");
/// # let homeserver = Url::parse("http://example.com")?;
/// # let client = Client::new(homeserver).await?;
/// if let Some(device) =
/// client.encryption().get_device(alice, device_id!("DEVICEID")).await?
/// {
/// println!("{:?}", device.is_verified());
///
/// if !device.is_verified() {
/// let verification = device.request_verification().await?;
/// }
/// }
/// # anyhow::Ok(()) };
/// ```
pub async fn get_device(
&self,
user_id: &UserId,
device_id: &DeviceId,
) -> Result<Option<Device>, CryptoStoreError> {
let olm = self.client.olm_machine().await;
let Some(machine) = olm.as_ref() else { return Ok(None) };
let device = machine.get_device(user_id, device_id, None).await?;
Ok(device.map(|d| Device { inner: d, client: self.client.clone() }))
}
/// A convenience method to retrieve your own device from the store.
///
/// This is the same as calling [`Encryption::get_device()`] with your own
/// user and device ID.
///
/// This will always return a device, unless you are not logged in.
pub async fn get_own_device(&self) -> Result<Option<Device>, CryptoStoreError> {
let olm = self.client.olm_machine().await;
let Some(machine) = olm.as_ref() else { return Ok(None) };
let device = machine.get_device(machine.user_id(), machine.device_id(), None).await?;
Ok(device.map(|d| Device { inner: d, client: self.client.clone() }))
}
/// Get a map holding all the devices of an user.
///
/// This will always return an empty map if the client hasn't been logged
/// in.
///
/// # Arguments
///
/// * `user_id` - The unique id of the user that the devices belong to.
///
/// # Examples
///
/// ```no_run
/// # use matrix_sdk::{Client, ruma::user_id};
/// # use url::Url;
/// # async {
/// # let alice = user_id!("@alice:example.org");
/// # let homeserver = Url::parse("http://example.com")?;
/// # let client = Client::new(homeserver).await?;
/// let devices = client.encryption().get_user_devices(alice).await?;
///
/// for device in devices.devices() {
/// println!("{device:?}");
/// }
/// # anyhow::Ok(()) };
/// ```
pub async fn get_user_devices(&self, user_id: &UserId) -> Result<UserDevices, Error> {
let devices = self
.client
.olm_machine()
.await
.as_ref()
.ok_or(Error::NoOlmMachine)?
.get_user_devices(user_id, None)
.await?;
Ok(UserDevices { inner: devices, client: self.client.clone() })
}
/// Get the E2EE identity of a user from the crypto store.
///
/// Usually, we only have the E2EE identity of a user locally if the user
/// is tracked, meaning that we are both members of the same encrypted room.
///
/// To get the E2EE identity of a user even if it is not available locally
/// use [`Encryption::request_user_identity()`].
///
/// # Arguments
///
/// * `user_id` - The unique id of the user that the identity belongs to.
///
/// Returns a `UserIdentity` if one is found and the crypto store
/// didn't throw an error.
///
/// This will always return None if the client hasn't been logged in.
///
/// # Examples
///
/// ```no_run
/// # use matrix_sdk::{Client, ruma::user_id};
/// # use url::Url;
/// # async {
/// # let alice = user_id!("@alice:example.org");
/// # let homeserver = Url::parse("http://example.com")?;
/// # let client = Client::new(homeserver).await?;
/// let user = client.encryption().get_user_identity(alice).await?;
///
/// if let Some(user) = user {
/// println!("{:?}", user.is_verified());
///
/// let verification = user.request_verification().await?;
/// }
/// # anyhow::Ok(()) };
/// ```
pub async fn get_user_identity(
&self,
user_id: &UserId,
) -> Result<Option<UserIdentity>, CryptoStoreError> {
let olm = self.client.olm_machine().await;
let Some(olm) = olm.as_ref() else { return Ok(None) };
let identity = olm.get_identity(user_id, None).await?;
Ok(identity.map(|i| UserIdentity::new(self.client.clone(), i)))
}
/// Get the E2EE identity of a user from the homeserver.
///
/// The E2EE identity returned is always guaranteed to be up-to-date. If the
/// E2EE identity is not found, it should mean that the user did not set
/// up cross-signing.
///
/// If you want the E2EE identity of a user without making a request to the
/// homeserver, use [`Encryption::get_user_identity()`] instead.
///
/// # Arguments
///
/// * `user_id` - The ID of the user that the identity belongs to.
///
/// Returns a [`UserIdentity`] if one is found. Returns an error if there
/// was an issue with the crypto store or with the request to the
/// homeserver.
///
/// This will always return `None` if the client hasn't been logged in.
///
/// # Examples
///
/// ```no_run
/// # use matrix_sdk::{Client, ruma::user_id};
/// # use url::Url;
/// # async {
/// # let alice = user_id!("@alice:example.org");
/// # let homeserver = Url::parse("http://example.com")?;
/// # let client = Client::new(homeserver).await?;
/// let user = client.encryption().request_user_identity(alice).await?;
///
/// if let Some(user) = user {
/// println!("User is verified: {:?}", user.is_verified());
///
/// let verification = user.request_verification().await?;
/// }
/// # anyhow::Ok(()) };
/// ```
pub async fn request_user_identity(&self, user_id: &UserId) -> Result<Option<UserIdentity>> {
let olm = self.client.olm_machine().await;
let Some(olm) = olm.as_ref() else { return Ok(None) };
let (request_id, request) = olm.query_keys_for_users(iter::once(user_id));
self.client.keys_query(&request_id, request.device_keys).await?;
let identity = olm.get_identity(user_id, None).await?;
Ok(identity.map(|i| UserIdentity::new(self.client.clone(), i)))
}
/// Returns a stream of device updates, allowing users to listen for
/// notifications about new or changed devices.
///
/// The stream produced by this method emits updates whenever a new device
/// is discovered or when an existing device's information is changed. Users
/// can subscribe to this stream and receive updates in real-time.
///
/// # Examples
///
/// ```no_run
/// # use matrix_sdk::Client;
/// # use ruma::{device_id, user_id};
/// # use futures_util::{pin_mut, StreamExt};
/// # let client: Client = unimplemented!();
/// # async {
/// let devices_stream = client.encryption().devices_stream().await?;
/// let user_id = client
/// .user_id()
/// .expect("We should know our user id after we have logged in");
/// pin_mut!(devices_stream);
///
/// for device_updates in devices_stream.next().await {
/// if let Some(user_devices) = device_updates.new.get(user_id) {
/// for device in user_devices.values() {
/// println!("A new device has been added {}", device.device_id());
/// }
/// }
/// }
/// # anyhow::Ok(()) };
/// ```
pub async fn devices_stream(&self) -> Result<impl Stream<Item = DeviceUpdates>> {
let olm = self.client.olm_machine().await;
let olm = olm.as_ref().ok_or(Error::NoOlmMachine)?;
let client = self.client.to_owned();
Ok(olm
.store()
.devices_stream()
.map(move |updates| DeviceUpdates::new(client.to_owned(), updates)))
}
/// Returns a stream of user identity updates, allowing users to listen for
/// notifications about new or changed user identities.
///
/// The stream produced by this method emits updates whenever a new user
/// identity is discovered or when an existing identities information is
/// changed. Users can subscribe to this stream and receive updates in
/// real-time.
///
/// # Examples
///
/// ```no_run
/// # use matrix_sdk::Client;
/// # use ruma::{device_id, user_id};
/// # use futures_util::{pin_mut, StreamExt};
/// # let client: Client = unimplemented!();
/// # async {
/// let identities_stream =
/// client.encryption().user_identities_stream().await?;
/// pin_mut!(identities_stream);
///
/// for identity_updates in identities_stream.next().await {
/// for (_, identity) in identity_updates.new {
/// println!("A new identity has been added {}", identity.user_id());
/// }
/// }
/// # anyhow::Ok(()) };
/// ```
pub async fn user_identities_stream(&self) -> Result<impl Stream<Item = IdentityUpdates>> {
let olm = self.client.olm_machine().await;
let olm = olm.as_ref().ok_or(Error::NoOlmMachine)?;
let client = self.client.to_owned();
Ok(olm
.store()
.user_identities_stream()
.map(move |updates| IdentityUpdates::new(client.to_owned(), updates)))
}
/// Create and upload a new cross signing identity.
///
/// # Arguments
///
/// * `auth_data` - This request requires user interactive auth, the first
/// request needs to set this to `None` and will always fail with an
/// `UiaaResponse`. The response will contain information for the
/// interactive auth and the same request needs to be made but this time
/// with some `auth_data` provided.
///
/// # Examples
///
/// ```no_run
/// # use std::collections::BTreeMap;
/// # use matrix_sdk::{ruma::api::client::uiaa, Client};
/// # use url::Url;
/// # use serde_json::json;
/// # async {
/// # let homeserver = Url::parse("http://example.com")?;
/// # let client = Client::new(homeserver).await?;
/// if let Err(e) = client.encryption().bootstrap_cross_signing(None).await {
/// if let Some(response) = e.as_uiaa_response() {
/// let mut password = uiaa::Password::new(
/// uiaa::UserIdentifier::UserIdOrLocalpart("example".to_owned()),
/// "wordpass".to_owned(),
/// );
/// password.session = response.session.clone();
///
/// client
/// .encryption()
/// .bootstrap_cross_signing(Some(uiaa::AuthData::Password(password)))
/// .await
/// .expect("Couldn't bootstrap cross signing")
/// } else {
/// panic!("Error during cross signing bootstrap {:#?}", e);
/// }
/// }
/// # anyhow::Ok(()) };
pub async fn bootstrap_cross_signing(&self, auth_data: Option<AuthData>) -> Result<()> {
let olm = self.client.olm_machine().await;
let olm = olm.as_ref().ok_or(Error::NoOlmMachine)?;
let CrossSigningBootstrapRequests {
upload_signing_keys_req,
upload_keys_req,
upload_signatures_req,
} = olm.bootstrap_cross_signing(false).await?;
let upload_signing_keys_req = assign!(UploadSigningKeysRequest::new(), {
auth: auth_data,
master_key: upload_signing_keys_req.master_key.map(|c| c.to_raw()),
self_signing_key: upload_signing_keys_req.self_signing_key.map(|c| c.to_raw()),
user_signing_key: upload_signing_keys_req.user_signing_key.map(|c| c.to_raw()),
});
if let Some(req) = upload_keys_req {
self.client.send_outgoing_request(req).await?;
}
self.client.send(upload_signing_keys_req, None).await?;
self.client.send(upload_signatures_req, None).await?;
Ok(())
}
/// Reset the cross-signing keys.
///
/// # Example
///
/// ```no_run
/// # use matrix_sdk::{ruma::api::client::uiaa, Client, encryption::CrossSigningResetAuthType};
/// # use url::Url;
/// # async {
/// # let homeserver = Url::parse("http://example.com")?;
/// # let client = Client::new(homeserver).await?;
/// # let user_id = unimplemented!();
/// let encryption = client.encryption();
///
/// if let Some(handle) = encryption.reset_cross_signing().await? {
/// match handle.auth_type() {
/// CrossSigningResetAuthType::Uiaa(uiaa) => {
/// use matrix_sdk::ruma::api::client::uiaa;
///
/// let password = "1234".to_owned();
/// let mut password = uiaa::Password::new(user_id, password);
/// password.session = uiaa.session;
///
/// handle.auth(Some(uiaa::AuthData::Password(password))).await?;
/// }
/// CrossSigningResetAuthType::Oidc(o) => {
/// println!(
/// "To reset your end-to-end encryption cross-signing identity, \
/// you first need to approve it at {}",
/// o.approval_url
/// );
/// handle.auth(None).await?;
/// }
/// }
/// }
/// # anyhow::Ok(()) };
/// ```
pub async fn reset_cross_signing(&self) -> Result<Option<CrossSigningResetHandle>> {
let olm = self.client.olm_machine().await;
let olm = olm.as_ref().ok_or(Error::NoOlmMachine)?;
let CrossSigningBootstrapRequests {
upload_keys_req,
upload_signing_keys_req,
upload_signatures_req,
} = olm.bootstrap_cross_signing(true).await?;
let upload_signing_keys_req = assign!(UploadSigningKeysRequest::new(), {
auth: None,
master_key: upload_signing_keys_req.master_key.map(|c| c.to_raw()),
self_signing_key: upload_signing_keys_req.self_signing_key.map(|c| c.to_raw()),
user_signing_key: upload_signing_keys_req.user_signing_key.map(|c| c.to_raw()),
});
if let Some(req) = upload_keys_req {
self.client.send_outgoing_request(req).await?;
}
if let Err(error) = self.client.send(upload_signing_keys_req.clone(), None).await {
if let Some(auth_type) = CrossSigningResetAuthType::new(&self.client, &error).await? {
let client = self.client.clone();
Ok(Some(CrossSigningResetHandle::new(
client,
upload_signing_keys_req,
upload_signatures_req,
auth_type,
)))
} else {
Err(error.into())
}
} else {
self.client.send(upload_signatures_req, None).await?;
Ok(None)
}
}
/// Query the user's own device keys, if, and only if, we didn't have their
/// identity in the first place.
async fn ensure_initial_key_query(&self) -> Result<()> {
let olm_machine = self.client.olm_machine().await;
let olm_machine = olm_machine.as_ref().ok_or(Error::NoOlmMachine)?;
let user_id = olm_machine.user_id();
if self.client.encryption().get_user_identity(user_id).await?.is_none() {
let (request_id, request) = olm_machine.query_keys_for_users([olm_machine.user_id()]);
self.client.keys_query(&request_id, request.device_keys).await?;
}
Ok(())
}
/// Create and upload a new cross signing identity, if that has not been
/// done yet.
///
/// This will only create a new cross-signing identity if the user had never
/// done it before. If the user did it before, then this is a no-op.
///
/// See also the documentation of [`Self::bootstrap_cross_signing`] for the
/// behavior of this function.
///
/// # Arguments
///
/// * `auth_data` - This request requires user interactive auth, the first
/// request needs to set this to `None` and will always fail with an
/// `UiaaResponse`. The response will contain information for the
/// interactive auth and the same request needs to be made but this time
/// with some `auth_data` provided.
///
/// # Examples
/// ```no_run
/// # use std::collections::BTreeMap;
/// # use matrix_sdk::{ruma::api::client::uiaa, Client};
/// # use url::Url;
/// # use serde_json::json;
/// # async {
/// # let homeserver = Url::parse("http://example.com")?;
/// # let client = Client::new(homeserver).await?;
/// if let Err(e) = client.encryption().bootstrap_cross_signing_if_needed(None).await {
/// if let Some(response) = e.as_uiaa_response() {
/// let mut password = uiaa::Password::new(
/// uiaa::UserIdentifier::UserIdOrLocalpart("example".to_owned()),
/// "wordpass".to_owned(),
/// );
/// password.session = response.session.clone();
///
/// // Note, on the failed attempt we can use `bootstrap_cross_signing` immediately, to
/// // avoid checks.
/// client
/// .encryption()
/// .bootstrap_cross_signing(Some(uiaa::AuthData::Password(password)))
/// .await
/// .expect("Couldn't bootstrap cross signing")
/// } else {
/// panic!("Error during cross signing bootstrap {:#?}", e);
/// }
/// }
/// # anyhow::Ok(()) };
pub async fn bootstrap_cross_signing_if_needed(
&self,
auth_data: Option<AuthData>,
) -> Result<()> {
let olm_machine = self.client.olm_machine().await;
let olm_machine = olm_machine.as_ref().ok_or(Error::NoOlmMachine)?;
let user_id = olm_machine.user_id();
self.ensure_initial_key_query().await?;
if self.client.encryption().get_user_identity(user_id).await?.is_none() {
self.bootstrap_cross_signing(auth_data).await?;
}
Ok(())
}
/// Export E2EE keys that match the given predicate encrypting them with the
/// given passphrase.
///
/// # Arguments
///
/// * `path` - The file path where the exported key file will be saved.
///
/// * `passphrase` - The passphrase that will be used to encrypt the
/// exported room keys.
///
/// * `predicate` - A closure that will be called for every known
/// `InboundGroupSession`, which represents a room key. If the closure
/// returns `true` the `InboundGroupSessoin` will be included in the
/// export, if the closure returns `false` it will not be included.
///
/// # Panics
///
/// This method will panic if it isn't run on a Tokio runtime.
///
/// This method will panic if it can't get enough randomness from the OS to
/// encrypt the exported keys securely.
///
/// # Examples
///
/// ```no_run
/// # use std::{path::PathBuf, time::Duration};
/// # use matrix_sdk::{
/// # Client, config::SyncSettings,
/// # ruma::room_id,
/// # };
/// # use url::Url;
/// # async {
/// # let homeserver = Url::parse("http://localhost:8080")?;
/// # let mut client = Client::new(homeserver).await?;
/// let path = PathBuf::from("/home/example/e2e-keys.txt");
/// // Export all room keys.
/// client
/// .encryption()
/// .export_room_keys(path, "secret-passphrase", |_| true)
/// .await?;
///
/// // Export only the room keys for a certain room.
/// let path = PathBuf::from("/home/example/e2e-room-keys.txt");
/// let room_id = room_id!("!test:localhost");
///
/// client
/// .encryption()
/// .export_room_keys(path, "secret-passphrase", |s| s.room_id() == room_id)
/// .await?;
/// # anyhow::Ok(()) };
/// ```
#[cfg(not(target_arch = "wasm32"))]
pub async fn export_room_keys(
&self,
path: PathBuf,
passphrase: &str,
predicate: impl FnMut(&matrix_sdk_base::crypto::olm::InboundGroupSession) -> bool,
) -> Result<()> {
let olm = self.client.olm_machine().await;
let olm = olm.as_ref().ok_or(Error::NoOlmMachine)?;
let keys = olm.store().export_room_keys(predicate).await?;
let passphrase = zeroize::Zeroizing::new(passphrase.to_owned());
let encrypt = move || -> Result<()> {
let export: String =
matrix_sdk_base::crypto::encrypt_room_key_export(&keys, &passphrase, 500_000)?;
let mut file = std::fs::File::create(path)?;
file.write_all(&export.into_bytes())?;
Ok(())
};
let task = tokio::task::spawn_blocking(encrypt);
task.await.expect("Task join error")
}
/// Import E2EE keys from the given file path.
///
/// # Arguments
///
/// * `path` - The file path where the exported key file will can be found.
///
/// * `passphrase` - The passphrase that should be used to decrypt the
/// exported room keys.
///
/// Returns a tuple of numbers that represent the number of sessions that
/// were imported and the total number of sessions that were found in the
/// key export.
///
/// # Panics
///
/// This method will panic if it isn't run on a Tokio runtime.
///
/// ```no_run
/// # use std::{path::PathBuf, time::Duration};
/// # use matrix_sdk::{
/// # Client, config::SyncSettings,
/// # ruma::room_id,
/// # };
/// # use url::Url;
/// # async {
/// # let homeserver = Url::parse("http://localhost:8080")?;
/// # let mut client = Client::new(homeserver).await?;
/// let path = PathBuf::from("/home/example/e2e-keys.txt");
/// let result =
/// client.encryption().import_room_keys(path, "secret-passphrase").await?;
///
/// println!(
/// "Imported {} room keys out of {}",
/// result.imported_count, result.total_count
/// );
/// # anyhow::Ok(()) };
/// ```
#[cfg(not(target_arch = "wasm32"))]
pub async fn import_room_keys(
&self,
path: PathBuf,
passphrase: &str,
) -> Result<RoomKeyImportResult, RoomKeyImportError> {
let olm = self.client.olm_machine().await;
let olm = olm.as_ref().ok_or(RoomKeyImportError::StoreClosed)?;
let passphrase = zeroize::Zeroizing::new(passphrase.to_owned());
let decrypt = move || {
let file = std::fs::File::open(path)?;
matrix_sdk_base::crypto::decrypt_room_key_export(file, &passphrase)
};
let task = tokio::task::spawn_blocking(decrypt);
let import = task.await.expect("Task join error")?;
let ret = olm.store().import_exported_room_keys(import, |_, _| {}).await?;
self.backups().maybe_trigger_backup();
Ok(ret)
}
/// Get the secret storage manager of the client.
pub fn secret_storage(&self) -> SecretStorage {
SecretStorage { client: self.client.to_owned() }
}
/// Get the backups manager of the client.
pub fn backups(&self) -> Backups {
Backups { client: self.client.to_owned() }
}
/// Get the recovery manager of the client.
pub fn recovery(&self) -> Recovery {
Recovery { client: self.client.to_owned() }
}
/// Enables the crypto-store cross-process lock.
///
/// This may be required if there are multiple processes that may do writes
/// to the same crypto store. In that case, it's necessary to create a
/// lock, so that only one process writes to it, otherwise this may
/// cause confusing issues because of stale data contained in in-memory
/// caches.
///
/// The provided `lock_value` must be a unique identifier for this process.
pub async fn enable_cross_process_store_lock(&self, lock_value: String) -> Result<(), Error> {
// If the lock has already been created, don't recreate it from scratch.
if let Some(prev_lock) = self.client.locks().cross_process_crypto_store_lock.get() {
let prev_holder = prev_lock.lock_holder();
if prev_holder == lock_value {
return Ok(());
}
warn!("Recreating cross-process store lock with a different holder value: prev was {prev_holder}, new is {lock_value}");
}
let olm_machine = self.client.base_client().olm_machine().await;
let olm_machine = olm_machine.as_ref().ok_or(Error::NoOlmMachine)?;
let lock =
olm_machine.store().create_store_lock("cross_process_lock".to_owned(), lock_value);
// Gently try to initialize the crypto store generation counter.
//
// If we don't get the lock immediately, then it is already acquired by another
// process, and we'll get to reload next time we acquire the lock.
{
let guard = lock.try_lock_once().await?;
if guard.is_some() {
olm_machine
.initialize_crypto_store_generation(
&self.client.locks().crypto_store_generation,
)
.await?;
}
}
self.client
.locks()
.cross_process_crypto_store_lock
.set(lock)
.map_err(|_| Error::BadCryptoStoreState)?;
Ok(())
}
/// Maybe reload the `OlmMachine` after acquiring the lock for the first
/// time.
///
/// Returns the current generation number.
async fn on_lock_newly_acquired(&self) -> Result<u64, Error> {
let olm_machine_guard = self.client.olm_machine().await;
if let Some(olm_machine) = olm_machine_guard.as_ref() {
let (new_gen, generation_number) = olm_machine
.maintain_crypto_store_generation(&self.client.locks().crypto_store_generation)
.await?;
// If the crypto store generation has changed,
if new_gen {
// (get rid of the reference to the current crypto store first)
drop(olm_machine_guard);
// Recreate the OlmMachine.
self.client.base_client().regenerate_olm(None).await?;
}
Ok(generation_number)
} else {
// XXX: not sure this is reachable. Seems like the OlmMachine should always have
// been initialised by the time we get here. Ideally we'd panic, or return an
// error, but for now I'm just adding some logging to check if it
// happens, and returning the magic number 0.
warn!("Encryption::on_lock_newly_acquired: called before OlmMachine initialised");
Ok(0)
}
}
/// If a lock was created with [`Self::enable_cross_process_store_lock`],
/// spin-waits until the lock is available.
///
/// May reload the `OlmMachine`, after obtaining the lock but not on the
/// first time.
pub async fn spin_lock_store(
&self,
max_backoff: Option<u32>,
) -> Result<Option<CrossProcessLockStoreGuardWithGeneration>, Error> {
if let Some(lock) = self.client.locks().cross_process_crypto_store_lock.get() {
let guard = lock.spin_lock(max_backoff).await?;
let generation = self.on_lock_newly_acquired().await?;
Ok(Some(CrossProcessLockStoreGuardWithGeneration { _guard: guard, generation }))
} else {
Ok(None)
}
}
/// If a lock was created with [`Self::enable_cross_process_store_lock`],
/// attempts to lock it once.
///
/// Returns a guard to the lock, if it was obtained.
pub async fn try_lock_store_once(
&self,
) -> Result<Option<CrossProcessLockStoreGuardWithGeneration>, Error> {
if let Some(lock) = self.client.locks().cross_process_crypto_store_lock.get() {
let maybe_guard = lock.try_lock_once().await?;
let Some(guard) = maybe_guard else {
return Ok(None);
};
let generation = self.on_lock_newly_acquired().await?;
Ok(Some(CrossProcessLockStoreGuardWithGeneration { _guard: guard, generation }))
} else {
Ok(None)
}
}
/// Testing purposes only.
#[cfg(any(test, feature = "testing"))]
pub async fn uploaded_key_count(&self) -> Result<u64> {
let olm_machine = self.client.olm_machine().await;
let olm_machine = olm_machine.as_ref().ok_or(Error::AuthenticationRequired)?;
Ok(olm_machine.uploaded_key_count().await?)
}
/// Bootstrap encryption and enables event listeners for the E2EE support.
///
/// Based on the `EncryptionSettings`, this call might:
/// - Bootstrap cross-signing if needed (POST `/device_signing/upload`)
/// - Create a key backup if needed (POST `/room_keys/version`)
/// - Create a secret storage if needed (PUT `/account_data/{type}`)
///
/// As part of this process, and if needed, the current device keys would be
/// uploaded to the server, new account data would be added, and cross
/// signing keys and signatures might be uploaded.
///
/// Should be called once we
/// created a [`OlmMachine`], i.e. after logging in.
///
/// # Arguments
///
/// * `auth_data` - Some requests may require re-authentication. To prevent
/// the user from having to re-enter their password (or use other
/// methods), we can provide the authentication data here. This is
/// necessary for uploading cross-signing keys. However, please note that
/// there is a proposal (MSC3967) to remove this requirement, which would
/// allow for the initial upload of cross-signing keys without
/// authentication, rendering this parameter obsolete.
pub(crate) fn spawn_initialization_task(&self, auth_data: Option<AuthData>) {
let mut tasks = self.client.inner.e2ee.tasks.lock().unwrap();
let this = self.clone();
tasks.setup_e2ee = Some(spawn(async move {
if this.settings().auto_enable_cross_signing {
if let Err(e) = this.bootstrap_cross_signing_if_needed(auth_data).await {
error!("Couldn't bootstrap cross signing {e:?}");
}
}
if let Err(e) = this.backups().setup_and_resume().await {
error!("Couldn't setup and resume backups {e:?}");
}
if let Err(e) = this.recovery().setup().await {
error!("Couldn't setup and resume recovery {e:?}");
}
this.update_verification_state().await;
}));
}
/// Waits for end-to-end encryption initialization tasks to finish, if any
/// was running in the background.
pub async fn wait_for_e2ee_initialization_tasks(&self) {
let task = self.client.inner.e2ee.tasks.lock().unwrap().setup_e2ee.take();
if let Some(task) = task {
if let Err(err) = task.await {
warn!("Error when initializing backups: {err}");
}
}
}
/// Upload the device keys and initial set of one-tim keys to the server.
///
/// This should only be called when the user logs in for the first time,
/// the method will ensure that other devices see our own device as an
/// end-to-end encryption enabled one.
///
/// **Warning**: Do not use this method if we're already calling
/// [`Client::send_outgoing_request()`]. This method is intended for
/// explicitly uploading the device keys before starting a sync.
#[cfg(feature = "experimental-oidc")]
pub(crate) async fn ensure_device_keys_upload(&self) -> Result<()> {
let olm = self.client.olm_machine().await;
let olm = olm.as_ref().ok_or(Error::NoOlmMachine)?;
if let Some((request_id, request)) = olm.upload_device_keys().await? {
self.client.keys_upload(&request_id, &request).await?;
let (request_id, request) = olm.query_keys_for_users([olm.user_id()]);
self.client.keys_query(&request_id, request.device_keys).await?;
}
Ok(())
}
pub(crate) async fn update_state_after_keys_query(&self, response: &get_keys::v3::Response) {
self.recovery().update_state_after_keys_query(response).await;
// Only update the verification_state if our own devices changed
if let Some(user_id) = self.client.user_id() {
let contains_own_device = response.device_keys.contains_key(user_id);
if contains_own_device {
self.update_verification_state().await;
}
}
}
async fn update_verification_state(&self) {
match self.get_own_device().await {
Ok(device) => {
if let Some(device) = device {
let is_verified = device.is_cross_signed_by_owner();
if is_verified {
self.client.inner.verification_state.set(VerificationState::Verified);
} else {
self.client.inner.verification_state.set(VerificationState::Unverified);
}
} else {
warn!("Couldn't find out own device in the store.");
self.client.inner.verification_state.set(VerificationState::Unknown);
}
}
Err(error) => {
warn!("Failed retrieving own device: {error}");
self.client.inner.verification_state.set(VerificationState::Unknown);
}
}
}
}
#[cfg(all(test, not(target_arch = "wasm32")))]
mod tests {
use std::time::Duration;
use matrix_sdk_base::SessionMeta;
use matrix_sdk_test::{
async_test, test_json, GlobalAccountDataTestEvent, JoinedRoomBuilder, StateTestEvent,
SyncResponseBuilder, DEFAULT_TEST_ROOM_ID,
};
use ruma::{
device_id, event_id,
events::{reaction::ReactionEventContent, relation::Annotation},
user_id,
};
use serde_json::json;
use wiremock::{
matchers::{header, method, path_regex},
Mock, MockServer, ResponseTemplate,
};
use crate::{
config::RequestConfig,
matrix_auth::{MatrixSession, MatrixSessionTokens},
test_utils::logged_in_client,
Client,
};
#[async_test]
async fn test_reaction_sending() {
let server = MockServer::start().await;
let client = logged_in_client(Some(server.uri())).await;
let event_id = event_id!("$2:example.org");
Mock::given(method("GET"))
.and(path_regex(r"^/_matrix/client/r0/rooms/.*/state/m.*room.*encryption.?"))
.and(header("authorization", "Bearer 1234"))
.respond_with(
ResponseTemplate::new(200)
.set_body_json(&*test_json::sync_events::ENCRYPTION_CONTENT),
)
.mount(&server)
.await;
Mock::given(method("PUT"))
.and(path_regex(r"^/_matrix/client/r0/rooms/.*/send/m\.reaction/.*".to_owned()))
.respond_with(ResponseTemplate::new(200).set_body_json(json!({
"event_id": event_id,
})))
.mount(&server)
.await;
let response = SyncResponseBuilder::default()
.add_joined_room(
JoinedRoomBuilder::default()
.add_state_event(StateTestEvent::Member)
.add_state_event(StateTestEvent::PowerLevels)
.add_state_event(StateTestEvent::Encryption),
)
.build_sync_response();
client.base_client().receive_sync_response(response).await.unwrap();
let room = client.get_room(&DEFAULT_TEST_ROOM_ID).expect("Room should exist");
assert!(room.is_encrypted().await.expect("Getting encryption state"));
let event_id = event_id!("$1:example.org");
let reaction = ReactionEventContent::new(Annotation::new(event_id.into(), "🐈".to_owned()));
room.send(reaction).await.expect("Sending the reaction should not fail");
room.send_raw("m.reaction", json!({})).await.expect("Sending the reaction should not fail");
}
#[async_test]
async fn test_get_dm_room_returns_the_room_we_have_with_this_user() {
let server = MockServer::start().await;
let client = logged_in_client(Some(server.uri())).await;
// This is the user ID that is inside MemberAdditional.
// Note the confusing username, so we can share
// GlobalAccountDataTestEvent::Direct with the invited test.
let user_id = user_id!("@invited:localhost");
// When we receive a sync response saying "invited" is invited to a DM
let response = SyncResponseBuilder::default()
.add_joined_room(
JoinedRoomBuilder::default().add_state_event(StateTestEvent::MemberAdditional),
)
.add_global_account_data_event(GlobalAccountDataTestEvent::Direct)
.build_sync_response();
client.base_client().receive_sync_response(response).await.unwrap();
// Then get_dm_room finds this room
let found_room = client.get_dm_room(user_id).expect("DM not found!");
assert!(found_room.get_member_no_sync(user_id).await.unwrap().is_some());
}
#[async_test]
async fn test_get_dm_room_still_finds_room_where_participant_is_only_invited() {
let server = MockServer::start().await;
let client = logged_in_client(Some(server.uri())).await;
// This is the user ID that is inside MemberInvite
let user_id = user_id!("@invited:localhost");
// When we receive a sync response saying "invited" is invited to a DM
let response = SyncResponseBuilder::default()
.add_joined_room(
JoinedRoomBuilder::default().add_state_event(StateTestEvent::MemberInvite),
)
.add_global_account_data_event(GlobalAccountDataTestEvent::Direct)
.build_sync_response();
client.base_client().receive_sync_response(response).await.unwrap();
// Then get_dm_room finds this room
let found_room = client.get_dm_room(user_id).expect("DM not found!");
assert!(found_room.get_member_no_sync(user_id).await.unwrap().is_some());
}
#[async_test]
async fn test_get_dm_room_still_finds_left_room() {
// See the discussion in https://github.com/matrix-org/matrix-rust-sdk/issues/2017
// and the high-level issue at https://github.com/vector-im/element-x-ios/issues/1077
let server = MockServer::start().await;
let client = logged_in_client(Some(server.uri())).await;
// This is the user ID that is inside MemberAdditional.
// Note the confusing username, so we can share
// GlobalAccountDataTestEvent::Direct with the invited test.
let user_id = user_id!("@invited:localhost");
// When we receive a sync response saying "invited" is invited to a DM
let response = SyncResponseBuilder::default()
.add_joined_room(
JoinedRoomBuilder::default().add_state_event(StateTestEvent::MemberLeave),
)
.add_global_account_data_event(GlobalAccountDataTestEvent::Direct)
.build_sync_response();
client.base_client().receive_sync_response(response).await.unwrap();
// Then get_dm_room finds this room
let found_room = client.get_dm_room(user_id).expect("DM not found!");
assert!(found_room.get_member_no_sync(user_id).await.unwrap().is_some());
}
#[cfg(feature = "sqlite")]
#[async_test]
async fn test_generation_counter_invalidates_olm_machine() {
// Create two clients using the same sqlite database.
let sqlite_path = std::env::temp_dir().join("generation_counter_sqlite.db");
let session = MatrixSession {
meta: SessionMeta {
user_id: user_id!("@example:localhost").to_owned(),
device_id: device_id!("DEVICEID").to_owned(),
},
tokens: MatrixSessionTokens { access_token: "1234".to_owned(), refresh_token: None },
};
let client1 = Client::builder()
.homeserver_url("http://localhost:1234")
.request_config(RequestConfig::new().disable_retry())
.sqlite_store(&sqlite_path, None)
.build()
.await
.unwrap();
client1.matrix_auth().restore_session(session.clone()).await.unwrap();
let client2 = Client::builder()
.homeserver_url("http://localhost:1234")
.request_config(RequestConfig::new().disable_retry())
.sqlite_store(sqlite_path, None)
.build()
.await
.unwrap();
client2.matrix_auth().restore_session(session).await.unwrap();
// When the lock isn't enabled, any attempt at locking won't return a guard.
let guard = client1.encryption().try_lock_store_once().await.unwrap();
assert!(guard.is_none());
client1.encryption().enable_cross_process_store_lock("client1".to_owned()).await.unwrap();
client2.encryption().enable_cross_process_store_lock("client2".to_owned()).await.unwrap();
// One client can take the lock.
let acquired1 = client1.encryption().try_lock_store_once().await.unwrap();
assert!(acquired1.is_some());
// Keep the olm machine, so we can see if it's changed later, by comparing Arcs.
let initial_olm_machine =
client1.olm_machine().await.clone().expect("must have an olm machine");
// Also enable backup to check that new machine has the same backup keys.
let decryption_key = matrix_sdk_base::crypto::store::BackupDecryptionKey::new()
.expect("Can't create new recovery key");
let backup_key = decryption_key.megolm_v1_public_key();
backup_key.set_version("1".to_owned());
initial_olm_machine
.backup_machine()
.save_decryption_key(Some(decryption_key.to_owned()), Some("1".to_owned()))
.await
.expect("Should save");
initial_olm_machine.backup_machine().enable_backup_v1(backup_key.clone()).await.unwrap();
assert!(client1.encryption().backups().are_enabled().await);
// The other client can't take the lock too.
let acquired2 = client2.encryption().try_lock_store_once().await.unwrap();
assert!(acquired2.is_none());
// Now have the first client release the lock,
drop(acquired1);
tokio::time::sleep(Duration::from_millis(100)).await;
// And re-take it.
let acquired1 = client1.encryption().try_lock_store_once().await.unwrap();
assert!(acquired1.is_some());
// In that case, the Olm Machine shouldn't change.
let olm_machine = client1.olm_machine().await.clone().expect("must have an olm machine");
assert!(initial_olm_machine.same_as(&olm_machine));
// Ok, release again.
drop(acquired1);
tokio::time::sleep(Duration::from_millis(100)).await;
// Client2 can acquire the lock.
let acquired2 = client2.encryption().try_lock_store_once().await.unwrap();
assert!(acquired2.is_some());
// And then release it.
drop(acquired2);
tokio::time::sleep(Duration::from_millis(100)).await;
// Client1 can acquire it again,
let acquired1 = client1.encryption().try_lock_store_once().await.unwrap();
assert!(acquired1.is_some());
// But now its olm machine has been invalidated and thus regenerated!
let olm_machine = client1.olm_machine().await.clone().expect("must have an olm machine");
assert!(!initial_olm_machine.same_as(&olm_machine));
let backup_key_new = olm_machine.backup_machine().get_backup_keys().await.unwrap();
assert!(backup_key_new.decryption_key.is_some());
assert_eq!(
backup_key_new.decryption_key.unwrap().megolm_v1_public_key().to_base64(),
backup_key.to_base64()
);
assert!(client1.encryption().backups().are_enabled().await);
}
#[cfg(feature = "sqlite")]
#[async_test]
async fn test_generation_counter_no_spurious_invalidation() {
// Create two clients using the same sqlite database.
let sqlite_path =
std::env::temp_dir().join("generation_counter_no_spurious_invalidations.db");
let session = MatrixSession {
meta: SessionMeta {
user_id: user_id!("@example:localhost").to_owned(),
device_id: device_id!("DEVICEID").to_owned(),
},
tokens: MatrixSessionTokens { access_token: "1234".to_owned(), refresh_token: None },
};
let client = Client::builder()
.homeserver_url("http://localhost:1234")
.request_config(RequestConfig::new().disable_retry())
.sqlite_store(&sqlite_path, None)
.build()
.await
.unwrap();
client.matrix_auth().restore_session(session.clone()).await.unwrap();
let initial_olm_machine = client.olm_machine().await.as_ref().unwrap().clone();
client.encryption().enable_cross_process_store_lock("client1".to_owned()).await.unwrap();
// Enabling the lock doesn't update the olm machine.
let after_enabling_lock = client.olm_machine().await.as_ref().unwrap().clone();
assert!(initial_olm_machine.same_as(&after_enabling_lock));
{
// Simulate that another client hold the lock before.
let client2 = Client::builder()
.homeserver_url("http://localhost:1234")
.request_config(RequestConfig::new().disable_retry())
.sqlite_store(sqlite_path, None)
.build()
.await
.unwrap();
client2.matrix_auth().restore_session(session).await.unwrap();
client2
.encryption()
.enable_cross_process_store_lock("client2".to_owned())
.await
.unwrap();
let guard = client2.encryption().spin_lock_store(None).await.unwrap();
assert!(guard.is_some());
drop(guard);
tokio::time::sleep(Duration::from_millis(100)).await;
}
{
let acquired = client.encryption().try_lock_store_once().await.unwrap();
assert!(acquired.is_some());
}
// Taking the lock the first time will update the olm machine.
let after_taking_lock_first_time = client.olm_machine().await.as_ref().unwrap().clone();
assert!(!initial_olm_machine.same_as(&after_taking_lock_first_time));
{
let acquired = client.encryption().try_lock_store_once().await.unwrap();
assert!(acquired.is_some());
}
// Re-taking the lock doesn't update the olm machine.
let after_taking_lock_second_time = client.olm_machine().await.as_ref().unwrap().clone();
assert!(after_taking_lock_first_time.same_as(&after_taking_lock_second_time));
}
}