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
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
// Copyright 2018 MaidSafe.net limited.
//
// This SAFE Network Software is licensed to you under the MIT license <LICENSE-MIT
// https://opensource.org/licenses/MIT> or the Modified BSD license <LICENSE-BSD
// https://opensource.org/licenses/BSD-3-Clause>, at your option. This file may not be copied,
// modified, or distributed except according to those terms. Please review the Licences for the
// specific language governing permissions and limitations relating to use of the SAFE Network
// Software.

use crate::cipher_opt::CipherOpt;
use crate::errors::AppError;
use crate::ffi::errors::Error;
use crate::ffi::object_cache::{
    CipherOptHandle, SelfEncryptorReaderHandle, SelfEncryptorWriterHandle,
};
use crate::App;
use bincode::{deserialize, serialize};
use ffi_utils::{call_result_cb, try_cb};
use ffi_utils::{catch_unwind_cb, vec_clone_from_raw_parts, FfiResult, OpaqueCtx, FFI_RESULT_OK};
use futures::Future;
use safe_core::ffi::arrays::XorNameArray;
use safe_core::{immutable_data, Client, FutureExt, SelfEncryptionStorage};
use safe_nd::{IDataAddress, IDataKind, XorName};
use self_encryption::{SelfEncryptor, SequentialEncryptor};
use std::os::raw::c_void;

/// Handle of a Self Encryptor Writer object.
pub type SEWriterHandle = SelfEncryptorWriterHandle;
/// Handle of a Self Encryptor Reader object.
pub type SEReaderHandle = SelfEncryptorReaderHandle;

/// Get a Self Encryptor.
#[no_mangle]
pub unsafe extern "C" fn idata_new_self_encryptor(
    app: *const App,
    published: bool,
    user_data: *mut c_void,
    o_cb: extern "C" fn(user_data: *mut c_void, result: *const FfiResult, se_h: SEWriterHandle),
) {
    let user_data = OpaqueCtx(user_data);

    catch_unwind_cb(user_data, o_cb, || {
        (*app).send(move |client, context| {
            let se_storage = SelfEncryptionStorage::new(client.clone(), published);
            let context = context.clone();

            let fut = SequentialEncryptor::new(se_storage, None)
                .map_err(Error::from)
                .map(move |se| {
                    let handle = context.object_cache().insert_se_writer(se);
                    o_cb(user_data.0, FFI_RESULT_OK, handle);
                })
                .map_err(move |e| {
                    call_result_cb!(Err::<(), _>(e), user_data, o_cb);
                })
                .into_box();

            Some(fut)
        })
    });
}

/// Write to Self Encryptor.
#[no_mangle]
pub unsafe extern "C" fn idata_write_to_self_encryptor(
    app: *const App,
    se_h: SEWriterHandle,
    data: *const u8,
    data_len: usize,
    user_data: *mut c_void,
    o_cb: extern "C" fn(user_data: *mut c_void, result: *const FfiResult),
) {
    let user_data = OpaqueCtx(user_data);

    catch_unwind_cb(user_data, o_cb, || {
        let data_slice = vec_clone_from_raw_parts(data, data_len);

        (*app).send(move |_, context| {
            let fut = {
                match context.object_cache().get_se_writer(se_h) {
                    Ok(writer) => writer.write(&data_slice),
                    res @ Err(..) => {
                        call_result_cb!(res.map_err(Error::from), user_data, o_cb);
                        return None;
                    }
                }
            };
            let fut = fut
                .map_err(Error::from)
                .then(move |res| {
                    call_result_cb!(res, user_data, o_cb);
                    Ok(())
                })
                .into_box();
            Some(fut)
        })
    });
}

