Blame doc/manpages/gnutls_x509_trust_list_verify_crt2.3

Packit aea12f
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
Packit Service 991b93
.TH "gnutls_x509_trust_list_verify_crt2" 3 "3.6.14" "gnutls" "gnutls"
Packit aea12f
.SH NAME
Packit aea12f
gnutls_x509_trust_list_verify_crt2 \- API function
Packit aea12f
.SH SYNOPSIS
Packit aea12f
.B #include <gnutls/x509.h>
Packit aea12f
.sp
Packit aea12f
.BI "int gnutls_x509_trust_list_verify_crt2(gnutls_x509_trust_list_t " list ", gnutls_x509_crt_t * " cert_list ", unsigned int " cert_list_size ", gnutls_typed_vdata_st * " data ", unsigned int " elements ", unsigned int " flags ", unsigned int * " voutput ", gnutls_verify_output_function " func ");"
Packit aea12f
.SH ARGUMENTS
Packit aea12f
.IP "gnutls_x509_trust_list_t list" 12
Packit aea12f
The list
Packit aea12f
.IP "gnutls_x509_crt_t * cert_list" 12
Packit aea12f
is the certificate list to be verified
Packit aea12f
.IP "unsigned int cert_list_size" 12
Packit aea12f
is the certificate list size
Packit aea12f
.IP "gnutls_typed_vdata_st * data" 12
Packit aea12f
an array of typed data
Packit aea12f
.IP "unsigned int elements" 12
Packit aea12f
the number of data elements
Packit aea12f
.IP "unsigned int flags" 12
Packit aea12f
Flags that may be used to change the verification algorithm. Use OR of the gnutls_certificate_verify_flags enumerations.
Packit aea12f
.IP "unsigned int * voutput" 12
Packit aea12f
will hold the certificate verification output.
Packit aea12f
.IP "gnutls_verify_output_function func" 12
Packit aea12f
If non\-null will be called on each chain element verification with the output.
Packit aea12f
.SH "DESCRIPTION"
Packit aea12f
This function will attempt to verify the given certificate chain and return
Packit aea12f
its status. The  \fIvoutput\fP parameter will hold an OR'ed sequence of
Packit aea12f
\fBgnutls_certificate_status_t\fP flags.
Packit aea12f
Packit aea12f
When a certificate chain of  \fIcert_list_size\fP with more than one certificates is
Packit aea12f
provided, the verification status will apply to the first certificate in the chain
Packit aea12f
that failed verification. The verification process starts from the end of the chain
Packit aea12f
(from CA to end certificate). The first certificate in the chain must be the end\-certificate
Packit aea12f
while the rest of the members may be sorted or not.
Packit aea12f
Packit aea12f
Additionally a certificate verification profile can be specified
Packit aea12f
from the ones in \fBgnutls_certificate_verification_profiles_t\fP by
Packit aea12f
ORing the result of \fBGNUTLS_PROFILE_TO_VFLAGS()\fP to the verification
Packit aea12f
flags.
Packit aea12f
Packit aea12f
Additional verification parameters are possible via the  \fIdata\fP types; the
Packit aea12f
acceptable types are \fBGNUTLS_DT_DNS_HOSTNAME\fP, \fBGNUTLS_DT_IP_ADDRESS\fP and \fBGNUTLS_DT_KEY_PURPOSE_OID\fP.
Packit aea12f
The former accepts as data a null\-terminated hostname, and the latter a null\-terminated
Packit aea12f
object identifier (e.g., \fBGNUTLS_KP_TLS_WWW_SERVER\fP).
Packit aea12f
If a DNS hostname is provided then this function will compare
Packit aea12f
the hostname in the end certificate against the given. If names do not match the
Packit aea12f
\fBGNUTLS_CERT_UNEXPECTED_OWNER\fP status flag will be set. In addition it
Packit aea12f
will consider certificates provided with \fBgnutls_x509_trust_list_add_named_crt()\fP.
Packit aea12f
Packit aea12f
If a key purpose OID is provided and the end\-certificate contains the extended key
Packit aea12f
usage PKIX extension, it will be required to match the provided OID
Packit aea12f
or be marked for any purpose, otherwise verification will fail with 
Packit aea12f
\fBGNUTLS_CERT_PURPOSE_MISMATCH\fP status.
Packit aea12f
.SH "RETURNS"
Packit aea12f
On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a
Packit aea12f
negative error value. Note that verification failure will not result to an
Packit aea12f
error code, only  \fIvoutput\fP will be updated.
Packit aea12f
.SH "SINCE"
Packit aea12f
3.3.8
Packit aea12f
.SH "REPORTING BUGS"
Packit aea12f
Report bugs to <bugs@gnutls.org>.
Packit aea12f
.br
Packit aea12f
Home page: https://www.gnutls.org
Packit aea12f
Packit aea12f
.SH COPYRIGHT
Packit Service 991b93
Copyright \(co 2001- Free Software Foundation, Inc., and others.
Packit aea12f
.br
Packit aea12f
Copying and distribution of this file, with or without modification,
Packit aea12f
are permitted in any medium without royalty provided the copyright
Packit aea12f
notice and this notice are preserved.
Packit aea12f
.SH "SEE ALSO"
Packit aea12f
The full documentation for
Packit aea12f
.B gnutls
Packit aea12f
is maintained as a Texinfo manual.
Packit aea12f
If the /usr/share/doc/gnutls/
Packit aea12f
directory does not contain the HTML form visit
Packit aea12f
.B
Packit aea12f
.IP https://www.gnutls.org/manual/
Packit aea12f
.PP