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