crypto_platform.h 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  1. /**
  2. * \file psa/crypto_platform.h
  3. *
  4. * \brief PSA cryptography module: Mbed TLS platform definitions
  5. *
  6. * \note This file may not be included directly. Applications must
  7. * include psa/crypto.h.
  8. *
  9. * This file contains platform-dependent type definitions.
  10. *
  11. * In implementations with isolation between the application and the
  12. * cryptography module, implementers should take care to ensure that
  13. * the definitions that are exposed to applications match what the
  14. * module implements.
  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_PLATFORM_H
  33. #define PSA_CRYPTO_PLATFORM_H
  34. #include "mbedtls/private_access.h"
  35. /* Include the Mbed TLS configuration file, the way Mbed TLS does it
  36. * in each of its header files. */
  37. #include "mbedtls/build_info.h"
  38. /* Translate between classic MBEDTLS_xxx feature symbols and PSA_xxx
  39. * feature symbols. */
  40. #include "mbedtls/config_psa.h"
  41. /* PSA requires several types which C99 provides in stdint.h. */
  42. #include <stdint.h>
  43. #if defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
  44. /* Building for the PSA Crypto service on a PSA platform, a key owner is a PSA
  45. * partition identifier.
  46. *
  47. * The function psa_its_identifier_of_slot() in psa_crypto_storage.c that
  48. * translates a key identifier to a key storage file name assumes that
  49. * mbedtls_key_owner_id_t is a 32-bit integer. This function thus needs
  50. * reworking if mbedtls_key_owner_id_t is not defined as a 32-bit integer
  51. * here anymore.
  52. */
  53. typedef int32_t mbedtls_key_owner_id_t;
  54. /** Compare two key owner identifiers.
  55. *
  56. * \param id1 First key owner identifier.
  57. * \param id2 Second key owner identifier.
  58. *
  59. * \return Non-zero if the two key owner identifiers are equal, zero otherwise.
  60. */
  61. static inline int mbedtls_key_owner_id_equal(mbedtls_key_owner_id_t id1,
  62. mbedtls_key_owner_id_t id2)
  63. {
  64. return id1 == id2;
  65. }
  66. #endif /* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER */
  67. /*
  68. * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is being built for SPM
  69. * (Secure Partition Manager) integration which separates the code into two
  70. * parts: NSPE (Non-Secure Processing Environment) and SPE (Secure Processing
  71. * Environment). When building for the SPE, an additional header file should be
  72. * included.
  73. */
  74. #if defined(MBEDTLS_PSA_CRYPTO_SPM)
  75. #define PSA_CRYPTO_SECURE 1
  76. #include "crypto_spe.h"
  77. #endif // MBEDTLS_PSA_CRYPTO_SPM
  78. #if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
  79. /** The type of the context passed to mbedtls_psa_external_get_random().
  80. *
  81. * Mbed TLS initializes the context to all-bits-zero before calling
  82. * mbedtls_psa_external_get_random() for the first time.
  83. *
  84. * The definition of this type in the Mbed TLS source code is for
  85. * demonstration purposes. Implementers of mbedtls_psa_external_get_random()
  86. * are expected to replace it with a custom definition.
  87. */
  88. typedef struct {
  89. uintptr_t MBEDTLS_PRIVATE(opaque)[2];
  90. } mbedtls_psa_external_random_context_t;
  91. #endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
  92. #endif /* PSA_CRYPTO_PLATFORM_H */