summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorkokke <spam@rowdy.dk>2021-01-06 18:07:35 +0100
committerGitHub <noreply@github.com>2021-01-06 18:07:35 +0100
commit7f70d54d6e8e22dec58a59254f53c3e66e978199 (patch)
treea630148722f0134b4fe04a8bcadca3d7b61107bb /README.md
parentUpdate README.md (diff)
downloadtiny-AES-c-7f70d54d6e8e22dec58a59254f53c3e66e978199.tar
tiny-AES-c-7f70d54d6e8e22dec58a59254f53c3e66e978199.tar.gz
tiny-AES-c-7f70d54d6e8e22dec58a59254f53c3e66e978199.tar.bz2
tiny-AES-c-7f70d54d6e8e22dec58a59254f53c3e66e978199.tar.lz
tiny-AES-c-7f70d54d6e8e22dec58a59254f53c3e66e978199.tar.xz
tiny-AES-c-7f70d54d6e8e22dec58a59254f53c3e66e978199.tar.zst
tiny-AES-c-7f70d54d6e8e22dec58a59254f53c3e66e978199.zip
Diffstat (limited to '')
-rw-r--r--README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.md b/README.md
index 8731992..6cedcfc 100644
--- a/README.md
+++ b/README.md
@@ -25,10 +25,10 @@ void AES_CBC_decrypt_buffer(struct AES_ctx* ctx, uint8_t* buf, size_t length);
void AES_CTR_xcrypt_buffer(struct AES_ctx* ctx, uint8_t* buf, size_t length);
```
-Note:
+Important notes:
* No padding is provided so for CBC and ECB all buffers should be multiples of 16 bytes. For padding [PKCS7](https://en.wikipedia.org/wiki/Padding_(cryptography)#PKCS7) is recommendable.
* ECB mode is considered unsafe for most uses and is not implemented in streaming mode. If you need this mode, call the function for every block of 16 bytes you need encrypted. See [wikipedia's article on ECB](https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation#Electronic_Codebook_(ECB)) for more details.
- * This library is not super fast. It is intended for portability and small size, not high speed. OpenSSL for example, is probably much faster.
+ * This library is designed for small code size and simplicity, intended for cases where small binary size, low memory footprint and portability is more important than high performance. If speed is a concern, you can try more complex libraries, e.g. [Mbed TLS](https://tls.mbed.org/), [OpenSSL](https://www.openssl.org/) etc.
You can choose to use any or all of the modes-of-operations, by defining the symbols CBC, CTR or ECB. See the header file for clarification.