interop/clients/corecrypto/
ffi.rs

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
// Wire
// Copyright (C) 2022 Wire Swiss GmbH

// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with this program. If not, see http://www.gnu.org/licenses/.

use crate::{
    CIPHERSUITE_IN_USE,
    clients::{EmulatedClient, EmulatedClientProtocol, EmulatedClientType, EmulatedMlsClient},
};
use color_eyre::eyre::Result;
use core_crypto_ffi::{ClientId, CoreCrypto, CustomConfiguration, MlsCredentialType, context::TransactionHelper};
use std::cell::Cell;
use std::sync::Arc;
use tempfile::NamedTempFile;

#[derive(Debug)]
pub(crate) struct CoreCryptoFfiClient {
    cc: CoreCrypto,
    client_id: Vec<u8>,
    // We will create a NamedTempFile which we will immediately use to get the path.
    // Once we get the path, we don't need to read from it anymore, but the compiler
    // will rightly point out that the value we store in the CoreCryptoFfiClient
    // struct is never read. However, we need to store the NamedTempFile instance in
    // the struct, so that the temporary file is not cleaned up prematurely.
    // So mark the field as unused to silence the compiler here.
    _temp_file: NamedTempFile,
    #[cfg(feature = "proteus")]
    prekey_last_id: Cell<u16>,
}

impl CoreCryptoFfiClient {
    pub(crate) async fn new() -> Result<CoreCryptoFfiClient> {
        let client_id = uuid::Uuid::new_v4();
        let client_id_bytes: Vec<u8> = client_id.as_hyphenated().to_string().as_bytes().into();
        let client_id = ClientId::from(core_crypto::prelude::ClientId::from(&client_id_bytes[..]));
        let ciphersuite = CIPHERSUITE_IN_USE;
        let temp_file = NamedTempFile::with_prefix("interop-ffi-keystore-")?;

        let cc = CoreCrypto::new(
            temp_file.path().to_string_lossy().into_owned(),
            "key".to_string(),
            Some(client_id),
            Some(vec![ciphersuite].into()),
            None,
        )
        .await?;

        cc.provide_transport(Arc::new(crate::MlsTransportSuccessProvider::default()))
            .await?;

        Ok(Self {
            cc,
            _temp_file: temp_file,
            client_id: client_id_bytes,
            #[cfg(feature = "proteus")]
            prekey_last_id: Cell::new(0),
        })
    }
}

#[async_trait::async_trait(?Send)]
impl EmulatedClient for CoreCryptoFfiClient {
    fn client_name(&self) -> &str {
        "CoreCrypto::ffi"
    }

    fn client_type(&self) -> EmulatedClientType {
        EmulatedClientType::Native
    }

    fn client_id(&self) -> &[u8] {
        self.client_id.as_slice()
    }

    fn client_protocol(&self) -> EmulatedClientProtocol {
        EmulatedClientProtocol::MLS | EmulatedClientProtocol::PROTEUS
    }

    async fn wipe(mut self) -> Result<()> {
        drop(self.cc);
        Ok(())
    }
}

#[async_trait::async_trait(?Send)]
impl EmulatedMlsClient for CoreCryptoFfiClient {
    async fn get_keypackage(&self) -> Result<Vec<u8>> {
        let ciphersuite = CIPHERSUITE_IN_USE.into();
        let credential_type = MlsCredentialType::Basic;
        let extractor = TransactionHelper::new(move |context| async move {
            Ok(context
                .client_keypackages(ciphersuite, credential_type, 1)
                .await?
                .pop()
                .unwrap())
        });
        self.cc.transaction(extractor.clone()).await?;
        let kp = extractor.into_return_value();
        Ok(kp)
    }

    async fn add_client(&self, conversation_id: &[u8], kp: &[u8]) -> Result<()> {
        if !self.cc.conversation_exists(conversation_id.to_vec()).await? {
            let cfg = core_crypto_ffi::ConversationConfiguration {
                ciphersuite: CIPHERSUITE_IN_USE.into(),
                external_senders: vec![],
                custom: CustomConfiguration {
                    key_rotation_span: None,
                    wire_policy: None,
                },
            };
            let conversation_id = conversation_id.to_vec();
            self.cc
                .transaction(TransactionHelper::new(move |context| async move {
                    context
                        .create_conversation(conversation_id, MlsCredentialType::Basic, cfg)
                        .await?;
                    Ok(())
                }))
                .await?;
        }

        let conversation_id = conversation_id.to_vec();
        let key_packages = vec![kp.to_vec()];
        let extractor = TransactionHelper::new(move |context| async move {
            context.add_clients_to_conversation(conversation_id, key_packages).await
        });
        self.cc.transaction(extractor.clone()).await?;
        Ok(())
    }

