PKCS7_verify(3ssl)

1PKCS7_verify(3)                     OpenSSL                    PKCS7_verify(3)
2
3
4

NAME

6       PKCS7_verify, PKCS7_get0_signers - verify a PKCS#7 signedData structure
7

SYNOPSIS

9        #include <openssl/pkcs7.h>
10
11        int PKCS7_verify(PKCS7 *p7, STACK_OF(X509) *certs, X509_STORE *store, BIO *indata, BIO *out, int flags);
12
13        STACK_OF(X509) *PKCS7_get0_signers(PKCS7 *p7, STACK_OF(X509) *certs, int flags);
14

DESCRIPTION

16       PKCS7_verify() verifies a PKCS#7 signedData structure. p7 is the PKCS7
17       structure to verify. certs is a set of certificates in which to search
18       for the signer's certificate. store is a trusted certficate store (used
19       for chain verification). indata is the signed data if the content is
20       not present in p7 (that is it is detached). The content is written to
21       out if it is not NULL.
22
23       flags is an optional set of flags, which can be used to modify the
24       verify operation.
25
26       PKCS7_get0_signers() retrieves the signer's certificates from p7, it
27       does not check their validity or whether any signatures are valid. The
28       certs and flags parameters have the same meanings as in PKCS7_verify().
29

VERIFY PROCESS

31       Normally the verify process proceeds as follows.
32
33       Initially some sanity checks are performed on p7. The type of p7 must
34       be signedData. There must be at least one signature on the data and if
35       the content is detached indata cannot be NULL.
36
37       An attempt is made to locate all the signer's certificates, first
38       looking in the certs parameter (if it is not NULL) and then looking in
39       any certificates contained in the p7 structure itself. If any signer's
40       certificates cannot be located the operation fails.
41
42       Each signer's certificate is chain verified using the smimesign purpose
43       and the supplied trusted certificate store. Any internal certificates
44       in the message are used as untrusted CAs. If any chain verify fails an
45       error code is returned.
46
47       Finally the signed content is read (and written to out is it is not
48       NULL) and the signature's checked.
49
50       If all signature's verify correctly then the function is successful.
51
52       Any of the following flags (ored together) can be passed in the flags
53       parameter to change the default verify behaviour. Only the flag
54       PKCS7_NOINTERN is meaningful to PKCS7_get0_signers().
55
56       If PKCS7_NOINTERN is set the certificates in the message itself are not
57       searched when locating the signer's certificate. This means that all
58       the signers certificates must be in the certs parameter.
59
60       If the PKCS7_TEXT flag is set MIME headers for type text/plain are
61       deleted from the content. If the content is not of type text/plain then
62       an error is returned.
63
64       If PKCS7_NOVERIFY is set the signer's certificates are not chain
65       verified.
66
67       If PKCS7_NOCHAIN is set then the certificates contained in the message
68       are not used as untrusted CAs. This means that the whole verify chain
69       (apart from the signer's certificate) must be contained in the trusted
70       store.
71
72       If PKCS7_NOSIGS is set then the signatures on the data are not checked.
73

NOTES

75       One application of PKCS7_NOINTERN is to only accept messages signed by
76       a small number of certificates. The acceptable certificates would be
77       passed in the certs parameter. In this case if the signer is not one of
78       the certificates supplied in certs then the verify will fail because
79       the signer cannot be found.
80
81       Care should be taken when modifying the default verify behaviour, for
82       example setting PKCS7_NOVERIFY|PKCS7_NOSIGS will totally disable all
83       verification and any signed message will be considered valid. This
84       combination is however useful if one merely wishes to write the content
85       to out and its validity is not considered important.
86
87       Chain verification should arguably be performed  using the signing time
88       rather than the current time. However since the signing time is
89       supplied by the signer it cannot be trusted without additional evidence
90       (such as a trusted timestamp).
91

RETURN VALUES

93       PKCS7_verify() returns one for a successful verification and zero if an
94       error occurs.
95
96       PKCS7_get0_signers() returns all signers or NULL if an error occurred.
97
98       The error can be obtained from ERR_get_error(3)
99

BUGS

101       The trusted certificate store is not searched for the signers
102       certificate, this is primarily due to the inadequacies of the current
103       X509_STORE functionality.
104
105       The lack of single pass processing and need to hold all data in memory
106       as mentioned in PKCS7_sign() also applies to PKCS7_verify().
107

HISTORY

112       PKCS7_verify() was added to OpenSSL 0.9.5
113
114
115
1161.0.2o                            2020-08-01                   PKCS7_verify(3)