Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mshernandez5 authored Jun 25, 2020
1 parent 3ae1f41 commit 1f90c99
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# aes-file-encrypt

A basic implementation of AES 128 in ECB mode using PKCS5 padding to encrypt files.
A basic implementation of AES 128/192/256 in ECB mode using PKCS5 padding to encrypt files.\
TODO: More Secure Modes, Multithreaded ECB

TODO: Larger Key Sizes (192/256), More Secure Modes

# Compiling

Compiling requires g++ and GNU Make
Expand All @@ -14,8 +13,15 @@ Remove the compiled classes and executable with `make clean`.

# Using

`./aesf <enc | dec> <input_file> <output_file> <options>` will prompt for an AES 128 key in hex format, ex. `00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F`
`./aesf <enc | dec> <input_file> <output_file> <options>`\
will prompt for an AES 128 key in hex format, ex. `00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F`

Alternatively, a key may be specified as a command line option with the use of `-k`,
# Options

ex. `./aesf <enc | dec> <input_file> <output_file> -k 000102030405060708090A0B0C0D0E0F`
A key may be specified as a command line option with the use of `-k`,\
ex. `./aesf <enc | dec> <input_file> <output_file> -k 000102030405060708090A0B0C0D0E0F`\
(Default: Prompt For Key)

The key size (128/192/256) may be specified with the use of `-s`,\
ex. `./aesf <enc | dec> <input_file> <output_file> -s 256 -k 1122334455667788990011223344556611223344556677889900112233445566`\
(Default: 128)

0 comments on commit 1f90c99

Please sign in to comment.