Update README.md

This commit is contained in:
kokke
2017-07-08 03:45:30 +02:00
committed by GitHub
parent a97324ad53
commit a0fd51ae85

View File

@@ -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.