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
// Copyright 2020 The Matrix.org Foundation C.I.C.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use std::collections::BTreeMap;
use matrix_sdk_common::deserialized_responses::VerificationLevel;
use ruma::{CanonicalJsonError, IdParseError, OwnedDeviceId, OwnedRoomId, OwnedUserId};
use serde::{ser::SerializeMap, Serializer};
use serde_json::Error as SerdeError;
use thiserror::Error;
use vodozemac::{Curve25519PublicKey, Ed25519PublicKey};
use super::store::CryptoStoreError;
use crate::{
olm::SessionExportError,
types::{events::room_key_withheld::WithheldCode, SignedKey},
};
#[cfg(doc)]
use crate::{CollectStrategy, Device, LocalTrust, OtherUserIdentity};
pub type OlmResult<T> = Result<T, OlmError>;
pub type MegolmResult<T> = Result<T, MegolmError>;
/// Error representing a failure during a device to device cryptographic
/// operation.
#[derive(Error, Debug)]
pub enum OlmError {
/// The event that should have been decrypted is malformed.
#[error(transparent)]
EventError(#[from] EventError),
/// The received decrypted event couldn't be deserialized.
#[error(transparent)]
JsonError(#[from] SerdeError),
/// The received room key couldn't be converted into a valid Megolm session.
#[error(transparent)]
SessionCreation(#[from] SessionCreationError),
/// The room key that should be exported can't be converted into a
/// `m.forwarded_room_key` event.
#[error(transparent)]
SessionExport(#[from] SessionExportError),
/// The storage layer returned an error.
#[error("failed to read or write to the crypto store {0}")]
Store(#[from] CryptoStoreError),
/// The session with a device has become corrupted.
#[error(
"decryption failed likely because an Olm session from {0} with sender key {1} was wedged"
)]
SessionWedged(OwnedUserId, Curve25519PublicKey),
/// An Olm message got replayed while the Olm ratchet has already moved
/// forward.
#[error("decryption failed because an Olm message from {0} with sender key {1} was replayed")]
ReplayedMessage(OwnedUserId, Curve25519PublicKey),
/// Encryption failed because the device does not have a valid Olm session
/// with us.
#[error(
"encryption failed because the device does not \
have a valid Olm session with us"
)]
MissingSession,
/// Encryption failed due to an error collecting the recipient devices.
#[error("encryption failed due to an error collecting the recipient devices: {0}")]
SessionRecipientCollectionError(SessionRecipientCollectionError),
}
/// Error representing a failure during a group encryption operation.
#[derive(Error, Debug)]
pub enum MegolmError {
/// The event that should have been decrypted is malformed.
#[error(transparent)]
EventError(#[from] EventError),
/// The received decrypted event couldn't be deserialized.
#[error(transparent)]
JsonError(#[from] SerdeError),
/// Decryption failed because we're missing the room key that was used to
/// encrypt the event.
#[error("Can't find the room key to decrypt the event, withheld code: {0:?}")]
MissingRoomKey(Option<WithheldCode>),
/// Decryption failed because of a mismatch between the identity keys of the
/// device we received the room key from and the identity keys recorded in
/// the plaintext of the room key to-device message.
#[error(
"decryption failed because of mismatched identity keys of the sending device and those recorded in the to-device message"
)]
MismatchedIdentityKeys(MismatchedIdentityKeysError),
/// The encrypted megolm message couldn't be decoded.
#[error(transparent)]
Decode(#[from] vodozemac::DecodeError),
/// The event could not have been decrypted.
#[error(transparent)]
Decryption(#[from] vodozemac::megolm::DecryptionError),
/// The storage layer returned an error.
#[error(transparent)]
Store(#[from] CryptoStoreError),
/// An encrypted message wasn't decrypted, because the sender's
/// cross-signing identity did not satisfy the requested
/// [`crate::TrustRequirement`].
///
/// The nested value is the sender's current verification level.
#[error("decryption failed because trust requirement not satisfied: {0}")]
SenderIdentityNotTrusted(VerificationLevel),
}
/// Decryption failed because of a mismatch between the identity keys of the
/// device we received the room key from and the identity keys recorded in
/// the plaintext of the room key to-device message.
#[derive(Error, Debug, PartialEq)]
pub struct MismatchedIdentityKeysError {
/// The Ed25519 key recorded in the room key's to-device message.
pub key_ed25519: Box<Ed25519PublicKey>,
/// The Ed25519 identity key of the device sending the room key.
pub device_ed25519: Option<Box<Ed25519PublicKey>>,
/// The Curve25519 key recorded in the room key's to-device message.
pub key_curve25519: Box<Curve25519PublicKey>,
/// The Curve25519 identity key of the device sending the room key.
pub device_curve25519: Option<Box<Curve25519PublicKey>>,
}
impl std::fmt::Display for MismatchedIdentityKeysError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut ser = f.serialize_struct("MismatchedIdentityKeysError", 4)?;
ser.serialize_entry("key_ed25519", &self.key_ed25519)?;
ser.serialize_entry("device_ed25519", &self.device_ed25519)?;
ser.serialize_entry("key_curve25519", &self.key_curve25519)?;
ser.serialize_entry("device_curve25519", &self.device_curve25519)?;
ser.end()
}
}
impl From<MismatchedIdentityKeysError> for MegolmError {
fn from(value: MismatchedIdentityKeysError) -> Self {
MegolmError::MismatchedIdentityKeys(value)
}
}
impl From<MismatchedIdentityKeysError> for SessionCreationError {
fn from(value: MismatchedIdentityKeysError) -> Self {
SessionCreationError::MismatchedIdentityKeys(value)
}
}
/// Error that occurs when decrypting an event that is malformed.
#[derive(Error, Debug)]
pub enum EventError {
/// The Encrypted message has been encrypted with a unsupported algorithm.
#[error("the Encrypted message has been encrypted with a unsupported algorithm.")]
UnsupportedAlgorithm,
/// The provided JSON value isn't an object.
#[error("the provided JSON value isn't an object")]
NotAnObject,
/// The Encrypted message doesn't contain a ciphertext for our device.
#[error("the Encrypted message doesn't contain a ciphertext for our device")]
MissingCiphertext,
/// The Encrypted message is missing the signing key of the sender.
#[error("the Encrypted message is missing the signing key of the sender")]
MissingSigningKey,
/// The Encrypted message is missing the sender key.
#[error("the Encrypted message is missing the sender key")]
MissingSenderKey,
/// The sender of the plaintext doesn't match the sender of the encrypted
/// message.
#[error(
"the sender of the plaintext doesn't match the sender of the encrypted \
message, got {0}, expected {1}"
)]
MismatchedSender(OwnedUserId, OwnedUserId),
/// The public key that was part of the message doesn't match the key we
/// have stored.
#[error(
"the public key that was part of the message doesn't match the key we \
have stored, expected {0}, got {1}"
)]
MismatchedKeys(Box<Ed25519PublicKey>, Box<Ed25519PublicKey>),
/// The room ID of the room key doesn't match the room ID of the decrypted
/// event.
#[error(
"the room id of the room key doesn't match the room id of the \
decrypted event: expected {0}, got {1:?}"
)]
MismatchedRoom(OwnedRoomId, Option<OwnedRoomId>),
}
/// Error type describing different errors that can happen when we create an
/// Olm session from a pickle.
#[derive(Error, Debug)]
pub enum SessionUnpickleError {
/// The device keys are missing the signing key
#[error("the device keys are missing the signing key")]
MissingSigningKey,
/// The device keys are missing the identity key
#[error("the device keys are missing the identity key")]
MissingIdentityKey,
}
/// Error type describing different errors that happen when we check or create
/// signatures for a Matrix JSON object.
#[derive(Error, Debug)]
pub enum SignatureError {
/// The signature was made using an unsupported algorithm.
#[error("the signature used an unsupported algorithm")]
UnsupportedAlgorithm,
/// The ID of the signing key isn't a valid key ID.
#[error("the ID of the signing key is invalid")]
InvalidKeyId(#[from] IdParseError),
/// The signing key that should create or check a signature is missing.
#[error("the signing key is missing from the object that signed the message")]
MissingSigningKey,
/// The user id of signing key differs from the user id that provided the
/// signature.
#[error("the user id of the signing key differs user id that provided the signature")]
UserIdMismatch,
/// The provided JSON value that was signed and the signature should be
/// checked isn't a valid JSON object.
#[error("the provided JSON value isn't an object")]
NotAnObject,
/// The provided JSON value that was signed and the signature should be
/// checked isn't a valid JSON object.
#[error("the provided JSON object doesn't contain a signatures field")]
NoSignatureFound,
/// The signature couldn't be verified.
#[error(transparent)]
VerificationError(#[from] vodozemac::SignatureError),
/// The public key isn't a valid ed25519 key.
#[error(transparent)]
InvalidKey(#[from] vodozemac::KeyError),
/// The signature could not be decoded.
#[error("the given signature is not valid and can't be decoded")]
InvalidSignature,
/// The signing key that used to sign the object has been changed.
#[error("the signing key that used to sign the object has changed, old: {0:?}, new: {1:?}")]
SigningKeyChanged(Option<Box<Ed25519PublicKey>>, Option<Box<Ed25519PublicKey>>),
/// The signed object couldn't be deserialized.
#[error(transparent)]
JsonError(#[from] CanonicalJsonError),
/// The store ran into an error.
#[error(transparent)]
StoreError(#[from] CryptoStoreError),
}
impl From<SerdeError> for SignatureError {
fn from(e: SerdeError) -> Self {
CanonicalJsonError::SerDe(e).into()
}
}
/// Error that occurs when a room key can't be converted into a valid Megolm
/// session.
#[derive(Error, Debug)]
pub enum SessionCreationError {
/// The requested one-time key isn't a signed curve key.
#[error(
"Failed to create a new Olm session for {0} {1}, the requested \
one-time key isn't a signed curve key"
)]
OneTimeKeyNotSigned(OwnedUserId, OwnedDeviceId),
/// The signed one-time key is missing.
#[error(
"Tried to create a new Olm session for {0} {1}, but the signed \
one-time key is missing"
)]
OneTimeKeyMissing(OwnedUserId, OwnedDeviceId),
/// Failed to verify the one-time key signatures.
#[error(
"Failed to verify the signature of a one-time key, key: {one_time_key:?}, \
signing_key: {signing_key:?}: {error:?}"
)]
InvalidSignature {
/// The one-time key that failed the signature verification.
one_time_key: Box<SignedKey>,
/// The key that was used to verify the signature.
signing_key: Option<Box<Ed25519PublicKey>>,
/// The exact error describing why the signature verification failed.
error: Box<SignatureError>,
},
/// The user's device is missing a curve25519 key.
#[error(
"Tried to create an Olm session for {0} {1}, but the device is missing \
a curve25519 key"
)]
DeviceMissingCurveKey(OwnedUserId, OwnedDeviceId),
/// Error deserializing the one-time key.
#[error("Error deserializing the one-time key: {0}")]
InvalidJson(#[from] serde_json::Error),
/// The given curve25519 key is not a valid key.
#[error("The given curve25519 key is not a valid key")]
InvalidCurveKey(#[from] vodozemac::KeyError),
/// Error when creating an Olm Session from an incoming Olm message.
#[error(transparent)]
InboundCreation(#[from] vodozemac::olm::SessionCreationError),
/// The given device keys are invalid.
#[error("The given device keys are invalid")]
InvalidDeviceKeys(#[from] SignatureError),
/// There was a mismatch between the identity keys of the device we received
/// the room key from and the identity keys recorded in the plaintext of the
/// room key to-device message.
#[error(
"There was a mismatch between the identity keys of the sending device \
and those recorded in the to-device message"
)]
MismatchedIdentityKeys(MismatchedIdentityKeysError),
}
/// Errors that can be returned by
/// [`crate::machine::OlmMachine::set_room_settings`].
#[derive(Debug, Error)]
pub enum SetRoomSettingsError {
/// The changes are rejected because they conflict with the previous
/// settings for this room.
#[error("the new settings would cause a downgrade of encryption security")]
EncryptionDowngrade,
/// The changes are rejected because we would be unable to use them to
/// encrypt events.
#[error("the new settings are invalid")]
InvalidSettings,
/// The store ran into an error.
#[error(transparent)]
Store(#[from] CryptoStoreError),
}
/// Error representing a problem when collecting the recipient devices for the
/// room key, during an encryption operation.
#[derive(Error, Debug)]
pub enum SessionRecipientCollectionError {
/// One or more verified users has one or more unsigned devices.
///
/// Happens only with [`CollectStrategy::DeviceBasedStrategy`] when
/// [`error_on_verified_user_problem`](`CollectStrategy::DeviceBasedStrategy::error_on_verified_user_problem`)
/// is true.
///
/// In order to resolve this, the caller can set the trust level of the
/// affected devices to [`LocalTrust::Ignored`] or
/// [`LocalTrust::BlackListed`] (see [`Device::set_local_trust`]), and
/// then retry the encryption operation.
#[error("one or more verified users have unsigned devices")]
VerifiedUserHasUnsignedDevice(BTreeMap<OwnedUserId, Vec<OwnedDeviceId>>),
/// One or more users was previously verified, but they have changed their
/// identity.
///
/// Happens only with [`CollectStrategy::DeviceBasedStrategy`] when
/// [`error_on_verified_user_problem`](`CollectStrategy::DeviceBasedStrategy::error_on_verified_user_problem`)
/// is true, or with [`CollectStrategy::IdentityBasedStrategy`].
///
/// In order to resolve this, the user can:
///
/// * re-verify the problematic recipients, or
///
/// * withdraw verification of the problematic recipients with
/// [`OtherUserIdentity::withdraw_verification`], or
///
/// * set the trust level of all of the devices belonging to the problematic
/// recipients to [`LocalTrust::Ignored`] or [`LocalTrust::BlackListed`]
/// (see [`Device::set_local_trust`]).
///
/// The caller can then retry the encryption operation.
#[error("one or more users that were verified have changed their identity")]
VerifiedUserChangedIdentity(Vec<OwnedUserId>),
/// Cross-signing has not been configured on our own identity.
///
/// Happens only with [`CollectStrategy::IdentityBasedStrategy`].
/// (Cross-signing is required for encryption when using
/// `IdentityBasedStrategy`.) Apps should detect this condition and prevent
/// sending in the UI rather than waiting for this error to be returned when
/// encrypting.
#[error("Encryption failed because cross-signing is not set up on your account")]
CrossSigningNotSetup,
/// The current device has not been cross-signed by our own identity.
///
/// Happens only with [`CollectStrategy::IdentityBasedStrategy`].
/// (Cross-signing is required for encryption when using
/// `IdentityBasedStrategy`.) Apps should detect this condition and prevent
/// sending in the UI rather than waiting for this error to be returned when
/// encrypting.
#[error("Encryption failed because your device is not verified")]
SendingFromUnverifiedDevice,
}