Kenji Arai / mbed-os_TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

Asymmetric cryptography

Asymmetric cryptography

Functions

psa_status_t psa_asymmetric_sign (psa_key_handle_t handle, psa_algorithm_t alg, const uint8_t *hash, size_t hash_length, uint8_t *signature, size_t signature_size, size_t *signature_length)
 Sign a hash or short message with a private key.
psa_status_t psa_asymmetric_verify (psa_key_handle_t handle, psa_algorithm_t alg, const uint8_t *hash, size_t hash_length, const uint8_t *signature, size_t signature_length)
 Verify the signature a hash or short message using a public key.
psa_status_t psa_asymmetric_encrypt (psa_key_handle_t handle, psa_algorithm_t alg, const uint8_t *input, size_t input_length, const uint8_t *salt, size_t salt_length, uint8_t *output, size_t output_size, size_t *output_length)
 Encrypt a short message with a public key.
psa_status_t psa_asymmetric_decrypt (psa_key_handle_t handle, psa_algorithm_t alg, const uint8_t *input, size_t input_length, const uint8_t *salt, size_t salt_length, uint8_t *output, size_t output_size, size_t *output_length)
 Decrypt a short message with a private key.

Function Documentation

psa_status_t psa_asymmetric_decrypt ( psa_key_handle_t  handle,
psa_algorithm_t  alg,
const uint8_t *  input,
size_t  input_length,
const uint8_t *  salt,
size_t  salt_length,
uint8_t *  output,
size_t  output_size,
size_t *  output_length 
)

Decrypt a short message with a private key.

Parameters:
handleHandle to the key to use for the operation. It must be an asymmetric key pair.
algAn asymmetric encryption algorithm that is compatible with the type of handle.
[in]inputThe message to decrypt.
input_lengthSize of the input buffer in bytes.
[in]saltA salt or label, if supported by the encryption algorithm. If the algorithm does not support a salt, pass NULL. If the algorithm supports an optional salt and you do not want to pass a salt, pass NULL.
  • For PSA_ALG_RSA_PKCS1V15_CRYPT, no salt is supported.
    Parameters:
    salt_lengthSize of the salt buffer in bytes. If salt is NULL, pass 0.
    [out]outputBuffer where the decrypted message is to be written.
    output_sizeSize of the output buffer in bytes.
    [out]output_lengthOn success, the number of bytes that make up the returned output.
    Return values:
    PSA_SUCCESS
    PSA_ERROR_INVALID_HANDLE
    PSA_ERROR_NOT_PERMITTED
    PSA_ERROR_BUFFER_TOO_SMALLThe size of the output buffer is too small. You can determine a sufficient buffer size by calling PSA_ASYMMETRIC_DECRYPT_OUTPUT_SIZE(key_type, key_bits, alg) where key_type and key_bits are the type and bit-size respectively of handle.
    PSA_ERROR_NOT_SUPPORTED
    PSA_ERROR_INVALID_ARGUMENT
    PSA_ERROR_INSUFFICIENT_MEMORY
    PSA_ERROR_COMMUNICATION_FAILURE
    PSA_ERROR_HARDWARE_FAILURE
    PSA_ERROR_CORRUPTION_DETECTED
    PSA_ERROR_STORAGE_FAILURE
    PSA_ERROR_INSUFFICIENT_ENTROPY
    PSA_ERROR_INVALID_PADDING
    PSA_ERROR_BAD_STATEThe library has not been previously initialized by psa_crypto_init(). It is implementation-dependent whether a failure to initialize results in this error code.

Definition at line 3569 of file psa_crypto.c.

psa_status_t psa_asymmetric_encrypt ( psa_key_handle_t  handle,
psa_algorithm_t  alg,
const uint8_t *  input,
size_t  input_length,
const uint8_t *  salt,
size_t  salt_length,
uint8_t *  output,
size_t  output_size,
size_t *  output_length 
)

Encrypt a short message with a public key.

Parameters:
handleHandle to the key to use for the operation. It must be a public key or an asymmetric key pair.
algAn asymmetric encryption algorithm that is compatible with the type of handle.
[in]inputThe message to encrypt.
input_lengthSize of the input buffer in bytes.
[in]saltA salt or label, if supported by the encryption algorithm. If the algorithm does not support a salt, pass NULL. If the algorithm supports an optional salt and you do not want to pass a salt, pass NULL.
  • For PSA_ALG_RSA_PKCS1V15_CRYPT, no salt is supported.
    Parameters:
    salt_lengthSize of the salt buffer in bytes. If salt is NULL, pass 0.
    [out]outputBuffer where the encrypted message is to be written.
    output_sizeSize of the output buffer in bytes.
    [out]output_lengthOn success, the number of bytes that make up the returned output.
    Return values:
    PSA_SUCCESS
    PSA_ERROR_INVALID_HANDLE
    PSA_ERROR_NOT_PERMITTED
    PSA_ERROR_BUFFER_TOO_SMALLThe size of the output buffer is too small. You can determine a sufficient buffer size by calling PSA_ASYMMETRIC_ENCRYPT_OUTPUT_SIZE(key_type, key_bits, alg) where key_type and key_bits are the type and bit-size respectively of handle.
    PSA_ERROR_NOT_SUPPORTED
    PSA_ERROR_INVALID_ARGUMENT
    PSA_ERROR_INSUFFICIENT_MEMORY
    PSA_ERROR_COMMUNICATION_FAILURE
    PSA_ERROR_HARDWARE_FAILURE
    PSA_ERROR_CORRUPTION_DETECTED
    PSA_ERROR_STORAGE_FAILURE
    PSA_ERROR_INSUFFICIENT_ENTROPY
    PSA_ERROR_BAD_STATEThe library has not been previously initialized by psa_crypto_init(). It is implementation-dependent whether a failure to initialize results in this error code.

