doc/crypto/PKCS7_verify.pod

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