c81ebca43d15b28bc8156a4cd39773b136d303ea
[dragonfly.git] / secure / usr.bin / openssl / man / cms.1
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.19)
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 1"
127 .TH CMS 1 "2012-04-26" "1.0.1b" "OpenSSL"
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 cms \- CMS utility
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 \&\fBopenssl\fR \fBcms\fR
137 [\fB\-encrypt\fR]
138 [\fB\-decrypt\fR]
139 [\fB\-sign\fR]
140 [\fB\-verify\fR]
141 [\fB\-cmsout\fR]
142 [\fB\-resign\fR]
143 [\fB\-data_create\fR]
144 [\fB\-data_out\fR]
145 [\fB\-digest_create\fR]
146 [\fB\-digest_verify\fR]
147 [\fB\-compress\fR]
148 [\fB\-uncompress\fR]
149 [\fB\-EncryptedData_encrypt\fR]
150 [\fB\-sign_receipt\fR]
151 [\fB\-verify_receipt receipt\fR]
152 [\fB\-in filename\fR]
153 [\fB\-inform SMIME|PEM|DER\fR]
154 [\fB\-rctform SMIME|PEM|DER\fR]
155 [\fB\-out filename\fR]
156 [\fB\-outform SMIME|PEM|DER\fR]
157 [\fB\-stream \-indef \-noindef\fR]
158 [\fB\-noindef\fR]
159 [\fB\-content filename\fR]
160 [\fB\-text\fR]
161 [\fB\-noout\fR]
162 [\fB\-print\fR]
163 [\fB\-CAfile file\fR]
164 [\fB\-CApath dir\fR]
165 [\fB\-md digest\fR]
166 [\fB\-[cipher]\fR]
167 [\fB\-nointern\fR]
168 [\fB\-no_signer_cert_verify\fR]
169 [\fB\-nocerts\fR]
170 [\fB\-noattr\fR]
171 [\fB\-nosmimecap\fR]
172 [\fB\-binary\fR]
173 [\fB\-nodetach\fR]
174 [\fB\-certfile file\fR]
175 [\fB\-certsout file\fR]
176 [\fB\-signer file\fR]
177 [\fB\-recip file\fR]
178 [\fB\-keyid\fR]
179 [\fB\-receipt_request_all \-receipt_request_first\fR]
180 [\fB\-receipt_request_from emailaddress\fR]
181 [\fB\-receipt_request_to emailaddress\fR]
182 [\fB\-receipt_request_print\fR]
183 [\fB\-secretkey key\fR]
184 [\fB\-secretkeyid id\fR]
185 [\fB\-econtent_type type\fR]
186 [\fB\-inkey file\fR]
187 [\fB\-passin arg\fR]
188 [\fB\-rand file(s)\fR]
189 [\fBcert.pem...\fR]
190 [\fB\-to addr\fR]
191 [\fB\-from addr\fR]
192 [\fB\-subject subj\fR]
193 [cert.pem]...
194 .SH "DESCRIPTION"
195 .IX Header "DESCRIPTION"
196 The \fBcms\fR command handles S/MIME v3.1 mail. It can encrypt, decrypt, sign and
197 verify, compress and uncompress S/MIME messages.
198 .SH "COMMAND OPTIONS"
199 .IX Header "COMMAND OPTIONS"
200 There are fourteen operation options that set the type of operation to be
201 performed. The meaning of the other options varies according to the operation
202 type.
203 .IP "\fB\-encrypt\fR" 4
204 .IX Item "-encrypt"
205 encrypt mail for the given recipient certificates. Input file is the message
206 to be encrypted. The output file is the encrypted mail in \s-1MIME\s0 format. The
207 actual \s-1CMS\s0 type is <B>EnvelopedData<B>.
208 .IP "\fB\-decrypt\fR" 4
209 .IX Item "-decrypt"
210 decrypt mail using the supplied certificate and private key. Expects an
211 encrypted mail message in \s-1MIME\s0 format for the input file. The decrypted mail
212 is written to the output file.
213 .IP "\fB\-sign\fR" 4
214 .IX Item "-sign"
215 sign mail using the supplied certificate and private key. Input file is
216 the message to be signed. The signed message in \s-1MIME\s0 format is written
217 to the output file.
218 .IP "\fB\-verify\fR" 4
219 .IX Item "-verify"
220 verify signed mail. Expects a signed mail message on input and outputs
221 the signed data. Both clear text and opaque signing is supported.
222 .IP "\fB\-cmsout\fR" 4
223 .IX Item "-cmsout"
224 takes an input message and writes out a \s-1PEM\s0 encoded \s-1CMS\s0 structure.
225 .IP "\fB\-resign\fR" 4
226 .IX Item "-resign"
227 resign a message: take an existing message and one or more new signers.
228 .IP "\fB\-data_create\fR" 4
229 .IX Item "-data_create"
230 Create a \s-1CMS\s0 \fBData\fR type.
231 .IP "\fB\-data_out\fR" 4
232 .IX Item "-data_out"
233 \&\fBData\fR type and output the content.
234 .IP "\fB\-digest_create\fR" 4
235 .IX Item "-digest_create"
236 Create a \s-1CMS\s0 \fBDigestedData\fR type.
237 .IP "\fB\-digest_verify\fR" 4
238 .IX Item "-digest_verify"
239 Verify a \s-1CMS\s0 \fBDigestedData\fR type and output the content.
240 .IP "\fB\-compress\fR" 4
241 .IX Item "-compress"
242 Create a \s-1CMS\s0 \fBCompressedData\fR type. OpenSSL must be compiled with \fBzlib\fR
243 support for this option to work, otherwise it will output an error.
244 .IP "\fB\-uncompress\fR" 4
245 .IX Item "-uncompress"
246 Uncompress a \s-1CMS\s0 \fBCompressedData\fR type and output the content. OpenSSL must be
247 compiled with \fBzlib\fR support for this option to work, otherwise it will
248 output an error.
249 .IP "\fB\-EncryptedData_encrypt\fR" 4
250 .IX Item "-EncryptedData_encrypt"
251 Encrypt suppled content using supplied symmetric key and algorithm using a \s-1CMS\s0
252 \&\fBEncrytedData\fR type and output the content.
253 .IP "\fB\-sign_receipt\fR" 4
254 .IX Item "-sign_receipt"
255 Generate and output a signed receipt for the supplied message. The input 
256 message \fBmust\fR contain a signed receipt request. Functionality is otherwise
257 similar to the \fB\-sign\fR operation.
258 .IP "\fB\-verify_receipt receipt\fR" 4
259 .IX Item "-verify_receipt receipt"
260 Verify a signed receipt in filename \fBreceipt\fR. The input message \fBmust\fR 
261 contain the original receipt request. Functionality is otherwise similar
262 to the \fB\-verify\fR operation.
263 .IP "\fB\-in filename\fR" 4
264 .IX Item "-in filename"
265 the input message to be encrypted or signed or the message to be decrypted
266 or verified.
267 .IP "\fB\-inform SMIME|PEM|DER\fR" 4
268 .IX Item "-inform SMIME|PEM|DER"
269 this specifies the input format for the \s-1CMS\s0 structure. The default
270 is \fB\s-1SMIME\s0\fR which reads an S/MIME format message. \fB\s-1PEM\s0\fR and \fB\s-1DER\s0\fR
271 format change this to expect \s-1PEM\s0 and \s-1DER\s0 format \s-1CMS\s0 structures
272 instead. This currently only affects the input format of the \s-1CMS\s0
273 structure, if no \s-1CMS\s0 structure is being input (for example with
274 \&\fB\-encrypt\fR or \fB\-sign\fR) this option has no effect.
275 .IP "\fB\-rctform SMIME|PEM|DER\fR" 4
276 .IX Item "-rctform SMIME|PEM|DER"
277 specify the format for a signed receipt for use with the \fB\-receipt_verify\fR
278 operation.
279 .IP "\fB\-out filename\fR" 4
280 .IX Item "-out filename"
281 the message text that has been decrypted or verified or the output \s-1MIME\s0
282 format message that has been signed or verified.
283 .IP "\fB\-outform SMIME|PEM|DER\fR" 4
284 .IX Item "-outform SMIME|PEM|DER"
285 this specifies the output format for the \s-1CMS\s0 structure. The default
286 is \fB\s-1SMIME\s0\fR which writes an S/MIME format message. \fB\s-1PEM\s0\fR and \fB\s-1DER\s0\fR
287 format change this to write \s-1PEM\s0 and \s-1DER\s0 format \s-1CMS\s0 structures
288 instead. This currently only affects the output format of the \s-1CMS\s0
289 structure, if no \s-1CMS\s0 structure is being output (for example with
290 \&\fB\-verify\fR or \fB\-decrypt\fR) this option has no effect.
291 .IP "\fB\-stream \-indef \-noindef\fR" 4
292 .IX Item "-stream -indef -noindef"
293 the \fB\-stream\fR and \fB\-indef\fR options are equivalent and enable streaming I/O
294 for encoding operations. This permits single pass processing of data without
295 the need to hold the entire contents in memory, potentially supporting very
296 large files. Streaming is automatically set for S/MIME signing with detached
297 data if the output format is \fB\s-1SMIME\s0\fR it is currently off by default for all
298 other operations.
299 .IP "\fB\-noindef\fR" 4
300 .IX Item "-noindef"
301 disable streaming I/O where it would produce and indefinite length constructed
302 encoding. This option currently has no effect. In future streaming will be
303 enabled by default on all relevant operations and this option will disable it.
304 .IP "\fB\-content filename\fR" 4
305 .IX Item "-content filename"
306 This specifies a file containing the detached content, this is only
307 useful with the \fB\-verify\fR command. This is only usable if the \s-1CMS\s0
308 structure is using the detached signature form where the content is
309 not included. This option will override any content if the input format
310 is S/MIME and it uses the multipart/signed \s-1MIME\s0 content type.
311 .IP "\fB\-text\fR" 4
312 .IX Item "-text"
313 this option adds plain text (text/plain) \s-1MIME\s0 headers to the supplied
314 message if encrypting or signing. If decrypting or verifying it strips
315 off text headers: if the decrypted or verified message is not of \s-1MIME\s0 
316 type text/plain then an error occurs.
317 .IP "\fB\-noout\fR" 4
318 .IX Item "-noout"
319 for the \fB\-cmsout\fR operation do not output the parsed \s-1CMS\s0 structure. This
320 is useful when combined with the \fB\-print\fR option or if the syntax of the \s-1CMS\s0
321 structure is being checked.
322 .IP "\fB\-print\fR" 4
323 .IX Item "-print"
324 for the \fB\-cmsout\fR operation print out all fields of the \s-1CMS\s0 structure. This
325 is mainly useful for testing purposes.
326 .IP "\fB\-CAfile file\fR" 4
327 .IX Item "-CAfile file"
328 a file containing trusted \s-1CA\s0 certificates, only used with \fB\-verify\fR.
329 .IP "\fB\-CApath dir\fR" 4
330 .IX Item "-CApath dir"
331 a directory containing trusted \s-1CA\s0 certificates, only used with
332 \&\fB\-verify\fR. This directory must be a standard certificate directory: that
333 is a hash of each subject name (using \fBx509 \-hash\fR) should be linked
334 to each certificate.
335 .IP "\fB\-md digest\fR" 4
336 .IX Item "-md digest"
337 digest algorithm to use when signing or resigning. If not present then the
338 default digest algorithm for the signing key will be used (usually \s-1SHA1\s0).
339 .IP "\fB\-[cipher]\fR" 4
340 .IX Item "-[cipher]"
341 the encryption algorithm to use. For example triple \s-1DES\s0 (168 bits) \- \fB\-des3\fR
342 or 256 bit \s-1AES\s0 \- \fB\-aes256\fR. Any standard algorithm name (as used by the
343 \&\fIEVP_get_cipherbyname()\fR function) can also be used preceded by a dash, for 
344 example \fB\-aes_128_cbc\fR. See \fBenc\fR for a list of ciphers
345 supported by your version of OpenSSL.
346 .Sp
347 If not specified triple \s-1DES\s0 is used. Only used with \fB\-encrypt\fR and 
348 \&\fB\-EncryptedData_create\fR commands.
349 .IP "\fB\-nointern\fR" 4
350 .IX Item "-nointern"
351 when verifying a message normally certificates (if any) included in
352 the message are searched for the signing certificate. With this option
353 only the certificates specified in the \fB\-certfile\fR option are used.
354 The supplied certificates can still be used as untrusted CAs however.
355 .IP "\fB\-no_signer_cert_verify\fR" 4
356 .IX Item "-no_signer_cert_verify"
357 do not verify the signers certificate of a signed message.
358 .IP "\fB\-nocerts\fR" 4
359 .IX Item "-nocerts"
360 when signing a message the signer's certificate is normally included
361 with this option it is excluded. This will reduce the size of the
362 signed message but the verifier must have a copy of the signers certificate
363 available locally (passed using the \fB\-certfile\fR option for example).
364 .IP "\fB\-noattr\fR" 4
365 .IX Item "-noattr"
366 normally when a message is signed a set of attributes are included which
367 include the signing time and supported symmetric algorithms. With this
368 option they are not included.
369 .IP "\fB\-nosmimecap\fR" 4
370 .IX Item "-nosmimecap"
371 exclude the list of supported algorithms from signed attributes, other options
372 such as signing time and content type are still included.
373 .IP "\fB\-binary\fR" 4
374 .IX Item "-binary"
375 normally the input message is converted to \*(L"canonical\*(R" format which is
376 effectively using \s-1CR\s0 and \s-1LF\s0 as end of line: as required by the S/MIME
377 specification. When this option is present no translation occurs. This
378 is useful when handling binary data which may not be in \s-1MIME\s0 format.
379 .IP "\fB\-nodetach\fR" 4
380 .IX Item "-nodetach"
381 when signing a message use opaque signing: this form is more resistant
382 to translation by mail relays but it cannot be read by mail agents that
383 do not support S/MIME.  Without this option cleartext signing with
384 the \s-1MIME\s0 type multipart/signed is used.
385 .IP "\fB\-certfile file\fR" 4
386 .IX Item "-certfile file"
387 allows additional certificates to be specified. When signing these will
388 be included with the message. When verifying these will be searched for
389 the signers certificates. The certificates should be in \s-1PEM\s0 format.
390 .IP "\fB\-certsout file\fR" 4
391 .IX Item "-certsout file"
392 any certificates contained in the message are written to \fBfile\fR.
393 .IP "\fB\-signer file\fR" 4
394 .IX Item "-signer file"
395 a signing certificate when signing or resigning a message, this option can be
396 used multiple times if more than one signer is required. If a message is being
397 verified then the signers certificates will be written to this file if the
398 verification was successful.
399 .IP "\fB\-recip file\fR" 4
400 .IX Item "-recip file"
401 the recipients certificate when decrypting a message. This certificate
402 must match one of the recipients of the message or an error occurs.
403 .IP "\fB\-keyid\fR" 4
404 .IX Item "-keyid"
405 use subject key identifier to identify certificates instead of issuer name and
406 serial number. The supplied certificate \fBmust\fR include a subject key
407 identifier extension. Supported by \fB\-sign\fR and \fB\-encrypt\fR options.
408 .IP "\fB\-receipt_request_all \-receipt_request_first\fR" 4
409 .IX Item "-receipt_request_all -receipt_request_first"
410 for \fB\-sign\fR option include a signed receipt request. Indicate requests should
411 be provided by all receipient or first tier recipients (those mailed directly
412 and not from a mailing list). Ignored it \fB\-receipt_request_from\fR is included.
413 .IP "\fB\-receipt_request_from emailaddress\fR" 4
414 .IX Item "-receipt_request_from emailaddress"
415 for \fB\-sign\fR option include a signed receipt request. Add an explicit email
416 address where receipts should be supplied.
417 .IP "\fB\-receipt_request_to emailaddress\fR" 4
418 .IX Item "-receipt_request_to emailaddress"
419 Add an explicit email address where signed receipts should be sent to. This 
420 option \fBmust\fR but supplied if a signed receipt it requested.
421 .IP "\fB\-receipt_request_print\fR" 4
422 .IX Item "-receipt_request_print"
423 For the \fB\-verify\fR operation print out the contents of any signed receipt
424 requests.
425 .IP "\fB\-secretkey key\fR" 4
426 .IX Item "-secretkey key"
427 specify symmetric key to use. The key must be supplied in hex format and be
428 consistent with the algorithm used. Supported by the \fB\-EncryptedData_encrypt\fR
429 \&\fB\-EncrryptedData_decrypt\fR, \fB\-encrypt\fR and \fB\-decrypt\fR options. When used
430 with \fB\-encrypt\fR or \fB\-decrypt\fR the supplied key is used to wrap or unwrap the
431 content encryption key using an \s-1AES\s0 key in the \fBKEKRecipientInfo\fR type.
432 .IP "\fB\-secretkeyid id\fR" 4
433 .IX Item "-secretkeyid id"
434 the key identifier for the supplied symmetric key for \fBKEKRecipientInfo\fR type.
435 This option \fBmust\fR be present if the \fB\-secretkey\fR option is used with
436 \&\fB\-encrypt\fR. With \fB\-decrypt\fR operations the \fBid\fR is used to locate the
437 relevant key if it is not supplied then an attempt is used to decrypt any
438 \&\fBKEKRecipientInfo\fR structures.
439 .IP "\fB\-econtent_type type\fR" 4
440 .IX Item "-econtent_type type"
441 set the encapsulated content type to \fBtype\fR if not supplied the \fBData\fR type
442 is used. The \fBtype\fR argument can be any valid \s-1OID\s0 name in either text or
443 numerical format.
444 .IP "\fB\-inkey file\fR" 4
445 .IX Item "-inkey file"
446 the private key to use when signing or decrypting. This must match the
447 corresponding certificate. If this option is not specified then the
448 private key must be included in the certificate file specified with
449 the \fB\-recip\fR or \fB\-signer\fR file. When signing this option can be used
450 multiple times to specify successive keys.
451 .IP "\fB\-passin arg\fR" 4
452 .IX Item "-passin arg"
453 the private key password source. For more information about the format of \fBarg\fR
454 see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
455 .IP "\fB\-rand file(s)\fR" 4
456 .IX Item "-rand file(s)"
457 a file or files containing random data used to seed the random number
458 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
459 Multiple files can be specified separated by a OS-dependent character.
460 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
461 all others.
462 .IP "\fBcert.pem...\fR" 4
463 .IX Item "cert.pem..."
464 one or more certificates of message recipients: used when encrypting
465 a message.
466 .IP "\fB\-to, \-from, \-subject\fR" 4
467 .IX Item "-to, -from, -subject"
468 the relevant mail headers. These are included outside the signed
469 portion of a message so they may be included manually. If signing
470 then many S/MIME mail clients check the signers certificate's email
471 address matches that specified in the From: address.
472 .IP "\fB\-purpose, \-ignore_critical, \-issuer_checks, \-crl_check, \-crl_check_all, \-policy_check, \-extended_crl, \-x509_strict, \-policy \-check_ss_sig\fR" 4
473 .IX Item "-purpose, -ignore_critical, -issuer_checks, -crl_check, -crl_check_all, -policy_check, -extended_crl, -x509_strict, -policy -check_ss_sig"
474 Set various certificate chain valiadition option. See the
475 \&\fBverify\fR manual page for details.
476 .SH "NOTES"
477 .IX Header "NOTES"
478 The \s-1MIME\s0 message must be sent without any blank lines between the
479 headers and the output. Some mail programs will automatically add
480 a blank line. Piping the mail directly to sendmail is one way to
481 achieve the correct format.
482 .PP
483 The supplied message to be signed or encrypted must include the
484 necessary \s-1MIME\s0 headers or many S/MIME clients wont display it
485 properly (if at all). You can use the \fB\-text\fR option to automatically
486 add plain text headers.
487 .PP
488 A \*(L"signed and encrypted\*(R" message is one where a signed message is
489 then encrypted. This can be produced by encrypting an already signed
490 message: see the examples section.
491 .PP
492 This version of the program only allows one signer per message but it
493 will verify multiple signers on received messages. Some S/MIME clients
494 choke if a message contains multiple signers. It is possible to sign
495 messages \*(L"in parallel\*(R" by signing an already signed message.
496 .PP
497 The options \fB\-encrypt\fR and \fB\-decrypt\fR reflect common usage in S/MIME
498 clients. Strictly speaking these process \s-1CMS\s0 enveloped data: \s-1CMS\s0
499 encrypted data is used for other purposes.
500 .PP
501 The \fB\-resign\fR option uses an existing message digest when adding a new
502 signer. This means that attributes must be present in at least one existing
503 signer using the same message digest or this operation will fail.
504 .PP
505 The \fB\-stream\fR and \fB\-indef\fR options enable experimental streaming I/O support.
506 As a result the encoding is \s-1BER\s0 using indefinite length constructed encoding
507 and no longer \s-1DER\s0. Streaming is supported for the \fB\-encrypt\fR operation and the
508 \&\fB\-sign\fR operation if the content is not detached.
509 .PP
510 Streaming is always used for the \fB\-sign\fR operation with detached data but
511 since the content is no longer part of the \s-1CMS\s0 structure the encoding
512 remains \s-1DER\s0.
513 .SH "EXIT CODES"
514 .IX Header "EXIT CODES"
515 .IP "0" 4
516 the operation was completely successfully.
517 .IP "1" 4
518 .IX Item "1"
519 an error occurred parsing the command options.
520 .IP "2" 4
521 .IX Item "2"
522 one of the input files could not be read.
523 .IP "3" 4
524 .IX Item "3"
525 an error occurred creating the \s-1CMS\s0 file or when reading the \s-1MIME\s0
526 message.
527 .IP "4" 4
528 .IX Item "4"
529 an error occurred decrypting or verifying the message.
530 .IP "5" 4
531 .IX Item "5"
532 the message was verified correctly but an error occurred writing out
533 the signers certificates.
534 .SH "COMPATIBILITY WITH PKCS#7 format."
535 .IX Header "COMPATIBILITY WITH PKCS#7 format."
536 The \fBsmime\fR utility can only process the older \fBPKCS#7\fR format. The \fBcms\fR
537 utility supports Cryptographic Message Syntax format. Use of some features
538 will result in messages which cannot be processed by applications which only
539 support the older format. These are detailed below.
540 .PP
541 The use of the \fB\-keyid\fR option with \fB\-sign\fR or \fB\-encrypt\fR.
542 .PP
543 The \fB\-outform \s-1PEM\s0\fR option uses different headers.
544 .PP
545 The \fB\-compress\fR option.
546 .PP
547 The \fB\-secretkey\fR option when used with \fB\-encrypt\fR.
548 .PP
549 Additionally the \fB\-EncryptedData_create\fR and \fB\-data_create\fR type cannot
550 be processed by the older \fBsmime\fR command.
551 .SH "EXAMPLES"
552 .IX Header "EXAMPLES"
553 Create a cleartext signed message:
554 .PP
555 .Vb 2
556 \& openssl cms \-sign \-in message.txt \-text \-out mail.msg \e
557 \&        \-signer mycert.pem
558 .Ve
559 .PP
560 Create an opaque signed message
561 .PP
562 .Vb 2
563 \& openssl cms \-sign \-in message.txt \-text \-out mail.msg \-nodetach \e
564 \&        \-signer mycert.pem
565 .Ve
566 .PP
567 Create a signed message, include some additional certificates and
568 read the private key from another file:
569 .PP
570 .Vb 2
571 \& openssl cms \-sign \-in in.txt \-text \-out mail.msg \e
572 \&        \-signer mycert.pem \-inkey mykey.pem \-certfile mycerts.pem
573 .Ve
574 .PP
575 Create a signed message with two signers, use key identifier:
576 .PP
577 .Vb 2
578 \& openssl cms \-sign \-in message.txt \-text \-out mail.msg \e
579 \&        \-signer mycert.pem \-signer othercert.pem \-keyid
580 .Ve
581 .PP
582 Send a signed message under Unix directly to sendmail, including headers:
583 .PP
584 .Vb 3
585 \& openssl cms \-sign \-in in.txt \-text \-signer mycert.pem \e
586 \&        \-from steve@openssl.org \-to someone@somewhere \e
587 \&        \-subject "Signed message" | sendmail someone@somewhere
588 .Ve
589 .PP
590 Verify a message and extract the signer's certificate if successful:
591 .PP
592 .Vb 1
593 \& openssl cms \-verify \-in mail.msg \-signer user.pem \-out signedtext.txt
594 .Ve
595 .PP
596 Send encrypted mail using triple \s-1DES:\s0
597 .PP
598 .Vb 3
599 \& openssl cms \-encrypt \-in in.txt \-from steve@openssl.org \e
600 \&        \-to someone@somewhere \-subject "Encrypted message" \e
601 \&        \-des3 user.pem \-out mail.msg
602 .Ve
603 .PP
604 Sign and encrypt mail:
605 .PP
606 .Vb 4
607 \& openssl cms \-sign \-in ml.txt \-signer my.pem \-text \e
608 \&        | openssl cms \-encrypt \-out mail.msg \e
609 \&        \-from steve@openssl.org \-to someone@somewhere \e
610 \&        \-subject "Signed and Encrypted message" \-des3 user.pem
611 .Ve
612 .PP
613 Note: the encryption command does not include the \fB\-text\fR option because the
614 message being encrypted already has \s-1MIME\s0 headers.
615 .PP
616 Decrypt mail:
617 .PP
618 .Vb 1
619 \& openssl cms \-decrypt \-in mail.msg \-recip mycert.pem \-inkey key.pem
620 .Ve
621 .PP
622 The output from Netscape form signing is a PKCS#7 structure with the
623 detached signature format. You can use this program to verify the
624 signature by line wrapping the base64 encoded structure and surrounding
625 it with:
626 .PP
627 .Vb 2
628 \& \-\-\-\-\-BEGIN PKCS7\-\-\-\-\-
629 \& \-\-\-\-\-END PKCS7\-\-\-\-\-
630 .Ve
631 .PP
632 and using the command,
633 .PP
634 .Vb 1
635 \& openssl cms \-verify \-inform PEM \-in signature.pem \-content content.txt
636 .Ve
637 .PP
638 alternatively you can base64 decode the signature and use
639 .PP
640 .Vb 1
641 \& openssl cms \-verify \-inform DER \-in signature.der \-content content.txt
642 .Ve
643 .PP
644 Create an encrypted message using 128 bit Camellia:
645 .PP
646 .Vb 1
647 \& openssl cms \-encrypt \-in plain.txt \-camellia128 \-out mail.msg cert.pem
648 .Ve
649 .PP
650 Add a signer to an existing message:
651 .PP
652 .Vb 1
653 \& openssl cms \-resign \-in mail.msg \-signer newsign.pem \-out mail2.msg
654 .Ve
655 .SH "BUGS"
656 .IX Header "BUGS"
657 The \s-1MIME\s0 parser isn't very clever: it seems to handle most messages that I've
658 thrown at it but it may choke on others.
659 .PP
660 The code currently will only write out the signer's certificate to a file: if
661 the signer has a separate encryption certificate this must be manually
662 extracted. There should be some heuristic that determines the correct
663 encryption certificate.
664 .PP
665 Ideally a database should be maintained of a certificates for each email
666 address.
667 .PP
668 The code doesn't currently take note of the permitted symmetric encryption
669 algorithms as supplied in the SMIMECapabilities signed attribute. this means the
670 user has to manually include the correct encryption algorithm. It should store
671 the list of permitted ciphers in a database and only use those.
672 .PP
673 No revocation checking is done on the signer's certificate.
674 .SH "HISTORY"
675 .IX Header "HISTORY"
676 The use of multiple \fB\-signer\fR options and the \fB\-resign\fR command were first
677 added in OpenSSL 1.0.0