Skip to content

Commit 4d96ff8

Browse files
TofMassilia13320Grom-
authored andcommitted
[api] Add EdDSA warning for few specific cryptographic library (public key concatenated to private key)
1 parent 59e82d8 commit 4d96ff8

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

api/stse_asymmetric_keys_management.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,8 @@ stse_ReturnCode_t stse_write_generic_ecc_public_key(
141141
* \param[out] pSignature Pointer to buffer containing signature
142142
* \return \ref STSE_OK on success ; \ref stse_ReturnCode_t error code otherwise
143143
* \details \include{doc} stse_write_generic_ecc_public_key.dox
144-
*/
144+
* \warning Few specific cryptographic library required to have public key concatenated to private key for EdDSA mechanism. In such case, pPrivate_key pointer shall reference concatenated key pair buffer's address.
145+
*/
145146
stse_ReturnCode_t stse_sign_for_generic_public_key_slot(
146147
stse_Handler_t *pSTSE,
147148
stse_ecc_key_type_t private_key_type,

api/stse_symmetric_keys_management.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ stse_ReturnCode_t stse_host_key_provisioning_wrapped(
8080
* \param[in] signature_private_key Private key used in authentication
8181
* \return \ref STSE_OK on success ; \ref stse_ReturnCode_t error code otherwise
8282
* \details \include{doc} stse_host_key_provisioning_wrapped_authenticated.dox
83+
* \warning Few specific cryptographic library required to have public key concatenated to private key for EdDSA mechanism. In such case, pPrivate_key pointer shall reference concatenated key pair buffer's address.
8384
*/
8485
stse_ReturnCode_t stse_host_key_provisioning_wrapped_authenticated(
8586
stse_Handler_t *pSTSE,
@@ -122,6 +123,7 @@ stse_ReturnCode_t stse_establish_host_key(
122123
* \param[in] host_cipher_key Pointer to the host cipher key buffer
123124
* \return \ref STSE_OK on success ; \ref stse_ReturnCode_t error code otherwise
124125
* \details \include{doc} stse_host_key_provisioning.dox
126+
* \warning Few specific cryptographic library required to have public key concatenated to private key for EdDSA mechanism. In such case, pPrivate_key pointer shall reference concatenated key pair buffer's address.
125127
*/
126128
stse_ReturnCode_t stse_establish_host_key_authenticated(
127129
stse_Handler_t *pSTSE,
@@ -239,6 +241,7 @@ stse_ReturnCode_t stse_write_symmetric_key_wrapped(
239241
* \param[in] signature_private_key Private key used in authentication
240242
* \return \ref STSE_OK on success ; \ref stse_ReturnCode_t error code otherwise
241243
* \details \include{doc} stse_write_symmetric_key_wrapped_authenticated.dox
244+
* \warning Few specific cryptographic library required to have public key concatenated to private key for EdDSA mechanism. In such case, pPrivate_key pointer shall reference concatenated key pair buffer's address.
242245
*/
243246
stse_ReturnCode_t stse_write_symmetric_key_wrapped_authenticated(
244247
stse_Handler_t *pSTSE,
@@ -282,6 +285,7 @@ stse_ReturnCode_t stse_establish_symmetric_key(
282285
* \param[in] private_key Authentication private key buffer
283286
* \return \ref STSE_OK on success ; \ref stse_ReturnCode_t error code otherwise
284287
* \details \include{doc} stse_establish_symmetric_key.dox
288+
* \warning Few specific cryptographic library required to have public key concatenated to private key for EdDSA mechanism. In such case, pPrivate_key pointer shall reference concatenated key pair buffer's address.
285289
*/
286290
stse_ReturnCode_t stse_establish_symmetric_key_authenticated(
287291
stse_Handler_t *pSTSE,

0 commit comments

Comments
 (0)