/// Close Self Encryptor and free the Self Encryptor Writer handle.
#[no_mangle]
pub unsafe extern "C" fn idata_close_self_encryptor(
    app: *const App,
    se_h: SEWriterHandle,
    cipher_opt_h: CipherOptHandle,
    published: bool,
    user_data: *mut c_void,
    o_cb: extern "C" fn(
        user_data: *mut c_void,
        result: *const FfiResult,
        name: *const XorNameArray,
    ),
) {
    let user_data = OpaqueCtx(user_data);

    catch_unwind_cb(user_data, o_cb, || {
        (*app).send(move |client, context| {
            let client2 = client.clone();
            let client3 = client.clone();
            let context2 = context.clone();

            let se_writer = try_cb!(
                context
                    .object_cache()
                    .remove_se_writer(se_h)
                    .map_err(Error::from),
                user_data,
                o_cb
            );

            se_writer
                .close()
                .map_err(Error::from)
                .and_then(move |(data_map, _)| {
                    let ser_data_map = serialize(&data_map)?;
                    let enc_data_map = {
                        let cipher_opt = context2.object_cache().get_cipher_opt(cipher_opt_h)?;
                        cipher_opt.encrypt(&ser_data_map, &context2)?
                    };

                    Ok(enc_data_map)
                })
                .and_then(move |enc_data_map| {
                    immutable_data::create(&client2, &enc_data_map, published, None)
                        .map_err(Error::from)
                })
                .and_then(move |data| {
                    let name = *data.name();

                    client3
                        .put_idata(data)
                        .map_err(Error::from)
                        .map(move |_| name)
                })
                .then(move |result| {
                    match result {
                        Ok(name) => o_cb(user_data.0, FFI_RESULT_OK, &name.0),
                        res @ Err(..) => {
                            call_result_cb!(res, user_data, o_cb);
                        }
                    }
                    Ok(())
                })
                .into_box()
                .into()
        })
    });
}

/// Fetch Self Encryptor.
#[no_mangle]
pub unsafe extern "C" fn idata_fetch_self_encryptor(
    app: *const App,
    name: *const XorNameArray,
    published: bool,
    user_data: *mut c_void,
    o_cb: extern "C" fn(user_data: *mut c_void, result: *const FfiResult, se_h: SEReaderHandle),
) {
    catch_unwind_cb(user_data, o_cb, || {
        let user_data = OpaqueCtx(user_data);
        let name = XorName(*name);

        (*app)
            .send(move |client, context| {
                let client2 = client.clone();
                let client3 = client.clone();
                let context2 = context.clone();
                let context3 = context.clone();
                let idata_kind = IDataKind::from_flag(published);
                let address = IDataAddress::from_kind(idata_kind, name);

                immutable_data::get_value(client, address, None, None, None)
                    .map_err(AppError::from)
                    .and_then(move |enc_data_map| {
                        let ser_data_map = CipherOpt::decrypt(&enc_data_map, &context2, &client2)?;
                        let data_map = deserialize(&ser_data_map)?;

                        Ok(data_map)
                    })
                    .and_then(move |data_map| {
                        let se_storage = SelfEncryptionStorage::new(client3, published);
                        SelfEncryptor::new(se_storage, data_map).map_err(AppError::from)
                    })
                    .map(move |se_reader| {
                        let handle = context3.object_cache().insert_se_reader(se_reader);
                        o_cb(user_data.0, FFI_RESULT_OK, handle);
                    })
                    .map_err(Error::from)
                    .map_err(move |e| {
                        call_result_cb!(Err::<(), _>(e), user_data, o_cb);
                    })
                    .into_box()
                    .into()
            })
            .map_err(Error::from)
    });
}

/// Get serialised size of `ImmutableData`.
#[no_mangle]
pub unsafe extern "C" fn idata_serialised_size(
    app: *const App,
    name: *const XorNameArray,
    published: bool,
    user_data: *mut c_void,
    o_cb: extern "C" fn(user_data: *mut c_void, result: *const FfiResult, serialised_size: u64),
) {
    let user_data = OpaqueCtx(user_data);

    catch_unwind_cb(user_data, o_cb, || {
        let name = XorName(*name);

        (*app).send(move |client, _| {
            let idata_kind = IDataKind::from_flag(published);
            let address = IDataAddress::from_kind(idata_kind, name);

            client
                .get_idata(address)
                .map(move |idata| o_cb(user_data.0, FFI_RESULT_OK, idata.serialised_size()))
                .map_err(move |e| {
                    call_result_cb!(Err::<(), _>(Error::from(e)), user_data, o_cb);
                })
                .into_box()
                .into()
        })
    });
}

