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