377 lines
15 KiB
C
377 lines
15 KiB
C
/*
|
|
ChibiOS - Copyright (C) 2006..2018 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_lld.h
|
|
* @brief PLATFORM cryptographic subsystem low level driver header.
|
|
*
|
|
* @addtogroup CRYPTO
|
|
* @{
|
|
*/
|
|
|
|
#ifndef HAL_CRYPTO_LLD_H
|
|
#define HAL_CRYPTO_LLD_H
|
|
|
|
#if (HAL_USE_CRY == TRUE) || defined(__DOXYGEN__)
|
|
|
|
/*===========================================================================*/
|
|
/* Driver constants. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @name Driver capability switches
|
|
* @{
|
|
*/
|
|
#define CRY_LLD_SUPPORTS_AES TRUE
|
|
#define CRY_LLD_SUPPORTS_AES_ECB TRUE
|
|
#define CRY_LLD_SUPPORTS_AES_CBC TRUE
|
|
#define CRY_LLD_SUPPORTS_AES_CFB TRUE
|
|
#define CRY_LLD_SUPPORTS_AES_CTR TRUE
|
|
#define CRY_LLD_SUPPORTS_AES_GCM TRUE
|
|
#define CRY_LLD_SUPPORTS_DES TRUE
|
|
#define CRY_LLD_SUPPORTS_DES_ECB TRUE
|
|
#define CRY_LLD_SUPPORTS_DES_CBC TRUE
|
|
#define CRY_LLD_SUPPORTS_SHA1 TRUE
|
|
#define CRY_LLD_SUPPORTS_SHA256 TRUE
|
|
#define CRY_LLD_SUPPORTS_SHA512 TRUE
|
|
#define CRY_LLD_SUPPORTS_HMAC_SHA256 TRUE
|
|
#define CRY_LLD_SUPPORTS_HMAC_SHA512 TRUE
|
|
/** @} */
|
|
|
|
/*===========================================================================*/
|
|
/* Driver pre-compile time settings. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @name PLATFORM configuration options
|
|
* @{
|
|
*/
|
|
/**
|
|
* @brief CRY1 driver enable switch.
|
|
* @details If set to @p TRUE the support for CRY1 is included.
|
|
* @note The default is @p FALSE.
|
|
*/
|
|
#if !defined(PLATFORM_CRY_USE_CRY1) || defined(__DOXYGEN__)
|
|
#define PLATFORM_CRY_USE_CRY1 FALSE
|
|
#endif
|
|
/** @} */
|
|
|
|
/*===========================================================================*/
|
|
/* Derived constants and error checks. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* Driver data structures and types. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief CRY key identifier type.
|
|
*/
|
|
typedef uint32_t crykey_t;
|
|
|
|
/**
|
|
* @brief Type of a structure representing an CRY driver.
|
|
*/
|
|
typedef struct CRYDriver CRYDriver;
|
|
|
|
/**
|
|
* @brief Driver configuration structure.
|
|
* @note It could be empty on some architectures.
|
|
*/
|
|
typedef struct {
|
|
uint32_t dummy;
|
|
} CRYConfig;
|
|
|
|
/**
|
|
* @brief Structure representing an CRY driver.
|
|
*/
|
|
struct CRYDriver {
|
|
/**
|
|
* @brief Driver state.
|
|
*/
|
|
crystate_t state;
|
|
/**
|
|
* @brief Current configuration data.
|
|
*/
|
|
const CRYConfig *config;
|
|
#if defined(CRY_DRIVER_EXT_FIELDS)
|
|
CRY_DRIVER_EXT_FIELDS
|
|
#endif
|
|
/* End of the mandatory fields.*/
|
|
};
|
|
|
|
#if (CRY_LLD_SUPPORTS_SHA1 == TRUE) || defined(__DOXYGEN__)
|
|
/**
|
|
* @brief Type of a SHA1 context.
|
|
*/
|
|
typedef struct {
|
|
uint32_t dummy;
|
|
} SHA1Context;
|
|
#endif
|
|
|
|
#if (CRY_LLD_SUPPORTS_SHA256 == TRUE) || defined(__DOXYGEN__)
|
|
/**
|
|
* @brief Type of a SHA256 context.
|
|
*/
|
|
typedef struct {
|
|
uint32_t dummy;
|
|
} SHA256Context;
|
|
#endif
|
|
|
|
#if (CRY_LLD_SUPPORTS_SHA512 == TRUE) || defined(__DOXYGEN__)
|
|
/**
|
|
* @brief Type of a SHA512 context.
|
|
*/
|
|
typedef struct {
|
|
uint32_t dummy;
|
|
} SHA512Context;
|
|
#endif
|
|
|
|
#if (CRY_LLD_SUPPORTS_HMAC_SHA256 == TRUE) || defined(__DOXYGEN__)
|
|
/**
|
|
* @brief Type of a HMAC_SHA256 context.
|
|
*/
|
|
typedef struct {
|
|
uint32_t dummy;
|
|
} HMACSHA256Context;
|
|
#endif
|
|
|
|
#if (CRY_LLD_SUPPORTS_HMAC_SHA512 == TRUE) || defined(__DOXYGEN__)
|
|
/**
|
|
* @brief Type of a HMAC_SHA512 context.
|
|
*/
|
|
typedef struct {
|
|
uint32_t dummy;
|
|
} HMACSHA512Context;
|
|
#endif
|
|
|
|
/*===========================================================================*/
|
|
/* Driver macros. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* External declarations. */
|
|
/*===========================================================================*/
|
|
|
|
#if (PLATFORM_CRY_USE_CRY1 == TRUE) && !defined(__DOXYGEN__)
|
|
extern CRYDriver CRYD1;
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
void cry_lld_init(void);
|
|
void cry_lld_start(CRYDriver *cryp);
|
|
void cry_lld_stop(CRYDriver *cryp);
|
|
#if (CRY_LLD_SUPPORTS_AES == TRUE) || \
|
|
(CRY_LLD_SUPPORTS_AES_ECB == TRUE) || \
|
|
(CRY_LLD_SUPPORTS_AES_CBC == TRUE) || \
|
|
(CRY_LLD_SUPPORTS_AES_CFB == TRUE) || \
|
|
(CRY_LLD_SUPPORTS_AES_CTR == TRUE) || \
|
|
(CRY_LLD_SUPPORTS_AES_GCM == TRUE) || \
|
|
defined(__DOXYGEN__)
|
|
cryerror_t cry_lld_aes_loadkey(CRYDriver *cryp,
|
|
size_t size,
|
|
const uint8_t *keyp);
|
|
#endif
|
|
#if (CRY_LLD_SUPPORTS_AES == TRUE) || defined(__DOXYGEN__)
|
|
cryerror_t cry_lld_encrypt_AES(CRYDriver *cryp,
|
|
crykey_t key_id,
|
|
const uint8_t *in,
|
|
uint8_t *out);
|
|
cryerror_t cry_lld_decrypt_AES(CRYDriver *cryp,
|
|
crykey_t key_id,
|
|
const uint8_t *in,
|
|
uint8_t *out);
|
|
#endif
|
|
#if (CRY_LLD_SUPPORTS_AES_ECB == TRUE) || defined(__DOXYGEN__)
|
|
cryerror_t cry_lld_encrypt_AES_ECB(CRYDriver *cryp,
|
|
crykey_t key_id,
|
|
size_t size,
|
|
const uint8_t *in,
|
|
uint8_t *out);
|
|
cryerror_t cry_lld_decrypt_AES_ECB(CRYDriver *cryp,
|
|
crykey_t key_id,
|
|
size_t size,
|
|
const uint8_t *in,
|
|
uint8_t *out);
|
|
#endif
|
|
#if (CRY_LLD_SUPPORTS_AES_CBC == TRUE) || defined(__DOXYGEN__)
|
|
cryerror_t cry_lld_encrypt_AES_CBC(CRYDriver *cryp,
|
|
crykey_t key_id,
|
|
size_t size,
|
|
const uint8_t *in,
|
|
uint8_t *out,
|
|
const uint8_t *iv);
|
|
cryerror_t cry_lld_decrypt_AES_CBC(CRYDriver *cryp,
|
|
crykey_t key_id,
|
|
size_t size,
|
|
const uint8_t *in,
|
|
uint8_t *out,
|
|
const uint8_t *iv);
|
|
#endif
|
|
#if (CRY_LLD_SUPPORTS_AES_CFB == TRUE) || defined(__DOXYGEN__)
|
|
cryerror_t cry_lld_encrypt_AES_CFB(CRYDriver *cryp,
|
|
crykey_t key_id,
|
|
size_t size,
|
|
const uint8_t *in,
|
|
uint8_t *out,
|
|
const uint8_t *iv);
|
|
cryerror_t cry_lld_decrypt_AES_CFB(CRYDriver *cryp,
|
|
crykey_t key_id,
|
|
size_t size,
|
|
const uint8_t *in,
|
|
uint8_t *out,
|
|
const uint8_t *iv);
|
|
#endif
|
|
#if (CRY_LLD_SUPPORTS_AES_CTR == TRUE) || defined(__DOXYGEN__)
|
|
cryerror_t cry_lld_encrypt_AES_CTR(CRYDriver *cryp,
|
|
crykey_t key_id,
|
|
size_t size,
|
|
const uint8_t *in,
|
|
uint8_t *out,
|
|
const uint8_t *iv);
|
|
cryerror_t cry_lld_decrypt_AES_CTR(CRYDriver *cryp,
|
|
crykey_t key_id,
|
|
size_t size,
|
|
const uint8_t *in,
|
|
uint8_t *out,
|
|
const uint8_t *iv);
|
|
#endif
|
|
#if (CRY_LLD_SUPPORTS_AES_GCM == TRUE) || defined(__DOXYGEN__)
|
|
cryerror_t cry_lld_encrypt_AES_GCM(CRYDriver *cryp,
|
|
crykey_t key_id,
|
|
size_t auth_size,
|
|
const uint8_t *auth_in,
|
|
size_t text_size,
|
|
const uint8_t *text_in,
|
|
uint8_t *text_out,
|
|
const uint8_t *iv,
|
|
size_t tag_size,
|
|
uint8_t *tag_out);
|
|
cryerror_t cry_lld_decrypt_AES_GCM(CRYDriver *cryp,
|
|
crykey_t key_id,
|
|
size_t auth_size,
|
|
const uint8_t *auth_in,
|
|
size_t text_size,
|
|
const uint8_t *text_in,
|
|
uint8_t *text_out,
|
|
const uint8_t *iv,
|
|
size_t tag_size,
|
|
const uint8_t *tag_in);
|
|
#endif
|
|
#if (CRY_LLD_SUPPORTS_DES == TRUE) || \
|
|
(CRY_LLD_SUPPORTS_DES_ECB == TRUE) || \
|
|
(CRY_LLD_SUPPORTS_DES_CBC == TRUE) || \
|
|
defined(__DOXYGEN__)
|
|
cryerror_t cry_lld_des_loadkey(CRYDriver *cryp,
|
|
size_t size,
|
|
const uint8_t *keyp);
|
|
#endif
|
|
#if (CRY_LLD_SUPPORTS_DES == TRUE) || defined(__DOXYGEN__)
|
|
cryerror_t cry_lld_encrypt_DES(CRYDriver *cryp,
|
|
crykey_t key_id,
|
|
const uint8_t *in,
|
|
uint8_t *out);
|
|
cryerror_t cry_lld_decrypt_DES(CRYDriver *cryp,
|
|
crykey_t key_id,
|
|
const uint8_t *in,
|
|
uint8_t *out);
|
|
#endif
|
|
#if (CRY_LLD_SUPPORTS_DES_ECB == TRUE) || defined(__DOXYGEN__)
|
|
cryerror_t cry_lld_encrypt_DES_ECB(CRYDriver *cryp,
|
|
crykey_t key_id,
|
|
size_t size,
|
|
const uint8_t *in,
|
|
uint8_t *out);
|
|
cryerror_t cry_lld_decrypt_DES_ECB(CRYDriver *cryp,
|
|
crykey_t key_id,
|
|
size_t size,
|
|
const uint8_t *in,
|
|
uint8_t *out);
|
|
#endif
|
|
#if (CRY_LLD_SUPPORTS_DES_CBC == TRUE) || defined(__DOXYGEN__)
|
|
cryerror_t cry_lld_encrypt_DES_CBC(CRYDriver *cryp,
|
|
crykey_t key_id,
|
|
size_t size,
|
|
const uint8_t *in,
|
|
uint8_t *out,
|
|
const uint8_t *iv);
|
|
cryerror_t cry_lld_decrypt_DES_CBC(CRYDriver *cryp,
|
|
crykey_t key_id,
|
|
size_t size,
|
|
const uint8_t *in,
|
|
uint8_t *out,
|
|
const uint8_t *iv);
|
|
#endif
|
|
#if (CRY_LLD_SUPPORTS_SHA1 == TRUE) || defined(__DOXYGEN__)
|
|
cryerror_t cry_lld_SHA1_init(CRYDriver *cryp, SHA1Context *sha1ctxp);
|
|
cryerror_t cry_lld_SHA1_update(CRYDriver *cryp, SHA1Context *sha1ctxp,
|
|
size_t size, const uint8_t *in);
|
|
cryerror_t cry_lld_SHA1_final(CRYDriver *cryp, SHA1Context *sha1ctxp,
|
|
uint8_t *out);
|
|
#endif
|
|
#if (CRY_LLD_SUPPORTS_SHA256 == TRUE) || defined(__DOXYGEN__)
|
|
cryerror_t cry_lld_SHA256_init(CRYDriver *cryp, SHA256Context *sha256ctxp);
|
|
cryerror_t cry_lld_SHA256_update(CRYDriver *cryp, SHA256Context *sha256ctxp,
|
|
size_t size, const uint8_t *in);
|
|
cryerror_t cry_lld_SHA256_final(CRYDriver *cryp, SHA256Context *sha256ctxp,
|
|
uint8_t *out);
|
|
#endif
|
|
#if (CRY_LLD_SUPPORTS_SHA512 == TRUE) || defined(__DOXYGEN__)
|
|
cryerror_t cry_lld_SHA512_init(CRYDriver *cryp, SHA512Context *sha512ctxp);
|
|
cryerror_t cry_lld_SHA512_update(CRYDriver *cryp, SHA512Context *sha512ctxp,
|
|
size_t size, const uint8_t *in);
|
|
cryerror_t cry_lld_SHA512_final(CRYDriver *cryp, SHA512Context *sha512ctxp,
|
|
uint8_t *out);
|
|
#endif
|
|
#if (CRY_LLD_SUPPORTS_HMAC_SHA256 == TRUE) || \
|
|
(CRY_LLD_SUPPORTS_HMAC_SHA512 == TRUE) || \
|
|
defined(__DOXYGEN__)
|
|
cryerror_t cry_lld_hmac_loadkey(CRYDriver *cryp,
|
|
size_t size,
|
|
const uint8_t *keyp);
|
|
#endif
|
|
#if (CRY_LLD_SUPPORTS_HMAC_SHA256 == TRUE) || defined(__DOXYGEN__)
|
|
cryerror_t cry_lld_HMACSHA256_init(CRYDriver *cryp,
|
|
HMACSHA256Context *hmacsha256ctxp);
|
|
cryerror_t cry_lld_HMACSHA256_update(CRYDriver *cryp,
|
|
HMACSHA256Context *hmacsha256ctxp,
|
|
size_t size, const uint8_t *in);
|
|
cryerror_t cry_lld_HMACSHA256_final(CRYDriver *cryp,
|
|
HMACSHA256Context *hmacsha256ctxp,
|
|
uint8_t *out);
|
|
#endif
|
|
#if (CRY_LLD_SUPPORTS_HMAC_SHA512 == TRUE) || defined(__DOXYGEN__)
|
|
cryerror_t cry_lld_HMACSHA512_init(CRYDriver *cryp,
|
|
HMACSHA512Context *hmacsha512ctxp);
|
|
cryerror_t cry_lld_HMACSHA512_update(CRYDriver *cryp,
|
|
HMACSHA512Context *hmacsha512ctxp,
|
|
size_t size, const uint8_t *in);
|
|
cryerror_t cry_lld_HMACSHA512_final(CRYDriver *cryp,
|
|
HMACSHA512Context *hmacsha512ctxp,
|
|
uint8_t *out);
|
|
#endif
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* HAL_USE_CRY == TRUE */
|
|
|
|
#endif /* HAL_CRYPTO_LLD_H */
|
|
|
|
/** @} */
|