commit b1895899f1d4aea2b25b7981f73b0736d592e0f4
author Pengyu Lv <pengyu.lv@arm.com> Thu Mar 16 11:38:43 2023 +0800
committer Pengyu Lv <pengyu.lv@arm.com> Thu Mar 16 14:33:28 2023 +0800
tree 4afd8e336c5b604d6f40c85def6fb124ed0837de
parent db47f2fbd4e12eb83e843b0146e466d209dae9c3

ssl_cache: Improve some comments

Signed-off-by: Pengyu Lv <pengyu.lv@arm.com>

include/mbedtls/ssl_cache.h

diff --git a/include/mbedtls/ssl_cache.h b/include/mbedtls/ssl_cache.h
index 55dcf77..1eb933c 100644
--- a/include/mbedtls/ssl_cache.h
+++ b/include/mbedtls/ssl_cache.h
@@ -132,9 +132,9 @@
  *                        associated to \p session.
  * \param session_id_len  The length of \p session_id in bytes.
  *
- * \return                0: The cache entry for session with provided ID
+ * \return                \c 0: The cache entry for session with provided ID
  *                           is removed or does not exist.
- *                        Otherwise: fail.
+ *                        A negative error code on failure.
  */
 int mbedtls_ssl_cache_remove(void *data,
                              unsigned char const *session_id,

library/ssl_cache.c

diff --git a/library/ssl_cache.c b/library/ssl_cache.c
index 048c21d..1c649ca 100644
--- a/library/ssl_cache.c
+++ b/library/ssl_cache.c
@@ -29,6 +29,7 @@
 
 #include "mbedtls/ssl_cache.h"
 #include "ssl_misc.h"
+#include "mbedtls/error.h"
 
 #include <string.h>
 
@@ -335,7 +336,7 @@
                              unsigned char const *session_id,
                              size_t session_id_len)
 {
-    int ret = 1;
+    int ret = MBEDTLS_ERR_ERROR_GENERIC_ERROR;
     mbedtls_ssl_cache_context *cache = (mbedtls_ssl_cache_context *) data;
     mbedtls_ssl_cache_entry *entry;
     mbedtls_ssl_cache_entry *prev;

programs/ssl/ssl_server2.c

diff --git a/programs/ssl/ssl_server2.c b/programs/ssl/ssl_server2.c
index 8277dde..d68f002 100644
--- a/programs/ssl/ssl_server2.c
+++ b/programs/ssl/ssl_server2.c
@@ -669,7 +669,7 @@
 #if defined(MBEDTLS_HAVE_TIME)
     int cache_timeout;          /* expiration delay of session cache entries*/
 #endif
-    int cache_remove;           /* enable / disable cache removement        */
+    int cache_remove;           /* enable / disable cache entry removal     */
     char *sni;                  /* string describing sni information        */
     const char *curves;         /* list of supported elliptic curves        */
     const char *sig_algs;       /* supported TLS 1.3 signature algorithms   */