1 .\" Automatically generated by Pod::Man 4.10 (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'.
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 .\" ========================================================================
136 .TH CMS 1 "2019-05-28" "1.0.2s" "OpenSSL"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
145 .IX Header "SYNOPSIS"
146 \&\fBopenssl\fR \fBcms\fR
153 [\fB\-data_create\fR]
155 [\fB\-digest_create\fR]
156 [\fB\-digest_verify\fR]
159 [\fB\-EncryptedData_encrypt\fR]
160 [\fB\-sign_receipt\fR]
161 [\fB\-verify_receipt receipt\fR]
162 [\fB\-in filename\fR]
163 [\fB\-inform SMIME|PEM|DER\fR]
164 [\fB\-rctform SMIME|PEM|DER\fR]
165 [\fB\-out filename\fR]
166 [\fB\-outform SMIME|PEM|DER\fR]
167 [\fB\-stream \-indef \-noindef\fR]
169 [\fB\-content filename\fR]
173 [\fB\-CAfile file\fR]
175 [\fB\-no_alt_chains\fR]
179 [\fB\-no_signer_cert_verify\fR]
185 [\fB\-certfile file\fR]
186 [\fB\-certsout file\fR]
187 [\fB\-signer file\fR]
190 [\fB\-receipt_request_all \-receipt_request_first\fR]
191 [\fB\-receipt_request_from emailaddress\fR]
192 [\fB\-receipt_request_to emailaddress\fR]
193 [\fB\-receipt_request_print\fR]
194 [\fB\-secretkey key\fR]
195 [\fB\-secretkeyid id\fR]
196 [\fB\-econtent_type type\fR]
198 [\fB\-keyopt name:parameter\fR]
200 [\fB\-rand file(s)\fR]
204 [\fB\-subject subj\fR]
207 .IX Header "DESCRIPTION"
208 The \fBcms\fR command handles S/MIME v3.1 mail. It can encrypt, decrypt, sign and
209 verify, compress and uncompress S/MIME messages.
210 .SH "COMMAND OPTIONS"
211 .IX Header "COMMAND OPTIONS"
212 There are fourteen operation options that set the type of operation to be
213 performed. The meaning of the other options varies according to the operation
215 .IP "\fB\-encrypt\fR" 4
217 encrypt mail for the given recipient certificates. Input file is the message
218 to be encrypted. The output file is the encrypted mail in \s-1MIME\s0 format. The
219 actual \s-1CMS\s0 type is <B>EnvelopedData<B>.
221 Note that no revocation check is done for the recipient cert, so if that
222 key has been compromised, others may be able to decrypt the text.
223 .IP "\fB\-decrypt\fR" 4
225 decrypt mail using the supplied certificate and private key. Expects an
226 encrypted mail message in \s-1MIME\s0 format for the input file. The decrypted mail
227 is written to the output file.
228 .IP "\fB\-debug_decrypt\fR" 4
229 .IX Item "-debug_decrypt"
230 this option sets the \fB\s-1CMS_DEBUG_DECRYPT\s0\fR flag. This option should be used
231 with caution: see the notes section below.
234 sign mail using the supplied certificate and private key. Input file is
235 the message to be signed. The signed message in \s-1MIME\s0 format is written
237 .IP "\fB\-verify\fR" 4
239 verify signed mail. Expects a signed mail message on input and outputs
240 the signed data. Both clear text and opaque signing is supported.
241 .IP "\fB\-cmsout\fR" 4
243 takes an input message and writes out a \s-1PEM\s0 encoded \s-1CMS\s0 structure.
244 .IP "\fB\-resign\fR" 4
246 resign a message: take an existing message and one or more new signers.
247 .IP "\fB\-data_create\fR" 4
248 .IX Item "-data_create"
249 Create a \s-1CMS\s0 \fBData\fR type.
250 .IP "\fB\-data_out\fR" 4
252 \&\fBData\fR type and output the content.
253 .IP "\fB\-digest_create\fR" 4
254 .IX Item "-digest_create"
255 Create a \s-1CMS\s0 \fBDigestedData\fR type.
256 .IP "\fB\-digest_verify\fR" 4
257 .IX Item "-digest_verify"
258 Verify a \s-1CMS\s0 \fBDigestedData\fR type and output the content.
259 .IP "\fB\-compress\fR" 4
261 Create a \s-1CMS\s0 \fBCompressedData\fR type. OpenSSL must be compiled with \fBzlib\fR
262 support for this option to work, otherwise it will output an error.
263 .IP "\fB\-uncompress\fR" 4
264 .IX Item "-uncompress"
265 Uncompress a \s-1CMS\s0 \fBCompressedData\fR type and output the content. OpenSSL must be
266 compiled with \fBzlib\fR support for this option to work, otherwise it will
268 .IP "\fB\-EncryptedData_encrypt\fR" 4
269 .IX Item "-EncryptedData_encrypt"
270 Encrypt content using supplied symmetric key and algorithm using a \s-1CMS\s0
271 \&\fBEncrytedData\fR type and output the content.
272 .IP "\fB\-sign_receipt\fR" 4
273 .IX Item "-sign_receipt"
274 Generate and output a signed receipt for the supplied message. The input
275 message \fBmust\fR contain a signed receipt request. Functionality is otherwise
276 similar to the \fB\-sign\fR operation.
277 .IP "\fB\-verify_receipt receipt\fR" 4
278 .IX Item "-verify_receipt receipt"
279 Verify a signed receipt in filename \fBreceipt\fR. The input message \fBmust\fR
280 contain the original receipt request. Functionality is otherwise similar
281 to the \fB\-verify\fR operation.
282 .IP "\fB\-in filename\fR" 4
283 .IX Item "-in filename"
284 the input message to be encrypted or signed or the message to be decrypted
286 .IP "\fB\-inform SMIME|PEM|DER\fR" 4
287 .IX Item "-inform SMIME|PEM|DER"
288 this specifies the input format for the \s-1CMS\s0 structure. The default
289 is \fB\s-1SMIME\s0\fR which reads an S/MIME format message. \fB\s-1PEM\s0\fR and \fB\s-1DER\s0\fR
290 format change this to expect \s-1PEM\s0 and \s-1DER\s0 format \s-1CMS\s0 structures
291 instead. This currently only affects the input format of the \s-1CMS\s0
292 structure, if no \s-1CMS\s0 structure is being input (for example with
293 \&\fB\-encrypt\fR or \fB\-sign\fR) this option has no effect.
294 .IP "\fB\-rctform SMIME|PEM|DER\fR" 4
295 .IX Item "-rctform SMIME|PEM|DER"
296 specify the format for a signed receipt for use with the \fB\-receipt_verify\fR
298 .IP "\fB\-out filename\fR" 4
299 .IX Item "-out filename"
300 the message text that has been decrypted or verified or the output \s-1MIME\s0
301 format message that has been signed or verified.
302 .IP "\fB\-outform SMIME|PEM|DER\fR" 4
303 .IX Item "-outform SMIME|PEM|DER"
304 this specifies the output format for the \s-1CMS\s0 structure. The default
305 is \fB\s-1SMIME\s0\fR which writes an S/MIME format message. \fB\s-1PEM\s0\fR and \fB\s-1DER\s0\fR
306 format change this to write \s-1PEM\s0 and \s-1DER\s0 format \s-1CMS\s0 structures
307 instead. This currently only affects the output format of the \s-1CMS\s0
308 structure, if no \s-1CMS\s0 structure is being output (for example with
309 \&\fB\-verify\fR or \fB\-decrypt\fR) this option has no effect.
310 .IP "\fB\-stream \-indef \-noindef\fR" 4
311 .IX Item "-stream -indef -noindef"
312 the \fB\-stream\fR and \fB\-indef\fR options are equivalent and enable streaming I/O
313 for encoding operations. This permits single pass processing of data without
314 the need to hold the entire contents in memory, potentially supporting very
315 large files. Streaming is automatically set for S/MIME signing with detached
316 data if the output format is \fB\s-1SMIME\s0\fR it is currently off by default for all
318 .IP "\fB\-noindef\fR" 4
320 disable streaming I/O where it would produce and indefinite length constructed
321 encoding. This option currently has no effect. In future streaming will be
322 enabled by default on all relevant operations and this option will disable it.
323 .IP "\fB\-content filename\fR" 4
324 .IX Item "-content filename"
325 This specifies a file containing the detached content, this is only
326 useful with the \fB\-verify\fR command. This is only usable if the \s-1CMS\s0
327 structure is using the detached signature form where the content is
328 not included. This option will override any content if the input format
329 is S/MIME and it uses the multipart/signed \s-1MIME\s0 content type.
332 this option adds plain text (text/plain) \s-1MIME\s0 headers to the supplied
333 message if encrypting or signing. If decrypting or verifying it strips
334 off text headers: if the decrypted or verified message is not of \s-1MIME\s0
335 type text/plain then an error occurs.
336 .IP "\fB\-noout\fR" 4
338 for the \fB\-cmsout\fR operation do not output the parsed \s-1CMS\s0 structure. This
339 is useful when combined with the \fB\-print\fR option or if the syntax of the \s-1CMS\s0
340 structure is being checked.
341 .IP "\fB\-print\fR" 4
343 for the \fB\-cmsout\fR operation print out all fields of the \s-1CMS\s0 structure. This
344 is mainly useful for testing purposes.
345 .IP "\fB\-CAfile file\fR" 4
346 .IX Item "-CAfile file"
347 a file containing trusted \s-1CA\s0 certificates, only used with \fB\-verify\fR.
348 .IP "\fB\-CApath dir\fR" 4
349 .IX Item "-CApath dir"
350 a directory containing trusted \s-1CA\s0 certificates, only used with
351 \&\fB\-verify\fR. This directory must be a standard certificate directory: that
352 is a hash of each subject name (using \fBx509 \-hash\fR) should be linked
354 .IP "\fB\-md digest\fR" 4
355 .IX Item "-md digest"
356 digest algorithm to use when signing or resigning. If not present then the
357 default digest algorithm for the signing key will be used (usually \s-1SHA1\s0).
358 .IP "\fB\-[cipher]\fR" 4
360 the encryption algorithm to use. For example triple \s-1DES\s0 (168 bits) \- \fB\-des3\fR
361 or 256 bit \s-1AES\s0 \- \fB\-aes256\fR. Any standard algorithm name (as used by the
362 \&\fBEVP_get_cipherbyname()\fR function) can also be used preceded by a dash, for
363 example \fB\-aes_128_cbc\fR. See \fBenc\fR for a list of ciphers
364 supported by your version of OpenSSL.
366 If not specified triple \s-1DES\s0 is used. Only used with \fB\-encrypt\fR and
367 \&\fB\-EncryptedData_create\fR commands.
368 .IP "\fB\-nointern\fR" 4
370 when verifying a message normally certificates (if any) included in
371 the message are searched for the signing certificate. With this option
372 only the certificates specified in the \fB\-certfile\fR option are used.
373 The supplied certificates can still be used as untrusted CAs however.
374 .IP "\fB\-no_signer_cert_verify\fR" 4
375 .IX Item "-no_signer_cert_verify"
376 do not verify the signers certificate of a signed message.
377 .IP "\fB\-nocerts\fR" 4
379 when signing a message the signer's certificate is normally included
380 with this option it is excluded. This will reduce the size of the
381 signed message but the verifier must have a copy of the signers certificate
382 available locally (passed using the \fB\-certfile\fR option for example).
383 .IP "\fB\-noattr\fR" 4
385 normally when a message is signed a set of attributes are included which
386 include the signing time and supported symmetric algorithms. With this
387 option they are not included.
388 .IP "\fB\-nosmimecap\fR" 4
389 .IX Item "-nosmimecap"
390 exclude the list of supported algorithms from signed attributes, other options
391 such as signing time and content type are still included.
392 .IP "\fB\-binary\fR" 4
394 normally the input message is converted to \*(L"canonical\*(R" format which is
395 effectively using \s-1CR\s0 and \s-1LF\s0 as end of line: as required by the S/MIME
396 specification. When this option is present no translation occurs. This
397 is useful when handling binary data which may not be in \s-1MIME\s0 format.
398 .IP "\fB\-nodetach\fR" 4
400 when signing a message use opaque signing: this form is more resistant
401 to translation by mail relays but it cannot be read by mail agents that
402 do not support S/MIME. Without this option cleartext signing with
403 the \s-1MIME\s0 type multipart/signed is used.
404 .IP "\fB\-certfile file\fR" 4
405 .IX Item "-certfile file"
406 allows additional certificates to be specified. When signing these will
407 be included with the message. When verifying these will be searched for
408 the signers certificates. The certificates should be in \s-1PEM\s0 format.
409 .IP "\fB\-certsout file\fR" 4
410 .IX Item "-certsout file"
411 any certificates contained in the message are written to \fBfile\fR.
412 .IP "\fB\-signer file\fR" 4
413 .IX Item "-signer file"
414 a signing certificate when signing or resigning a message, this option can be
415 used multiple times if more than one signer is required. If a message is being
416 verified then the signers certificates will be written to this file if the
417 verification was successful.
418 .IP "\fB\-recip file\fR" 4
419 .IX Item "-recip file"
420 when decrypting a message this specifies the recipients certificate. The
421 certificate must match one of the recipients of the message or an error
424 When encrypting a message this option may be used multiple times to specify
425 each recipient. This form \fBmust\fR be used if customised parameters are
426 required (for example to specify RSA-OAEP).
428 Only certificates carrying \s-1RSA,\s0 Diffie-Hellman or \s-1EC\s0 keys are supported by this
430 .IP "\fB\-keyid\fR" 4
432 use subject key identifier to identify certificates instead of issuer name and
433 serial number. The supplied certificate \fBmust\fR include a subject key
434 identifier extension. Supported by \fB\-sign\fR and \fB\-encrypt\fR options.
435 .IP "\fB\-receipt_request_all \-receipt_request_first\fR" 4
436 .IX Item "-receipt_request_all -receipt_request_first"
437 for \fB\-sign\fR option include a signed receipt request. Indicate requests should
438 be provided by all receipient or first tier recipients (those mailed directly
439 and not from a mailing list). Ignored it \fB\-receipt_request_from\fR is included.
440 .IP "\fB\-receipt_request_from emailaddress\fR" 4
441 .IX Item "-receipt_request_from emailaddress"
442 for \fB\-sign\fR option include a signed receipt request. Add an explicit email
443 address where receipts should be supplied.
444 .IP "\fB\-receipt_request_to emailaddress\fR" 4
445 .IX Item "-receipt_request_to emailaddress"
446 Add an explicit email address where signed receipts should be sent to. This
447 option \fBmust\fR but supplied if a signed receipt it requested.
448 .IP "\fB\-receipt_request_print\fR" 4
449 .IX Item "-receipt_request_print"
450 For the \fB\-verify\fR operation print out the contents of any signed receipt
452 .IP "\fB\-secretkey key\fR" 4
453 .IX Item "-secretkey key"
454 specify symmetric key to use. The key must be supplied in hex format and be
455 consistent with the algorithm used. Supported by the \fB\-EncryptedData_encrypt\fR
456 \&\fB\-EncrryptedData_decrypt\fR, \fB\-encrypt\fR and \fB\-decrypt\fR options. When used
457 with \fB\-encrypt\fR or \fB\-decrypt\fR the supplied key is used to wrap or unwrap the
458 content encryption key using an \s-1AES\s0 key in the \fBKEKRecipientInfo\fR type.
459 .IP "\fB\-secretkeyid id\fR" 4
460 .IX Item "-secretkeyid id"
461 the key identifier for the supplied symmetric key for \fBKEKRecipientInfo\fR type.
462 This option \fBmust\fR be present if the \fB\-secretkey\fR option is used with
463 \&\fB\-encrypt\fR. With \fB\-decrypt\fR operations the \fBid\fR is used to locate the
464 relevant key if it is not supplied then an attempt is used to decrypt any
465 \&\fBKEKRecipientInfo\fR structures.
466 .IP "\fB\-econtent_type type\fR" 4
467 .IX Item "-econtent_type type"
468 set the encapsulated content type to \fBtype\fR if not supplied the \fBData\fR type
469 is used. The \fBtype\fR argument can be any valid \s-1OID\s0 name in either text or
471 .IP "\fB\-inkey file\fR" 4
472 .IX Item "-inkey file"
473 the private key to use when signing or decrypting. This must match the
474 corresponding certificate. If this option is not specified then the
475 private key must be included in the certificate file specified with
476 the \fB\-recip\fR or \fB\-signer\fR file. When signing this option can be used
477 multiple times to specify successive keys.
478 .IP "\fB\-keyopt name:opt\fR" 4
479 .IX Item "-keyopt name:opt"
480 for signing and encryption this option can be used multiple times to
481 set customised parameters for the preceding key or certificate. It can
482 currently be used to set RSA-PSS for signing, RSA-OAEP for encryption
483 or to modify default parameters for \s-1ECDH.\s0
484 .IP "\fB\-passin arg\fR" 4
485 .IX Item "-passin arg"
486 the private key password source. For more information about the format of \fBarg\fR
487 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fBopenssl\fR\|(1).
488 .IP "\fB\-rand file(s)\fR" 4
489 .IX Item "-rand file(s)"
490 a file or files containing random data used to seed the random number
491 generator, or an \s-1EGD\s0 socket (see \fBRAND_egd\fR\|(3)).
492 Multiple files can be specified separated by a OS-dependent character.
493 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
495 .IP "\fBcert.pem...\fR" 4
496 .IX Item "cert.pem..."
497 one or more certificates of message recipients: used when encrypting
499 .IP "\fB\-to, \-from, \-subject\fR" 4
500 .IX Item "-to, -from, -subject"
501 the relevant mail headers. These are included outside the signed
502 portion of a message so they may be included manually. If signing
503 then many S/MIME mail clients check the signers certificate's email
504 address matches that specified in the From: address.
505 .IP "\fB\-purpose, \-ignore_critical, \-issuer_checks, \-crl_check, \-crl_check_all, \-policy_check, \-extended_crl, \-x509_strict, \-policy \-check_ss_sig \-no_alt_chains\fR" 4
506 .IX Item "-purpose, -ignore_critical, -issuer_checks, -crl_check, -crl_check_all, -policy_check, -extended_crl, -x509_strict, -policy -check_ss_sig -no_alt_chains"
507 Set various certificate chain valiadition option. See the
508 \&\fBverify\fR manual page for details.
511 The \s-1MIME\s0 message must be sent without any blank lines between the
512 headers and the output. Some mail programs will automatically add
513 a blank line. Piping the mail directly to sendmail is one way to
514 achieve the correct format.
516 The supplied message to be signed or encrypted must include the
517 necessary \s-1MIME\s0 headers or many S/MIME clients wont display it
518 properly (if at all). You can use the \fB\-text\fR option to automatically
519 add plain text headers.
521 A \*(L"signed and encrypted\*(R" message is one where a signed message is
522 then encrypted. This can be produced by encrypting an already signed
523 message: see the examples section.
525 This version of the program only allows one signer per message but it
526 will verify multiple signers on received messages. Some S/MIME clients
527 choke if a message contains multiple signers. It is possible to sign
528 messages \*(L"in parallel\*(R" by signing an already signed message.
530 The options \fB\-encrypt\fR and \fB\-decrypt\fR reflect common usage in S/MIME
531 clients. Strictly speaking these process \s-1CMS\s0 enveloped data: \s-1CMS\s0
532 encrypted data is used for other purposes.
534 The \fB\-resign\fR option uses an existing message digest when adding a new
535 signer. This means that attributes must be present in at least one existing
536 signer using the same message digest or this operation will fail.
538 The \fB\-stream\fR and \fB\-indef\fR options enable experimental streaming I/O support.
539 As a result the encoding is \s-1BER\s0 using indefinite length constructed encoding
540 and no longer \s-1DER.\s0 Streaming is supported for the \fB\-encrypt\fR operation and the
541 \&\fB\-sign\fR operation if the content is not detached.
543 Streaming is always used for the \fB\-sign\fR operation with detached data but
544 since the content is no longer part of the \s-1CMS\s0 structure the encoding
547 If the \fB\-decrypt\fR option is used without a recipient certificate then an
548 attempt is made to locate the recipient by trying each potential recipient
549 in turn using the supplied private key. To thwart the \s-1MMA\s0 attack
550 (Bleichenbacher's attack on \s-1PKCS\s0 #1 v1.5 \s-1RSA\s0 padding) all recipients are
551 tried whether they succeed or not and if no recipients match the message
552 is \*(L"decrypted\*(R" using a random key which will typically output garbage.
553 The \fB\-debug_decrypt\fR option can be used to disable the \s-1MMA\s0 attack protection
554 and return an error if no recipient can be found: this option should be used
555 with caution. For a fuller description see \fBCMS_decrypt\fR\|(3)).
557 .IX Header "EXIT CODES"
559 the operation was completely successfully.
562 an error occurred parsing the command options.
565 one of the input files could not be read.
568 an error occurred creating the \s-1CMS\s0 file or when reading the \s-1MIME\s0
572 an error occurred decrypting or verifying the message.
575 the message was verified correctly but an error occurred writing out
576 the signers certificates.
577 .SH "COMPATIBILITY WITH PKCS#7 format."
578 .IX Header "COMPATIBILITY WITH PKCS#7 format."
579 The \fBsmime\fR utility can only process the older \fBPKCS#7\fR format. The \fBcms\fR
580 utility supports Cryptographic Message Syntax format. Use of some features
581 will result in messages which cannot be processed by applications which only
582 support the older format. These are detailed below.
584 The use of the \fB\-keyid\fR option with \fB\-sign\fR or \fB\-encrypt\fR.
586 The \fB\-outform \s-1PEM\s0\fR option uses different headers.
588 The \fB\-compress\fR option.
590 The \fB\-secretkey\fR option when used with \fB\-encrypt\fR.
592 The use of \s-1PSS\s0 with \fB\-sign\fR.
594 The use of \s-1OAEP\s0 or non-RSA keys with \fB\-encrypt\fR.
596 Additionally the \fB\-EncryptedData_create\fR and \fB\-data_create\fR type cannot
597 be processed by the older \fBsmime\fR command.
599 .IX Header "EXAMPLES"
600 Create a cleartext signed message:
603 \& openssl cms \-sign \-in message.txt \-text \-out mail.msg \e
604 \& \-signer mycert.pem
607 Create an opaque signed message
610 \& openssl cms \-sign \-in message.txt \-text \-out mail.msg \-nodetach \e
611 \& \-signer mycert.pem
614 Create a signed message, include some additional certificates and
615 read the private key from another file:
618 \& openssl cms \-sign \-in in.txt \-text \-out mail.msg \e
619 \& \-signer mycert.pem \-inkey mykey.pem \-certfile mycerts.pem
622 Create a signed message with two signers, use key identifier:
625 \& openssl cms \-sign \-in message.txt \-text \-out mail.msg \e
626 \& \-signer mycert.pem \-signer othercert.pem \-keyid
629 Send a signed message under Unix directly to sendmail, including headers:
632 \& openssl cms \-sign \-in in.txt \-text \-signer mycert.pem \e
633 \& \-from steve@openssl.org \-to someone@somewhere \e
634 \& \-subject "Signed message" | sendmail someone@somewhere
637 Verify a message and extract the signer's certificate if successful:
640 \& openssl cms \-verify \-in mail.msg \-signer user.pem \-out signedtext.txt
643 Send encrypted mail using triple \s-1DES:\s0
646 \& openssl cms \-encrypt \-in in.txt \-from steve@openssl.org \e
647 \& \-to someone@somewhere \-subject "Encrypted message" \e
648 \& \-des3 user.pem \-out mail.msg
651 Sign and encrypt mail:
654 \& openssl cms \-sign \-in ml.txt \-signer my.pem \-text \e
655 \& | openssl cms \-encrypt \-out mail.msg \e
656 \& \-from steve@openssl.org \-to someone@somewhere \e
657 \& \-subject "Signed and Encrypted message" \-des3 user.pem
660 Note: the encryption command does not include the \fB\-text\fR option because the
661 message being encrypted already has \s-1MIME\s0 headers.
666 \& openssl cms \-decrypt \-in mail.msg \-recip mycert.pem \-inkey key.pem
669 The output from Netscape form signing is a PKCS#7 structure with the
670 detached signature format. You can use this program to verify the
671 signature by line wrapping the base64 encoded structure and surrounding
675 \& \-\-\-\-\-BEGIN PKCS7\-\-\-\-\-
676 \& \-\-\-\-\-END PKCS7\-\-\-\-\-
679 and using the command,
682 \& openssl cms \-verify \-inform PEM \-in signature.pem \-content content.txt
685 alternatively you can base64 decode the signature and use
688 \& openssl cms \-verify \-inform DER \-in signature.der \-content content.txt
691 Create an encrypted message using 128 bit Camellia:
694 \& openssl cms \-encrypt \-in plain.txt \-camellia128 \-out mail.msg cert.pem
697 Add a signer to an existing message:
700 \& openssl cms \-resign \-in mail.msg \-signer newsign.pem \-out mail2.msg
703 Sign mail using RSA-PSS:
706 \& openssl cms \-sign \-in message.txt \-text \-out mail.msg \e
707 \& \-signer mycert.pem \-keyopt rsa_padding_mode:pss
710 Create encrypted mail using RSA-OAEP:
713 \& openssl cms \-encrypt \-in plain.txt \-out mail.msg \e
714 \& \-recip cert.pem \-keyopt rsa_padding_mode:oaep
717 Use \s-1SHA256 KDF\s0 with an \s-1ECDH\s0 certificate:
720 \& openssl cms \-encrypt \-in plain.txt \-out mail.msg \e
721 \& \-recip ecdhcert.pem \-keyopt ecdh_kdf_md:sha256
725 The \s-1MIME\s0 parser isn't very clever: it seems to handle most messages that I've
726 thrown at it but it may choke on others.
728 The code currently will only write out the signer's certificate to a file: if
729 the signer has a separate encryption certificate this must be manually
730 extracted. There should be some heuristic that determines the correct
731 encryption certificate.
733 Ideally a database should be maintained of a certificates for each email
736 The code doesn't currently take note of the permitted symmetric encryption
737 algorithms as supplied in the SMIMECapabilities signed attribute. this means the
738 user has to manually include the correct encryption algorithm. It should store
739 the list of permitted ciphers in a database and only use those.
741 No revocation checking is done on the signer's certificate.
744 The use of multiple \fB\-signer\fR options and the \fB\-resign\fR command were first
745 added in OpenSSL 1.0.0.
747 The \fBkeyopt\fR option was first added in OpenSSL 1.0.2.
749 Support for RSA-OAEP and RSA-PSS was first added to OpenSSL 1.0.2.
751 The use of non-RSA keys with \fB\-encrypt\fR and \fB\-decrypt\fR was first added
754 The \-no_alt_chains options was first added to OpenSSL 1.0.2b.
projects / FreeBSD / FreeBSD.git / blob