kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-28 16:01:18 +01:00
Code Releases Activity

Merge pull request #4787 from BytesGalore/doc_crypto_add_word_on_required_cflags

Browse Source 
doc crypto: add word on using required `CFLAGS`
This commit is contained in:
Cenk Gündoğan 2016-03-03 13:36:27 +01:00
commit e70c5d416e
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
sys/crypto/doc.txt
View File

@ -25,6 +25,13 @@
* While you can use the ciphers functions directly, you should resort to
* the generic API for block ciphers whenever possible.
*
* Additionally you need to set a CFLAG for each cipher you want to use in your Makefile:
* * AES-128: CFLAGS += -DCRYPTO_AES
* * 3DES: CFLAGS += -DCRYPTO_THREEDES
* * Twofish: CFLAGS += -DCRYPTO_TWOFISH
* Setting the CFLAGS initializes a sufficient large buffer size of the cipher_context_t,
* used by the ciphers for en-/de-cryption operations.
*
* Example:
* @code
* #include "crypto/ciphers.h"