nrf_cc310_bl_hash_sha256.h 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
  1. /**************************************************************************************
  2. * Copyright (c) 2016-2017, ARM Limited or its affiliates. All rights reserved *
  3. * *
  4. * This file and the related binary are licensed under the following license: *
  5. * *
  6. * ARM Object Code and Header Files License, v1.0 Redistribution. *
  7. * *
  8. * Redistribution and use of object code, header files, and documentation, without *
  9. * modification, are permitted provided that the following conditions are met: *
  10. * *
  11. * 1) Redistributions must reproduce the above copyright notice and the *
  12. * following disclaimer in the documentation and/or other materials *
  13. * provided with the distribution. *
  14. * *
  15. * 2) Unless to the extent explicitly permitted by law, no reverse *
  16. * engineering, decompilation, or disassembly of is permitted. *
  17. * *
  18. * 3) Redistribution and use is permitted solely for the purpose of *
  19. * developing or executing applications that are targeted for use *
  20. * on an ARM-based product. *
  21. * *
  22. * DISCLAIMER. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND *
  23. * CONTRIBUTORS "AS IS." ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT *
  24. * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, NON-INFRINGEMENT, *
  25. * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE *
  26. * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, *
  27. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED *
  28. * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
  29. * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
  30. * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
  31. * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
  32. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
  33. **************************************************************************************/
  34. #ifndef NRF_CC310_BL_HASH_SHA256_H__
  35. #define NRF_CC310_BL_HASH_SHA256_H__
  36. /**@file
  37. *
  38. * @defgroup nrf_cc310_bl_hash_sha256 nrf_cc310_bl Hash SHA-256 API
  39. * @ingroup nrf_cc310_bl
  40. * @brief Type definitions and public APIs for nrf_cc310_bl HASH using SHA-256.
  41. * @{
  42. */
  43. #include <stdint.h>
  44. #include "nrf_cc310_bl_hash_common.h"
  45. #include "crys_error.h"
  46. #ifdef __cplusplus
  47. extern "C" {
  48. #endif
  49. /**@brief Structure to hold SHA-256 context information.
  50. */
  51. typedef struct
  52. {
  53. uint32_t init_val;
  54. uint8_t context_buffer[NRF_CC310_BL_HASH_CONTEXT_BUFFER_SIZE_SHA256];
  55. } nrf_cc310_bl_hash_context_sha256_t;
  56. /**@brief Array to hold SHA-256 hash digest.
  57. */
  58. typedef uint8_t nrf_cc310_bl_hash_digest_sha256_t[NRF_CC310_BL_SHA256_DIGEST_SIZE_IN_BYTES];
  59. /**@brief Function for initializing the SHA-256 context.
  60. *
  61. * @note Memory pointed to in hash context must be allocated prior to this call.
  62. *
  63. * @param[in,out] p_hash_context Structure holding context information for
  64. * the SHA-256 operation.
  65. *
  66. * @retval CRYS_OK If call was successful.
  67. * @retval CRYS_HASH_INVALID_USER_CONTEXT_POINTER_ERROR p_hash_context was NULL.
  68. */
  69. CRYSError_t nrf_cc310_bl_hash_sha256_init(
  70. nrf_cc310_bl_hash_context_sha256_t * const p_hash_context);
  71. /** @brief Function for running an update to the SHA-256 hash calculation.
  72. *
  73. * @param[in,out] p_hash_context Structure holding context information
  74. * for the SHA-256 operation.
  75. *
  76. * @retval CRYS_OK If call was successful.
  77. * @retval CRYS_HASH_INVALID_USER_CONTEXT_POINTER_ERROR p_hash_context was NULL.
  78. * @retval CRYS_HASH_USER_CONTEXT_CORRUPTED_ERROR p_hash_context not initialized.
  79. * @retval CRYS_HASH_LAST_BLOCK_ALREADY_PROCESSED_ERROR p_hash_context already finalized.
  80. */
  81. CRYSError_t nrf_cc310_bl_hash_sha256_update(
  82. nrf_cc310_bl_hash_context_sha256_t * const p_hash_context,
  83. uint8_t const * p_src,
  84. uint32_t len);
  85. /** @brief Function for finalizing the hash calculation.
  86. *
  87. * @note Memory pointed to in hash digest must be allocated prior to this call.
  88. *
  89. * @param[in,out] p_hash_context Structure holding context information for
  90. * the SHA-256 operation.
  91. * @param[in,out] p_hash_digest Pointer to the structure holding SHA-256
  92. * hash digest. Data pointed to must be 32 bytes long.
  93. *
  94. * @retval CRYS_HASH_INVALID_USER_CONTEXT_POINTER_ERROR p_hash_context was NULL.
  95. * @retval CRYS_HASH_USER_CONTEXT_CORRUPTED_ERROR p_hash_context was corrupted.
  96. * @retval CRYS_HASH_INVALID_RESULT_BUFFER_POINTER_ERROR p_digest was NULL.
  97. */
  98. CRYSError_t nrf_cc310_bl_hash_sha256_finalize(
  99. nrf_cc310_bl_hash_context_sha256_t * const p_hash_context,
  100. nrf_cc310_bl_hash_digest_sha256_t * const p_digest);
  101. #ifdef __cplusplus
  102. }
  103. #endif
  104. /** @} */
  105. #endif // NRF_CC310_BL_HASH_SHA256_H__