diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/X509_verify_cert.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/X509_verify_cert.3 | 165 |
1 files changed, 165 insertions, 0 deletions
diff --git a/secure/lib/libcrypto/man/man3/X509_verify_cert.3 b/secure/lib/libcrypto/man/man3/X509_verify_cert.3 new file mode 100644 index 000000000000..5c34f3c38627 --- /dev/null +++ b/secure/lib/libcrypto/man/man3/X509_verify_cert.3 @@ -0,0 +1,165 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. +.ie n \{\ +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds C` +. ds C' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is >0, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.\" +.\" Avoid warning from groff about undefined register 'F'. +.de IX +.. +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} +. \} +.\} +.rr rF +.\" ======================================================================== +.\" +.IX Title "X509_VERIFY_CERT 3ossl" +.TH X509_VERIFY_CERT 3ossl 2025-09-30 3.5.4 OpenSSL +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH NAME +X509_build_chain, +X509_verify_cert, +X509_STORE_CTX_verify \- build and verify X509 certificate chain +.SH SYNOPSIS +.IX Header "SYNOPSIS" +.Vb 1 +\& #include <openssl/x509_vfy.h> +\& +\& STACK_OF(X509) *X509_build_chain(X509 *target, STACK_OF(X509) *certs, +\& X509_STORE *store, int with_self_signed, +\& OSSL_LIB_CTX *libctx, const char *propq); +\& int X509_verify_cert(X509_STORE_CTX *ctx); +\& int X509_STORE_CTX_verify(X509_STORE_CTX *ctx); +.Ve +.SH DESCRIPTION +.IX Header "DESCRIPTION" +\&\fBX509_build_chain()\fR builds a certificate chain starting from \fItarget\fR +using the optional list of intermediate CA certificates \fIcerts\fR. +If \fIstore\fR is NULL it builds the chain as far down as possible, ignoring errors. +Else the chain must reach a trust anchor contained in \fIstore\fR. +It internally uses a \fBX509_STORE_CTX\fR structure associated with the library +context \fIlibctx\fR and property query string \fIpropq\fR, both of which may be NULL. +In case there is more than one possibility for the chain, only one is taken. +.PP +On success it returns a pointer to a new stack of (up_ref'ed) certificates +starting with \fItarget\fR and followed by all available intermediate certificates. +A self-signed trust anchor is included only if \fItarget\fR is the trust anchor +of \fIwith_self_signed\fR is 1. +If a non-NULL stack is returned the caller is responsible for freeing it. +.PP +The \fBX509_verify_cert()\fR function attempts to discover and validate a +certificate chain based on parameters in \fIctx\fR. +The verification context, of type \fBX509_STORE_CTX\fR, can be constructed +using \fBX509_STORE_CTX_new\fR\|(3) and \fBX509_STORE_CTX_init\fR\|(3). +It usually includes a target certificate to be verified, +a set of certificates serving as trust anchors, +a list of non-trusted certificates that may be helpful for chain construction, +flags such as X509_V_FLAG_X509_STRICT, and various other optional components +such as a callback function that allows customizing the verification outcome. +A complete description of the certificate verification process is contained in +the \fBopenssl\-verification\-options\fR\|(1) manual page. +.PP +Applications rarely call this function directly but it is used by +OpenSSL internally for certificate validation, in both the S/MIME and +SSL/TLS code. +.PP +A negative return value from \fBX509_verify_cert()\fR can occur if it is invoked +incorrectly, such as with no certificate set in \fIctx\fR, or when it is called +twice in succession without reinitialising \fIctx\fR for the second call. +A negative return value can also happen due to internal resource problems +or because an internal inconsistency has been detected. +Applications must interpret any return value <= 0 as an error. +.PP +The \fBX509_STORE_CTX_verify()\fR behaves like \fBX509_verify_cert()\fR except that its +target certificate is the first element of the list of untrusted certificates +in \fIctx\fR unless a target certificate is set explicitly. +.PP +When the verification target is a raw public key, rather than a certificate, +both functions validate the target raw public key. +In that case the number of possible checks is significantly reduced. +The raw public key can be authenticated only via DANE TLSA records, either +locally synthesised or obtained by the application from DNS. +Raw public key DANE TLSA records may be added via \fBSSL_add_expected_rpk\fR\|(3) or +\&\fBSSL_dane_tlsa_add\fR\|(3). +.SH "RETURN VALUES" +.IX Header "RETURN VALUES" +\&\fBX509_build_chain()\fR returns NULL on error, else a stack of certificates. +.PP +Both \fBX509_verify_cert()\fR and \fBX509_STORE_CTX_verify()\fR +return 1 if a complete chain can be built and validated, +otherwise they return 0, and in exceptional circumstances (such as malloc +failure and internal errors) they can also return a negative code. +.PP +If a complete chain can be built and validated both functions return 1. +If the certificate must be rejected on the basis of the data available +or any required certificate status data is not available they return 0. +If no definite answer possible they usually return a negative code. +.PP +On error or failure additional error information can be obtained by +examining \fIctx\fR using, for example, \fBX509_STORE_CTX_get_error\fR\|(3). Even if +verification indicated success, the stored error code may be different from +X509_V_OK, likely because a verification callback function has waived the error. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fBSSL_add_expected_rpk\fR\|(3), +\&\fBSSL_CTX_dane_enable\fR\|(3), +\&\fBSSL_dane_tlsa_add\fR\|(3), +\&\fBX509_STORE_CTX_new\fR\|(3), +\&\fBX509_STORE_CTX_init\fR\|(3), +\&\fBX509_STORE_CTX_init_rpk\fR\|(3), +\&\fBX509_STORE_CTX_get_error\fR\|(3) +.SH HISTORY +.IX Header "HISTORY" +\&\fBX509_build_chain()\fR and \fBX509_STORE_CTX_verify()\fR were added in OpenSSL 3.0. +.SH COPYRIGHT +.IX Header "COPYRIGHT" +Copyright 2009\-2023 The OpenSSL Project Authors. All Rights Reserved. +.PP +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +<https://www.openssl.org/source/license.html>. |