secure/lib/libcrypto/man/PKCS7_verify.3

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