index.rst (8159B)
1 .. _mozilla_projects_nss_tools_nss_tools_cmsutil: 2 3 NSS Tools cmsutil 4 ================= 5 6 .. _using_cmsutil: 7 8 `Using cmsutil <#using_cmsutil>`__ 9 ---------------------------------- 10 11 .. container:: 12 13 Newsgroup: `mozilla.dev.tech.crypto <news://news.mozilla.org/mozilla.dev.tech.crypto>`__ 14 The cmsutil command-line utility uses the `S/MIME Toolkit <../smime/>`__ to perform basic 15 operations, such as encryption and decryption, on `Cryptographic Message 16 Syntax (CMS) <http://www.ietf.org/rfc/rfc2630.txt>`__ messages. 17 18 .. _syntax_2: 19 20 ` <#syntax_2>`__ Syntax 21 ----------------------- 22 23 .. container:: 24 25 To run cmsutil, type the command ``cmsutil``\ *option*\ ``[``\ *arguments*\ ``]`` where *option* 26 and *arguments* are combinations of the options and arguments listed in the following section. 27 Each command takes one option. Each option may take zero or more arguments. To see a usage 28 string, issue the command without options. 29 30 .. _options_and_arguments: 31 32 `Options and Arguments <#options_and_arguments>`__ 33 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 34 35 .. container:: 36 37 Options specify an action. Option arguments modify an action. The options and arguments for the 38 ``cmsutil`` command are defined as follows: 39 40 +------------------------------------------------+------------------------------------------------+ 41 | **Options** | | 42 +------------------------------------------------+------------------------------------------------+ 43 | ``-D`` | Decode a message. | 44 +------------------------------------------------+------------------------------------------------+ 45 | ``-C`` | Encrypt a message. | 46 +------------------------------------------------+------------------------------------------------+ 47 | ``-E`` | Envelope a message. | 48 +------------------------------------------------+------------------------------------------------+ 49 | ``-O`` | Create a certificates-only message. | 50 +------------------------------------------------+------------------------------------------------+ 51 | ``-S`` | Sign a message. | 52 +------------------------------------------------+------------------------------------------------+ 53 | **Arguments** | | 54 +------------------------------------------------+------------------------------------------------+ 55 | ``-c`` *content* | Use this detached content (decode only). | 56 +------------------------------------------------+------------------------------------------------+ 57 | ``-d`` *dbdir* | Specify the key/certificate database directory | 58 | | (default is ".") | 59 +------------------------------------------------+------------------------------------------------+ 60 | ``-e`` *envfile* | Specify a file containing an enveloped message | 61 | | for a set of recipients to which you would | 62 | | like to send an encrypted message. If this is | 63 | | the first encrypted message for that set of | 64 | | recipients, a new enveloped message will be | 65 | | created that you can then use for future | 66 | | messages (encrypt only). | 67 +------------------------------------------------+------------------------------------------------+ 68 | ``-G`` | Include a signing time attribute (sign only). | 69 +------------------------------------------------+------------------------------------------------+ 70 | ``-h`` *num* | Generate email headers with info about CMS | 71 | | message (decode only). | 72 +------------------------------------------------+------------------------------------------------+ 73 | ``-i`` *infile* | Use *infile* as a source of data (default is | 74 | | stdin). | 75 +------------------------------------------------+------------------------------------------------+ 76 | ``-N`` *nickname* | Specify nickname of certificate to sign with | 77 | | (sign only). | 78 +------------------------------------------------+------------------------------------------------+ 79 | ``-n`` | Suppress output of contents (decode only). | 80 +------------------------------------------------+------------------------------------------------+ 81 | ``-o`` *outfile* | Use outfile as a destination of data (default | 82 | | is stdout). | 83 +------------------------------------------------+------------------------------------------------+ 84 | ``-P`` | Include an S/MIME capabilities attribute. | 85 +------------------------------------------------+------------------------------------------------+ 86 | -p *password* | Use password as key database password. | 87 +------------------------------------------------+------------------------------------------------+ 88 | - | Specify list of recipients (email addresses) | 89 | r \ *recipient1*,\ *recipient2, . . .* | for an encrypted or enveloped message. For | 90 | | certificates-only message, list of | 91 | | certificates to send. | 92 +------------------------------------------------+------------------------------------------------+ 93 | -T | Suppress content in CMS message (sign only). | 94 +------------------------------------------------+------------------------------------------------+ 95 | -u *certusage* | Set type of cert usage (default is | 96 | | <tt>certUsageEmailSigner)</tt>. | 97 +------------------------------------------------+------------------------------------------------+ 98 | <-Y *ekprefnick* | Specify an encryption key preference by | 99 | | nickname. | 100 +------------------------------------------------+------------------------------------------------+ 101 102 `Usage <#usage>`__ 103 ------------------ 104 105 .. container:: 106 107 cmsutil -C [-i *infile*] [-o *outfile*] [-d *dbdir*] [-p *password*] -r 108 "*recipient1*,\ *recipient2*, . . ." -e *envfile* 109 cmsutil -D [-i *infile*] [-o *outfile*] [-d *dbdir*] [-p *password*] [-c *content*] [-n] [-h 110 *num*] 111 112 cmsutil -E [-i *infile*] [-o *outfile*] [-d *dbdir*] [-p *password*] -r 113 "*recipient1*,\ *recipient2*, . . ." 114 115 cmsutil -O [-i *infile*] [-o *outfile*] [-d *dbdir*] [-p *password*] -r 116 "*cert1*,\ *cert2*, . . ." 117 118 cmsutil -S [-i *infile*] [-o *outfile*] [-d *dbdir*] [-p *password*] -N *nickname*\ [-TGP] [-Y 119 *ekprefnick*]