/* ChibiOS - Copyright (C) 2006..2016 Giovanni Di Sirio Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ /** * @file hal_crypto.h * @brief Cryptographic Driver macros and structures. * * @addtogroup CRYPTO * @{ */ #ifndef HAL_CRYPTO_H #define HAL_CRYPTO_H #if (HAL_USE_CRY == TRUE) || defined(__DOXYGEN__) /*===========================================================================*/ /* Driver constants. */ /*===========================================================================*/ /** * #brief Maximum size of a key for all supported algorithms. */ #define HAL_CRY_MAX_KEY_SIZE 32 /*===========================================================================*/ /* Driver pre-compile time settings. */ /*===========================================================================*/ /** * @brief Enables the SW fall-back of the cryptographic driver. * @details When enabled, this option, activates a fall-back software * implementation for algorithms not supported by the underlying * hardware. * @note Fall-back implementations may not be present for all algorithms. */ #if !defined(HAL_CRY_USE_FALLBACK) || defined(__DOXYGEN__) #define HAL_CRY_USE_FALLBACK FALSE #endif /** * @brief Makes the driver forcibly use the fall-back implementations. */ #if !defined(HAL_CRY_ENFORCE_FALLBACK) || defined(__DOXYGEN__) #define HAL_CRY_ENFORCE_FALLBACK FALSE #endif /*===========================================================================*/ /* Derived constants and error checks. */ /*===========================================================================*/ #if HAL_CRY_ENFORCE_FALLBACK == TRUE #undef HAL_CRY_USE_FALLBACK #define HAL_CRY_USE_FALLBACK TRUE #endif /*===========================================================================*/ /* Driver data structures and types. */ /*===========================================================================*/ /** * @brief Size, in bits, of a crypto field or message. * @note It is assumed, for simplicity, that this type is equivalent to * a @p size_t. */ typedef size_t bitsize_t; /** * @brief Driver state machine possible states. */ typedef enum { CRY_UNINIT = 0, /**< Not initialized. */ CRY_STOP = 1, /**< Stopped. */ CRY_READY = 2 /**< Ready. */ } crystate_t; /** * @brief Driver error codes. */ typedef enum { CRY_NOERROR = 0, /**< No error. */ CRY_ERR_INV_ALGO = 1, /**< Invalid cypher/mode. */ CRY_ERR_INV_KEY_SIZE = 2, /**< Invalid key size. */ CRY_ERR_INV_KEY_TYPE = 3, /**< Invalid key type. */ CRY_ERR_INV_KEY_ID = 4 /**< Invalid key type. */ } cryerror_t; /** * @brief Type of an algorithm identifier. * @note It is only used to determine the key required for operations. */ typedef enum { cry_algo_none = 0, cry_algo_aes, cry_algo_des, cry_algo_tripledes } cryalgorithm_t; #if HAL_CRY_ENFORCE_FALLBACK == FALSE /* Use the defined low level driver.*/ #include "hal_crypto_lld.h" #else /* No LLD at all, using the standalone mode.*/ #define CRY_LLD_SUPPORTS_AES_ECB FALSE #define CRY_LLD_SUPPORTS_AES_CBC FALSE #define CRY_LLD_SUPPORTS_AES_CFB FALSE #define CRY_LLD_SUPPORTS_AES_CTR FALSE #define CRY_LLD_SUPPORTS_AES_GCM FALSE typedef uint_fast8_t crykey_t; typedef struct CRYDriver CRYDriver; typedef struct { uint32_t dummy; } CRYConfig; struct CRYDriver { crystate_t state; const CRYConfig *config; cryalgorithm_t key0_type; size_t key0_size; uint8_t key0_buffer[HAL_CRY_MAX_KEY_SIZE]; }; #endif #if !defined(CRY_LLD_SUPPORTS_AES_ECB) || \ !defined(CRY_LLD_SUPPORTS_AES_CBC) || \ !defined(CRY_LLD_SUPPORTS_AES_CFB) || \ !defined(CRY_LLD_SUPPORTS_AES_CTR) || \ !defined(CRY_LLD_SUPPORTS_AES_GCM) #error "CRYPTO LLD does not export the required switches" #endif /*===========================================================================*/ /* Driver macros. */ /*===========================================================================*/ /** * @name Low level driver helper macros * @{ */ /** @} */ /*===========================================================================*/ /* External declarations. */ /*===========================================================================*/ #ifdef __cplusplus extern "C" { #endif void cryInit(void); void cryObjectInit(CRYDriver *cryp); void cryStart(CRYDriver *cryp, const CRYConfig *config); void cryStop(CRYDriver *cryp); cryerror_t cryLoadTransientKey(CRYDriver *cryp, cryalgorithm_t algorithm, size_t size, const uint8_t *keyp); cryerror_t cryEncryptAES_ECB(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out); cryerror_t cryDecryptAES_ECB(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out); cryerror_t cryEncryptAES_CBC(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out, const uint8_t *iv); cryerror_t cryDecryptAES_CBC(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out, const uint8_t *iv); cryerror_t cryEncryptAES_CFB(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out, const uint8_t *iv); cryerror_t cryDecryptAES_CFB(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out, const uint8_t *iv); cryerror_t cryEncryptAES_CTR(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out, const uint8_t *iv); cryerror_t cryDecryptAES_CTR(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out, const uint8_t *iv); cryerror_t cryEncryptAES_GCM(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out, const uint8_t *iv, size_t aadsize, const uint8_t *aad, uint8_t *authtag); cryerror_t cryDecryptAES_GCM(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out, const uint8_t *iv, size_t aadsize, const uint8_t *aad, uint8_t *authtag); #ifdef __cplusplus } #endif #endif /* HAL_USE_CRYPTO == TRUE */ #endif /* HAL_CRYPTO_H */ /** @} */