1 .\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.35)
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 >0, 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'.
60 . tm Index:\\$1\t\\n%\t"\\$2"
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
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
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'
102 . \" troff and (daisy-wheel) nroff accents
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
112 . \" corrections for vroff
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'
115 . \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
129 .\" ========================================================================
131 .IX Title "SMIME_write_PKCS7 3"
132 .TH SMIME_write_PKCS7 3 "2017-12-07" "1.0.2n" "OpenSSL"
133 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
134 .\" way too many mistakes in technical documents.
138 SMIME_write_PKCS7 \- convert PKCS#7 structure to S/MIME format.
140 .IX Header "SYNOPSIS"
142 \& #include <openssl/pkcs7.h>
144 \& int SMIME_write_PKCS7(BIO *out, PKCS7 *p7, BIO *data, int flags);
147 .IX Header "DESCRIPTION"
148 \&\fISMIME_write_PKCS7()\fR adds the appropriate \s-1MIME\s0 headers to a PKCS#7
149 structure to produce an S/MIME message.
151 \&\fBout\fR is the \s-1BIO\s0 to write the data to. \fBp7\fR is the appropriate \fB\s-1PKCS7\s0\fR
152 structure. If streaming is enabled then the content must be supplied in the
153 \&\fBdata\fR argument. \fBflags\fR is an optional set of flags.
156 The following flags can be passed in the \fBflags\fR parameter.
158 If \fB\s-1PKCS7_DETACHED\s0\fR is set then cleartext signing will be used,
159 this option only makes sense for signedData where \fB\s-1PKCS7_DETACHED\s0\fR
160 is also set when \fIPKCS7_sign()\fR is also called.
162 If the \fB\s-1PKCS7_TEXT\s0\fR flag is set \s-1MIME\s0 headers for type \fBtext/plain\fR
163 are added to the content, this only makes sense if \fB\s-1PKCS7_DETACHED\s0\fR
166 If the \fB\s-1PKCS7_STREAM\s0\fR flag is set streaming is performed. This flag should
167 only be set if \fB\s-1PKCS7_STREAM\s0\fR was also set in the previous call to
168 \&\fIPKCS7_sign()\fR or \fB\f(BIPKCS7_encrypt()\fB\fR.
170 If cleartext signing is being used and \fB\s-1PKCS7_STREAM\s0\fR not set then
171 the data must be read twice: once to compute the signature in \fIPKCS7_sign()\fR
172 and once to output the S/MIME message.
174 If streaming is performed the content is output in \s-1BER\s0 format using indefinite
175 length constructuted encoding except in the case of signed data with detached
176 content where the content is absent and \s-1DER\s0 format is used.
179 \&\fISMIME_write_PKCS7()\fR always base64 encodes PKCS#7 structures, there
180 should be an option to disable this.
182 .IX Header "RETURN VALUES"
183 \&\fISMIME_write_PKCS7()\fR returns 1 for success or 0 for failure.
185 .IX Header "SEE ALSO"
186 \&\fIERR_get_error\fR\|(3), \fIPKCS7_sign\fR\|(3),
187 \&\fIPKCS7_verify\fR\|(3), \fIPKCS7_encrypt\fR\|(3)
188 \&\fIPKCS7_decrypt\fR\|(3)
191 \&\fISMIME_write_PKCS7()\fR was added to OpenSSL 0.9.5