smime.1 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617
  1. .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
  2. .\"
  3. .\" Standard preamble:
  4. .\" ========================================================================
  5. .de Sp \" Vertical space (when we can't use .PP)
  6. .if t .sp .5v
  7. .if n .sp
  8. ..
  9. .de Vb \" Begin verbatim text
  10. .ft CW
  11. .nf
  12. .ne \\$1
  13. ..
  14. .de Ve \" End verbatim text
  15. .ft R
  16. .fi
  17. ..
  18. .\" Set up some character translations and predefined strings. \*(-- will
  19. .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20. .\" double quote, and \*(R" will give a right double quote. \*(C+ will
  21. .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
  22. .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
  23. .\" nothing in troff, for use with C<>.
  24. .tr \(*W-
  25. .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26. .ie n \{\
  27. . ds -- \(*W-
  28. . ds PI pi
  29. . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30. . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
  31. . ds L" ""
  32. . ds R" ""
  33. . ds C` ""
  34. . ds C' ""
  35. 'br\}
  36. .el\{\
  37. . ds -- \|\(em\|
  38. . ds PI \(*p
  39. . ds L" ``
  40. . ds R" ''
  41. . ds C`
  42. . ds C'
  43. 'br\}
  44. .\"
  45. .\" Escape single quotes in literal strings from groff's Unicode transform.
  46. .ie \n(.g .ds Aq \(aq
  47. .el .ds Aq '
  48. .\"
  49. .\" If the F register is >0, we'll generate index entries on stderr for
  50. .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51. .\" entries marked with X<> in POD. Of course, you'll have to process the
  52. .\" output yourself in some meaningful fashion.
  53. .\"
  54. .\" Avoid warning from groff about undefined register 'F'.
  55. .de IX
  56. ..
  57. .nr rF 0
  58. .if \n(.g .if rF .nr rF 1
  59. .if (\n(rF:(\n(.g==0)) \{\
  60. . if \nF \{\
  61. . de IX
  62. . tm Index:\\$1\t\\n%\t"\\$2"
  63. ..
  64. . if !\nF==2 \{\
  65. . nr % 0
  66. . nr F 2
  67. . \}
  68. . \}
  69. .\}
  70. .rr rF
  71. .\"
  72. .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73. .\" Fear. Run. Save yourself. No user-serviceable parts.
  74. . \" fudge factors for nroff and troff
  75. .if n \{\
  76. . ds #H 0
  77. . ds #V .8m
  78. . ds #F .3m
  79. . ds #[ \f1
  80. . ds #] \fP
  81. .\}
  82. .if t \{\
  83. . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84. . ds #V .6m
  85. . ds #F 0
  86. . ds #[ \&
  87. . ds #] \&
  88. .\}
  89. . \" simple accents for nroff and troff
  90. .if n \{\
  91. . ds ' \&
  92. . ds ` \&
  93. . ds ^ \&
  94. . ds , \&
  95. . ds ~ ~
  96. . ds /
  97. .\}
  98. .if t \{\
  99. . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  100. . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  101. . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  102. . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  103. . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  104. . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  105. .\}
  106. . \" troff and (daisy-wheel) nroff accents
  107. .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  108. .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
  109. .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
  110. .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
  111. .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
  112. .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
  113. .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
  114. .ds ae a\h'-(\w'a'u*4/10)'e
  115. .ds Ae A\h'-(\w'A'u*4/10)'E
  116. . \" corrections for vroff
  117. .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
  118. .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
  119. . \" for low resolution devices (crt and lpr)
  120. .if \n(.H>23 .if \n(.V>19 \
  121. \{\
  122. . ds : e
  123. . ds 8 ss
  124. . ds o a
  125. . ds d- d\h'-1'\(ga
  126. . ds D- D\h'-1'\(hy
  127. . ds th \o'bp'
  128. . ds Th \o'LP'
  129. . ds ae ae
  130. . ds Ae AE
  131. .\}
  132. .rm #[ #] #H #V #F C
  133. .\" ========================================================================
  134. .\"
  135. .IX Title "SMIME 1"
  136. .TH SMIME 1 "2022-03-15" "1.1.1n" "OpenSSL"
  137. .\" For nroff, turn off justification. Always turn off hyphenation; it makes
  138. .\" way too many mistakes in technical documents.
  139. .if n .ad l
  140. .nh
  141. .SH "NAME"
  142. openssl\-smime, smime \- S/MIME utility
  143. .SH "SYNOPSIS"
  144. .IX Header "SYNOPSIS"
  145. \&\fBopenssl\fR \fBsmime\fR
  146. [\fB\-help\fR]
  147. [\fB\-encrypt\fR]
  148. [\fB\-decrypt\fR]
  149. [\fB\-sign\fR]
  150. [\fB\-resign\fR]
  151. [\fB\-verify\fR]
  152. [\fB\-pk7out\fR]
  153. [\fB\-binary\fR]
  154. [\fB\-crlfeol\fR]
  155. [\fB\-\f(BIcipher\fB\fR]
  156. [\fB\-in file\fR]
  157. [\fB\-CAfile file\fR]
  158. [\fB\-CApath dir\fR]
  159. [\fB\-no\-CAfile\fR]
  160. [\fB\-no\-CApath\fR]
  161. [\fB\-attime timestamp\fR]
  162. [\fB\-check_ss_sig\fR]
  163. [\fB\-crl_check\fR]
  164. [\fB\-crl_check_all\fR]
  165. [\fB\-explicit_policy\fR]
  166. [\fB\-extended_crl\fR]
  167. [\fB\-ignore_critical\fR]
  168. [\fB\-inhibit_any\fR]
  169. [\fB\-inhibit_map\fR]
  170. [\fB\-partial_chain\fR]
  171. [\fB\-policy arg\fR]
  172. [\fB\-policy_check\fR]
  173. [\fB\-policy_print\fR]
  174. [\fB\-purpose purpose\fR]
  175. [\fB\-suiteB_128\fR]
  176. [\fB\-suiteB_128_only\fR]
  177. [\fB\-suiteB_192\fR]
  178. [\fB\-trusted_first\fR]
  179. [\fB\-no_alt_chains\fR]
  180. [\fB\-use_deltas\fR]
  181. [\fB\-auth_level num\fR]
  182. [\fB\-verify_depth num\fR]
  183. [\fB\-verify_email email\fR]
  184. [\fB\-verify_hostname hostname\fR]
  185. [\fB\-verify_ip ip\fR]
  186. [\fB\-verify_name name\fR]
  187. [\fB\-x509_strict\fR]
  188. [\fB\-certfile file\fR]
  189. [\fB\-signer file\fR]
  190. [\fB\-recip file\fR]
  191. [\fB\-inform SMIME|PEM|DER\fR]
  192. [\fB\-passin arg\fR]
  193. [\fB\-inkey file_or_id\fR]
  194. [\fB\-out file\fR]
  195. [\fB\-outform SMIME|PEM|DER\fR]
  196. [\fB\-content file\fR]
  197. [\fB\-to addr\fR]
  198. [\fB\-from ad\fR]
  199. [\fB\-subject s\fR]
  200. [\fB\-text\fR]
  201. [\fB\-indef\fR]
  202. [\fB\-noindef\fR]
  203. [\fB\-stream\fR]
  204. [\fB\-rand file...\fR]
  205. [\fB\-writerand file\fR]
  206. [\fB\-md digest\fR]
  207. [cert.pem]...
  208. .SH "DESCRIPTION"
  209. .IX Header "DESCRIPTION"
  210. The \fBsmime\fR command handles S/MIME mail. It can encrypt, decrypt, sign and
  211. verify S/MIME messages.
  212. .SH "OPTIONS"
  213. .IX Header "OPTIONS"
  214. There are six operation options that set the type of operation to be performed.
  215. The meaning of the other options varies according to the operation type.
  216. .IP "\fB\-help\fR" 4
  217. .IX Item "-help"
  218. Print out a usage message.
  219. .IP "\fB\-encrypt\fR" 4
  220. .IX Item "-encrypt"
  221. Encrypt mail for the given recipient certificates. Input file is the message
  222. to be encrypted. The output file is the encrypted mail in \s-1MIME\s0 format.
  223. .Sp
  224. Note that no revocation check is done for the recipient cert, so if that
  225. key has been compromised, others may be able to decrypt the text.
  226. .IP "\fB\-decrypt\fR" 4
  227. .IX Item "-decrypt"
  228. Decrypt mail using the supplied certificate and private key. Expects an
  229. encrypted mail message in \s-1MIME\s0 format for the input file. The decrypted mail
  230. is written to the output file.
  231. .IP "\fB\-sign\fR" 4
  232. .IX Item "-sign"
  233. Sign mail using the supplied certificate and private key. Input file is
  234. the message to be signed. The signed message in \s-1MIME\s0 format is written
  235. to the output file.
  236. .IP "\fB\-verify\fR" 4
  237. .IX Item "-verify"
  238. Verify signed mail. Expects a signed mail message on input and outputs
  239. the signed data. Both clear text and opaque signing is supported.
  240. .IP "\fB\-pk7out\fR" 4
  241. .IX Item "-pk7out"
  242. Takes an input message and writes out a \s-1PEM\s0 encoded PKCS#7 structure.
  243. .IP "\fB\-resign\fR" 4
  244. .IX Item "-resign"
  245. Resign a message: take an existing message and one or more new signers.
  246. .IP "\fB\-in filename\fR" 4
  247. .IX Item "-in filename"
  248. The input message to be encrypted or signed or the \s-1MIME\s0 message to
  249. be decrypted or verified.
  250. .IP "\fB\-inform SMIME|PEM|DER\fR" 4
  251. .IX Item "-inform SMIME|PEM|DER"
  252. This specifies the input format for the PKCS#7 structure. The default
  253. is \fB\s-1SMIME\s0\fR which reads an S/MIME format message. \fB\s-1PEM\s0\fR and \fB\s-1DER\s0\fR
  254. format change this to expect \s-1PEM\s0 and \s-1DER\s0 format PKCS#7 structures
  255. instead. This currently only affects the input format of the PKCS#7
  256. structure, if no PKCS#7 structure is being input (for example with
  257. \&\fB\-encrypt\fR or \fB\-sign\fR) this option has no effect.
  258. .IP "\fB\-out filename\fR" 4
  259. .IX Item "-out filename"
  260. The message text that has been decrypted or verified or the output \s-1MIME\s0
  261. format message that has been signed or verified.
  262. .IP "\fB\-outform SMIME|PEM|DER\fR" 4
  263. .IX Item "-outform SMIME|PEM|DER"
  264. This specifies the output format for the PKCS#7 structure. The default
  265. is \fB\s-1SMIME\s0\fR which write an S/MIME format message. \fB\s-1PEM\s0\fR and \fB\s-1DER\s0\fR
  266. format change this to write \s-1PEM\s0 and \s-1DER\s0 format PKCS#7 structures
  267. instead. This currently only affects the output format of the PKCS#7
  268. structure, if no PKCS#7 structure is being output (for example with
  269. \&\fB\-verify\fR or \fB\-decrypt\fR) this option has no effect.
  270. .IP "\fB\-stream \-indef \-noindef\fR" 4
  271. .IX Item "-stream -indef -noindef"
  272. The \fB\-stream\fR and \fB\-indef\fR options are equivalent and enable streaming I/O
  273. for encoding operations. This permits single pass processing of data without
  274. the need to hold the entire contents in memory, potentially supporting very
  275. large files. Streaming is automatically set for S/MIME signing with detached
  276. data if the output format is \fB\s-1SMIME\s0\fR it is currently off by default for all
  277. other operations.
  278. .IP "\fB\-noindef\fR" 4
  279. .IX Item "-noindef"
  280. Disable streaming I/O where it would produce and indefinite length constructed
  281. encoding. This option currently has no effect. In future streaming will be
  282. enabled by default on all relevant operations and this option will disable it.
  283. .IP "\fB\-content filename\fR" 4
  284. .IX Item "-content filename"
  285. This specifies a file containing the detached content, this is only
  286. useful with the \fB\-verify\fR command. This is only usable if the PKCS#7
  287. structure is using the detached signature form where the content is
  288. not included. This option will override any content if the input format
  289. is S/MIME and it uses the multipart/signed \s-1MIME\s0 content type.
  290. .IP "\fB\-text\fR" 4
  291. .IX Item "-text"
  292. This option adds plain text (text/plain) \s-1MIME\s0 headers to the supplied
  293. message if encrypting or signing. If decrypting or verifying it strips
  294. off text headers: if the decrypted or verified message is not of \s-1MIME\s0
  295. type text/plain then an error occurs.
  296. .IP "\fB\-CAfile file\fR" 4
  297. .IX Item "-CAfile file"
  298. A file containing trusted \s-1CA\s0 certificates, only used with \fB\-verify\fR.
  299. .IP "\fB\-CApath dir\fR" 4
  300. .IX Item "-CApath dir"
  301. A directory containing trusted \s-1CA\s0 certificates, only used with
  302. \&\fB\-verify\fR. This directory must be a standard certificate directory: that
  303. is a hash of each subject name (using \fBx509 \-hash\fR) should be linked
  304. to each certificate.
  305. .IP "\fB\-no\-CAfile\fR" 4
  306. .IX Item "-no-CAfile"
  307. Do not load the trusted \s-1CA\s0 certificates from the default file location.
  308. .IP "\fB\-no\-CApath\fR" 4
  309. .IX Item "-no-CApath"
  310. Do not load the trusted \s-1CA\s0 certificates from the default directory location.
  311. .IP "\fB\-md digest\fR" 4
  312. .IX Item "-md digest"
  313. Digest algorithm to use when signing or resigning. If not present then the
  314. default digest algorithm for the signing key will be used (usually \s-1SHA1\s0).
  315. .IP "\fB\-\f(BIcipher\fB\fR" 4
  316. .IX Item "-cipher"
  317. The encryption algorithm to use. For example \s-1DES\s0 (56 bits) \- \fB\-des\fR,
  318. triple \s-1DES\s0 (168 bits) \- \fB\-des3\fR,
  319. \&\fBEVP_get_cipherbyname()\fR function) can also be used preceded by a dash, for
  320. example \fB\-aes\-128\-cbc\fR. See \fBenc\fR for list of ciphers
  321. supported by your version of OpenSSL.
  322. .Sp
  323. If not specified triple \s-1DES\s0 is used. Only used with \fB\-encrypt\fR.
  324. .IP "\fB\-nointern\fR" 4
  325. .IX Item "-nointern"
  326. When verifying a message normally certificates (if any) included in
  327. the message are searched for the signing certificate. With this option
  328. only the certificates specified in the \fB\-certfile\fR option are used.
  329. The supplied certificates can still be used as untrusted CAs however.
  330. .IP "\fB\-noverify\fR" 4
  331. .IX Item "-noverify"
  332. Do not verify the signers certificate of a signed message.
  333. .IP "\fB\-nochain\fR" 4
  334. .IX Item "-nochain"
  335. Do not do chain verification of signers certificates: that is don't
  336. use the certificates in the signed message as untrusted CAs.
  337. .IP "\fB\-nosigs\fR" 4
  338. .IX Item "-nosigs"
  339. Don't try to verify the signatures on the message.
  340. .IP "\fB\-nocerts\fR" 4
  341. .IX Item "-nocerts"
  342. When signing a message the signer's certificate is normally included
  343. with this option it is excluded. This will reduce the size of the
  344. signed message but the verifier must have a copy of the signers certificate
  345. available locally (passed using the \fB\-certfile\fR option for example).
  346. .IP "\fB\-noattr\fR" 4
  347. .IX Item "-noattr"
  348. Normally when a message is signed a set of attributes are included which
  349. include the signing time and supported symmetric algorithms. With this
  350. option they are not included.
  351. .IP "\fB\-binary\fR" 4
  352. .IX Item "-binary"
  353. Normally the input message is converted to \*(L"canonical\*(R" format which is
  354. effectively using \s-1CR\s0 and \s-1LF\s0 as end of line: as required by the S/MIME
  355. specification. When this option is present no translation occurs. This
  356. is useful when handling binary data which may not be in \s-1MIME\s0 format.
  357. .IP "\fB\-crlfeol\fR" 4
  358. .IX Item "-crlfeol"
  359. Normally the output file uses a single \fB\s-1LF\s0\fR as end of line. When this
  360. option is present \fB\s-1CRLF\s0\fR is used instead.
  361. .IP "\fB\-nodetach\fR" 4
  362. .IX Item "-nodetach"
  363. When signing a message use opaque signing: this form is more resistant
  364. to translation by mail relays but it cannot be read by mail agents that
  365. do not support S/MIME. Without this option cleartext signing with
  366. the \s-1MIME\s0 type multipart/signed is used.
  367. .IP "\fB\-certfile file\fR" 4
  368. .IX Item "-certfile file"
  369. Allows additional certificates to be specified. When signing these will
  370. be included with the message. When verifying these will be searched for
  371. the signers certificates. The certificates should be in \s-1PEM\s0 format.
  372. .IP "\fB\-signer file\fR" 4
  373. .IX Item "-signer file"
  374. A signing certificate when signing or resigning a message, this option can be
  375. used multiple times if more than one signer is required. If a message is being
  376. verified then the signers certificates will be written to this file if the
  377. verification was successful.
  378. .IP "\fB\-recip file\fR" 4
  379. .IX Item "-recip file"
  380. The recipients certificate when decrypting a message. This certificate
  381. must match one of the recipients of the message or an error occurs.
  382. .IP "\fB\-inkey file_or_id\fR" 4
  383. .IX Item "-inkey file_or_id"
  384. The private key to use when signing or decrypting. This must match the
  385. corresponding certificate. If this option is not specified then the
  386. private key must be included in the certificate file specified with
  387. the \fB\-recip\fR or \fB\-signer\fR file. When signing this option can be used
  388. multiple times to specify successive keys.
  389. If no engine is used, the argument is taken as a file; if an engine is
  390. specified, the argument is given to the engine as a key identifier.
  391. .IP "\fB\-passin arg\fR" 4
  392. .IX Item "-passin arg"
  393. The private key password source. For more information about the format of \fBarg\fR
  394. see \*(L"Pass Phrase Options\*(R" in \fBopenssl\fR\|(1).
  395. .IP "\fB\-rand file...\fR" 4
  396. .IX Item "-rand file..."
  397. A file or files containing random data used to seed the random number
  398. generator.
  399. Multiple files can be specified separated by an OS-dependent character.
  400. The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
  401. all others.
  402. .IP "[\fB\-writerand file\fR]" 4
  403. .IX Item "[-writerand file]"
  404. Writes random data to the specified \fIfile\fR upon exit.
  405. This can be used with a subsequent \fB\-rand\fR flag.
  406. .IP "\fBcert.pem...\fR" 4
  407. .IX Item "cert.pem..."
  408. One or more certificates of message recipients: used when encrypting
  409. a message.
  410. .IP "\fB\-to, \-from, \-subject\fR" 4
  411. .IX Item "-to, -from, -subject"
  412. The relevant mail headers. These are included outside the signed
  413. portion of a message so they may be included manually. If signing
  414. then many S/MIME mail clients check the signers certificate's email
  415. address matches that specified in the From: address.
  416. .IP "\fB\-attime\fR, \fB\-check_ss_sig\fR, \fB\-crl_check\fR, \fB\-crl_check_all\fR, \fB\-explicit_policy\fR, \fB\-extended_crl\fR, \fB\-ignore_critical\fR, \fB\-inhibit_any\fR, \fB\-inhibit_map\fR, \fB\-no_alt_chains\fR, \fB\-partial_chain\fR, \fB\-policy\fR, \fB\-policy_check\fR, \fB\-policy_print\fR, \fB\-purpose\fR, \fB\-suiteB_128\fR, \fB\-suiteB_128_only\fR, \fB\-suiteB_192\fR, \fB\-trusted_first\fR, \fB\-use_deltas\fR, \fB\-auth_level\fR, \fB\-verify_depth\fR, \fB\-verify_email\fR, \fB\-verify_hostname\fR, \fB\-verify_ip\fR, \fB\-verify_name\fR, \fB\-x509_strict\fR" 4
  417. .IX Item "-attime, -check_ss_sig, -crl_check, -crl_check_all, -explicit_policy, -extended_crl, -ignore_critical, -inhibit_any, -inhibit_map, -no_alt_chains, -partial_chain, -policy, -policy_check, -policy_print, -purpose, -suiteB_128, -suiteB_128_only, -suiteB_192, -trusted_first, -use_deltas, -auth_level, -verify_depth, -verify_email, -verify_hostname, -verify_ip, -verify_name, -x509_strict"
  418. Set various options of certificate chain verification. See
  419. \&\fBverify\fR\|(1) manual page for details.
  420. .SH "NOTES"
  421. .IX Header "NOTES"
  422. The \s-1MIME\s0 message must be sent without any blank lines between the
  423. headers and the output. Some mail programs will automatically add
  424. a blank line. Piping the mail directly to sendmail is one way to
  425. achieve the correct format.
  426. .PP
  427. The supplied message to be signed or encrypted must include the
  428. necessary \s-1MIME\s0 headers or many S/MIME clients won't display it
  429. properly (if at all). You can use the \fB\-text\fR option to automatically
  430. add plain text headers.
  431. .PP
  432. A \*(L"signed and encrypted\*(R" message is one where a signed message is
  433. then encrypted. This can be produced by encrypting an already signed
  434. message: see the examples section.
  435. .PP
  436. This version of the program only allows one signer per message but it
  437. will verify multiple signers on received messages. Some S/MIME clients
  438. choke if a message contains multiple signers. It is possible to sign
  439. messages \*(L"in parallel\*(R" by signing an already signed message.
  440. .PP
  441. The options \fB\-encrypt\fR and \fB\-decrypt\fR reflect common usage in S/MIME
  442. clients. Strictly speaking these process PKCS#7 enveloped data: PKCS#7
  443. encrypted data is used for other purposes.
  444. .PP
  445. The \fB\-resign\fR option uses an existing message digest when adding a new
  446. signer. This means that attributes must be present in at least one existing
  447. signer using the same message digest or this operation will fail.
  448. .PP
  449. The \fB\-stream\fR and \fB\-indef\fR options enable streaming I/O support.
  450. As a result the encoding is \s-1BER\s0 using indefinite length constructed encoding
  451. and no longer \s-1DER.\s0 Streaming is supported for the \fB\-encrypt\fR operation and the
  452. \&\fB\-sign\fR operation if the content is not detached.
  453. .PP
  454. Streaming is always used for the \fB\-sign\fR operation with detached data but
  455. since the content is no longer part of the PKCS#7 structure the encoding
  456. remains \s-1DER.\s0
  457. .SH "EXIT CODES"
  458. .IX Header "EXIT CODES"
  459. .IP "0" 4
  460. The operation was completely successfully.
  461. .IP "1" 4
  462. .IX Item "1"
  463. An error occurred parsing the command options.
  464. .IP "2" 4
  465. .IX Item "2"
  466. One of the input files could not be read.
  467. .IP "3" 4
  468. .IX Item "3"
  469. An error occurred creating the PKCS#7 file or when reading the \s-1MIME\s0
  470. message.
  471. .IP "4" 4
  472. .IX Item "4"
  473. An error occurred decrypting or verifying the message.
  474. .IP "5" 4
  475. .IX Item "5"
  476. The message was verified correctly but an error occurred writing out
  477. the signers certificates.
  478. .SH "EXAMPLES"
  479. .IX Header "EXAMPLES"
  480. Create a cleartext signed message:
  481. .PP
  482. .Vb 2
  483. \& openssl smime \-sign \-in message.txt \-text \-out mail.msg \e
  484. \& \-signer mycert.pem
  485. .Ve
  486. .PP
  487. Create an opaque signed message:
  488. .PP
  489. .Vb 2
  490. \& openssl smime \-sign \-in message.txt \-text \-out mail.msg \-nodetach \e
  491. \& \-signer mycert.pem
  492. .Ve
  493. .PP
  494. Create a signed message, include some additional certificates and
  495. read the private key from another file:
  496. .PP
  497. .Vb 2
  498. \& openssl smime \-sign \-in in.txt \-text \-out mail.msg \e
  499. \& \-signer mycert.pem \-inkey mykey.pem \-certfile mycerts.pem
  500. .Ve
  501. .PP
  502. Create a signed message with two signers:
  503. .PP
  504. .Vb 2
  505. \& openssl smime \-sign \-in message.txt \-text \-out mail.msg \e
  506. \& \-signer mycert.pem \-signer othercert.pem
  507. .Ve
  508. .PP
  509. Send a signed message under Unix directly to sendmail, including headers:
  510. .PP
  511. .Vb 3
  512. \& openssl smime \-sign \-in in.txt \-text \-signer mycert.pem \e
  513. \& \-from steve@openssl.org \-to someone@somewhere \e
  514. \& \-subject "Signed message" | sendmail someone@somewhere
  515. .Ve
  516. .PP
  517. Verify a message and extract the signer's certificate if successful:
  518. .PP
  519. .Vb 1
  520. \& openssl smime \-verify \-in mail.msg \-signer user.pem \-out signedtext.txt
  521. .Ve
  522. .PP
  523. Send encrypted mail using triple \s-1DES:\s0
  524. .PP
  525. .Vb 3
  526. \& openssl smime \-encrypt \-in in.txt \-from steve@openssl.org \e
  527. \& \-to someone@somewhere \-subject "Encrypted message" \e
  528. \& \-des3 user.pem \-out mail.msg
  529. .Ve
  530. .PP
  531. Sign and encrypt mail:
  532. .PP
  533. .Vb 4
  534. \& openssl smime \-sign \-in ml.txt \-signer my.pem \-text \e
  535. \& | openssl smime \-encrypt \-out mail.msg \e
  536. \& \-from steve@openssl.org \-to someone@somewhere \e
  537. \& \-subject "Signed and Encrypted message" \-des3 user.pem
  538. .Ve
  539. .PP
  540. Note: the encryption command does not include the \fB\-text\fR option because the
  541. message being encrypted already has \s-1MIME\s0 headers.
  542. .PP
  543. Decrypt mail:
  544. .PP
  545. .Vb 1
  546. \& openssl smime \-decrypt \-in mail.msg \-recip mycert.pem \-inkey key.pem
  547. .Ve
  548. .PP
  549. The output from Netscape form signing is a PKCS#7 structure with the
  550. detached signature format. You can use this program to verify the
  551. signature by line wrapping the base64 encoded structure and surrounding
  552. it with:
  553. .PP
  554. .Vb 2
  555. \& \-\-\-\-\-BEGIN PKCS7\-\-\-\-\-
  556. \& \-\-\-\-\-END PKCS7\-\-\-\-\-
  557. .Ve
  558. .PP
  559. and using the command:
  560. .PP
  561. .Vb 1
  562. \& openssl smime \-verify \-inform PEM \-in signature.pem \-content content.txt
  563. .Ve
  564. .PP
  565. Alternatively you can base64 decode the signature and use:
  566. .PP
  567. .Vb 1
  568. \& openssl smime \-verify \-inform DER \-in signature.der \-content content.txt
  569. .Ve
  570. .PP
  571. Create an encrypted message using 128 bit Camellia:
  572. .PP
  573. .Vb 1
  574. \& openssl smime \-encrypt \-in plain.txt \-camellia128 \-out mail.msg cert.pem
  575. .Ve
  576. .PP
  577. Add a signer to an existing message:
  578. .PP
  579. .Vb 1
  580. \& openssl smime \-resign \-in mail.msg \-signer newsign.pem \-out mail2.msg
  581. .Ve
  582. .SH "BUGS"
  583. .IX Header "BUGS"
  584. The \s-1MIME\s0 parser isn't very clever: it seems to handle most messages that I've
  585. thrown at it but it may choke on others.
  586. .PP
  587. The code currently will only write out the signer's certificate to a file: if
  588. the signer has a separate encryption certificate this must be manually
  589. extracted. There should be some heuristic that determines the correct
  590. encryption certificate.
  591. .PP
  592. Ideally a database should be maintained of a certificates for each email
  593. address.
  594. .PP
  595. The code doesn't currently take note of the permitted symmetric encryption
  596. algorithms as supplied in the SMIMECapabilities signed attribute. This means the
  597. user has to manually include the correct encryption algorithm. It should store
  598. the list of permitted ciphers in a database and only use those.
  599. .PP
  600. No revocation checking is done on the signer's certificate.
  601. .PP
  602. The current code can only handle S/MIME v2 messages, the more complex S/MIME v3
  603. structures may cause parsing errors.
  604. .SH "HISTORY"
  605. .IX Header "HISTORY"
  606. The use of multiple \fB\-signer\fR options and the \fB\-resign\fR command were first
  607. added in OpenSSL 1.0.0
  608. .PP
  609. The \-no_alt_chains option was added in OpenSSL 1.1.0.
  610. .SH "COPYRIGHT"
  611. .IX Header "COPYRIGHT"
  612. Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved.
  613. .PP
  614. Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
  615. this file except in compliance with the License. You can obtain a copy
  616. in the file \s-1LICENSE\s0 in the source distribution or at
  617. <https://www.openssl.org/source/license.html>.