mbedtls_ecp_write_key: document that this function doesn't detect uns…

…et data Fixes #8803. Signed-off-by: Gilles Peskine <[email protected]>
Mbed-TLS · Feb 26, 2024 · 7ce99c0 · 7ce99c0
1 parent e65e98a
commit 7ce99c0
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/include/mbedtls/ecp.h b/include/mbedtls/ecp.h
@@ -1295,6 +1295,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
  *                  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 buf       The output buffer for containing the binary representation
  *                  of the key.