diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 07:33:12 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 07:33:12 +0000 |
commit | 36082a2fe36ecd800d784ae44c14f1f18c66a7e9 (patch) | |
tree | 6c68e0c0097987aff85a01dabddd34b862309a7c /doc/manpages/gnutls_dtls_cookie_verify.3 | |
parent | Initial commit. (diff) | |
download | gnutls28-upstream.tar.xz gnutls28-upstream.zip |
Adding upstream version 3.7.9.upstream/3.7.9upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/manpages/gnutls_dtls_cookie_verify.3')
-rw-r--r-- | doc/manpages/gnutls_dtls_cookie_verify.3 | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/doc/manpages/gnutls_dtls_cookie_verify.3 b/doc/manpages/gnutls_dtls_cookie_verify.3 new file mode 100644 index 0000000..fb5573d --- /dev/null +++ b/doc/manpages/gnutls_dtls_cookie_verify.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dtls_cookie_verify" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dtls_cookie_verify \- API function +.SH SYNOPSIS +.B #include <gnutls/dtls.h> +.sp +.BI "int gnutls_dtls_cookie_verify(gnutls_datum_t * " key ", void * " client_data ", size_t " client_data_size ", void * " _msg ", size_t " msg_size ", gnutls_dtls_prestate_st * " prestate ");" +.SH ARGUMENTS +.IP "gnutls_datum_t * key" 12 +is a random key to be used at cookie generation +.IP "void * client_data" 12 +contains data identifying the client (i.e. address) +.IP "size_t client_data_size" 12 +The size of client's data +.IP "void * _msg" 12 +An incoming message that initiates a connection. +.IP "size_t msg_size" 12 +The size of the message. +.IP "gnutls_dtls_prestate_st * prestate" 12 +The cookie of this client. +.SH "DESCRIPTION" +This function will verify the received message for +a valid cookie. If a valid cookie is returned then +it should be associated with the session using +\fBgnutls_dtls_prestate_set()\fP; + +This function must be called after \fBgnutls_dtls_cookie_send()\fP. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP (0) on success, or a negative error code. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP |