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
#![doc = include_str!("../docs/encryption.md")]
#![cfg_attr(target_arch = "wasm32", allow(unused_imports))]
pub mod identities;
pub mod verification;
use std::{
collections::{BTreeMap, HashSet},
io::{Read, Write},
iter,
path::PathBuf,
};
use futures_util::stream::{self, StreamExt};
use matrix_sdk_base::crypto::{
store::CryptoStoreError, CrossSigningStatus, OutgoingRequest, RoomMessageRequest,
ToDeviceRequest,
};
pub use matrix_sdk_base::crypto::{LocalTrust, MediaEncryptionInfo, RoomKeyImportResult};
use matrix_sdk_common::instant::Duration;
#[cfg(feature = "e2e-encryption")]
use ruma::{
api::client::config::set_global_account_data, events::GlobalAccountDataEventContent,
OwnedDeviceId,
};
use ruma::{
api::client::{
backup::add_backup_keys::v3::Response as KeysBackupResponse,
keys::{
get_keys, upload_keys, 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,
},
assign,
events::GlobalAccountDataEventType,
DeviceId, OwnedUserId, TransactionId, UserId,
};
use tracing::{debug, instrument, trace, warn};
use crate::{
attachment::{AttachmentInfo, Thumbnail},
encryption::{
identities::{Device, UserDevices},
verification::{SasVerification, Verification, VerificationRequest},
},
error::{HttpError, HttpResult, RoomKeyImportError},
room, Client, Error, Result,
};
impl Client {
#[cfg(feature = "e2e-encryption")]
#[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?;
Ok(response)
}
#[cfg(feature = "e2e-encryption")]
pub(crate) async fn prepare_encrypted_attachment_message<R: Read, T: Read>(
&self,
body: &str,
content_type: &mime::Mime,
reader: &mut R,
info: Option<AttachmentInfo>,
thumbnail: Option<Thumbnail<'_, T>>,
) -> Result<ruma::events::room::message::MessageType> {
let (thumbnail_source, thumbnail_info) = if let Some(thumbnail) = thumbnail {
let mut reader = matrix_sdk_base::crypto::AttachmentEncryptor::new(thumbnail.reader);
let response = self.upload(thumbnail.content_type, &mut reader).await?;
let file: ruma::events::room::EncryptedFile = {
let keys = reader.finish();
ruma::events::room::EncryptedFileInit {
url: response.content_uri,
key: keys.web_key,
iv: keys.iv,
hashes: keys.hashes,
v: keys.version,
}
.into()
};
use ruma::events::room::ThumbnailInfo;
let thumbnail_info = assign!(
thumbnail.info.as_ref().map(|info| ThumbnailInfo::from(info.clone())).unwrap_or_default(),
{ mimetype: Some(thumbnail.content_type.as_ref().to_owned()) }
);
(Some(MediaSource::Encrypted(Box::new(file))), Some(Box::new(thumbnail_info)))
} else {
(None, None)
};
let mut reader = matrix_sdk_base::crypto::AttachmentEncryptor::new(reader);
let response = self.upload(content_type, &mut reader).await?;
let file: ruma::events::room::EncryptedFile = {
let keys = reader.finish();
ruma::events::room::EncryptedFileInit {
url: response.content_uri,
key: keys.web_key,
iv: keys.iv,
hashes: keys.hashes,
v: keys.version,
}
.into()
};
use ruma::events::room::{self, message, MediaSource};
Ok(match content_type.type_() {
mime::IMAGE => {
let info = assign!(
info.map(room::ImageInfo::from).unwrap_or_default(),
{
mimetype: Some(content_type.as_ref().to_owned()),
thumbnail_source,
thumbnail_info
}
);
let content =
assign!(message::ImageMessageEventContent::encrypted(body.to_owned(), file), {
info: Some(Box::new(info))
});
message::MessageType::Image(content)
}
mime::AUDIO => {
let info = assign!(
info.map(message::AudioInfo::from).unwrap_or_default(),
{
mimetype: Some(content_type.as_ref().to_owned()),
}
);
let content =
assign!(message::AudioMessageEventContent::encrypted(body.to_owned(), file), {
info: Some(Box::new(info))
});
message::MessageType::Audio(content)
}
mime::VIDEO => {
let info = assign!(
info.map(message::VideoInfo::from).unwrap_or_default(),
{
mimetype: Some(content_type.as_ref().to_owned()),
thumbnail_source,
thumbnail_info
}
);
let content =
assign!(message::VideoMessageEventContent::encrypted(body.to_owned(), file), {
info: Some(Box::new(info))
});
message::MessageType::Video(content)
}
_ => {
let info = assign!(
info.map(message::FileInfo::from).unwrap_or_default(),
{
mimetype: Some(content_type.as_ref().to_owned()),
thumbnail_source,
thumbnail_info
}
);
let content =
assign!(message::FileMessageEventContent::encrypted(body.to_owned(), file), {
info: Some(Box::new(info))
});
message::MessageType::File(content)
}
})
}
#[cfg(feature = "e2e-encryption")]
async fn send_account_data<T>(
&self,
content: T,
) -> Result<set_global_account_data::v3::Response>
where
T: GlobalAccountDataEventContent,
{
let own_user =
self.user_id().await.ok_or_else(|| Error::from(HttpError::AuthenticationRequired))?;
let request = set_global_account_data::v3::Request::new(&content, &own_user)?;
Ok(self.send(request, None).await?)
}
#[cfg(feature = "e2e-encryption")]
pub(crate) async fn create_dm_room(
&self,
user_id: OwnedUserId,
) -> Result<Option<room::Joined>> {
use ruma::{api::client::room::create_room::v3::RoomPreset, events::direct::DirectEvent};
const SYNC_WAIT_TIME: Duration = Duration::from_secs(3);
let invite = &[user_id.clone()];
let request = assign!(
ruma::api::client::room::create_room::v3::Request::new(),
{
invite,
is_direct: true,
preset: Some(RoomPreset::TrustedPrivateChat),
}
);
let response = self.send(request, None).await?;
let mut content = self
.store()
.get_account_data_event(GlobalAccountDataEventType::Direct)
.await?
.map(|e| e.deserialize_as::<DirectEvent>())
.transpose()?
.map(|e| e.content)
.unwrap_or_else(|| ruma::events::direct::DirectEventContent(BTreeMap::new()));
content.entry(user_id.to_owned()).or_default().push(response.room_id.to_owned());
self.send_account_data(content).await?;
if let Some(room) = self.get_joined_room(&response.room_id) {
Ok(Some(room))
} else {
self.inner.sync_beat.listen().wait_timeout(SYNC_WAIT_TIME);
Ok(self.get_joined_room(&response.room_id))
}
}
#[cfg(feature = "e2e-encryption")]
#[instrument(skip_all)]
pub(crate) async fn claim_one_time_keys(
&self,
users: impl Iterator<Item = &UserId>,
) -> Result<()> {
let _lock = self.inner.key_claim_lock.lock().await;
if let Some((request_id, request)) = self.base_client().get_missing_sessions(users).await? {
let response = self.send(request, None).await?;
self.mark_request_as_sent(&request_id, &response).await?;
}
Ok(())
}
#[cfg(feature = "e2e-encryption")]
#[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)
}
#[cfg(feature = "e2e-encryption")]
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;
let room_id = &request.room_id;
self.get_joined_room(room_id)
.expect("Can't send a message to a room that isn't known to the store")
.send(content, Some(txn_id))
.await
}
#[cfg(feature = "e2e-encryption")]
pub(crate) async fn send_to_device(
&self,
request: &ToDeviceRequest,
) -> HttpResult<ToDeviceResponse> {
let event_type = request.event_type.to_string();
let request =
RumaToDeviceRequest::new_raw(&event_type, &request.txn_id, request.messages.clone());
self.send(request, None).await
}
#[cfg(feature = "e2e-encryption")]
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(())
}
#[cfg(feature = "e2e-encryption")]
fn get_dm_room(&self, user_id: &UserId) -> Option<room::Joined> {
let rooms = self.joined_rooms();
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?;
}
OutgoingRequests::KeysBackup(request) => {
let response = self.send_backup_request(request).await?;
self.mark_request_as_sent(r.request_id(), &response).await?;
}
}
Ok(())
}
async fn send_backup_request(
&self,
request: &matrix_sdk_base::crypto::KeysBackupRequest,
) -> Result<KeysBackupResponse> {
let request = ruma::api::client::backup::add_backup_keys::v3::Request::new(
&request.version,
request.rooms.to_owned(),
);
Ok(self.send(request, None).await?)
}
pub(crate) async fn send_outgoing_requests(&self) -> Result<()> {
const MAX_CONCURRENT_REQUESTS: usize = 20;
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.base_client().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(feature = "e2e-encryption")]
#[derive(Debug, Clone)]
pub struct Encryption {
client: Client,
}
#[cfg(feature = "e2e-encryption")]
impl Encryption {
pub(crate) fn new(client: Client) -> Self {
Self { client }
}
pub async fn ed25519_key(&self) -> Option<String> {
self.client.olm_machine().await.map(|o| o.identity_keys().ed25519.to_base64())
}
pub async fn cross_signing_status(&self) -> Option<CrossSigningStatus> {
if let Some(machine) = self.client.olm_machine().await {
Some(machine.cross_signing_status().await)
} else {
None
}
}
pub async fn tracked_users(&self) -> HashSet<OwnedUserId> {
self.client.olm_machine().await.map(|o| o.tracked_users()).unwrap_or_default()
}
pub async fn get_verification(&self, user_id: &UserId, flow_id: &str) -> Option<Verification> {
let olm = self.client.olm_machine().await?;
#[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,
})
}
pub async fn get_verification_request(
&self,
user_id: &UserId,
flow_id: impl AsRef<str>,
) -> Option<VerificationRequest> {
let olm = self.client.olm_machine().await?;
olm.get_verification_request(user_id, flow_id)
.map(|r| VerificationRequest { inner: r, client: self.client.clone() })
}
pub async fn get_device(
&self,
user_id: &UserId,
device_id: &DeviceId,
) -> Result<Option<Device>, CryptoStoreError> {
let device = self.client.base_client().get_device(user_id, device_id).await?;
Ok(device.map(|d| Device { inner: d, client: self.client.clone() }))
}
pub async fn get_user_devices(
&self,
user_id: &UserId,
) -> Result<UserDevices, CryptoStoreError> {
let devices = self.client.base_client().get_user_devices(user_id).await?;
Ok(UserDevices { inner: devices, client: self.client.clone() })
}
pub async fn get_user_identity(
&self,
user_id: &UserId,
) -> Result<Option<crate::encryption::identities::UserIdentity>, CryptoStoreError> {
use crate::encryption::identities::UserIdentity;
if let Some(olm) = self.client.olm_machine().await {
let identity = olm.get_identity(user_id).await?;
Ok(identity.map(|i| match i {
matrix_sdk_base::crypto::UserIdentities::Own(i) => {
UserIdentity::new_own(self.client.clone(), i)
}
matrix_sdk_base::crypto::UserIdentities::Other(i) => {
UserIdentity::new(self.client.clone(), i, self.client.get_dm_room(user_id))
}
}))
} else {
Ok(None)
}
}
pub async fn bootstrap_cross_signing(&self, auth_data: Option<AuthData<'_>>) -> Result<()> {
let olm = self.client.olm_machine().await.ok_or(Error::AuthenticationRequired)?;
let (request, signature_request) = olm.bootstrap_cross_signing(false).await?;
let request = assign!(UploadSigningKeysRequest::new(), {
auth: auth_data,
master_key: request.master_key.map(|c| c.to_raw()),
self_signing_key: request.self_signing_key.map(|c| c.to_raw()),
user_signing_key: request.user_signing_key.map(|c| c.to_raw()),
});
self.client.send(request, None).await?;
self.client.send(signature_request, None).await?;
Ok(())
}
#[cfg(not(target_arch = "wasm32"))]
pub async fn export_keys(
&self,
path: PathBuf,
passphrase: &str,
predicate: impl FnMut(&matrix_sdk_base::crypto::olm::InboundGroupSession) -> bool,
) -> Result<()> {
let olm = self.client.olm_machine().await.ok_or(Error::AuthenticationRequired)?;
let keys = olm.export_keys(predicate).await?;
let passphrase = zeroize::Zeroizing::new(passphrase.to_owned());
let encrypt = move || -> Result<()> {
let export: String =
matrix_sdk_base::crypto::encrypt_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")
}
#[cfg(not(target_arch = "wasm32"))]
pub async fn import_keys(
&self,
path: PathBuf,
passphrase: &str,
) -> Result<RoomKeyImportResult, RoomKeyImportError> {
let olm = self.client.olm_machine().await.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_key_export(file, &passphrase)
};
let task = tokio::task::spawn_blocking(decrypt);
let import = task.await.expect("Task join error")?;
Ok(olm.import_keys(import, false, |_, _| {}).await?)
}
}
#[cfg(all(test, not(target_arch = "wasm32")))]
mod tests {
use matrix_sdk_test::{async_test, EventBuilder, EventsJson};
use mockito::{mock, Matcher};
use ruma::{
event_id,
events::reaction::{ReactionEventContent, Relation},
room_id,
};
use serde_json::json;
use crate::client::tests::logged_in_client;
#[async_test]
async fn test_reaction_sending() {
let client = logged_in_client().await;
let event_id = event_id!("$2:example.org");
let room_id = room_id!("!SVkFJHzfwvuaIEawgC:localhost");
let _m = mock(
"PUT",
Matcher::Regex(r"^/_matrix/client/r0/rooms/.*/send/m%2Ereaction/.*".to_owned()),
)
.with_status(200)
.with_body(
json!({
"event_id": event_id,
})
.to_string(),
)
.create();
let response = EventBuilder::default()
.add_state_event(EventsJson::Member)
.add_state_event(EventsJson::PowerLevels)
.add_state_event(EventsJson::Encryption)
.build_sync_response();
client.inner.base_client.receive_sync_response(response).await.unwrap();
let room = client.get_joined_room(room_id).expect("Room should exist");
assert!(room.is_encrypted());
let event_id = event_id!("$1:example.org");
let reaction = ReactionEventContent::new(Relation::new(event_id.into(), "🐈".to_owned()));
room.send(reaction, None).await.expect("Sending the reaction should not fail");
room.send_raw(json!({}), "m.reaction", None)
.await
.expect("Sending the reaction should not fail");
}
}