1 .\" Automatically generated by Pod::Man 2.12 (Pod::Simple 3.05)
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
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<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
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
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.
57 . tm Index:\\$1\t\\n%\t"\\$2"
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
74 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 . \" simple accents for nroff and troff
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'
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 \
124 .\" ========================================================================
126 .IX Title "SMIME_read_PKCS7 3"
127 .TH SMIME_read_PKCS7 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.
133 SMIME_read_PKCS7 \- parse S/MIME message.
135 .IX Header "SYNOPSIS"
136 \&\s-1PKCS7\s0 *SMIME_read_PKCS7(\s-1BIO\s0 *in, \s-1BIO\s0 **bcont);
138 .IX Header "DESCRIPTION"
139 \&\fISMIME_read_PKCS7()\fR parses a message in S/MIME format.
141 \&\fBin\fR is a \s-1BIO\s0 to read the message from.
143 If cleartext signing is used then the content is saved in
144 a memory bio which is written to \fB*bcont\fR, otherwise
145 \&\fB*bcont\fR is set to \fB\s-1NULL\s0\fR.
147 The parsed PKCS#7 structure is returned or \fB\s-1NULL\s0\fR if an
151 If \fB*bcont\fR is not \fB\s-1NULL\s0\fR then the message is clear text
152 signed. \fB*bcont\fR can then be passed to \fIPKCS7_verify()\fR with
153 the \fB\s-1PKCS7_DETACHED\s0\fR flag set.
155 Otherwise the type of the returned structure can be determined
156 using \fIPKCS7_type()\fR.
158 To support future functionality if \fBbcont\fR is not \fB\s-1NULL\s0\fR
159 \&\fB*bcont\fR should be initialized to \fB\s-1NULL\s0\fR. For example:
165 \& p7 = SMIME_read_PKCS7(in, &cont);
169 The \s-1MIME\s0 parser used by \fISMIME_read_PKCS7()\fR is somewhat primitive.
170 While it will handle most S/MIME messages more complex compound
171 formats may not work.
173 The parser assumes that the \s-1PKCS7\s0 structure is always base64
174 encoded and will not handle the case where it is in binary format
175 or uses quoted printable format.
177 The use of a memory \s-1BIO\s0 to hold the signed content limits the size
178 of message which can be processed due to memory restraints: a
179 streaming single pass option should be available.
181 .IX Header "RETURN VALUES"
182 \&\fISMIME_read_PKCS7()\fR returns a valid \fB\s-1PKCS7\s0\fR structure or \fB\s-1NULL\s0\fR
183 is an error occurred. The error can be obtained from \fIERR_get_error\fR\|(3).
185 .IX Header "SEE ALSO"
186 \&\fIERR_get_error\fR\|(3), \fIPKCS7_type\fR\|(3)
187 \&\fISMIME_read_PKCS7\fR\|(3), \fIPKCS7_sign\fR\|(3),
188 \&\fIPKCS7_verify\fR\|(3), \fIPKCS7_encrypt\fR\|(3)
189 \&\fIPKCS7_decrypt\fR\|(3)
192 \&\fISMIME_read_PKCS7()\fR was added to OpenSSL 0.9.5