Update README.md

This commit is contained in:
Matteo Brichese 2018-04-05 16:15:32 -07:00 committed by GitHub
parent e0d35f2fde
commit d96ee60dee
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -6,18 +6,18 @@ Supports all key sizes - 128/192/256 bits - ECB, CBC and CFB modes
### Available Methods ### Available Methods
``` ```
//Encode of rawText with key // Encode of rawText with key
//iv is used in CBC mode // iv is used in CBC mode
//return the encrypted byte array // return the encrypted byte array
QByteArray encode(const QByteArray rawText, const QByteArray key, const QByteArray iv = NULL); QByteArray encode(const QByteArray rawText, const QByteArray key, const QByteArray iv = NULL);
//Decode of rawText with key // Decode of rawText with key
//iv is used in CBC mode // iv is used in CBC mode
//return the decrypted byte array // return the decrypted byte array
QByteArray decode(const QByteArray rawText, const QByteArray key, const QByteArray iv = NULL); QByteArray decode(const QByteArray rawText, const QByteArray key, const QByteArray iv = NULL);
//Key expansion in Rijndael schedule // Key expansion in Rijndael schedule
//return the new expanded key as byte array // return the new expanded key as byte array
QByteArray expandKey(const QByteArray key); QByteArray expandKey(const QByteArray key);
``` ```
The same methods are available as static calls The same methods are available as static calls
@ -26,6 +26,14 @@ QAESEncryption::Crypt => encode(...)
QAESEncryption::Decrypt => decode(...) QAESEncryption::Decrypt => decode(...)
QAESEncryption::ExpandKey => expandKey(...) QAESEncryption::ExpandKey => expandKey(...)
``` ```
#### AES Levels
The class supports all AES key lenghts
* AES_128
* AES_192
* AES_256
#### Modes #### Modes
The class supports the following operating modes The class supports the following operating modes