wolfSSL/wolfssl
1
0
Fork 1
mirror of https://github.com/wolfSSL/wolfssl.git synced 2025-08-03 12:44:45 +02:00
Code Issues Packages Projects Releases Wiki Activity

add comments to dox header file

Browse Source
This commit is contained in:
Jacob Barthelmeh
2021-06-08 01:23:53 +07:00
parent 41f3a006ac
commit 6e7c6e8a66
1 changed files with 37 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
doc/dox_comments/header_files/ssl.h
View File

@@ -568,6 +568,26 @@ WOLFSSL_API int wolfSSL_use_old_poly(WOLFSSL*, int);
WOLFSSL_API int wolfSSL_dtls_import(WOLFSSL* ssl, unsigned char* buf, WOLFSSL_API int wolfSSL_dtls_import(WOLFSSL* ssl, unsigned char* buf,
unsigned int sz); unsigned int sz);
/*!
\brief Used to import a serialized TLS session. In most cases
wolfSSL_get_session should be used instead, this function is for exporting
the state of the connection and when imported a resumption is not needed.
WARNING: buf contains sensitive information about the state and is best to
be encrypted before storing if stored.
\return the number of bytes read from buffer 'buf'
\param ssl WOLFSSL structure to import the session into
\param buf serialized session
\param sz size of buffer 'buf'
\sa wolfSSL_dtls_import
\sa wolfSSL_tls_export
*/
WOLFSSL_API int wolfSSL_tls_import(WOLFSSL* ssl, const unsigned char* buf,
unsigned int sz);
/*! /*!
\brief The wolfSSL_CTX_dtls_set_export() function is used to set \brief The wolfSSL_CTX_dtls_set_export() function is used to set
the callback function for exporting a session. It is allowed to the callback function for exporting a session. It is allowed to
@@ -680,6 +700,23 @@ WOLFSSL_API int wolfSSL_dtls_set_export(WOLFSSL* ssl, wc_dtls_export func);
WOLFSSL_API int wolfSSL_dtls_export(WOLFSSL* ssl, unsigned char* buf, WOLFSSL_API int wolfSSL_dtls_export(WOLFSSL* ssl, unsigned char* buf,
unsigned int* sz); unsigned int* sz);
/*!
\brief Used to export a serialized TLS session. In most cases
wolfSSL_set_session should be used instead, this function is for importing a
serialized state of the connection.
\return the number of bytes written into buffer 'buf'
\param ssl WOLFSSL structure to export the session from
\param buf output of serialized session
\param sz size in bytes set in 'buf'
\sa wolfSSL_dtls_import
\sa wolfSSL_tls_import
*/
WOLFSSL_API int wolfSSL_tls_export(WOLFSSL* ssl, unsigned char* buf,
unsigned int* sz);
/*! /*!
\brief This function is used to set aside static memory for a CTX. Memory \brief This function is used to set aside static memory for a CTX. Memory
set aside is then used for the CTX’s lifetime and for any SSL objects set aside is then used for the CTX’s lifetime and for any SSL objects