finn1y/ciphertool

A command line tool for encrypting and decrypting files with several different algorithms

CipherTool

About

Command line interface gui tool for encrypting and decrypting files or standard input using several different ciphers

Project by: Finn, JJ & James

The repository is split into: a source code directory containing all the source code and make files to buld the project; a test suite to test the project, which also includes a continous integration bash script to be run on the project before committing to the repository and a binary folder which contains pre-built binaries for windows and linux systems.

Help

Usage: cipher_tool [OPTION] --gui/--input-file=IN_FILE
Options:
  -c, --cipher=CIPHER           cipher to encrypt/decrypt with defaults to XOR
  -d, --decrypt                 tool will decrypt the input
  -e, --encrypt                 tool will encrypy the input default
  -g, --gui                     use the tool with gui
  -h, --help                    shows this message
  -i, --input-file=IN_FILE      file to read input data from required when not using gui
  -k, --key=KEY                 key used by some ciphers defualts to random key
                                see Ciphers for specific info on keys required for each cipher
  -o, --output-file=OUT_FILE    file to write output data to defaults to same as IN_FILE

Ciphers:
  XOR           KEY of any length as a string
  AES           KEY of any length as a string
  OTP           KEY of length equal to or greater than data as a string
  Caesars       KEY as an integer
  ROT13         no KEY taken
  Vigenere      KEY of any length as a string

Install

1. Clone the repo:

git clone https://github.com/finn1y/CipherTool.git

2. Navigate to the bin directory

3. Run the binary for your system:

   Linux

   ./cipher_tool-linux64 --gui
   

   Windows

   .\cipher_tool-win64.exe --gui
   

4. Happy encrypting!

Build your own binary

To build your own binary you must have make on your machine.

1. Clone the repo:

git clone https://github.com/finn1y/CipherTool.git

2. Navigate to the src directory
3. Run:

make all

4. Navigate to the bin directory
5. Run:

./cipher_tool --gui

6. Happy encrypting!