self_encryption

Primary Maintainer: Brian Smith (brian.smith@maidsafe.net)

Secondary Maintainer: Qi Ma (qi.ma@maidsafe.net)

Self encrypting files (convergent encryption plus obfuscation)

|Crate|Linux|Windows|OSX|Coverage| |:------:|:-------:|:-------:|:-------:|:-------:| ||| | | |

| API Documentation | SAFENetwork System Documention | MaidSafe website | Safe Community site |

Overview

A version of convergent encryption with an additional obfuscation step. This pattern allows secured data that can also be de-duplicated. This library presents an API that can be utilised in any application that provides a POSIX like filesystem interface, dealing very effectively with the content part of any data (in tests the parallelised approach can actually be faster than reading/writing data as a single stream). It is important to realise two important aspects of this library:

1. This library deals with file content only
2. This library provides very secure data, but does return a data structure (DataMap) that in turn requires to be secured.

![image of self encryption] (https://github.com/maidsafe/self_encryption/blob/master/img/self-encryption.png?raw=true)

Todo Items

[0.1.2] - Parallel processing and compression.

• [ ] Add compression pre encrypt and post encrypt in encrypt and decrypt methods
• [ ] Add task passing to allow cores to be lit up when handling chunks

[0.1.3] - Unrestricted file sizes.

• [ ] Allow any size file
  • [ ] Replace sequencer with new struct and use BufferedStream to offload to disk (MemoryMapped file)
  • [ ] Clean up any cache chunks when disk space is low (start + now < 90%)
  • [ ] Store intermediate chunks when disk space is low (start + now < 90%)
• [ ] Add another functor to constructor to allow storage query for chunks (not get)
• [ ] Check for first last middle chunks on net and presume file stored

[?] - Requires Beta channel.

• [ ] Uncomment benchmark tests read methods (require bench in beta channel or stabilised first)

Video of the process

[self_encryption process and use case video] (https://www.youtube.com/watch?v=Jnvwv4z17b4)

Examples

Using self_encryptor

This library splits a file into encrypted chunks and also produces a data map for the same. This data map with encrypted chunks enables the file to be reconstituted. Instructions to use the 'basic_encryptor' example are as follows:

1. Install RUST(Nightly build).

   • OSX / Linux: curl -s https://static.rust-lang.org/rustup.sh | sudo sh -s -- --channel=nightly
   • Windows: Download Exe installer from http://www.rust-lang.org/install.html

2. Install gcc.

   • Linux: sudo apt-get install gcc
   • Windows: Any compatible gcc such as TDM-GCC

3. Clone this repo / Download as zip and extract archive.

   • To clone via Git: git clone http://github.com/maidsafe/self_encryption.git

4. Browse to repo locally in terminal / command prompt.

   • cd self_encryption

5. Encrypt a file:

   • cargo run --example basic_encryptor -- -e <full_path_to_any_file>

   You should now have the example binary in ../self_encryption/target/debug/examples/. The data_map for the given file and it's encrypted chunks will be written to the current directory.

6. Decrypt a file:

   • cargo run --example basic_encryptor -- -d <full_path_to_data_map> <full_destination_path_including_filename>

   This will restore the original file to the given destination path.