1 .\" Automatically generated by Pod::Man version 1.15
2 .\" Wed Mar 17 09:38:40 2004
5 .\" ======================================================================
6 .de Sh \" Subsection heading
14 .de Sp \" Vertical space (when we can't use .PP)
20 .ie \\n(.$>=3 .ne \\$3
24 .de Vb \" Begin verbatim text
29 .de Ve \" End verbatim text
34 .\" Set up some character translations and predefined strings. \*(-- will
35 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
36 .\" double quote, and \*(R" will give a right double quote. | will give a
37 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used
38 .\" to do unbreakable dashes and therefore won't be available. \*(C` and
39 .\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
41 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
45 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
46 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
59 .\" If the F register is turned on, we'll generate index entries on stderr
60 .\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
61 .\" index entries marked with X<> in POD. Of course, you'll have to process
62 .\" the output yourself in some meaningful fashion.
65 . tm Index:\\$1\t\\n%\t"\\$2"
71 .\" For nroff, turn off justification. Always turn off hyphenation; it
72 .\" makes way too many mistakes in technical documents.
76 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
77 .\" Fear. Run. Save yourself. No user-serviceable parts.
79 . \" fudge factors for nroff and troff
88 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
94 . \" simple accents for nroff and troff
104 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
105 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
106 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
107 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
108 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
109 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
111 . \" troff and (daisy-wheel) nroff accents
112 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
113 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
114 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
115 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
116 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
117 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
118 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
119 .ds ae a\h'-(\w'a'u*4/10)'e
120 .ds Ae A\h'-(\w'A'u*4/10)'E
121 . \" corrections for vroff
122 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
123 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
124 . \" for low resolution devices (crt and lpr)
125 .if \n(.H>23 .if \n(.V>19 \
138 .\" ======================================================================
140 .IX Title "SMIME_read_PKCS7 3"
141 .TH SMIME_read_PKCS7 3 "0.9.7d" "2004-03-17" "OpenSSL"
144 SMIME_read_PKCS7 \- parse S/MIME message.
146 .IX Header "SYNOPSIS"
147 \&\s-1PKCS7\s0 *SMIME_read_PKCS7(\s-1BIO\s0 *in, \s-1BIO\s0 **bcont);
149 .IX Header "DESCRIPTION"
150 \&\fISMIME_read_PKCS7()\fR parses a message in S/MIME format.
152 \&\fBin\fR is a \s-1BIO\s0 to read the message from.
154 If cleartext signing is used then the content is saved in
155 a memory bio which is written to \fB*bcont\fR, otherwise
156 \&\fB*bcont\fR is set to \fB\s-1NULL\s0\fR.
158 The parsed PKCS#7 structure is returned or \fB\s-1NULL\s0\fR if an
162 If \fB*bcont\fR is not \fB\s-1NULL\s0\fR then the message is clear text
163 signed. \fB*bcont\fR can then be passed to \fIPKCS7_verify()\fR with
164 the \fB\s-1PKCS7_DETACHED\s0\fR flag set.
166 Otherwise the type of the returned structure can be determined
167 using \fIPKCS7_type()\fR.
169 To support future functionality if \fBbcont\fR is not \fB\s-1NULL\s0\fR
170 \&\fB*bcont\fR should be initialized to \fB\s-1NULL\s0\fR. For example:
177 \& p7 = SMIME_read_PKCS7(in, &cont);
181 The \s-1MIME\s0 parser used by \fISMIME_read_PKCS7()\fR is somewhat primitive.
182 While it will handle most S/MIME messages more complex compound
183 formats may not work.
185 The parser assumes that the \s-1PKCS7\s0 structure is always base64
186 encoded and will not handle the case where it is in binary format
187 or uses quoted printable format.
189 The use of a memory \s-1BIO\s0 to hold the signed content limits the size
190 of message which can be processed due to memory restraints: a
191 streaming single pass option should be available.
193 .IX Header "RETURN VALUES"
194 \&\fISMIME_read_PKCS7()\fR returns a valid \fB\s-1PKCS7\s0\fR structure or \fB\s-1NULL\s0\fR
195 is an error occurred. The error can be obtained from \fIERR_get_error\fR\|(3).
197 .IX Header "SEE ALSO"
198 ERR_get_error(3), PKCS7_type(3)
199 SMIME_read_PKCS7(3), PKCS7_sign(3),
200 PKCS7_verify(3), PKCS7_encrypt(3)
204 \&\fISMIME_read_PKCS7()\fR was added to OpenSSL 0.9.5