text: /*
   *  PSA RSA layer on top of Mbed TLS crypto
   */
  /*
   *  Copyright The Mbed TLS Contributors
   *  SPDX-License-Identifier: Apache-2.0
   *
   *  Licensed under the Apache License, Version 2.0 (the "License"); you may
   *  not use this file except in compliance with the License.
   *  You may obtain a copy of the License at
   *
   *  http://www.apache.org/licenses/LICENSE-2.0
   *
   *  Unless required by applicable law or agreed to in writing, software
   *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
   *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   *  See the License for the specific language governing permissions and
   *  limitations under the License.
   */
  
  #ifndef PSA_CRYPTO_RSA_H
  #define PSA_CRYPTO_RSA_H
  
  #include <psa/crypto.h>
  #include <mbedtls/rsa.h>
  
  /** Load the contents of a key buffer into an internal RSA representation
   *
   * \param[in] type          The type of key contained in \p data.
   * \param[in] data          The buffer from which to load the representation.
   * \param[in] data_length   The size in bytes of \p data.
   * \param[out] p_rsa        Returns a pointer to an RSA context on success.
   *                          The caller is responsible for freeing both the
   *                          contents of the context and the context itself
   *                          when done.
   */
  psa_status_t mbedtls_psa_rsa_load_representation( psa_key_type_t type,
                                                    const uint8_t *data,
                                                    size_t data_length,
                                                    mbedtls_rsa_context **p_rsa );
  
  /** Import an RSA key in binary format.
   *
   * \note The signature of this function is that of a PSA driver
   *       import_key entry point. This function behaves as an import_key
   *       entry point as defined in the PSA driver interface specification for
   *       transparent drivers.
   *
   * \param[in]  attributes       The attributes for the key to import.
   * \param[in]  data             The buffer containing the key data in import
   *                              format.
   * \param[in]  data_length      Size of the \p data buffer in bytes.
   * \param[out] key_buffer       The buffer containing the key data in output
   *                              format.
   * \param[in]  key_buffer_size  Size of the \p key_buffer buffer in bytes. This
   *                              size is greater or equal to \p data_length.
   * \param[out] key_buffer_length  The length of the data written in \p
   *                                key_buffer in bytes.
   * \param[out] bits             The key size in number of bits.
   *
   * \retval #PSA_SUCCESS  The RSA key was imported successfully.
   * \retval #PSA_ERROR_INVALID_ARGUMENT
   *         The key data is not correctly formatted.
   * \retval #PSA_ERROR_NOT_SUPPORTED
   * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
   * \retval #PSA_ERROR_CORRUPTION_DETECTED
   */
  psa_status_t mbedtls_psa_rsa_import_key(
      const psa_key_attributes_t *attributes,
      const uint8_t *data, size_t data_length,
      uint8_t *key_buffer, size_t key_buffer_size,
      size_t *key_buffer_length, size_t *bits );
  
  /** Export an RSA key to export representation
   *
   * \param[in] type          The type of key (public/private) to export
   * \param[in] rsa           The internal RSA representation from which to export
   * \param[out] data         The buffer to export to
   * \param[in] data_size     The length of the buffer to export to
   * \param[out] data_length  The amount of bytes written to \p data
   */
  psa_status_t mbedtls_psa_rsa_export_key( psa_key_type_t type,
                                           mbedtls_rsa_context *rsa,
                                           uint8_t *data,
                                           size_t data_size,
                                           size_t *data_length );
  
  /** Export a public RSA key or the public part of an RSA key pair in binary
   *  format.
   *
   * \note The signature of this function is that of a PSA driver
   *       export_public_key entry point. This function behaves as an
   *       export_public_key entry point as defined in the PSA driver interface
   *       specification.
   *
   * \param[in]  attributes       The attributes for the key to export.
   * \param[in]  key_buffer       Material or context of the key to export.
   * \param[in]  key_buffer_size  Size of the \p key_buffer buffer in bytes.
   * \param[out] data             Buffer where the key data is to be written.
   * \param[in]  data_size        Size of the \p data buffer in bytes.
   * \param[out] data_length      On success, the number of bytes written in
   *                              \p data.
   *
   * \retval #PSA_SUCCESS  The RSA public key was exported successfully.
   * \retval #PSA_ERROR_NOT_SUPPORTED
   * \retval #PSA_ERROR_COMMUNICATION_FAILURE
   * \retval #PSA_ERROR_HARDWARE_FAILURE
   * \retval #PSA_ERROR_CORRUPTION_DETECTED
   * \retval #PSA_ERROR_STORAGE_FAILURE
   * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
   */
  psa_status_t mbedtls_psa_rsa_export_public_key(
      const psa_key_attributes_t *attributes,
      const uint8_t *key_buffer, size_t key_buffer_size,
      uint8_t *data, size_t data_size, size_t *data_length );
  
  /**
   * \brief Generate an RSA key.
   *
   * \note The signature of the function is that of a PSA driver generate_key
   *       entry point.
   *
   * \param[in]  attributes         The attributes for the RSA key to generate.
   * \param[out] key_buffer         Buffer where the key data is to be written.
   * \param[in]  key_buffer_size    Size of \p key_buffer in bytes.
   * \param[out] key_buffer_length  On success, the number of bytes written in
   *                                \p key_buffer.
   *
   * \retval #PSA_SUCCESS
   *         The key was successfully generated.
   * \retval #PSA_ERROR_NOT_SUPPORTED
   *         Key length or type not supported.
   * \retval #PSA_ERROR_BUFFER_TOO_SMALL
   *         The size of \p key_buffer is too small.
   */
  psa_status_t mbedtls_psa_rsa_generate_key(
      const psa_key_attributes_t *attributes,
      uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length );
  
  /** Sign an already-calculated hash with an RSA private key.
   *
   * \note The signature of this function is that of a PSA driver
   *       sign_hash entry point. This function behaves as a sign_hash
   *       entry point as defined in the PSA driver interface specification for
   *       transparent drivers.
   *
   * \param[in]  attributes       The attributes of the RSA key to use for the
   *                              operation.
   * \param[in]  key_buffer       The buffer containing the RSA key context.
   *                              format.
   * \param[in]  key_buffer_size  Size of the \p key_buffer buffer in bytes.
   * \param[in]  alg              A signature algorithm that is compatible with
   *                              an RSA key.
   * \param[in]  hash             The hash or message to sign.
   * \param[in]  hash_length      Size of the \p hash buffer in bytes.
   * \param[out] signature        Buffer where the signature is to be written.
   * \param[in]  signature_size   Size of the \p signature buffer in bytes.
   * \param[out] signature_length On success, the number of bytes
   *                              that make up the returned signature value.
   *
   * \retval #PSA_SUCCESS
   * \retval #PSA_ERROR_BUFFER_TOO_SMALL
   *         The size of the \p signature buffer is too small. You can
   *         determine a sufficient buffer size by calling
   *         #PSA_SIGN_OUTPUT_SIZE(\c PSA_KEY_TYPE_RSA_KEY_PAIR, \c key_bits,
   *         \p alg) where \c key_bits is the bit-size of the RSA key.
   * \retval #PSA_ERROR_NOT_SUPPORTED
   * \retval #PSA_ERROR_INVALID_ARGUMENT
   * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
   * \retval #PSA_ERROR_CORRUPTION_DETECTED
   * \retval #PSA_ERROR_INSUFFICIENT_ENTROPY
   */
  psa_status_t mbedtls_psa_rsa_sign_hash(
      const psa_key_attributes_t *attributes,
      const uint8_t *key_buffer, size_t key_buffer_size,
      psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
      uint8_t *signature, size_t signature_size, size_t *signature_length );
  
  /**
   * \brief Verify the signature a hash or short message using a public RSA key.
   *
   * \note The signature of this function is that of a PSA driver
   *       verify_hash entry point. This function behaves as a verify_hash
   *       entry point as defined in the PSA driver interface specification for
   *       transparent drivers.
   *
   * \param[in]  attributes       The attributes of the RSA key to use for the
   *                              operation.
   * \param[in]  key_buffer       The buffer containing the RSA key context.
   *                              format.
   * \param[in]  key_buffer_size  Size of the \p key_buffer buffer in bytes.
   * \param[in]  alg              A signature algorithm that is compatible with
   *                              an RSA key.
   * \param[in]  hash             The hash or message whose signature is to be
   *                              verified.
   * \param[in]  hash_length      Size of the \p hash buffer in bytes.
   * \param[in]  signature        Buffer containing the signature to verify.
   * \param[in]  signature_length Size of the \p signature buffer in bytes.
   *
   * \retval #PSA_SUCCESS
   *         The signature is valid.
   * \retval #PSA_ERROR_INVALID_SIGNATURE
   *         The calculation was performed successfully, but the passed
   *         signature is not a valid signature.
   * \retval #PSA_ERROR_NOT_SUPPORTED
   * \retval #PSA_ERROR_INVALID_ARGUMENT
   * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
   */
  psa_status_t mbedtls_psa_rsa_verify_hash(
      const psa_key_attributes_t *attributes,
      const uint8_t *key_buffer, size_t key_buffer_size,
      psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
      const uint8_t *signature, size_t signature_length );
  
  #endif /* PSA_CRYPTO_RSA_H */
  