mirror/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2024-12-29 09:21:19 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

ECP write/export key: document that these functions don't detect unset data

Browse Source 
Fixes #8803.

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
Gilles Peskine 2024-02-19 13:56:39 +01:00
parent 1c7ff7ea53
commit 7511d4aed7
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
include/mbedtls/ecp.h
View File

@ -1339,6 +1339,10 @@ int mbedtls_ecp_read_key(mbedtls_ecp_group_id grp_id, mbedtls_ecp_keypair *key,
* See the description of the \p buflen parameter for * See the description of the \p buflen parameter for
* how to calculate the nominal length. * how to calculate the nominal length.
* *
* \note If the private key was not set in \p key,
* the output is unspecified. Future versions
* may return an error in that case.
*
* \param key The private key. * \param key The private key.
* \param buf The output buffer for containing the binary representation * \param buf The output buffer for containing the binary representation
* of the key. * of the key.
@ -1369,6 +1373,10 @@ int mbedtls_ecp_write_key(mbedtls_ecp_keypair *key,
/** /**
* \brief This function exports an elliptic curve public key. * \brief This function exports an elliptic curve public key.
* *
* \note If the public key was not set in \p key,
* the output is unspecified. Future versions
* may return an error in that case.
*
* \param key The public key. * \param key The public key.
* \param format The point format. This must be either * \param format The point format. This must be either
* #MBEDTLS_ECP_PF_COMPRESSED or #MBEDTLS_ECP_PF_UNCOMPRESSED. * #MBEDTLS_ECP_PF_COMPRESSED or #MBEDTLS_ECP_PF_UNCOMPRESSED.
@ -1451,6 +1459,10 @@ mbedtls_ecp_group_id mbedtls_ecp_keypair_get_group_id(
* Each of the output parameters can be a null pointer * Each of the output parameters can be a null pointer
* if you do not need that parameter. * if you do not need that parameter.
* *
* \note If the private key or the public key was not set in \p key,
* the corresponding output is unspecified. Future versions
* may return an error in that case.
*
* \param key The key pair to export from. * \param key The key pair to export from.
* \param grp Slot for exported ECP group. * \param grp Slot for exported ECP group.
* It must either be null or point to an initialized ECP group. * It must either be null or point to an initialized ECP group.