security/nss/doc/cmsutil.xml@6474c204b198 (annotated)
security/nss/doc/cmsutil.xml
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | <?xml version="1.0" encoding="UTF-8"?> |
| michael@0 | 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
| michael@0 | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ |
| michael@0 | 4 | <!ENTITY date SYSTEM "date.xml"> |
| michael@0 | 5 | <!ENTITY version SYSTEM "version.xml"> |
| michael@0 | 6 | ]> |
| michael@0 | 7 | |
| michael@0 | 8 | <refentry id="cmsutil"> |
| michael@0 | 9 | |
| michael@0 | 10 | <refentryinfo> |
| michael@0 | 11 | <date>&date;</date> |
| michael@0 | 12 | <title>NSS Security Tools</title> |
| michael@0 | 13 | <productname>nss-tools</productname> |
| michael@0 | 14 | <productnumber>&version;</productnumber> |
| michael@0 | 15 | </refentryinfo> |
| michael@0 | 16 | |
| michael@0 | 17 | <refmeta> |
| michael@0 | 18 | <refentrytitle>CMSUTIL</refentrytitle> |
| michael@0 | 19 | <manvolnum>1</manvolnum> |
| michael@0 | 20 | </refmeta> |
| michael@0 | 21 | |
| michael@0 | 22 | <refnamediv> |
| michael@0 | 23 | <refname>cmsutil</refname> |
| michael@0 | 24 | <refpurpose>Performs basic cryptograpic operations, such as encryption and decryption, on Cryptographic Message Syntax (CMS) messages.</refpurpose> |
| michael@0 | 25 | </refnamediv> |
| michael@0 | 26 | |
| michael@0 | 27 | <refsynopsisdiv> |
| michael@0 | 28 | <cmdsynopsis> |
| michael@0 | 29 | <command>cmsutil</command> |
| michael@0 | 30 | <arg><replaceable>options</replaceable></arg> |
| michael@0 | 31 | <arg>[<replaceable>arguments</replaceable>]</arg> |
| michael@0 | 32 | </cmdsynopsis> |
| michael@0 | 33 | </refsynopsisdiv> |
| michael@0 | 34 | |
| michael@0 | 35 | <refsection> |
| michael@0 | 36 | <title>STATUS</title> |
| michael@0 | 37 | <para>This documentation is still work in progress. Please contribute to the initial review in <ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=836477">Mozilla NSS bug 836477</ulink> |
| michael@0 | 38 | </para> |
| michael@0 | 39 | </refsection> |
| michael@0 | 40 | |
| michael@0 | 41 | <refsection id="description"> |
| michael@0 | 42 | <title>Description</title> |
| michael@0 | 43 | |
| michael@0 | 44 | <para>The <command>cmsutil</command> command-line uses the S/MIME Toolkit to perform basic operations, such as encryption and decryption, on Cryptographic Message Syntax (CMS) messages. |
| michael@0 | 45 | </para> |
| michael@0 | 46 | <para> |
| michael@0 | 47 | To run cmsutil, type the command cmsutil option [arguments] where option and arguments are combinations of the options and arguments listed in the following section. |
| michael@0 | 48 | Each command takes one option. Each option may take zero or more arguments. |
| michael@0 | 49 | To see a usage string, issue the command without options. |
| michael@0 | 50 | </para> |
| michael@0 | 51 | |
| michael@0 | 52 | </refsection> |
| michael@0 | 53 | |
| michael@0 | 54 | <refsection id="options"> |
| michael@0 | 55 | <title>Options and Arguments</title> |
| michael@0 | 56 | <para> |
| michael@0 | 57 | </para> |
| michael@0 | 58 | <para><command>Options</command></para> |
| michael@0 | 59 | <para> |
| michael@0 | 60 | Options specify an action. Option arguments modify an action. |
| michael@0 | 61 | The options and arguments for the cmsutil command are defined as follows: |
| michael@0 | 62 | </para> |
| michael@0 | 63 | <variablelist> |
| michael@0 | 64 | <varlistentry> |
| michael@0 | 65 | <term>-C</term> |
| michael@0 | 66 | <listitem><para>Encrypt a message.</para></listitem> |
| michael@0 | 67 | </varlistentry> |
| michael@0 | 68 | |
| michael@0 | 69 | <varlistentry> |
| michael@0 | 70 | <term>-D </term> |
| michael@0 | 71 | <listitem><para>Decode a message.</para></listitem> |
| michael@0 | 72 | </varlistentry> |
| michael@0 | 73 | |
| michael@0 | 74 | <varlistentry> |
| michael@0 | 75 | <term>-E </term> |
| michael@0 | 76 | <listitem><para>Envelope a message.</para></listitem> |
| michael@0 | 77 | </varlistentry> |
| michael@0 | 78 | |
| michael@0 | 79 | <varlistentry> |
| michael@0 | 80 | <term>-O </term> |
| michael@0 | 81 | <listitem><para>Create a certificates-only message.</para></listitem> |
| michael@0 | 82 | </varlistentry> |
| michael@0 | 83 | |
| michael@0 | 84 | <varlistentry> |
| michael@0 | 85 | <term>-S </term> |
| michael@0 | 86 | <listitem><para>Sign a message.</para></listitem> |
| michael@0 | 87 | </varlistentry> |
| michael@0 | 88 | |
| michael@0 | 89 | </variablelist> |
| michael@0 | 90 | |
| michael@0 | 91 | <para><command>Arguments</command></para> |
| michael@0 | 92 | <para>Option arguments modify an action.</para> |
| michael@0 | 93 | <variablelist> |
| michael@0 | 94 | <varlistentry> |
| michael@0 | 95 | <term>-b </term> |
| michael@0 | 96 | <listitem> |
| michael@0 | 97 | <para>Decode a batch of files named in infile.</para> |
| michael@0 | 98 | </listitem> |
| michael@0 | 99 | </varlistentry> |
| michael@0 | 100 | |
| michael@0 | 101 | <varlistentry> |
| michael@0 | 102 | <term>-c content </term> |
| michael@0 | 103 | <listitem> |
| michael@0 | 104 | <para>Use this detached content (decode only).</para> |
| michael@0 | 105 | </listitem> |
| michael@0 | 106 | </varlistentry> |
| michael@0 | 107 | |
| michael@0 | 108 | <varlistentry> |
| michael@0 | 109 | <term>-d dbdir</term> |
| michael@0 | 110 | <listitem> |
| michael@0 | 111 | <para>Specify the key/certificate database directory (default is ".")</para> |
| michael@0 | 112 | </listitem> |
| michael@0 | 113 | </varlistentry> |
| michael@0 | 114 | |
| michael@0 | 115 | <varlistentry> |
| michael@0 | 116 | <term>-e envfile</term> |
| michael@0 | 117 | <listitem> |
| michael@0 | 118 | <para>Specify a file containing an enveloped message for a set of recipients to which you would like to send an encrypted message. If this is the first encrypted message for that set of recipients, a new enveloped message will be created that you can then use for future messages (encrypt only).</para> |
| michael@0 | 119 | </listitem> |
| michael@0 | 120 | </varlistentry> |
| michael@0 | 121 | |
| michael@0 | 122 | <varlistentry> |
| michael@0 | 123 | <term>-f pwfile</term> |
| michael@0 | 124 | <listitem> |
| michael@0 | 125 | <para>Use password file to set password on all PKCS#11 tokens.</para> |
| michael@0 | 126 | </listitem> |
| michael@0 | 127 | </varlistentry> |
| michael@0 | 128 | |
| michael@0 | 129 | <varlistentry> |
| michael@0 | 130 | <term>-G</term> |
| michael@0 | 131 | <listitem> |
| michael@0 | 132 | <para>Include a signing time attribute (sign only).</para> |
| michael@0 | 133 | </listitem> |
| michael@0 | 134 | </varlistentry> |
| michael@0 | 135 | |
| michael@0 | 136 | <varlistentry> |
| michael@0 | 137 | <term>-H hash</term> |
| michael@0 | 138 | <listitem> |
| michael@0 | 139 | <para>Use specified hash algorithm (default:SHA1).</para> |
| michael@0 | 140 | </listitem> |
| michael@0 | 141 | </varlistentry> |
| michael@0 | 142 | |
| michael@0 | 143 | <varlistentry> |
| michael@0 | 144 | <term>-h num</term> |
| michael@0 | 145 | <listitem> |
| michael@0 | 146 | <para>Generate email headers with info about CMS message (decode only).</para> |
| michael@0 | 147 | </listitem> |
| michael@0 | 148 | </varlistentry> |
| michael@0 | 149 | |
| michael@0 | 150 | <varlistentry> |
| michael@0 | 151 | <term>-i infile</term> |
| michael@0 | 152 | <listitem> |
| michael@0 | 153 | <para>Use infile as a source of data (default is stdin).</para> |
| michael@0 | 154 | </listitem> |
| michael@0 | 155 | </varlistentry> |
| michael@0 | 156 | |
| michael@0 | 157 | <varlistentry> |
| michael@0 | 158 | <term>-k</term> |
| michael@0 | 159 | <listitem> |
| michael@0 | 160 | <para>Keep decoded encryption certs in permanent cert db.</para> |
| michael@0 | 161 | </listitem> |
| michael@0 | 162 | </varlistentry> |
| michael@0 | 163 | |
| michael@0 | 164 | <varlistentry> |
| michael@0 | 165 | <term>-N nickname</term> |
| michael@0 | 166 | <listitem> |
| michael@0 | 167 | <para>Specify nickname of certificate to sign with (sign only).</para> |
| michael@0 | 168 | </listitem> |
| michael@0 | 169 | </varlistentry> |
| michael@0 | 170 | |
| michael@0 | 171 | <varlistentry> |
| michael@0 | 172 | <term>-n </term> |
| michael@0 | 173 | <listitem> |
| michael@0 | 174 | <para>Suppress output of contents (decode only).</para> |
| michael@0 | 175 | </listitem> |
| michael@0 | 176 | </varlistentry> |
| michael@0 | 177 | |
| michael@0 | 178 | <varlistentry> |
| michael@0 | 179 | <term>-o outfile</term> |
| michael@0 | 180 | <listitem> |
| michael@0 | 181 | <para>Use outfile as a destination of data (default is stdout).</para> |
| michael@0 | 182 | </listitem> |
| michael@0 | 183 | </varlistentry> |
| michael@0 | 184 | |
| michael@0 | 185 | <varlistentry> |
| michael@0 | 186 | <term>-P</term> |
| michael@0 | 187 | <listitem> |
| michael@0 | 188 | <para>Include an S/MIME capabilities attribute.</para> |
| michael@0 | 189 | </listitem> |
| michael@0 | 190 | </varlistentry> |
| michael@0 | 191 | |
| michael@0 | 192 | <varlistentry> |
| michael@0 | 193 | <term>-p password</term> |
| michael@0 | 194 | <listitem> |
| michael@0 | 195 | <para>Use password as key database password.</para> |
| michael@0 | 196 | </listitem> |
| michael@0 | 197 | </varlistentry> |
| michael@0 | 198 | |
| michael@0 | 199 | <varlistentry> |
| michael@0 | 200 | <term>-r recipient1,recipient2, ...</term> |
| michael@0 | 201 | <listitem> |
| michael@0 | 202 | <para> |
| michael@0 | 203 | Specify list of recipients (email addresses) for an encrypted or enveloped message. |
| michael@0 | 204 | For certificates-only message, list of certificates to send. |
| michael@0 | 205 | </para> |
| michael@0 | 206 | </listitem> |
| michael@0 | 207 | </varlistentry> |
| michael@0 | 208 | |
| michael@0 | 209 | <varlistentry> |
| michael@0 | 210 | <term>-T</term> |
| michael@0 | 211 | <listitem> |
| michael@0 | 212 | <para>Suppress content in CMS message (sign only).</para> |
| michael@0 | 213 | </listitem> |
| michael@0 | 214 | </varlistentry> |
| michael@0 | 215 | |
| michael@0 | 216 | <varlistentry> |
| michael@0 | 217 | <term>-u certusage</term> |
| michael@0 | 218 | <listitem> |
| michael@0 | 219 | <para>Set type of cert usage (default is certUsageEmailSigner).</para> |
| michael@0 | 220 | </listitem> |
| michael@0 | 221 | </varlistentry> |
| michael@0 | 222 | |
| michael@0 | 223 | <varlistentry> |
| michael@0 | 224 | <term>-v</term> |
| michael@0 | 225 | <listitem> |
| michael@0 | 226 | <para>Print debugging information.</para> |
| michael@0 | 227 | </listitem> |
| michael@0 | 228 | </varlistentry> |
| michael@0 | 229 | |
| michael@0 | 230 | <varlistentry> |
| michael@0 | 231 | <term>-Y ekprefnick</term> |
| michael@0 | 232 | <listitem> |
| michael@0 | 233 | <para>Specify an encryption key preference by nickname.</para> |
| michael@0 | 234 | </listitem> |
| michael@0 | 235 | </varlistentry> |
| michael@0 | 236 | |
| michael@0 | 237 | </variablelist> |
| michael@0 | 238 | |
| michael@0 | 239 | </refsection> |
| michael@0 | 240 | |
| michael@0 | 241 | <refsection id="usage"> |
| michael@0 | 242 | <title>Usage</title> |
| michael@0 | 243 | <para>Encrypt Example</para> |
| michael@0 | 244 | <programlisting> |
| michael@0 | 245 | cmsutil -C [-i infile] [-o outfile] [-d dbdir] [-p password] -r "recipient1,recipient2, . . ." -e envfile |
| michael@0 | 246 | </programlisting> |
| michael@0 | 247 | |
| michael@0 | 248 | <para>Decode Example</para> |
| michael@0 | 249 | <programlisting> |
| michael@0 | 250 | cmsutil -D [-i infile] [-o outfile] [-d dbdir] [-p password] [-c content] [-n] [-h num] |
| michael@0 | 251 | </programlisting> |
| michael@0 | 252 | |
| michael@0 | 253 | <para>Envelope Example</para> |
| michael@0 | 254 | <programlisting> |
| michael@0 | 255 | cmsutil -E [-i infile] [-o outfile] [-d dbdir] [-p password] -r "recipient1,recipient2, ..." |
| michael@0 | 256 | </programlisting> |
| michael@0 | 257 | |
| michael@0 | 258 | <para>Certificate-only Example</para> |
| michael@0 | 259 | <programlisting> |
| michael@0 | 260 | cmsutil -O [-i infile] [-o outfile] [-d dbdir] [-p password] -r "cert1,cert2, . . ." |
| michael@0 | 261 | </programlisting> |
| michael@0 | 262 | |
| michael@0 | 263 | <para>Sign Message Example</para> |
| michael@0 | 264 | <programlisting> |
| michael@0 | 265 | cmsutil -S [-i infile] [-o outfile] [-d dbdir] [-p password] -N nickname[-TGP] [-Y ekprefnick] |
| michael@0 | 266 | </programlisting> |
| michael@0 | 267 | |
| michael@0 | 268 | </refsection> |
| michael@0 | 269 | |
| michael@0 | 270 | <refsection id="seealso"> |
| michael@0 | 271 | <title>See also</title> |
| michael@0 | 272 | <para>certutil(1)</para> |
| michael@0 | 273 | </refsection> |
| michael@0 | 274 | |
| michael@0 | 275 | <!-- don't change --> |
| michael@0 | 276 | <refsection id="resources"> |
| michael@0 | 277 | <title>Additional Resources</title> |
| michael@0 | 278 | <para>For information about NSS and other tools related to NSS (like JSS), check out the NSS project wiki at <ulink url="http://www.mozilla.org/projects/security/pki/nss/">http://www.mozilla.org/projects/security/pki/nss/</ulink>. The NSS site relates directly to NSS code changes and releases.</para> |
| michael@0 | 279 | <para>Mailing lists: https://lists.mozilla.org/listinfo/dev-tech-crypto</para> |
| michael@0 | 280 | <para>IRC: Freenode at #dogtag-pki</para> |
| michael@0 | 281 | </refsection> |
| michael@0 | 282 | |
| michael@0 | 283 | <!-- fill in your name first; keep the other names for reference --> |
| michael@0 | 284 | <refsection id="authors"> |
| michael@0 | 285 | <title>Authors</title> |
| michael@0 | 286 | <para>The NSS tools were written and maintained by developers with Netscape, Red Hat, Sun, Oracle, Mozilla, and Google.</para> |
| michael@0 | 287 | <para> |
| michael@0 | 288 | Authors: Elio Maldonado <emaldona@redhat.com>, Deon Lackey <dlackey@redhat.com>. |
| michael@0 | 289 | </para> |
| michael@0 | 290 | </refsection> |
| michael@0 | 291 | |
| michael@0 | 292 | <!-- don't change --> |
| michael@0 | 293 | <refsection id="license"> |
| michael@0 | 294 | <title>LICENSE</title> |
| michael@0 | 295 | <para>Licensed under the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. |
| michael@0 | 296 | </para> |
| michael@0 | 297 | </refsection> |
| michael@0 | 298 | |
| michael@0 | 299 | </refentry> |
