1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/security/nss/doc/nroff/cmsutil.1 Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,271 @@
1.4 +'\" t
1.5 +.\" Title: CMSUTIL
1.6 +.\" Author: [see the "Authors" section]
1.7 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
1.8 +.\" Date: 5 June 2014
1.9 +.\" Manual: NSS Security Tools
1.10 +.\" Source: nss-tools
1.11 +.\" Language: English
1.12 +.\"
1.13 +.TH "CMSUTIL" "1" "5 June 2014" "nss-tools" "NSS Security Tools"
1.14 +.\" -----------------------------------------------------------------
1.15 +.\" * Define some portability stuff
1.16 +.\" -----------------------------------------------------------------
1.17 +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1.18 +.\" http://bugs.debian.org/507673
1.19 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
1.20 +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1.21 +.ie \n(.g .ds Aq \(aq
1.22 +.el .ds Aq '
1.23 +.\" -----------------------------------------------------------------
1.24 +.\" * set default formatting
1.25 +.\" -----------------------------------------------------------------
1.26 +.\" disable hyphenation
1.27 +.nh
1.28 +.\" disable justification (adjust text to left margin only)
1.29 +.ad l
1.30 +.\" -----------------------------------------------------------------
1.31 +.\" * MAIN CONTENT STARTS HERE *
1.32 +.\" -----------------------------------------------------------------
1.33 +.SH "NAME"
1.34 +cmsutil \- Performs basic cryptograpic operations, such as encryption and decryption, on Cryptographic Message Syntax (CMS) messages\&.
1.35 +.SH "SYNOPSIS"
1.36 +.HP \w'\fBcmsutil\fR\ 'u
1.37 +\fBcmsutil\fR [\fIoptions\fR] [[\fIarguments\fR]]
1.38 +.SH "STATUS"
1.39 +.PP
1.40 +This documentation is still work in progress\&. Please contribute to the initial review in
1.41 +\m[blue]\fBMozilla NSS bug 836477\fR\m[]\&\s-2\u[1]\d\s+2
1.42 +.SH "DESCRIPTION"
1.43 +.PP
1.44 +The
1.45 +\fBcmsutil\fR
1.46 +command\-line uses the S/MIME Toolkit to perform basic operations, such as encryption and decryption, on Cryptographic Message Syntax (CMS) messages\&.
1.47 +.PP
1.48 +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\&.
1.49 +.SH "OPTIONS AND ARGUMENTS"
1.50 +.PP
1.51 +.PP
1.52 +\fBOptions\fR
1.53 +.PP
1.54 +Options specify an action\&. Option arguments modify an action\&. The options and arguments for the cmsutil command are defined as follows:
1.55 +.PP
1.56 +\-C
1.57 +.RS 4
1.58 +Encrypt a message\&.
1.59 +.RE
1.60 +.PP
1.61 +\-D
1.62 +.RS 4
1.63 +Decode a message\&.
1.64 +.RE
1.65 +.PP
1.66 +\-E
1.67 +.RS 4
1.68 +Envelope a message\&.
1.69 +.RE
1.70 +.PP
1.71 +\-O
1.72 +.RS 4
1.73 +Create a certificates\-only message\&.
1.74 +.RE
1.75 +.PP
1.76 +\-S
1.77 +.RS 4
1.78 +Sign a message\&.
1.79 +.RE
1.80 +.PP
1.81 +\fBArguments\fR
1.82 +.PP
1.83 +Option arguments modify an action\&.
1.84 +.PP
1.85 +\-b
1.86 +.RS 4
1.87 +Decode a batch of files named in infile\&.
1.88 +.RE
1.89 +.PP
1.90 +\-c content
1.91 +.RS 4
1.92 +Use this detached content (decode only)\&.
1.93 +.RE
1.94 +.PP
1.95 +\-d dbdir
1.96 +.RS 4
1.97 +Specify the key/certificate database directory (default is "\&.")
1.98 +.RE
1.99 +.PP
1.100 +\-e envfile
1.101 +.RS 4
1.102 +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)\&.
1.103 +.RE
1.104 +.PP
1.105 +\-f pwfile
1.106 +.RS 4
1.107 +Use password file to set password on all PKCS#11 tokens\&.
1.108 +.RE
1.109 +.PP
1.110 +\-G
1.111 +.RS 4
1.112 +Include a signing time attribute (sign only)\&.
1.113 +.RE
1.114 +.PP
1.115 +\-H hash
1.116 +.RS 4
1.117 +Use specified hash algorithm (default:SHA1)\&.
1.118 +.RE
1.119 +.PP
1.120 +\-h num
1.121 +.RS 4
1.122 +Generate email headers with info about CMS message (decode only)\&.
1.123 +.RE
1.124 +.PP
1.125 +\-i infile
1.126 +.RS 4
1.127 +Use infile as a source of data (default is stdin)\&.
1.128 +.RE
1.129 +.PP
1.130 +\-k
1.131 +.RS 4
1.132 +Keep decoded encryption certs in permanent cert db\&.
1.133 +.RE
1.134 +.PP
1.135 +\-N nickname
1.136 +.RS 4
1.137 +Specify nickname of certificate to sign with (sign only)\&.
1.138 +.RE
1.139 +.PP
1.140 +\-n
1.141 +.RS 4
1.142 +Suppress output of contents (decode only)\&.
1.143 +.RE
1.144 +.PP
1.145 +\-o outfile
1.146 +.RS 4
1.147 +Use outfile as a destination of data (default is stdout)\&.
1.148 +.RE
1.149 +.PP
1.150 +\-P
1.151 +.RS 4
1.152 +Include an S/MIME capabilities attribute\&.
1.153 +.RE
1.154 +.PP
1.155 +\-p password
1.156 +.RS 4
1.157 +Use password as key database password\&.
1.158 +.RE
1.159 +.PP
1.160 +\-r recipient1,recipient2, \&.\&.\&.
1.161 +.RS 4
1.162 +Specify list of recipients (email addresses) for an encrypted or enveloped message\&. For certificates\-only message, list of certificates to send\&.
1.163 +.RE
1.164 +.PP
1.165 +\-T
1.166 +.RS 4
1.167 +Suppress content in CMS message (sign only)\&.
1.168 +.RE
1.169 +.PP
1.170 +\-u certusage
1.171 +.RS 4
1.172 +Set type of cert usage (default is certUsageEmailSigner)\&.
1.173 +.RE
1.174 +.PP
1.175 +\-v
1.176 +.RS 4
1.177 +Print debugging information\&.
1.178 +.RE
1.179 +.PP
1.180 +\-Y ekprefnick
1.181 +.RS 4
1.182 +Specify an encryption key preference by nickname\&.
1.183 +.RE
1.184 +.SH "USAGE"
1.185 +.PP
1.186 +Encrypt Example
1.187 +.sp
1.188 +.if n \{\
1.189 +.RS 4
1.190 +.\}
1.191 +.nf
1.192 +cmsutil \-C [\-i infile] [\-o outfile] [\-d dbdir] [\-p password] \-r "recipient1,recipient2, \&. \&. \&." \-e envfile
1.193 +
1.194 +.fi
1.195 +.if n \{\
1.196 +.RE
1.197 +.\}
1.198 +.PP
1.199 +Decode Example
1.200 +.sp
1.201 +.if n \{\
1.202 +.RS 4
1.203 +.\}
1.204 +.nf
1.205 +cmsutil \-D [\-i infile] [\-o outfile] [\-d dbdir] [\-p password] [\-c content] [\-n] [\-h num]
1.206 +
1.207 +.fi
1.208 +.if n \{\
1.209 +.RE
1.210 +.\}
1.211 +.PP
1.212 +Envelope Example
1.213 +.sp
1.214 +.if n \{\
1.215 +.RS 4
1.216 +.\}
1.217 +.nf
1.218 +cmsutil \-E [\-i infile] [\-o outfile] [\-d dbdir] [\-p password] \-r "recipient1,recipient2, \&.\&.\&."
1.219 +
1.220 +.fi
1.221 +.if n \{\
1.222 +.RE
1.223 +.\}
1.224 +.PP
1.225 +Certificate\-only Example
1.226 +.sp
1.227 +.if n \{\
1.228 +.RS 4
1.229 +.\}
1.230 +.nf
1.231 +cmsutil \-O [\-i infile] [\-o outfile] [\-d dbdir] [\-p password] \-r "cert1,cert2, \&. \&. \&."
1.232 +
1.233 +.fi
1.234 +.if n \{\
1.235 +.RE
1.236 +.\}
1.237 +.PP
1.238 +Sign Message Example
1.239 +.sp
1.240 +.if n \{\
1.241 +.RS 4
1.242 +.\}
1.243 +.nf
1.244 +cmsutil \-S [\-i infile] [\-o outfile] [\-d dbdir] [\-p password] \-N nickname[\-TGP] [\-Y ekprefnick]
1.245 +
1.246 +.fi
1.247 +.if n \{\
1.248 +.RE
1.249 +.\}
1.250 +.SH "SEE ALSO"
1.251 +.PP
1.252 +certutil(1)
1.253 +.SH "ADDITIONAL RESOURCES"
1.254 +.PP
1.255 +For information about NSS and other tools related to NSS (like JSS), check out the NSS project wiki at
1.256 +\m[blue]\fBhttp://www\&.mozilla\&.org/projects/security/pki/nss/\fR\m[]\&. The NSS site relates directly to NSS code changes and releases\&.
1.257 +.PP
1.258 +Mailing lists: https://lists\&.mozilla\&.org/listinfo/dev\-tech\-crypto
1.259 +.PP
1.260 +IRC: Freenode at #dogtag\-pki
1.261 +.SH "AUTHORS"
1.262 +.PP
1.263 +The NSS tools were written and maintained by developers with Netscape, Red Hat, Sun, Oracle, Mozilla, and Google\&.
1.264 +.PP
1.265 +Authors: Elio Maldonado <emaldona@redhat\&.com>, Deon Lackey <dlackey@redhat\&.com>\&.
1.266 +.SH "LICENSE"
1.267 +.PP
1.268 +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/\&.
1.269 +.SH "NOTES"
1.270 +.IP " 1." 4
1.271 +Mozilla NSS bug 836477
1.272 +.RS 4
1.273 +\%https://bugzilla.mozilla.org/show_bug.cgi?id=836477
1.274 +.RE