/// Get data size from Self Encryptor.
#[no_mangle]
pub unsafe extern "C" fn idata_size(
    app: *const App,
    se_h: SEReaderHandle,
    user_data: *mut c_void,
    o_cb: extern "C" fn(user_data: *mut c_void, result: *const FfiResult, size: u64),
) {
    let user_data = OpaqueCtx(user_data);

    catch_unwind_cb(user_data, o_cb, || {
        (*app).send(move |_, context| {
            match context.object_cache().get_se_reader(se_h) {
                Ok(se) => {
                    o_cb(user_data.0, FFI_RESULT_OK, se.len());
                }
                res @ Err(..) => {
                    call_result_cb!(res.map_err(Error::from), user_data, o_cb);
                }
            };
            None
        })
    });
}

/// Read from Self Encryptor.
#[no_mangle]
pub unsafe extern "C" fn idata_read_from_self_encryptor(
    app: *const App,
    se_h: SEReaderHandle,
    from_pos: u64,
    len: u64,
    user_data: *mut c_void,
    o_cb: extern "C" fn(
        user_data: *mut c_void,
        result: *const FfiResult,
        data: *const u8,
        data_len: usize,
    ),
) {
    let user_data = OpaqueCtx(user_data);

    catch_unwind_cb(user_data, o_cb, || {
        (*app).send(move |_, context| {
            let se = match context.object_cache().get_se_reader(se_h) {
                Ok(r) => r,
                res @ Err(..) => {
                    call_result_cb!(res.map_err(Error::from), user_data, o_cb);
                    return None;
                }
            };

            if from_pos + len > se.len() {
                call_result_cb!(
                    Err::<(), _>(Error::from(AppError::InvalidSelfEncryptorReadOffsets)),
                    user_data,
                    o_cb
                );
                return None;
            }

            let fut = se
                .read(from_pos, len)
                .map(move |data| {
                    o_cb(user_data.0, FFI_RESULT_OK, data.as_ptr(), data.len());
                })
                .map_err(Error::from)
                .map_err(move |e| {
                    call_result_cb!(Err::<(), _>(e), user_data, o_cb);
                })
                .into_box();

            Some(fut)
        })
    });
}

/// Free Self Encryptor Writer handle.
#[no_mangle]
pub unsafe extern "C" fn idata_self_encryptor_writer_free(
    app: *const App,
    handle: SEWriterHandle,
    user_data: *mut c_void,
    o_cb: extern "C" fn(user_data: *mut c_void, result: *const FfiResult),
) {
    let user_data = OpaqueCtx(user_data);

    catch_unwind_cb(user_data, o_cb, || {
        (*app).send(move |_, context| {
            let res = context.object_cache().remove_se_writer(handle);
            call_result_cb!(res.map_err(Error::from), user_data, o_cb);
            None
        })
    });
}

