Crypto

RIOT provides a collection of block cipher ciphers, different operation modes and cryptographic hash algorithms. More...

Detailed Description

RIOT provides a collection of block cipher ciphers, different operation modes and cryptographic hash algorithms.

Ciphers

RIOT supports the following block ciphers:

• AES-128
• 3DES (deprecated)
• NULL

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.

Depending on the selected block ciphers, a sufficient large buffer size of the cipher_context_t is used for en-/de-cryption operations.

Example:

#include "crypto/ciphers.h"
 
cipher_t cipher;
uint8_t key[AES_KEY_SIZE] = {0},
        plain_text[AES_BLOCK_SIZE] = {0},
        cipher_text[AES_BLOCK_SIZE] = {0};
 
if (cipher_init(&cipher, CIPHER_AES_128, key, AES_KEY_SIZE) < 0)
    printf("Cipher init failed!\n");
 
if (cipher_encrypt(&cipher, plain_text, cipher_text) < 0)
    printf("Cipher encryption failed!\n");
else
    od_hex_dump(cipher_text, AES_BLOCK_SIZE, 0);

Some aspects of the AES implementation can be fine tuned by pseudo-modules:

• crypto_aes_precalculated: Use pre-calculated T-tables. This improved speed at the expense of increased program size. The default is to calculate most tables on the fly.
• crypto_aes_unroll: enable manually-unrolled loops. The default is to not have them unrolled.

If you need to encrypt data of arbitrary size take a look at the different operation modes like: CBC, CTR or CCM.

Additional examples can be found in the test suite.

Modules
	HACL* High Assurance Cryptographic Library
	Support for HACL* (High Assurance Cryptographic Library)
	Lightweight ASN.1 decoding/encoding library
	Lightweight ASN.1 decoding/encoding library.
	Micro-ECC for RIOT
	Micro-ECC for RIOT.
	Microchip CryptoAuthentication Library
	Provides the library for Microchip CryptoAuth devices.
	Relic toolkit for RIOT
	Provides the Relic cryptographic toolkit to RIOT.
	chacha20poly1305 AEAD cipher
	Provides RFC 8439 style chacha20poly1305.
	poly1305
	Poly1305 one-time message authentication code.

Files
file	aes.h
	Headers for the implementation of the AES cipher-algorithm.
file	chacha.h
	ChaCha stream cipher.
file	ciphers.h
	Headers for the packet encryption class. They are used to encrypt single packets.
file	helper.h
	helper functions for sys_crypto_modes
file	cbc.h
	Cipher block chaining mode of operation for block ciphers.
file	ccm.h
	Counter with CBC-MAC mode of operation for block ciphers.
file	ctr.h
	Counter mode of operation for block ciphers.
file	ecb.h
	Electronic code book mode of operation for block ciphers.
file	ocb.h
	Offset Codebook (OCB3) AEAD mode as specified in RFC 7253.