/* 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.c * @brief Cryptographic Driver code. * * @addtogroup CRYPTO * @{ */ #include "hal.h" #if (HAL_USE_CRY == TRUE) || defined(__DOXYGEN__) /*===========================================================================*/ /* Driver local definitions. */ /*===========================================================================*/ /*===========================================================================*/ /* Driver exported variables. */ /*===========================================================================*/ /*===========================================================================*/ /* Driver local variables and types. */ /*===========================================================================*/ /*===========================================================================*/ /* Driver local functions. */ /*===========================================================================*/ /*===========================================================================*/ /* Driver exported functions. */ /*===========================================================================*/ /** * @brief Cryptographic Driver initialization. * @note This function is implicitly invoked by @p halInit(), there is * no need to explicitly initialize the driver. * * @init */ void cryInit(void) { #if HAL_CRY_ENFORCE_FALLBACK == FALSE cry_lld_init(); #endif } /** * @brief Initializes the standard part of a @p CRYDriver structure. * * @param[out] cryp pointer to the @p CRYDriver object * * @init */ void cryObjectInit(CRYDriver *cryp) { cryp->state = CRY_STOP; cryp->config = NULL; #if defined(CRY_DRIVER_EXT_INIT_HOOK) CRY_DRIVER_EXT_INIT_HOOK(cryp); #endif } /** * @brief Configures and activates the cryptographic peripheral. * * @param[in] cryp pointer to the @p CRYDriver object * @param[in] config pointer to the @p CRYConfig object. Depending on * the implementation the value can be @p NULL. * * @api */ void cryStart(CRYDriver *cryp, const CRYConfig *config) { osalDbgCheck(cryp != NULL); osalSysLock(); osalDbgAssert((cryp->state == CRY_STOP) || (cryp->state == CRY_READY), "invalid state"); cryp->config = config; #if HAL_CRY_ENFORCE_FALLBACK == FALSE cry_lld_start(cryp); #endif cryp->state = CRY_READY; osalSysUnlock(); } /** * @brief Deactivates the cryptographic peripheral. * * @param[in] cryp pointer to the @p CRYDriver object * * @api */ void cryStop(CRYDriver *cryp) { osalDbgCheck(cryp != NULL); osalSysLock(); osalDbgAssert((cryp->state == CRY_STOP) || (cryp->state == CRY_READY), "invalid state"); #if HAL_CRY_ENFORCE_FALLBACK == FALSE cry_lld_stop(cryp); #endif cryp->config = NULL; cryp->state = CRY_STOP; osalSysUnlock(); } /** * @brief Initializes the transient key for a specific algorithm. * * @param[in] cryp pointer to the @p CRYDriver object * @param[in] algorithm the algorithm identifier * @param[in] size key size in bytes * @param[in] keyp pointer to the key data * @return The operation status. * @retval CRY_NOERROR if the operation succeeded. * @retval CRY_ERR_INV_ALGO if the specified algorithm is unknown or * unsupported. * @retval CRY_ERR_INV_KEY_SIZE if the specified key size is invalid. * * @api */ cryerror_t cryLoadTransientKey(CRYDriver *cryp, cryalgorithm_t algorithm, size_t size, const uint8_t *keyp) { cryerror_t err; osalDbgCheck((cryp != NULL) && (size <= HAL_CRY_MAX_KEY_SIZE) && (keyp != NULL)); #if HAL_CRY_ENFORCE_FALLBACK == FALSE /* Key setup in the low level driver.*/ err = cry_lld_loadkey(cryp, algorithm, size, keyp); #else err = CRY_ERR_INV_ALGO; #endif #if HAL_CRY_USE_FALLBACK == TRUE if (err == CRY_ERR_INV_ALGO) { err = cry_fallback_loadkey(cryp, algorithm, size, keyp); } #endif if (err == CRY_NOERROR) { /* Storing the transient key info.*/ cryp->key0_type = algorithm; cryp->key0_size = size; } return err; } /** * @brief Encryption operation using AES-ECB. * @note The function operates on data buffers whose lenght is a multiple * of an AES block, this means that padding must be done by the * caller. * * @param[in] cryp pointer to the @p CRYDriver object * @param[in] key_id the key to be used for the operation, zero is the * transient key, other values are keys stored in an * unspecified way * @param[in] size size of the plaintext buffer, this number must be a * multiple of 16 * @param[in] in buffer containing the input plaintext * @param[out] out buffer for the output cyphertext * @return The operation status. * @retval CRY_NOERROR if the operation succeeded. * @retval CRY_ERR_INV_ALGO if the operation is unsupported on this * device instance. * @retval CRY_ERR_INV_KEY_TYPE the selected key is invalid for this operation. * @retval CRY_ERR_INV_KEY_ID if the specified key identifier is invalid * or refers and empty key slot. * * @api */ cryerror_t cryEncryptAES_ECB(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out) { osalDbgCheck((cryp != NULL) && (in != NULL) && (out != NULL) && ((size & (size_t)15) == (size_t)0)); osalDbgAssert(cryp->state == CRY_READY, "not ready"); #if CRY_LLD_SUPPORTS_AES_ECB == TRUE return cry_lld_encrypt_AES_ECB(cryp, key_id, size, in, out); #elif HAL_CRY_USE_FALLBACK == TRUE return cry_fallback_encrypt_AES_ECB(cryp, key_id, size, in, out); #else (void)cryp; (void)key_id; (void)size; (void)in; (void)out; return CRY_ERR_INV_ALGO; #endif } /** * @brief Decryption operation using AES-ECB. * @note The function operates on data buffers whose lenght is a multiple * of an AES block, this means that padding must be done by the * caller. * * @param[in] cryp pointer to the @p CRYDriver object * @param[in] key_id the key to be used for the operation, zero is the * transient key, other values are keys stored in an * unspecified way * @param[in] size size of the plaintext buffer, this number must be a * multiple of 16 * @param[in] in buffer containing the input cyphertext * @param[out] out buffer for the output plaintext * @return The operation status. * @retval CRY_NOERROR if the operation succeeded. * @retval CRY_ERR_INV_ALGO if the operation is unsupported on this * device instance. * @retval CRY_ERR_INV_KEY_TYPE the selected key is invalid for this operation. * @retval CRY_ERR_INV_KEY_ID if the specified key identifier is invalid * or refers and empty key slot. * * @api */ cryerror_t cryDecryptAES_ECB(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out) { osalDbgCheck((cryp != NULL) && (in != NULL) && (out != NULL) && ((size & (size_t)15) == (size_t)0)); osalDbgAssert(cryp->state == CRY_READY, "not ready"); #if CRY_LLD_SUPPORTS_AES_ECB == TRUE return cry_lld_decrypt_AES_ECB(cryp, key_id, size, in, out); #elif HAL_CRY_USE_FALLBACK == TRUE return cry_fallback_decrypt_AES_ECB(cryp, key_id, size, in, out); #else (void)cryp; (void)key_id; (void)size; (void)in; (void)out; return CRY_ERR_INV_ALGO; #endif } /** * @brief Encryption operation using AES-CBC. * @note The function operates on data buffers whose lenght is a multiple * of an AES block, this means that padding must be done by the * caller. * * @param[in] cryp pointer to the @p CRYDriver object * @param[in] key_id the key to be used for the operation, zero is the * transient key, other values are keys stored in an * unspecified way * @param[in] size size of the plaintext buffer, this number must be a * multiple of 16 * @param[in] in buffer containing the input plaintext * @param[out] out buffer for the output cyphertext * @param[in] iv 128 bits initial vector * @return The operation status. * @retval CRY_NOERROR if the operation succeeded. * @retval CRY_ERR_INV_ALGO if the operation is unsupported on this * device instance. * @retval CRY_ERR_INV_KEY_TYPE the selected key is invalid for this operation. * @retval CRY_ERR_INV_KEY_ID if the specified key identifier is invalid * or refers and empty key slot. * * @api */ cryerror_t cryEncryptAES_CBC(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out, const uint8_t *iv) { osalDbgCheck((cryp != NULL) && (in != NULL) && (out != NULL) && (iv != NULL) && ((size & (size_t)15) == (size_t)0)); osalDbgAssert(cryp->state == CRY_READY, "not ready"); #if CRY_LLD_SUPPORTS_AES_CBC == TRUE return cry_lld_encrypt_AES_CBC(cryp, key_id, size, in, out, iv); #elif HAL_CRY_USE_FALLBACK == TRUE return cry_fallback_encrypt_AES_CBC(cryp, key_id, size, in, out, iv); #else (void)cryp; (void)key_id; (void)size; (void)in; (void)out; (void)iv; return CRY_ERR_INV_ALGO; #endif } /** * @brief Decryption operation using AES-CBC. * @note The function operates on data buffers whose lenght is a multiple * of an AES block, this means that padding must be done by the * caller. * * @param[in] cryp pointer to the @p CRYDriver object * @param[in] key_id the key to be used for the operation, zero is the * transient key, other values are keys stored in an * unspecified way * @param[in] size size of the plaintext buffer, this number must be a * multiple of 16 * @param[in] in buffer containing the input cyphertext * @param[out] out buffer for the output plaintext * @param[in] iv 128 bits initial vector * @return The operation status. * @retval CRY_NOERROR if the operation succeeded. * @retval CRY_ERR_INV_ALGO if the operation is unsupported on this * device instance. * @retval CRY_ERR_INV_KEY_TYPE the selected key is invalid for this operation. * @retval CRY_ERR_INV_KEY_ID if the specified key identifier is invalid * or refers and empty key slot. * * @api */ cryerror_t cryDecryptAES_CBC(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out, const uint8_t *iv) { osalDbgCheck((cryp != NULL) && (in != NULL) && (out != NULL) && (iv != NULL) && ((size & (size_t)15) == (size_t)0)); osalDbgAssert(cryp->state == CRY_READY, "not ready"); #if CRY_LLD_SUPPORTS_AES_CBC == TRUE return cry_lld_decrypt_AES_CBC(cryp, key_id, size, in, out, iv); #elif HAL_CRY_USE_FALLBACK == TRUE return cry_fallback_decrypt_AES_CBC(cryp, key_id, size, in, out, iv); #else (void)cryp; (void)key_id; (void)size; (void)in; (void)out; (void)iv; return CRY_ERR_INV_ALGO; #endif } /** * @brief Encryption operation using AES-CFB. * @note The function operates on data buffers whose lenght is a multiple * of an AES block, this means that padding must be done by the * caller. * * @param[in] cryp pointer to the @p CRYDriver object * @param[in] key_id the key to be used for the operation, zero is the * transient key, other values are keys stored in an * unspecified way * @param[in] size size of the plaintext buffer, this number must be a * multiple of 16 * @param[in] in buffer containing the input plaintext * @param[out] out buffer for the output cyphertext * @param[in] iv 128 bits initial vector * @return The operation status. * @retval CRY_NOERROR if the operation succeeded. * @retval CRY_ERR_INV_ALGO if the operation is unsupported on this * device instance. * @retval CRY_ERR_INV_KEY_TYPE the selected key is invalid for this operation. * @retval CRY_ERR_INV_KEY_ID if the specified key identifier is invalid * or refers and empty key slot. * * @api */ cryerror_t cryEncryptAES_CFB(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out, const uint8_t *iv) { osalDbgCheck((cryp != NULL) && (in != NULL) && (out != NULL) && (iv != NULL) && ((size & (size_t)15) == (size_t)0)); osalDbgAssert(cryp->state == CRY_READY, "not ready"); #if CRY_LLD_SUPPORTS_AES_CFB == TRUE return cry_lld_encrypt_AES_CFB(cryp, key_id, size, in, out, iv); #elif HAL_CRY_USE_FALLBACK == TRUE return cry_fallback_encrypt_AES_CFB(cryp, key_id, size, in, out, iv); #else (void)cryp; (void)key_id; (void)size; (void)in; (void)out; (void)iv; return CRY_ERR_INV_ALGO; #endif } /** * @brief Decryption operation using AES-CFB. * @note The function operates on data buffers whose lenght is a multiple * of an AES block, this means that padding must be done by the * caller. * * @param[in] cryp pointer to the @p CRYDriver object * @param[in] key_id the key to be used for the operation, zero is the * transient key, other values are keys stored in an * unspecified way * @param[in] size size of the plaintext buffer, this number must be a * multiple of 16 * @param[in] in buffer containing the input cyphertext * @param[out] out buffer for the output plaintext * @param[in] iv 128 bits initial vector * @return The operation status. * @retval CRY_NOERROR if the operation succeeded. * @retval CRY_ERR_INV_ALGO if the operation is unsupported on this * device instance. * @retval CRY_ERR_INV_KEY_TYPE the selected key is invalid for this operation. * @retval CRY_ERR_INV_KEY_ID if the specified key identifier is invalid * or refers and empty key slot. * * @api */ cryerror_t cryDecryptAES_CFB(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out, const uint8_t *iv) { osalDbgCheck((cryp != NULL) && (in != NULL) && (out != NULL) && (iv != NULL) && ((size & (size_t)15) == (size_t)0)); osalDbgAssert(cryp->state == CRY_READY, "not ready"); #if CRY_LLD_SUPPORTS_AES_CFB == TRUE return cry_lld_decrypt_AES_CFB(cryp, key_id, size, in, out, iv); #elif HAL_CRY_USE_FALLBACK == TRUE return cry_fallback_decrypt_AES_CFB(cryp, key_id, size, in, out, iv); #else (void)cryp; (void)key_id; (void)size; (void)in; (void)out; (void)iv; return CRY_ERR_INV_ALGO; #endif } /** * @brief Encryption operation using AES-CTR. * @note The function operates on data buffers whose lenght is a multiple * of an AES block, this means that padding must be done by the * caller. * * @param[in] cryp pointer to the @p CRYDriver object * @param[in] key_id the key to be used for the operation, zero is the * transient key, other values are keys stored in an * unspecified way * @param[in] size size of the plaintext buffer, this number must be a * multiple of 16 * @param[in] in buffer containing the input plaintext * @param[out] out buffer for the output cyphertext * @param[in] iv 128 bits initial vector + counter, it contains * a 96 bits IV and a 32 bits counter * @return The operation status. * @retval CRY_NOERROR if the operation succeeded. * @retval CRY_ERR_INV_ALGO if the operation is unsupported on this * device instance. * @retval CRY_ERR_INV_KEY_TYPE the selected key is invalid for this operation. * @retval CRY_ERR_INV_KEY_ID if the specified key identifier is invalid * or refers and empty key slot. * * @api */ cryerror_t cryEncryptAES_CTR(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out, const uint8_t *iv) { osalDbgCheck((cryp != NULL) && (in != NULL) && (out != NULL) && (iv != NULL) && ((size & (size_t)15) == (size_t)0)); osalDbgAssert(cryp->state == CRY_READY, "not ready"); #if CRY_LLD_SUPPORTS_AES_CTR == TRUE return cry_lld_encrypt_AES_CTR(cryp, key_id, size, in, out, iv); #elif HAL_CRY_USE_FALLBACK == TRUE return cry_fallback_encrypt_AES_CTR(cryp, key_id, size, in, out, iv); #else (void)cryp; (void)key_id; (void)size; (void)in; (void)out; (void)nonce; (void)cnt; return CRY_ERR_INV_ALGO; #endif } /** * @brief Decryption operation using AES-CTR. * @note The function operates on data buffers whose lenght is a multiple * of an AES block, this means that padding must be done by the * caller. * * @param[in] cryp pointer to the @p CRYDriver object * @param[in] key_id the key to be used for the operation, zero is the * transient key, other values are keys stored in an * unspecified way * @param[in] size size of the plaintext buffer, this number must be a * multiple of 16 * @param[in] in buffer containing the input cyphertext * @param[out] out buffer for the output plaintext * @param[in] iv 128 bits initial vector + counter, it contains * a 96 bits IV and a 32 bits counter * @return The operation status. * @retval CRY_NOERROR if the operation succeeded. * @retval CRY_ERR_INV_ALGO if the operation is unsupported on this * device instance. * @retval CRY_ERR_INV_KEY_TYPE the selected key is invalid for this operation. * @retval CRY_ERR_INV_KEY_ID if the specified key identifier is invalid * or refers and empty key slot. * * @api */ cryerror_t cryDecryptAES_CTR(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out, const uint8_t *iv) { osalDbgCheck((cryp != NULL) && (in != NULL) && (out != NULL) && (iv != NULL) && ((size & (size_t)15) == (size_t)0)); osalDbgAssert(cryp->state == CRY_READY, "not ready"); #if CRY_LLD_SUPPORTS_AES_CTR == TRUE return cry_lld_decrypt_AES_CTR(cryp, key_id, size, in, out, iv); #elif HAL_CRY_USE_FALLBACK == TRUE return cry_fallback_decrypt_AES_CTR(cryp, key_id, size, in, out, iv); #else (void)cryp; (void)key_id; (void)size; (void)in; (void)out; (void)nonce; (void)cnt; return CRY_ERR_INV_ALGO; #endif } /** * @brief Encryption operation using AES-GCM. * @note The function operates on data buffers whose lenght is a multiple * of an AES block, this means that padding must be done by the * caller. * * @param[in] cryp pointer to the @p CRYDriver object * @param[in] key_id the key to be used for the operation, zero is the * transient key, other values are keys stored in an * unspecified way * @param[in] size size of the text buffers, this number must be a * multiple of 16 * @param[in] in buffer containing the input plaintext * @param[out] out buffer for the output cyphertext * @param[in] iv 128 bits initial vector + counter, it contains * a 96 bits IV and a 32 bits counter * @param[in] aadsize size of the authentication data, this number must be a * multiple of 16 * @param[in] aad buffer containing the authentication data * @param[in] authtag 128 bits buffer for the generated authentication tag * @return The operation status. * @retval CRY_NOERROR if the operation succeeded. * @retval CRY_ERR_INV_ALGO if the operation is unsupported on this * device instance. * @retval CRY_ERR_INV_KEY_TYPE the selected key is invalid for this operation. * @retval CRY_ERR_INV_KEY_ID if the specified key identifier is invalid * or refers and empty key slot. * * @api */ 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) { osalDbgCheck((cryp != NULL) && (in != NULL) && (out != NULL) && (iv != NULL) && (aad != NULL) && (authtag != NULL) && ((size & (size_t)15) == (size_t)0) && ((aadsize & (size_t)15) == (size_t)0)); osalDbgAssert(cryp->state == CRY_READY, "not ready"); #if CRY_LLD_SUPPORTS_AES_GCM== TRUE return cry_lld_encrypt_AES_GCM(cryp, key_id, size, in, out, iv, aadsize, aad, authtag); #elif HAL_CRY_USE_FALLBACK == TRUE return cry_fallback_encrypt_AES_GCM(cryp, key_id, size, in, out, iv, aadsize, aad, authtag); #else (void)cryp; (void)key_id; (void)size; (void)in; (void)out; (void)iv; (void)aadsize; (void)aad; (void)authtag; return CRY_ERR_INV_ALGO; #endif } /** * @brief Decryption operation using AES-GCM. * @note The function operates on data buffers whose lenght is a multiple * of an AES block, this means that padding must be done by the * caller. * * @param[in] cryp pointer to the @p CRYDriver object * @param[in] key_id the key to be used for the operation, zero is the * transient key, other values are keys stored in an * unspecified way * @param[in] size size of the text buffers, this number must be a * multiple of 16 * @param[in] in buffer for the output cyphertext * @param[out] out buffer containing the input plaintext * @param[in] iv 128 bits initial vector + counter, it contains * a 96 bits IV and a 32 bits counter * @param[in] aadsize size of the authentication data, this number must be a * multiple of 16 * @param[in] aad buffer containing the authentication data * @param[in] authtag 128 bits buffer for the generated authentication tag * @return The operation status. * @retval CRY_NOERROR if the operation succeeded. * @retval CRY_ERR_INV_ALGO if the operation is unsupported on this * device instance. * @retval CRY_ERR_INV_KEY_TYPE the selected key is invalid for this operation. * @retval CRY_ERR_INV_KEY_ID if the specified key identifier is invalid * or refers and empty key slot. * * @api */ 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) { osalDbgCheck((cryp != NULL) && (in != NULL) && (out != NULL) && (iv != NULL) && (aad != NULL) && (authtag != NULL) && ((size & (size_t)15) == (size_t)0) && ((aadsize & (size_t)15) == (size_t)0)); osalDbgAssert(cryp->state == CRY_READY, "not ready"); #if CRY_LLD_SUPPORTS_AES_GCM== TRUE return cry_lld_decrypt_AES_GCM(cryp, key_id, size, in, out, iv, aadsize, aad, authtag); #elif HAL_CRY_USE_FALLBACK == TRUE return cry_fallback_decrypt_AES_GCM(cryp, key_id, size, in, out, iv, aadsize, aad, authtag); #else (void)cryp; (void)key_id; (void)size; (void)in; (void)out; (void)iv; (void)aadsize; (void)aad; (void)authtag; return CRY_ERR_INV_ALGO; #endif } #endif /* HAL_USE_CRY == TRUE */ /** @} */