https://github.com/flewsoftware/filecrypt
A super easy file encryption utility written in go and under 800kb
https://github.com/flewsoftware/filecrypt
cryptography decryption encryption encryption-utility small
Last synced: about 1 month ago
JSON representation
A super easy file encryption utility written in go and under 800kb
- Host: GitHub
- URL: https://github.com/flewsoftware/filecrypt
- Owner: flewsoftware
- License: mit
- Archived: true
- Created: 2020-11-13T10:53:03.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-10-04T04:38:12.000Z (over 4 years ago)
- Last Synced: 2024-06-20T14:27:13.511Z (over 1 year ago)
- Topics: cryptography, decryption, encryption, encryption-utility, small
- Language: Go
- Homepage: https://flew-software.github.io/filecrypt/
- Size: 120 KB
- Stars: 82
- Watchers: 3
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# filecrypt
[](https://www.codacy.com/gh/flew-software/filecrypt/dashboard?utm_source=github.com&utm_medium=referral&utm_content=flew-software/filecrypt&utm_campaign=Badge_Grade)
[](https://goreportcard.com/report/github.com/flew-software/filecrypt)
[](https://github.com/flew-software/filecrypt)
[](https://golang.org)
A super easy to use file encryption utility written in golang
[](https://github.com/flew-software/filecrypt)
⚠ **Filecrypt is nolonger maintained**
**NOTE:** if you are planning to use filecrypt for your go-lang project please clone this repo and build your software from there
## What's the difference
* Speed
* Simple
* Works on all operating systems
## How to use
#### Windows
1. Download the latest release from [here](https://github.com/flew-software/filecrypt/releases/latest)
2. Create a folder named "filecrypt" in any drive
3. Move the downloaded executable(.exe) to the folder created in step 2
4. Add the path of the created folder created in step 2 into [windows path variable](https://docs.alfresco.com/4.2/tasks/fot-addpath.html)
5. Open the command prompt and enter `filecrypt --help` for detailed info about using flags
#### flags
* `--force` - Force write even if a file exists with that name (overwrite) DESTRUCTIVE
* `--location` - The location of the file to encrypt/decrypt(determined by the mode flag)
* `--mode` - FileCrypt mode (encrypt/decrypt These can be replaced with their first letters) Example: `filecrypt --mode=e --location="super secret file.txt" --password="test"`
* `--password` - (removed in release v2 & later) Password to be used while encrypting/decrypting
**Note: due to security issues with commandline flags the password will be prompted at runtime.**
## Q&A
### How can I help?
* Staring this project on github
* Creating issues
* Contributing with code or documentation
* Sharing this project with your friends
### What is a .fcef file
fcef (File. Crypt. Encrypted. File) is an encrypted file that is generated by FileCrypt,
If you know the password that it was encrypted with it can be decrypted with FileCrypt using the `--mode=d`or `--mode=decrypt` flag.
### How is FileCrypt so small
Because Filecrypt
* Only uses the standard library
* Has no unwanted code
* Is built with `-ldflags "-s -w"` flag
* Executable is compressed with [upx](https://upx.github.io/) (Only extra small binaries)
## Docs
* [FCEF format](./docs/fcef_format.md)