22 [B<-EncryptedData_encrypt>]
24 [B<-verify_receipt receipt>]
26 [B<-inform SMIME|PEM|DER>]
27 [B<-rctform SMIME|PEM|DER>]
29 [B<-outform SMIME|PEM|DER>]
30 [B<-stream -indef -noindef>]
32 [B<-content filename>]
42 [B<-no_signer_cert_verify>]
53 [B<-receipt_request_all -receipt_request_first>]
54 [B<-receipt_request_from emailaddress>]
55 [B<-receipt_request_to emailaddress>]
56 [B<-receipt_request_print>]
59 [B<-econtent_type type>]
61 [B<-keyopt name:parameter>]
72 The B<cms> command handles S/MIME v3.1 mail. It can encrypt, decrypt, sign and
73 verify, compress and uncompress S/MIME messages.
75 =head1 COMMAND OPTIONS
77 There are fourteen operation options that set the type of operation to be
78 performed. The meaning of the other options varies according to the operation
85 encrypt mail for the given recipient certificates. Input file is the message
86 to be encrypted. The output file is the encrypted mail in MIME format. The
87 actual CMS type is <B>EnvelopedData<B>.
91 decrypt mail using the supplied certificate and private key. Expects an
92 encrypted mail message in MIME format for the input file. The decrypted mail
93 is written to the output file.
95 =item B<-debug_decrypt>
97 this option sets the B<CMS_DEBUG_DECRYPT> flag. This option should be used
98 with caution: see the notes section below.
102 sign mail using the supplied certificate and private key. Input file is
103 the message to be signed. The signed message in MIME format is written
108 verify signed mail. Expects a signed mail message on input and outputs
109 the signed data. Both clear text and opaque signing is supported.
113 takes an input message and writes out a PEM encoded CMS structure.
117 resign a message: take an existing message and one or more new signers.
119 =item B<-data_create>
121 Create a CMS B<Data> type.
125 B<Data> type and output the content.
127 =item B<-digest_create>
129 Create a CMS B<DigestedData> type.
131 =item B<-digest_verify>
133 Verify a CMS B<DigestedData> type and output the content.
137 Create a CMS B<CompressedData> type. OpenSSL must be compiled with B<zlib>
138 support for this option to work, otherwise it will output an error.
142 Uncompress a CMS B<CompressedData> type and output the content. OpenSSL must be
143 compiled with B<zlib> support for this option to work, otherwise it will
146 =item B<-EncryptedData_encrypt>
148 Encrypt content using supplied symmetric key and algorithm using a CMS
149 B<EncrytedData> type and output the content.
151 =item B<-sign_receipt>
153 Generate and output a signed receipt for the supplied message. The input
154 message B<must> contain a signed receipt request. Functionality is otherwise
155 similar to the B<-sign> operation.
157 =item B<-verify_receipt receipt>
159 Verify a signed receipt in filename B<receipt>. The input message B<must>
160 contain the original receipt request. Functionality is otherwise similar
161 to the B<-verify> operation.
163 =item B<-in filename>
165 the input message to be encrypted or signed or the message to be decrypted
168 =item B<-inform SMIME|PEM|DER>
170 this specifies the input format for the CMS structure. The default
171 is B<SMIME> which reads an S/MIME format message. B<PEM> and B<DER>
172 format change this to expect PEM and DER format CMS structures
173 instead. This currently only affects the input format of the CMS
174 structure, if no CMS structure is being input (for example with
175 B<-encrypt> or B<-sign>) this option has no effect.
177 =item B<-rctform SMIME|PEM|DER>
179 specify the format for a signed receipt for use with the B<-receipt_verify>
182 =item B<-out filename>
184 the message text that has been decrypted or verified or the output MIME
185 format message that has been signed or verified.
187 =item B<-outform SMIME|PEM|DER>
189 this specifies the output format for the CMS structure. The default
190 is B<SMIME> which writes an S/MIME format message. B<PEM> and B<DER>
191 format change this to write PEM and DER format CMS structures
192 instead. This currently only affects the output format of the CMS
193 structure, if no CMS structure is being output (for example with
194 B<-verify> or B<-decrypt>) this option has no effect.
196 =item B<-stream -indef -noindef>
198 the B<-stream> and B<-indef> options are equivalent and enable streaming I/O
199 for encoding operations. This permits single pass processing of data without
200 the need to hold the entire contents in memory, potentially supporting very
201 large files. Streaming is automatically set for S/MIME signing with detached
202 data if the output format is B<SMIME> it is currently off by default for all
207 disable streaming I/O where it would produce and indefinite length constructed
208 encoding. This option currently has no effect. In future streaming will be
209 enabled by default on all relevant operations and this option will disable it.
211 =item B<-content filename>
213 This specifies a file containing the detached content, this is only
214 useful with the B<-verify> command. This is only usable if the CMS
215 structure is using the detached signature form where the content is
216 not included. This option will override any content if the input format
217 is S/MIME and it uses the multipart/signed MIME content type.
221 this option adds plain text (text/plain) MIME headers to the supplied
222 message if encrypting or signing. If decrypting or verifying it strips
223 off text headers: if the decrypted or verified message is not of MIME
224 type text/plain then an error occurs.
228 for the B<-cmsout> operation do not output the parsed CMS structure. This
229 is useful when combined with the B<-print> option or if the syntax of the CMS
230 structure is being checked.
234 for the B<-cmsout> operation print out all fields of the CMS structure. This
235 is mainly useful for testing purposes.
237 =item B<-CAfile file>
239 a file containing trusted CA certificates, only used with B<-verify>.
243 a directory containing trusted CA certificates, only used with
244 B<-verify>. This directory must be a standard certificate directory: that
245 is a hash of each subject name (using B<x509 -hash>) should be linked
250 digest algorithm to use when signing or resigning. If not present then the
251 default digest algorithm for the signing key will be used (usually SHA1).
255 the encryption algorithm to use. For example triple DES (168 bits) - B<-des3>
256 or 256 bit AES - B<-aes256>. Any standard algorithm name (as used by the
257 EVP_get_cipherbyname() function) can also be used preceded by a dash, for
258 example B<-aes_128_cbc>. See L<B<enc>|enc(1)> for a list of ciphers
259 supported by your version of OpenSSL.
261 If not specified triple DES is used. Only used with B<-encrypt> and
262 B<-EncryptedData_create> commands.
266 when verifying a message normally certificates (if any) included in
267 the message are searched for the signing certificate. With this option
268 only the certificates specified in the B<-certfile> option are used.
269 The supplied certificates can still be used as untrusted CAs however.
271 =item B<-no_signer_cert_verify>
273 do not verify the signers certificate of a signed message.
277 when signing a message the signer's certificate is normally included
278 with this option it is excluded. This will reduce the size of the
279 signed message but the verifier must have a copy of the signers certificate
280 available locally (passed using the B<-certfile> option for example).
284 normally when a message is signed a set of attributes are included which
285 include the signing time and supported symmetric algorithms. With this
286 option they are not included.
290 exclude the list of supported algorithms from signed attributes, other options
291 such as signing time and content type are still included.
295 normally the input message is converted to "canonical" format which is
296 effectively using CR and LF as end of line: as required by the S/MIME
297 specification. When this option is present no translation occurs. This
298 is useful when handling binary data which may not be in MIME format.
302 when signing a message use opaque signing: this form is more resistant
303 to translation by mail relays but it cannot be read by mail agents that
304 do not support S/MIME. Without this option cleartext signing with
305 the MIME type multipart/signed is used.
307 =item B<-certfile file>
309 allows additional certificates to be specified. When signing these will
310 be included with the message. When verifying these will be searched for
311 the signers certificates. The certificates should be in PEM format.
313 =item B<-certsout file>
315 any certificates contained in the message are written to B<file>.
317 =item B<-signer file>
319 a signing certificate when signing or resigning a message, this option can be
320 used multiple times if more than one signer is required. If a message is being
321 verified then the signers certificates will be written to this file if the
322 verification was successful.
326 when decrypting a message this specifies the recipients certificate. The
327 certificate must match one of the recipients of the message or an error
330 When encrypting a message this option may be used multiple times to specify
331 each recipient. This form B<must> be used if customised parameters are
332 required (for example to specify RSA-OAEP).
336 use subject key identifier to identify certificates instead of issuer name and
337 serial number. The supplied certificate B<must> include a subject key
338 identifier extension. Supported by B<-sign> and B<-encrypt> options.
340 =item B<-receipt_request_all -receipt_request_first>
342 for B<-sign> option include a signed receipt request. Indicate requests should
343 be provided by all receipient or first tier recipients (those mailed directly
344 and not from a mailing list). Ignored it B<-receipt_request_from> is included.
346 =item B<-receipt_request_from emailaddress>
348 for B<-sign> option include a signed receipt request. Add an explicit email
349 address where receipts should be supplied.
351 =item B<-receipt_request_to emailaddress>
353 Add an explicit email address where signed receipts should be sent to. This
354 option B<must> but supplied if a signed receipt it requested.
356 =item B<-receipt_request_print>
358 For the B<-verify> operation print out the contents of any signed receipt
361 =item B<-secretkey key>
363 specify symmetric key to use. The key must be supplied in hex format and be
364 consistent with the algorithm used. Supported by the B<-EncryptedData_encrypt>
365 B<-EncrryptedData_decrypt>, B<-encrypt> and B<-decrypt> options. When used
366 with B<-encrypt> or B<-decrypt> the supplied key is used to wrap or unwrap the
367 content encryption key using an AES key in the B<KEKRecipientInfo> type.
369 =item B<-secretkeyid id>
371 the key identifier for the supplied symmetric key for B<KEKRecipientInfo> type.
372 This option B<must> be present if the B<-secretkey> option is used with
373 B<-encrypt>. With B<-decrypt> operations the B<id> is used to locate the
374 relevant key if it is not supplied then an attempt is used to decrypt any
375 B<KEKRecipientInfo> structures.
377 =item B<-econtent_type type>
379 set the encapsulated content type to B<type> if not supplied the B<Data> type
380 is used. The B<type> argument can be any valid OID name in either text or
385 the private key to use when signing or decrypting. This must match the
386 corresponding certificate. If this option is not specified then the
387 private key must be included in the certificate file specified with
388 the B<-recip> or B<-signer> file. When signing this option can be used
389 multiple times to specify successive keys.
391 =item B<-keyopt name:opt>
393 for signing and encryption this option can be used multiple times to
394 set customised parameters for the preceding key or certificate. It can
395 currently be used to set RSA-PSS for signing, RSA-OAEP for encryption
396 or to modify default parameters for ECDH.
400 the private key password source. For more information about the format of B<arg>
401 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)|openssl(1)>.
403 =item B<-rand file(s)>
405 a file or files containing random data used to seed the random number
406 generator, or an EGD socket (see L<RAND_egd(3)|RAND_egd(3)>).
407 Multiple files can be specified separated by a OS-dependent character.
408 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
413 one or more certificates of message recipients: used when encrypting
416 =item B<-to, -from, -subject>
418 the relevant mail headers. These are included outside the signed
419 portion of a message so they may be included manually. If signing
420 then many S/MIME mail clients check the signers certificate's email
421 address matches that specified in the From: address.
423 =item B<-purpose, -ignore_critical, -issuer_checks, -crl_check, -crl_check_all, -policy_check, -extended_crl, -x509_strict, -policy -check_ss_sig -no_alt_chains>
425 Set various certificate chain valiadition option. See the
426 L<B<verify>|verify(1)> manual page for details.
432 The MIME message must be sent without any blank lines between the
433 headers and the output. Some mail programs will automatically add
434 a blank line. Piping the mail directly to sendmail is one way to
435 achieve the correct format.
437 The supplied message to be signed or encrypted must include the
438 necessary MIME headers or many S/MIME clients wont display it
439 properly (if at all). You can use the B<-text> option to automatically
440 add plain text headers.
442 A "signed and encrypted" message is one where a signed message is
443 then encrypted. This can be produced by encrypting an already signed
444 message: see the examples section.
446 This version of the program only allows one signer per message but it
447 will verify multiple signers on received messages. Some S/MIME clients
448 choke if a message contains multiple signers. It is possible to sign
449 messages "in parallel" by signing an already signed message.
451 The options B<-encrypt> and B<-decrypt> reflect common usage in S/MIME
452 clients. Strictly speaking these process CMS enveloped data: CMS
453 encrypted data is used for other purposes.
455 The B<-resign> option uses an existing message digest when adding a new
456 signer. This means that attributes must be present in at least one existing
457 signer using the same message digest or this operation will fail.
459 The B<-stream> and B<-indef> options enable experimental streaming I/O support.
460 As a result the encoding is BER using indefinite length constructed encoding
461 and no longer DER. Streaming is supported for the B<-encrypt> operation and the
462 B<-sign> operation if the content is not detached.
464 Streaming is always used for the B<-sign> operation with detached data but
465 since the content is no longer part of the CMS structure the encoding
468 If the B<-decrypt> option is used without a recipient certificate then an
469 attempt is made to locate the recipient by trying each potential recipient
470 in turn using the supplied private key. To thwart the MMA attack
471 (Bleichenbacher's attack on PKCS #1 v1.5 RSA padding) all recipients are
472 tried whether they succeed or not and if no recipients match the message
473 is "decrypted" using a random key which will typically output garbage.
474 The B<-debug_decrypt> option can be used to disable the MMA attack protection
475 and return an error if no recipient can be found: this option should be used
476 with caution. For a fuller description see L<CMS_decrypt(3)|CMS_decrypt(3)>).
484 the operation was completely successfully.
488 an error occurred parsing the command options.
492 one of the input files could not be read.
496 an error occurred creating the CMS file or when reading the MIME
501 an error occurred decrypting or verifying the message.
505 the message was verified correctly but an error occurred writing out
506 the signers certificates.
510 =head1 COMPATIBILITY WITH PKCS#7 format.
512 The B<smime> utility can only process the older B<PKCS#7> format. The B<cms>
513 utility supports Cryptographic Message Syntax format. Use of some features
514 will result in messages which cannot be processed by applications which only
515 support the older format. These are detailed below.
517 The use of the B<-keyid> option with B<-sign> or B<-encrypt>.
519 The B<-outform PEM> option uses different headers.
521 The B<-compress> option.
523 The B<-secretkey> option when used with B<-encrypt>.
525 The use of PSS with B<-sign>.
527 The use of OAEP or non-RSA keys with B<-encrypt>.
529 Additionally the B<-EncryptedData_create> and B<-data_create> type cannot
530 be processed by the older B<smime> command.
534 Create a cleartext signed message:
536 openssl cms -sign -in message.txt -text -out mail.msg \
539 Create an opaque signed message
541 openssl cms -sign -in message.txt -text -out mail.msg -nodetach \
544 Create a signed message, include some additional certificates and
545 read the private key from another file:
547 openssl cms -sign -in in.txt -text -out mail.msg \
548 -signer mycert.pem -inkey mykey.pem -certfile mycerts.pem
550 Create a signed message with two signers, use key identifier:
552 openssl cms -sign -in message.txt -text -out mail.msg \
553 -signer mycert.pem -signer othercert.pem -keyid
555 Send a signed message under Unix directly to sendmail, including headers:
557 openssl cms -sign -in in.txt -text -signer mycert.pem \
558 -from steve@openssl.org -to someone@somewhere \
559 -subject "Signed message" | sendmail someone@somewhere
561 Verify a message and extract the signer's certificate if successful:
563 openssl cms -verify -in mail.msg -signer user.pem -out signedtext.txt
565 Send encrypted mail using triple DES:
567 openssl cms -encrypt -in in.txt -from steve@openssl.org \
568 -to someone@somewhere -subject "Encrypted message" \
569 -des3 user.pem -out mail.msg
571 Sign and encrypt mail:
573 openssl cms -sign -in ml.txt -signer my.pem -text \
574 | openssl cms -encrypt -out mail.msg \
575 -from steve@openssl.org -to someone@somewhere \
576 -subject "Signed and Encrypted message" -des3 user.pem
578 Note: the encryption command does not include the B<-text> option because the
579 message being encrypted already has MIME headers.
583 openssl cms -decrypt -in mail.msg -recip mycert.pem -inkey key.pem
585 The output from Netscape form signing is a PKCS#7 structure with the
586 detached signature format. You can use this program to verify the
587 signature by line wrapping the base64 encoded structure and surrounding
590 -----BEGIN PKCS7-----
593 and using the command,
595 openssl cms -verify -inform PEM -in signature.pem -content content.txt
597 alternatively you can base64 decode the signature and use
599 openssl cms -verify -inform DER -in signature.der -content content.txt
601 Create an encrypted message using 128 bit Camellia:
603 openssl cms -encrypt -in plain.txt -camellia128 -out mail.msg cert.pem
605 Add a signer to an existing message:
607 openssl cms -resign -in mail.msg -signer newsign.pem -out mail2.msg
609 Sign mail using RSA-PSS:
611 openssl cms -sign -in message.txt -text -out mail.msg \
612 -signer mycert.pem -keyopt rsa_padding_mode:pss
614 Create encrypted mail using RSA-OAEP:
616 openssl cms -encrypt -in plain.txt -out mail.msg \
617 -recip cert.pem -keyopt rsa_padding_mode:oaep
619 Use SHA256 KDF with an ECDH certificate:
621 openssl cms -encrypt -in plain.txt -out mail.msg \
622 -recip ecdhcert.pem -keyopt ecdh_kdf_md:sha256
626 The MIME parser isn't very clever: it seems to handle most messages that I've
627 thrown at it but it may choke on others.
629 The code currently will only write out the signer's certificate to a file: if
630 the signer has a separate encryption certificate this must be manually
631 extracted. There should be some heuristic that determines the correct
632 encryption certificate.
634 Ideally a database should be maintained of a certificates for each email
637 The code doesn't currently take note of the permitted symmetric encryption
638 algorithms as supplied in the SMIMECapabilities signed attribute. this means the
639 user has to manually include the correct encryption algorithm. It should store
640 the list of permitted ciphers in a database and only use those.
642 No revocation checking is done on the signer's certificate.
646 The use of multiple B<-signer> options and the B<-resign> command were first
647 added in OpenSSL 1.0.0
649 The B<keyopt> option was first added in OpenSSL 1.1.0
651 The use of B<-recip> to specify the recipient when encrypting mail was first
652 added to OpenSSL 1.1.0
654 Support for RSA-OAEP and RSA-PSS was first added to OpenSSL 1.1.0.
656 The use of non-RSA keys with B<-encrypt> and B<-decrypt> was first added
659 The -no_alt_chains options was first added to OpenSSL 1.0.2b.