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
// 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 futures_core::Stream;
use matrix_sdk_base::crypto::{
AcceptSettings, CancelInfo, DeviceData, Emoji, Sas as BaseSas, SasState,
};
use ruma::{events::key::verification::cancel::CancelCode, RoomId, UserId};
use crate::{error::Result, Client};
/// An object controlling the short auth string verification flow.
#[derive(Debug, Clone)]
pub struct SasVerification {
pub(crate) inner: BaseSas,
pub(crate) client: Client,
}
impl SasVerification {
/// Accept the interactive verification flow.
pub async fn accept(&self) -> Result<()> {
self.accept_with_settings(Default::default()).await
}
/// Accept the interactive verification flow with specific settings.
///
/// # Arguments
///
/// * `settings` - specific customizations to the verification flow.
///
/// # Examples
///
/// ```no_run
/// # use matrix_sdk::Client;
/// # use url::Url;
/// # use ruma::user_id;
/// use matrix_sdk::{
/// encryption::verification::{AcceptSettings, SasVerification},
/// ruma::events::key::verification::ShortAuthenticationString,
/// };
///
/// # let flow_id = "someID";
/// # let user_id = user_id!("@alice:example");
/// # async {
/// # let homeserver = Url::parse("http://example.com")?;
/// # let client = Client::new(homeserver).await?;
/// let sas = client
/// .encryption()
/// .get_verification(&user_id, flow_id)
/// .await
/// .and_then(|v| v.sas());
///
/// if let Some(sas) = sas {
/// let only_decimal = AcceptSettings::with_allowed_methods(vec![
/// ShortAuthenticationString::Decimal,
/// ]);
///
/// sas.accept_with_settings(only_decimal).await?;
/// }
/// # anyhow::Ok(()) };
/// ```
pub async fn accept_with_settings(&self, settings: AcceptSettings) -> Result<()> {
if let Some(request) = self.inner.accept_with_settings(settings) {
self.client.send_verification_request(request).await?;
}
Ok(())
}
/// Confirm that the short auth strings match on both sides.
pub async fn confirm(&self) -> Result<()> {
let (requests, signature) = self.inner.confirm().await?;
for request in requests {
self.client.send_verification_request(request).await?;
}
if let Some(s) = signature {
self.client.send(s, None).await?;
}
Ok(())
}
/// Cancel the interactive verification flow because the short auth strings
/// didn't match on both sides.
pub async fn mismatch(&self) -> Result<()> {
if let Some(request) = self.inner.cancel_with_code(CancelCode::MismatchedSas) {
self.client.send_verification_request(request).await?;
}
Ok(())
}
/// Cancel the interactive verification flow.
pub async fn cancel(&self) -> Result<()> {
if let Some(request) = self.inner.cancel() {
self.client.send_verification_request(request).await?;
}
Ok(())
}
/// Get the emoji version of the short auth string.
///
/// # Examples
///
/// ```no_run
/// # use matrix_sdk::Client;
/// # use url::Url;
/// # use ruma::user_id;
/// use matrix_sdk::{
/// encryption::verification::{AcceptSettings, SasVerification},
/// ruma::events::key::verification::ShortAuthenticationString,
/// };
///
/// # let flow_id = "someID";
/// # let user_id = user_id!("@alice:example");
/// # async {
/// # let homeserver = Url::parse("http://example.com")?;
/// # let client = Client::new(homeserver).await?;
/// let sas_verification = client
/// .encryption()
/// .get_verification(&user_id, flow_id)
/// .await
/// .and_then(|v| v.sas());
///
/// if let Some(emojis) = sas_verification.and_then(|s| s.emoji()) {
/// let emoji_string = emojis
/// .iter()
/// .map(|e| format!("{:^12}", e.symbol))
/// .collect::<Vec<_>>()
/// .join("");
///
/// let description = emojis
/// .iter()
/// .map(|e| format!("{:^12}", e.description))
/// .collect::<Vec<_>>()
/// .join("");
///
/// println!("Do the emojis match?\n{emoji_string}\n{description}");
/// }
/// # anyhow::Ok(()) };
/// ```
pub fn emoji(&self) -> Option<[Emoji; 7]> {
self.inner.emoji()
}
/// Get the decimal version of the short auth string.
pub fn decimals(&self) -> Option<(u16, u16, u16)> {
self.inner.decimals()
}
/// Does this verification flow support emoji for the short authentication
/// string.
pub fn supports_emoji(&self) -> bool {
self.inner.supports_emoji()
}
/// Is the verification process done.
pub fn is_done(&self) -> bool {
self.inner.is_done()
}
/// Are we in a state where we can show the short auth string.
pub fn can_be_presented(&self) -> bool {
self.inner.can_be_presented()
}
/// Did we initiate the verification flow.
pub fn we_started(&self) -> bool {
self.inner.we_started()
}
/// Get info about the cancellation if the verification flow has been
/// cancelled.
pub fn cancel_info(&self) -> Option<CancelInfo> {
self.inner.cancel_info()
}
/// Is the verification process canceled.
pub fn is_cancelled(&self) -> bool {
self.inner.is_cancelled()
}
/// Get the other users device that we're verifying.
pub fn other_device(&self) -> &DeviceData {
self.inner.other_device()
}
/// Did this verification flow start from a verification request.
pub fn started_from_request(&self) -> bool {
self.inner.started_from_request()
}
/// Is this a verification that is verifying one of our own devices.
pub fn is_self_verification(&self) -> bool {
self.inner.is_self_verification()
}
/// Get our own user id.
pub fn own_user_id(&self) -> &UserId {
self.inner.user_id()
}
/// Get the user id of the other user participating in this verification
/// flow.
pub fn other_user_id(&self) -> &UserId {
self.inner.other_user_id()
}
/// Listen for changes in the SAS verification process.
///
/// The changes are presented as a stream of [`SasState`] values.
///
/// This method can be used to react to changes in the state of the
/// verification process, or rather the method can be used to handle
/// each step of the verification process.
///
/// # Flowchart
///
/// The flow of the verification process is pictured bellow. Please note
/// that the process can be cancelled at each step of the process.
/// Either side can cancel the process.
///
/// ```text
/// ┌───────┐
/// │Created│
/// └───┬───┘
/// │
/// ┌───⌄───┐
/// │Started│
/// └───┬───┘
/// │
/// ┌────⌄───┐
/// │Accepted│
/// └────┬───┘
/// │
/// ┌───────⌄──────┐
/// │Keys Exchanged│
/// └───────┬──────┘
/// │
/// ________⌄________
/// ╱ ╲ ┌─────────┐
/// ╱ Does the short ╲______│Cancelled│
/// ╲ auth string match ╱ no └─────────┘
/// ╲_________________╱
/// │yes
/// │
/// ┌────⌄────┐
/// │Confirmed│
/// └────┬────┘
/// │
/// ┌───⌄───┐
/// │ Done │
/// └───────┘
/// ```
/// # Examples
///
/// ```no_run
/// use futures_util::{Stream, StreamExt};
/// use matrix_sdk::encryption::verification::{SasState, SasVerification};
///
/// # async {
/// # let sas: SasVerification = unimplemented!();
/// # let user_confirmed = false;
/// let mut stream = sas.changes();
///
/// while let Some(state) = stream.next().await {
/// match state {
/// SasState::KeysExchanged { emojis, decimals: _ } => {
/// let emojis =
/// emojis.expect("We only support emoji verification");
/// println!("Do these emojis match {emojis:#?}");
///
/// // Ask the user to confirm or cancel here.
/// if user_confirmed {
/// sas.confirm().await?;
/// } else {
/// sas.cancel().await?;
/// }
/// }
/// SasState::Done { .. } => {
/// let device = sas.other_device();
///
/// println!(
/// "Successfully verified device {} {} {:?}",
/// device.user_id(),
/// device.device_id(),
/// device.local_trust_state()
/// );
///
/// break;
/// }
/// SasState::Cancelled(cancel_info) => {
/// println!(
/// "The verification has been cancelled, reason: {}",
/// cancel_info.reason()
/// );
/// break;
/// }
/// SasState::Created { .. }
/// | SasState::Started { .. }
/// | SasState::Accepted { .. }
/// | SasState::Confirmed => (),
/// }
/// }
/// # anyhow::Ok(()) };
/// ```
pub fn changes(&self) -> impl Stream<Item = SasState> {
self.inner.changes()
}
/// Get the current state the verification process is in.
///
/// To listen to changes to the [`SasState`] use the
/// [`SasVerification::changes`] method.
pub fn state(&self) -> SasState {
self.inner.state()
}
/// Get the room ID, if the verification is happening inside a room.
pub fn room_id(&self) -> Option<&RoomId> {
self.inner.room_id()
}
}