optiga_backend_ecc.h 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200
  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 OPTIGA_BACKEND_ECC_H__
  41. #define OPTIGA_BACKEND_ECC_H__
  42. #include "sdk_config.h"
  43. #include "nordic_common.h"
  44. #if NRF_MODULE_ENABLED(NRF_CRYPTO) && NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_OPTIGA)
  45. #include <stdint.h>
  46. #include <stdbool.h>
  47. #include "nrf_crypto_ecc.h"
  48. /*lint -save -e????*/
  49. #include "optiga/optiga_crypt.h"
  50. /*lint -restore*/
  51. #ifdef __cplusplus
  52. extern "C" {
  53. #endif
  54. /** @internal Magic OID that indicates a host supplied public key
  55. */
  56. #define NRF_CRYPTO_INFINEON_PUBKEY_HOST_OID 0xFFFF
  57. /** @internal Magic OID that indicates to export the private key
  58. */
  59. #define NRF_CRYPTO_INFINEON_PRIVKEY_HOST_OID 0xFFFE
  60. /** @internal @brief Common structure holding private key for the OPTIGA backend.
  61. */
  62. typedef struct nrf_crypto_backend_optiga_ecc_private_key_t
  63. {
  64. nrf_crypto_internal_ecc_key_header_t header; /**< @internal @brief Common ECC key header */
  65. optiga_key_id_t oid; // OID where the private key is stored
  66. uint8_t raw_privkey[64+2]; // Private Key encoded as DER OCTET STRING
  67. } nrf_crypto_backend_optiga_ecc_private_key_t;
  68. #define NRF_CRYPTO_INFINEON_SECP256R1_PRIVATE_KEY_FROM_OID(oid_value) { \
  69. .key_secp256r1 = { \
  70. .header = { \
  71. .init_value = NRF_CRYPTO_INTERNAL_ECC_PRIVATE_KEY_INIT_VALUE, \
  72. .p_info = &g_nrf_crypto_ecc_secp256r1_curve_info \
  73. }, \
  74. .oid = (optiga_key_id_t)(oid_value) \
  75. } \
  76. }
  77. /** @internal @brief Common structure holding public key for the OPTIGA backend.
  78. */
  79. typedef struct
  80. {
  81. nrf_crypto_internal_ecc_key_header_t header; /**< @internal @brief Common ECC key header */
  82. optiga_key_id_t oid; // OID where the public key is stored
  83. uint8_t raw_pubkey[64+4]; // Public Key encoded as DER BITSTRING with header
  84. } nrf_crypto_backend_secp256r1_public_key_t;
  85. #define NRF_CRYPTO_INFINEON_SECP256R1_PUBLIC_KEY_FROM_OID(oid_value) { \
  86. .key_secp256r1 = { \
  87. .header = { \
  88. .init_value = NRF_CRYPTO_INTERNAL_ECC_PUBLIC_KEY_INIT_VALUE, \
  89. .p_info = &g_nrf_crypto_ecc_secp256r1_curve_info \
  90. }, \
  91. .oid = (optiga_key_id_t)(oid_value) \
  92. } \
  93. }
  94. #define NRF_CRYPTO_INFINEON_SECP256R1_PUBLIC_KEY_RAW \
  95. NRF_CRYPTO_INFINEON_SECP256R1_PUBLIC_KEY_FROM_OID(NRF_CRYPTO_INFINEON_PUBKEY_HOST_OID)
  96. /** @internal See @ref nrf_crypto_backend_ecc_key_pair_generate_fn_t.
  97. */
  98. ret_code_t nrf_crypto_backend_optiga_key_pair_generate(
  99. void * p_context,
  100. void * p_private_key,
  101. void * p_public_key);
  102. /** @internal See @ref nrf_crypto_backend_ecc_public_key_calculate_fn_t.
  103. */
  104. ret_code_t nrf_crypto_backend_optiga_public_key_calculate(
  105. void * p_context,
  106. void const * p_private_key,
  107. void * p_public_key);
  108. /** @internal See @ref nrf_crypto_backend_ecc_private_key_from_raw_fn_t.
  109. */
  110. ret_code_t nrf_crypto_backend_optiga_private_key_from_raw(
  111. void * p_private_key,
  112. uint8_t const * p_raw_data);
  113. /** @internal See @ref nrf_crypto_backend_ecc_private_key_to_raw_fn_t.
  114. */
  115. ret_code_t nrf_crypto_backend_optiga_private_key_to_raw(
  116. void const * p_private_key,
  117. uint8_t * p_raw_data);
  118. /** @internal See @ref nrf_crypto_backend_ecc_public_key_from_raw_fn_t.
  119. */
  120. ret_code_t nrf_crypto_backend_optiga_public_key_from_raw(
  121. void * p_public_key,
  122. uint8_t const * p_raw_data);
  123. /** @internal See @ref nrf_crypto_backend_ecc_public_key_to_raw_fn_t.
  124. */
  125. ret_code_t nrf_crypto_backend_optiga_public_key_to_raw(
  126. void const * p_public_key,
  127. uint8_t * p_raw_data);
  128. /** @internal See @ref nrf_crypto_backend_ecc_key_free_fn_t.
  129. */
  130. ret_code_t nrf_crypto_backend_optiga_private_key_free(
  131. void * p_private_key);
  132. /** @internal See @ref nrf_crypto_backend_ecc_key_free_fn_t.
  133. */
  134. ret_code_t nrf_crypto_backend_optiga_public_key_free(
  135. void * p_public_key);
  136. #if NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_OPTIGA_ECC_SECP256R1)
  137. #if NRF_MODULE_ENABLED(NRF_CRYPTO_ECC_SECP256R1)
  138. #error "More than one backend enabled for secp256r1 (NIST 256-bit).");
  139. #endif
  140. #define NRF_CRYPTO_ECC_SECP256R1_ENABLED 1
  141. // Aliases for one common OPTIGA implementation
  142. #define nrf_crypto_backend_secp256r1_key_pair_generate nrf_crypto_backend_optiga_key_pair_generate
  143. #define nrf_crypto_backend_secp256r1_public_key_calculate nrf_crypto_backend_optiga_public_key_calculate
  144. #define nrf_crypto_backend_secp256r1_private_key_from_raw nrf_crypto_backend_optiga_private_key_from_raw
  145. #define nrf_crypto_backend_secp256r1_private_key_to_raw nrf_crypto_backend_optiga_private_key_to_raw
  146. #define nrf_crypto_backend_secp256r1_public_key_from_raw nrf_crypto_backend_optiga_public_key_from_raw
  147. #define nrf_crypto_backend_secp256r1_public_key_to_raw nrf_crypto_backend_optiga_public_key_to_raw
  148. #define nrf_crypto_backend_secp256r1_private_key_free nrf_crypto_backend_optiga_private_key_free
  149. #define nrf_crypto_backend_secp256r1_public_key_free nrf_crypto_backend_optiga_public_key_free
  150. // OPTIGA does not require context, so its size is 0.
  151. #define NRF_CRYPTO_BACKEND_SECP256R1_KEY_PAIR_GENERATE_CONTEXT_SIZE 0
  152. #define NRF_CRYPTO_BACKEND_SECP256R1_PUBLIC_KEY_CALCULATE_CONTEXT_SIZE 0
  153. // All OPTIGA curve types share the same private key data structures
  154. typedef nrf_crypto_backend_optiga_ecc_private_key_t nrf_crypto_backend_secp256r1_private_key_t;
  155. // Dummy typedef for unused context
  156. typedef uint32_t nrf_crypto_backend_secp256r1_key_pair_generate_context_t;
  157. typedef uint32_t nrf_crypto_backend_secp256r1_public_key_calculate_context_t;
  158. #endif // NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_OPTIGA_ECC_SECP256R1)
  159. #ifdef __cplusplus
  160. }
  161. #endif
  162. #endif // NRF_MODULE_ENABLED(NRF_CRYPTO) && NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_OPTIGA)
  163. #endif // OPTIGA_BACKEND_ECC_H__