summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorkokke <spam@rowdy.dk>2017-07-08 03:45:30 +0200
committerGitHub <noreply@github.com>2017-07-08 03:45:30 +0200
commita0fd51ae85798711088f38a6417a018741b4c245 (patch)
tree832c19e35db11a5b93c89cbe13e255ea7daa8a76 /README.md
parentUpdate aes.c (diff)
downloadtiny-AES-c-a0fd51ae85798711088f38a6417a018741b4c245.tar
tiny-AES-c-a0fd51ae85798711088f38a6417a018741b4c245.tar.gz
tiny-AES-c-a0fd51ae85798711088f38a6417a018741b4c245.tar.bz2
tiny-AES-c-a0fd51ae85798711088f38a6417a018741b4c245.tar.lz
tiny-AES-c-a0fd51ae85798711088f38a6417a018741b4c245.tar.xz
tiny-AES-c-a0fd51ae85798711088f38a6417a018741b4c245.tar.zst
tiny-AES-c-a0fd51ae85798711088f38a6417a018741b4c245.zip
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index 179ee15..add3d34 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,8 @@
This is a small and portable implementation of the AES ECB and CBC encryption algorithms written in C.
+You can override the default 128bit key with a 192 or 256bit by defining the symbols AES192 or AES256 in `aes.h`.
+
The API is very simple and looks like this (I am using C99 `<stdint.h>`-style annotated types):
```C
@@ -10,7 +12,7 @@ void AES_ECB_decrypt(uint8_t* input, const uint8_t* key, uint8_t* output);
void AES_CBC_encrypt_buffer(uint8_t* output, uint8_t* input, uint32_t length, const uint8_t* key, const uint8_t* iv);
void AES_CBC_decrypt_buffer(uint8_t* output, uint8_t* input, uint32_t length, const uint8_t* key, const uint8_t* iv);
```
-You can choose to use the standard 128b key or 192/256b by defining the symbols AES192 or AES256 in `aes.h` - AES128 is defined by default.
+
You can choose to use one or both of the modes-of-operation, by defining the symbols CBC and ECB. See the header file for clarification.