gnutls_certificate_verify_peers3(3) — Linux manual page
gnutls_certif...verify_peers3(3) gnutls gnutls_certif...verify_peers3(3)
NAME
gnutls_certificate_verify_peers3 - API function
SYNOPSIS
#include <gnutls/gnutls.h>
int gnutls_certificate_verify_peers3(gnutls_session_t session,
const char * hostname, unsigned int * status);
ARGUMENTS
gnutls_session_t session
is a gnutls session
const char * hostname
is the expected name of the peer; may be NULL
unsigned int * status
is the output of the verification
DESCRIPTION
This function will verify the peer's certificate and store the
the status in the status variable as a bitwise OR of
gnutls_certificate_status_t values or zero if the certificate is
trusted. Note that value in status is set only when the return
value of this function is success (i.e, failure to trust a
certificate does not imply a negative return value). The default
verification flags used by this function can be overridden using
gnutls_certificate_set_verify_flags(). See the documentation of
gnutls_certificate_verify_peers2() for details in the
verification process.
This function will take into account the stapled OCSP responses
sent by the server, as well as the following X.509 certificate
extensions: Name Constraints, Key Usage, and Basic Constraints
(pathlen).
If the hostname provided is non-NULL then this function will
compare the hostname in the certificate against it. The
comparison will follow the RFC6125 recommendations. If names do
not match the GNUTLS_CERT_UNEXPECTED_OWNER status flag will be
set.
In order to verify the purpose of the end-certificate (by
checking the extended key usage), use
gnutls_certificate_verify_peers().
To avoid denial of service attacks some default upper limits
regarding the certificate key size and chain size are set. To
override them use gnutls_certificate_set_verify_limits().
Note that when using raw public-keys verification will not work
because there is no corresponding certificate body belonging to
the raw key that can be verified. In that case this function will
return GNUTLS_E_INVALID_REQUEST.
RETURNS
GNUTLS_E_SUCCESS (0) when the validation is performed, or a
negative error code otherwise. A successful error code means
that the status parameter must be checked to obtain the
validation status.
SINCE
3.1.4
REPORTING BUGS
Report bugs to <bugs@gnutls.org>.
Home page: https://www.gnutls.org
COPYRIGHT
Copyright © 2001-2023 Free Software Foundation, Inc., and others.
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.
SEE ALSO
The full documentation for gnutls is maintained as a Texinfo
manual. If the /usr/share/doc/gnutls/ directory does not contain
the HTML form visit
https://www.gnutls.org/manual/
COLOPHON
This page is part of the GnuTLS (GnuTLS Transport Layer Security
Library) project. Information about the project can be found at
⟨http://www.gnutls.org/⟩. If you have a bug report for this
manual page, send it to bugs@gnutls.org. This page was obtained
from the tarball gnutls-3.8.5.tar.xz fetched from
⟨http://www.gnutls.org/download.html⟩ on 2024-06-14. If you
discover any rendering problems in this HTML version of the page,
or you believe there is a better or more up-to-date source for
the page, or you have corrections or improvements to the
information in this COLOPHON (which is not part of the original
manual page), send a mail to man-pages@man7.org