From eaf55beeadb90016fa0d6d6676844c0cca774306 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Manuel=20P=C3=A9gouri=C3=A9-Gonnard?= Date: Wed, 23 Aug 2017 14:40:21 +0200 Subject: [PATCH] Misc documentation fixes/improvements --- include/mbedtls/ecdh.h | 6 +++++- include/mbedtls/ecdsa.h | 4 ++++ include/mbedtls/x509_crt.h | 2 +- 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/include/mbedtls/ecdh.h b/include/mbedtls/ecdh.h index 6f3fe137c..435ba00cb 100644 --- a/include/mbedtls/ecdh.h +++ b/include/mbedtls/ecdh.h @@ -40,6 +40,10 @@ typedef enum /** * \brief ECDH context structure + * + * \warning Performing multiple operations concurrently on the same + * ECDSA context is not supported; objects of this type + * should not be shared between multiple threads. */ typedef struct { @@ -159,7 +163,7 @@ int mbedtls_ecdh_read_params( mbedtls_ecdh_context *ctx, * ServerKeyEchange for static ECDH: import ECDH parameters * from a certificate's EC key information.) * - * \param ctx ECDH constext to set + * \param ctx ECDH context to set * \param key EC key to use * \param side Is it our key (1) or the peer's key (0) ? * diff --git a/include/mbedtls/ecdsa.h b/include/mbedtls/ecdsa.h index ce94af871..3440a84fe 100644 --- a/include/mbedtls/ecdsa.h +++ b/include/mbedtls/ecdsa.h @@ -52,6 +52,10 @@ extern "C" { /** * \brief ECDSA context structure + * + * \warning Performing multiple operations concurrently on the same + * ECDSA context is not supported; objects of this type + * should not be shared between multiple threads. */ typedef mbedtls_ecp_keypair mbedtls_ecdsa_context; diff --git a/include/mbedtls/x509_crt.h b/include/mbedtls/x509_crt.h index 2f652b76d..683181270 100644 --- a/include/mbedtls/x509_crt.h +++ b/include/mbedtls/x509_crt.h @@ -425,7 +425,7 @@ int mbedtls_x509_crt_verify_with_profile( mbedtls_x509_crt *crt, * \param flags result of the verification * \param f_vrfy verification function * \param p_vrfy verification parameter - * \param rs_ctx resart context + * \param rs_ctx restart context * * \return See \c mbedtls_crt_verify_with_profile(), or * MBEDTLS_ERR_ECP_IN_PROGRESS if maximum number of