RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-01-17 06:12:43 +01:00
Code Releases Activity

sys/crypto: update documentation

Browse Source
This commit is contained in:
Alexandre Abadie 2020-03-05 12:34:20 +01:00
parent f6c4e269b1
commit 08162f72b6
No known key found for this signature in database
GPG Key ID: 1C919A403CAE1405
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
sys/crypto/doc.txt
View File

@ -15,18 +15,18 @@
*
* @section ciphers Ciphers
*
* Riot supports the following block ciphers:
* RIOT supports the following block ciphers:
* * AES-128
* * 3DES (deprecated)
* * NULL
*
* You can use them directly by adding "crypto" to your USEMODULE-List.
* You can use them directly by adding `crypto_aes` or `crypto_3des` to your
* USEMODULE-List.
* 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
* Setting the CFLAGS initializes a sufficient large buffer size of the cipher_context_t,
* used by the ciphers for en-/de-cryption operations.
* Depending on the selected block ciphers, a sufficient large buffer size of
* the cipher_context_t is used for en-/de-cryption operations.
*
* Example:
* @code