https://github.com/brunocampos01/encrypt-file

:lock: :page_with_curl: CLI to encrypt or decrypt files with only one command.
https://github.com/brunocampos01/encrypt-file

aes aes-encryption aes-gcm decrypt decryption encrypt encryption encryption-decryption pbkdf2 pip python security security-tools sha256

Last synced: about 8 hours ago
JSON representation

:lock: :page_with_curl: CLI to encrypt or decrypt files with only one command.

• Host: GitHub
• URL: https://github.com/brunocampos01/encrypt-file
• Owner: brunocampos01
• License: mit
• Created: 2020-09-30T06:10:48.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2022-02-09T09:20:19.000Z (almost 3 years ago)
• Last Synced: 2024-10-11T17:44:56.510Z (about 1 month ago)
• Topics: aes, aes-encryption, aes-gcm, decrypt, decryption, encrypt, encryption, encryption-decryption, pbkdf2, pip, python, security, security-tools, sha256
• Language: Python
• Homepage: https://pypi.org/project/encrypt-file/
• Size: 77.1 KB
• Stars: 17
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# :page_with_curl:	_Encrypt File_ :lock: 

[![Python 3](https://img.shields.io/badge/Python-3-blue.svg)](https://www.python.org/downloads/release/python-381/)

![License](https://img.shields.io/badge/Code%20License-MIT-blue.svg)

CLI to encrypt or decrypt files with only one command

```bash

                                    __     _____ __   

  ___  ____  ____________  ______  / /_   / __(_) /__ 

 / _ \/ __ \/ ___/ ___/ / / / __ \/ __/  / /_/ / / _ \

/  __/ / / / /__/ /  / /_/ / /_/ / /_   / __/ / /  __/

\___/_/ /_/\___/_/   \__, / .___/\__/  /_/ /_/_/\___/ 

                    /____/_/                          

Encrypt or decrypt files with ONLY ONE COMMAND 

----------------------------------------------------------------------

PARAMETERS

func:		encrypt

password:	123456

file_path:	tests/plain_text.txt

Encrypting ...

Encrypted file at tests/plain_text.txt.enc

Execution time: 0.01 seconds                        

```

The _encrypt file_ is a **CLI** for encrypting and decrypting files.

## Why should I use the _encrypt file_?

- **No Code**: When there is no need to code something you can simply use _encrypt file_.

- **Abstraction of cryptographic algorithms**: you don't need to know what goes on behind the scenes in _encrypt file_ (but if you want, just see it on github).

## Requirements

This project is tested with:

| Requisite      | Version  |

|----------------|----------|

| Python         | 3.8.10   |

| Pip            | 21.2.4   |

## Install

```sh

pip install encrypt-file

```

## Usage

- :lock: Encrypt :lock:

```bash

encrypt-file \

          --func encrypt \

          --file plain_text.txt \

          --password 123456

```

- :unlock: Decrypt :unlock:

```bash

encrypt-file \

          --func decrypt \

          --file plain_text.txt.enc \

          --password 123456

```

## What is the security level?

- Even using low-quality passwords, _encrypt file_ tries to make things as secure as possible because it is implemented using **PBKDF2** key deviation with SHA256 hash, a 16-bit random salt and 10,000 rounds.

---