atagen

matrix-rust-sdk

public
Star0
Watch0
ssh://brewery@pls.lobotomise.me:33/atagen/matrix-rust-sdk.git

Blame: bindings/matrix-sdk-ffi/src/utd.rs

7ff8adafe9e4atagen2026-10-22 12:30 UTC1
// Copyright 2025 The Matrix.org Foundation C.I.C.
7ff8adafe9e4atagen2026-10-22 12:30 UTC2
//
7ff8adafe9e4atagen2026-10-22 12:30 UTC3
// Licensed under the Apache License, Version 2.0 (the "License");
7ff8adafe9e4atagen2026-10-22 12:30 UTC4
// you may not use this file except in compliance with the License.
7ff8adafe9e4atagen2026-10-22 12:30 UTC5
// You may obtain a copy of the License at
7ff8adafe9e4atagen2026-10-22 12:30 UTC6
//
7ff8adafe9e4atagen2026-10-22 12:30 UTC7
//     http://www.apache.org/licenses/LICENSE-2.0
7ff8adafe9e4atagen2026-10-22 12:30 UTC8
//
7ff8adafe9e4atagen2026-10-22 12:30 UTC9
// Unless required by applicable law or agreed to in writing, software
7ff8adafe9e4atagen2026-10-22 12:30 UTC10
// distributed under the License is distributed on an "AS IS" BASIS,
7ff8adafe9e4atagen2026-10-22 12:30 UTC11
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
7ff8adafe9e4atagen2026-10-22 12:30 UTC12
// See the License for the specific language governing permissions and
7ff8adafe9e4atagen2026-10-22 12:30 UTC13
// limitations under the License.
7ff8adafe9e4atagen2026-10-22 12:30 UTC14
7ff8adafe9e4atagen2026-10-22 12:30 UTC15
use std::{fmt::Debug, sync::Arc, time::Duration};
7ff8adafe9e4atagen2026-10-22 12:30 UTC16
7ff8adafe9e4atagen2026-10-22 12:30 UTC17
use matrix_sdk_base::crypto::types::events::UtdCause;
7ff8adafe9e4atagen2026-10-22 12:30 UTC18
use matrix_sdk_common::{SendOutsideWasm, SyncOutsideWasm};
7ff8adafe9e4atagen2026-10-22 12:30 UTC19
use matrix_sdk_ui::unable_to_decrypt_hook::{
7ff8adafe9e4atagen2026-10-22 12:30 UTC20
    UnableToDecryptHook, UnableToDecryptInfo as SdkUnableToDecryptInfo,
7ff8adafe9e4atagen2026-10-22 12:30 UTC21
};
7ff8adafe9e4atagen2026-10-22 12:30 UTC22
7ff8adafe9e4atagen2026-10-22 12:30 UTC23
#[matrix_sdk_ffi_macros::export(callback_interface)]
7ff8adafe9e4atagen2026-10-22 12:30 UTC24
pub trait UnableToDecryptDelegate: SyncOutsideWasm + SendOutsideWasm {
7ff8adafe9e4atagen2026-10-22 12:30 UTC25
    fn on_utd(&self, info: UnableToDecryptInfo);
7ff8adafe9e4atagen2026-10-22 12:30 UTC26
}
7ff8adafe9e4atagen2026-10-22 12:30 UTC27
7ff8adafe9e4atagen2026-10-22 12:30 UTC28
pub struct UtdHook {
7ff8adafe9e4atagen2026-10-22 12:30 UTC29
    pub delegate: Arc<dyn UnableToDecryptDelegate>,
7ff8adafe9e4atagen2026-10-22 12:30 UTC30
}
7ff8adafe9e4atagen2026-10-22 12:30 UTC31
7ff8adafe9e4atagen2026-10-22 12:30 UTC32
impl std::fmt::Debug for UtdHook {
7ff8adafe9e4atagen2026-10-22 12:30 UTC33
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
7ff8adafe9e4atagen2026-10-22 12:30 UTC34
        f.debug_struct("UtdHook").finish_non_exhaustive()
7ff8adafe9e4atagen2026-10-22 12:30 UTC35
    }
