crypto_builtin_composites.h 7.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219
  1. /*
  2. * Context structure declaration of the Mbed TLS software-based PSA drivers
  3. * called through the PSA Crypto driver dispatch layer.
  4. * This file contains the context structures of those algorithms which need to
  5. * rely on other algorithms, i.e. are 'composite' algorithms.
  6. *
  7. * \note This file may not be included directly. Applications must
  8. * include psa/crypto.h.
  9. *
  10. * \note This header and its content is not part of the Mbed TLS API and
  11. * applications must not depend on it. Its main purpose is to define the
  12. * multi-part state objects of the Mbed TLS software-based PSA drivers. The
  13. * definition of these objects are then used by crypto_struct.h to define the
  14. * implementation-defined types of PSA multi-part state objects.
  15. */
  16. /*
  17. * Copyright The Mbed TLS Contributors
  18. * SPDX-License-Identifier: Apache-2.0
  19. *
  20. * Licensed under the Apache License, Version 2.0 (the "License"); you may
  21. * not use this file except in compliance with the License.
  22. * You may obtain a copy of the License at
  23. *
  24. * http://www.apache.org/licenses/LICENSE-2.0
  25. *
  26. * Unless required by applicable law or agreed to in writing, software
  27. * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  28. * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  29. * See the License for the specific language governing permissions and
  30. * limitations under the License.
  31. */
  32. #ifndef PSA_CRYPTO_BUILTIN_COMPOSITES_H
  33. #define PSA_CRYPTO_BUILTIN_COMPOSITES_H
  34. #include "mbedtls/private_access.h"
  35. #include <psa/crypto_driver_common.h>
  36. /*
  37. * MAC multi-part operation definitions.
  38. */
  39. #if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC) || \
  40. defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
  41. #define MBEDTLS_PSA_BUILTIN_MAC
  42. #endif
  43. #if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) || defined(PSA_CRYPTO_DRIVER_TEST)
  44. typedef struct {
  45. /** The HMAC algorithm in use */
  46. psa_algorithm_t MBEDTLS_PRIVATE(alg);
  47. /** The hash context. */
  48. struct psa_hash_operation_s hash_ctx;
  49. /** The HMAC part of the context. */
  50. uint8_t MBEDTLS_PRIVATE(opad)[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
  51. } mbedtls_psa_hmac_operation_t;
  52. #define MBEDTLS_PSA_HMAC_OPERATION_INIT { 0, PSA_HASH_OPERATION_INIT, { 0 } }
  53. #endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
  54. #include "mbedtls/cmac.h"
  55. typedef struct {
  56. psa_algorithm_t MBEDTLS_PRIVATE(alg);
  57. union {
  58. unsigned MBEDTLS_PRIVATE(dummy); /* Make the union non-empty even with no supported algorithms. */
  59. #if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) || defined(PSA_CRYPTO_DRIVER_TEST)
  60. mbedtls_psa_hmac_operation_t MBEDTLS_PRIVATE(hmac);
  61. #endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
  62. #if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC) || defined(PSA_CRYPTO_DRIVER_TEST)
  63. mbedtls_cipher_context_t MBEDTLS_PRIVATE(cmac);
  64. #endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
  65. } MBEDTLS_PRIVATE(ctx);
  66. } mbedtls_psa_mac_operation_t;
  67. #define MBEDTLS_PSA_MAC_OPERATION_INIT { 0, { 0 } }
  68. #if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM) || \
  69. defined(MBEDTLS_PSA_BUILTIN_ALG_CCM) || \
  70. defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
  71. #define MBEDTLS_PSA_BUILTIN_AEAD 1
  72. #endif
  73. /* Context structure for the Mbed TLS AEAD implementation. */
  74. typedef struct {
  75. psa_algorithm_t MBEDTLS_PRIVATE(alg);
  76. psa_key_type_t MBEDTLS_PRIVATE(key_type);
  77. unsigned int MBEDTLS_PRIVATE(is_encrypt) : 1;
  78. uint8_t MBEDTLS_PRIVATE(tag_length);
  79. union {
  80. unsigned dummy; /* Enable easier initializing of the union. */
  81. #if defined(MBEDTLS_PSA_BUILTIN_ALG_CCM)
  82. mbedtls_ccm_context MBEDTLS_PRIVATE(ccm);
  83. #endif /* MBEDTLS_PSA_BUILTIN_ALG_CCM */
  84. #if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
  85. mbedtls_gcm_context MBEDTLS_PRIVATE(gcm);
  86. #endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
  87. #if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
  88. mbedtls_chachapoly_context MBEDTLS_PRIVATE(chachapoly);
  89. #endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
  90. } ctx;
  91. } mbedtls_psa_aead_operation_t;
  92. #define MBEDTLS_PSA_AEAD_OPERATION_INIT { 0, 0, 0, 0, { 0 } }
  93. #include "mbedtls/ecdsa.h"
  94. /* Context structure for the Mbed TLS interruptible sign hash implementation. */
  95. typedef struct {
  96. #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
  97. defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
  98. defined(MBEDTLS_ECP_RESTARTABLE)
  99. mbedtls_ecdsa_context *MBEDTLS_PRIVATE(ctx);
  100. mbedtls_ecdsa_restart_ctx MBEDTLS_PRIVATE(restart_ctx);
  101. uint32_t MBEDTLS_PRIVATE(num_ops);
  102. size_t MBEDTLS_PRIVATE(coordinate_bytes);
  103. psa_algorithm_t MBEDTLS_PRIVATE(alg);
  104. mbedtls_md_type_t MBEDTLS_PRIVATE(md_alg);
  105. uint8_t MBEDTLS_PRIVATE(hash)[PSA_BITS_TO_BYTES(PSA_VENDOR_ECC_MAX_CURVE_BITS)];
  106. size_t MBEDTLS_PRIVATE(hash_length);
  107. #else
  108. /* Make the struct non-empty if algs not supported. */
  109. unsigned MBEDTLS_PRIVATE(dummy);
  110. #endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
  111. * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
  112. * defined( MBEDTLS_ECP_RESTARTABLE ) */
  113. } mbedtls_psa_sign_hash_interruptible_operation_t;
  114. #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
  115. defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
  116. defined(MBEDTLS_ECP_RESTARTABLE)
  117. #define MBEDTLS_PSA_SIGN_HASH_INTERRUPTIBLE_OPERATION_INIT { { 0 }, { 0 }, 0, 0, 0, 0, 0, 0 }
  118. #else
  119. #define MBEDTLS_PSA_SIGN_HASH_INTERRUPTIBLE_OPERATION_INIT { 0 }
  120. #endif
  121. /* Context structure for the Mbed TLS interruptible verify hash
  122. * implementation.*/
  123. typedef struct {
  124. #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
  125. defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
  126. defined(MBEDTLS_ECP_RESTARTABLE)
  127. mbedtls_ecdsa_context *MBEDTLS_PRIVATE(ctx);
  128. mbedtls_ecdsa_restart_ctx MBEDTLS_PRIVATE(restart_ctx);
  129. uint32_t MBEDTLS_PRIVATE(num_ops);
  130. uint8_t MBEDTLS_PRIVATE(hash)[PSA_BITS_TO_BYTES(PSA_VENDOR_ECC_MAX_CURVE_BITS)];
  131. size_t MBEDTLS_PRIVATE(hash_length);
  132. mbedtls_mpi MBEDTLS_PRIVATE(r);
  133. mbedtls_mpi MBEDTLS_PRIVATE(s);
  134. #else
  135. /* Make the struct non-empty if algs not supported. */
  136. unsigned MBEDTLS_PRIVATE(dummy);
  137. #endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
  138. * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
  139. * defined( MBEDTLS_ECP_RESTARTABLE ) */
  140. } mbedtls_psa_verify_hash_interruptible_operation_t;
  141. #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
  142. defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
  143. defined(MBEDTLS_ECP_RESTARTABLE)
  144. #define MBEDTLS_VERIFY_SIGN_HASH_INTERRUPTIBLE_OPERATION_INIT { { 0 }, { 0 }, 0, 0, 0, 0, { 0 }, \
  145. { 0 } }
  146. #else
  147. #define MBEDTLS_VERIFY_SIGN_HASH_INTERRUPTIBLE_OPERATION_INIT { 0 }
  148. #endif
  149. /* EC-JPAKE operation definitions */
  150. #include "mbedtls/ecjpake.h"
  151. #if defined(MBEDTLS_PSA_BUILTIN_ALG_JPAKE)
  152. #define MBEDTLS_PSA_BUILTIN_PAKE 1
  153. #endif
  154. /* Note: the format for mbedtls_ecjpake_read/write function has an extra
  155. * length byte for each step, plus an extra 3 bytes for ECParameters in the
  156. * server's 2nd round. */
  157. #define MBEDTLS_PSA_JPAKE_BUFFER_SIZE ((3 + 1 + 65 + 1 + 65 + 1 + 32) * 2)
  158. typedef struct {
  159. psa_algorithm_t MBEDTLS_PRIVATE(alg);
  160. uint8_t *MBEDTLS_PRIVATE(password);
  161. size_t MBEDTLS_PRIVATE(password_len);
  162. #if defined(MBEDTLS_PSA_BUILTIN_ALG_JPAKE)
  163. uint8_t MBEDTLS_PRIVATE(role);
  164. uint8_t MBEDTLS_PRIVATE(buffer[MBEDTLS_PSA_JPAKE_BUFFER_SIZE]);
  165. size_t MBEDTLS_PRIVATE(buffer_length);
  166. size_t MBEDTLS_PRIVATE(buffer_offset);
  167. #endif
  168. /* Context structure for the Mbed TLS EC-JPAKE implementation. */
  169. union {
  170. unsigned int MBEDTLS_PRIVATE(dummy);
  171. #if defined(MBEDTLS_PSA_BUILTIN_ALG_JPAKE)
  172. mbedtls_ecjpake_context MBEDTLS_PRIVATE(jpake);
  173. #endif
  174. } MBEDTLS_PRIVATE(ctx);
  175. } mbedtls_psa_pake_operation_t;
  176. #define MBEDTLS_PSA_PAKE_OPERATION_INIT { { 0 } }
  177. #endif /* PSA_CRYPTO_BUILTIN_COMPOSITES_H */