2021-csci-ga3205-hw-09/README.md

22 lines
1.0 KiB
Markdown
Raw Normal View History

2021-11-08 00:11:18 +00:00
# 2021 CSCI-GA3205 Homework 09
2021-11-10 19:52:26 +00:00
Author: Vicky Rampin
2021-11-08 00:11:18 +00:00
2021-11-10 19:52:26 +00:00
## Prompt
**AES Encryption Implementation**: write a program to encrypt and decrypt a file using the AES algorithm. You can implement the functions you need or use the libraries.
2021-11-08 00:13:16 +00:00
2021-11-10 19:52:26 +00:00
## Installation
2021-11-12 04:21:05 +00:00
This script is made with Python 3.8 and uses the `argparse` and `pycryptodome` libraries. Ensure that you have [Python 3.8+](https://www.python.org/downloads/) and these libraries installed in order to run this script correctly.
2021-11-08 00:13:16 +00:00
2021-11-10 19:52:26 +00:00
## Usage
First, clone this repository to your machine. Open the command line on your machine and navigate to where you cloned this repository. To get help using `cd`, use [this tutorial](https://swcarpentry.github.io/shell-novice/02-filedir/index.html).
2021-11-12 04:21:05 +00:00
Before running the script, you should know it expects one argument:
1. `--file` or `-f` : provide a path to the file that you want to decrypt
2021-11-10 19:52:26 +00:00
With this in mind, you can run it like so:
```
2021-11-12 04:21:05 +00:00
$ python index.py --file=README.md
2021-11-10 19:52:26 +00:00
```
2021-11-12 04:21:05 +00:00
It will encrypt and decrypt the file, and print the contents.