diff --git a/README.md b/README.md index 2eaf65c..a1c6996 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,27 @@ # 2021 CSCI-GA3205 Homework 09 +Author: Vicky Rampin -Vicky Rampin +## 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. -Pick one of the following and implement: +## Installation +This script is made with Python 3.8 and uses the `argparse` and `pathlib` libraries. Ensure that you have [Python 3.8+](https://www.python.org/downloads/) installed in order to run this script correctly. -1) **Network Packet sniffer**. Packet sniffers are programs that intercept the network traffic flowing in and out of a system through network interfaces. Packet sniffers can be coded by either using sockets API provided by the kernel, or by using some packet capture libraries. Write a program and implement your own packet sniffer in your programming language of choice. -2) **RSA Encryption Implementation**. Write a program to encrypt and decrypt a message (string) using the RSA algorithm. You can implement the functions you need or use the libraries. -3) **Hash generator**. Think of designing your own hash generator and then implementing it in your programming language of choice. It doesn't have to outperform SHA! It could be so easy as converting letters to their Hex values and running a formula. I believe you can be more creative though :) -4) **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. +## 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). + +Before running the script, you should know it expects two arguments: +1. `--file` : provide a path to the file that you want to decrypt +2. `modality`: either encrypt and decrypt, tells the script which activity you'd like to do + +With this in mind, you can run it like so: + +``` +$ python index.py --file=README.md encrypt +``` + +Or like this: + +``` +$ python index.py --file=/home/user/Desktop/secureFile.txt decrypt +```