aboutsummaryrefslogtreecommitdiff
path: root/secure/lib/libcrypto/man/man3/CMS_verify.3
diff options
context:
space:
mode:
Diffstat (limited to 'secure/lib/libcrypto/man/man3/CMS_verify.3')
-rw-r--r--secure/lib/libcrypto/man/man3/CMS_verify.397
1 files changed, 54 insertions, 43 deletions
diff --git a/secure/lib/libcrypto/man/man3/CMS_verify.3 b/secure/lib/libcrypto/man/man3/CMS_verify.3
index c1e5ce44d13b..7ec416584bf3 100644
--- a/secure/lib/libcrypto/man/man3/CMS_verify.3
+++ b/secure/lib/libcrypto/man/man3/CMS_verify.3
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
+.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
@@ -68,8 +68,6 @@
. \}
.\}
.rr rF
-.\"
-.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
@@ -132,8 +130,8 @@
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
-.IX Title "CMS_VERIFY 3"
-.TH CMS_VERIFY 3 "2022-07-05" "1.1.1q" "OpenSSL"
+.IX Title "CMS_VERIFY 3ossl"
+.TH CMS_VERIFY 3ossl "2023-09-19" "3.0.11" "OpenSSL"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -152,49 +150,57 @@ CMS_verify, CMS_get0_signers \- verify a CMS SignedData structure
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
-\&\fBCMS_verify()\fR verifies a \s-1CMS\s0 SignedData structure. \fBcms\fR is the CMS_ContentInfo
-structure to verify. \fBcerts\fR is a set of certificates in which to search for
-the signing certificate(s). \fBstore\fR is a trusted certificate store used for
-chain verification. \fBindata\fR is the detached content if the content is not
-present in \fBcms\fR. The content is written to \fBout\fR if it is not \s-1NULL.\s0
-.PP
-\&\fBflags\fR is an optional set of flags, which can be used to modify the verify
-operation.
+\&\fBCMS_verify()\fR is very similar to \fBPKCS7_verify\fR\|(3). It verifies a
+\&\fB\s-1CMS\s0 SignedData\fR structure contained in a structure of type \fBCMS_ContentInfo\fR.
+\&\fIcms\fR points to the \fBCMS_ContentInfo\fR structure to verify.
+The optional \fIcerts\fR parameter refers to a set of certificates
+in which to search for signing certificates.
+\&\fIcms\fR may contain extra untrusted \s-1CA\s0 certificates that may be used for
+chain building as well as CRLs that may be used for certificate validation.
+\&\fIstore\fR may be \s-1NULL\s0 or point to
+the trusted certificate store to use for chain verification.
+\&\fIindata\fR refers to the signed data if the content is detached from \fIcms\fR.
+Otherwise \fIindata\fR should be \s-1NULL\s0 and the signed data must be in \fIcms\fR.
+The content is written to the \s-1BIO\s0 \fIout\fR unless it is \s-1NULL.\s0
+\&\fIflags\fR is an optional set of flags, which can be used to modify the operation.
.PP
-\&\fBCMS_get0_signers()\fR retrieves the signing certificate(s) from \fBcms\fR, it may only
+\&\fBCMS_get0_signers()\fR retrieves the signing certificate(s) from \fIcms\fR, it may only
be called after a successful \fBCMS_verify()\fR operation.
.SH "VERIFY PROCESS"
.IX Header "VERIFY PROCESS"
Normally the verify process proceeds as follows.
.PP
-Initially some sanity checks are performed on \fBcms\fR. The type of \fBcms\fR must
+Initially some sanity checks are performed on \fIcms\fR. The type of \fIcms\fR must
be SignedData. There must be at least one signature on the data and if
-the content is detached \fBindata\fR cannot be \fB\s-1NULL\s0\fR.
+the content is detached \fIindata\fR cannot be \s-1NULL.\s0
.PP
An attempt is made to locate all the signing certificate(s), first looking in
-the \fBcerts\fR parameter (if it is not \s-1NULL\s0) and then looking in any
-certificates contained in the \fBcms\fR structure itself. If any signing
-certificate cannot be located the operation fails.
+the \fIcerts\fR parameter (if it is not \s-1NULL\s0) and then looking in any
+certificates contained in the \fIcms\fR structure unless \fB\s-1CMS_NOINTERN\s0\fR is set.
+If any signing certificate cannot be located the operation fails.
.PP
-Each signing certificate is chain verified using the \fBsmimesign\fR purpose and
-the supplied trusted certificate store. Any internal certificates in the message
-are used as untrusted CAs. If \s-1CRL\s0 checking is enabled in \fBstore\fR any internal
-CRLs are used in addition to attempting to look them up in \fBstore\fR. If any
-chain verify fails an error code is returned.
+Each signing certificate is chain verified using the \fIsmimesign\fR purpose and
+using the trusted certificate store \fIstore\fR if supplied.
+Any internal certificates in the message, which may have been added using
+\&\fBCMS_add1_cert\fR\|(3), are used as untrusted CAs.
+If \s-1CRL\s0 checking is enabled in \fIstore\fR and \fB\s-1CMS_NOCRL\s0\fR is not set,
+any internal CRLs, which may have been added using \fBCMS_add1_crl\fR\|(3),
+are used in addition to attempting to look them up in \fIstore\fR.
+If \fIstore\fR is not \s-1NULL\s0 and any chain verify fails an error code is returned.
.PP
-Finally the signed content is read (and written to \fBout\fR if it is not \s-1NULL\s0)
-and the signature's checked.
+Finally the signed content is read (and written to \fIout\fR unless it is \s-1NULL\s0)
+and the signature is checked.
.PP
-If all signature's verify correctly then the function is successful.
+If all signatures verify correctly then the function is successful.
.PP
-Any of the following flags (ored together) can be passed in the \fBflags\fR
+Any of the following flags (ored together) can be passed in the \fIflags\fR
parameter to change the default verify behaviour.
.PP
If \fB\s-1CMS_NOINTERN\s0\fR is set the certificates in the message itself are not
-searched when locating the signing certificate(s). This means that all the
-signing certificates must be in the \fBcerts\fR parameter.
+searched when locating the signing certificate(s).
+This means that all the signing certificates must be in the \fIcerts\fR parameter.
.PP
-If \fB\s-1CMS_NOCRL\s0\fR is set and \s-1CRL\s0 checking is enabled in \fBstore\fR then any
+If \fB\s-1CMS_NOCRL\s0\fR is set and \s-1CRL\s0 checking is enabled in \fIstore\fR then any
CRLs in the message itself are ignored.
.PP
If the \fB\s-1CMS_TEXT\s0\fR flag is set \s-1MIME\s0 headers for type \fBtext/plain\fR are deleted
@@ -202,30 +208,34 @@ from the content. If the content is not of type \fBtext/plain\fR then an error i
returned.
.PP
If \fB\s-1CMS_NO_SIGNER_CERT_VERIFY\s0\fR is set the signing certificates are not
-verified.
+chain verified, unless \fB\s-1CMS_CADES\s0\fR flag is also set.
.PP
If \fB\s-1CMS_NO_ATTR_VERIFY\s0\fR is set the signed attributes signature is not
-verified.
+verified, unless \s-1CMS_CADES\s0 flag is also set.
+.PP
+If \fB\s-1CMS_CADES\s0\fR is set, each signer certificate is checked against the
+\&\s-1ESS\s0 signingCertificate or \s-1ESS\s0 signingCertificateV2 extension
+that is required in the signed attributes of the signature.
.PP
If \fB\s-1CMS_NO_CONTENT_VERIFY\s0\fR is set then the content digest is not checked.
.SH "NOTES"
.IX Header "NOTES"
One application of \fB\s-1CMS_NOINTERN\s0\fR is to only accept messages signed by
a small number of certificates. The acceptable certificates would be passed
-in the \fBcerts\fR parameter. In this case if the signer is not one of the
-certificates supplied in \fBcerts\fR then the verify will fail because the
+in the \fIcerts\fR parameter. In this case if the signer certificate is not one
+of the certificates supplied in \fIcerts\fR then the verify will fail because the
signer cannot be found.
.PP
In some cases the standard techniques for looking up and validating
certificates are not appropriate: for example an application may wish to
lookup certificates in a database or perform customised verification. This
-can be achieved by setting and verifying the signers certificates manually
+can be achieved by setting and verifying the signer certificates manually
using the signed data utility functions.
.PP
Care should be taken when modifying the default verify behaviour, for example
setting \fB\s-1CMS_NO_CONTENT_VERIFY\s0\fR will totally disable all content verification
and any modified content will be considered valid. This combination is however
-useful if one merely wishes to write the content to \fBout\fR and its validity
+useful if one merely wishes to write the content to \fIout\fR and its validity
is not considered important.
.PP
Chain verification should arguably be performed using the signing time rather
@@ -234,28 +244,29 @@ signer it cannot be trusted without additional evidence (such as a trusted
timestamp).
.SH "RETURN VALUES"
.IX Header "RETURN VALUES"
-\&\fBCMS_verify()\fR returns 1 for a successful verification and zero if an error
-occurred.
+\&\fBCMS_verify()\fR returns 1 for a successful verification and 0 if an error occurred.
.PP
\&\fBCMS_get0_signers()\fR returns all signers or \s-1NULL\s0 if an error occurred.
.PP
The error can be obtained from \fBERR_get_error\fR\|(3)
.SH "BUGS"
.IX Header "BUGS"
-The trusted certificate store is not searched for the signing certificate,
-this is primarily due to the inadequacies of the current \fBX509_STORE\fR
+The trusted certificate store is not searched for the signing certificate.
+This is primarily due to the inadequacies of the current \fBX509_STORE\fR
functionality.
.PP
The lack of single pass processing means that the signed content must all
be held in memory if it is not detached.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
+\&\fBPKCS7_verify\fR\|(3), \fBCMS_add1_cert\fR\|(3), \fBCMS_add1_crl\fR\|(3),
+\&\fBOSSL_ESS_check_signing_certs\fR\|(3),
\&\fBERR_get_error\fR\|(3), \fBCMS_sign\fR\|(3)
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
-Copyright 2008\-2020 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2008\-2022 The OpenSSL Project Authors. All Rights Reserved.
.PP
-Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
+Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file \s-1LICENSE\s0 in the source distribution or at
<https://www.openssl.org/source/license.html>.