doc/man3/PKCS7_verify.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 PKCS7_verify, PKCS7_get0_signers - verify a PKCS#7 signedData structure
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/pkcs7.h>
  10
  11  int PKCS7_verify(PKCS7 *p7, STACK_OF(X509) *certs, X509_STORE *store,
  12                   BIO *indata, BIO *out, int flags);
  13
  14  STACK_OF(X509) *PKCS7_get0_signers(PKCS7 *p7, STACK_OF(X509) *certs, int flags);
  15
  16 =head1 DESCRIPTION
  17
  18 PKCS7_verify() is very similar to L<CMS_verify(3)>.
  19 It verifies a PKCS#7 signedData structure given in I<p7>.
  20 The optional I<certs> parameter refers to a set of certificates
  21 in which to search for signer's certificates.
  22 I<p7> may contain extra untrusted CA certificates that may be used for
  23 chain building as well as CRLs that may be used for certificate validation.
  24 I<store> may be NULL or point to
  25 the trusted certificate store to use for chain verification.
  26 I<indata> refers to the signed data if the content is detached from I<p7>.
  27 Otherwise I<indata> should be NULL, and then the signed data must be in I<p7>.
  28 The content is written to the BIO I<out> unless it is NULL.
  29 I<flags> is an optional set of flags, which can be used to modify the operation.
  30
  31 PKCS7_get0_signers() retrieves the signer's certificates from I<p7>, it does
  32 B<not> check their validity or whether any signatures are valid. The I<certs>
  33 and I<flags> parameters have the same meanings as in PKCS7_verify().
  34
  35 =head1 VERIFY PROCESS
  36
  37 Normally the verify process proceeds as follows.
  38
  39 Initially some sanity checks are performed on I<p7>. The type of I<p7> must
  40 be SignedData. There must be at least one signature on the data and if
  41 the content is detached I<indata> cannot be NULL.  If the content is
  42 not detached and I<indata> is not NULL then the structure has both
  43 embedded and external content. To treat this as an error, use the flag
  44 B<PKCS7_NO_DUAL_CONTENT>.
  45 The default behavior allows this, for compatibility with older
  46 versions of OpenSSL.
  47
  48 An attempt is made to locate all the signer's certificates, first looking in
  49 the I<certs> parameter (if it is not NULL). Then they are looked up in any
  50 certificates contained in the I<p7> structure unless B<PKCS7_NOINTERN> is set.
  51 If any signer's certificates cannot be located the operation fails.
  52
  53 Each signer's certificate is chain verified using the B<smimesign> purpose and
  54 using the trusted certificate store I<store> if supplied.
  55 Any internal certificates in the message, which may have been added using
  56 L<PKCS7_add_certificate(3)>, are used as untrusted CAs unless B<PKCS7_NOCHAIN>
  57 is set.
  58 If CRL checking is enabled in I<store> and B<PKCS7_NOCRL> is not set,
  59 any internal CRLs, which may have been added using L<PKCS7_add_crl(3)>,
  60 are used in addition to attempting to look them up in I<store>.
  61 If I<store> is not NULL and any chain verify fails an error code is returned.
  62
  63 Finally the signed content is read (and written to I<out> unless it is NULL)
  64 and the signature is checked.
  65
  66 If all signatures verify correctly then the function is successful.
  67
  68 Any of the following flags (ored together) can be passed in the I<flags>
  69 parameter to change the default verify behaviour.
  70 Only the flag B<PKCS7_NOINTERN> is meaningful to PKCS7_get0_signers().
  71
  72 If B<PKCS7_NOINTERN> is set the certificates in the message itself are not
  73 searched when locating the signer's certificates.
  74 This means that all the signer's certificates must be in the I<certs> parameter.
  75
  76 If B<PKCS7_NOCRL> is set and CRL checking is enabled in I<store> then any
  77 CRLs in the message itself are ignored.
  78
  79 If the B<PKCS7_TEXT> flag is set MIME headers for type C<text/plain> are deleted
  80 from the content. If the content is not of type C<text/plain> then an error is
  81 returned.
  82
  83 If B<PKCS7_NOVERIFY> is set the signer's certificates are not chain verified.
  84
  85 If B<PKCS7_NOCHAIN> is set then the certificates contained in the message are
  86 not used as untrusted CAs. This means that the whole verify chain (apart from
  87 the signer's certificates) must be contained in the trusted store.
  88
  89 If B<PKCS7_NOSIGS> is set then the signatures on the data are not checked.
  90
  91 =head1 NOTES
  92
  93 One application of B<PKCS7_NOINTERN> is to only accept messages signed by
  94 a small number of certificates. The acceptable certificates would be passed
  95 in the I<certs> parameter. In this case if the signer's certificate is not one
  96 of the certificates supplied in I<certs> then the verify will fail because the
  97 signer cannot be found.
  98
  99 Care should be taken when modifying the default verify behaviour, for example
 100 setting C<PKCS7_NOVERIFY|PKCS7_NOSIGS> will totally disable all verification
 101 and any signed message will be considered valid. This combination is however
 102 useful if one merely wishes to write the content to I<out> and its validity
 103 is not considered important.
 104
 105 Chain verification should arguably be performed using the signing time rather
 106 than the current time. However, since the signing time is supplied by the
 107 signer it cannot be trusted without additional evidence (such as a trusted
 108 timestamp).
 109
 110 =head1 RETURN VALUES
 111
 112 PKCS7_verify() returns 1 for a successful verification and 0 if an error occurs.
 113
 114 PKCS7_get0_signers() returns all signers or NULL if an error occurred.
 115
 116 The error can be obtained from L<ERR_get_error(3)>.
 117
 118 =head1 BUGS
 119
 120 The trusted certificate store is not searched for the signer's certificates.
 121 This is primarily due to the inadequacies of the current B<X509_STORE>
 122 functionality.
 123
 124 The lack of single pass processing means that the signed content must all
 125 be held in memory if it is not detached.
 126
 127 =head1 SEE ALSO
 128
 129 L<CMS_verify(3)>, L<PKCS7_add_certificate(3)>, L<PKCS7_add_crl(3)>,
 130 L<ERR_get_error(3)>, L<PKCS7_sign(3)>
 131
 132 =head1 COPYRIGHT
 133
 134 Copyright 2002-2020 The OpenSSL Project Authors. All Rights Reserved.
 135
 136 Licensed under the Apache License 2.0 (the "License").  You may not use
 137 this file except in compliance with the License.  You can obtain a copy
 138 in the file LICENSE in the source distribution or at
 139 L<https://www.openssl.org/source/license.html>.
 140
 141 =cut