tiny-AES-c/README.md

64 lines
2.3 KiB
Markdown
Raw Normal View History

2014-05-30 16:25:47 +04:00
### Tiny AES128 in C
2014-05-30 16:24:49 +04:00
2014-12-15 23:30:25 +03:00
This is a small and portable implementation of the AES128 ECB and CBC encryption algorithms written in C.
2014-05-31 02:45:54 +04:00
2014-07-13 06:16:34 +04:00
The API is very simple and looks like this (I am using C99 `<stdint.h>`-style annotated types):
2014-07-12 04:24:10 +04:00
2014-07-12 04:26:22 +04:00
```C
2014-12-11 02:10:38 +03:00
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);
2014-12-15 23:30:25 +03:00
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);
2014-07-12 04:25:58 +04:00
```
2014-07-12 04:24:10 +04:00
2014-12-15 23:30:25 +03:00
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.
2014-12-11 01:34:55 +03:00
The module uses around 200 bytes of RAM and 2.5K ROM when compiled for ARM (~2K for Thumb but YMMV).
2014-05-31 02:45:54 +04:00
2014-05-31 02:45:42 +04:00
It is the smallest implementation in C I've seen yet, but do contact me if you know of something smaller (or have improvements to the code here).
2014-05-29 04:29:06 +04:00
2014-05-29 04:43:12 +04:00
2014-05-31 02:45:42 +04:00
I've successfully used the code on 64bit x86, 32bit ARM and 8 bit AVR platforms.
2014-05-29 04:29:06 +04:00
2014-05-29 04:43:12 +04:00
2014-12-15 23:32:42 +03:00
GCC size output when ECB mode is compiled for ARM:
2014-05-29 04:43:12 +04:00
2014-05-30 16:26:31 +04:00
2014-05-29 05:50:24 +04:00
2014-12-15 23:32:42 +03:00
$ arm-none-eabi-gcc -Os -c aes.c -DCBC=0
2014-06-03 00:35:03 +04:00
$ size aes.o
text data bss dec hex filename
2014-12-11 01:33:59 +03:00
2323 0 184 2507 9cb aes.o
2014-06-03 00:35:03 +04:00
2014-05-31 02:46:46 +04:00
2014-07-12 22:53:20 +04:00
.. and when compiling for the THUMB instruction set, we end up around 2K in code size.
2014-07-12 22:52:42 +04:00
2014-12-15 23:32:42 +03:00
$ arm-none-eabi-gcc -mthumb -Os -c aes.c -DCBC=0
2014-07-12 22:52:42 +04:00
$ size aes.o
text data bss dec hex filename
2014-12-11 01:33:59 +03:00
1775 0 184 1959 7a7 aes.o
2014-07-12 22:52:42 +04:00
2014-07-10 20:50:18 +04:00
I am using Mentor Graphics free ARM toolchain:
2014-05-29 04:43:12 +04:00
2014-05-31 02:46:46 +04:00
2014-05-30 16:31:32 +04:00
$ arm-none-eabi-gcc --version
2014-07-13 06:18:42 +04:00
arm-none-eabi-gcc (GNU Tools for ARM Embedded Processors) 4.8.4 20140526 (release) [ARM/embedded-4_8-branch revision 211358]
2014-05-30 16:31:32 +04:00
Copyright (C) 2013 Free Software Foundation, Inc.
This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
2014-05-29 05:58:14 +04:00
2014-05-29 06:04:06 +04:00
2014-05-31 02:46:46 +04:00
2014-07-13 06:18:42 +04:00
This implementation is verified against the data in:
2014-05-31 02:46:13 +04:00
2014-05-31 02:42:28 +04:00
[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.
2014-05-30 16:35:26 +04:00
2014-05-31 02:45:42 +04:00
2014-09-09 01:46:59 +04:00
All material in this repository is in the public domain.
2014-05-31 02:45:42 +04:00