cipher.h

Go to the documentation of this file.

 
#ifndef _CIPHER_H
#define _CIPHER_H
 
// Dependencies
#include "cipher/cipher_algorithms.h"
#include "cipher_modes/cipher_modes.h"
#include "core/cboot_error.h"
#include "boot_config.h"
 
#ifndef CIPHER_SUPPORT
#define CIPHER_SUPPORT DISABLED
#elif ((CIPHER_SUPPORT != ENABLED) && (CIPHER_SUPPORT != DISABLED))
#error CIPHER_SUPPORT parameter is not valid!
#endif
 
// Magic number used to check cipher key
#define CIPHER_MAGIC_NUMBER "5ef41578fcfbb9a98ffc218dde463d44"
#define CIPHER_MAGIC_NUMBER_SIZE 16
 
// Cipher initialization vector maximum size
#define MAX_CIPHER_IV_SIZE MAX_CIPHER_BLOCK_SIZE
 
// C++ guard
#ifdef __cplusplus
extern "C"
{
#endif
 
typedef struct
{
   CipherContext context;
   const CipherAlgo *algo;
   CipherMode mode;
   const uint8_t *key;
   size_t keyLen;
   uint8_t iv[MAX_CIPHER_IV_SIZE];
   size_t ivLen;
} CipherEngine;
 
// CycloneBOOT cipher engine related functions
cboot_error_t cipherInit(CipherEngine *engine, const CipherAlgo *algo, CipherMode mode,
   const uint8_t *key, size_t keyLen);
cboot_error_t cipherSetIv(CipherEngine *engine, uint8_t *iv, size_t ivLen);
cboot_error_t cipherGenerateIv(uint8_t *iv, size_t ivLen);
cboot_error_t cipherEncryptData(CipherEngine *cipherEngine, uint8_t *data, size_t length);
cboot_error_t cipherDecryptData(CipherEngine *cipherEngine, uint8_t *data, size_t length);
 
cboot_error_t cipherCheckMagicNumberCrc(uint32_t magicNumberCrc, bool_t *magicNumberIsValid);
cboot_error_t cipherComputeMagicNumberCrc(uint32_t *magicNumberCrc);
 
// C++ guard
#ifdef __cplusplus
}
#endif
 
#endif // !_CIPHER_H