Skip to content

Commit ab3d296

Browse files
Grolleau-BenjaminTofMassilia13320
authored andcommitted
[docs][api] add documentation for generate key behaviour
Signed-off-by: Benjamin Grolleau <benjamin.grolleau@outlook.com>
1 parent 4fff8d9 commit ab3d296

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

api/stse_asymmetric_keys_management.h

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,8 @@ stse_ReturnCode_t stse_get_ecc_key_slot_info(
7979

8080
/**
8181
* \brief Generate an ECDHE key pair
82-
* \details This API request STSE to generate an ECDHE key pair
82+
* \details This API request STSE to generate an ECDHE key pair.
83+
* If the slot is already seeded, it will be overwritten with the new key
8384
* \param[in] pSTSE Pointer to STSE Handler
8485
* \param[in] key_type Key type to generate
8586
* \param[out] pPublic_key Public key of the generated key pair
@@ -93,7 +94,8 @@ stse_ReturnCode_t stse_generate_ECDHE_key_pair(
9394

9495
/**
9596
* \brief Generate an ECC key pair
96-
* \details This API request STSE to generate an ECC key pair in the private key table
97+
* \details This API requests the STSE to generate an ECC key pair in the private key table.
98+
* If the slot is already seeded, it will be overwritten with the new key
9799
* \param[in] pSTSE Pointer to STSE Handler
98100
* \param[in] slot_number Private key table slot used to generate the key pair
99101
* \param[in] key_type Key pair type

0 commit comments

Comments
 (0)