Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ezhil56x/file-encryption-cli
File Encryption is command-line tool used to encrypt and decrypt files using AES and RSA encryption algorithms
https://github.com/ezhil56x/file-encryption-cli
cli cli-tools command-line-tool encryption-decryption file-encryption file-encryption-python python-encryption
Last synced: 10 days ago
JSON representation
File Encryption is command-line tool used to encrypt and decrypt files using AES and RSA encryption algorithms
- Host: GitHub
- URL: https://github.com/ezhil56x/file-encryption-cli
- Owner: ezhil56x
- License: mit
- Created: 2023-08-05T20:16:23.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-05T20:16:44.000Z (over 1 year ago)
- Last Synced: 2023-08-05T21:27:17.874Z (over 1 year ago)
- Topics: cli, cli-tools, command-line-tool, encryption-decryption, file-encryption, file-encryption-python, python-encryption
- Language: Python
- Homepage:
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# File Encryption CLI
## Description
File Encryption is command-line tool used to encrypt and decrypt files using AES and RSA encryption algorithms. It is written in Python and uses the `PyCryptoDome` library.
## Requirements
- Python 3.6 or above
- `PyCryptoDome` library
## Installation
1. Install pycryptodome library
```
pip install pycryptodome
```
2. Clone the repository
```
git clone https://github.com/ezhil56x/file-encryption-cli.git
```
3. Go to file-encryption-cli directory
```
cd file-encryption-cli
```
4. Take a look at the help menu to see the usage of the tool
```
python file_encrypt.py --help
```
```
python file_decrypt.py --help
```
## Usage
### AES Encryption
#### Encrypting a File
To encrypt a file, using AES encryption, use the following command
```
python file_encrypt.py --file --algorithm AES --key
```
#### Decrypting a File
To decrypt a file, using AES encryption, use the following command
```
python file_decrypt.py --file --algorithm AES --key
```
### RSA Encryption
For RSA encryption, you need to generate public and private keys. You can use the `key_generator.py` script to generate the keys. And the keys will be stored in `public.pem` and `private.pem` files. You should move these files to the same directory as the `file_encrypt.py` and `file_decrypt.py` scripts.
#### Encrypting a File
To encrypt a file, using RSA encryption, use the following command
```
python file_encrypt.py --file --algorithm RSA --key public.pem
```
#### Decrypting a File
To decrypt a file, using RSA encryption, use the following command
```
python file_decrypt.py --file --algorithm RSA --key private.pem
```
#### Generating public and private keys
To generate public and private keys, go to RSA folder and run the following command
```
python key_generator.py
```