secure/lib/libcrypto/man/PKCS7_verify.3

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