https://github.com/potlaetu/fcrpyt

Fcrypt is a tool for file encryption and decryption in a CLI using Spring Shell
https://github.com/potlaetu/fcrpyt

java spring spring-shell

Last synced: about 2 months ago
JSON representation

Fcrypt is a tool for file encryption and decryption in a CLI using Spring Shell

• Host: GitHub
• URL: https://github.com/potlaetu/fcrpyt
• Owner: PotlaETU
• Created: 2024-09-08T16:00:36.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-09-12T13:26:27.000Z (5 months ago)
• Last Synced: 2024-12-19T04:08:04.365Z (about 2 months ago)
• Topics: java, spring, spring-shell
• Language: Java
• Homepage:
• Size: 82 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# FCrypt

Fcrypt is a CLI tool that aims to simplify the encryption of files.

It uses the AES algorithm to encrypt and decrypt files and Spring Shell to provide a CLI interface.

## List of commands

- `enc [filePath]` : Encrypt a file

- `dec [filePath]` : Decrypt a file

## Installation

```bash

mvn clean package

java -jar target/fcrypt-1.0.0.jar

```

Docker: 

```bash

docker build -t fcrypt .

```

or

```bash

docker pull anthorld/fcrypt

```

and then run the container to access directly the CLI:

```bash

docker run -it -v /path/to/your/files:/files fcrypt 

```

## Warnings

- The encryption key is stored in the `secret.key` file in the root directory of the project.

- The encryption key is generated randomly and is 256 bits long.

- The encryption key is not stored in the Docker image, so it will be generated each time the container is started.