summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorkokke <spam@rowdy.dk>2017-07-08 01:51:43 +0200
committerGitHub <noreply@github.com>2017-07-08 01:51:43 +0200
commit4fd333ea76281644d391f7db2d1ef07814f348bc (patch)
treeea6117e093d14445bc66346b22fb4e9ec99448e3 /README.md
parentUpdate test.c (diff)
parentremoved unecessary blockcopy (diff)
downloadtiny-AES-c-4fd333ea76281644d391f7db2d1ef07814f348bc.tar
tiny-AES-c-4fd333ea76281644d391f7db2d1ef07814f348bc.tar.gz
tiny-AES-c-4fd333ea76281644d391f7db2d1ef07814f348bc.tar.bz2
tiny-AES-c-4fd333ea76281644d391f7db2d1ef07814f348bc.tar.lz
tiny-AES-c-4fd333ea76281644d391f7db2d1ef07814f348bc.tar.xz
tiny-AES-c-4fd333ea76281644d391f7db2d1ef07814f348bc.tar.zst
tiny-AES-c-4fd333ea76281644d391f7db2d1ef07814f348bc.zip
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 9 insertions, 10 deletions
diff --git a/README.md b/README.md
index c261b78..374a02c 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,20 @@
-### Tiny AES128 in C
+### Tiny AES in C
-This is a small and portable implementation of the AES128 ECB and CBC encryption algorithms written in C.
+This is a small and portable implementation of the AES ECB and CBC encryption algorithms written in C.
The API is very simple and looks like this (I am using C99 `<stdint.h>`-style annotated types):
```C
-void AES128_ECB_encrypt(uint8_t* input, const uint8_t* key, uint8_t* output);
-void AES128_ECB_decrypt(uint8_t* input, const uint8_t* key, uint8_t* output);
-void AES128_CBC_encrypt_buffer(uint8_t* output, uint8_t* input, uint32_t length, const uint8_t* key, const uint8_t* iv);
-void AES128_CBC_decrypt_buffer(uint8_t* output, uint8_t* input, uint32_t length, const uint8_t* key, const uint8_t* iv);
+void AES_ECB_encrypt(uint8_t* input, const uint8_t* key, uint8_t* output);
+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
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.
-There is no built-in error checking or protection from out-of-bounds memory access errors as a result of malicious input. The two functions AES128_ECB_xxcrypt() do most of the work, and they expect inputs of 128 bit length.
+There is no built-in error checking or protection from out-of-bounds memory access errors as a result of malicious input. The two functions AES_ECB_xxcrypt() do most of the work, and they expect inputs of 128 bit length.
The module uses around 200 bytes of RAM and 2.5K ROM when compiled for ARM (~2K for Thumb but YMMV).
@@ -57,9 +58,7 @@ I am using Mentor Graphics free ARM toolchain:
This implementation is verified against the data in:
-[National Institute of Standards and Technology Special Publication 800-38A 2001 ED](http://csrc.nist.gov/publications/nistpubs/800-38a/sp800-38a.pdf) Appendix F: Example Vectors for Modes of Operation of the AES.
+[National Institute of Standards and Technology Special Publication 800-38A 2001 ED](http://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38a.pdf) Appendix F: Example Vectors for Modes of Operation of the AES.
All material in this repository is in the public domain.
-
-I am a bit slow to react to pull requests and issues, but I have an ambition to go through all issues sometime in the future and release an API-stable version.