935a89b67872a3a8b8dc78d59684634e2289b5ca
[openssl.git] / doc / man1 / openssl-smime.pod
1 =pod
2
3 =head1 NAME
4
5 openssl-smime - S/MIME utility
6
7 =head1 SYNOPSIS
8
9 B<openssl> B<smime>
10 [B<-help>]
11 [B<-encrypt>]
12 [B<-decrypt>]
13 [B<-sign>]
14 [B<-resign>]
15 [B<-verify>]
16 [B<-pk7out>]
17 [B<-binary>]
18 [B<-crlfeol>]
19 [B<-I<cipher>>]
20 [B<-in> I<file>]
21 [B<-CAfile> I<file>]
22 [B<-CApath> I<dir>]
23 [B<-no-CAfile>]
24 [B<-no-CApath>]
25 [B<-attime> I<timestamp>]
26 [B<-check_ss_sig>]
27 [B<-crl_check>]
28 [B<-crl_check_all>]
29 [B<-explicit_policy>]
30 [B<-extended_crl>]
31 [B<-ignore_critical>]
32 [B<-inhibit_any>]
33 [B<-inhibit_map>]
34 [B<-partial_chain>]
35 [B<-policy> I<arg>]
36 [B<-policy_check>]
37 [B<-policy_print>]
38 [B<-purpose> I<purpose>]
39 [B<-suiteB_128>]
40 [B<-suiteB_128_only>]
41 [B<-suiteB_192>]
42 [B<-trusted_first>]
43 [B<-no_alt_chains>]
44 [B<-use_deltas>]
45 [B<-auth_level> I<num>]
46 [B<-verify_depth> I<num>]
47 [B<-verify_email> I<email>]
48 [B<-verify_hostname> I<hostname>]
49 [B<-verify_ip> I<ip>]
50 [B<-verify_name> I<name>]
51 [B<-x509_strict>]
52 [B<-certfile> I<file>]
53 [B<-signer> I<file>]
54 [B<-recip> I< file>]
55 [B<-inform> B<DER>|B<PEM>|B<SMIME>]
56 [B<-outform> B<DER>|B<PEM>|B<SMIME>]
57 [B<-keyform> B<DER>|B<PEM>|B<ENGINE>]
58 [B<-passin> I<arg>]
59 [B<-inkey> I<file_or_id>]
60 [B<-out> I<file>]
61 [B<-content> I<file>]
62 [B<-to> I<addr>]
63 [B<-from> I<ad>]
64 [B<-subject> I<s>]
65 [B<-text>]
66 [B<-indef>]
67 [B<-noindef>]
68 [B<-stream>]
69 [B<-rand> I<files>]
70 [B<-writerand> I<file>]
71 [B<-md> I<digest>]
72 I<cert.pem> ...
73
74 =for openssl ifdef engine
75
76 =head1 DESCRIPTION
77
78 This command handles S/MIME mail. It can encrypt, decrypt, sign
79 and verify S/MIME messages.
80
81 =head1 OPTIONS
82
83 There are six operation options that set the type of operation to be performed.
84 The meaning of the other options varies according to the operation type.
85
86 =over 4
87
88 =item B<-help>
89
90 Print out a usage message.
91
92 =item B<-encrypt>
93
94 Encrypt mail for the given recipient certificates. Input file is the message
95 to be encrypted. The output file is the encrypted mail in MIME format.
96
97 Note that no revocation check is done for the recipient cert, so if that
98 key has been compromised, others may be able to decrypt the text.
99
100 =item B<-decrypt>
101
102 Decrypt mail using the supplied certificate and private key. Expects an
103 encrypted mail message in MIME format for the input file. The decrypted mail
104 is written to the output file.
105
106 =item B<-sign>
107
108 Sign mail using the supplied certificate and private key. Input file is
109 the message to be signed. The signed message in MIME format is written
110 to the output file.
111
112 =item B<-verify>
113
114 Verify signed mail. Expects a signed mail message on input and outputs
115 the signed data. Both clear text and opaque signing is supported.
116
117 =item B<-pk7out>
118
119 Takes an input message and writes out a PEM encoded PKCS#7 structure.
120
121 =item B<-resign>
122
123 Resign a message: take an existing message and one or more new signers.
124
125 =item B<-in> I<filename>
126
127 The input message to be encrypted or signed or the MIME message to
128 be decrypted or verified.
129
130 =item B<-out> I<filename>
131
132 The message text that has been decrypted or verified or the output MIME
133 format message that has been signed or verified.
134
135 =item B<-inform> B<DER>|B<PEM>|B<SMIME>
136
137 The input format of the PKCS#7 (S/MIME) structure (if one is being read);
138 the default is B<SMIME>.
139 See L<openssl(1)/Format Options> for details.
140
141 =item B<-outform> B<DER>|B<PEM>|B<SMIME>
142
143 The output format of the PKCS#7 (S/MIME) structure (if one is being written);
144 the default is B<SMIME>.
145 See L<openssl(1)/Format Options> for details.
146
147 =item B<-keyform> B<DER>|B<PEM>
148
149 The key format; the default is B<PEM>.
150 See L<openssl(1)/Format Options> for details.
151
152 =item B<-stream>, B<-indef>, B<-noindef>
153
154 The B<-stream> and B<-indef> options are equivalent and enable streaming I/O
155 for encoding operations. This permits single pass processing of data without
156 the need to hold the entire contents in memory, potentially supporting very
157 large files. Streaming is automatically set for S/MIME signing with detached
158 data if the output format is B<SMIME> it is currently off by default for all
159 other operations.
160
161 =item B<-noindef>
162
163 Disable streaming I/O where it would produce and indefinite length constructed
164 encoding. This option currently has no effect. In future streaming will be
165 enabled by default on all relevant operations and this option will disable it.
166
167 =item B<-content> I<filename>
168
169 This specifies a file containing the detached content, this is only
170 useful with the B<-verify> command. This is only usable if the PKCS#7
171 structure is using the detached signature form where the content is
172 not included. This option will override any content if the input format
173 is S/MIME and it uses the multipart/signed MIME content type.
174
175 =item B<-text>
176
177 This option adds plain text (text/plain) MIME headers to the supplied
178 message if encrypting or signing. If decrypting or verifying it strips
179 off text headers: if the decrypted or verified message is not of MIME
180 type text/plain then an error occurs.
181
182 =item B<-CAfile> I<file>, B<-no-CAfile>, B<-CApath> I<dir>, B<-no-CApath>
183
184 See L<openssl(1)/Trusted Certificate Options> for more information.
185
186 =item B<-md> I<digest>
187
188 Digest algorithm to use when signing or resigning. If not present then the
189 default digest algorithm for the signing key will be used (usually SHA1).
190
191 =item B<-I<cipher>>
192
193 The encryption algorithm to use. For example DES  (56 bits) - B<-des>,
194 triple DES (168 bits) - B<-des3>,
195 EVP_get_cipherbyname() function) can also be used preceded by a dash, for
196 example B<-aes-128-cbc>. See L<openssl-enc(1)> for list of ciphers
197 supported by your version of OpenSSL.
198
199 If not specified triple DES is used. Only used with B<-encrypt>.
200
201 =item B<-nointern>
202
203 When verifying a message normally certificates (if any) included in
204 the message are searched for the signing certificate. With this option
205 only the certificates specified in the B<-certfile> option are used.
206 The supplied certificates can still be used as untrusted CAs however.
207
208 =item B<-noverify>
209
210 Do not verify the signers certificate of a signed message.
211
212 =item B<-nochain>
213
214 Do not do chain verification of signers certificates: that is don't
215 use the certificates in the signed message as untrusted CAs.
216
217 =item B<-nosigs>
218
219 Don't try to verify the signatures on the message.
220
221 =item B<-nocerts>
222
223 When signing a message the signer's certificate is normally included
224 with this option it is excluded. This will reduce the size of the
225 signed message but the verifier must have a copy of the signers certificate
226 available locally (passed using the B<-certfile> option for example).
227
228 =item B<-noattr>
229
230 Normally when a message is signed a set of attributes are included which
231 include the signing time and supported symmetric algorithms. With this
232 option they are not included.
233
234 =item B<-binary>
235
236 Normally the input message is converted to "canonical" format which is
237 effectively using CR and LF as end of line: as required by the S/MIME
238 specification. When this option is present no translation occurs. This
239 is useful when handling binary data which may not be in MIME format.
240
241 =item B<-crlfeol>
242
243 Normally the output file uses a single B<LF> as end of line. When this
244 option is present B<CRLF> is used instead.
245
246 =item B<-nodetach>
247
248 When signing a message use opaque signing: this form is more resistant
249 to translation by mail relays but it cannot be read by mail agents that
250 do not support S/MIME.  Without this option cleartext signing with
251 the MIME type multipart/signed is used.
252
253 =item B<-certfile> I<file>
254
255 Allows additional certificates to be specified. When signing these will
256 be included with the message. When verifying these will be searched for
257 the signers certificates. The certificates should be in PEM format.
258
259 =item B<-signer> I<file>
260
261 A signing certificate when signing or resigning a message, this option can be
262 used multiple times if more than one signer is required. If a message is being
263 verified then the signers certificates will be written to this file if the
264 verification was successful.
265
266 =item B<-recip> I<file>
267
268 The recipients certificate when decrypting a message. This certificate
269 must match one of the recipients of the message or an error occurs.
270
271 =item B<-inkey> I<file_or_id>
272
273 The private key to use when signing or decrypting. This must match the
274 corresponding certificate. If this option is not specified then the
275 private key must be included in the certificate file specified with
276 the B<-recip> or B<-signer> file. When signing this option can be used
277 multiple times to specify successive keys.
278 If no engine is used, the argument is taken as a file; if an engine is
279 specified, the argument is given to the engine as a key identifier.
280
281 =item B<-passin> I<arg>
282
283 The private key password source. For more information about the format of I<arg>
284 see L<openssl(1)/Pass Phrase Options>.
285
286 =item B<-rand> I<files>, B<-writerand> I<file>
287
288 See L<openssl(1)/Random State Options> for more information.
289
290 =item B<-to>, B<-from>, B<-subject>
291
292 The relevant mail headers. These are included outside the signed
293 portion of a message so they may be included manually. If signing
294 then many S/MIME mail clients check the signers certificate's email
295 address matches that specified in the From: address.
296
297 =item B<-attime>, B<-check_ss_sig>, B<-crl_check>, B<-crl_check_all>,
298 B<-explicit_policy>, B<-extended_crl>, B<-ignore_critical>, B<-inhibit_any>,
299 B<-inhibit_map>, B<-no_alt_chains>, B<-partial_chain>, B<-policy>,
300 B<-policy_check>, B<-policy_print>, B<-purpose>, B<-suiteB_128>,
301 B<-suiteB_128_only>, B<-suiteB_192>, B<-trusted_first>, B<-use_deltas>,
302 B<-auth_level>, B<-verify_depth>, B<-verify_email>, B<-verify_hostname>,
303 B<-verify_ip>, B<-verify_name>, B<-x509_strict>
304
305 Set various options of certificate chain verification. See
306 L<openssl-verify(1)> manual page for details.
307
308 =item I<cert.pem> ...
309
310 One or more certificates of message recipients, used when encrypting
311 a message.
312
313 =back
314
315 =head1 NOTES
316
317 The MIME message must be sent without any blank lines between the
318 headers and the output. Some mail programs will automatically add
319 a blank line. Piping the mail directly to sendmail is one way to
320 achieve the correct format.
321
322 The supplied message to be signed or encrypted must include the
323 necessary MIME headers or many S/MIME clients won't display it
324 properly (if at all). You can use the B<-text> option to automatically
325 add plain text headers.
326
327 A "signed and encrypted" message is one where a signed message is
328 then encrypted. This can be produced by encrypting an already signed
329 message: see the examples section.
330
331 This version of the program only allows one signer per message but it
332 will verify multiple signers on received messages. Some S/MIME clients
333 choke if a message contains multiple signers. It is possible to sign
334 messages "in parallel" by signing an already signed message.
335
336 The options B<-encrypt> and B<-decrypt> reflect common usage in S/MIME
337 clients. Strictly speaking these process PKCS#7 enveloped data: PKCS#7
338 encrypted data is used for other purposes.
339
340 The B<-resign> option uses an existing message digest when adding a new
341 signer. This means that attributes must be present in at least one existing
342 signer using the same message digest or this operation will fail.
343
344 The B<-stream> and B<-indef> options enable streaming I/O support.
345 As a result the encoding is BER using indefinite length constructed encoding
346 and no longer DER. Streaming is supported for the B<-encrypt> operation and the
347 B<-sign> operation if the content is not detached.
348
349 Streaming is always used for the B<-sign> operation with detached data but
350 since the content is no longer part of the PKCS#7 structure the encoding
351 remains DER.
352
353 =head1 EXIT CODES
354
355 =over 4
356
357 =item Z<>0
358
359 The operation was completely successfully.
360
361 =item Z<>1
362
363 An error occurred parsing the command options.
364
365 =item Z<>2
366
367 One of the input files could not be read.
368
369 =item Z<>3
370
371 An error occurred creating the PKCS#7 file or when reading the MIME
372 message.
373
374 =item Z<>4
375
376 An error occurred decrypting or verifying the message.
377
378 =item Z<>5
379
380 The message was verified correctly but an error occurred writing out
381 the signers certificates.
382
383 =back
384
385 =head1 EXAMPLES
386
387 Create a cleartext signed message:
388
389  openssl smime -sign -in message.txt -text -out mail.msg \
390         -signer mycert.pem
391
392 Create an opaque signed message:
393
394  openssl smime -sign -in message.txt -text -out mail.msg -nodetach \
395         -signer mycert.pem
396
397 Create a signed message, include some additional certificates and
398 read the private key from another file:
399
400  openssl smime -sign -in in.txt -text -out mail.msg \
401         -signer mycert.pem -inkey mykey.pem -certfile mycerts.pem
402
403 Create a signed message with two signers:
404
405  openssl smime -sign -in message.txt -text -out mail.msg \
406         -signer mycert.pem -signer othercert.pem
407
408 Send a signed message under Unix directly to sendmail, including headers:
409
410  openssl smime -sign -in in.txt -text -signer mycert.pem \
411         -from steve@openssl.org -to someone@somewhere \
412         -subject "Signed message" | sendmail someone@somewhere
413
414 Verify a message and extract the signer's certificate if successful:
415
416  openssl smime -verify -in mail.msg -signer user.pem -out signedtext.txt
417
418 Send encrypted mail using triple DES:
419
420  openssl smime -encrypt -in in.txt -from steve@openssl.org \
421         -to someone@somewhere -subject "Encrypted message" \
422         -des3 user.pem -out mail.msg
423
424 Sign and encrypt mail:
425
426  openssl smime -sign -in ml.txt -signer my.pem -text \
427         | openssl smime -encrypt -out mail.msg \
428         -from steve@openssl.org -to someone@somewhere \
429         -subject "Signed and Encrypted message" -des3 user.pem
430
431 Note: the encryption command does not include the B<-text> option because the
432 message being encrypted already has MIME headers.
433
434 Decrypt mail:
435
436  openssl smime -decrypt -in mail.msg -recip mycert.pem -inkey key.pem
437
438 The output from Netscape form signing is a PKCS#7 structure with the
439 detached signature format. You can use this program to verify the
440 signature by line wrapping the base64 encoded structure and surrounding
441 it with:
442
443  -----BEGIN PKCS7-----
444  -----END PKCS7-----
445
446 and using the command:
447
448  openssl smime -verify -inform PEM -in signature.pem -content content.txt
449
450 Alternatively you can base64 decode the signature and use:
451
452  openssl smime -verify -inform DER -in signature.der -content content.txt
453
454 Create an encrypted message using 128 bit Camellia:
455
456  openssl smime -encrypt -in plain.txt -camellia128 -out mail.msg cert.pem
457
458 Add a signer to an existing message:
459
460  openssl smime -resign -in mail.msg -signer newsign.pem -out mail2.msg
461
462 =head1 BUGS
463
464 The MIME parser isn't very clever: it seems to handle most messages that I've
465 thrown at it but it may choke on others.
466
467 The code currently will only write out the signer's certificate to a file: if
468 the signer has a separate encryption certificate this must be manually
469 extracted. There should be some heuristic that determines the correct
470 encryption certificate.
471
472 Ideally a database should be maintained of a certificates for each email
473 address.
474
475 The code doesn't currently take note of the permitted symmetric encryption
476 algorithms as supplied in the SMIMECapabilities signed attribute. This means the
477 user has to manually include the correct encryption algorithm. It should store
478 the list of permitted ciphers in a database and only use those.
479
480 No revocation checking is done on the signer's certificate.
481
482 The current code can only handle S/MIME v2 messages, the more complex S/MIME v3
483 structures may cause parsing errors.
484
485 =head1 HISTORY
486
487 The use of multiple B<-signer> options and the B<-resign> command were first
488 added in OpenSSL 1.0.0
489
490 The -no_alt_chains option was added in OpenSSL 1.1.0.
491
492 =head1 COPYRIGHT
493
494 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
495
496 Licensed under the Apache License 2.0 (the "License").  You may not use
497 this file except in compliance with the License.  You can obtain a copy
498 in the file LICENSE in the source distribution or at
499 L<https://www.openssl.org/source/license.html>.
500
501 =cut