299 lines
12 KiB
Plaintext
299 lines
12 KiB
Plaintext
.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
|
|
.\"
|
|
.\" 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
|
|
..
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
|
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
|
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
|
.\" nothing in troff, for use with C<>.
|
|
.tr \(*W-
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. ds -- \(*W-
|
|
. ds PI pi
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
. ds L" ""
|
|
. ds R" ""
|
|
. ds C` ""
|
|
. ds C' ""
|
|
'br\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
. 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 turned on, 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
|
|
.\"
|
|
.\" 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 \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
.\}
|
|
. \" troff and (daisy-wheel) nroff accents
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. ds : e
|
|
. ds 8 ss
|
|
. ds o a
|
|
. ds d- d\h'-1'\(ga
|
|
. ds D- D\h'-1'\(hy
|
|
. ds th \o'bp'
|
|
. ds Th \o'LP'
|
|
. ds ae ae
|
|
. ds Ae AE
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "CMS_VERIFY 3ossl"
|
|
.TH CMS_VERIFY 3ossl "2024-01-30" "3.2.1" "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"
|
|
CMS_verify, CMS_SignedData_verify,
|
|
CMS_get0_signers \- verify a CMS SignedData structure
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/cms.h>
|
|
\&
|
|
\& int CMS_verify(CMS_ContentInfo *cms, STACK_OF(X509) *certs, X509_STORE *store,
|
|
\& BIO *detached_data, BIO *out, unsigned int flags);
|
|
\& BIO *CMS_SignedData_verify(CMS_SignedData *sd, BIO *detached_data,
|
|
\& STACK_OF(X509) *scerts, X509_STORE *store,
|
|
\& STACK_OF(X509) *extra, STACK_OF(X509_CRL) *crls,
|
|
\& unsigned int flags,
|
|
\& OSSL_LIB_CTX *libctx, const char *propq);
|
|
\&
|
|
\& STACK_OF(X509) *CMS_get0_signers(CMS_ContentInfo *cms);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
\&\fICMS_verify()\fR is very similar to \fIPKCS7_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.
|
|
\&\fIdetached_data\fR refers to the signed data if the content is detached from \fIcms\fR.
|
|
Otherwise \fIdetached_data\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
|
|
\&\fICMS_SignedData_verify()\fR is like \fICMS_verify()\fR except that
|
|
it operates on \fB\s-1CMS\s0 SignedData\fR input in the \fIsd\fR argument,
|
|
it has some additional parameters described next,
|
|
and on success it returns the verified content as a memory \s-1BIO.\s0
|
|
The optional \fIextra\fR parameter may be used to provide untrusted \s-1CA\s0
|
|
certificates that may be helpful for chain building in certificate validation.
|
|
This list of certificates must not contain duplicates.
|
|
The optional \fIcrls\fR parameter may be used to provide extra CRLs.
|
|
Also the list of CRLs must not contain duplicates.
|
|
The optional parameters library context \fIlibctx\fR and property query \fIpropq\fR
|
|
are used when retrieving algorithms from providers.
|
|
.PP
|
|
\&\fICMS_get0_signers()\fR retrieves the signing certificate(s) from \fIcms\fR; it may only
|
|
be called after a successful \fICMS_verify()\fR or \fICMS_SignedData_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 \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 \fIdetached_data\fR cannot be \s-1NULL.\s0
|
|
.PP
|
|
An attempt is made to locate all the signing certificate(s), first looking in
|
|
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 \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
|
|
\&\fICMS_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 \fICMS_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 \fIout\fR unless it is \s-1NULL\s0)
|
|
and the signature is checked.
|
|
.PP
|
|
If all signatures verify correctly then the function is successful.
|
|
.PP
|
|
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 \fIcerts\fR parameter.
|
|
.PP
|
|
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 and provided via the \fIcrls\fR parameter are ignored.
|
|
.PP
|
|
If the \fB\s-1CMS_TEXT\s0\fR flag is set \s-1MIME\s0 headers for type \f(CW\*(C`text/plain\*(C'\fR are deleted
|
|
from the content. If the content is not of type \f(CW\*(C`text/plain\*(C'\fR then an error is
|
|
returned.
|
|
.PP
|
|
If \fB\s-1CMS_NO_SIGNER_CERT_VERIFY\s0\fR is set the signing certificates are not
|
|
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, 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 \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 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 \fIout\fR and its validity
|
|
is not considered important.
|
|
.PP
|
|
Chain verification should arguably be performed using the signing time rather
|
|
than the current time. However, since the signing time is supplied by the
|
|
signer it cannot be trusted without additional evidence (such as a trusted
|
|
timestamp).
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
\&\fICMS_verify()\fR returns 1 for a successful verification and 0 if an error occurred.
|
|
.PP
|
|
\&\fICMS_SignedData_verify()\fR returns a memory \s-1BIO\s0 containing the verified content,
|
|
or \s-1NULL\s0 on error.
|
|
.PP
|
|
\&\fICMS_get0_signers()\fR returns all signers or \s-1NULL\s0 if an error occurred.
|
|
.PP
|
|
The error can be obtained from \fIERR_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
|
|
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"
|
|
\&\fIPKCS7_verify\fR\|(3), \fICMS_add1_cert\fR\|(3), \fICMS_add1_crl\fR\|(3),
|
|
\&\fIOSSL_ESS_check_signing_certs\fR\|(3),
|
|
\&\fIERR_get_error\fR\|(3), \fICMS_sign\fR\|(3)
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
\&\fICMS_SignedData_verify()\fR was added in OpenSSL 3.2.
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2008\-2023 The OpenSSL Project Authors. All Rights Reserved.
|
|
.PP
|
|
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>.
|