cc310_backend_hash.c 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303
  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. #include "sdk_common.h"
  41. #if NRF_MODULE_ENABLED(NRF_CRYPTO) && NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_CC310)
  42. #include "nrf.h"
  43. #include "cc310_backend_hash.h"
  44. #include "crys_hash.h"
  45. #include "crys_hash_error.h"
  46. #include "nrf_crypto_init.h"
  47. #include "nrf_crypto_types.h"
  48. #include "nrf_crypto_error.h"
  49. #include "nrf_crypto_hash_shared.h"
  50. #include "sdk_macros.h"
  51. #include "nrf_log.h"
  52. #include "nrf_assert.h"
  53. #include "cc310_backend_mutex.h"
  54. #include "cc310_backend_shared.h"
  55. #include <drivers/nrfx_common.h>
  56. #if NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_CC310_HASH_SHA256) || \
  57. NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_CC310_HASH_SHA512)
  58. static ret_code_t hash_result_get(CRYSError_t error)
  59. {
  60. ret_code_t ret_val;
  61. switch (error)
  62. {
  63. case CRYS_OK:
  64. ret_val = NRF_SUCCESS;
  65. break;
  66. case CRYS_HASH_INVALID_USER_CONTEXT_POINTER_ERROR:
  67. ret_val = NRF_ERROR_CRYPTO_CONTEXT_NULL;
  68. break;
  69. case CRYS_HASH_ILLEGAL_OPERATION_MODE_ERROR:
  70. ret_val = NRF_ERROR_CRYPTO_FEATURE_UNAVAILABLE;
  71. break;
  72. case CRYS_HASH_USER_CONTEXT_CORRUPTED_ERROR:
  73. ret_val = NRF_ERROR_CRYPTO_CONTEXT_NOT_INITIALIZED;
  74. break;
  75. // May be added to specialized errors for hash.
  76. case CRYS_HASH_LAST_BLOCK_ALREADY_PROCESSED_ERROR:
  77. ret_val = NRF_ERROR_CRYPTO_INTERNAL;
  78. break;
  79. case CRYS_HASH_IS_NOT_SUPPORTED:
  80. ret_val = NRF_ERROR_CRYPTO_FEATURE_UNAVAILABLE;
  81. break;
  82. default:
  83. ret_val = NRF_ERROR_CRYPTO_INTERNAL;
  84. break;
  85. }
  86. return ret_val;
  87. }
  88. #if NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_CC310_HASH_SHA256)
  89. static ret_code_t cc310_backend_hash_sha256_init(void * const p_context)
  90. {
  91. uint32_t ret_val;
  92. CRYSError_t crys_error;
  93. CRYS_HASH_OperationMode_t hash_mode = CRYS_HASH_SHA256_mode;
  94. // No parameter testing on this level.
  95. // This has been done on upper level.
  96. CRYS_HASHUserContext_t * const p_backend_context
  97. = &(((nrf_crypto_backend_hash_sha256_context_t *)p_context)->context);
  98. crys_error = CRYS_HASH_Init(p_backend_context, hash_mode);
  99. ret_val = hash_result_get(crys_error);
  100. return ret_val;
  101. }
  102. static ret_code_t cc310_backend_hash_sha256_update(void * const p_context,
  103. uint8_t const * p_data,
  104. size_t size)
  105. {
  106. ret_code_t ret_val;
  107. CRYSError_t crys_error;
  108. bool mutex_locked;
  109. size_t cur_len;
  110. size_t len_left = size;
  111. uint8_t const * p_cur = p_data;
  112. // Limited parameter testing on this level.
  113. // This has been done on upper level.
  114. CRYS_HASHUserContext_t * const p_backend_context
  115. = &(((nrf_crypto_backend_hash_sha256_context_t *)p_context)->context);
  116. // Data in flash could lead to silently calculating wrong Hash.
  117. VERIFY_TRUE(nrfx_is_in_ram(p_data), NRF_ERROR_CRYPTO_INPUT_LOCATION);
  118. mutex_locked = cc310_backend_mutex_trylock();
  119. VERIFY_TRUE(mutex_locked, NRF_ERROR_CRYPTO_BUSY);
  120. // If the input is larger than CC310_MAX_LENGTH_DMA_OPERATIONS, split into smaller
  121. do
  122. {
  123. cur_len = (len_left > CC310_MAX_LENGTH_DMA_OPERATIONS) ?
  124. CC310_MAX_LENGTH_DMA_OPERATIONS : len_left;
  125. crys_error = CRYS_HASH_Update(p_backend_context, (uint8_t *)p_cur, cur_len);
  126. len_left -= cur_len;
  127. p_cur += cur_len;
  128. } while (crys_error == CRYS_OK && len_left > 0);
  129. cc310_backend_mutex_unlock();
  130. ret_val = hash_result_get(crys_error);
  131. return ret_val;
  132. }
  133. static ret_code_t cc310_backend_hash_sha256_finalize(void * const p_context,
  134. uint8_t * p_digest,
  135. size_t * const p_digest_size)
  136. {
  137. ret_code_t ret_val;
  138. CRYSError_t crys_error;
  139. bool mutex_locked;
  140. CRYS_HASH_Result_t * p_int_digest = (CRYS_HASH_Result_t *)p_digest;
  141. // Limited parameter testing on this level.
  142. // This has been done on upper level.
  143. CRYS_HASHUserContext_t * const p_backend_context
  144. = &(((nrf_crypto_backend_hash_sha256_context_t * )p_context)->context);
  145. mutex_locked = cc310_backend_mutex_trylock();
  146. VERIFY_TRUE(mutex_locked, NRF_ERROR_CRYPTO_BUSY);
  147. // Do the hash finalize calculation
  148. crys_error = CRYS_HASH_Finish(p_backend_context, *p_int_digest);
  149. cc310_backend_mutex_unlock();
  150. ret_val = hash_result_get(crys_error);
  151. if (ret_val == NRF_SUCCESS)
  152. {
  153. *p_digest_size = NRF_CRYPTO_HASH_SIZE_SHA256;
  154. }
  155. return ret_val;
  156. }
  157. const nrf_crypto_hash_info_t g_nrf_crypto_hash_sha256_info =
  158. {
  159. .init_fn = cc310_backend_hash_sha256_init,
  160. .update_fn = cc310_backend_hash_sha256_update,
  161. .finalize_fn = cc310_backend_hash_sha256_finalize,
  162. .digest_size = NRF_CRYPTO_HASH_SIZE_SHA256,
  163. .context_size = sizeof(nrf_crypto_backend_hash_sha256_context_t),
  164. .hash_mode = NRF_CRYPTO_HASH_MODE_SHA256
  165. };
  166. #endif // NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_CC310_HASH_SHA256)
  167. #if NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_CC310_HASH_SHA512)
  168. // SHA-512 does not use CC310 hardware and therefore will not use a mutex lock
  169. static ret_code_t cc310_backend_hash_sha512_init(void * p_context)
  170. {
  171. uint32_t ret_val;
  172. CRYSError_t crys_error;
  173. CRYS_HASH_OperationMode_t hash_mode = CRYS_HASH_SHA512_mode;
  174. // No parameter testing on this level.
  175. // This has been done on upper level.
  176. CRYS_HASHUserContext_t * const p_backend_context
  177. = &(((nrf_crypto_backend_hash_sha512_context_t * ) p_context)->context);
  178. crys_error = CRYS_HASH_Init(p_backend_context, hash_mode);
  179. ret_val = hash_result_get(crys_error);
  180. return ret_val;
  181. }
  182. static ret_code_t cc310_backend_hash_sha512_update(void * const p_context,
  183. uint8_t const * p_data,
  184. size_t size)
  185. {
  186. ret_code_t ret_val;
  187. CRYSError_t crys_error;
  188. // Limited parameter testing on this level.
  189. // This has been done on upper level.
  190. CRYS_HASHUserContext_t * const p_backend_context
  191. = &(((nrf_crypto_backend_hash_sha512_context_t *)p_context)->context);
  192. // Data in flash could lead to silently calculating wrong Hash.
  193. VERIFY_TRUE(nrfx_is_in_ram(p_data), NRF_ERROR_CRYPTO_INPUT_LOCATION);
  194. crys_error = CRYS_HASH_Update(p_backend_context, (uint8_t *)p_data, size);
  195. ret_val = hash_result_get(crys_error);
  196. return ret_val;
  197. }
  198. static ret_code_t cc310_backend_hash_sha512_finalize(void * const p_context,
  199. uint8_t * p_digest,
  200. size_t * const p_digest_size)
  201. {
  202. ret_code_t ret_val;
  203. CRYSError_t crys_error;
  204. CRYS_HASH_Result_t * p_int_digest = (CRYS_HASH_Result_t *)p_digest;
  205. // Limited parameter testing on this level.
  206. // This has been done on upper level.
  207. CRYS_HASHUserContext_t * const p_backend_context
  208. = &(((nrf_crypto_backend_hash_sha512_context_t *) p_context)->context);
  209. crys_error = CRYS_HASH_Finish(p_backend_context, *p_int_digest);
  210. ret_val = hash_result_get(crys_error);
  211. if (ret_val == NRF_SUCCESS)
  212. {
  213. *p_digest_size = NRF_CRYPTO_HASH_SIZE_SHA512;
  214. }
  215. return ret_val;
  216. }
  217. const nrf_crypto_hash_info_t g_nrf_crypto_hash_sha512_info =
  218. {
  219. .init_fn = cc310_backend_hash_sha512_init,
  220. .update_fn = cc310_backend_hash_sha512_update,
  221. .finalize_fn = cc310_backend_hash_sha512_finalize,
  222. .digest_size = NRF_CRYPTO_HASH_SIZE_SHA512,
  223. .context_size = sizeof(nrf_crypto_backend_hash_sha512_context_t),
  224. .hash_mode = NRF_CRYPTO_HASH_MODE_SHA512
  225. };
  226. #endif // NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_CC310_HASH_SHA512)
  227. #endif // NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_CC310_HASH_SHA256) || NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_CC310_HASH_SHA512)
  228. #endif // NRF_MODULE_ENABLED(NRF_CRYPTO) && #if NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_CC310)