Debian Codegraph @

upstream/debian-unstable/man3/SMIME_write_CMS.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "SMIME_WRITE_CMS 3SSL"
58 .TH SMIME_WRITE_CMS 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 SMIME_write_CMS \- convert CMS structure to S/MIME format
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/cms.h>
69 \&
70 \& int SMIME_write_CMS(BIO *out, CMS_ContentInfo *cms, BIO *data, int flags);
71 .Ve
72 .SH DESCRIPTION
73 .IX Header "DESCRIPTION"
74 \&\fBSMIME_write_CMS()\fR adds the appropriate MIME headers to a CMS
75 structure to produce an S/MIME message.
76 .PP
77 \&\fBout\fR is the BIO to write the data to. \fBcms\fR is the appropriate
78 \&\fBCMS_ContentInfo\fR structure. If streaming is enabled then the content must be
79 supplied in the \fBdata\fR argument. \fBflags\fR is an optional set of flags.
80 .SH NOTES
81 .IX Header "NOTES"
82 The following flags can be passed in the \fBflags\fR parameter.
83 .PP
84 If \fBCMS_DETACHED\fR is set then cleartext signing will be used, this option only
85 makes sense for SignedData where \fBCMS_DETACHED\fR is also set when \fBCMS_sign()\fR is
86 called.
87 .PP
88 If the \fBCMS_TEXT\fR flag is set MIME headers for type \fBtext/plain\fR are added to
89 the content, this only makes sense if \fBCMS_DETACHED\fR is also set.
90 .PP
91 If the \fBCMS_STREAM\fR flag is set streaming is performed. This flag should only
92 be set if \fBCMS_STREAM\fR was also set in the previous call to a CMS_ContentInfo
93 creation function.
94 .PP
95 If cleartext signing is being used and \fBCMS_STREAM\fR not set then the data must
96 be read twice: once to compute the signature in \fBCMS_sign()\fR and once to output
97 the S/MIME message.
98 .PP
99 If streaming is performed the content is output in BER format using indefinite
100 length constructed encoding except in the case of signed data with detached
101 content where the content is absent and DER format is used.
102 .SH BUGS
103 .IX Header "BUGS"
104 \&\fBSMIME_write_CMS()\fR always base64 encodes CMS structures, there should be an
105 option to disable this.
106 .SH "RETURN VALUES"
107 .IX Header "RETURN VALUES"
108 \&\fBSMIME_write_CMS()\fR returns 1 for success or 0 for failure.
109 .SH "SEE ALSO"
110 .IX Header "SEE ALSO"
111 \&\fBERR_get_error\fR\|(3), \fBCMS_sign\fR\|(3),
112 \&\fBCMS_verify\fR\|(3), \fBCMS_encrypt\fR\|(3)
113 \&\fBCMS_decrypt\fR\|(3)
114 .SH COPYRIGHT
115 .IX Header "COPYRIGHT"
116 Copyright 2008\-2016 The OpenSSL Project Authors. All Rights Reserved.
117 .PP
118 Licensed under the Apache License 2.0 (the "License"). You may not use
119 this file except in compliance with the License. You can obtain a copy
120 in the file LICENSE in the source distribution or at
121 <https://www.openssl.org/source/license.html>.