Clarify that session cache query must return free-able session
Signed-off-by: Hanno Becker <hanno.becker@arm.com>
diff --git a/include/mbedtls/ssl.h b/include/mbedtls/ssl.h
index 972cac2..63417c3 100644
--- a/include/mbedtls/ssl.h
+++ b/include/mbedtls/ssl.h
@@ -639,11 +639,16 @@
* \param data The address of the session cache structure to query.
* \param session_id The buffer holding the session ID to query.
* \param session_id_len The length of \p session_id in Bytes.
- * \param session The address at which to store the session found
- * in the cache.
+ * \param session The address of the session structure to populate.
+ * It is initialized with mbdtls_ssl_session_init(),
+ * and the callback must always leave it in a state
+ * where it can savely be freed via
+ * mbedtls_ssl_session_free() independent of the
+ * return code of this function.
*
* \return \c 0 on success
* \return A non-zero return value on failure.
+ *
*/
typedef int mbedtls_ssl_cache_get_t( void *data,
unsigned char const *session_id,