$NetBSD: openssl_cms.1,v 1.14 2015/06/12 17:01:14 christos Exp $

Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)

Standard preamble:
========================================================================
..

..

.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is turned on, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "CMS 1" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
cms - CMS utility libcrypto, -lcrypto Header "SYNOPSIS" \fBopenssl cms [-encrypt] [-decrypt] [-sign] [-verify] [-cmsout] [-resign] [-data_create] [-data_out] [-digest_create] [-digest_verify] [-compress] [-uncompress] [-EncryptedData_encrypt] [-sign_receipt] [-verify_receipt receipt] [-in filename] [-inform SMIME|PEM|DER] [-rctform SMIME|PEM|DER] [-out filename] [-outform SMIME|PEM|DER] [-stream -indef -noindef] [-noindef] [-content filename] [-text] [-noout] [-print] [-CAfile file] [-CApath dir] [-no_alt_chains] [-md digest] [-[cipher]] [-nointern] [-no_signer_cert_verify] [-nocerts] [-noattr] [-nosmimecap] [-binary] [-nodetach] [-certfile file] [-certsout file] [-signer file] [-recip file] [-keyid] [-receipt_request_all -receipt_request_first] [-receipt_request_from emailaddress] [-receipt_request_to emailaddress] [-receipt_request_print] [-secretkey key] [-secretkeyid id] [-econtent_type type] [-inkey file] [-passin arg] [-rand file(s)] [cert.pem...] [-to addr] [-from addr] [-subject subj] [cert.pem]... Header "DESCRIPTION" The cms command handles S/MIME v3.1 mail. It can encrypt, decrypt, sign and verify, compress and uncompress S/MIME messages. Header "COMMAND OPTIONS" There are fourteen operation options that set the type of operation to be performed. The meaning of the other options varies according to the operation type. Item "-encrypt" encrypt mail for the given recipient certificates. Input file is the message to be encrypted. The output file is the encrypted mail in \s-1MIME\s0 format. The actual \s-1CMS\s0 type is <B>EnvelopedData<B>. Item "-decrypt" decrypt mail using the supplied certificate and private key. Expects an encrypted mail message in \s-1MIME\s0 format for the input file. The decrypted mail is written to the output file. Item "-debug_decrypt" this option sets the \s-1CMS_DEBUG_DECRYPT\s0 flag. This option should be used with caution: see the notes section below. Item "-sign" sign mail using the supplied certificate and private key. Input file is the message to be signed. The signed message in \s-1MIME\s0 format is written to the output file. Item "-verify" verify signed mail. Expects a signed mail message on input and outputs the signed data. Both clear text and opaque signing is supported. Item "-cmsout" takes an input message and writes out a \s-1PEM\s0 encoded \s-1CMS\s0 structure. Item "-resign" resign a message: take an existing message and one or more new signers. Item "-data_create" Create a \s-1CMS \s0Data type. Item "-data_out" \fBData type and output the content. Item "-digest_create" Create a \s-1CMS \s0DigestedData type. Item "-digest_verify" Verify a \s-1CMS \s0DigestedData type and output the content. Item "-compress" Create a \s-1CMS \s0CompressedData type. OpenSSL must be compiled with zlib support for this option to work, otherwise it will output an error. Item "-uncompress" Uncompress a \s-1CMS \s0CompressedData type and output the content. OpenSSL must be compiled with zlib support for this option to work, otherwise it will output an error. Item "-EncryptedData_encrypt" Encrypt content using supplied symmetric key and algorithm using a \s-1CMS \s0EncrytedData type and output the content. Item "-sign_receipt" Generate and output a signed receipt for the supplied message. The input message must contain a signed receipt request. Functionality is otherwise similar to the -sign operation. Item "-verify_receipt receipt" Verify a signed receipt in filename receipt. The input message must contain the original receipt request. Functionality is otherwise similar to the -verify operation. Item "-in filename" the input message to be encrypted or signed or the message to be decrypted or verified. Item "-inform SMIME|PEM|DER" this specifies the input format for the \s-1CMS\s0 structure. The default is \s-1SMIME\s0 which reads an S/MIME format message. \s-1PEM\s0 and \s-1DER\s0 format change this to expect \s-1PEM\s0 and \s-1DER\s0 format \s-1CMS\s0 structures instead. This currently only affects the input format of the \s-1CMS\s0 structure, if no \s-1CMS\s0 structure is being input (for example with \fB-encrypt or -sign) this option has no effect. Item "-rctform SMIME|PEM|DER" specify the format for a signed receipt for use with the -receipt_verify operation. Item "-out filename" the message text that has been decrypted or verified or the output \s-1MIME\s0 format message that has been signed or verified. Item "-outform SMIME|PEM|DER" this specifies the output format for the \s-1CMS\s0 structure. The default is \s-1SMIME\s0 which writes an S/MIME format message. \s-1PEM\s0 and \s-1DER\s0 format change this to write \s-1PEM\s0 and \s-1DER\s0 format \s-1CMS\s0 structures instead. This currently only affects the output format of the \s-1CMS\s0 structure, if no \s-1CMS\s0 structure is being output (for example with \fB-verify or -decrypt) this option has no effect. Item "-stream -indef -noindef" the -stream and -indef options are equivalent and enable streaming I/O for encoding operations. This permits single pass processing of data without the need to hold the entire contents in memory, potentially supporting very large files. Streaming is automatically set for S/MIME signing with detached data if the output format is \s-1SMIME\s0 it is currently off by default for all other operations. Item "-noindef" disable streaming I/O where it would produce and indefinite length constructed encoding. This option currently has no effect. In future streaming will be enabled by default on all relevant operations and this option will disable it. Item "-content filename" This specifies a file containing the detached content, this is only useful with the -verify command. This is only usable if the \s-1CMS\s0 structure is using the detached signature form where the content is not included. This option will override any content if the input format is S/MIME and it uses the multipart/signed \s-1MIME\s0 content type. Item "-text" this option adds plain text (text/plain) \s-1MIME\s0 headers to the supplied message if encrypting or signing. If decrypting or verifying it strips off text headers: if the decrypted or verified message is not of \s-1MIME \s0 type text/plain then an error occurs. Item "-noout" for the -cmsout operation do not output the parsed \s-1CMS\s0 structure. This is useful when combined with the -print option or if the syntax of the \s-1CMS\s0 structure is being checked. Item "-print" for the -cmsout operation print out all fields of the \s-1CMS\s0 structure. This is mainly useful for testing purposes. Item "-CAfile file" a file containing trusted \s-1CA\s0 certificates, only used with -verify. Item "-CApath dir" a directory containing trusted \s-1CA\s0 certificates, only used with \fB-verify. This directory must be a standard certificate directory: that is a hash of each subject name (using x509 -hash) should be linked to each certificate. Item "-md digest" digest algorithm to use when signing or resigning. If not present then the default digest algorithm for the signing key will be used (usually \s-1SHA1\s0). Item "-[cipher]" the encryption algorithm to use. For example triple \s-1DES \s0(168 bits) - -des3 or 256 bit \s-1AES - \s0-aes256. Any standard algorithm name (as used by the \fIEVP_get_cipherbyname() function) can also be used preceded by a dash, for example -aes_128_cbc. See enc for a list of ciphers supported by your version of OpenSSL. .Sp If not specified triple \s-1DES\s0 is used. Only used with -encrypt and \fB-EncryptedData_create commands. Item "-nointern" when verifying a message normally certificates (if any) included in the message are searched for the signing certificate. With this option only the certificates specified in the -certfile option are used. The supplied certificates can still be used as untrusted CAs however. Item "-no_signer_cert_verify" do not verify the signers certificate of a signed message. Item "-nocerts" when signing a message the signer's certificate is normally included with this option it is excluded. This will reduce the size of the signed message but the verifier must have a copy of the signers certificate available locally (passed using the -certfile option for example). Item "-noattr" normally when a message is signed a set of attributes are included which include the signing time and supported symmetric algorithms. With this option they are not included. Item "-nosmimecap" exclude the list of supported algorithms from signed attributes, other options such as signing time and content type are still included. Item "-binary" normally the input message is converted to \*(L"canonical\*(R" format which is effectively using \s-1CR\s0 and \s-1LF\s0 as end of line: as required by the S/MIME specification. When this option is present no translation occurs. This is useful when handling binary data which may not be in \s-1MIME\s0 format. Item "-nodetach" when signing a message use opaque signing: this form is more resistant to translation by mail relays but it cannot be read by mail agents that do not support S/MIME. Without this option cleartext signing with the \s-1MIME\s0 type multipart/signed is used. Item "-certfile file" allows additional certificates to be specified. When signing these will be included with the message. When verifying these will be searched for the signers certificates. The certificates should be in \s-1PEM\s0 format. Item "-certsout file" any certificates contained in the message are written to file. Item "-signer file" a signing certificate when signing or resigning a message, this option can be used multiple times if more than one signer is required. If a message is being verified then the signers certificates will be written to this file if the verification was successful. Item "-recip file" the recipients certificate when decrypting a message. This certificate must match one of the recipients of the message or an error occurs. Item "-keyid" use subject key identifier to identify certificates instead of issuer name and serial number. The supplied certificate must include a subject key identifier extension. Supported by -sign and -encrypt options. Item "-receipt_request_all -receipt_request_first" for -sign option include a signed receipt request. Indicate requests should be provided by all receipient or first tier recipients (those mailed directly and not from a mailing list). Ignored it -receipt_request_from is included. Item "-receipt_request_from emailaddress" for -sign option include a signed receipt request. Add an explicit email address where receipts should be supplied. Item "-receipt_request_to emailaddress" Add an explicit email address where signed receipts should be sent to. This option must but supplied if a signed receipt it requested. Item "-receipt_request_print" For the -verify operation print out the contents of any signed receipt requests. Item "-secretkey key" specify symmetric key to use. The key must be supplied in hex format and be consistent with the algorithm used. Supported by the -EncryptedData_encrypt \fB-EncrryptedData_decrypt, -encrypt and -decrypt options. When used with -encrypt or -decrypt the supplied key is used to wrap or unwrap the content encryption key using an \s-1AES\s0 key in the KEKRecipientInfo type. Item "-secretkeyid id" the key identifier for the supplied symmetric key for KEKRecipientInfo type. This option must be present if the -secretkey option is used with \fB-encrypt. With -decrypt operations the id is used to locate the relevant key if it is not supplied then an attempt is used to decrypt any \fBKEKRecipientInfo structures. Item "-econtent_type type" set the encapsulated content type to type if not supplied the Data type is used. The type argument can be any valid \s-1OID\s0 name in either text or numerical format. Item "-inkey file" the private key to use when signing or decrypting. This must match the corresponding certificate. If this option is not specified then the private key must be included in the certificate file specified with the -recip or -signer file. When signing this option can be used multiple times to specify successive keys. Item "-passin arg" the private key password source. For more information about the format of arg see the \s-1PASS PHRASE ARGUMENTS\s0 section in openssl\|(1). Item "-rand file(s)" a file or files containing random data used to seed the random number generator, or an \s-1EGD\s0 socket (see RAND_egd\|(3)). Multiple files can be specified separated by a OS-dependent character. The separator is ; for MS-Windows, , for OpenVMS, and : for all others. Item "cert.pem..." one or more certificates of message recipients: used when encrypting a message. Item "-to, -from, -subject" the relevant mail headers. These are included outside the signed portion of a message so they may be included manually. If signing then many S/MIME mail clients check the signers certificate's email address matches that specified in the From: address. Item "-purpose, -ignore_critical, -issuer_checks, -crl_check, -crl_check_all, -policy_check, -extended_crl, -x509_strict, -policy -check_ss_sig -no_alt_chains" Set various certificate chain valiadition option. See the \fBverify manual page for details. Header "NOTES" The \s-1MIME\s0 message must be sent without any blank lines between the headers and the output. Some mail programs will automatically add a blank line. Piping the mail directly to sendmail is one way to achieve the correct format.

