2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
6 openssl-smime - S/MIME command
22 [B<-certfile> I<file>]
33 [B<-inform> B<DER>|B<PEM>|B<SMIME>]
34 [B<-outform> B<DER>|B<PEM>|B<SMIME>]
35 [B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>]
37 [B<-inkey> I<file_or_id>]
48 {- $OpenSSL::safe::opt_trust_synopsis -}
49 {- $OpenSSL::safe::opt_engine_synopsis -}
50 {- $OpenSSL::safe::opt_r_synopsis -}
51 {- $OpenSSL::safe::opt_v_synopsis -}
52 {- $OpenSSL::safe::opt_provider_synopsis -}
55 =for openssl ifdef engine
59 This command handles S/MIME mail. It can encrypt, decrypt, sign
60 and verify S/MIME messages.
64 There are six operation options that set the type of operation to be performed.
65 The meaning of the other options varies according to the operation type.
71 Print out a usage message.
75 Encrypt mail for the given recipient certificates. Input file is the message
76 to be encrypted. The output file is the encrypted mail in MIME format.
78 Note that no revocation check is done for the recipient cert, so if that
79 key has been compromised, others may be able to decrypt the text.
83 Decrypt mail using the supplied certificate and private key. Expects an
84 encrypted mail message in MIME format for the input file. The decrypted mail
85 is written to the output file.
89 Sign mail using the supplied certificate and private key. Input file is
90 the message to be signed. The signed message in MIME format is written
95 Verify signed mail. Expects a signed mail message on input and outputs
96 the signed data. Both clear text and opaque signing is supported.
100 Takes an input message and writes out a PEM encoded PKCS#7 structure.
104 Resign a message: take an existing message and one or more new signers.
106 =item B<-in> I<filename>
108 The input message to be encrypted or signed or the MIME message to
109 be decrypted or verified.
111 =item B<-out> I<filename>
113 The message text that has been decrypted or verified or the output MIME
114 format message that has been signed or verified.
116 =item B<-inform> B<DER>|B<PEM>|B<SMIME>
118 The input format of the PKCS#7 (S/MIME) structure (if one is being read);
119 the default is B<SMIME>.
120 See L<openssl(1)/Format Options> for details.
122 =item B<-outform> B<DER>|B<PEM>|B<SMIME>
124 The output format of the PKCS#7 (S/MIME) structure (if one is being written);
125 the default is B<SMIME>.
126 See L<openssl(1)/Format Options> for details.
128 =item B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
130 The key format; the default is B<PEM>.
131 The only value with effect is B<ENGINE>; all others have become obsolete.
132 See L<openssl(1)/Format Options> for details.
134 =item B<-stream>, B<-indef>, B<-noindef>
136 The B<-stream> and B<-indef> options are equivalent and enable streaming I/O
137 for encoding operations. This permits single pass processing of data without
138 the need to hold the entire contents in memory, potentially supporting very
139 large files. Streaming is automatically set for S/MIME signing with detached
140 data if the output format is B<SMIME> it is currently off by default for all
145 Disable streaming I/O where it would produce and indefinite length constructed
146 encoding. This option currently has no effect. In future streaming will be
147 enabled by default on all relevant operations and this option will disable it.
149 =item B<-content> I<filename>
151 This specifies a file containing the detached content, this is only
152 useful with the B<-verify> command. This is only usable if the PKCS#7
153 structure is using the detached signature form where the content is
154 not included. This option will override any content if the input format
155 is S/MIME and it uses the multipart/signed MIME content type.
159 This option adds plain text (text/plain) MIME headers to the supplied
160 message if encrypting or signing. If decrypting or verifying it strips
161 off text headers: if the decrypted or verified message is not of MIME
162 type text/plain then an error occurs.
164 =item B<-md> I<digest>
166 Digest algorithm to use when signing or resigning. If not present then the
167 default digest algorithm for the signing key will be used (usually SHA1).
171 The encryption algorithm to use. For example DES (56 bits) - B<-des>,
172 triple DES (168 bits) - B<-des3>,
173 EVP_get_cipherbyname() function) can also be used preceded by a dash, for
174 example B<-aes-128-cbc>. See L<openssl-enc(1)> for list of ciphers
175 supported by your version of OpenSSL.
177 If not specified triple DES is used. Only used with B<-encrypt>.
181 When verifying a message normally certificates (if any) included in
182 the message are searched for the signing certificate. With this option
183 only the certificates specified in the B<-certfile> option are used.
184 The supplied certificates can still be used as untrusted CAs however.
188 Do not verify the signers certificate of a signed message.
192 Do not do chain verification of signers certificates; that is, do not
193 use the certificates in the signed message as untrusted CAs.
197 Don't try to verify the signatures on the message.
201 When signing a message the signer's certificate is normally included
202 with this option it is excluded. This will reduce the size of the
203 signed message but the verifier must have a copy of the signers certificate
204 available locally (passed using the B<-certfile> option for example).
208 Normally when a message is signed a set of attributes are included which
209 include the signing time and supported symmetric algorithms. With this
210 option they are not included.
214 When signing a message use opaque signing. This form is more resistant
215 to translation by mail relays but it cannot be read by mail agents that
216 do not support S/MIME. Without this option cleartext signing with
217 the MIME type multipart/signed is used.
221 When signing a message, do not include the B<SMIMECapabilities> attribute.
225 Normally the input message is converted to "canonical" format which is
226 effectively using CR and LF as end of line: as required by the S/MIME
227 specification. When this option is present no translation occurs. This
228 is useful when handling binary data which may not be in MIME format.
232 Normally the output file uses a single B<LF> as end of line. When this
233 option is present B<CRLF> is used instead.
235 =item B<-certfile> I<file>
237 Allows additional certificates to be specified. When signing these will
238 be included with the message. When verifying these will be searched for
239 the signers certificates.
241 =item B<-signer> I<file>
243 A signing certificate when signing or resigning a message, this option can be
244 used multiple times if more than one signer is required. If a message is being
245 verified then the signers certificates will be written to this file if the
246 verification was successful.
250 Don't include signers certificate when signing.
254 Don't include any signed attributes when signing.
256 =item B<-recip> I<file>
258 The recipients certificate when decrypting a message. This certificate
259 must match one of the recipients of the message or an error occurs.
261 =item B<-inkey> I<file_or_id>
263 The private key to use when signing or decrypting. This must match the
264 corresponding certificate. If this option is not specified then the
265 private key must be included in the certificate file specified with
266 the B<-recip> or B<-signer> file. When signing this option can be used
267 multiple times to specify successive keys.
268 If no engine is used, the argument is taken as a file; if an engine is
269 specified, the argument is given to the engine as a key identifier.
271 =item B<-passin> I<arg>
273 The private key password source. For more information about the format of I<arg>
274 see L<openssl(1)/Pass Phrase Options>.
276 =item B<-to>, B<-from>, B<-subject>
278 The relevant mail headers. These are included outside the signed
279 portion of a message so they may be included manually. If signing
280 then many S/MIME mail clients check the signers certificate's email
281 address matches that specified in the From: address.
283 {- $OpenSSL::safe::opt_v_item -}
285 Any verification errors cause the command to exit.
287 {- $OpenSSL::safe::opt_trust_item -}
289 {- $OpenSSL::safe::opt_engine_item -}
291 {- $OpenSSL::safe::opt_r_item -}
293 {- $OpenSSL::safe::opt_provider_item -}
295 =item I<recipcert> ...
297 One or more certificates of message recipients, used when encrypting
304 The MIME message must be sent without any blank lines between the
305 headers and the output. Some mail programs will automatically add
306 a blank line. Piping the mail directly to sendmail is one way to
307 achieve the correct format.
309 The supplied message to be signed or encrypted must include the
310 necessary MIME headers or many S/MIME clients won't display it
311 properly (if at all). You can use the B<-text> option to automatically
312 add plain text headers.
314 A "signed and encrypted" message is one where a signed message is
315 then encrypted. This can be produced by encrypting an already signed
316 message: see the examples section.
318 This version of the program only allows one signer per message but it
319 will verify multiple signers on received messages. Some S/MIME clients
320 choke if a message contains multiple signers. It is possible to sign
321 messages "in parallel" by signing an already signed message.
323 The options B<-encrypt> and B<-decrypt> reflect common usage in S/MIME
324 clients. Strictly speaking these process PKCS#7 enveloped data: PKCS#7
325 encrypted data is used for other purposes.
327 The B<-resign> option uses an existing message digest when adding a new
328 signer. This means that attributes must be present in at least one existing
329 signer using the same message digest or this operation will fail.
331 The B<-stream> and B<-indef> options enable streaming I/O support.
332 As a result the encoding is BER using indefinite length constructed encoding
333 and no longer DER. Streaming is supported for the B<-encrypt> operation and the
334 B<-sign> operation if the content is not detached.
336 Streaming is always used for the B<-sign> operation with detached data but
337 since the content is no longer part of the PKCS#7 structure the encoding
346 The operation was completely successfully.
350 An error occurred parsing the command options.
354 One of the input files could not be read.
358 An error occurred creating the PKCS#7 file or when reading the MIME
363 An error occurred decrypting or verifying the message.
367 The message was verified correctly but an error occurred writing out
368 the signers certificates.
374 Create a cleartext signed message:
376 openssl smime -sign -in message.txt -text -out mail.msg \
379 Create an opaque signed message:
381 openssl smime -sign -in message.txt -text -out mail.msg -nodetach \
384 Create a signed message, include some additional certificates and
385 read the private key from another file:
387 openssl smime -sign -in in.txt -text -out mail.msg \
388 -signer mycert.pem -inkey mykey.pem -certfile mycerts.pem
390 Create a signed message with two signers:
392 openssl smime -sign -in message.txt -text -out mail.msg \
393 -signer mycert.pem -signer othercert.pem
395 Send a signed message under Unix directly to sendmail, including headers:
397 openssl smime -sign -in in.txt -text -signer mycert.pem \
398 -from steve@openssl.org -to someone@somewhere \
399 -subject "Signed message" | sendmail someone@somewhere
401 Verify a message and extract the signer's certificate if successful:
403 openssl smime -verify -in mail.msg -signer user.pem -out signedtext.txt
405 Send encrypted mail using triple DES:
407 openssl smime -encrypt -in in.txt -from steve@openssl.org \
408 -to someone@somewhere -subject "Encrypted message" \
409 -des3 user.pem -out mail.msg
411 Sign and encrypt mail:
413 openssl smime -sign -in ml.txt -signer my.pem -text \
414 | openssl smime -encrypt -out mail.msg \
415 -from steve@openssl.org -to someone@somewhere \
416 -subject "Signed and Encrypted message" -des3 user.pem
418 Note: the encryption command does not include the B<-text> option because the
419 message being encrypted already has MIME headers.
423 openssl smime -decrypt -in mail.msg -recip mycert.pem -inkey key.pem
425 The output from Netscape form signing is a PKCS#7 structure with the
426 detached signature format. You can use this program to verify the
427 signature by line wrapping the base64 encoded structure and surrounding
430 -----BEGIN PKCS7-----
433 and using the command:
435 openssl smime -verify -inform PEM -in signature.pem -content content.txt
437 Alternatively you can base64 decode the signature and use:
439 openssl smime -verify -inform DER -in signature.der -content content.txt
441 Create an encrypted message using 128 bit Camellia:
443 openssl smime -encrypt -in plain.txt -camellia128 -out mail.msg cert.pem
445 Add a signer to an existing message:
447 openssl smime -resign -in mail.msg -signer newsign.pem -out mail2.msg
451 The MIME parser isn't very clever: it seems to handle most messages that I've
452 thrown at it but it may choke on others.
454 The code currently will only write out the signer's certificate to a file: if
455 the signer has a separate encryption certificate this must be manually
456 extracted. There should be some heuristic that determines the correct
457 encryption certificate.
459 Ideally a database should be maintained of a certificates for each email
462 The code doesn't currently take note of the permitted symmetric encryption
463 algorithms as supplied in the SMIMECapabilities signed attribute. This means the
464 user has to manually include the correct encryption algorithm. It should store
465 the list of permitted ciphers in a database and only use those.
467 No revocation checking is done on the signer's certificate.
469 The current code can only handle S/MIME v2 messages, the more complex S/MIME v3
470 structures may cause parsing errors.
474 L<ossl_store-file(7)>
478 The use of multiple B<-signer> options and the B<-resign> command were first
479 added in OpenSSL 1.0.0
481 The -no_alt_chains option was added in OpenSSL 1.1.0.
483 All B<-keyform> values except B<ENGINE> have become obsolete in OpenSSL 3.0.0
486 The B<-engine> option was deprecated in OpenSSL 3.0.
490 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
492 Licensed under the Apache License 2.0 (the "License"). You may not use
493 this file except in compliance with the License. You can obtain a copy
494 in the file LICENSE in the source distribution or at
495 L<https://www.openssl.org/source/license.html>.