mbedtls_backend_hmac.h 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
  1. /**
  2. * Copyright (c) 2018 - 2020, Nordic Semiconductor ASA
  3. *
  4. * All rights reserved.
  5. *
  6. * Redistribution and use in source and binary forms, with or without modification,
  7. * are permitted provided that the following conditions are met:
  8. *
  9. * 1. Redistributions of source code must retain the above copyright notice, this
  10. * list of conditions and the following disclaimer.
  11. *
  12. * 2. Redistributions in binary form, except as embedded into a Nordic
  13. * Semiconductor ASA integrated circuit in a product or a software update for
  14. * such product, must reproduce the above copyright notice, this list of
  15. * conditions and the following disclaimer in the documentation and/or other
  16. * materials provided with the distribution.
  17. *
  18. * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
  19. * contributors may be used to endorse or promote products derived from this
  20. * software without specific prior written permission.
  21. *
  22. * 4. This software, with or without modification, must only be used with a
  23. * Nordic Semiconductor ASA integrated circuit.
  24. *
  25. * 5. Any software provided in binary form under this license must not be reverse
  26. * engineered, decompiled, modified and/or disassembled.
  27. *
  28. * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
  29. * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  30. * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
  31. * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
  32. * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  33. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  34. * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  37. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38. *
  39. */
  40. #ifndef MBEDTLS_BACKEND_HMAC_H__
  41. #define MBEDTLS_BACKEND_HMAC_H__
  42. /** @file
  43. *
  44. * @defgroup nrf_crypto_mbedtls_backend_hmac mbed TLS backend for HMAC
  45. * @{
  46. * @ingroup nrf_crypto_mbedtls_backend
  47. *
  48. * @brief Backend wrapper for mbed TLS. None of these types should be used directly by the
  49. * application.
  50. */
  51. #include "sdk_common.h"
  52. #if NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_MBEDTLS) && \
  53. ( NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_MBEDTLS_HMAC_SHA256) || \
  54. NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_MBEDTLS_HMAC_SHA512) )
  55. #include "nrf_crypto_hmac_shared.h"
  56. /*lint -save -e????*/
  57. #include "mbedtls/md.h"
  58. #include "mbedtls/sha256.h"
  59. #include "mbedtls/sha512.h"
  60. /*lint -restore*/
  61. #ifdef __cplusplus
  62. extern "C" {
  63. #endif
  64. #undef NRF_CRYPTO_HMAC_ENABLED
  65. #define NRF_CRYPTO_HMAC_ENABLED 1
  66. #if NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_MBEDTLS_HMAC_SHA256)
  67. #if NRF_MODULE_ENABLED(NRF_CRYPTO_HMAC_SHA256)
  68. #error "Duplicate definition of HMAC SHA-256. More than one backend enabled"
  69. #endif // NRF_CRYPTO_HMAC_SHA256_ENABLED
  70. #define NRF_CRYPTO_HMAC_SHA256_ENABLED 1
  71. /**
  72. * @internal @brief Internal context object used by the mbed TLS backend wrapper for HMAC SHA256.
  73. *
  74. * @note This should never be used directly. Use @ref nrf_crypto_backend_hmac_sha256_context_t
  75. * instead.
  76. */
  77. typedef struct
  78. {
  79. nrf_crypto_hmac_internal_context_t header; //!< Internal nrf_crypto_hmac context.
  80. mbedtls_md_context_t mbedtls_ctx; //!< Mbed TLS context object.
  81. uint8_t md_ctx_buffer[sizeof(mbedtls_sha256_context)]; //!< Message digest buffer for mbed TLS.
  82. uint16_t hmac_ctx_buffer[64]; //!< Hash buffer for mbed TLS of size defined in mbedtls_sha256_info in md_internal.h.
  83. } nrf_crypto_backend_mbedtls_hmac_sha256_context_t;
  84. /**
  85. * @internal @brief Context for HMAC SHA256 using mbed TLS backend.
  86. */
  87. typedef nrf_crypto_backend_mbedtls_hmac_sha256_context_t nrf_crypto_backend_hmac_sha256_context_t;
  88. #endif // NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_MBEDTLS_HMAC_SHA256)
  89. #if NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_MBEDTLS_HMAC_SHA512)
  90. #if NRF_MODULE_ENABLED(NRF_CRYPTO_HMAC_SHA512)
  91. #error "Duplicate definition of HMAC SHA-512. More than one backend enabled"
  92. #endif // NRF_CRYPTO_HMAC_SHA512_ENABLED
  93. #define NRF_CRYPTO_HMAC_SHA512_ENABLED 1
  94. /**
  95. * @internal @brief Internal context object used by the mbed TLS backend wrapper for HMAC SHA512.
  96. *
  97. * @note This should never be used directly. Use @ref nrf_crypto_backend_hmac_sha512_context_t
  98. * instead.
  99. */
  100. typedef struct
  101. {
  102. nrf_crypto_hmac_internal_context_t header; //!< Internal nrf_crypto_hmac context header.
  103. mbedtls_md_context_t mbedtls_ctx; //!< Mbed TLS context object.
  104. uint8_t md_ctx_buffer[sizeof(mbedtls_sha512_context)]; //!< Message digest buffer for mbed TLS.
  105. uint16_t hmac_ctx_buffer[128]; //!< Hash buffer for mbed TLS of size defined in mbedtls_sha512_info in md_internal.h.
  106. } nrf_crypto_backend_mbedtls_hmac_sha512_context_t;
  107. /**
  108. * @internal @brief Context for HMAC SHA512 using mbed TLS backend.
  109. */
  110. typedef nrf_crypto_backend_mbedtls_hmac_sha512_context_t nrf_crypto_backend_hmac_sha512_context_t;
  111. #ifdef __cplusplus
  112. }
  113. #endif
  114. #endif // NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_MBEDTLS_HMAC_SHA512)
  115. #endif // NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_MBEDTLS) && ( NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_MBEDTLS_HMAC_SHA256) || NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_MBEDTLS_HMAC_SHA512) )
  116. /**@} */
  117. #endif // MBEDTLS_BACKEND_HMAC_H__