The supplied message to be signed or encrypted must include the necessary \s-1MIME\s0 headers or many S/MIME clients wont display it properly (if at all). You can use the -text option to automatically add plain text headers.

A \*(L"signed and encrypted\*(R" message is one where a signed message is then encrypted. This can be produced by encrypting an already signed message: see the examples section.

This version of the program only allows one signer per message but it will verify multiple signers on received messages. Some S/MIME clients choke if a message contains multiple signers. It is possible to sign messages \*(L"in parallel\*(R" by signing an already signed message.

The options -encrypt and -decrypt reflect common usage in S/MIME clients. Strictly speaking these process \s-1CMS\s0 enveloped data: \s-1CMS\s0 encrypted data is used for other purposes.

The -resign option uses an existing message digest when adding a new signer. This means that attributes must be present in at least one existing signer using the same message digest or this operation will fail.

The -stream and -indef options enable experimental streaming I/O support. As a result the encoding is \s-1BER\s0 using indefinite length constructed encoding and no longer \s-1DER.\s0 Streaming is supported for the -encrypt operation and the \fB-sign operation if the content is not detached.

Streaming is always used for the -sign operation with detached data but since the content is no longer part of the \s-1CMS\s0 structure the encoding remains \s-1DER.\s0

If the -decrypt option is used without a recipient certificate then an attempt is made to locate the recipient by trying each potential recipient in turn using the supplied private key. To thwart the \s-1MMA\s0 attack (Bleichenbacher's attack on \s-1PKCS\s0 #1 v1.5 \s-1RSA\s0 padding) all recipients are tried whether they succeed or not and if no recipients match the message is \*(L"decrypted\*(R" using a random key which will typically output garbage. The -debug_decrypt option can be used to disable the \s-1MMA\s0 attack protection and return an error if no recipient can be found: this option should be used with caution. For a fuller description see CMS_decrypt\|(3)).

Header "EXIT CODES" the operation was completely successfully. Item "1" an error occurred parsing the command options. Item "2" one of the input files could not be read. Item "3" an error occurred creating the \s-1CMS\s0 file or when reading the \s-1MIME\s0 message. Item "4" an error occurred decrypting or verifying the message. Item "5" the message was verified correctly but an error occurred writing out the signers certificates. Header "COMPATIBILITY WITH PKCS#7 format." The smime utility can only process the older PKCS#7 format. The cms utility supports Cryptographic Message Syntax format. Use of some features will result in messages which cannot be processed by applications which only support the older format. These are detailed below.

The use of the -keyid option with -sign or -encrypt.

The -outform \s-1PEM\s0 option uses different headers.

The -compress option.

The -secretkey option when used with -encrypt.

Additionally the -EncryptedData_create and -data_create type cannot be processed by the older smime command.

Header "EXAMPLES" Create a cleartext signed message:

.Vb 2 openssl cms -sign -in message.txt -text -out mail.msg \e -signer mycert.pem .Ve

Create an opaque signed message

.Vb 2 openssl cms -sign -in message.txt -text -out mail.msg -nodetach \e -signer mycert.pem .Ve

Create a signed message, include some additional certificates and read the private key from another file:

.Vb 2 openssl cms -sign -in in.txt -text -out mail.msg \e -signer mycert.pem -inkey mykey.pem -certfile mycerts.pem .Ve

Create a signed message with two signers, use key identifier:

.Vb 2 openssl cms -sign -in message.txt -text -out mail.msg \e -signer mycert.pem -signer othercert.pem -keyid .Ve

Send a signed message under Unix directly to sendmail, including headers:

.Vb 3 openssl cms -sign -in in.txt -text -signer mycert.pem \e -from steve@openssl.org -to someone@somewhere \e -subject "Signed message" | sendmail someone@somewhere .Ve

Verify a message and extract the signer's certificate if successful:

.Vb 1 openssl cms -verify -in mail.msg -signer user.pem -out signedtext.txt .Ve

Send encrypted mail using triple \s-1DES:\s0

.Vb 3 openssl cms -encrypt -in in.txt -from steve@openssl.org \e -to someone@somewhere -subject "Encrypted message" \e -des3 user.pem -out mail.msg .Ve

Sign and encrypt mail:

.Vb 4 openssl cms -sign -in ml.txt -signer my.pem -text \e | openssl cms -encrypt -out mail.msg \e -from steve@openssl.org -to someone@somewhere \e -subject "Signed and Encrypted message" -des3 user.pem .Ve

Note: the encryption command does not include the -text option because the message being encrypted already has \s-1MIME\s0 headers.

Decrypt mail:

.Vb 1 openssl cms -decrypt -in mail.msg -recip mycert.pem -inkey key.pem .Ve

The output from Netscape form signing is a PKCS#7 structure with the detached signature format. You can use this program to verify the signature by line wrapping the base64 encoded structure and surrounding it with:

.Vb 2 -----BEGIN PKCS7----- -----END PKCS7----- .Ve

and using the command,

.Vb 1 openssl cms -verify -inform PEM -in signature.pem -content content.txt .Ve

alternatively you can base64 decode the signature and use

.Vb 1 openssl cms -verify -inform DER -in signature.der -content content.txt .Ve

Create an encrypted message using 128 bit Camellia:

.Vb 1 openssl cms -encrypt -in plain.txt -camellia128 -out mail.msg cert.pem .Ve

Add a signer to an existing message:

.Vb 1 openssl cms -resign -in mail.msg -signer newsign.pem -out mail2.msg .Ve

Header "BUGS" The \s-1MIME\s0 parser isn't very clever: it seems to handle most messages that I've thrown at it but it may choke on others.

The code currently will only write out the signer's certificate to a file: if the signer has a separate encryption certificate this must be manually extracted. There should be some heuristic that determines the correct encryption certificate.

Ideally a database should be maintained of a certificates for each email address.

The code doesn't currently take note of the permitted symmetric encryption algorithms as supplied in the SMIMECapabilities signed attribute. this means the user has to manually include the correct encryption algorithm. It should store the list of permitted ciphers in a database and only use those.

No revocation checking is done on the signer's certificate.

Header "HISTORY" The use of multiple -signer options and the -resign command were first added in OpenSSL 1.0.0

The -no_alt_chains options was first added to OpenSSL 1.0.1n and 1.0.2b.