diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/PKCS7_verify.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/PKCS7_verify.3 | 114 |
1 files changed, 62 insertions, 52 deletions
diff --git a/secure/lib/libcrypto/man/man3/PKCS7_verify.3 b/secure/lib/libcrypto/man/man3/PKCS7_verify.3 index fbc4650be7a8..7e5140fd7bb5 100644 --- a/secure/lib/libcrypto/man/man3/PKCS7_verify.3 +++ b/secure/lib/libcrypto/man/man3/PKCS7_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 "PKCS7_VERIFY 3" -.TH PKCS7_VERIFY 3 "2022-06-21" "1.1.1p" "OpenSSL" +.IX Title "PKCS7_VERIFY 3ossl" +.TH PKCS7_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,107 +150,119 @@ PKCS7_verify, PKCS7_get0_signers \- verify a PKCS#7 signedData structure .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" -\&\fBPKCS7_verify()\fR verifies a PKCS#7 signedData structure. \fBp7\fR is the \s-1PKCS7\s0 -structure to verify. \fBcerts\fR is a set of certificates in which to search for -the signer's certificate. \fBstore\fR is a trusted certificate store (used for -chain verification). \fBindata\fR is the signed data if the content is not -present in \fBp7\fR (that is it is detached). 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. +\&\fBPKCS7_verify()\fR is very similar to \fBCMS_verify\fR\|(3). +It verifies a PKCS#7 signedData structure given in \fIp7\fR. +The optional \fIcerts\fR parameter refers to a set of certificates +in which to search for signer's certificates. +\&\fIp7\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 \fIp7\fR. +Otherwise \fIindata\fR should be \s-1NULL,\s0 and then the signed data must be in \fIp7\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 -\&\fBPKCS7_get0_signers()\fR retrieves the signer's certificates from \fBp7\fR, it does -\&\fBnot\fR check their validity or whether any signatures are valid. The \fBcerts\fR -and \fBflags\fR parameters have the same meanings as in \fBPKCS7_verify()\fR. +\&\fBPKCS7_get0_signers()\fR retrieves the signer's certificates from \fIp7\fR, it does +\&\fBnot\fR check their validity or whether any signatures are valid. The \fIcerts\fR +and \fIflags\fR parameters have the same meanings as in \fBPKCS7_verify()\fR. .SH "VERIFY PROCESS" .IX Header "VERIFY PROCESS" Normally the verify process proceeds as follows. .PP -Initially some sanity checks are performed on \fBp7\fR. The type of \fBp7\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. If the content is -not detached and \fBindata\fR is not \fB\s-1NULL\s0\fR, then the structure has both +Initially some sanity checks are performed on \fIp7\fR. The type of \fIp7\fR must +be SignedData. There must be at least one signature on the data and if +the content is detached \fIindata\fR cannot be \s-1NULL.\s0 If the content is +not detached and \fIindata\fR is not \s-1NULL\s0 then the structure has both embedded and external content. To treat this as an error, use the flag \&\fB\s-1PKCS7_NO_DUAL_CONTENT\s0\fR. The default behavior allows this, for compatibility with older versions of OpenSSL. .PP An attempt is made to locate all the signer's certificates, first looking in -the \fBcerts\fR parameter (if it is not \fB\s-1NULL\s0\fR) and then looking in any certificates -contained in the \fBp7\fR structure itself. If any signer's certificates cannot be -located the operation fails. +the \fIcerts\fR parameter (if it is not \s-1NULL\s0). Then they are looked up in any +certificates contained in the \fIp7\fR structure unless \fB\s-1PKCS7_NOINTERN\s0\fR is set. +If any signer's certificates cannot be located the operation fails. .PP Each signer's 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 any chain verify fails an error code is returned. +using the trusted certificate store \fIstore\fR if supplied. +Any internal certificates in the message, which may have been added using +\&\fBPKCS7_add_certificate\fR\|(3), are used as untrusted CAs unless \fB\s-1PKCS7_NOCHAIN\s0\fR +is set. +If \s-1CRL\s0 checking is enabled in \fIstore\fR and \fB\s-1PKCS7_NOCRL\s0\fR is not set, +any internal CRLs, which may have been added using \fBPKCS7_add_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 is 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 parameter -to change the default verify behaviour. Only the flag \fB\s-1PKCS7_NOINTERN\s0\fR is -meaningful to \fBPKCS7_get0_signers()\fR. +Any of the following flags (ored together) can be passed in the \fIflags\fR +parameter to change the default verify behaviour. +Only the flag \fB\s-1PKCS7_NOINTERN\s0\fR is meaningful to \fBPKCS7_get0_signers()\fR. .PP If \fB\s-1PKCS7_NOINTERN\s0\fR is set the certificates in the message itself are not -searched when locating the signer's certificate. This means that all the signers -certificates must be in the \fBcerts\fR parameter. +searched when locating the signer's certificates. +This means that all the signer's certificates must be in the \fIcerts\fR parameter. +.PP +If \fB\s-1PKCS7_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-1PKCS7_TEXT\s0\fR flag is set \s-1MIME\s0 headers for type \fBtext/plain\fR are deleted -from the content. If the content is not of type \fBtext/plain\fR then an error is +If the \fB\s-1PKCS7_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-1PKCS7_NOVERIFY\s0\fR is set the signer's certificates are not chain verified. .PP If \fB\s-1PKCS7_NOCHAIN\s0\fR is set then the certificates contained in the message are not used as untrusted CAs. This means that the whole verify chain (apart from -the signer's certificate) must be contained in the trusted store. +the signer's certificates) must be contained in the trusted store. .PP If \fB\s-1PKCS7_NOSIGS\s0\fR is set then the signatures on the data are not checked. .SH "NOTES" .IX Header "NOTES" One application of \fB\s-1PKCS7_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's certificate is not one +of the certificates supplied in \fIcerts\fR then the verify will fail because the signer cannot be found. .PP Care should be taken when modifying the default verify behaviour, for example -setting \fBPKCS7_NOVERIFY|PKCS7_NOSIGS\fR will totally disable all verification +setting \f(CW\*(C`PKCS7_NOVERIFY|PKCS7_NOSIGS\*(C'\fR will totally disable all verification and any signed message 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 +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" -\&\fBPKCS7_verify()\fR returns one for a successful verification and zero -if an error occurs. +\&\fBPKCS7_verify()\fR returns 1 for a successful verification and 0 if an error occurs. .PP -\&\fBPKCS7_get0_signers()\fR returns all signers or \fB\s-1NULL\s0\fR if an error occurred. +\&\fBPKCS7_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) +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 signers certificate, -this is primarily due to the inadequacies of the current \fBX509_STORE\fR +The trusted certificate store is not searched for the signer's certificates. +This is primarily due to the inadequacies of the current \fBX509_STORE\fR functionality. .PP -The lack of single pass processing and need to hold all data in memory as -mentioned in \fBPKCS7_sign()\fR also applies to \fBPKCS7_verify()\fR. +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" +\&\fBCMS_verify\fR\|(3), \fBPKCS7_add_certificate\fR\|(3), \fBPKCS7_add_crl\fR\|(3), \&\fBERR_get_error\fR\|(3), \fBPKCS7_sign\fR\|(3) .SH "COPYRIGHT" .IX Header "COPYRIGHT" -Copyright 2002\-2020 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2002\-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>. |