    async fn kick_client(&self, conversation_id: &[u8], client_id: &[u8]) -> Result<()> {
        let client_id = ClientId::from(core_crypto::prelude::ClientId::from(client_id));
        let conversation_id = conversation_id.to_vec();
        let extractor = TransactionHelper::new(move |context| async move {
            context
                .remove_clients_from_conversation(conversation_id, vec![client_id])
                .await
        });
        self.cc.transaction(extractor.clone()).await?;
        Ok(())
    }

    async fn process_welcome(&self, welcome: &[u8]) -> Result<Vec<u8>> {
        let cfg = CustomConfiguration {
            key_rotation_span: None,
            wire_policy: None,
        };
        let welcome = welcome.to_vec();
        let extractor =
            TransactionHelper::new(move |context| async move { context.process_welcome_message(welcome, cfg).await });
        self.cc.transaction(extractor.clone()).await?;
        Ok(extractor.into_return_value().id)
    }

    async fn encrypt_message(&self, conversation_id: &[u8], message: &[u8]) -> Result<Vec<u8>> {
        let conversation_id = conversation_id.to_vec();
        let message = message.to_vec();
        let extractor =
            TransactionHelper::new(
                move |context| async move { context.encrypt_message(conversation_id, message).await },
            );
        self.cc.transaction(extractor.clone()).await?;
        Ok(extractor.into_return_value())
    }

    async fn decrypt_message(&self, conversation_id: &[u8], message: &[u8]) -> Result<Option<Vec<u8>>> {
        let conversation_id = conversation_id.to_vec();
        let message = message.to_vec();
        let extractor =
            TransactionHelper::new(
                move |context| async move { context.decrypt_message(conversation_id, message).await },
            );
        self.cc.transaction(extractor.clone()).await?;
        Ok(extractor.into_return_value().message)
    }
}

#[cfg(feature = "proteus")]
#[async_trait::async_trait(?Send)]
impl crate::clients::EmulatedProteusClient for CoreCryptoFfiClient {
    async fn init(&mut self) -> Result<()> {
        self.cc
            .transaction(TransactionHelper::new(move |context| async move {
                context.proteus_init().await
            }))
            .await?;
        Ok(())
    }

    async fn get_prekey(&self) -> Result<Vec<u8>> {
        let prekey_last_id = self.prekey_last_id.get() + 1;
        self.prekey_last_id.replace(prekey_last_id);
        let extractor =
            TransactionHelper::new(move |context| async move { context.proteus_new_prekey(prekey_last_id).await });
        self.cc.transaction(extractor.clone()).await?;
        Ok(extractor.into_return_value())
    }

    async fn session_from_prekey(&self, session_id: &str, prekey: &[u8]) -> Result<()> {
        let session_id = session_id.to_string();
        let prekey = prekey.to_vec();
        self.cc
            .transaction(TransactionHelper::new(move |context| async move {
                context.proteus_session_from_prekey(session_id, prekey).await
            }))
            .await?;
        Ok(())
    }

    async fn session_from_message(&self, session_id: &str, message: &[u8]) -> Result<Vec<u8>> {
        let session_id = session_id.to_string();
        let message = message.to_vec();
        let extractor = TransactionHelper::new(move |context| async move {
            context.proteus_session_from_message(session_id, message).await
        });
        self.cc.transaction(extractor.clone()).await?;
        Ok(extractor.into_return_value())
    }

    async fn encrypt(&self, session_id: &str, plaintext: &[u8]) -> Result<Vec<u8>> {
        let session_id = session_id.to_string();
        let plaintext = plaintext.to_vec();
        let extractor =
            TransactionHelper::new(move |context| async move { context.proteus_encrypt(session_id, plaintext).await });
        self.cc.transaction(extractor.clone()).await?;
        Ok(extractor.into_return_value())
    }

    async fn decrypt(&self, session_id: &str, ciphertext: &[u8]) -> Result<Vec<u8>> {
        let session_id = session_id.to_string();
        let ciphertext = ciphertext.to_vec();
        let extractor =
            TransactionHelper::new(move |context| async move { context.proteus_decrypt(session_id, ciphertext).await });
        self.cc.transaction(extractor.clone()).await?;
        Ok(extractor.into_return_value())
    }

    async fn fingerprint(&self) -> Result<String> {
        self.cc.proteus_fingerprint().await.map_err(Into::into)
    }
}