Recommended Minimum Rust Version: 1.76
Susi Core is a library that allows encryption and decryption of files to protect them from unauthorized parties. This project is expected to be integrated with other applications or even libraries. This library does the majority of the work in operating on files, including but not limited to managing worker threads and assigning tasks to them. Client projects will simply have to plug into the library's interfaces to start encrypting and decrypting files.
Files are encrypted to and decrypted from a custom file format called the Susi Encrypted File. Susi Core is not capable of encrypting nor decrypting other encryption file formats. See Susi Software Specifications to know where to learn more about the file format.
Susi Core is likely compilable in all modern versions of major desktop platforms (Windows, macOS, Linux). However, this project has only been compiled in Windows so far. Full support for the other major platforms are to be determined.
Additionally, only little-endian systems are supported currently.
To compile Susi Core, just run:
$ cd /path/to/susi/core
$ cargo build --debug # or --release for a release buildThe compiled library (susi_core.dll) and related files (e.g. susi_core.dll.lib, susi_core.pdb) can be found in target/debug for debug builds (if any) and target/release for release builds (if any).
Tests are available for Susi Core. To run these tests, simply run:
$ cd /path/to/susi/core
$ cargo testDocumentation on integrating with other projects is still lacking. Those who would like to integrate Susi Core into their own projects as a DLL may check out the Susi GUI (for Windows) project for guidance.
Software specifications for Susi have been written to guide us with the development of the project. It also contains the specifications of the file format of a Susi Encrypted File (.ssef). If you are interested in reading it or learning about the file format, you may obtain and read the latest specifications from the "Releases" page of the software specifications's repository.
Susi Core is licensed under the Mozilla Public License 2.0. See LICENSE.md for details.
Some code used in the project are based on online sources, specifically blogs. The links to such sources are included in the individual files with code based off of such sources.
Sean Francis N. Ballais - @seanballais - sean@seanballais.com