openssl-smime.pod.in 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501
  1. =pod
  2. {- OpenSSL::safe::output_do_not_edit_headers(); -}
  3. =head1 NAME
  4. openssl-smime - S/MIME command
  5. =head1 SYNOPSIS
  6. B<openssl> B<smime>
  7. [B<-help>]
  8. [B<-encrypt>]
  9. [B<-decrypt>]
  10. [B<-sign>]
  11. [B<-resign>]
  12. [B<-verify>]
  13. [B<-pk7out>]
  14. [B<-binary>]
  15. [B<-crlfeol>]
  16. [B<-I<cipher>>]
  17. [B<-in> I<file>]
  18. [B<-certfile> I<file>]
  19. [B<-signer> I<file>]
  20. [B<-nointern>]
  21. [B<-noverify>]
  22. [B<-nochain>]
  23. [B<-nosigs>]
  24. [B<-nocerts>]
  25. [B<-noattr>]
  26. [B<-nodetach>]
  27. [B<-nosmimecap>]
  28. [B<-recip> I< file>]
  29. [B<-inform> B<DER>|B<PEM>|B<SMIME>]
  30. [B<-outform> B<DER>|B<PEM>|B<SMIME>]
  31. [B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>]
  32. [B<-passin> I<arg>]
  33. [B<-inkey> I<file_or_id>]
  34. [B<-out> I<file>]
  35. [B<-content> I<file>]
  36. [B<-to> I<addr>]
  37. [B<-from> I<ad>]
  38. [B<-subject> I<s>]
  39. [B<-text>]
  40. [B<-indef>]
  41. [B<-noindef>]
  42. [B<-stream>]
  43. [B<-md> I<digest>]
  44. {- $OpenSSL::safe::opt_trust_synopsis -}
  45. {- $OpenSSL::safe::opt_engine_synopsis -}
  46. {- $OpenSSL::safe::opt_r_synopsis -}
  47. {- $OpenSSL::safe::opt_v_synopsis -}
  48. {- $OpenSSL::safe::opt_provider_synopsis -}
  49. {- $OpenSSL::safe::opt_config_synopsis -}
  50. I<recipcert> ...
  51. =for openssl ifdef engine
  52. =head1 DESCRIPTION
  53. This command handles S/MIME mail. It can encrypt, decrypt, sign
  54. and verify S/MIME messages.
  55. =head1 OPTIONS
  56. There are six operation options that set the type of operation to be performed.
  57. The meaning of the other options varies according to the operation type.
  58. =over 4
  59. =item B<-help>
  60. Print out a usage message.
  61. =item B<-encrypt>
  62. Encrypt mail for the given recipient certificates. Input file is the message
  63. to be encrypted. The output file is the encrypted mail in MIME format.
  64. Note that no revocation check is done for the recipient cert, so if that
  65. key has been compromised, others may be able to decrypt the text.
  66. =item B<-decrypt>
  67. Decrypt mail using the supplied certificate and private key. Expects an
  68. encrypted mail message in MIME format for the input file. The decrypted mail
  69. is written to the output file.
  70. =item B<-sign>
  71. Sign mail using the supplied certificate and private key. Input file is
  72. the message to be signed. The signed message in MIME format is written
  73. to the output file.
  74. =item B<-verify>
  75. Verify signed mail. Expects a signed mail message on input and outputs
  76. the signed data. Both clear text and opaque signing is supported.
  77. =item B<-pk7out>
  78. Takes an input message and writes out a PEM encoded PKCS#7 structure.
  79. =item B<-resign>
  80. Resign a message: take an existing message and one or more new signers.
  81. =item B<-in> I<filename>
  82. The input message to be encrypted or signed or the MIME message to
  83. be decrypted or verified.
  84. =item B<-out> I<filename>
  85. The message text that has been decrypted or verified or the output MIME
  86. format message that has been signed or verified.
  87. =item B<-inform> B<DER>|B<PEM>|B<SMIME>
  88. The input format of the PKCS#7 (S/MIME) structure (if one is being read);
  89. the default is B<SMIME>.
  90. See L<openssl(1)/Format Options> for details.
  91. =item B<-outform> B<DER>|B<PEM>|B<SMIME>
  92. The output format of the PKCS#7 (S/MIME) structure (if one is being written);
  93. the default is B<SMIME>.
  94. See L<openssl(1)/Format Options> for details.
  95. =item B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
  96. The key format; the default is B<PEM>.
  97. The only value with effect is B<ENGINE>; all others have become obsolete.
  98. See L<openssl(1)/Format Options> for details.
  99. =item B<-stream>, B<-indef>, B<-noindef>
  100. The B<-stream> and B<-indef> options are equivalent and enable streaming I/O
  101. for encoding operations. This permits single pass processing of data without
  102. the need to hold the entire contents in memory, potentially supporting very
  103. large files. Streaming is automatically set for S/MIME signing with detached
  104. data if the output format is B<SMIME> it is currently off by default for all
  105. other operations.
  106. =item B<-noindef>
  107. Disable streaming I/O where it would produce and indefinite length constructed
  108. encoding. This option currently has no effect. In future streaming will be
  109. enabled by default on all relevant operations and this option will disable it.
  110. =item B<-content> I<filename>
  111. This specifies a file containing the detached content, this is only
  112. useful with the B<-verify> command. This is only usable if the PKCS#7
  113. structure is using the detached signature form where the content is
  114. not included. This option will override any content if the input format
  115. is S/MIME and it uses the multipart/signed MIME content type.
  116. =item B<-text>
  117. This option adds plain text (text/plain) MIME headers to the supplied
  118. message if encrypting or signing. If decrypting or verifying it strips
  119. off text headers: if the decrypted or verified message is not of MIME
  120. type text/plain then an error occurs.
  121. =item B<-md> I<digest>
  122. Digest algorithm to use when signing or resigning. If not present then the
  123. default digest algorithm for the signing key will be used (usually SHA1).
  124. =item B<-I<cipher>>
  125. The encryption algorithm to use. For example DES (56 bits) - B<-des>,
  126. triple DES (168 bits) - B<-des3>,
  127. EVP_get_cipherbyname() function) can also be used preceded by a dash, for
  128. example B<-aes-128-cbc>. See L<openssl-enc(1)> for list of ciphers
  129. supported by your version of OpenSSL.
  130. If not specified triple DES is used. Only used with B<-encrypt>.
  131. =item B<-nointern>
  132. When verifying a message normally certificates (if any) included in
  133. the message are searched for the signing certificate. With this option
  134. only the certificates specified in the B<-certfile> option are used.
  135. The supplied certificates can still be used as untrusted CAs however.
  136. =item B<-noverify>
  137. Do not verify the signers certificate of a signed message.
  138. =item B<-nochain>
  139. Do not do chain verification of signers certificates; that is, do not
  140. use the certificates in the signed message as untrusted CAs.
  141. =item B<-nosigs>
  142. Don't try to verify the signatures on the message.
  143. =item B<-nocerts>
  144. When signing a message the signer's certificate is normally included
  145. with this option it is excluded. This will reduce the size of the
  146. signed message but the verifier must have a copy of the signers certificate
  147. available locally (passed using the B<-certfile> option for example).
  148. =item B<-noattr>
  149. Normally when a message is signed a set of attributes are included which
  150. include the signing time and supported symmetric algorithms. With this
  151. option they are not included.
  152. =item B<-nodetach>
  153. When signing a message use opaque signing. This form is more resistant
  154. to translation by mail relays but it cannot be read by mail agents that
  155. do not support S/MIME. Without this option cleartext signing with
  156. the MIME type multipart/signed is used.
  157. =item B<-nosmimecap>
  158. When signing a message, do not include the B<SMIMECapabilities> attribute.
  159. =item B<-binary>
  160. Normally the input message is converted to "canonical" format which is
  161. effectively using CR and LF as end of line: as required by the S/MIME
  162. specification. When this option is present no translation occurs. This
  163. is useful when handling binary data which may not be in MIME format.
  164. =item B<-crlfeol>
  165. Normally the output file uses a single B<LF> as end of line. When this
  166. option is present B<CRLF> is used instead.
  167. =item B<-certfile> I<file>
  168. Allows additional certificates to be specified. When signing these will
  169. be included with the message. When verifying these will be searched for
  170. the signers certificates.
  171. The input can be in PEM, DER, or PKCS#12 format.
  172. =item B<-signer> I<file>
  173. A signing certificate when signing or resigning a message, this option can be
  174. used multiple times if more than one signer is required. If a message is being
  175. verified then the signers certificates will be written to this file if the
  176. verification was successful.
  177. =item B<-nocerts>
  178. Don't include signers certificate when signing.
  179. =item B<-noattr>
  180. Don't include any signed attributes when signing.
  181. =item B<-recip> I<file>
  182. The recipients certificate when decrypting a message. This certificate
  183. must match one of the recipients of the message or an error occurs.
  184. =item B<-inkey> I<file_or_id>
  185. The private key to use when signing or decrypting. This must match the
  186. corresponding certificate. If this option is not specified then the
  187. private key must be included in the certificate file specified with
  188. the B<-recip> or B<-signer> file. When signing this option can be used
  189. multiple times to specify successive keys.
  190. If no engine is used, the argument is taken as a file; if an engine is
  191. specified, the argument is given to the engine as a key identifier.
  192. =item B<-passin> I<arg>
  193. The private key password source. For more information about the format of I<arg>
  194. see L<openssl(1)/Pass Phrase Options>.
  195. =item B<-to>, B<-from>, B<-subject>
  196. The relevant mail headers. These are included outside the signed
  197. portion of a message so they may be included manually. If signing
  198. then many S/MIME mail clients check the signers certificate's email
  199. address matches that specified in the From: address.
  200. {- $OpenSSL::safe::opt_v_item -}
  201. Any verification errors cause the command to exit.
  202. {- $OpenSSL::safe::opt_trust_item -}
  203. {- $OpenSSL::safe::opt_engine_item -}
  204. {- $OpenSSL::safe::opt_r_item -}
  205. {- $OpenSSL::safe::opt_provider_item -}
  206. {- $OpenSSL::safe::opt_config_item -}
  207. =item I<recipcert> ...
  208. One or more certificates of message recipients, used when encrypting
  209. a message.
  210. =back
  211. =head1 NOTES
  212. The MIME message must be sent without any blank lines between the
  213. headers and the output. Some mail programs will automatically add
  214. a blank line. Piping the mail directly to sendmail is one way to
  215. achieve the correct format.
  216. The supplied message to be signed or encrypted must include the
  217. necessary MIME headers or many S/MIME clients won't display it
  218. properly (if at all). You can use the B<-text> option to automatically
  219. add plain text headers.
  220. A "signed and encrypted" message is one where a signed message is
  221. then encrypted. This can be produced by encrypting an already signed
  222. message: see the examples section.
  223. This version of the program only allows one signer per message but it
  224. will verify multiple signers on received messages. Some S/MIME clients
  225. choke if a message contains multiple signers. It is possible to sign
  226. messages "in parallel" by signing an already signed message.
  227. The options B<-encrypt> and B<-decrypt> reflect common usage in S/MIME
  228. clients. Strictly speaking these process PKCS#7 enveloped data: PKCS#7
  229. encrypted data is used for other purposes.
  230. The B<-resign> option uses an existing message digest when adding a new
  231. signer. This means that attributes must be present in at least one existing
  232. signer using the same message digest or this operation will fail.
  233. The B<-stream> and B<-indef> options enable streaming I/O support.
  234. As a result the encoding is BER using indefinite length constructed encoding
  235. and no longer DER. Streaming is supported for the B<-encrypt> operation and the
  236. B<-sign> operation if the content is not detached.
  237. Streaming is always used for the B<-sign> operation with detached data but
  238. since the content is no longer part of the PKCS#7 structure the encoding
  239. remains DER.
  240. =head1 EXIT CODES
  241. =over 4
  242. =item Z<>0
  243. The operation was completely successfully.
  244. =item Z<>1
  245. An error occurred parsing the command options.
  246. =item Z<>2
  247. One of the input files could not be read.
  248. =item Z<>3
  249. An error occurred creating the PKCS#7 file or when reading the MIME
  250. message.
  251. =item Z<>4
  252. An error occurred decrypting or verifying the message.
  253. =item Z<>5
  254. The message was verified correctly but an error occurred writing out
  255. the signers certificates.
  256. =back
  257. =head1 EXAMPLES
  258. Create a cleartext signed message:
  259. openssl smime -sign -in message.txt -text -out mail.msg \
  260. -signer mycert.pem
  261. Create an opaque signed message:
  262. openssl smime -sign -in message.txt -text -out mail.msg -nodetach \
  263. -signer mycert.pem
  264. Create a signed message, include some additional certificates and
  265. read the private key from another file:
  266. openssl smime -sign -in in.txt -text -out mail.msg \
  267. -signer mycert.pem -inkey mykey.pem -certfile mycerts.pem
  268. Create a signed message with two signers:
  269. openssl smime -sign -in message.txt -text -out mail.msg \
  270. -signer mycert.pem -signer othercert.pem
  271. Send a signed message under Unix directly to sendmail, including headers:
  272. openssl smime -sign -in in.txt -text -signer mycert.pem \
  273. -from steve@openssl.org -to someone@somewhere \
  274. -subject "Signed message" | sendmail someone@somewhere
  275. Verify a message and extract the signer's certificate if successful:
  276. openssl smime -verify -in mail.msg -signer user.pem -out signedtext.txt
  277. Send encrypted mail using triple DES:
  278. openssl smime -encrypt -in in.txt -from steve@openssl.org \
  279. -to someone@somewhere -subject "Encrypted message" \
  280. -des3 user.pem -out mail.msg
  281. Sign and encrypt mail:
  282. openssl smime -sign -in ml.txt -signer my.pem -text \
  283. | openssl smime -encrypt -out mail.msg \
  284. -from steve@openssl.org -to someone@somewhere \
  285. -subject "Signed and Encrypted message" -des3 user.pem
  286. Note: the encryption command does not include the B<-text> option because the
  287. message being encrypted already has MIME headers.
  288. Decrypt mail:
  289. openssl smime -decrypt -in mail.msg -recip mycert.pem -inkey key.pem
  290. The output from Netscape form signing is a PKCS#7 structure with the
  291. detached signature format. You can use this program to verify the
  292. signature by line wrapping the base64 encoded structure and surrounding
  293. it with:
  294. -----BEGIN PKCS7-----
  295. -----END PKCS7-----
  296. and using the command:
  297. openssl smime -verify -inform PEM -in signature.pem -content content.txt
  298. Alternatively you can base64 decode the signature and use:
  299. openssl smime -verify -inform DER -in signature.der -content content.txt
  300. Create an encrypted message using 128 bit Camellia:
  301. openssl smime -encrypt -in plain.txt -camellia128 -out mail.msg cert.pem
  302. Add a signer to an existing message:
  303. openssl smime -resign -in mail.msg -signer newsign.pem -out mail2.msg
  304. =head1 BUGS
  305. The MIME parser isn't very clever: it seems to handle most messages that I've
  306. thrown at it but it may choke on others.
  307. The code currently will only write out the signer's certificate to a file: if
  308. the signer has a separate encryption certificate this must be manually
  309. extracted. There should be some heuristic that determines the correct
  310. encryption certificate.
  311. Ideally a database should be maintained of a certificates for each email
  312. address.
  313. The code doesn't currently take note of the permitted symmetric encryption
  314. algorithms as supplied in the SMIMECapabilities signed attribute. This means the
  315. user has to manually include the correct encryption algorithm. It should store
  316. the list of permitted ciphers in a database and only use those.
  317. No revocation checking is done on the signer's certificate.
  318. The current code can only handle S/MIME v2 messages, the more complex S/MIME v3
  319. structures may cause parsing errors.
  320. =head1 SEE ALSO
  321. L<ossl_store-file(7)>
  322. =head1 HISTORY
  323. The use of multiple B<-signer> options and the B<-resign> command were first
  324. added in OpenSSL 1.0.0
  325. The -no_alt_chains option was added in OpenSSL 1.1.0.
  326. All B<-keyform> values except B<ENGINE> have become obsolete in OpenSSL 3.0.0
  327. and have no effect.
  328. The B<-engine> option was deprecated in OpenSSL 3.0.
  329. =head1 COPYRIGHT
  330. Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
  331. Licensed under the Apache License 2.0 (the "License"). You may not use
  332. this file except in compliance with the License. You can obtain a copy
  333. in the file LICENSE in the source distribution or at
  334. L<https://www.openssl.org/source/license.html>.
  335. =cut