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
// Copyright 2021 The Matrix.org Foundation C.I.C.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use std::{collections::BTreeMap, ops::Deref};
use matrix_sdk_base::crypto::{
store::CryptoStoreError, Device as BaseDevice, DeviceData, LocalTrust,
UserDevices as BaseUserDevices,
};
use ruma::{events::key::verification::VerificationMethod, DeviceId, OwnedDeviceId, OwnedUserId};
use super::ManualVerifyError;
use crate::{
encryption::verification::{SasVerification, VerificationRequest},
error::Result,
Client,
};
/// Updates about [`Device`]s which got received over the `/keys/query`
/// endpoint.
#[derive(Clone, Debug, Default)]
pub struct DeviceUpdates {
/// The list of newly discovered devices.
///
/// A device being in this list does not necessarily mean that the device
/// was just created, it just means that it's the first time we're
/// seeing this device.
pub new: BTreeMap<OwnedUserId, BTreeMap<OwnedDeviceId, Device>>,
/// The list of changed devices.
pub changed: BTreeMap<OwnedUserId, BTreeMap<OwnedDeviceId, Device>>,
}
impl DeviceUpdates {
pub(crate) fn new(
client: Client,
updates: matrix_sdk_base::crypto::store::DeviceUpdates,
) -> Self {
let map_devices = |(user_id, devices)| {
// For some reason we need to tell Rust the type of `devices`.
let devices: BTreeMap<_, _> = devices;
(
user_id,
devices
.into_iter()
.map(|(device_id, device)| {
(device_id, Device { inner: device, client: client.to_owned() })
})
.collect(),
)
};
let new = updates.new.into_iter().map(map_devices).collect();
let changed = updates.changed.into_iter().map(map_devices).collect();
DeviceUpdates { new, changed }
}
}
/// A device represents a E2EE capable client or device of an user.
///
/// A `Device` is backed by [device keys] that are uploaded to the server.
///
/// The [device keys] for our own device will be automatically uploaded by the
/// SDK and the private parts of our device keys never leave this device.
///
/// Device keys consist of an Ed25519 keypair and a Curve25519 keypair. Only the
/// public parts of those keypairs will be uploaded to the server.
///
/// ```text
/// ┌──────────────────────────────────┐
/// │ Device │
/// ├──────────────────────────────────┤
/// │ Device Keys │
/// ├────────────────┬─────────────────┤
/// │ Ed25519 Key │ Curve25519 Key │
/// └────────────────┴─────────────────┘
/// ```
///
/// The Ed25519 key will be used to uniquely identify the `Device` while the
/// Curve25519 key is used to establish 1-to-1 encrypted communication channels
/// between two devices.
///
/// [device keys]: https://spec.matrix.org/unstable/client-server-api/#device-keys
#[derive(Clone, Debug)]
pub struct Device {
pub(crate) inner: BaseDevice,
pub(crate) client: Client,
}
impl Deref for Device {
type Target = DeviceData;
fn deref(&self) -> &Self::Target {
&self.inner
}
}
impl Device {
/// Request an interactive verification with this `Device`.
///
/// Returns a [`VerificationRequest`] object that can be used to control the
/// verification flow.
///
/// The default methods that are supported are `m.sas.v1` and
/// `m.qr_code.show.v1`, if this isn't desirable the
/// [`request_verification_with_methods()`] method can be used to override
/// this. `m.qr_code.show.v1` is only available if the `qrcode` feature is
/// enabled, which it is by default.
///
/// # 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?;
/// let device =
/// client.encryption().get_device(alice, device_id!("DEVICEID")).await?;
///
/// if let Some(device) = device {
/// let verification = device.request_verification().await?;
/// }
/// # anyhow::Ok(()) };
/// ```
///
/// [`request_verification_with_methods()`]:
/// #method.request_verification_with_methods
pub async fn request_verification(&self) -> Result<VerificationRequest> {
let (verification, request) = self.inner.request_verification();
self.client.send_verification_request(request).await?;
Ok(VerificationRequest { inner: verification, client: self.client.clone() })
}
/// Request an interactive verification with this `Device`.
///
/// Returns a [`VerificationRequest`] object that can be used to control the
/// verification flow.
///
/// # Arguments
///
/// * `methods` - The verification methods that we want to support. Must be
/// non-empty.
///
/// # Panics
///
/// This method will panic if `methods` is empty.
///
/// # Examples
///
/// ```no_run
/// # use matrix_sdk::{
/// # Client,
/// # ruma::{
/// # device_id, user_id,
/// # events::key::verification::VerificationMethod,
/// # }
/// # };
/// # 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 device =
/// client.encryption().get_device(alice, device_id!("DEVICEID")).await?;
///
/// // We don't want to support showing a QR code, we only support SAS
/// // verification
/// let methods = vec![VerificationMethod::SasV1];
///
/// if let Some(device) = device {
/// let verification =
/// device.request_verification_with_methods(methods).await?;
/// }
/// # anyhow::Ok(()) };
/// ```
pub async fn request_verification_with_methods(
&self,
methods: Vec<VerificationMethod>,
) -> Result<VerificationRequest> {
assert!(!methods.is_empty(), "The list of verification methods can't be non-empty");
let (verification, request) = self.inner.request_verification_with_methods(methods);
self.client.send_verification_request(request).await?;
Ok(VerificationRequest { inner: verification, client: self.client.clone() })
}
/// Start an interactive verification with this [`Device`]
///
/// Returns a [`SasVerification`] object that represents the interactive
/// verification flow.
///
/// This method has been deprecated in the spec and the
/// [`request_verification()`] method should be used instead.
///
/// # 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?;
/// let device =
/// client.encryption().get_device(alice, device_id!("DEVICEID")).await?;
///
/// if let Some(device) = device {
/// let verification = device.start_verification().await?;
/// }
/// # anyhow::Ok(()) };
/// ```
///
/// [`request_verification()`]: #method.request_verification
#[deprecated(
since = "0.4.0",
note = "directly starting a verification is deprecated in the spec. \
Users should instead use request_verification()"
)]
pub async fn start_verification(&self) -> Result<SasVerification> {
let (sas, request) = self.inner.start_verification().await?;
self.client.send_to_device(&request).await?;
Ok(SasVerification { inner: sas, client: self.client.clone() })
}
/// Manually verify this device.
///
/// This method will attempt to sign the device using our private cross
/// signing key.
///
/// This method will always fail if the device belongs to someone else, we
/// can only sign our own devices.
///
/// It can also fail if we don't have the private part of our self-signing
/// key.
///
/// The state of our private cross signing keys can be inspected using the
/// [`Encryption::cross_signing_status()`] method.
///
/// [`Encryption::cross_signing_status()`]: crate::encryption::Encryption::cross_signing_status
///
/// ### Problems of manual verification
///
/// Manual verification may be more convenient to use, i.e. both devices
/// need to be online and available to interactively verify each other.
/// Despite the convenience, interactive verifications should be
/// generally preferred. Manually verifying a device won't notify the
/// other device, the one being verified, that they should also verify
/// us. This means that device `A` will consider device `B` to be
/// verified, but not the other way around.
///
/// # Examples
///
/// ```no_run
/// # use matrix_sdk::{
/// # Client,
/// # ruma::{
/// # device_id, user_id,
/// # events::key::verification::VerificationMethod,
/// # }
/// # };
/// # 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 device =
/// client.encryption().get_device(alice, device_id!("DEVICEID")).await?;
///
/// if let Some(device) = device {
/// device.verify().await?;
/// }
/// # anyhow::Ok(()) };
/// ```
pub async fn verify(&self) -> Result<(), ManualVerifyError> {
let request = self.inner.verify().await?;
self.client.send(request, None).await?;
Ok(())
}
/// Is the device considered to be verified.
///
/// A device is considered to be verified, either if it's locally marked as
/// such, or if it's signed by the appropriate cross signing key. Our own
/// device, is always implicitly verified.
///
/// ## Local trust
///
/// Local trust can be established using the [`Device::set_local_trust()`]
/// method or it will be established if we interactively verify the device
/// using [`Device::request_verification()`].
///
/// **Note**: The concept of local trust is largely deprecated because it
/// can't be shared with other devices. Every device needs to verify all the
/// other devices it communicates to. Because this becomes quickly
/// unsustainable verification has migrated to cross signing verification.
///
/// ## Cross signing verification
///
/// Cross signing verification uses signatures over devices and user
/// identities to check if a device is considered to be verified. The
/// signatures can be uploaded to the homeserver, this allows us to
/// share the verification state with other devices. Devices only need to
/// verify a user identity, if the user identity has verified and signed
/// the device we can consider the device to be verified as well.
///
/// Devices are usually cross signing verified using interactive
/// verification, which can be started using the
/// [`Device::request_verification()`] method.
///
/// A [`Device`] can also be manually signed using the [`Device::verify()`]
/// method, this works only for devices belonging to our own user.
///
/// Do note that the device that is being manually signed will not trust our
/// own user identity like it would if we interactively verify the device.
/// Such a device can mark our own user as verified using the
/// [`UserIdentity::verify()`] method.
///
/// ### Verification of devices belonging to our own user.
///
/// If the device belongs to our own user, the device will be considered to
/// be verified if:
///
/// * The device has been signed by our self-signing key
/// * Our own user identity is considered to be [verified]
///
/// In other words we need to find a valid signature chain from our user
/// identity to the device:
///
///```text
/// ┌─────────────────────────────────────┐ ┌─────────────┐
/// │ Own User Identity │ │ Device │
/// ├──────────────────┬──────────────────┤───►├─────────────┤
/// │ Master Key │ Self-signing Key │ │ Device Keys │
/// └──────────────────┴──────────────────┘ └─────────────┘
/// ```
///
/// ### Verification of devices belonging to other users.
///
/// If the device belongs to some other user it will be considered to be
/// verified if:
///
/// * The device has been signed by the user's self-signing key
/// * The user's master-signing key has been signed by our own user-signing
/// key, i.e. our own identity trusts the other users identity.
/// * Our own user identity is considered to be [verified]
///
/// ```text
/// ┌─────────────────────────────────────┐
/// │ Own User Identity │
/// ├──────────────────┬──────────────────┤─────┐
/// │ Master Key │ User-signing Key │ │
/// └──────────────────┴──────────────────┘ │
/// ┌───────────────────────────────────────────────────┘
/// │
/// │ ┌─────────────────────────────────────┐ ┌─────────────┐
/// │ │ User Identity │ │ Device │
/// └──────►├──────────────────┬──────────────────┤───►│─────────────│
/// │ Master Key │ Self-signing Key │ │ Device Keys │
/// └──────────────────┴──────────────────┘ └─────────────┘
/// ```
///
/// # Examples
///
/// Let's check if a device is verified:
///
/// ```no_run
/// # use matrix_sdk::{
/// # Client,
/// # ruma::{
/// # device_id, user_id,
/// # events::key::verification::VerificationMethod,
/// # }
/// # };
/// # 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 device =
/// client.encryption().get_device(alice, device_id!("DEVICEID")).await?;
///
/// if let Some(device) = device {
/// if device.is_verified() {
/// println!(
/// "Device {} of user {} is verified",
/// device.device_id(),
/// device.user_id(),
/// );
/// } else {
/// println!(
/// "Device {} of user {} is not verified",
/// device.device_id(),
/// device.user_id(),
/// );
/// }
/// }
/// # anyhow::Ok(()) };
/// ```
///
/// [`UserIdentity::verify()`]:
/// crate::encryption::identities::UserIdentity::verify
/// [verified]: crate::encryption::identities::UserIdentity::is_verified
pub fn is_verified(&self) -> bool {
self.inner.is_verified()
}
/// Is the device considered to be verified with cross-signing.
///
/// A device is considered to be verified if it's signed by the appropriate
/// cross-signing key.
///
/// ## Cross-signing verification
///
/// Cross-signing verification uses signatures over devices and user
/// identities to check if a device is considered to be verified. The
/// signatures can be uploaded to the homeserver, this allows us to
/// share the verification state with other devices. Devices only need to
/// verify a user identity, if the user identity has verified and signed
/// the device we can consider the device to be verified as well.
///
/// Devices are usually cross-signing verified using interactive
/// verification, which can be started using the
/// [`Device::request_verification()`] method.
///
/// A [`Device`] can also be manually signed using the [`Device::verify()`]
/// method, this works only for devices belonging to our own user.
///
/// Do note that the device that is being manually signed will not trust our
/// own user identity like it would if we interactively verify the device.
/// Such a device can mark our own user as verified using the
/// [`UserIdentity::verify()`] method.
///
/// ### Verification of devices belonging to our own user.
///
/// If the device belongs to our own user, the device will be considered to
/// be verified if:
///
/// * The device has been signed by our self-signing key
/// * Our own user identity is considered to be [verified]
///
/// In other words we need to find a valid signature chain from our user
/// identity to the device:
///
///```text
/// ┌─────────────────────────────────────┐ ┌─────────────┐
/// │ Own User Identity │ │ Device │
/// ├──────────────────┬──────────────────┤───►├─────────────┤
/// │ Master Key │ Self-signing Key │ │ Device Keys │
/// └──────────────────┴──────────────────┘ └─────────────┘
/// ```
///
/// ### Verification of devices belonging to other users.
///
/// If the device belongs to some other user it will be considered to be
/// verified if:
///
/// * The device has been signed by the user's self-signing key
/// * The user's master-signing key has been signed by our own user-signing
/// key, i.e. our own identity trusts the other users identity.
/// * Our own user identity is considered to be [verified]
///
/// ```text
/// ┌─────────────────────────────────────┐
/// │ Own User Identity │
/// ├──────────────────┬──────────────────┤─────┐
/// │ Master Key │ User-signing Key │ │
/// └──────────────────┴──────────────────┘ │
/// ┌───────────────────────────────────────────────────┘
/// │
/// │ ┌─────────────────────────────────────┐ ┌─────────────┐
/// │ │ User Identity │ │ Device │
/// └──────►├──────────────────┬──────────────────┤───►│─────────────│
/// │ Master Key │ Self-signing Key │ │ Device Keys │
/// └──────────────────┴──────────────────┘ └─────────────┘
/// ```
///
/// # Examples
///
/// Let's check if a device is verified:
///
/// ```no_run
/// # use matrix_sdk::{
/// # Client,
/// # ruma::{
/// # device_id, user_id,
/// # events::key::verification::VerificationMethod,
/// # }
/// # };
/// # 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 device =
/// client.encryption().get_device(alice, device_id!("DEVICEID")).await?;
///
/// if let Some(device) = device {
/// if device.is_verified_with_cross_signing() {
/// println!(
/// "Device {} of user {} is verified with cross-signing",
/// device.device_id(),
/// device.user_id()
/// );
/// } else {
/// println!(
/// "Device {} of user {} is not verified with cross-signing",
/// device.device_id(),
/// device.user_id()
/// );
/// }
/// }
/// # anyhow::Ok(()) };
/// ```
///
/// [`UserIdentity::verify()`]:
/// crate::encryption::identities::UserIdentity::verify
/// [verified]: crate::encryption::identities::UserIdentity::is_verified
pub fn is_verified_with_cross_signing(&self) -> bool {
self.inner.is_cross_signing_trusted()
}
/// Set the local trust state of the device to the given state.
///
/// This won't affect any cross signing verification state, this only sets
/// a flag marking to have the given trust state.
///
/// # Arguments
///
/// * `trust_state` - The new trust state that should be set for the device.
pub async fn set_local_trust(&self, trust_state: LocalTrust) -> Result<(), CryptoStoreError> {
self.inner.set_local_trust(trust_state).await
}
/// Is the device cross-signed by its own user.
pub fn is_cross_signed_by_owner(&self) -> bool {
self.inner.is_cross_signed_by_owner()
}
}
/// The collection of all the [`Device`]s a user has.
#[derive(Debug)]
pub struct UserDevices {
pub(crate) inner: BaseUserDevices,
pub(crate) client: Client,
}
impl UserDevices {
/// Get the specific device with the given device ID.
pub fn get(&self, device_id: &DeviceId) -> Option<Device> {
self.inner.get(device_id).map(|d| Device { inner: d, client: self.client.clone() })
}
/// Iterator over all the device ids of the user devices.
pub fn keys(&self) -> impl Iterator<Item = &DeviceId> {
self.inner.keys()
}
/// Iterator over all the devices of the user devices.
pub fn devices(&self) -> impl Iterator<Item = Device> + '_ {
let client = self.client.clone();
self.inner.devices().map(move |d| Device { inner: d, client: client.clone() })
}
}