aes/readme.md

27 lines
897 B
Markdown

# this repository contains 3 Main :
- crypto.ex use for test ( take a file, crypt and decrypt this file in one step )
products a crypted and decrypted file.
- crypt.ex : allow to crypt a file with aes algorithms
./crypt.ex <FileToCrypt>
products the crypted file and a json file which contain aes key and aes IV key.
- decrypt.ex : allow to uncrypt a file from a crypted file and a json key file.
./decrypt.ex <FileToDecrypt> <aesKeyFile>
products the uncrypted file.
:smiley:
## requirements
* this program required jsoncpp : https://github.com/open-source-parsers/jsoncpp
> archlinux setup : `pacman -S jsoncpp`
* gcc lib flag are retrieve thanks to [pkg-config](https://people.freedesktop.org/~dbn/pkg-config-guide.html) tool
* cpp documentation is generated thanks to [doxygen](http://www.doxygen.nl/manual/doxygen_usage.html)
> use make doc to generate doxygen documentation