Definition at line 3489 of file psa_crypto.c.

psa_status_t psa_asymmetric_sign ( psa_key_handle_t  handle,
psa_algorithm_t  alg,
const uint8_t *  hash,
size_t  hash_length,
uint8_t *  signature,
size_t  signature_size,
size_t *  signature_length 
)

Sign a hash or short message with a private key.

Note that to perform a hash-and-sign signature algorithm, you must first calculate the hash by calling psa_hash_setup(), psa_hash_update() and psa_hash_finish(). Then pass the resulting hash as the hash parameter to this function. You can use PSA_ALG_SIGN_GET_HASH(alg) to determine the hash algorithm to use.

Parameters:
handleHandle to the key to use for the operation. It must be an asymmetric key pair.
algA signature algorithm that is compatible with the type of handle.
[in]hashThe hash or message to sign.
hash_lengthSize of the hash buffer in bytes.
[out]signatureBuffer where the signature is to be written.
signature_sizeSize of the signature buffer in bytes.
[out]signature_lengthOn success, the number of bytes that make up the returned signature value.
Return values:
PSA_SUCCESS
PSA_ERROR_INVALID_HANDLE
PSA_ERROR_NOT_PERMITTED
PSA_ERROR_BUFFER_TOO_SMALLThe size of the signature buffer is too small. You can determine a sufficient buffer size by calling PSA_ASYMMETRIC_SIGN_OUTPUT_SIZE(key_type, key_bits, alg) where key_type and key_bits are the type and bit-size respectively of handle.
PSA_ERROR_NOT_SUPPORTED
PSA_ERROR_INVALID_ARGUMENT
PSA_ERROR_INSUFFICIENT_MEMORY
PSA_ERROR_COMMUNICATION_FAILURE
PSA_ERROR_HARDWARE_FAILURE
PSA_ERROR_CORRUPTION_DETECTED
PSA_ERROR_STORAGE_FAILURE
PSA_ERROR_INSUFFICIENT_ENTROPY
PSA_ERROR_BAD_STATEThe library has not been previously initialized by psa_crypto_init(). It is implementation-dependent whether a failure to initialize results in this error code.

Definition at line 3311 of file psa_crypto.c.

psa_status_t psa_asymmetric_verify ( psa_key_handle_t  handle,
psa_algorithm_t  alg,
const uint8_t *  hash,
size_t  hash_length,
const uint8_t *  signature,
size_t  signature_length 
)

Verify the signature a hash or short message using a public key.

Note that to perform a hash-and-sign signature algorithm, you must first calculate the hash by calling psa_hash_setup(), psa_hash_update() and psa_hash_finish(). Then pass the resulting hash as the hash parameter to this function. You can use PSA_ALG_SIGN_GET_HASH(alg) to determine the hash algorithm to use.

Parameters:
handleHandle to the key to use for the operation. It must be a public key or an asymmetric key pair.
algA signature algorithm that is compatible with the type of handle.
[in]hashThe hash or message whose signature is to be verified.
hash_lengthSize of the hash buffer in bytes.
[in]signatureBuffer containing the signature to verify.
signature_lengthSize of the signature buffer in bytes.
Return values:
PSA_SUCCESSThe signature is valid.
PSA_ERROR_INVALID_HANDLE
PSA_ERROR_NOT_PERMITTED
PSA_ERROR_INVALID_SIGNATUREThe calculation was perfomed successfully, but the passed signature is not a valid signature.
PSA_ERROR_NOT_SUPPORTED
PSA_ERROR_INVALID_ARGUMENT
PSA_ERROR_INSUFFICIENT_MEMORY
PSA_ERROR_COMMUNICATION_FAILURE
PSA_ERROR_HARDWARE_FAILURE
PSA_ERROR_CORRUPTION_DETECTED
PSA_ERROR_STORAGE_FAILURE
PSA_ERROR_BAD_STATEThe library has not been previously initialized by psa_crypto_init(). It is implementation-dependent whether a failure to initialize results in this error code.

Definition at line 3415 of file psa_crypto.c.