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