Upgrade to OpenSSL 0.9.8h.
[dragonfly.git] / secure / lib / libcrypto / man / SMIME_read_PKCS7.3
CommitLineData
aac4ff6f 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
8b0cefbb
JR
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
984263bc
MD
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
8b0cefbb 13.de Sp \" Vertical space (when we can't use .PP)
984263bc
MD
14.if t .sp .5v
15.if n .sp
16..
8b0cefbb 17.de Vb \" Begin verbatim text
984263bc
MD
18.ft CW
19.nf
20.ne \\$1
21..
8b0cefbb 22.de Ve \" End verbatim text
984263bc 23.ft R
984263bc
MD
24.fi
25..
8b0cefbb
JR
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
aac4ff6f
PA
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
8b0cefbb 33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
984263bc 34.ie n \{\
8b0cefbb
JR
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' ""
984263bc
MD
43'br\}
44.el\{\
8b0cefbb
JR
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
984263bc 49'br\}
8b0cefbb
JR
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"
984263bc 58..
8b0cefbb
JR
59. nr % 0
60. rr F
984263bc 61.\}
8b0cefbb 62.\"
aac4ff6f
PA
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.\"
8b0cefbb
JR
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
984263bc 71.if n \{\
8b0cefbb
JR
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
984263bc
MD
77.\}
78.if t \{\
8b0cefbb
JR
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
984263bc 84.\}
8b0cefbb 85. \" simple accents for nroff and troff
984263bc 86.if n \{\
8b0cefbb
JR
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
984263bc
MD
93.\}
94.if t \{\
8b0cefbb
JR
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'
984263bc 101.\}
8b0cefbb 102. \" troff and (daisy-wheel) nroff accents
984263bc
MD
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
8b0cefbb 112. \" corrections for vroff
984263bc
MD
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'
8b0cefbb 115. \" for low resolution devices (crt and lpr)
984263bc
MD
116.if \n(.H>23 .if \n(.V>19 \
117\{\
8b0cefbb
JR
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
984263bc
MD
127.\}
128.rm #[ #] #H #V #F C
8b0cefbb
JR
129.\" ========================================================================
130.\"
131.IX Title "SMIME_read_PKCS7 3"
aac4ff6f 132.TH SMIME_read_PKCS7 3 "2008-09-06" "0.9.8h" "OpenSSL"
984263bc
MD
133.SH "NAME"
134SMIME_read_PKCS7 \- parse S/MIME message.
135.SH "SYNOPSIS"
8b0cefbb
JR
136.IX Header "SYNOPSIS"
137\&\s-1PKCS7\s0 *SMIME_read_PKCS7(\s-1BIO\s0 *in, \s-1BIO\s0 **bcont);
984263bc 138.SH "DESCRIPTION"
8b0cefbb
JR
139.IX Header "DESCRIPTION"
140\&\fISMIME_read_PKCS7()\fR parses a message in S/MIME format.
984263bc 141.PP
8b0cefbb 142\&\fBin\fR is a \s-1BIO\s0 to read the message from.
984263bc
MD
143.PP
144If cleartext signing is used then the content is saved in
145a memory bio which is written to \fB*bcont\fR, otherwise
8b0cefbb 146\&\fB*bcont\fR is set to \fB\s-1NULL\s0\fR.
984263bc 147.PP
8b0cefbb 148The parsed PKCS#7 structure is returned or \fB\s-1NULL\s0\fR if an
984263bc
MD
149error occurred.
150.SH "NOTES"
8b0cefbb
JR
151.IX Header "NOTES"
152If \fB*bcont\fR is not \fB\s-1NULL\s0\fR then the message is clear text
984263bc 153signed. \fB*bcont\fR can then be passed to \fIPKCS7_verify()\fR with
8b0cefbb 154the \fB\s-1PKCS7_DETACHED\s0\fR flag set.
984263bc
MD
155.PP
156Otherwise the type of the returned structure can be determined
157using \fIPKCS7_type()\fR.
158.PP
8b0cefbb
JR
159To support future functionality if \fBbcont\fR is not \fB\s-1NULL\s0\fR
160\&\fB*bcont\fR should be initialized to \fB\s-1NULL\s0\fR. For example:
984263bc
MD
161.PP
162.Vb 2
163\& BIO *cont = NULL;
164\& PKCS7 *p7;
aac4ff6f
PA
165.Ve
166.PP
167.Vb 1
984263bc
MD
168\& p7 = SMIME_read_PKCS7(in, &cont);
169.Ve
170.SH "BUGS"
8b0cefbb
JR
171.IX Header "BUGS"
172The \s-1MIME\s0 parser used by \fISMIME_read_PKCS7()\fR is somewhat primitive.
984263bc
MD
173While it will handle most S/MIME messages more complex compound
174formats may not work.
175.PP
8b0cefbb 176The parser assumes that the \s-1PKCS7\s0 structure is always base64
984263bc
MD
177encoded and will not handle the case where it is in binary format
178or uses quoted printable format.
179.PP
8b0cefbb 180The use of a memory \s-1BIO\s0 to hold the signed content limits the size
984263bc
MD
181of message which can be processed due to memory restraints: a
182streaming single pass option should be available.
183.SH "RETURN VALUES"
8b0cefbb
JR
184.IX Header "RETURN VALUES"
185\&\fISMIME_read_PKCS7()\fR returns a valid \fB\s-1PKCS7\s0\fR structure or \fB\s-1NULL\s0\fR
984263bc
MD
186is an error occurred. The error can be obtained from \fIERR_get_error\fR\|(3).
187.SH "SEE ALSO"
74dab6c2 188.IX Header "SEE ALSO"
8b0cefbb
JR
189\&\fIERR_get_error\fR\|(3), \fIPKCS7_type\fR\|(3)
190\&\fISMIME_read_PKCS7\fR\|(3), \fIPKCS7_sign\fR\|(3),
191\&\fIPKCS7_verify\fR\|(3), \fIPKCS7_encrypt\fR\|(3)
192\&\fIPKCS7_decrypt\fR\|(3)
193.SH "HISTORY"
984263bc 194.IX Header "HISTORY"
8b0cefbb 195\&\fISMIME_read_PKCS7()\fR was added to OpenSSL 0.9.5