Update files for OpenSSL-1.0.0f import.
[dragonfly.git] / secure / lib / libcrypto / man / CMS_encrypt.3
CommitLineData
e3261593 1.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.19)
01185282
PA
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sp \" Vertical space (when we can't use .PP)
6.if t .sp .5v
7.if n .sp
8..
9.de Vb \" Begin verbatim text
10.ft CW
11.nf
12.ne \\$1
13..
14.de Ve \" End verbatim text
15.ft R
16.fi
17..
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<>.
24.tr \(*W-
25.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26.ie n \{\
27. ds -- \(*W-
28. ds PI pi
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
31. ds L" ""
32. ds R" ""
33. ds C` ""
34. ds C' ""
35'br\}
36.el\{\
37. ds -- \|\(em\|
38. ds PI \(*p
39. ds L" ``
40. ds R" ''
41'br\}
42.\"
43.\" Escape single quotes in literal strings from groff's Unicode transform.
44.ie \n(.g .ds Aq \(aq
45.el .ds Aq '
46.\"
47.\" If the F register is turned on, we'll generate index entries on stderr for
48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49.\" entries marked with X<> in POD. Of course, you'll have to process the
50.\" output yourself in some meaningful fashion.
51.ie \nF \{\
52. de IX
53. tm Index:\\$1\t\\n%\t"\\$2"
54..
55. nr % 0
56. rr F
57.\}
58.el \{\
59. de IX
60..
61.\}
62.\"
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
66.if n \{\
67. ds #H 0
68. ds #V .8m
69. ds #F .3m
70. ds #[ \f1
71. ds #] \fP
72.\}
73.if t \{\
74. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75. ds #V .6m
76. ds #F 0
77. ds #[ \&
78. ds #] \&
79.\}
80. \" simple accents for nroff and troff
81.if n \{\
82. ds ' \&
83. ds ` \&
84. ds ^ \&
85. ds , \&
86. ds ~ ~
87. ds /
88.\}
89.if t \{\
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'
96.\}
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 \
112\{\
113. ds : e
114. ds 8 ss
115. ds o a
116. ds d- d\h'-1'\(ga
117. ds D- D\h'-1'\(hy
118. ds th \o'bp'
119. ds Th \o'LP'
120. ds ae ae
121. ds Ae AE
122.\}
123.rm #[ #] #H #V #F C
124.\" ========================================================================
125.\"
126.IX Title "CMS_encrypt 3"
e3261593 127.TH CMS_encrypt 3 "2012-01-04" "1.0.0f" "OpenSSL"
01185282
PA
128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129.\" way too many mistakes in technical documents.
130.if n .ad l
131.nh
132.SH "NAME"
133.Vb 1
134\& CMS_encrypt \- create a CMS envelopedData structure
135.Ve
136.SH "SYNOPSIS"
137.IX Header "SYNOPSIS"
138.Vb 1
139\& #include <openssl/cms.h>
140\&
141\& CMS_ContentInfo *CMS_encrypt(STACK_OF(X509) *certs, BIO *in, const EVP_CIPHER *cipher, unsigned int flags);
142.Ve
143.SH "DESCRIPTION"
144.IX Header "DESCRIPTION"
145\&\fICMS_encrypt()\fR creates and returns a \s-1CMS\s0 EnvelopedData structure. \fBcerts\fR
146is a list of recipient certificates. \fBin\fR is the content to be encrypted.
147\&\fBcipher\fR is the symmetric cipher to use. \fBflags\fR is an optional set of flags.
148.SH "NOTES"
149.IX Header "NOTES"
150Only certificates carrying \s-1RSA\s0 keys are supported so the recipient certificates
151supplied to this function must all contain \s-1RSA\s0 public keys, though they do not
152have to be signed using the \s-1RSA\s0 algorithm.
153.PP
154\&\fIEVP_des_ede3_cbc()\fR (triple \s-1DES\s0) is the algorithm of choice for S/MIME use
155because most clients will support it.
156.PP
157The algorithm passed in the \fBcipher\fR parameter must support \s-1ASN1\s0 encoding of
158its parameters.
159.PP
160Many browsers implement a \*(L"sign and encrypt\*(R" option which is simply an S/MIME
161envelopedData containing an S/MIME signed message. This can be readily produced
162by storing the S/MIME signed message in a memory \s-1BIO\s0 and passing it to
163\&\fICMS_encrypt()\fR.
164.PP
165The following flags can be passed in the \fBflags\fR parameter.
166.PP
167If the \fB\s-1CMS_TEXT\s0\fR flag is set \s-1MIME\s0 headers for type \fBtext/plain\fR are
168prepended to the data.
169.PP
170Normally the supplied content is translated into \s-1MIME\s0 canonical format (as
171required by the S/MIME specifications) if \fB\s-1CMS_BINARY\s0\fR is set no translation
172occurs. This option should be used if the supplied data is in binary format
173otherwise the translation will corrupt it. If \fB\s-1CMS_BINARY\s0\fR is set then
174\&\fB\s-1CMS_TEXT\s0\fR is ignored.
175.PP
176OpenSSL will by default identify recipient certificates using issuer name
177and serial number. If \fB\s-1CMS_USE_KEYID\s0\fR is set it will use the subject key
178identifier value instead. An error occurs if all recipient certificates do not
179have a subject key identifier extension.
180.PP
181If the \fB\s-1CMS_STREAM\s0\fR flag is set a partial \fBCMS_ContentInfo\fR structure is
182returned suitable for streaming I/O: no data is read from the \s-1BIO\s0 \fBin\fR.
183.PP
184If the \fB\s-1CMS_PARTIAL\s0\fR flag is set a partial \fBCMS_ContentInfo\fR structure is
185returned to which additional recipients and attributes can be added before
186finalization.
187.PP
188The data being encrypted is included in the CMS_ContentInfo structure, unless
189\&\fB\s-1CMS_DETACHED\s0\fR is set in which case it is omitted. This is rarely used in
190practice and is not supported by \fISMIME_write_CMS()\fR.
191.SH "NOTES"
192.IX Header "NOTES"
193If the flag \fB\s-1CMS_STREAM\s0\fR is set the returned \fBCMS_ContentInfo\fR structure is
194\&\fBnot\fR complete and outputting its contents via a function that does not
195properly finalize the \fBCMS_ContentInfo\fR structure will give unpredictable
196results.
197.PP
198Several functions including \fISMIME_write_CMS()\fR, \fIi2d_CMS_bio_stream()\fR,
199\&\fIPEM_write_bio_CMS_stream()\fR finalize the structure. Alternatively finalization
200can be performed by obtaining the streaming \s-1ASN1\s0 \fB\s-1BIO\s0\fR directly using
201\&\fIBIO_new_CMS()\fR.
202.PP
203The recipients specified in \fBcerts\fR use a \s-1CMS\s0 KeyTransRecipientInfo info
204structure. KEKRecipientInfo is also supported using the flag \fB\s-1CMS_PARTIAL\s0\fR
205and \fICMS_add0_recipient_key()\fR.
206.PP
207The parameter \fBcerts\fR may be \s-1NULL\s0 if \fB\s-1CMS_PARTIAL\s0\fR is set and recipients
208added later using \fICMS_add1_recipient_cert()\fR or \fICMS_add0_recipient_key()\fR.
209.SH "RETURN VALUES"
210.IX Header "RETURN VALUES"
211\&\fICMS_encrypt()\fR returns either a CMS_ContentInfo structure or \s-1NULL\s0 if an error
212occurred. The error can be obtained from \fIERR_get_error\fR\|(3).
213.SH "SEE ALSO"
214.IX Header "SEE ALSO"
215\&\fIERR_get_error\fR\|(3), \fICMS_decrypt\fR\|(3)
216.SH "HISTORY"
217.IX Header "HISTORY"
218\&\fICMS_decrypt()\fR was added to OpenSSL 0.9.8
219The \fB\s-1CMS_STREAM\s0\fR flag was first supported in OpenSSL 1.0.0.