use std::{
collections::HashMap,
sync::{Arc, RwLock as StdRwLock},
};
use ruma::{
events::{
key::verification::VerificationMethod, AnyToDeviceEvent, AnyToDeviceEventContent,
ToDeviceEvent,
},
serde::Raw,
uint, DeviceId, EventId, MilliSecondsSinceUnixEpoch, OwnedDeviceId, OwnedUserId, RoomId,
SecondsSinceUnixEpoch, TransactionId, UInt, UserId,
};
use tokio::sync::Mutex;
use tracing::{debug, info, instrument, trace, warn, Span};
use super::{
cache::{RequestInfo, VerificationCache},
event_enums::{AnyEvent, AnyVerificationContent, OutgoingContent},
requests::VerificationRequest,
sas::Sas,
FlowId, Verification, VerificationResult, VerificationStore,
};
use crate::{
olm::{PrivateCrossSigningIdentity, StaticAccountData},
store::{CryptoStoreError, CryptoStoreWrapper},
types::requests::{
OutgoingRequest, OutgoingVerificationRequest, RoomMessageRequest, ToDeviceRequest,
},
DeviceData, OtherUserIdentityData,
};
#[derive(Clone, Debug)]
pub struct VerificationMachine {
pub(crate) store: VerificationStore,
verifications: VerificationCache,
requests: Arc<StdRwLock<HashMap<OwnedUserId, HashMap<String, VerificationRequest>>>>,
}
impl VerificationMachine {
pub(crate) fn new(
account: StaticAccountData,
identity: Arc<Mutex<PrivateCrossSigningIdentity>>,
store: Arc<CryptoStoreWrapper>,
) -> Self {
Self {
store: VerificationStore { account, private_identity: identity, inner: store },
verifications: VerificationCache::new(),
requests: Default::default(),
}
}
pub(crate) fn own_user_id(&self) -> &UserId {
&self.store.account.user_id
}
pub(crate) fn own_device_id(&self) -> &DeviceId {
&self.store.account.device_id
}
pub(crate) fn request_to_device_verification(
&self,
user_id: &UserId,
recipient_devices: Vec<OwnedDeviceId>,
methods: Option<Vec<VerificationMethod>>,
) -> (VerificationRequest, OutgoingVerificationRequest) {
let flow_id = FlowId::from(TransactionId::new());
let verification = VerificationRequest::new(
self.verifications.clone(),
self.store.clone(),
flow_id,
user_id,
recipient_devices,
methods,
);
self.insert_request(verification.clone());
let request = verification.request_to_device();
(verification, request.into())
}
pub fn request_verification(
&self,
identity: &OtherUserIdentityData,
room_id: &RoomId,
request_event_id: &EventId,
methods: Option<Vec<VerificationMethod>>,
) -> VerificationRequest {
let flow_id = FlowId::InRoom(room_id.to_owned(), request_event_id.to_owned());
let request = VerificationRequest::new(
self.verifications.clone(),
self.store.clone(),
flow_id,
identity.user_id(),
vec![],
methods,
);
self.insert_request(request.clone());
request
}
pub async fn start_sas(
&self,
device: DeviceData,
) -> Result<(Sas, OutgoingVerificationRequest), CryptoStoreError> {
let identities = self.store.get_identities(device.clone()).await?;
let (sas, content) = Sas::start(identities, TransactionId::new(), true, None, None);
let request = match content {
OutgoingContent::Room(r, c) => {
RoomMessageRequest { room_id: r, txn_id: TransactionId::new(), content: c }.into()
}
OutgoingContent::ToDevice(c) => {
let request = ToDeviceRequest::with_id(
device.user_id(),
device.device_id().to_owned(),
&c,
TransactionId::new(),
);
self.verifications.insert_sas(sas.clone());
request.into()
}
};
Ok((sas, request))
}
pub fn get_request(
&self,
user_id: &UserId,
flow_id: impl AsRef<str>,
) -> Option<VerificationRequest> {
self.requests.read().unwrap().get(user_id)?.get(flow_id.as_ref()).cloned()
}
pub fn get_requests(&self, user_id: &UserId) -> Vec<VerificationRequest> {
self.requests
.read()
.unwrap()
.get(user_id)
.map(|v| v.iter().map(|(_, value)| value.clone()).collect())
.unwrap_or_default()
}
fn insert_request(&self, request: VerificationRequest) {
if let Some(r) = self.get_request(request.other_user(), request.flow_id().as_str()) {
debug!(flow_id = r.flow_id().as_str(), "Ignoring known verification request",);
return;
}
let mut requests = self.requests.write().unwrap();
let user_requests = requests.entry(request.other_user().to_owned()).or_default();
for old_verification in user_requests.values_mut() {
if !old_verification.is_cancelled() {
warn!(
"Received a new verification request whilst another request \
with the same user is ongoing. Cancelling both requests."
);
if let Some(r) = old_verification.cancel() {
self.verifications.add_request(r.into())
}
if let Some(r) = request.cancel() {
self.verifications.add_request(r.into())
}
}
}
user_requests.insert(request.flow_id().as_str().to_owned(), request);
}
pub fn get_verification(&self, user_id: &UserId, flow_id: &str) -> Option<Verification> {
self.verifications.get(user_id, flow_id)
}
pub fn get_sas(&self, user_id: &UserId, flow_id: &str) -> Option<Sas> {
self.verifications.get_sas(user_id, flow_id)
}
fn is_timestamp_valid(timestamp: MilliSecondsSinceUnixEpoch) -> bool {
let old_timestamp_threshold: UInt = uint!(600);
let timestamp_threshold: UInt = uint!(300);
let timestamp = timestamp.as_secs();
let now = SecondsSinceUnixEpoch::now().get();
!(now.saturating_sub(timestamp) > old_timestamp_threshold
|| timestamp.saturating_sub(now) > timestamp_threshold)
}
fn queue_up_content(
&self,
recipient: &UserId,
recipient_device: &DeviceId,
content: OutgoingContent,
request_id: Option<RequestInfo>,
) {
self.verifications.queue_up_content(recipient, recipient_device, content, request_id)
}
pub fn mark_request_as_sent(&self, request_id: &TransactionId) {
self.verifications.mark_request_as_sent(request_id);
}
pub fn outgoing_messages(&self) -> Vec<OutgoingRequest> {
self.verifications.outgoing_requests()
}
pub fn garbage_collect(&self) -> Vec<Raw<AnyToDeviceEvent>> {
let mut events = vec![];
let mut requests: Vec<OutgoingVerificationRequest> = {
let mut requests = self.requests.write().unwrap();
for user_verification in requests.values_mut() {
user_verification.retain(|_, v| !(v.is_done() || v.is_cancelled()));
}
requests.retain(|_, v| !v.is_empty());
requests.values().flatten().filter_map(|(_, v)| v.cancel_if_timed_out()).collect()
};
requests.extend(self.verifications.garbage_collect());
for request in requests {
if let Ok(OutgoingContent::ToDevice(AnyToDeviceEventContent::KeyVerificationCancel(
content,
))) = request.clone().try_into()
{
let event = ToDeviceEvent { content, sender: self.own_user_id().to_owned() };
events.push(
Raw::new(&event)
.expect("Failed to serialize m.key_verification.cancel event")
.cast(),
);
}
self.verifications.add_verification_request(request)
}
events
}
async fn mark_sas_as_done(
&self,
sas: &Sas,
out_content: Option<OutgoingContent>,
) -> Result<(), CryptoStoreError> {
match sas.mark_as_done().await? {
VerificationResult::Ok => {
if let Some(c) = out_content {
self.queue_up_content(sas.other_user_id(), sas.other_device_id(), c, None);
}
}
VerificationResult::Cancel(c) => {
if let Some(r) = sas.cancel_with_code(c) {
self.verifications.add_request(r.into());
}
}
VerificationResult::SignatureUpload(r) => {
self.verifications.add_request(r.into());
if let Some(c) = out_content {
self.queue_up_content(sas.other_user_id(), sas.other_device_id(), c, None);
}
}
}
Ok(())
}
#[instrument(skip_all, fields(flow_id))]
pub async fn receive_any_event(
&self,
event: impl Into<AnyEvent<'_>>,
) -> Result<(), CryptoStoreError> {
let event = event.into();
let Ok(flow_id) = FlowId::try_from(&event) else {
return Ok(());
};
Span::current().record("flow_id", flow_id.as_str());
let flow_id_mismatch = || {
warn!(
flow_id = flow_id.as_str(),
"Received a verification event with a mismatched flow id, \
the verification object was created for a in-room \
verification but an event was received over to-device \
messaging or vice versa"
);
};
let event_sent_from_us = |event: &AnyEvent<'_>, from_device: &DeviceId| {
if event.sender() == self.store.account.user_id {
from_device == self.store.account.device_id || event.is_room_event()
} else {
false
}
};
let Some(content) = event.verification_content() else { return Ok(()) };
match &content {
AnyVerificationContent::Request(r) => {
info!(
sender = ?event.sender(),
from_device = r.from_device().as_str(),
"Received a new verification request",
);
let Some(timestamp) = event.timestamp() else {
warn!(
from_device = r.from_device().as_str(),
"The key verification request didn't contain a valid timestamp"
);
return Ok(());
};
if !Self::is_timestamp_valid(timestamp) {
trace!(
from_device = r.from_device().as_str(),
?timestamp,
"The received verification request was too old or too far into the future",
);
return Ok(());
}
if event_sent_from_us(&event, r.from_device()) {
trace!(
from_device = r.from_device().as_str(),
"The received verification request was sent by us, ignoring it",
);
return Ok(());
}
let Some(device_data) =
self.store.get_device(event.sender(), r.from_device()).await?
else {
warn!("Could not retrieve the device data for the incoming verification request, ignoring it");
return Ok(());
};
let request = VerificationRequest::from_request(
self.verifications.clone(),
self.store.clone(),
event.sender(),
flow_id,
r,
device_data,
);
self.insert_request(request);
}
AnyVerificationContent::Cancel(c) => {
if let Some(verification) = self.get_request(event.sender(), flow_id.as_str()) {
verification.receive_cancel(event.sender(), c);
}
if let Some(verification) = self.get_verification(event.sender(), flow_id.as_str())
{
match verification {
Verification::SasV1(sas) => {
let _ = sas.receive_any_event(event.sender(), &content);
}
#[cfg(feature = "qrcode")]
Verification::QrV1(qr) => qr.receive_cancel(event.sender(), c),
}
}
}
AnyVerificationContent::Ready(c) => {
let Some(request) = self.get_request(event.sender(), flow_id.as_str()) else {
return Ok(());
};
if request.flow_id() == &flow_id {
if let Some(device_data) =
self.store.get_device(event.sender(), c.from_device()).await?
{
request.receive_ready(event.sender(), c, device_data);
} else {
warn!("Could not retrieve the data for the accepting device, ignoring it");
}
} else {
flow_id_mismatch();
}
}
AnyVerificationContent::Start(c) => {
if let Some(request) = self.get_request(event.sender(), flow_id.as_str()) {
if request.flow_id() == &flow_id {
Box::pin(request.receive_start(event.sender(), c)).await?
} else {
flow_id_mismatch();
}
} else if let FlowId::ToDevice(_) = flow_id {
if let Some(device) =
self.store.get_device(event.sender(), c.from_device()).await?
{
let identities = self.store.get_identities(device).await?;
match Sas::from_start_event(flow_id, c, identities, None, false) {
Ok(sas) => {
self.verifications.insert_sas(sas);
}
Err(cancellation) => self.queue_up_content(
event.sender(),
c.from_device(),
cancellation,
None,
),
}
}
}
}
AnyVerificationContent::Accept(_) | AnyVerificationContent::Key(_) => {
let Some(sas) = self.get_sas(event.sender(), flow_id.as_str()) else {
return Ok(());
};
if sas.flow_id() != &flow_id {
flow_id_mismatch();
return Ok(());
}
let Some((content, request_info)) = sas.receive_any_event(event.sender(), &content)
else {
return Ok(());
};
self.queue_up_content(
sas.other_user_id(),
sas.other_device_id(),
content,
request_info,
);
}
AnyVerificationContent::Mac(_) => {
let Some(s) = self.get_sas(event.sender(), flow_id.as_str()) else { return Ok(()) };
if s.flow_id() != &flow_id {
flow_id_mismatch();
return Ok(());
}
let content = s.receive_any_event(event.sender(), &content);
if s.is_done() {
Box::pin(self.mark_sas_as_done(&s, content.map(|(c, _)| c))).await?;
} else {
let Some((content, request_id)) = content else { return Ok(()) };
self.queue_up_content(
s.other_user_id(),
s.other_device_id(),
content,
request_id,
);
}
}
AnyVerificationContent::Done(c) => {
if let Some(verification) = self.get_request(event.sender(), flow_id.as_str()) {
verification.receive_done(event.sender(), c);
}
#[allow(clippy::single_match)]
match self.get_verification(event.sender(), flow_id.as_str()) {
Some(Verification::SasV1(sas)) => {
let content = sas.receive_any_event(event.sender(), &content);
if sas.is_done() {
Box::pin(self.mark_sas_as_done(&sas, content.map(|(c, _)| c))).await?;
}
}
#[cfg(feature = "qrcode")]
Some(Verification::QrV1(qr)) => {
let (cancellation, request) = Box::pin(qr.receive_done(c)).await?;
if let Some(c) = cancellation {
self.verifications.add_request(c.into())
}
if let Some(s) = request {
self.verifications.add_request(s.into())
}
}
None => {}
}
}
}
Ok(())
}
}
#[cfg(test)]
mod tests {
use std::sync::Arc;
use matrix_sdk_test::async_test;
use ruma::TransactionId;
use tokio::sync::Mutex;
use super::{Sas, VerificationMachine};
use crate::{
olm::PrivateCrossSigningIdentity,
store::{CryptoStoreWrapper, MemoryStore},
verification::{
cache::VerificationCache,
event_enums::{AcceptContent, KeyContent, MacContent, OutgoingContent},
tests::{alice_device_id, alice_id, setup_stores, wrap_any_to_device_content},
FlowId, VerificationStore,
},
Account, VerificationRequest,
};
async fn verification_machine() -> (VerificationMachine, VerificationStore) {
let (_account, store, _bob, bob_store) = setup_stores().await;
let machine = VerificationMachine {
store,
verifications: VerificationCache::new(),
requests: Default::default(),
};
(machine, bob_store)
}
async fn setup_verification_machine() -> (VerificationMachine, Sas) {
let (machine, bob_store) = verification_machine().await;
let alice_device =
bob_store.get_device(alice_id(), alice_device_id()).await.unwrap().unwrap();
let identities = bob_store.get_identities(alice_device).await.unwrap();
let (bob_sas, start_content) =
Sas::start(identities, TransactionId::new(), true, None, None);
machine
.receive_any_event(&wrap_any_to_device_content(bob_sas.user_id(), start_content))
.await
.unwrap();
(machine, bob_sas)
}
#[async_test]
async fn test_create() {
let alice = Account::with_device_id(alice_id(), alice_device_id());
let identity = Arc::new(Mutex::new(PrivateCrossSigningIdentity::empty(alice_id())));
let _ = VerificationMachine::new(
alice.static_data,
identity,
Arc::new(CryptoStoreWrapper::new(alice_id(), alice_device_id(), MemoryStore::new())),
);
}
#[async_test]
async fn test_full_flow() {
let (alice_machine, bob) = setup_verification_machine().await;
let alice = alice_machine.get_sas(bob.user_id(), bob.flow_id().as_str()).unwrap();
let request = alice.accept().unwrap();
let content = OutgoingContent::try_from(request).unwrap();
let content = AcceptContent::try_from(&content).unwrap().into();
let (content, request_info) = bob.receive_any_event(alice.user_id(), &content).unwrap();
let event = wrap_any_to_device_content(bob.user_id(), content);
assert!(alice_machine.verifications.outgoing_requests().is_empty());
alice_machine.receive_any_event(&event).await.unwrap();
assert!(!alice_machine.verifications.outgoing_requests().is_empty());
let request = alice_machine.verifications.outgoing_requests().first().cloned().unwrap();
let txn_id = request.request_id().to_owned();
let content = OutgoingContent::try_from(request).unwrap();
let content = KeyContent::try_from(&content).unwrap().into();
alice_machine.mark_request_as_sent(&txn_id);
assert!(bob.receive_any_event(alice.user_id(), &content).is_none());
assert!(alice.emoji().is_some());
assert!(bob.emoji().is_none());
bob.mark_request_as_sent(&request_info.unwrap().request_id);
assert!(bob.emoji().is_some());
assert_eq!(alice.emoji(), bob.emoji());
let mut requests = alice.confirm().await.unwrap().0;
assert!(requests.len() == 1);
let request = requests.pop().unwrap();
let content = OutgoingContent::try_from(request).unwrap();
let content = MacContent::try_from(&content).unwrap().into();
bob.receive_any_event(alice.user_id(), &content);
let mut requests = bob.confirm().await.unwrap().0;
assert!(requests.len() == 1);
let request = requests.pop().unwrap();
let content = OutgoingContent::try_from(request).unwrap();
let content = MacContent::try_from(&content).unwrap().into();
alice.receive_any_event(bob.user_id(), &content);
assert!(alice.is_done());
assert!(bob.is_done());
}
#[cfg(not(target_os = "macos"))]
#[allow(unknown_lints, clippy::unchecked_duration_subtraction)]
#[async_test]
async fn test_timing_out() {
use std::time::Duration;
use ruma::time::Instant;
let (alice_machine, bob) = setup_verification_machine().await;
let alice = alice_machine.get_sas(bob.user_id(), bob.flow_id().as_str()).unwrap();
assert!(!alice.timed_out());
assert!(alice_machine.verifications.outgoing_requests().is_empty());
alice.set_creation_time(Instant::now() - Duration::from_secs(60 * 15));
assert!(alice.timed_out());
assert!(alice_machine.verifications.outgoing_requests().is_empty());
alice_machine.garbage_collect();
assert!(!alice_machine.verifications.outgoing_requests().is_empty());
alice_machine.garbage_collect();
assert!(alice_machine.verifications.is_empty());
}
#[async_test]
async fn test_double_verification_cancellation() {
let (machine, bob_store) = verification_machine().await;
let alice_device =
bob_store.get_device(alice_id(), alice_device_id()).await.unwrap().unwrap();
let identities = bob_store.get_identities(alice_device).await.unwrap();
let (bob_sas, start_content) =
Sas::start(identities.clone(), TransactionId::new(), true, None, None);
machine
.receive_any_event(&wrap_any_to_device_content(bob_sas.user_id(), start_content))
.await
.unwrap();
let alice_sas = machine.get_sas(bob_sas.user_id(), bob_sas.flow_id().as_str()).unwrap();
assert!(!alice_sas.is_cancelled());
let second_transaction_id = TransactionId::new();
let (bob_sas, start_content) =
Sas::start(identities, second_transaction_id.clone(), true, None, None);
machine
.receive_any_event(&wrap_any_to_device_content(bob_sas.user_id(), start_content))
.await
.unwrap();
let second_sas = machine.get_sas(bob_sas.user_id(), bob_sas.flow_id().as_str()).unwrap();
assert_eq!(second_sas.flow_id().as_str(), second_transaction_id);
assert!(alice_sas.is_cancelled());
assert!(second_sas.is_cancelled());
}
#[async_test]
async fn test_double_verification_request_cancellation() {
let (machine, bob_store) = verification_machine().await;
let flow_id = FlowId::ToDevice("TEST_FLOW_ID".into());
let bob_request = VerificationRequest::new(
VerificationCache::new(),
bob_store.clone(),
flow_id.clone(),
alice_id(),
vec![],
None,
);
let request = bob_request.request_to_device();
let content: OutgoingContent = request.try_into().unwrap();
machine
.receive_any_event(&wrap_any_to_device_content(bob_request.own_user_id(), content))
.await
.unwrap();
let alice_request =
machine.get_request(bob_request.own_user_id(), bob_request.flow_id().as_str()).unwrap();
assert!(!alice_request.is_cancelled());
let second_transaction_id = TransactionId::new();
let bob_request = VerificationRequest::new(
VerificationCache::new(),
bob_store,
second_transaction_id.clone().into(),
alice_id(),
vec![],
None,
);
let request = bob_request.request_to_device();
let content: OutgoingContent = request.try_into().unwrap();
machine
.receive_any_event(&wrap_any_to_device_content(bob_request.own_user_id(), content))
.await
.unwrap();
let second_request =
machine.get_request(bob_request.own_user_id(), bob_request.flow_id().as_str()).unwrap();
assert_eq!(second_request.flow_id().as_str(), second_transaction_id);
assert!(alice_request.is_cancelled());
assert!(second_request.is_cancelled());
}
#[async_test]
async fn test_ignore_identical_verification_request() {
let (machine, bob_store) = verification_machine().await;
let flow_id = FlowId::ToDevice("TEST_FLOW_ID".into());
let bob_request = VerificationRequest::new(
VerificationCache::new(),
bob_store.clone(),
flow_id.clone(),
alice_id(),
vec![],
None,
);
let request = bob_request.request_to_device();
let content: OutgoingContent = request.try_into().unwrap();
machine
.receive_any_event(&wrap_any_to_device_content(bob_request.own_user_id(), content))
.await
.unwrap();
let first_request =
machine.get_request(bob_request.own_user_id(), bob_request.flow_id().as_str()).unwrap();
assert!(!first_request.is_cancelled());
let bob_request = VerificationRequest::new(
VerificationCache::new(),
bob_store,
flow_id.clone(),
alice_id(),
vec![],
None,
);
let request = bob_request.request_to_device();
let content: OutgoingContent = request.try_into().unwrap();
machine
.receive_any_event(&wrap_any_to_device_content(bob_request.own_user_id(), content))
.await
.unwrap();
let second_request =
machine.get_request(bob_request.own_user_id(), bob_request.flow_id().as_str()).unwrap();
assert!(!first_request.is_cancelled());
assert!(!second_request.is_cancelled());
}
}