The Tor Browser / annotate

security/nss/doc/nroff/cmsutil.1@b8a032363ba2 (annotated)

security/nss/doc/nroff/cmsutil.1

Thu, 22 Jan 2015 13:21:57 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Thu, 22 Jan 2015 13:21:57 +0100
branch
TOR_BUG_9701
changeset 15
b8a032363ba2
permissions
-rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

michael@0 1 '\" t
michael@0 2 .\" Title: CMSUTIL
michael@0 3 .\" Author: [see the "Authors" section]
michael@0 4 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
michael@0 5 .\" Date: 5 June 2014
michael@0 6 .\" Manual: NSS Security Tools
michael@0 7 .\" Source: nss-tools
michael@0 8 .\" Language: English
michael@0 9 .\"
michael@0 10 .TH "CMSUTIL" "1" "5 June 2014" "nss-tools" "NSS Security Tools"
michael@0 11 .\" -----------------------------------------------------------------
michael@0 12 .\" * Define some portability stuff
michael@0 13 .\" -----------------------------------------------------------------
michael@0 14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
michael@0 15 .\" http://bugs.debian.org/507673
michael@0 16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
michael@0 17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
michael@0 18 .ie \n(.g .ds Aq \(aq
michael@0 19 .el .ds Aq '
michael@0 20 .\" -----------------------------------------------------------------
michael@0 21 .\" * set default formatting
michael@0 22 .\" -----------------------------------------------------------------
michael@0 23 .\" disable hyphenation
michael@0 24 .nh
michael@0 25 .\" disable justification (adjust text to left margin only)
michael@0 26 .ad l
michael@0 27 .\" -----------------------------------------------------------------
michael@0 28 .\" * MAIN CONTENT STARTS HERE *
michael@0 29 .\" -----------------------------------------------------------------
michael@0 30 .SH "NAME"
michael@0 31 cmsutil \- Performs basic cryptograpic operations, such as encryption and decryption, on Cryptographic Message Syntax (CMS) messages\&.
michael@0 32 .SH "SYNOPSIS"
michael@0 33 .HP \w'\fBcmsutil\fR\ 'u
michael@0 34 \fBcmsutil\fR [\fIoptions\fR] [[\fIarguments\fR]]
michael@0 35 .SH "STATUS"
michael@0 36 .PP
michael@0 37 This documentation is still work in progress\&. Please contribute to the initial review in
michael@0 38 \m[blue]\fBMozilla NSS bug 836477\fR\m[]\&\s-2\u[1]\d\s+2
michael@0 39 .SH "DESCRIPTION"
michael@0 40 .PP
michael@0 41 The
michael@0 42 \fBcmsutil\fR
michael@0 43 command\-line uses the S/MIME Toolkit to perform basic operations, such as encryption and decryption, on Cryptographic Message Syntax (CMS) messages\&.
michael@0 44 .PP
michael@0 45 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\&. Each command takes one option\&. Each option may take zero or more arguments\&. To see a usage string, issue the command without options\&.
michael@0 46 .SH "OPTIONS AND ARGUMENTS"
michael@0 47 .PP
michael@0 48 .PP
michael@0 49 \fBOptions\fR
michael@0 50 .PP
michael@0 51 Options specify an action\&. Option arguments modify an action\&. The options and arguments for the cmsutil command are defined as follows:
michael@0 52 .PP
michael@0 53 \-C
michael@0 54 .RS 4
michael@0 55 Encrypt a message\&.
michael@0 56 .RE
michael@0 57 .PP
michael@0 58 \-D
michael@0 59 .RS 4
michael@0 60 Decode a message\&.
michael@0 61 .RE
michael@0 62 .PP
michael@0 63 \-E
michael@0 64 .RS 4
michael@0 65 Envelope a message\&.
michael@0 66 .RE
michael@0 67 .PP
michael@0 68 \-O
michael@0 69 .RS 4
michael@0 70 Create a certificates\-only message\&.
michael@0 71 .RE
michael@0 72 .PP
michael@0 73 \-S
michael@0 74 .RS 4
michael@0 75 Sign a message\&.
michael@0 76 .RE
michael@0 77 .PP
michael@0 78 \fBArguments\fR
michael@0 79 .PP
michael@0 80 Option arguments modify an action\&.
michael@0 81 .PP
michael@0 82 \-b
michael@0 83 .RS 4
michael@0 84 Decode a batch of files named in infile\&.
michael@0 85 .RE
michael@0 86 .PP
michael@0 87 \-c content
michael@0 88 .RS 4
michael@0 89 Use this detached content (decode only)\&.
michael@0 90 .RE
michael@0 91 .PP
michael@0 92 \-d dbdir
michael@0 93 .RS 4
michael@0 94 Specify the key/certificate database directory (default is "\&.")
michael@0 95 .RE
michael@0 96 .PP
michael@0 97 \-e envfile
michael@0 98 .RS 4
michael@0 99 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)\&.
michael@0 100 .RE
michael@0 101 .PP
michael@0 102 \-f pwfile
michael@0 103 .RS 4
michael@0 104 Use password file to set password on all PKCS#11 tokens\&.
michael@0 105 .RE
michael@0 106 .PP
michael@0 107 \-G
michael@0 108 .RS 4
michael@0 109 Include a signing time attribute (sign only)\&.
michael@0 110 .RE
michael@0 111 .PP
michael@0 112 \-H hash
michael@0 113 .RS 4
michael@0 114 Use specified hash algorithm (default:SHA1)\&.
michael@0 115 .RE
michael@0 116 .PP
michael@0 117 \-h num
michael@0 118 .RS 4
michael@0 119 Generate email headers with info about CMS message (decode only)\&.
michael@0 120 .RE
michael@0 121 .PP
michael@0 122 \-i infile
michael@0 123 .RS 4
michael@0 124 Use infile as a source of data (default is stdin)\&.
michael@0 125 .RE
michael@0 126 .PP
michael@0 127 \-k
michael@0 128 .RS 4
michael@0 129 Keep decoded encryption certs in permanent cert db\&.
michael@0 130 .RE
michael@0 131 .PP
michael@0 132 \-N nickname
michael@0 133 .RS 4
michael@0 134 Specify nickname of certificate to sign with (sign only)\&.
michael@0 135 .RE
michael@0 136 .PP
michael@0 137 \-n
michael@0 138 .RS 4
michael@0 139 Suppress output of contents (decode only)\&.
michael@0 140 .RE
michael@0 141 .PP
michael@0 142 \-o outfile
michael@0 143 .RS 4
michael@0 144 Use outfile as a destination of data (default is stdout)\&.
michael@0 145 .RE
michael@0 146 .PP
michael@0 147 \-P
michael@0 148 .RS 4
michael@0 149 Include an S/MIME capabilities attribute\&.
michael@0 150 .RE
michael@0 151 .PP
michael@0 152 \-p password
michael@0 153 .RS 4
michael@0 154 Use password as key database password\&.
michael@0 155 .RE
michael@0 156 .PP
michael@0 157 \-r recipient1,recipient2, \&.\&.\&.
michael@0 158 .RS 4
michael@0 159 Specify list of recipients (email addresses) for an encrypted or enveloped message\&. For certificates\-only message, list of certificates to send\&.
michael@0 160 .RE
michael@0 161 .PP
michael@0 162 \-T
michael@0 163 .RS 4
michael@0 164 Suppress content in CMS message (sign only)\&.
michael@0 165 .RE
michael@0 166 .PP
michael@0 167 \-u certusage
michael@0 168 .RS 4
michael@0 169 Set type of cert usage (default is certUsageEmailSigner)\&.
michael@0 170 .RE
michael@0 171 .PP
michael@0 172 \-v
michael@0 173 .RS 4
michael@0 174 Print debugging information\&.
michael@0 175 .RE
michael@0 176 .PP
michael@0 177 \-Y ekprefnick
michael@0 178 .RS 4
michael@0 179 Specify an encryption key preference by nickname\&.
michael@0 180 .RE
michael@0 181 .SH "USAGE"
michael@0 182 .PP
michael@0 183 Encrypt Example
michael@0 184 .sp
michael@0 185 .if n \{\
michael@0 186 .RS 4
michael@0 187 .\}
michael@0 188 .nf
michael@0 189 cmsutil \-C [\-i infile] [\-o outfile] [\-d dbdir] [\-p password] \-r "recipient1,recipient2, \&. \&. \&." \-e envfile
michael@0 190
michael@0 191 .fi
michael@0 192 .if n \{\
michael@0 193 .RE
michael@0 194 .\}
michael@0 195 .PP
michael@0 196 Decode Example
michael@0 197 .sp
michael@0 198 .if n \{\
michael@0 199 .RS 4
michael@0 200 .\}
michael@0 201 .nf
michael@0 202 cmsutil \-D [\-i infile] [\-o outfile] [\-d dbdir] [\-p password] [\-c content] [\-n] [\-h num]
michael@0 203
michael@0 204 .fi
michael@0 205 .if n \{\
michael@0 206 .RE
michael@0 207 .\}
michael@0 208 .PP
michael@0 209 Envelope Example
michael@0 210 .sp
michael@0 211 .if n \{\
michael@0 212 .RS 4
michael@0 213 .\}
michael@0 214 .nf
michael@0 215 cmsutil \-E [\-i infile] [\-o outfile] [\-d dbdir] [\-p password] \-r "recipient1,recipient2, \&.\&.\&."
michael@0 216
michael@0 217 .fi
michael@0 218 .if n \{\
michael@0 219 .RE
michael@0 220 .\}
michael@0 221 .PP
michael@0 222 Certificate\-only Example
michael@0 223 .sp
michael@0 224 .if n \{\
michael@0 225 .RS 4
michael@0 226 .\}
michael@0 227 .nf
michael@0 228 cmsutil \-O [\-i infile] [\-o outfile] [\-d dbdir] [\-p password] \-r "cert1,cert2, \&. \&. \&."
michael@0 229
michael@0 230 .fi
michael@0 231 .if n \{\
michael@0 232 .RE
michael@0 233 .\}
michael@0 234 .PP
michael@0 235 Sign Message Example
michael@0 236 .sp
michael@0 237 .if n \{\
michael@0 238 .RS 4
michael@0 239 .\}
michael@0 240 .nf
michael@0 241 cmsutil \-S [\-i infile] [\-o outfile] [\-d dbdir] [\-p password] \-N nickname[\-TGP] [\-Y ekprefnick]
michael@0 242
michael@0 243 .fi
michael@0 244 .if n \{\
michael@0 245 .RE
michael@0 246 .\}
michael@0 247 .SH "SEE ALSO"
michael@0 248 .PP
michael@0 249 certutil(1)
michael@0 250 .SH "ADDITIONAL RESOURCES"
michael@0 251 .PP
michael@0 252 For information about NSS and other tools related to NSS (like JSS), check out the NSS project wiki at
michael@0 253 \m[blue]\fBhttp://www\&.mozilla\&.org/projects/security/pki/nss/\fR\m[]\&. The NSS site relates directly to NSS code changes and releases\&.
michael@0 254 .PP
michael@0 255 Mailing lists: https://lists\&.mozilla\&.org/listinfo/dev\-tech\-crypto
michael@0 256 .PP
michael@0 257 IRC: Freenode at #dogtag\-pki
michael@0 258 .SH "AUTHORS"
michael@0 259 .PP
michael@0 260 The NSS tools were written and maintained by developers with Netscape, Red Hat, Sun, Oracle, Mozilla, and Google\&.
michael@0 261 .PP
michael@0 262 Authors: Elio Maldonado <emaldona@redhat\&.com>, Deon Lackey <dlackey@redhat\&.com>\&.
michael@0 263 .SH "LICENSE"
michael@0 264 .PP
michael@0 265 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 266 .SH "NOTES"
michael@0 267 .IP " 1." 4
michael@0 268 Mozilla NSS bug 836477
michael@0 269 .RS 4
michael@0 270 \%https://bugzilla.mozilla.org/show_bug.cgi?id=836477
michael@0 271 .RE

Mercurial Repository: The Tor Browser

Europalab SCM Repository Server

mercurial