Skip to content

Commit 774f89a

Browse files
committed
[api] Update stste_ecc.h functions parametters description
1 parent 73516f2 commit 774f89a

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

api/stse_ecc.h

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,11 @@
5050
* \param[in] message_length Message length
5151
* \param[in] eddsa_variant Flag indicating a pre-hashed EdDSA (1) message or a pure EdDSA (0) plaintext message. Used only in case of Edwards25519 public key
5252
* \param[out] pSignature_validity Signature validity flag (1 = valid signature, invalid otherwise)
53-
* \return \ref STSE_OK on success ; \ref stse_ReturnCode_t error code otherwise
53+
* \return \ref STSE_OK on success ; \ref stse_ReturnCode_t error code otherwise
54+
*
55+
* \note The expected signature format is the concatenation of R and S values (R|S as defined in ASN.1 DER encoding).
56+
The public key format must match the expected ECC representation (typically concatenation of X and Y coordinates for uncompressed, or X with a prefix for compressed)
57+
*
5458
* \details \include{doc} stse_ecc_verify_signature.dox
5559
*/
5660
stse_ReturnCode_t stse_ecc_verify_signature(
@@ -68,11 +72,14 @@ stse_ReturnCode_t stse_ecc_verify_signature(
6872
* \details This API use the STSE to sign a message using a key in the requested slot
6973
* \param[in] pSTSE Pointer to STSE Handler
7074
* \param[in] slot_number Signature key slot
71-
* \param[in] key_type Signature key type
72-
* \param[in] pMessage Message to sign
73-
* \param[in] message_length Message length
74-
* \param[out] pSignature Signature buffer
75-
* \return \ref STSE_OK on success ; \ref stse_ReturnCode_t error code otherwise
75+
* \param[in] key_type Signature key type
76+
* \param[in] pMessage Message to sign
77+
* \param[in] message_length Message length
78+
* \param[out] pSignature Signature buffer (concatenation of R and S)
79+
* \return \ref STSE_OK on success ; \ref stse_ReturnCode_t error code otherwise
80+
*
81+
* \note The signature output is the concatenation of R and S values (R|S as defined in ASN.1 DER encoding).
82+
*
7683
* \details \include{doc} stse_ecc_generate_signature.dox
7784
*/
7885
stse_ReturnCode_t stse_ecc_generate_signature(
@@ -92,7 +99,10 @@ stse_ReturnCode_t stse_ecc_generate_signature(
9299
* \param[in] pPublic_key Remote public key
93100
* \param[out] pShared_secret Shared secret returned by the STSE
94101
* \return \ref STSE_OK on success ; \ref stse_ReturnCode_t error code otherwise
102+
*
95103
* \details \include{doc} stse_ecc_establish_shared_secret.dox
104+
*
105+
* \note The public key format must match the expected ECC representation (typically concatenation of X and Y coordinates for uncompressed, or X with a prefix for compressed).
96106
*/
97107
stse_ReturnCode_t stse_ecc_establish_shared_secret(
98108
stse_Handler_t *pSTSE,

0 commit comments

Comments
 (0)