secure/lib/libcrypto/man/PKCS7_verify.3

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