Susi is a utitlity app by Sean Ballais that lets you encrypt (and decrypt) files to protect them from unauthorized parties. This is considered to be alpha software, so use this at your own risk. No warranty is provided with this software.
app-demo.mp4
A demonstration of Susi.
Susi fully supports Windows 11, but has partial support for Windows 10. Only file unlocking/decryption is supported in Windows 10 at the moment. Additionally, only 64-bit versions of the aformentioned operating systems are supported.
Susi is composed of two main components: (a) Susi GUI, and (b) Susi Core. Susi GUI is the GUI component of the app (this repository holds the code for the Windows version), while Susi Core is where most of the major operations, such as encryption and decryption, are done.
Susi GUI is built with C# (.NET 8 and WinUI 3) and a small, but important, component in C++. Susi Core is built completely in Rust. The installer for Susi GUI is mostly built with InnoSetup, with an internal script written in PowerShell.
Due to personal time constraints, a complete documentation on how to work on this project will not be available. However, the basic requirements are Visual Studio 2022, the .NET 8 SDK, and the Windows App SDK 1.5.
A DLL of Susi Core is also required. It must be compiled, and the resulting DLL (susi_core.dll) and its accompanying .lib file (susi_core.dll.lib) must be added to the susi-gui-windows C# project (stored in the inner susi-gui-windows/ folder) of this app's solution. The DLL must be compiled in debug mode during development, but it must be compiled in release mode when you are working towards a distributable copy of Susi. You must also set the DLL file's "Copy to Output Directory" property in the C# project to "Copy if newer", when editing it via Visual Studio, or PreserveNewest, when directly editing the C# project file.
The app is built as a packaged application. Based on experience, this was the easiest way to build Susi while also using WinUI 3. This means that deployment is primarily done through MSIX. Packaging our app into an MSIX package is currently performed through Visual Studio tools (as shown below). If you want to distribute a version of Susi GUI (which is allowed by the license of the app), it is recommended that you also do the same procedure. Distribution of the MSIX package will differ based on how it will be distributed. Please refer to Microsoft's documentation for more information on that regard.
Creating an MSIX package for Susi is currently done through Visual Studio tools.
NOTE: This section assumes that you are using the installer provided in Sean Ballais's repository for Susi GUI (Windows). The installation procedure for other distributions of Susi may differ.
Susi GUI is exported as an MSIX package. However, it depends on the latest Visual C++ 2022 Redistributable, .NET 8 Desktop Runtime, and Windows App SDK Runtime. A certificate is also required to allow sideloading/installing the app. These steps are cumbersome for users. So, to make the installation process easy, we are providing a setup file that is a chain installer. It does all the aforementioned steps on the behalf of the user.
You can simply grab a setup file from the Releases page. Once you have a setup file, simply run it and follow the steps. You don't have to do much to install it! The demo below shows the installation process. Note that this is shortened since the dependencies were already instaleld.
app-installation-demo.mp4
A demonstration on installing Susi in Windows.
We recommend restarting your machine, however, once the installation is done, so that our shell extension to the Windows Explorer gets loaded in. Alternatively, you can just restart Windows Explorer from the Task Manager.
One important thing to note is that Susi is installed using MSIX. So, it will be installed inside C:\Program Files\WindowsApps.
Beware that the app and installer are both alpha software. So, again, use at your own risk.
Uninstallation of Susi is simply done by uninstalling the app from the Start Menu or the Settings app.
app-uninstallation-demo.mp4
Uninstalling Susi in Windows.
However, this only removes the app itself. You will have to manually uninstall the dependencies if you want them off of your machine. We don't necessarily recommend that since other apps may already be dependending on them.
The certificate for the app will still remain unless removed manually. You can remove it by performing the following steps:
- Open "Manage user certificates" in the Control Panel. This can also be opened directly from the Start Menu.
- Open "Trusted People" and then "Certificates".
- Select the certificate that was issued by "Sean Francis N. Ballais", and either click on the red "X" button on the toolbar or right-click the selected item and click "Delete". You will be asked if you would like to delete the selected certificate. Press "Yes".
- Done!
You may also view the demo below to learn how to remove the certificate.
cert-removal-demo.mp4
Removing the certificate that was added during the installation of Susi.
Susi provides two features -- encryption and decryption of files, both of which may also be referred to as "locking" and "unlocking" files, respectively. The app encrypts to and decrypts from a custom Susi Encrypted File (a .ssef file). It does not support any other encryption formats. You may check Susi Software Specifications to know where to learn about details on the custom .ssef file format.
Encrypting a file with Susi is easy. The following steps will guide you how to encrypt a file.
- Simply select a file from the Windows Explorer or desktop.
- Right-click the selected file, and select "Lock File".
- Susi will show up and will ask for a password to encrypt the file. Enter the desired password for the file. You will have to enter the same password in the "Confirm Password" textbox.
- After entering the password, Susi will start encrypting the file. It may take a while depending on your computer. After encryption is complete, the original file will be removed and you are left with an encrypted
.sseffile in the same directory as the original file.
The following video provides a visual demonstration on how to encrypt a file with Susi.
file-locking-demo.mp4
Encrypting/Locking a file with Susi.
Decrypting a Susi Encrypted File with Susi is easy as well. Remember that Susi can only decrpyt a Susi Encrypted File (.ssef file). The following steps will guide you how to decrpyt a file.
- Open a Susi Encrypted File (
.sseffile) from Windows Explorer or the desktop. If you are asked to select a program to open the file with, make sure you select Susi and, as a recommendation, set it as the default app. - Susi will show up and will ask for the password used to encrypt the file. Enter the correct password for the file. Susi will inform you if you entered the wrong password.
- After entering the password, Susi will start decrypting the file. It may take a while depending on your computer. After decryption is complete, the encrypted file will be removed and you are left with the original file with its original file name in the same directory as the encrypted file.
The following video provides a visual demonstration on how to decrypt a Susi Encrypted File with Susi.
file-unlocking-demo.mp4
Decrypting/Unlocking a Susi Encrypted File.
Make sure you remember the password you set for a file when you encrypt it. You will not be able to decrypt it without the correct password. Additionally, note that a Susi Encrypted File is portable and can be renamed. However, upon decryption, it will revert back to its original file name.
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.
This project, Susi GUI (for Windows), is licensed under the GNU General Public License v3. See LICENSE.md for details.
Some parts of the app was based on third-party code. See THIRD-PARTY-LICENSES.txt for details. Some code used in this project are based on online sources, such as but not limited to blogs and StackOverflow answers. The links to such sources are included in the individual files with code based off of such sources.
Sean Francis N. Ballais - @seanballais - [email protected]