7ff8adafe9e4atagen2026-10-22 12:30 UTC36
}
7ff8adafe9e4atagen2026-10-22 12:30 UTC37
7ff8adafe9e4atagen2026-10-22 12:30 UTC38
impl UnableToDecryptHook for UtdHook {
7ff8adafe9e4atagen2026-10-22 12:30 UTC39
    fn on_utd(&self, info: SdkUnableToDecryptInfo) {
7ff8adafe9e4atagen2026-10-22 12:30 UTC40
        const IGNORE_UTD_PERIOD: Duration = Duration::from_secs(4);
7ff8adafe9e4atagen2026-10-22 12:30 UTC41
7ff8adafe9e4atagen2026-10-22 12:30 UTC42
        // UTDs that have been decrypted in the `IGNORE_UTD_PERIOD` are just ignored and
7ff8adafe9e4atagen2026-10-22 12:30 UTC43
        // not considered UTDs.
7ff8adafe9e4atagen2026-10-22 12:30 UTC44
        if let Some(duration) = &info.time_to_decrypt
7ff8adafe9e4atagen2026-10-22 12:30 UTC45
            && *duration < IGNORE_UTD_PERIOD
7ff8adafe9e4atagen2026-10-22 12:30 UTC46
        {
7ff8adafe9e4atagen2026-10-22 12:30 UTC47
            return;
7ff8adafe9e4atagen2026-10-22 12:30 UTC48
        }
7ff8adafe9e4atagen2026-10-22 12:30 UTC49
7ff8adafe9e4atagen2026-10-22 12:30 UTC50
        // Report the UTD to the client.
7ff8adafe9e4atagen2026-10-22 12:30 UTC51
        self.delegate.on_utd(info.into());
7ff8adafe9e4atagen2026-10-22 12:30 UTC52
    }
7ff8adafe9e4atagen2026-10-22 12:30 UTC53
}
7ff8adafe9e4atagen2026-10-22 12:30 UTC54
7ff8adafe9e4atagen2026-10-22 12:30 UTC55
#[derive(uniffi::Record)]
7ff8adafe9e4atagen2026-10-22 12:30 UTC56
pub struct UnableToDecryptInfo {
7ff8adafe9e4atagen2026-10-22 12:30 UTC57
    /// The identifier of the event that couldn't get decrypted.
7ff8adafe9e4atagen2026-10-22 12:30 UTC58
    event_id: String,
7ff8adafe9e4atagen2026-10-22 12:30 UTC59
7ff8adafe9e4atagen2026-10-22 12:30 UTC60
    /// If the event could be decrypted late (that is, the event was encrypted
7ff8adafe9e4atagen2026-10-22 12:30 UTC61
    /// at first, but could be decrypted later on), then this indicates the
7ff8adafe9e4atagen2026-10-22 12:30 UTC62
    /// time it took to decrypt the event. If it is not set, this is
7ff8adafe9e4atagen2026-10-22 12:30 UTC63
    /// considered a definite UTD.
7ff8adafe9e4atagen2026-10-22 12:30 UTC64
    ///
7ff8adafe9e4atagen2026-10-22 12:30 UTC65
    /// If set, this is in milliseconds.
7ff8adafe9e4atagen2026-10-22 12:30 UTC66
    pub time_to_decrypt_ms: Option<u64>,
7ff8adafe9e4atagen2026-10-22 12:30 UTC67
7ff8adafe9e4atagen2026-10-22 12:30 UTC68
    /// What we know about what caused this UTD. E.g. was this event sent when
7ff8adafe9e4atagen2026-10-22 12:30 UTC69
    /// we were not a member of this room?
7ff8adafe9e4atagen2026-10-22 12:30 UTC70
    pub cause: UtdCause,
7ff8adafe9e4atagen2026-10-22 12:30 UTC71
7ff8adafe9e4atagen2026-10-22 12:30 UTC72
    /// The difference between the event creation time (`origin_server_ts`) and
7ff8adafe9e4atagen2026-10-22 12:30 UTC73
    /// the time our device was created. If negative, this event was sent
7ff8adafe9e4atagen2026-10-22 12:30 UTC74
    /// *before* our device was created.
7ff8adafe9e4atagen2026-10-22 12:30 UTC75
    pub event_local_age_millis: i64,
7ff8adafe9e4atagen2026-10-22 12:30 UTC76
7ff8adafe9e4atagen2026-10-22 12:30 UTC77
    /// Whether the user had verified their own identity at the point they
7ff8adafe9e4atagen2026-10-22 12:30 UTC78
    /// received the UTD event.
7ff8adafe9e4atagen2026-10-22 12:30 UTC79
    pub user_trusts_own_identity: bool,
7ff8adafe9e4atagen2026-10-22 12:30 UTC80
7ff8adafe9e4atagen2026-10-22 12:30 UTC81
    /// The homeserver of the user that sent the undecryptable event.
7ff8adafe9e4atagen2026-10-22 12:30 UTC82
    pub sender_homeserver: String,
7ff8adafe9e4atagen2026-10-22 12:30 UTC83
7ff8adafe9e4atagen2026-10-22 12:30 UTC84
    /// Our local user's own homeserver, or `None` if the client is not logged
7ff8adafe9e4atagen2026-10-22 12:30 UTC85
    /// in.
7ff8adafe9e4atagen2026-10-22 12:30 UTC86
    pub own_homeserver: Option<String>,
7ff8adafe9e4atagen2026-10-22 12:30 UTC87
}
7ff8adafe9e4atagen2026-10-22 12:30 UTC88
7ff8adafe9e4atagen2026-10-22 12:30 UTC89
impl From<SdkUnableToDecryptInfo> for UnableToDecryptInfo {
7ff8adafe9e4atagen2026-10-22 12:30 UTC90
    fn from(value: SdkUnableToDecryptInfo) -> Self {
7ff8adafe9e4atagen2026-10-22 12:30 UTC91
        Self {
7ff8adafe9e4atagen2026-10-22 12:30 UTC92
            event_id: value.event_id.to_string(),
7ff8adafe9e4atagen2026-10-22 12:30 UTC93
            time_to_decrypt_ms: value.time_to_decrypt.map(|ttd| ttd.as_millis() as u64),
7ff8adafe9e4atagen2026-10-22 12:30 UTC94
            cause: value.cause,
7ff8adafe9e4atagen2026-10-22 12:30 UTC95
            event_local_age_millis: value.event_local_age_millis,
7ff8adafe9e4atagen2026-10-22 12:30 UTC96
            user_trusts_own_identity: value.user_trusts_own_identity,
7ff8adafe9e4atagen2026-10-22 12:30 UTC97
            sender_homeserver: value.sender_homeserver.to_string(),
7ff8adafe9e4atagen2026-10-22 12:30 UTC98
            own_homeserver: value.own_homeserver.map(String::from),
7ff8adafe9e4atagen2026-10-22 12:30 UTC99
        }
7ff8adafe9e4atagen2026-10-22 12:30 UTC100
    }
7ff8adafe9e4atagen2026-10-22 12:30 UTC101
}