Blame doc/manpages/gnutls_reauth.3

Packit Service 4684c1
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
Packit Service 4684c1
.TH "gnutls_reauth" 3 "3.6.14" "gnutls" "gnutls"
Packit Service 4684c1
.SH NAME
Packit Service 4684c1
gnutls_reauth \- API function
Packit Service 4684c1
.SH SYNOPSIS
Packit Service 4684c1
.B #include <gnutls/gnutls.h>
Packit Service 4684c1
.sp
Packit Service 4684c1
.BI "int gnutls_reauth(gnutls_session_t " session ", unsigned int " flags ");"
Packit Service 4684c1
.SH ARGUMENTS
Packit Service 4684c1
.IP "gnutls_session_t session" 12
Packit Service 4684c1
is a \fBgnutls_session_t\fP type.
Packit Service 4684c1
.IP "unsigned int flags" 12
Packit Service 4684c1
must be zero
Packit Service 4684c1
.SH "DESCRIPTION"
Packit Service 4684c1
This function performs the post\-handshake authentication
Packit Service 4684c1
for TLS 1.3. The post\-handshake authentication is initiated by the server
Packit Service 4684c1
by calling this function. Clients respond when \fBGNUTLS_E_REAUTH_REQUEST\fP
Packit Service 4684c1
has been seen while receiving data.
Packit Service 4684c1
Packit Service 4684c1
The non\-fatal errors expected by this function are:
Packit Service 4684c1
\fBGNUTLS_E_INTERRUPTED\fP, \fBGNUTLS_E_AGAIN\fP, as well as
Packit Service 4684c1
\fBGNUTLS_E_GOT_APPLICATION_DATA\fP when called on server side.
Packit Service 4684c1
Packit Service 4684c1
The former two interrupt the authentication procedure due to the transport
Packit Service 4684c1
layer being interrupted, and the latter because there were pending data prior
Packit Service 4684c1
to peer initiating the re\-authentication. The server should read/process that
Packit Service 4684c1
data as unauthenticated and retry calling \fBgnutls_reauth()\fP.
Packit Service 4684c1
Packit Service 4684c1
When this function is called under TLS1.2 or earlier or the peer didn't
Packit Service 4684c1
advertise post\-handshake auth, it always fails with
Packit Service 4684c1
\fBGNUTLS_E_INVALID_REQUEST\fP. The verification of the received peers certificate
Packit Service 4684c1
is delegated to the session or credentials verification callbacks. A
Packit Service 4684c1
server can check whether post handshake authentication is supported
Packit Service 4684c1
by the client by checking the session flags with \fBgnutls_session_get_flags()\fP.
Packit Service 4684c1
Packit Service 4684c1
Prior to calling this function in server side, the function
Packit Service 4684c1
\fBgnutls_certificate_server_set_request()\fP must be called setting expectations
Packit Service 4684c1
for the received certificate (request or require). If none are set
Packit Service 4684c1
this function will return with \fBGNUTLS_E_INVALID_REQUEST\fP.
Packit Service 4684c1
Packit Service 4684c1
Note that post handshake authentication is available irrespective
Packit Service 4684c1
of the initial negotiation type (PSK or certificate). In all cases
Packit Service 4684c1
however, certificate credentials must be set to the session prior
Packit Service 4684c1
to calling this function.
Packit Service 4684c1
.SH "RETURNS"
Packit Service 4684c1
\fBGNUTLS_E_SUCCESS\fP on a successful authentication, otherwise a negative error code.
Packit Service 4684c1
.SH "REPORTING BUGS"
Packit Service 4684c1
Report bugs to <bugs@gnutls.org>.
Packit Service 4684c1
.br
Packit Service 4684c1
Home page: https://www.gnutls.org
Packit Service 4684c1
Packit Service 4684c1
.SH COPYRIGHT
Packit Service 4684c1
Copyright \(co 2001- Free Software Foundation, Inc., and others.
Packit Service 4684c1
.br
Packit Service 4684c1
Copying and distribution of this file, with or without modification,
Packit Service 4684c1
are permitted in any medium without royalty provided the copyright
Packit Service 4684c1
notice and this notice are preserved.
Packit Service 4684c1
.SH "SEE ALSO"
Packit Service 4684c1
The full documentation for
Packit Service 4684c1
.B gnutls
Packit Service 4684c1
is maintained as a Texinfo manual.
Packit Service 4684c1
If the /usr/share/doc/gnutls/
Packit Service 4684c1
directory does not contain the HTML form visit
Packit Service 4684c1
.B
Packit Service 4684c1
.IP https://www.gnutls.org/manual/
Packit Service 4684c1
.PP