1 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.30)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
49 .\" If the F register is turned on, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
54 .\" Avoid warning from groff about undefined register 'F'.
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{
62 . tm Index:\\$1\t\\n%\t"\\$2"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear. Run. Save yourself. No user-serviceable parts.
74 . \" fudge factors for nroff and troff
83 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
89 . \" simple accents for nroff and troff
99 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
106 . \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 . \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 . \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
133 .\" ========================================================================
135 .IX Title "SMIME_write_PKCS7 3"
136 .TH SMIME_write_PKCS7 3 "2016-05-03" "1.0.2h" "OpenSSL"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
142 SMIME_write_PKCS7 \- convert PKCS#7 structure to S/MIME format.
144 .IX Header "SYNOPSIS"
146 \& #include <openssl/pkcs7.h>
148 \& int SMIME_write_PKCS7(BIO *out, PKCS7 *p7, BIO *data, int flags);
151 .IX Header "DESCRIPTION"
152 \&\fISMIME_write_PKCS7()\fR adds the appropriate \s-1MIME\s0 headers to a PKCS#7
153 structure to produce an S/MIME message.
155 \&\fBout\fR is the \s-1BIO\s0 to write the data to. \fBp7\fR is the appropriate \fB\s-1PKCS7\s0\fR
156 structure. If streaming is enabled then the content must be supplied in the
157 \&\fBdata\fR argument. \fBflags\fR is an optional set of flags.
160 The following flags can be passed in the \fBflags\fR parameter.
162 If \fB\s-1PKCS7_DETACHED\s0\fR is set then cleartext signing will be used,
163 this option only makes sense for signedData where \fB\s-1PKCS7_DETACHED\s0\fR
164 is also set when \fIPKCS7_sign()\fR is also called.
166 If the \fB\s-1PKCS7_TEXT\s0\fR flag is set \s-1MIME\s0 headers for type \fBtext/plain\fR
167 are added to the content, this only makes sense if \fB\s-1PKCS7_DETACHED\s0\fR
170 If the \fB\s-1PKCS7_STREAM\s0\fR flag is set streaming is performed. This flag should
171 only be set if \fB\s-1PKCS7_STREAM\s0\fR was also set in the previous call to
172 \&\fIPKCS7_sign()\fR or \fB\f(BIPKCS7_encrypt()\fB\fR.
174 If cleartext signing is being used and \fB\s-1PKCS7_STREAM\s0\fR not set then
175 the data must be read twice: once to compute the signature in \fIPKCS7_sign()\fR
176 and once to output the S/MIME message.
178 If streaming is performed the content is output in \s-1BER\s0 format using indefinite
179 length constructuted encoding except in the case of signed data with detached
180 content where the content is absent and \s-1DER\s0 format is used.
183 \&\fISMIME_write_PKCS7()\fR always base64 encodes PKCS#7 structures, there
184 should be an option to disable this.
186 .IX Header "RETURN VALUES"
187 \&\fISMIME_write_PKCS7()\fR returns 1 for success or 0 for failure.
189 .IX Header "SEE ALSO"
190 \&\fIERR_get_error\fR\|(3), \fIPKCS7_sign\fR\|(3),
191 \&\fIPKCS7_verify\fR\|(3), \fIPKCS7_encrypt\fR\|(3)
192 \&\fIPKCS7_decrypt\fR\|(3)
195 \&\fISMIME_write_PKCS7()\fR was added to OpenSSL 0.9.5