secure/lib/libcrypto/man/PKCS7_verify.3

   1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is turned on, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{
  60 .    if \nF \{
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "PKCS7_verify 3"
 136 .TH PKCS7_verify 3 "2015-03-19" "1.0.1m" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 PKCS7_verify \- verify a PKCS#7 signedData structure
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/pkcs7.h>
 147 \&
 148 \& int PKCS7_verify(PKCS7 *p7, STACK_OF(X509) *certs, X509_STORE *store, BIO *indata, BIO *out, int flags);
 149 \&
 150 \& STACK_OF(X509) *PKCS7_get0_signers(PKCS7 *p7, STACK_OF(X509) *certs, int flags);
 151 .Ve
 152 .SH "DESCRIPTION"
 153 .IX Header "DESCRIPTION"
 154 \&\fIPKCS7_verify()\fR verifies a PKCS#7 signedData structure. \fBp7\fR is the \s-1PKCS7\s0
 155 structure to verify. \fBcerts\fR is a set of certificates in which to search for
 156 the signer's certificate. \fBstore\fR is a trusted certficate store (used for
 157 chain verification). \fBindata\fR is the signed data if the content is not
 158 present in \fBp7\fR (that is it is detached). The content is written to \fBout\fR
 159 if it is not \s-1NULL.\s0
 160 .PP
 161 \&\fBflags\fR is an optional set of flags, which can be used to modify the verify
 162 operation.
 163 .PP
 164 \&\fIPKCS7_get0_signers()\fR retrieves the signer's certificates from \fBp7\fR, it does
 165 \&\fBnot\fR check their validity or whether any signatures are valid. The \fBcerts\fR
 166 and \fBflags\fR parameters have the same meanings as in \fIPKCS7_verify()\fR.
 167 .SH "VERIFY PROCESS"
 168 .IX Header "VERIFY PROCESS"
 169 Normally the verify process proceeds as follows.
 170 .PP
 171 Initially some sanity checks are performed on \fBp7\fR. The type of \fBp7\fR must
 172 be signedData. There must be at least one signature on the data and if
 173 the content is detached \fBindata\fR cannot be \fB\s-1NULL\s0\fR.
 174 .PP
 175 An attempt is made to locate all the signer's certificates, first looking in
 176 the \fBcerts\fR parameter (if it is not \fB\s-1NULL\s0\fR) and then looking in any certificates
 177 contained in the \fBp7\fR structure itself. If any signer's certificates cannot be
 178 located the operation fails.
 179 .PP
 180 Each signer's certificate is chain verified using the \fBsmimesign\fR purpose and
 181 the supplied trusted certificate store. Any internal certificates in the message
 182 are used as untrusted CAs. If any chain verify fails an error code is returned.
 183 .PP
 184 Finally the signed content is read (and written to \fBout\fR is it is not \s-1NULL\s0) and
 185 the signature's checked.
 186 .PP
 187 If all signature's verify correctly then the function is successful.
 188 .PP
 189 Any of the following flags (ored together) can be passed in the \fBflags\fR parameter
 190 to change the default verify behaviour. Only the flag \fB\s-1PKCS7_NOINTERN\s0\fR is
 191 meaningful to \fIPKCS7_get0_signers()\fR.
 192 .PP
 193 If \fB\s-1PKCS7_NOINTERN\s0\fR is set the certificates in the message itself are not
 194 searched when locating the signer's certificate. This means that all the signers
 195 certificates must be in the \fBcerts\fR parameter.
 196 .PP
 197 If the \fB\s-1PKCS7_TEXT\s0\fR flag is set \s-1MIME\s0 headers for type \fBtext/plain\fR are deleted
 198 from the content. If the content is not of type \fBtext/plain\fR then an error is
 199 returned.
 200 .PP
 201 If \fB\s-1PKCS7_NOVERIFY\s0\fR is set the signer's certificates are not chain verified.
 202 .PP
 203 If \fB\s-1PKCS7_NOCHAIN\s0\fR is set then the certificates contained in the message are
 204 not used as untrusted CAs. This means that the whole verify chain (apart from
 205 the signer's certificate) must be contained in the trusted store.
 206 .PP
 207 If \fB\s-1PKCS7_NOSIGS\s0\fR is set then the signatures on the data are not checked.
 208 .SH "NOTES"
 209 .IX Header "NOTES"
 210 One application of \fB\s-1PKCS7_NOINTERN\s0\fR is to only accept messages signed by
 211 a small number of certificates. The acceptable certificates would be passed
 212 in the \fBcerts\fR parameter. In this case if the signer is not one of the
 213 certificates supplied in \fBcerts\fR then the verify will fail because the
 214 signer cannot be found.
 215 .PP
 216 Care should be taken when modifying the default verify behaviour, for example
 217 setting \fBPKCS7_NOVERIFY|PKCS7_NOSIGS\fR will totally disable all verification
 218 and any signed message will be considered valid. This combination is however
 219 useful if one merely wishes to write the content to \fBout\fR and its validity
 220 is not considered important.
 221 .PP
 222 Chain verification should arguably be performed  using the signing time rather
 223 than the current time. However since the signing time is supplied by the
 224 signer it cannot be trusted without additional evidence (such as a trusted
 225 timestamp).
 226 .SH "RETURN VALUES"
 227 .IX Header "RETURN VALUES"
 228 \&\fIPKCS7_verify()\fR returns 1 for a successful verification and zero or a negative
 229 value if an error occurs.
 230 .PP
 231 \&\fIPKCS7_get0_signers()\fR returns all signers or \fB\s-1NULL\s0\fR if an error occurred.
 232 .PP
 233 The error can be obtained from \fIERR_get_error\fR\|(3)
 234 .SH "BUGS"
 235 .IX Header "BUGS"
 236 The trusted certificate store is not searched for the signers certificate,
 237 this is primarily due to the inadequacies of the current \fBX509_STORE\fR
 238 functionality.
 239 .PP
 240 The lack of single pass processing and need to hold all data in memory as
 241 mentioned in \fIPKCS7_sign()\fR also applies to \fIPKCS7_verify()\fR.
 242 .SH "SEE ALSO"
 243 .IX Header "SEE ALSO"
 244 \&\fIERR_get_error\fR\|(3), \fIPKCS7_sign\fR\|(3)
 245 .SH "HISTORY"
 246 .IX Header "HISTORY"
 247 \&\fIPKCS7_verify()\fR was added to OpenSSL 0.9.5