https://github.com/stasel/secfs

Encrypted file system implementation using FUSE and openSSL
https://github.com/stasel/secfs

Last synced: 27 days ago
JSON representation

Encrypted file system implementation using FUSE and openSSL

• Host: GitHub
• URL: https://github.com/stasel/secfs
• Owner: stasel
• License: apache-2.0
• Created: 2023-06-07T21:51:50.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-06-07T22:24:26.000Z (over 1 year ago)
• Last Synced: 2024-10-27T00:05:30.612Z (3 months ago)
• Language: C
• Size: 8.38 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Secfs

Secfs is a secure file system built on top of FUSE. When running, it will create a virtual folder where all the files will be stored encrypted.

For more information, please check the [design document](design-document.pdf).

## Requirements

* Unix based OS. Developed and tested on Ubuntu 20.04 (macOS not supported)

* Fuse3 (install with `sudo apt install fuse3` on debian based systems)

## Build

To build the software simply run `make` from the root directory. A binary under the name `secfs` will be created.

## Run

Run example: `./secfs  `

- Data directory is where all the encrypted binary data will be stored on disk.

- Mount point is the directory where to mount the virtual decrypted folder.

### First run

In the first run, you will be asked to create a unique password. This password will not be stored anywhere and meant to be secret. If you forget your password, you will lose access to all the encrypted files.

### Stoping the software

There are two options to stop the software:

1. Manually unmount the mounted secfs driver

2. Stop the program runing in the terminal

After stopping the program, all files will remain encrypted and it will be impossible to read the data without running the software again.