use std::{ops::Add, sync::Arc, time::Duration};
use as_variant::as_variant;
use eyeball::{ObservableWriteGuard, SharedObservable, WeakObservable};
use futures_core::Stream;
use futures_util::StreamExt;
#[cfg(feature = "qrcode")]
use matrix_sdk_qrcode::QrVerificationData;
use ruma::{
events::{
key::verification::{
cancel::CancelCode,
ready::{KeyVerificationReadyEventContent, ToDeviceKeyVerificationReadyEventContent},
request::ToDeviceKeyVerificationRequestEventContent,
start::StartMethod,
VerificationMethod,
},
relation::Reference,
room::message::KeyVerificationRequestEventContent,
AnyMessageLikeEventContent, AnyToDeviceEventContent,
},
time::Instant,
to_device::DeviceIdOrAllDevices,
DeviceId, MilliSecondsSinceUnixEpoch, OwnedDeviceId, OwnedUserId, RoomId, TransactionId,
UserId,
};
#[cfg(feature = "qrcode")]
use tracing::debug;
use tracing::{info, trace, warn};
#[cfg(feature = "qrcode")]
use super::qrcode::{QrVerification, QrVerificationState, ScanError};
use super::{
cache::VerificationCache,
event_enums::{
CancelContent, DoneContent, OutgoingContent, ReadyContent, RequestContent, StartContent,
},
CancelInfo, Cancelled, FlowId, Verification, VerificationStore,
};
use crate::{
olm::StaticAccountData,
types::requests::{OutgoingVerificationRequest, RoomMessageRequest, ToDeviceRequest},
CryptoStoreError, DeviceData, Sas,
};
const SUPPORTED_METHODS: &[VerificationMethod] = &[
VerificationMethod::SasV1,
#[cfg(feature = "qrcode")]
VerificationMethod::QrCodeShowV1,
VerificationMethod::ReciprocateV1,
];
const VERIFICATION_TIMEOUT: Duration = Duration::from_secs(60 * 10);
#[derive(Debug, Clone)]
pub enum VerificationRequestState {
Created {
our_methods: Vec<VerificationMethod>,
},
Requested {
their_methods: Vec<VerificationMethod>,
other_device_data: DeviceData,
},
Ready {
their_methods: Vec<VerificationMethod>,
our_methods: Vec<VerificationMethod>,
other_device_data: DeviceData,
},
Transitioned {
verification: Verification,
other_device_data: DeviceData,
},
Done,
Cancelled(CancelInfo),
}
impl From<&InnerRequest> for VerificationRequestState {
fn from(value: &InnerRequest) -> Self {
match value {
InnerRequest::Created(s) => {
Self::Created { our_methods: s.state.our_methods.to_owned() }
}
InnerRequest::Requested(s) => Self::Requested {
their_methods: s.state.their_methods.to_owned(),
other_device_data: s.state.other_device_data.to_owned(),
},
InnerRequest::Ready(s) => Self::Ready {
their_methods: s.state.their_methods.to_owned(),
our_methods: s.state.our_methods.to_owned(),
other_device_data: s.state.other_device_data.to_owned(),
},
InnerRequest::Transitioned(s) => Self::Transitioned {
verification: s.state.verification.to_owned(),
other_device_data: s.state.other_device_data.to_owned(),
},
InnerRequest::Passive(_) => {
Self::Cancelled(Cancelled::new(true, CancelCode::Accepted).into())
}
InnerRequest::Done(_) => Self::Done,
InnerRequest::Cancelled(s) => Self::Cancelled(s.state.to_owned().into()),
}
}
}
#[derive(Clone, Debug)]
pub struct VerificationRequest {
verification_cache: VerificationCache,
account: StaticAccountData,
flow_id: Arc<FlowId>,
other_user_id: OwnedUserId,
inner: SharedObservable<InnerRequest>,
creation_time: Arc<Instant>,
we_started: bool,
recipient_devices: Arc<Vec<OwnedDeviceId>>,
}
#[derive(Debug, Clone)]
pub(crate) struct RequestHandle {
inner: WeakObservable<InnerRequest>,
}
impl RequestHandle {
pub fn cancel_with_code(&self, cancel_code: &CancelCode) {
if let Some(observable) = self.inner.upgrade() {
let mut guard = observable.write();
if let Some(updated) = guard.cancel(true, cancel_code) {
ObservableWriteGuard::set(&mut guard, updated);
}
}
}
}
impl From<SharedObservable<InnerRequest>> for RequestHandle {
fn from(inner: SharedObservable<InnerRequest>) -> Self {
let inner = inner.downgrade();
Self { inner }
}
}
impl VerificationRequest {
pub(crate) fn new(
cache: VerificationCache,
store: VerificationStore,
flow_id: FlowId,
other_user: &UserId,
recipient_devices: Vec<OwnedDeviceId>,
methods: Option<Vec<VerificationMethod>>,
) -> Self {
let account = store.account.clone();
let inner = SharedObservable::new(InnerRequest::Created(RequestState::new(
cache.clone(),
store,
other_user,
&flow_id,
methods,
)));
Self {
account,
verification_cache: cache,
flow_id: flow_id.into(),
inner,
other_user_id: other_user.into(),
creation_time: Instant::now().into(),
we_started: true,
recipient_devices: recipient_devices.into(),
}
}
pub(crate) fn request_to_device(&self) -> ToDeviceRequest {
let inner = self.inner.read();
let methods = if let InnerRequest::Created(c) = &*inner {
c.state.our_methods.clone()
} else {
SUPPORTED_METHODS.to_vec()
};
let content = ToDeviceKeyVerificationRequestEventContent::new(
self.account.device_id.clone(),
self.flow_id().as_str().into(),
methods,
MilliSecondsSinceUnixEpoch::now(),
);
ToDeviceRequest::for_recipients(
self.other_user(),
self.recipient_devices.to_vec(),
&AnyToDeviceEventContent::KeyVerificationRequest(content),
TransactionId::new(),
)
}
pub fn request(
own_user_id: &UserId,
own_device_id: &DeviceId,
other_user_id: &UserId,
methods: Option<Vec<VerificationMethod>>,
) -> KeyVerificationRequestEventContent {
KeyVerificationRequestEventContent::new(
format!(
"{own_user_id} is requesting to verify your key, but your client does not \
support in-chat key verification. You will need to use legacy \
key verification to verify keys."
),
methods.unwrap_or_else(|| SUPPORTED_METHODS.to_vec()),
own_device_id.into(),
other_user_id.to_owned(),
)
}
pub fn own_user_id(&self) -> &UserId {
&self.account.user_id
}
pub fn other_user(&self) -> &UserId {
&self.other_user_id
}
pub fn other_device_id(&self) -> Option<OwnedDeviceId> {
match &*self.inner.read() {
InnerRequest::Requested(r) => Some(r.state.other_device_data.device_id().to_owned()),
InnerRequest::Ready(r) => Some(r.state.other_device_data.device_id().to_owned()),
InnerRequest::Transitioned(r) => {
Some(r.state.ready.other_device_data.device_id().to_owned())
}
InnerRequest::Created(_)
| InnerRequest::Passive(_)
| InnerRequest::Done(_)
| InnerRequest::Cancelled(_) => None,
}
}
pub fn room_id(&self) -> Option<&RoomId> {
match self.flow_id.as_ref() {
FlowId::ToDevice(_) => None,
FlowId::InRoom(r, _) => Some(r),
}
}
pub fn cancel_info(&self) -> Option<CancelInfo> {
as_variant!(&*self.inner.read(), InnerRequest::Cancelled(c) => {
c.state.clone().into()
})
}
pub fn is_passive(&self) -> bool {
matches!(*self.inner.read(), InnerRequest::Passive(_))
}
pub fn is_ready(&self) -> bool {
matches!(*self.inner.read(), InnerRequest::Ready(_))
}
pub fn timed_out(&self) -> bool {
self.creation_time.elapsed() > VERIFICATION_TIMEOUT
}
pub fn time_remaining(&self) -> Duration {
self.creation_time
.add(VERIFICATION_TIMEOUT)
.checked_duration_since(Instant::now())
.unwrap_or(Duration::from_secs(0))
}
pub fn their_supported_methods(&self) -> Option<Vec<VerificationMethod>> {
match &*self.inner.read() {
InnerRequest::Requested(r) => Some(r.state.their_methods.clone()),
InnerRequest::Ready(r) => Some(r.state.their_methods.clone()),
InnerRequest::Transitioned(r) => Some(r.state.ready.their_methods.clone()),
InnerRequest::Created(_)
| InnerRequest::Passive(_)
| InnerRequest::Done(_)
| InnerRequest::Cancelled(_) => None,
}
}
pub fn our_supported_methods(&self) -> Option<Vec<VerificationMethod>> {
match &*self.inner.read() {
InnerRequest::Created(r) => Some(r.state.our_methods.clone()),
InnerRequest::Ready(r) => Some(r.state.our_methods.clone()),
InnerRequest::Transitioned(r) => Some(r.state.ready.our_methods.clone()),
InnerRequest::Requested(_)
| InnerRequest::Passive(_)
| InnerRequest::Done(_)
| InnerRequest::Cancelled(_) => None,
}
}
pub fn flow_id(&self) -> &FlowId {
&self.flow_id
}
pub fn is_self_verification(&self) -> bool {
self.account.user_id == self.other_user()
}
pub fn we_started(&self) -> bool {
self.we_started
}
pub fn is_done(&self) -> bool {
matches!(*self.inner.read(), InnerRequest::Done(_))
}
pub fn is_cancelled(&self) -> bool {
matches!(*self.inner.read(), InnerRequest::Cancelled(_))
}
#[cfg(feature = "qrcode")]
pub async fn generate_qr_code(&self) -> Result<Option<QrVerification>, CryptoStoreError> {
let inner = self.inner.get();
let ret = if let Some((state, verification)) =
inner.generate_qr_code(self.we_started, self.inner.clone().into()).await?
{
let mut inner = self.inner.write();
ObservableWriteGuard::set(&mut inner, InnerRequest::Transitioned(state));
Some(verification)
} else {
None
};
Ok(ret)
}
#[cfg(feature = "qrcode")]
pub async fn scan_qr_code(
&self,
data: QrVerificationData,
) -> Result<Option<QrVerification>, ScanError> {
let inner = self.inner.read().to_owned();
let (new_state, qr_verification) = match inner {
InnerRequest::Ready(r) => {
scan_qr_code(data, &r, &r.state, self.we_started, self.inner.to_owned().into())
.await?
}
InnerRequest::Transitioned(r) => {
scan_qr_code(
data,
&r,
&r.state.ready,
self.we_started,
self.inner.to_owned().into(),
)
.await?
}
_ => return Ok(None),
};
if self
.verification_cache
.get_qr(qr_verification.other_user_id(), qr_verification.flow_id().as_str())
.is_some()
{
self.verification_cache.replace_qr(qr_verification.clone());
} else {
self.verification_cache.insert_qr(qr_verification.clone());
}
let mut guard = self.inner.write();
ObservableWriteGuard::set(&mut guard, InnerRequest::Transitioned(new_state));
Ok(Some(qr_verification))
}
pub(crate) fn from_request(
cache: VerificationCache,
store: VerificationStore,
sender: &UserId,
flow_id: FlowId,
content: &RequestContent<'_>,
device_data: DeviceData,
) -> Self {
let account = store.account.clone();
Self {
verification_cache: cache.clone(),
inner: SharedObservable::new(InnerRequest::Requested(
RequestState::from_request_event(
cache,
store,
sender,
&flow_id,
content,
device_data,
),
)),
account,
other_user_id: sender.into(),
flow_id: flow_id.into(),
we_started: false,
creation_time: Instant::now().into(),
recipient_devices: vec![].into(),
}
}
pub fn accept_with_methods(
&self,
methods: Vec<VerificationMethod>,
) -> Option<OutgoingVerificationRequest> {
let mut guard = self.inner.write();
let (updated, content) = guard.accept(methods)?;
ObservableWriteGuard::set(&mut guard, updated);
let request = match content {
OutgoingContent::ToDevice(content) => ToDeviceRequest::with_id(
self.other_user(),
guard.other_device_id(),
&content,
TransactionId::new(),
)
.into(),
OutgoingContent::Room(room_id, content) => {
RoomMessageRequest { room_id, txn_id: TransactionId::new(), content }.into()
}
};
Some(request)
}
pub fn accept(&self) -> Option<OutgoingVerificationRequest> {
self.accept_with_methods(SUPPORTED_METHODS.to_vec())
}
pub fn cancel(&self) -> Option<OutgoingVerificationRequest> {
self.cancel_with_code(CancelCode::User)
}
fn cancel_with_code(&self, cancel_code: CancelCode) -> Option<OutgoingVerificationRequest> {
let mut guard = self.inner.write();
let send_to_everyone = self.we_started() && matches!(*guard, InnerRequest::Created(_));
let other_device = guard.other_device_id();
if let Some(updated) = guard.cancel(true, &cancel_code) {
ObservableWriteGuard::set(&mut guard, updated);
}
let content = as_variant!(&*guard, InnerRequest::Cancelled(c) => {
c.state.as_content(self.flow_id())
});
let request = content.map(|c| match c {
OutgoingContent::ToDevice(content) => {
if send_to_everyone {
ToDeviceRequest::for_recipients(
self.other_user(),
self.recipient_devices.to_vec(),
&content,
TransactionId::new(),
)
.into()
} else {
ToDeviceRequest::with_id(
self.other_user(),
other_device,
&content,
TransactionId::new(),
)
.into()
}
}
OutgoingContent::Room(room_id, content) => {
RoomMessageRequest { room_id, txn_id: TransactionId::new(), content }.into()
}
});
drop(guard);
if let Some(verification) =
self.verification_cache.get(self.other_user(), self.flow_id().as_str())
{
match verification {
Verification::SasV1(s) => s.cancel_with_code(cancel_code),
#[cfg(feature = "qrcode")]
Verification::QrV1(q) => q.cancel_with_code(cancel_code),
};
}
request
}
pub(crate) fn cancel_if_timed_out(&self) -> Option<OutgoingVerificationRequest> {
if self.is_cancelled() || self.is_done() {
None
} else if self.timed_out() {
let request = self.cancel_with_code(CancelCode::Timeout);
if self.is_passive() {
None
} else {
trace!(
other_user = self.other_user().as_str(),
flow_id = self.flow_id().as_str(),
"Timing a verification request out"
);
request
}
} else {
None
}
}
pub(crate) fn cancel_for_other_devices(
&self,
code: CancelCode,
filter_device: Option<&DeviceId>,
) -> Option<ToDeviceRequest> {
let cancelled = Cancelled::new(true, code);
let cancel_content = cancelled.as_content(self.flow_id());
let OutgoingContent::ToDevice(c) = cancel_content else { return None };
let recip_devices: Vec<OwnedDeviceId> = self
.recipient_devices
.iter()
.filter(|&d| filter_device.map_or(true, |device| **d != *device))
.cloned()
.collect();
if recip_devices.is_empty() && filter_device.is_some() {
return None;
}
let recipient = self.other_user();
Some(ToDeviceRequest::for_recipients(recipient, recip_devices, &c, TransactionId::new()))
}
pub(crate) fn receive_ready(
&self,
sender: &UserId,
content: &ReadyContent<'_>,
from_device_data: DeviceData,
) {
let mut guard = self.inner.write();
match &*guard {
InnerRequest::Created(s) => {
let new_value =
InnerRequest::Ready(s.clone().into_ready(sender, content, from_device_data));
ObservableWriteGuard::set(&mut guard, new_value);
if let Some(request) =
self.cancel_for_other_devices(CancelCode::Accepted, Some(content.from_device()))
{
self.verification_cache.add_verification_request(request.into());
}
}
InnerRequest::Requested(s) => {
if sender == self.own_user_id() && content.from_device() != self.account.device_id {
let new_value = InnerRequest::Passive(s.clone().into_passive(content));
ObservableWriteGuard::set(&mut guard, new_value);
}
}
InnerRequest::Ready(_)
| InnerRequest::Transitioned(_)
| InnerRequest::Passive(_)
| InnerRequest::Done(_)
| InnerRequest::Cancelled(_) => {}
}
}
pub(crate) async fn receive_start(
&self,
sender: &UserId,
content: &StartContent<'_>,
) -> Result<(), CryptoStoreError> {
let inner = self.inner.get();
match &inner {
InnerRequest::Created(_)
| InnerRequest::Requested(_)
| InnerRequest::Passive(_)
| InnerRequest::Done(_)
| InnerRequest::Cancelled(_) => {
warn!(
?sender,
device_id = content.from_device().as_str(),
"Received a key verification start event but we're not yet in the ready state"
);
Ok(())
}
InnerRequest::Ready(s) => {
let s = s.clone();
if let Some(new_state) = s
.receive_start(sender, content, self.we_started, self.inner.clone().into())
.await?
{
let mut inner = self.inner.write();
ObservableWriteGuard::set(&mut inner, InnerRequest::Transitioned(new_state));
}
Ok(())
}
InnerRequest::Transitioned(s) => {
let s = s.clone();
if let Some(new_state) = s
.receive_start(sender, content, self.we_started, self.inner.clone().into())
.await?
{
let mut inner = self.inner.write();
ObservableWriteGuard::set(&mut inner, InnerRequest::Transitioned(new_state));
}
Ok(())
}
}
}
pub(crate) fn receive_done(&self, sender: &UserId, content: &DoneContent<'_>) {
if sender == self.other_user() {
trace!(
other_user = ?self.other_user(),
flow_id = self.flow_id().as_str(),
"Marking a verification request as done"
);
let mut guard = self.inner.write();
if let Some(updated) = guard.receive_done(content) {
ObservableWriteGuard::set(&mut guard, updated);
}
}
}
pub(crate) fn receive_cancel(&self, sender: &UserId, content: &CancelContent<'_>) {
if sender != self.other_user() {
return;
}
trace!(
?sender,
code = content.cancel_code().as_str(),
"Cancelling a verification request, other user has cancelled"
);
let mut guard = self.inner.write();
if let Some(updated) = guard.cancel(false, content.cancel_code()) {
ObservableWriteGuard::set(&mut guard, updated);
}
if self.we_started() {
if let Some(request) =
self.cancel_for_other_devices(content.cancel_code().to_owned(), None)
{
self.verification_cache.add_verification_request(request.into());
}
}
}
fn start_sas_helper(
&self,
new_state: RequestState<Transitioned>,
sas: Sas,
content: OutgoingContent,
other_device_id: DeviceIdOrAllDevices,
) -> Option<(Sas, OutgoingVerificationRequest)> {
cfg_if::cfg_if! {
if #[cfg(feature = "qrcode")] {
if self.verification_cache.get_qr(sas.other_user_id(), sas.flow_id().as_str()).is_some() {
debug!(
user_id = ?self.other_user(),
flow_id = self.flow_id().as_str(),
"We have an ongoing QR verification, replacing with SAS"
);
self.verification_cache.replace(sas.clone().into())
} else {
self.verification_cache.insert_sas(sas.clone());
}
} else {
self.verification_cache.insert_sas(sas.clone());
}
}
let request = match content {
OutgoingContent::ToDevice(content) => ToDeviceRequest::with_id(
self.other_user(),
other_device_id,
&content,
TransactionId::new(),
)
.into(),
OutgoingContent::Room(room_id, content) => {
RoomMessageRequest { room_id, txn_id: TransactionId::new(), content }.into()
}
};
let mut guard = self.inner.write();
ObservableWriteGuard::set(&mut guard, InnerRequest::Transitioned(new_state));
Some((sas, request))
}
pub async fn start_sas(
&self,
) -> Result<Option<(Sas, OutgoingVerificationRequest)>, CryptoStoreError> {
let inner = self.inner.get();
let other_device_id = inner.other_device_id();
Ok(match &inner {
InnerRequest::Ready(s) => {
if let Some((new_state, sas, content)) =
s.start_sas(self.we_started, self.inner.clone().into()).await?
{
self.start_sas_helper(new_state, sas, content, other_device_id)
} else {
None
}
}
InnerRequest::Transitioned(s) => {
if let Some((new_state, sas, content)) =
s.start_sas(self.we_started, self.inner.clone().into()).await?
{
self.start_sas_helper(new_state, sas, content, other_device_id)
} else {
None
}
}
_ => None,
})
}
pub fn changes(&self) -> impl Stream<Item = VerificationRequestState> {
self.inner.subscribe().map(|s| (&s).into())
}
pub fn state(&self) -> VerificationRequestState {
(&*self.inner.read()).into()
}
}
#[derive(Clone, Debug)]
enum InnerRequest {
Created(RequestState<Created>),
Requested(RequestState<Requested>),
Ready(RequestState<Ready>),
Transitioned(RequestState<Transitioned>),
Passive(RequestState<Passive>),
#[allow(dead_code)] Done(RequestState<Done>),
Cancelled(RequestState<Cancelled>),
}
impl InnerRequest {
fn other_device_id(&self) -> DeviceIdOrAllDevices {
match self {
InnerRequest::Created(_) => DeviceIdOrAllDevices::AllDevices,
InnerRequest::Requested(r) => {
DeviceIdOrAllDevices::DeviceId(r.state.other_device_data.device_id().to_owned())
}
InnerRequest::Ready(r) => {
DeviceIdOrAllDevices::DeviceId(r.state.other_device_data.device_id().to_owned())
}
InnerRequest::Transitioned(r) => DeviceIdOrAllDevices::DeviceId(
r.state.ready.other_device_data.device_id().to_owned(),
),
InnerRequest::Passive(_) => DeviceIdOrAllDevices::AllDevices,
InnerRequest::Done(_) => DeviceIdOrAllDevices::AllDevices,
InnerRequest::Cancelled(_) => DeviceIdOrAllDevices::AllDevices,
}
}
fn accept(&self, methods: Vec<VerificationMethod>) -> Option<(InnerRequest, OutgoingContent)> {
let InnerRequest::Requested(s) = self else { return None };
let (state, content) = s.clone().accept(methods);
Some((InnerRequest::Ready(state), content))
}
fn receive_done(&self, content: &DoneContent<'_>) -> Option<InnerRequest> {
let state = InnerRequest::Done(match self {
InnerRequest::Transitioned(s) => s.clone().into_done(content),
InnerRequest::Passive(s) => s.clone().into_done(content),
InnerRequest::Done(_)
| InnerRequest::Ready(_)
| InnerRequest::Created(_)
| InnerRequest::Requested(_)
| InnerRequest::Cancelled(_) => return None,
});
Some(state)
}
fn cancel(&self, cancelled_by_us: bool, cancel_code: &CancelCode) -> Option<InnerRequest> {
let print_info = || {
trace!(
cancelled_by_us = cancelled_by_us,
code = cancel_code.as_str(),
"Verification request going into the cancelled state"
);
};
let state = InnerRequest::Cancelled(match self {
InnerRequest::Created(s) => {
print_info();
s.clone().into_canceled(cancelled_by_us, cancel_code)
}
InnerRequest::Requested(s) => {
print_info();
s.clone().into_canceled(cancelled_by_us, cancel_code)
}
InnerRequest::Ready(s) => {
print_info();
s.clone().into_canceled(cancelled_by_us, cancel_code)
}
InnerRequest::Transitioned(s) => {
print_info();
s.clone().into_canceled(cancelled_by_us, cancel_code)
}
InnerRequest::Passive(_) | InnerRequest::Done(_) | InnerRequest::Cancelled(_) => {
return None
}
});
Some(state)
}
#[cfg(feature = "qrcode")]
async fn generate_qr_code(
&self,
we_started: bool,
request_handle: RequestHandle,
) -> Result<Option<(RequestState<Transitioned>, QrVerification)>, CryptoStoreError> {
match self {
InnerRequest::Created(_)
| InnerRequest::Requested(_)
| InnerRequest::Passive(_)
| InnerRequest::Done(_)
| InnerRequest::Cancelled(_) => Ok(None),
InnerRequest::Ready(s) => s.generate_qr_code(we_started, request_handle).await,
InnerRequest::Transitioned(s) => s.generate_qr_code(we_started, request_handle).await,
}
}
}
#[derive(Clone, Debug)]
struct RequestState<S: Clone> {
verification_cache: VerificationCache,
store: VerificationStore,
flow_id: Arc<FlowId>,
pub other_user_id: OwnedUserId,
state: S,
}
impl<S: Clone> RequestState<S> {
fn into_done(self, _: &DoneContent<'_>) -> RequestState<Done> {
RequestState::<Done> {
verification_cache: self.verification_cache,
store: self.store,
flow_id: self.flow_id,
other_user_id: self.other_user_id,
state: Done {},
}
}
fn into_canceled(
self,
cancelled_by_us: bool,
cancel_code: &CancelCode,
) -> RequestState<Cancelled> {
RequestState::<Cancelled> {
verification_cache: self.verification_cache,
store: self.store,
flow_id: self.flow_id,
other_user_id: self.other_user_id,
state: Cancelled::new(cancelled_by_us, cancel_code.clone()),
}
}
}
impl RequestState<Created> {
fn new(
cache: VerificationCache,
store: VerificationStore,
other_user_id: &UserId,
flow_id: &FlowId,
methods: Option<Vec<VerificationMethod>>,
) -> Self {
let our_methods = methods.unwrap_or_else(|| SUPPORTED_METHODS.to_vec());
Self {
other_user_id: other_user_id.to_owned(),
state: Created { our_methods },
verification_cache: cache,
store,
flow_id: flow_id.to_owned().into(),
}
}
fn into_ready(
self,
_sender: &UserId,
content: &ReadyContent<'_>,
from_device_data: DeviceData,
) -> RequestState<Ready> {
RequestState {
flow_id: self.flow_id,
verification_cache: self.verification_cache,
store: self.store,
other_user_id: self.other_user_id,
state: Ready {
their_methods: content.methods().to_owned(),
our_methods: self.state.our_methods,
other_device_data: from_device_data,
},
}
}
}
#[derive(Clone, Debug)]
struct Created {
pub our_methods: Vec<VerificationMethod>,
}
#[derive(Clone, Debug)]
struct Requested {
pub their_methods: Vec<VerificationMethod>,
pub other_device_data: DeviceData,
}
impl RequestState<Requested> {
fn from_request_event(
cache: VerificationCache,
store: VerificationStore,
sender: &UserId,
flow_id: &FlowId,
content: &RequestContent<'_>,
device_data: DeviceData,
) -> RequestState<Requested> {
RequestState {
store,
verification_cache: cache,
flow_id: flow_id.to_owned().into(),
other_user_id: sender.to_owned(),
state: Requested {
their_methods: content.methods().to_owned(),
other_device_data: device_data,
},
}
}
fn into_passive(self, content: &ReadyContent<'_>) -> RequestState<Passive> {
RequestState {
flow_id: self.flow_id,
verification_cache: self.verification_cache,
store: self.store,
other_user_id: self.other_user_id,
state: Passive { other_device_id: content.from_device().to_owned() },
}
}
fn accept(self, methods: Vec<VerificationMethod>) -> (RequestState<Ready>, OutgoingContent) {
let state = RequestState {
store: self.store,
verification_cache: self.verification_cache,
flow_id: self.flow_id.clone(),
other_user_id: self.other_user_id,
state: Ready {
their_methods: self.state.their_methods,
our_methods: methods.clone(),
other_device_data: self.state.other_device_data,
},
};
let content = match self.flow_id.as_ref() {
FlowId::ToDevice(i) => AnyToDeviceEventContent::KeyVerificationReady(
ToDeviceKeyVerificationReadyEventContent::new(
state.store.account.device_id.clone(),
methods,
i.to_owned(),
),
)
.into(),
FlowId::InRoom(r, e) => (
r.to_owned(),
AnyMessageLikeEventContent::KeyVerificationReady(
KeyVerificationReadyEventContent::new(
state.store.account.device_id.clone(),
methods,
Reference::new(e.to_owned()),
),
),
)
.into(),
};
(state, content)
}
}
#[derive(Clone, Debug)]
struct Ready {
pub their_methods: Vec<VerificationMethod>,
pub our_methods: Vec<VerificationMethod>,
pub other_device_data: DeviceData,
}
#[cfg(feature = "qrcode")]
async fn scan_qr_code<T: Clone>(
data: QrVerificationData,
request_state: &RequestState<T>,
state: &Ready,
we_started: bool,
request_handle: RequestHandle,
) -> Result<(RequestState<Transitioned>, QrVerification), ScanError> {
let verification = QrVerification::from_scan(
request_state.store.to_owned(),
request_state.other_user_id.to_owned(),
state.other_device_data.device_id().to_owned(),
request_state.flow_id.as_ref().to_owned(),
data,
we_started,
Some(request_handle),
)
.await?;
let new_state = RequestState {
verification_cache: request_state.verification_cache.to_owned(),
store: request_state.store.to_owned(),
flow_id: request_state.flow_id.to_owned(),
other_user_id: request_state.other_user_id.to_owned(),
state: Transitioned {
ready: state.to_owned(),
verification: verification.to_owned().into(),
other_device_data: state.other_device_data.to_owned(),
},
};
Ok((new_state, verification))
}
#[cfg(feature = "qrcode")]
async fn generate_qr_code<T: Clone>(
request_state: &RequestState<T>,
state: &Ready,
we_started: bool,
request_handle: RequestHandle,
) -> Result<Option<(RequestState<Transitioned>, QrVerification)>, CryptoStoreError> {
use crate::UserIdentityData;
if !state.our_methods.contains(&VerificationMethod::QrCodeShowV1)
|| !state.their_methods.contains(&VerificationMethod::QrCodeScanV1)
{
return Ok(None);
}
let identities = request_state.store.get_identities(state.other_device_data.clone()).await?;
let verification = if let Some(identity) = &identities.identity_being_verified {
match &identity {
UserIdentityData::Own(i) => {
if let Some(master_key) = i.master_key().get_first_key() {
if identities.can_sign_devices().await {
if let Some(device_key) = identities.other_device().ed25519_key() {
Some(QrVerification::new_self(
request_state.flow_id.as_ref().to_owned(),
master_key.to_owned(),
device_key.to_owned(),
identities,
we_started,
Some(request_handle),
))
} else {
warn!(
user_id = ?request_state.other_user_id,
device_id = ?state.other_device_data.device_id(),
"Can't create a QR code, the other device \
doesn't have a valid device key"
);
None
}
} else {
Some(QrVerification::new_self_no_master(
request_state.store.clone(),
request_state.flow_id.as_ref().to_owned(),
master_key.to_owned(),
identities,
we_started,
Some(request_handle),
))
}
} else {
warn!(
user_id = ?request_state.other_user_id,
device_id = ?state.other_device_data.device_id(),
"Can't create a QR code, our cross signing identity \
doesn't contain a valid master key"
);
None
}
}
UserIdentityData::Other(i) => {
if let Some(other_master) = i.master_key().get_first_key() {
if let Some(own_master) = identities
.private_identity
.master_public_key()
.await
.and_then(|m| m.get_first_key().map(|m| m.to_owned()))
{
Some(QrVerification::new_cross(
request_state.flow_id.as_ref().to_owned(),
own_master,
other_master.to_owned(),
identities,
we_started,
Some(request_handle),
))
} else {
warn!(
user_id = ?request_state.other_user_id,
device_id = ?state.other_device_data.device_id(),
"Can't create a QR code, we don't trust our own \
master key"
);
None
}
} else {
warn!(
user_id = ?request_state.other_user_id,
device_id = ?state.other_device_data.device_id(),
"Can't create a QR code, the user's identity \
doesn't have a valid master key"
);
None
}
}
}
} else {
warn!(
user_id = ?request_state.other_user_id,
device_id = ?state.other_device_data.device_id(),
"Can't create a QR code, the user doesn't have a valid cross \
signing identity."
);
None
};
if let Some(verification) = verification {
let new_state = RequestState {
verification_cache: request_state.verification_cache.to_owned(),
store: request_state.store.to_owned(),
flow_id: request_state.flow_id.to_owned(),
other_user_id: request_state.other_user_id.to_owned(),
state: Transitioned {
ready: state.to_owned(),
verification: verification.to_owned().into(),
other_device_data: state.other_device_data.to_owned(),
},
};
request_state.verification_cache.insert_qr(verification.to_owned());
Ok(Some((new_state, verification)))
} else {
Ok(None)
}
}
async fn receive_start<T: Clone>(
sender: &UserId,
content: &StartContent<'_>,
we_started: bool,
request_handle: RequestHandle,
request_state: &RequestState<T>,
state: &Ready,
) -> Result<Option<RequestState<Transitioned>>, CryptoStoreError> {
info!(
?sender,
device = ?content.from_device(),
method = ?content.method(),
"Received a new verification start event",
);
let other_device_data = state.other_device_data.clone();
let identities = request_state.store.get_identities(other_device_data.clone()).await?;
let own_user_id = &request_state.store.account.user_id;
let own_device_id = &request_state.store.account.device_id;
match content.method() {
StartMethod::SasV1(_) => {
match Sas::from_start_event(
(*request_state.flow_id).to_owned(),
content,
identities,
Some(request_handle),
we_started,
) {
Ok(new) => {
let old_verification = request_state
.verification_cache
.get(sender, request_state.flow_id.as_str());
match old_verification {
Some(Verification::SasV1(_old)) => {
use std::cmp::Ordering;
if !matches!(
(
sender.cmp(own_user_id),
other_device_data.device_id().cmp(own_device_id)
),
(Ordering::Greater, _) | (Ordering::Equal, Ordering::Greater)
) {
info!("Started a new SAS verification, replacing an already started one.");
request_state.verification_cache.replace_sas(new.to_owned());
Ok(Some(state.to_transitioned(request_state, new.into())))
} else {
info!("Ignored incoming SAS verification from lexicographically larger user/device ID.");
Ok(None)
}
}
#[cfg(feature = "qrcode")]
Some(Verification::QrV1(old)) => {
if let QrVerificationState::Started = old.state() {
info!("Transitioned from QR display to SAS");
request_state.verification_cache.replace_sas(new.to_owned());
Ok(Some(state.to_transitioned(request_state, new.into())))
} else {
warn!(qr_state = ?old.state(), "Invalid transition from QR to SAS");
request_state.verification_cache.insert_sas(new.to_owned());
Ok(Some(state.to_transitioned(request_state, new.into())))
}
}
None => {
info!("Started a new SAS verification.");
request_state.verification_cache.insert_sas(new.to_owned());
Ok(Some(state.to_transitioned(request_state, new.into())))
}
}
}
Err(c) => {
warn!(
user_id = ?other_device_data.user_id(),
device_id = ?other_device_data.device_id(),
content = ?c,
"Can't start key verification, canceling.",
);
request_state.verification_cache.queue_up_content(
other_device_data.user_id(),
other_device_data.device_id(),
c,
None,
);
Ok(None)
}
}
}
#[cfg(feature = "qrcode")]
StartMethod::ReciprocateV1(_) => {
if let Some(qr_verification) =
request_state.verification_cache.get_qr(sender, content.flow_id())
{
if let Some(request) = qr_verification.receive_reciprocation(content) {
request_state.verification_cache.add_request(request.into())
}
debug!(
sender = ?identities.device_being_verified.user_id(),
device_id = ?identities.device_being_verified.device_id(),
verification = ?qr_verification,
"Received a QR code reciprocation"
);
Ok(None)
} else {
warn!("Received a QR code reciprocation for an unknown flow");
Ok(None)
}
}
m => {
warn!(method = ?m, "Received a key verification start event with an unsupported method");
Ok(None)
}
}
}
async fn start_sas<T: Clone>(
request_state: &RequestState<T>,
state: &Ready,
we_started: bool,
request_handle: RequestHandle,
) -> Result<Option<(RequestState<Transitioned>, Sas, OutgoingContent)>, CryptoStoreError> {
if !state.their_methods.contains(&VerificationMethod::SasV1) {
return Ok(None);
}
let identities = request_state.store.get_identities(state.other_device_data.clone()).await?;
let (state, sas, content) = match request_state.flow_id.as_ref() {
FlowId::ToDevice(t) => {
let (sas, content) =
Sas::start(identities, t.to_owned(), we_started, Some(request_handle), None);
let state = Transitioned {
ready: state.to_owned(),
verification: sas.to_owned().into(),
other_device_data: state.other_device_data.to_owned(),
};
(state, sas, content)
}
FlowId::InRoom(r, e) => {
let (sas, content) = Sas::start_in_room(
e.to_owned(),
r.to_owned(),
identities,
we_started,
request_handle,
);
let state = Transitioned {
ready: state.to_owned(),
verification: sas.to_owned().into(),
other_device_data: state.other_device_data.to_owned(),
};
(state, sas, content)
}
};
let state = RequestState {
verification_cache: request_state.verification_cache.to_owned(),
store: request_state.store.to_owned(),
flow_id: request_state.flow_id.to_owned(),
other_user_id: request_state.other_user_id.to_owned(),
state,
};
Ok(Some((state, sas, content)))
}
impl RequestState<Ready> {
#[cfg(feature = "qrcode")]
async fn generate_qr_code(
&self,
we_started: bool,
request_handle: RequestHandle,
) -> Result<Option<(RequestState<Transitioned>, QrVerification)>, CryptoStoreError> {
generate_qr_code(self, &self.state, we_started, request_handle).await
}
async fn receive_start(
&self,
sender: &UserId,
content: &StartContent<'_>,
we_started: bool,
request_handle: RequestHandle,
) -> Result<Option<RequestState<Transitioned>>, CryptoStoreError> {
receive_start(sender, content, we_started, request_handle, self, &self.state).await
}
async fn start_sas(
&self,
we_started: bool,
request_handle: RequestHandle,
) -> Result<Option<(RequestState<Transitioned>, Sas, OutgoingContent)>, CryptoStoreError> {
start_sas(self, &self.state, we_started, request_handle).await
}
}
impl Ready {
fn to_transitioned<T: Clone>(
&self,
request_state: &RequestState<T>,
verification: Verification,
) -> RequestState<Transitioned> {
RequestState {
verification_cache: request_state.verification_cache.to_owned(),
store: request_state.store.to_owned(),
flow_id: request_state.flow_id.to_owned(),
other_user_id: request_state.other_user_id.to_owned(),
state: Transitioned {
ready: self.clone(),
verification,
other_device_data: self.other_device_data.clone(),
},
}
}
}
#[derive(Clone, Debug)]
struct Transitioned {
ready: Ready,
verification: Verification,
other_device_data: DeviceData,
}
impl RequestState<Transitioned> {
#[cfg(feature = "qrcode")]
async fn generate_qr_code(
&self,
we_started: bool,
request_handle: RequestHandle,
) -> Result<Option<(RequestState<Transitioned>, QrVerification)>, CryptoStoreError> {
generate_qr_code(self, &self.state.ready, we_started, request_handle).await
}
async fn receive_start(
&self,
sender: &UserId,
content: &StartContent<'_>,
we_started: bool,
request_handle: RequestHandle,
) -> Result<Option<RequestState<Transitioned>>, CryptoStoreError> {
receive_start(sender, content, we_started, request_handle, self, &self.state.ready).await
}
async fn start_sas(
&self,
we_started: bool,
request_handle: RequestHandle,
) -> Result<Option<(RequestState<Transitioned>, Sas, OutgoingContent)>, CryptoStoreError> {
start_sas(self, &self.state.ready, we_started, request_handle).await
}
}
#[derive(Clone, Debug)]
struct Passive {
#[allow(dead_code)]
pub other_device_id: OwnedDeviceId,
}
#[derive(Clone, Debug)]
struct Done {}
#[cfg(test)]
mod tests {
use std::time::Duration;
use assert_matches::assert_matches;
use assert_matches2::assert_let;
#[cfg(feature = "qrcode")]
use matrix_sdk_qrcode::QrVerificationData;
use matrix_sdk_test::async_test;
use ruma::{
event_id, events::key::verification::VerificationMethod, room_id,
to_device::DeviceIdOrAllDevices, UserId,
};
use super::VerificationRequest;
use crate::{
types::requests::OutgoingVerificationRequest,
verification::{
cache::VerificationCache,
event_enums::{
CancelContent, OutgoingContent, ReadyContent, RequestContent, StartContent,
},
tests::{alice_id, bob_id, setup_stores},
FlowId, Verification, VerificationStore,
},
DeviceData, VerificationRequestState,
};
#[async_test]
async fn test_request_accepting() {
let event_id = event_id!("$1234localhost").to_owned();
let room_id = room_id!("!test:localhost").to_owned();
let (alice, alice_store, bob, bob_store) = setup_stores().await;
let alice_device_data = DeviceData::from_account(&alice);
let bob_device_data = DeviceData::from_account(&bob);
let content = VerificationRequest::request(
&bob_store.account.user_id,
&bob_store.account.device_id,
alice_id(),
None,
);
let flow_id = FlowId::InRoom(room_id, event_id);
let bob_request = VerificationRequest::new(
VerificationCache::new(),
bob_store,
flow_id.clone(),
alice_id(),
vec![],
None,
);
assert_matches!(bob_request.state(), VerificationRequestState::Created { .. });
assert!(bob_request.time_remaining() <= Duration::from_secs(600)); assert!(bob_request.time_remaining() > Duration::from_secs(540)); #[allow(clippy::needless_borrow)]
let alice_request = VerificationRequest::from_request(
VerificationCache::new(),
alice_store,
bob_id(),
flow_id,
&(&content).into(),
bob_device_data,
);
assert_matches!(alice_request.state(), VerificationRequestState::Requested { .. });
let content: OutgoingContent = alice_request.accept().unwrap().try_into().unwrap();
let content = ReadyContent::try_from(&content).unwrap();
bob_request.receive_ready(alice_id(), &content, alice_device_data);
assert_matches!(bob_request.state(), VerificationRequestState::Ready { .. });
assert_matches!(alice_request.state(), VerificationRequestState::Ready { .. });
assert!(bob_request.is_ready());
assert!(alice_request.is_ready());
}
#[async_test]
async fn test_request_refusal_to_device() {
let (_alice, alice_store, bob, bob_store) = setup_stores().await;
let bob_device = DeviceData::from_account(&bob);
let bob_request = build_test_request(&bob_store, alice_id(), None);
let alice_request = build_incoming_verification_request(&alice_store, &bob_request).await;
let outgoing_request = alice_request.cancel().unwrap();
{
assert_let!(
OutgoingVerificationRequest::ToDevice(to_device_request) = &outgoing_request
);
assert_eq!(to_device_request.messages.len(), 1);
let device_ids: Vec<&DeviceIdOrAllDevices> =
to_device_request.messages.values().next().unwrap().keys().collect();
assert_eq!(device_ids.len(), 1);
assert_let!(DeviceIdOrAllDevices::DeviceId(device_id) = &device_ids[0]);
assert_eq!(device_id, bob_device.device_id());
}
let content = OutgoingContent::try_from(outgoing_request).unwrap();
let content = CancelContent::try_from(&content).unwrap();
bob_request.receive_cancel(alice_id(), &content);
assert_matches!(bob_request.state(), VerificationRequestState::Cancelled { .. });
assert_matches!(alice_request.state(), VerificationRequestState::Cancelled { .. });
}
#[async_test]
async fn test_requesting_until_sas() {
let event_id = event_id!("$1234localhost");
let room_id = room_id!("!test:localhost");
let (alice, alice_store, bob, bob_store) = setup_stores().await;
let alice_device_data = DeviceData::from_account(&alice);
let bob_device_data = DeviceData::from_account(&bob);
let content = VerificationRequest::request(
&bob_store.account.user_id,
&bob_store.account.device_id,
alice_id(),
None,
);
let flow_id = FlowId::from((room_id, event_id));
let bob_request = VerificationRequest::new(
VerificationCache::new(),
bob_store,
flow_id.clone(),
alice_id(),
vec![],
None,
);
#[allow(clippy::needless_borrow)]
let alice_request = VerificationRequest::from_request(
VerificationCache::new(),
alice_store,
bob_id(),
flow_id,
&(&content).into(),
bob_device_data.clone(),
);
do_accept_request(&alice_request, alice_device_data.clone(), &bob_request, None);
let (bob_sas, request) = bob_request.start_sas().await.unwrap().unwrap();
let content: OutgoingContent = request.try_into().unwrap();
let content = StartContent::try_from(&content).unwrap();
let flow_id = content.flow_id().to_owned();
alice_request.receive_start(bob_device_data.user_id(), &content).await.unwrap();
let alice_sas =
alice_request.verification_cache.get_sas(bob_device_data.user_id(), &flow_id).unwrap();
assert_let!(
VerificationRequestState::Transitioned {
verification: Verification::SasV1(_),
other_device_data
} = alice_request.state()
);
assert_eq!(bob_device_data, other_device_data);
assert_let!(
VerificationRequestState::Transitioned {
verification: Verification::SasV1(_),
other_device_data
} = bob_request.state()
);
assert_eq!(alice_device_data, other_device_data);
assert!(!bob_sas.is_cancelled());
assert!(!alice_sas.is_cancelled());
}
#[async_test]
async fn test_requesting_until_sas_to_device() {
let (alice, alice_store, bob, bob_store) = setup_stores().await;
let alice_device_data = DeviceData::from_account(&alice);
let bob_device_data = DeviceData::from_account(&bob);
let bob_request = build_test_request(&bob_store, alice_id(), None);
let alice_request = build_incoming_verification_request(&alice_store, &bob_request).await;
do_accept_request(&alice_request, alice_device_data.clone(), &bob_request, None);
let (bob_sas, request) = bob_request.start_sas().await.unwrap().unwrap();
let content: OutgoingContent = request.try_into().unwrap();
let content = StartContent::try_from(&content).unwrap();
let flow_id = content.flow_id().to_owned();
alice_request.receive_start(bob_device_data.user_id(), &content).await.unwrap();
let alice_sas =
alice_request.verification_cache.get_sas(bob_device_data.user_id(), &flow_id).unwrap();
assert_let!(
VerificationRequestState::Transitioned {
verification: Verification::SasV1(_),
other_device_data
} = alice_request.state()
);
assert_eq!(bob_device_data, other_device_data);
assert_let!(
VerificationRequestState::Transitioned {
verification: Verification::SasV1(_),
other_device_data
} = bob_request.state()
);
assert_eq!(alice_device_data, other_device_data);
assert!(!bob_sas.is_cancelled());
assert!(!alice_sas.is_cancelled());
assert!(alice_sas.started_from_request());
assert!(bob_sas.started_from_request());
}
#[async_test]
#[cfg(feature = "qrcode")]
async fn test_can_scan_another_qr_after_creating_mine() {
let (alice, alice_store, bob, bob_store) = setup_stores().await;
let alice_device_data = DeviceData::from_account(&alice);
let bob_device_data = DeviceData::from_account(&bob);
let bob_request = build_test_request(
&bob_store,
alice_id(),
Some(vec![VerificationMethod::QrCodeScanV1, VerificationMethod::QrCodeShowV1]),
);
let alice_request = build_incoming_verification_request(&alice_store, &bob_request).await;
do_accept_request(
&alice_request,
alice_device_data.clone(),
&bob_request,
Some(vec![VerificationMethod::QrCodeScanV1, VerificationMethod::QrCodeShowV1]),
);
let alice_verification = alice_request.generate_qr_code().await.unwrap();
let bob_verification = bob_request.generate_qr_code().await.unwrap();
assert_let!(
VerificationRequestState::Transitioned {
verification: Verification::QrV1(_),
other_device_data
} = alice_request.state()
);
assert_eq!(bob_device_data, other_device_data);
assert_let!(
VerificationRequestState::Transitioned {
verification: Verification::QrV1(_),
other_device_data
} = bob_request.state()
);
assert_eq!(alice_device_data, other_device_data);
assert!(alice_verification.is_some());
assert!(bob_verification.is_some());
let bob_qr_code = bob_verification.unwrap().to_bytes().unwrap();
let bob_qr_code = QrVerificationData::from_bytes(bob_qr_code).unwrap();
let _ = alice_request.scan_qr_code(bob_qr_code).await.unwrap().unwrap();
assert_let!(
VerificationRequestState::Transitioned {
verification: Verification::QrV1(alice_verification),
other_device_data
} = alice_request.state()
);
assert_eq!(bob_device_data, other_device_data);
assert!(!alice_verification.is_cancelled());
assert!(alice_verification.reciprocated());
}
#[async_test]
#[cfg(feature = "qrcode")]
async fn test_can_start_sas_after_generating_qr_code() {
let (alice, alice_store, bob, bob_store) = setup_stores().await;
let alice_device_data = DeviceData::from_account(&alice);
let bob_device_data = DeviceData::from_account(&bob);
let bob_request = build_test_request(&bob_store, alice_id(), Some(all_methods()));
let alice_request = build_incoming_verification_request(&alice_store, &bob_request).await;
do_accept_request(
&alice_request,
alice_device_data.clone(),
&bob_request,
Some(all_methods()),
);
let alice_verification = alice_request.generate_qr_code().await.unwrap();
let bob_verification = bob_request.generate_qr_code().await.unwrap();
assert_let!(
VerificationRequestState::Transitioned {
verification: Verification::QrV1(_),
other_device_data
} = alice_request.state()
);
assert_eq!(bob_device_data, other_device_data);
assert!(alice_verification.is_some());
assert!(bob_verification.is_some());
let (sas, request) = alice_request.start_sas().await.unwrap().unwrap();
assert_let!(
VerificationRequestState::Transitioned {
verification: Verification::SasV1(_),
other_device_data
} = alice_request.state()
);
assert_eq!(bob_device_data, other_device_data);
assert!(!sas.is_cancelled());
let content: OutgoingContent = request.try_into().unwrap();
let content = StartContent::try_from(&content).unwrap();
bob_request.receive_start(alice_id(), &content).await.unwrap();
assert_let!(
VerificationRequestState::Transitioned {
verification: Verification::SasV1(bob_sas),
other_device_data
} = bob_request.state()
);
assert_eq!(alice_device_data, other_device_data);
assert!(!bob_sas.is_cancelled());
}
#[async_test]
#[cfg(feature = "qrcode")]
async fn test_start_sas_after_scan_cancels_request() {
let (alice, alice_store, bob, bob_store) = setup_stores().await;
let alice_device_data = DeviceData::from_account(&alice);
let bob_device_data = DeviceData::from_account(&bob);
let bob_request = build_test_request(&bob_store, alice_id(), Some(all_methods()));
let alice_request = build_incoming_verification_request(&alice_store, &bob_request).await;
do_accept_request(
&alice_request,
alice_device_data.clone(),
&bob_request,
Some(all_methods()),
);
let bob_verification = bob_request.generate_qr_code().await.unwrap().unwrap();
assert_let!(
VerificationRequestState::Transitioned {
verification: Verification::QrV1(_),
other_device_data
} = bob_request.state()
);
assert_eq!(alice_device_data, other_device_data);
let bob_qr_code = bob_verification.to_bytes().unwrap();
let bob_qr_code = QrVerificationData::from_bytes(bob_qr_code).unwrap();
let _ = alice_request.scan_qr_code(bob_qr_code).await.unwrap().unwrap();
assert_let!(
VerificationRequestState::Transitioned {
verification: Verification::QrV1(alice_qr),
other_device_data
} = alice_request.state()
);
assert_eq!(bob_device_data, other_device_data);
assert!(alice_qr.reciprocated());
let (_, request) = bob_request.start_sas().await.unwrap().unwrap();
assert_let!(
VerificationRequestState::Transitioned {
verification: Verification::SasV1(_),
other_device_data
} = bob_request.state()
);
assert_eq!(alice_device_data, other_device_data);
let content: OutgoingContent = request.try_into().unwrap();
let content = StartContent::try_from(&content).unwrap();
alice_request.receive_start(bob_id(), &content).await.unwrap();
assert!(alice_qr.is_cancelled());
assert_let!(
VerificationRequestState::Transitioned {
verification: Verification::SasV1(alice_sas),
other_device_data
} = alice_request.state()
);
assert_eq!(bob_device_data, other_device_data);
assert!(alice_sas.is_cancelled());
}
fn build_test_request(
verification_store: &VerificationStore,
other_user_id: &UserId,
methods: Option<Vec<VerificationMethod>>,
) -> VerificationRequest {
VerificationRequest::new(
VerificationCache::new(),
verification_store.clone(),
FlowId::ToDevice("TEST_FLOW_ID".into()),
other_user_id,
vec![],
methods,
)
}
async fn build_incoming_verification_request(
verification_store: &VerificationStore,
outgoing_request: &VerificationRequest,
) -> VerificationRequest {
let request = outgoing_request.request_to_device();
let content: OutgoingContent = request.try_into().unwrap();
let content = RequestContent::try_from(&content).unwrap();
let device_data = verification_store
.get_device(outgoing_request.own_user_id(), content.from_device())
.await
.unwrap()
.expect("Missing device data");
VerificationRequest::from_request(
VerificationCache::new(),
verification_store.clone(),
outgoing_request.own_user_id(),
outgoing_request.flow_id().clone(),
&content,
device_data,
)
}
fn do_accept_request(
accepting_request: &VerificationRequest,
accepting_device_data: DeviceData,
initiating_request: &VerificationRequest,
methods: Option<Vec<VerificationMethod>>,
) {
let request = match methods {
Some(methods) => accepting_request.accept_with_methods(methods),
None => accepting_request.accept(),
};
let content: OutgoingContent = request.unwrap().try_into().unwrap();
let content = ReadyContent::try_from(&content).unwrap();
initiating_request.receive_ready(
accepting_request.own_user_id(),
&content,
accepting_device_data,
);
assert!(initiating_request.is_ready());
assert!(accepting_request.is_ready());
}
#[cfg(feature = "qrcode")]
fn all_methods() -> Vec<VerificationMethod> {
vec![
VerificationMethod::SasV1,
VerificationMethod::QrCodeScanV1,
VerificationMethod::QrCodeShowV1,
VerificationMethod::ReciprocateV1,
]
}
}