 |
Software APIs
|
|
Software APIs
|
Ed25519 operations for OpenTitan cryptography library. More...
#include "datatypes.h"Go to the source code of this file.
Typedefs | |
| typedef enum otcrypto_eddsa_sign_mode | otcrypto_eddsa_sign_mode_t |
| Hashing mode for EdDSA signatures. More... | |
Enumerations | |
| enum | otcrypto_eddsa_sign_mode { kOtcryptoEddsaSignModeEddsa = 0xae1 , kOtcryptoEddsaSignModeHashEddsa = 0x9a6 } |
| Hashing mode for EdDSA signatures. More... | |
Ed25519 operations for OpenTitan cryptography library.
Definition in file ed25519.h.
| typedef enum otcrypto_eddsa_sign_mode otcrypto_eddsa_sign_mode_t |
Hashing mode for EdDSA signatures.
Values are hardened.
| OT_WARN_UNUSED_RESULT otcrypto_status_t otcrypto_ed25519_keygen | ( | otcrypto_blinded_key_t * | private_key, |
| otcrypto_unblinded_key_t * | public_key | ||
| ) |
Generates a key pair for Ed25519.
The caller should allocate and partially populate the blinded key struct, including populating the key configuration and allocating space for the keyblob. For a hardware-backed key, use the private key handle returned by otcrypto_hw_backed_key. Otherwise, the mode should indicate Ed25519 and the keyblob should be 80 bytes. The value in the checksum field of the blinded key struct will be populated by the key generation function.
| [out] | private_key | Pointer to the blinded private key struct. |
| [out] | public_key | Pointer to the unblinded public key struct. |
| OT_WARN_UNUSED_RESULT otcrypto_status_t otcrypto_ed25519_keygen_async_finalize | ( | otcrypto_blinded_key_t * | private_key, |
| otcrypto_unblinded_key_t * | public_key | ||
| ) |
Finalizes asynchronous key generation for Ed25519.
See otcrypto_ed25519_keygen for requirements on input values.
May block until the operation is complete.
The caller should ensure that the private key configuration matches that passed to the _start function.
| [out] | private_key | Pointer to the blinded private key struct. |
| [out] | public_key | Pointer to the unblinded public key struct. |
| OT_WARN_UNUSED_RESULT otcrypto_status_t otcrypto_ed25519_keygen_async_start | ( | const otcrypto_blinded_key_t * | private_key | ) |
| OT_WARN_UNUSED_RESULT otcrypto_status_t otcrypto_ed25519_sign | ( | const otcrypto_blinded_key_t * | private_key, |
| otcrypto_const_byte_buf_t | input_message, | ||
| otcrypto_eddsa_sign_mode_t | sign_mode, | ||
| otcrypto_word32_buf_t | signature | ||
| ) |
Generates an Ed25519 digital signature.
| private_key | Pointer to the blinded private key struct. | |
| input_message | Input message to be signed. | |
| sign_mode | EdDSA signature hashing mode. | |
| [out] | signature | Pointer to the EdDSA signature with (r,s) values. |
| OT_WARN_UNUSED_RESULT otcrypto_status_t otcrypto_ed25519_sign_async_finalize | ( | otcrypto_word32_buf_t | signature | ) |
Finalizes asynchronous signature generation for Ed25519.
See otcrypto_ecdsa_p256_sign for requirements on input values.
May block until the operation is complete.
| [out] | signature | Pointer to the EdDSA signature to get (s) value. |
| OT_WARN_UNUSED_RESULT otcrypto_status_t otcrypto_ed25519_sign_async_start | ( | const otcrypto_blinded_key_t * | private_key, |
| otcrypto_const_byte_buf_t | input_message, | ||
| otcrypto_eddsa_sign_mode_t | sign_mode, | ||
| otcrypto_word32_buf_t | signature | ||
| ) |
Starts asynchronous signature generation for Ed25519.
See otcrypto_ed25519_sign for requirements on input values.
| private_key | Pointer to the blinded private key struct. | |
| input_message | Input message to be signed. | |
| sign_mode | EdDSA signature hashing mode. | |
| [out] | signature | Pointer to the EdDSA signature to get (r) value. |
| OT_WARN_UNUSED_RESULT otcrypto_status_t otcrypto_ed25519_verify | ( | const otcrypto_unblinded_key_t * | public_key, |
| otcrypto_const_byte_buf_t | input_message, | ||
| otcrypto_eddsa_sign_mode_t | sign_mode, | ||
| otcrypto_const_word32_buf_t | signature, | ||
| hardened_bool_t * | verification_result | ||
| ) |
Verifies an Ed25519 signature.
The caller must check the verification_result parameter, NOT only the returned status code, to know if the signature passed verification. The status code, as for other operations, only indicates whether errors were encountered, and may return OK even when the signature is invalid.
| public_key | Pointer to the unblinded public key struct. | |
| input_message | Input message to be signed for verification. | |
| sign_mode | EdDSA signature hashing mode. | |
| signature | Pointer to the signature to be verified. | |
| [out] | verification_result | Whether the signature passed verification. |
| OT_WARN_UNUSED_RESULT otcrypto_status_t otcrypto_ed25519_verify_async_finalize | ( | hardened_bool_t * | verification_result | ) |
Finalizes asynchronous signature verification for Ed25519.
See otcrypto_ecdsa_p256_verify for requirements on input values.
May block until the operation is complete.
The caller must check the verification_result parameter, NOT only the returned status code, to know if the signature passed verification. The status code, as for other operations, only indicates whether errors were encountered, and may return OK even when the signature is invalid.
| [out] | verification_result | Whether the signature passed verification. |
| OT_WARN_UNUSED_RESULT otcrypto_status_t otcrypto_ed25519_verify_async_start | ( | const otcrypto_unblinded_key_t * | public_key, |
| otcrypto_const_byte_buf_t | input_message, | ||
| otcrypto_eddsa_sign_mode_t | sign_mode, | ||
| otcrypto_const_word32_buf_t | signature | ||
| ) |
Starts asynchronous signature verification for Ed25519.
See otcrypto_ecdsa_p256_verify for requirements on input values.
| public_key | Pointer to the unblinded public key struct. |
| input_message | Input message to be signed for verification. |
| sign_mode | EdDSA signature hashing mode. |
| signature | Pointer to the signature to be verified. |