diff options
Diffstat (limited to 'doc/manpages/gnutls_session_set_verify_cert.3')
| -rw-r--r-- | doc/manpages/gnutls_session_set_verify_cert.3 | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/doc/manpages/gnutls_session_set_verify_cert.3 b/doc/manpages/gnutls_session_set_verify_cert.3 new file mode 100644 index 0000000..7a94c80 --- /dev/null +++ b/doc/manpages/gnutls_session_set_verify_cert.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_set_verify_cert" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_set_verify_cert \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_session_set_verify_cert(gnutls_session_t " session ", const char * " hostname ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.IP "const char * hostname" 12 +is the expected name of the peer; may be \fBNULL\fP +.IP "unsigned flags" 12 +flags for certificate verification \-\- \fBgnutls_certificate_verify_flags\fP +.SH "DESCRIPTION" +This function instructs GnuTLS to verify the peer's certificate +using the provided hostname. If the verification fails the handshake +will also fail with \fBGNUTLS_E_CERTIFICATE_VERIFICATION_ERROR\fP. In that +case the verification result can be obtained using \fBgnutls_session_get_verify_cert_status()\fP. + +The \fIhostname\fP pointer provided must remain valid for the lifetime +of the session. More precisely it should be available during any subsequent +handshakes. If no hostname is provided, no hostname verification +will be performed. For a more advanced verification function check +\fBgnutls_session_set_verify_cert2()\fP. + +If \fIflags\fP is provided which contain a profile, this function should be +called after any session priority setting functions. + +The \fBgnutls_session_set_verify_cert()\fP function is intended to be used by TLS +clients to verify the server's certificate. +.SH "SINCE" +3.4.6 +.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 |