/// Free Self Encryptor Reader handle.
#[no_mangle]
pub unsafe extern "C" fn idata_self_encryptor_reader_free(
    app: *const App,
    handle: SEReaderHandle,
    user_data: *mut c_void,
    o_cb: extern "C" fn(user_data: *mut c_void, result: *const FfiResult),
) {
    let user_data = OpaqueCtx(user_data);

    catch_unwind_cb(user_data, o_cb, || {
        (*app).send(move |_, context| {
            let res = context.object_cache().remove_se_reader(handle);
            call_result_cb!(res.map_err(Error::from), user_data, o_cb);
            None
        })
    })
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::ffi::cipher_opt::*;
    use crate::ffi::errors::codes::{
        ERR_INVALID_SELF_ENCRYPTOR_HANDLE, ERR_INVALID_SELF_ENCRYPTOR_READ_OFFSETS,
    };
    use crate::test_utils::create_app;
    use ffi_utils::test_utils::{call_0, call_1, call_vec_u8};
    use safe_core::utils;
    use unwrap::unwrap;

    // Test immutable data operations.
    #[test]
    fn immut_data_operations() {
        let app = create_app();

        let plain_text = unwrap!(utils::generate_random_vector::<u8>(10));

        // Write idata to self encryptor handle
        unsafe {
            let cipher_opt_h = unwrap!(call_1(|ud, cb| cipher_opt_new_symmetric(&app, ud, cb)));
            let se_writer_h = unwrap!(call_1(|ud, cb| idata_new_self_encryptor(
                &app, true, ud, cb
            )));

            let res = call_0(|ud, cb| {
                idata_write_to_self_encryptor(
                    &app,
                    0,
                    plain_text.as_ptr(),
                    plain_text.len(),
                    ud,
                    cb,
                )
            });
            assert_eq!(res, Err(ERR_INVALID_SELF_ENCRYPTOR_HANDLE));

            unwrap!(call_0(|ud, cb| idata_write_to_self_encryptor(
                &app,
                se_writer_h,
                plain_text.as_ptr(),
                plain_text.len(),
                ud,
                cb,
            )));

            let name: XorNameArray = unwrap!(call_1(|ud, cb| idata_close_self_encryptor(
                &app,
                se_writer_h,
                cipher_opt_h,
                true,
                ud,
                cb
            )));

            // It should've been closed by immut_data_close_self_encryptor
            let res = call_0(|ud, cb| idata_self_encryptor_writer_free(&app, se_writer_h, ud, cb));
            assert_eq!(res, Err(ERR_INVALID_SELF_ENCRYPTOR_HANDLE));

            // Invalid self encryptor reader.
            let res: Result<u64, _> = call_1(|ud, cb| idata_size(&app, 0, ud, cb));
            assert_eq!(res, Err(ERR_INVALID_SELF_ENCRYPTOR_HANDLE));

            // Invalid self encryptor reader.
            let res: Result<u64, _> = call_1(|ud, cb| idata_size(&app, se_writer_h, ud, cb));
            assert_eq!(res, Err(ERR_INVALID_SELF_ENCRYPTOR_HANDLE));

            // Invalid self encryptor reader.
            let res: u64 = unwrap!(call_1(|ud, cb| idata_serialised_size(
                &app, &name, true, ud, cb
            )));
            assert!(res > 0);

            let se_reader_h = {
                unwrap!(call_1(|ud, cb| idata_fetch_self_encryptor(
                    &app, &name, true, ud, cb
                ),))
            };

            let size = unwrap!(call_1(|ud, cb| idata_size(&app, se_reader_h, ud, cb)));
            assert_eq!(size, plain_text.len() as u64);

            let res = call_vec_u8(|ud, cb| {
                idata_read_from_self_encryptor(&app, se_reader_h, 1, size, ud, cb)
            });
            assert_eq!(res, Err(ERR_INVALID_SELF_ENCRYPTOR_READ_OFFSETS));

            let received_plain_text;
            received_plain_text = call_vec_u8(|ud, cb| {
                idata_read_from_self_encryptor(&app, se_reader_h, 0, size, ud, cb)
            });
            assert_eq!(plain_text, unwrap!(received_plain_text));

            unwrap!(call_0(|ud, cb| idata_self_encryptor_reader_free(
                &app,
                se_reader_h,
                ud,
                cb
            )));

            let res = call_0(|ud, cb| idata_self_encryptor_reader_free(&app, se_reader_h, ud, cb));
            assert_eq!(res, Err(ERR_INVALID_SELF_ENCRYPTOR_HANDLE));

            unwrap!(call_0(|ud, cb| cipher_opt_free(&app, cipher_opt_h, ud, cb)));
        }
    }
}