Warning
This crate hasn't been audited; it's using ring crate, which is a well-known audited library, so in principle, at
least the primitives should offer a similar level of security.
This is still under development. Please do not use it with sensitive data for now; please wait for a
stable release.
It's mostly ideal for experimental and learning projects.
An encrypted file system written in Rust mounted with FUSE on Linux. It can be used to create encrypted directories.
You can then safely back up the encrypted directory to an untrusted server without worrying about the data being exposed. You can also store it in a cloud storage service like Google Drive, Dropbox, etc., and sync it across multiple devices.
You can use it as CLI or as a library to build your custom FUSE implementation or other apps that work with encrypted data.
- Motivation
Create a
simple,performant,modularandergonomicyetvery secureencrypted filesystemto protect yourprivacy, which is alsoopen sourceand is correctly and safely usingwell-known auditedcrates ascryptographic primitives. - Read an article The Hitchhiker’s Guide to Building an Encrypted Filesystem in Rust.
- A one-pager The Hitchhiker’s Guide to Building an Encrypted Filesystem in Rust.
- Talks
- It was crate of the week in Aug 2024.
Some of these are still being worked on and marked with [WIP].
Securityusing well-known auditedAEADcryptography primitives;[WIP]Data integrity, data is written with WAL to ensure integrity even on crash or power loss[WIP]Hide all info for enhanced privacy; all metadata, content, file name, file size, *time fields, files count, and directory structure is encryptedSafelymanagecredentialsin memory withmlock(2),mprotect,zeroize, andexpiryto mitigate cold boot attacks;Memory safety,performance, andoptimizedforconcurrencywith Rust;- Simplicity;
- Encryption key generated from password;
- Password saved in OS's
keyring; Change passwordwithout re-encrypting all data;[WIP]Generate unique nonce in offline mode[WIP]Add file inode and chunk index to AAD This prevents blocks from being copied between or within files by an attacker;Fast seekon both reads and writes;Writes in parallel;- Exposed with
FUSE; - Fully
concurrentfor all operations; [WIP]Handle long file names[WIP]Abstraction layer for Rust File and fs API to use it as lib to switch to using encrypted files by just changing the use statements[WIP]Abstraction layer to access the storage with implementations for desktop, Wasm, Android, and iOS and the ability to write your own implementation
Please look into Flows for a detailed sequence flow description.
- Usage
- Build from Source
- Minimum Supported Rust Version (MSRV). The minimum supported version is
1.75.
- The plan is to implement it also on macOS and Windows
- Systemd service is being worked on rencfs-daemon
- GUI is being worked on rencfs-desktop and ciphershell-kotlin
- Mobile apps for Android and iOS are being worked on ciphershell-kotlin
- Performance
Aes256Gcmis slightly faster thanChaCha20Poly1305by an average factor of 1.28. This is because of the hardware acceleration of AES on most CPUs via AES-NI. However, where hardware acceleration is unavailable,ChaCha20Poly1305is faster. Also,ChaChaPoly1305is better atSIMD. ⚠️ Security- Cipher comparison
- Others
If you find any issues or vulnerabilities or you'd like a feature, please follow these steps:
- Open a bug: Create a report to help us improve.
- Report a security vulnerability: Report a security vulnerability.
- Feature request: Suggest an idea for this project.
Feel free to fork, change, and use it however you want. We always appreciate it if you build something interesting and feel like sharing pull requests.
- How to contribute Please see CONTRIBUTING.md.
