matrix-sdk 0.2.0

A high level Matrix client-server library.
Documentation 
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

// 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 matrix_sdk_base::crypto::{ReadOnlyDevice, Sas as BaseSas};
use matrix_sdk_common::api::r0::to_device::send_event_to_device::Request as ToDeviceRequest;

use crate::{error::Result, http_client::HttpClient};

/// An object controling the interactive verification flow.
#[derive(Debug, Clone)]
pub struct Sas {
    pub(crate) inner: BaseSas,
    pub(crate) http_client: HttpClient,
}

impl Sas {
    /// Accept the interactive verification flow.
    pub async fn accept(&self) -> Result<()> {
        if let Some(req) = self.inner.accept() {
            let txn_id_string = req.txn_id_string();
            let request = ToDeviceRequest::new(req.event_type, &txn_id_string, req.messages);

            self.http_client.send(request).await?;
        }
        Ok(())
    }

    /// Confirm that the short auth strings match on both sides.
    pub async fn confirm(&self) -> Result<()> {
        let (to_device, signature) = self.inner.confirm().await?;

        if let Some(req) = to_device {
            let txn_id_string = req.txn_id_string();
            let request = ToDeviceRequest::new(req.event_type, &txn_id_string, req.messages);

            self.http_client.send(request).await?;
        }

        if let Some(s) = signature {
            self.http_client.send(s).await?;
        }

        Ok(())
    }

    /// Cancel the interactive verification flow.
    pub async fn cancel(&self) -> Result<()> {
        if let Some(req) = self.inner.cancel() {
            let txn_id_string = req.txn_id_string();
            let request = ToDeviceRequest::new(req.event_type, &txn_id_string, req.messages);

            self.http_client.send(request).await?;
        }
        Ok(())
    }

    /// Get the emoji version of the short auth string.
    pub fn emoji(&self) -> Option<Vec<(&'static str, &'static str)>> {
        self.inner.emoji()
    }

    /// Get the decimal version of the short auth string.
    pub fn decimals(&self) -> Option<(u16, u16, u16)> {
        self.inner.decimals()
    }

    /// Is the verification process done.
    pub fn is_done(&self) -> bool {
        self.inner.is_done()
    }

    /// Is the verification process canceled.
    pub fn is_canceled(&self) -> bool {
        self.inner.is_canceled()
    }

    /// Get the other users device that we're veryfying.
    pub fn other_device(&self) -> ReadOnlyDevice {
        self.inner.other_device()
    }
}