The Tor Browser / file comparison
comparison: security/nss/doc/nroff/crlutil.1
security/nss/doc/nroff/crlutil.1
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
equal
deleted
inserted
replaced
| -1:000000000000 | 0:16b0b9c1f6cc |
|---|---|
| 1 '\" t | |
| 2 .\" Title: CRLUTIL | |
| 3 .\" Author: [see the "Authors" section] | |
| 4 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> | |
| 5 .\" Date: 5 June 2014 | |
| 6 .\" Manual: NSS Security Tools | |
| 7 .\" Source: nss-tools | |
| 8 .\" Language: English | |
| 9 .\" | |
| 10 .TH "CRLUTIL" "1" "5 June 2014" "nss-tools" "NSS Security Tools" | |
| 11 .\" ----------------------------------------------------------------- | |
| 12 .\" * Define some portability stuff | |
| 13 .\" ----------------------------------------------------------------- | |
| 14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 15 .\" http://bugs.debian.org/507673 | |
| 16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html | |
| 17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 18 .ie \n(.g .ds Aq \(aq | |
| 19 .el .ds Aq ' | |
| 20 .\" ----------------------------------------------------------------- | |
| 21 .\" * set default formatting | |
| 22 .\" ----------------------------------------------------------------- | |
| 23 .\" disable hyphenation | |
| 24 .nh | |
| 25 .\" disable justification (adjust text to left margin only) | |
| 26 .ad l | |
| 27 .\" ----------------------------------------------------------------- | |
| 28 .\" * MAIN CONTENT STARTS HERE * | |
| 29 .\" ----------------------------------------------------------------- | |
| 30 .SH "NAME" | |
| 31 crlutil \- List, generate, modify, or delete CRLs within the NSS security database file(s) and list, create, modify or delete certificates entries in a particular CRL\&. | |
| 32 .SH "SYNOPSIS" | |
| 33 .HP \w'\fBcrlutil\fR\ 'u | |
| 34 \fBcrlutil\fR [\fIoptions\fR] [[\fIarguments\fR]] | |
| 35 .SH "STATUS" | |
| 36 .PP | |
| 37 This documentation is still work in progress\&. Please contribute to the initial review in | |
| 38 \m[blue]\fBMozilla NSS bug 836477\fR\m[]\&\s-2\u[1]\d\s+2 | |
| 39 .SH "DESCRIPTION" | |
| 40 .PP | |
| 41 The Certificate Revocation List (CRL) Management Tool, | |
| 42 \fBcrlutil\fR, is a command\-line utility that can list, generate, modify, or delete CRLs within the NSS security database file(s) and list, create, modify or delete certificates entries in a particular CRL\&. | |
| 43 .PP | |
| 44 The key and certificate management process generally begins with creating keys in the key database, then generating and managing certificates in the certificate database(see certutil tool) and continues with certificates expiration or revocation\&. | |
| 45 .PP | |
| 46 This document discusses certificate revocation list management\&. For information on security module database management, see Using the Security Module Database Tool\&. For information on certificate and key database management, see Using the Certificate Database Tool\&. | |
| 47 .PP | |
| 48 To run the Certificate Revocation List Management Tool, type the command | |
| 49 .PP | |
| 50 crlutil option [arguments] | |
| 51 .PP | |
| 52 where options 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, or with the \-H option\&. | |
| 53 .SH "OPTIONS AND ARGUMENTS" | |
| 54 .PP | |
| 55 .PP | |
| 56 \fBOptions\fR | |
| 57 .PP | |
| 58 Options specify an action\&. Option arguments modify an action\&. The options and arguments for the crlutil command are defined as follows: | |
| 59 .PP | |
| 60 \-D | |
| 61 .RS 4 | |
| 62 Delete Certificate Revocation List from cert database\&. | |
| 63 .RE | |
| 64 .PP | |
| 65 \-E | |
| 66 .RS 4 | |
| 67 Erase all CRLs of specified type from the cert database | |
| 68 .RE | |
| 69 .PP | |
| 70 \-G | |
| 71 .RS 4 | |
| 72 Create new Certificate Revocation List (CRL)\&. | |
| 73 .RE | |
| 74 .PP | |
| 75 \-I | |
| 76 .RS 4 | |
| 77 Import a CRL to the cert database | |
| 78 .RE | |
| 79 .PP | |
| 80 \-L | |
| 81 .RS 4 | |
| 82 List existing CRL located in cert database file\&. | |
| 83 .RE | |
| 84 .PP | |
| 85 \-M | |
| 86 .RS 4 | |
| 87 Modify existing CRL which can be located in cert db or in arbitrary file\&. If located in file it should be encoded in ASN\&.1 encode format\&. | |
| 88 .RE | |
| 89 .PP | |
| 90 \-S | |
| 91 .RS 4 | |
| 92 Show contents of a CRL file which isn\*(Aqt stored in the database\&. | |
| 93 .RE | |
| 94 .PP | |
| 95 \fBArguments\fR | |
| 96 .PP | |
| 97 Option arguments modify an action\&. | |
| 98 .PP | |
| 99 \-a | |
| 100 .RS 4 | |
| 101 Use ASCII format or allow the use of ASCII format for input and output\&. This formatting follows RFC #1113\&. | |
| 102 .RE | |
| 103 .PP | |
| 104 \-B | |
| 105 .RS 4 | |
| 106 Bypass CA signature checks\&. | |
| 107 .RE | |
| 108 .PP | |
| 109 \-c crl\-gen\-file | |
| 110 .RS 4 | |
| 111 Specify script file that will be used to control crl generation/modification\&. See crl\-cript\-file format below\&. If options \-M|\-G is used and \-c crl\-script\-file is not specified, crlutil will read script data from standard input\&. | |
| 112 .RE | |
| 113 .PP | |
| 114 \-d directory | |
| 115 .RS 4 | |
| 116 Specify the database directory containing the certificate and key database files\&. On Unix the Certificate Database Tool defaults to $HOME/\&.netscape (that is, ~/\&.netscape)\&. On Windows NT the default is the current directory\&. | |
| 117 .sp | |
| 118 The NSS database files must reside in the same directory\&. | |
| 119 .RE | |
| 120 .PP | |
| 121 \-f password\-file | |
| 122 .RS 4 | |
| 123 Specify a file that will automatically supply the password to include in a certificate or to access a certificate database\&. This is a plain\-text file containing one password\&. Be sure to prevent unauthorized access to this file\&. | |
| 124 .RE | |
| 125 .PP | |
| 126 \-i crl\-file | |
| 127 .RS 4 | |
| 128 Specify the file which contains the CRL to import or show\&. | |
| 129 .RE | |
| 130 .PP | |
| 131 \-l algorithm\-name | |
| 132 .RS 4 | |
| 133 Specify a specific signature algorithm\&. List of possible algorithms: MD2 | MD4 | MD5 | SHA1 | SHA256 | SHA384 | SHA512 | |
| 134 .RE | |
| 135 .PP | |
| 136 \-n nickname | |
| 137 .RS 4 | |
| 138 Specify the nickname of a certificate or key to list, create, add to a database, modify, or validate\&. Bracket the nickname string with quotation marks if it contains spaces\&. | |
| 139 .RE | |
| 140 .PP | |
| 141 \-o output\-file | |
| 142 .RS 4 | |
| 143 Specify the output file name for new CRL\&. Bracket the output\-file string with quotation marks if it contains spaces\&. If this argument is not used the output destination defaults to standard output\&. | |
| 144 .RE | |
| 145 .PP | |
| 146 \-P dbprefix | |
| 147 .RS 4 | |
| 148 Specify the prefix used on the NSS security database files (for example, my_cert8\&.db and my_key3\&.db)\&. This option is provided as a special case\&. Changing the names of the certificate and key databases is not recommended\&. | |
| 149 .RE | |
| 150 .PP | |
| 151 \-t crl\-type | |
| 152 .RS 4 | |
| 153 Specify type of CRL\&. possible types are: 0 \- SEC_KRL_TYPE, 1 \- SEC_CRL_TYPE\&. This option is obsolete | |
| 154 .RE | |
| 155 .PP | |
| 156 \-u url | |
| 157 .RS 4 | |
| 158 Specify the url\&. | |
| 159 .RE | |
| 160 .PP | |
| 161 \-w pwd\-string | |
| 162 .RS 4 | |
| 163 Provide db password in command line\&. | |
| 164 .RE | |
| 165 .PP | |
| 166 \-Z algorithm | |
| 167 .RS 4 | |
| 168 Specify the hash algorithm to use for signing the CRL\&. | |
| 169 .RE | |
| 170 .SH "CRL GENERATION SCRIPT SYNTAX" | |
| 171 .PP | |
| 172 CRL generation script file has the following syntax: | |
| 173 .PP | |
| 174 * Line with comments should have # as a first symbol of a line | |
| 175 .PP | |
| 176 * Set "this update" or "next update" CRL fields: | |
| 177 .PP | |
| 178 update=YYYYMMDDhhmmssZ nextupdate=YYYYMMDDhhmmssZ | |
| 179 .PP | |
| 180 Field "next update" is optional\&. Time should be in GeneralizedTime format (YYYYMMDDhhmmssZ)\&. For example: 20050204153000Z | |
| 181 .PP | |
| 182 * Add an extension to a CRL or a crl certificate entry: | |
| 183 .PP | |
| 184 addext extension\-name critical/non\-critical [arg1[arg2 \&.\&.\&.]] | |
| 185 .PP | |
| 186 Where: | |
| 187 .PP | |
| 188 extension\-name: string value of a name of known extensions\&. critical/non\-critical: is 1 when extension is critical and 0 otherwise\&. arg1, arg2: specific to extension type extension parameters | |
| 189 .PP | |
| 190 addext uses the range that was set earlier by addcert and will install an extension to every cert entries within the range\&. | |
| 191 .PP | |
| 192 * Add certificate entries(s) to CRL: | |
| 193 .PP | |
| 194 addcert range date | |
| 195 .PP | |
| 196 range: two integer values separated by dash: range of certificates that will be added by this command\&. dash is used as a delimiter\&. Only one cert will be added if there is no delimiter\&. date: revocation date of a cert\&. Date should be represented in GeneralizedTime format (YYYYMMDDhhmmssZ)\&. | |
| 197 .PP | |
| 198 * Remove certificate entry(s) from CRL | |
| 199 .PP | |
| 200 rmcert range | |
| 201 .PP | |
| 202 Where: | |
| 203 .PP | |
| 204 range: two integer values separated by dash: range of certificates that will be added by this command\&. dash is used as a delimiter\&. Only one cert will be added if there is no delimiter\&. | |
| 205 .PP | |
| 206 * Change range of certificate entry(s) in CRL | |
| 207 .PP | |
| 208 range new\-range | |
| 209 .PP | |
| 210 Where: | |
| 211 .PP | |
| 212 new\-range: two integer values separated by dash: range of certificates that will be added by this command\&. dash is used as a delimiter\&. Only one cert will be added if there is no delimiter\&. | |
| 213 .PP | |
| 214 Implemented Extensions | |
| 215 .PP | |
| 216 The extensions defined for CRL provide methods for associating additional attributes with CRLs of theirs entries\&. For more information see RFC #3280 | |
| 217 .PP | |
| 218 * Add The Authority Key Identifier extension: | |
| 219 .PP | |
| 220 The authority key identifier extension provides a means of identifying the public key corresponding to the private key used to sign a CRL\&. | |
| 221 .PP | |
| 222 authKeyId critical [key\-id | dn cert\-serial] | |
| 223 .PP | |
| 224 Where: | |
| 225 .PP | |
| 226 authKeyIdent: identifies the name of an extension critical: value of 1 of 0\&. Should be set to 1 if this extension is critical or 0 otherwise\&. key\-id: key identifier represented in octet string\&. dn:: is a CA distinguished name cert\-serial: authority certificate serial number\&. | |
| 227 .PP | |
| 228 * Add Issuer Alternative Name extension: | |
| 229 .PP | |
| 230 The issuer alternative names extension allows additional identities to be associated with the issuer of the CRL\&. Defined options include an rfc822 name (electronic mail address), a DNS name, an IP address, and a URI\&. | |
| 231 .PP | |
| 232 issuerAltNames non\-critical name\-list | |
| 233 .PP | |
| 234 Where: | |
| 235 .PP | |
| 236 subjAltNames: identifies the name of an extension should be set to 0 since this is non\-critical extension name\-list: comma separated list of names | |
| 237 .PP | |
| 238 * Add CRL Number extension: | |
| 239 .PP | |
| 240 The CRL number is a non\-critical CRL extension which conveys a monotonically increasing sequence number for a given CRL scope and CRL issuer\&. This extension allows users to easily determine when a particular CRL supersedes another CRL | |
| 241 .PP | |
| 242 crlNumber non\-critical number | |
| 243 .PP | |
| 244 Where: | |
| 245 .PP | |
| 246 crlNumber: identifies the name of an extension critical: should be set to 0 since this is non\-critical extension number: value of long which identifies the sequential number of a CRL\&. | |
| 247 .PP | |
| 248 * Add Revocation Reason Code extension: | |
| 249 .PP | |
| 250 The reasonCode is a non\-critical CRL entry extension that identifies the reason for the certificate revocation\&. | |
| 251 .PP | |
| 252 reasonCode non\-critical code | |
| 253 .PP | |
| 254 Where: | |
| 255 .PP | |
| 256 reasonCode: identifies the name of an extension non\-critical: should be set to 0 since this is non\-critical extension code: the following codes are available: | |
| 257 .PP | |
| 258 unspecified (0), keyCompromise (1), cACompromise (2), affiliationChanged (3), superseded (4), cessationOfOperation (5), certificateHold (6), removeFromCRL (8), privilegeWithdrawn (9), aACompromise (10) | |
| 259 .PP | |
| 260 * Add Invalidity Date extension: | |
| 261 .PP | |
| 262 The invalidity date is a non\-critical CRL entry extension that provides the date on which it is known or suspected that the private key was compromised or that the certificate otherwise became invalid\&. | |
| 263 .PP | |
| 264 invalidityDate non\-critical date | |
| 265 .PP | |
| 266 Where: | |
| 267 .PP | |
| 268 crlNumber: identifies the name of an extension non\-critical: should be set to 0 since this is non\-critical extension date: invalidity date of a cert\&. Date should be represented in GeneralizedTime format (YYYYMMDDhhmmssZ)\&. | |
| 269 .SH "USAGE" | |
| 270 .PP | |
| 271 The Certificate Revocation List Management Tool\*(Aqs capabilities are grouped as follows, using these combinations of options and arguments\&. Options and arguments in square brackets are optional, those without square brackets are required\&. | |
| 272 .PP | |
| 273 See "Implemented extensions" for more information regarding extensions and their parameters\&. | |
| 274 .PP | |
| 275 * Creating or modifying a CRL: | |
| 276 .sp | |
| 277 .if n \{\ | |
| 278 .RS 4 | |
| 279 .\} | |
| 280 .nf | |
| 281 crlutil \-G|\-M \-c crl\-gen\-file \-n nickname [\-i crl] [\-u url] [\-d keydir] [\-P dbprefix] [\-l alg] [\-a] [\-B] | |
| 282 | |
| 283 .fi | |
| 284 .if n \{\ | |
| 285 .RE | |
| 286 .\} | |
| 287 .PP | |
| 288 * Listing all CRls or a named CRL: | |
| 289 .sp | |
| 290 .if n \{\ | |
| 291 .RS 4 | |
| 292 .\} | |
| 293 .nf | |
| 294 crlutil \-L [\-n crl\-name] [\-d krydir] | |
| 295 | |
| 296 .fi | |
| 297 .if n \{\ | |
| 298 .RE | |
| 299 .\} | |
| 300 .PP | |
| 301 * Deleting CRL from db: | |
| 302 .sp | |
| 303 .if n \{\ | |
| 304 .RS 4 | |
| 305 .\} | |
| 306 .nf | |
| 307 crlutil \-D \-n nickname [\-d keydir] [\-P dbprefix] | |
| 308 | |
| 309 .fi | |
| 310 .if n \{\ | |
| 311 .RE | |
| 312 .\} | |
| 313 .PP | |
| 314 * Erasing CRLs from db: | |
| 315 .sp | |
| 316 .if n \{\ | |
| 317 .RS 4 | |
| 318 .\} | |
| 319 .nf | |
| 320 crlutil \-E [\-d keydir] [\-P dbprefix] | |
| 321 | |
| 322 .fi | |
| 323 .if n \{\ | |
| 324 .RE | |
| 325 .\} | |
| 326 .PP | |
| 327 * Deleting CRL from db: | |
| 328 .sp | |
| 329 .if n \{\ | |
| 330 .RS 4 | |
| 331 .\} | |
| 332 .nf | |
| 333 crlutil \-D \-n nickname [\-d keydir] [\-P dbprefix] | |
| 334 | |
| 335 .fi | |
| 336 .if n \{\ | |
| 337 .RE | |
| 338 .\} | |
| 339 .PP | |
| 340 * Erasing CRLs from db: | |
| 341 .sp | |
| 342 .if n \{\ | |
| 343 .RS 4 | |
| 344 .\} | |
| 345 .nf | |
| 346 crlutil \-E [\-d keydir] [\-P dbprefix] | |
| 347 | |
| 348 .fi | |
| 349 .if n \{\ | |
| 350 .RE | |
| 351 .\} | |
| 352 .PP | |
| 353 * Import CRL from file: | |
| 354 .sp | |
| 355 .if n \{\ | |
| 356 .RS 4 | |
| 357 .\} | |
| 358 .nf | |
| 359 crlutil \-I \-i crl [\-t crlType] [\-u url] [\-d keydir] [\-P dbprefix] [\-B] | |
| 360 | |
| 361 .fi | |
| 362 .if n \{\ | |
| 363 .RE | |
| 364 .\} | |
| 365 .SH "SEE ALSO" | |
| 366 .PP | |
| 367 certutil(1) | |
| 368 .SH "ADDITIONAL RESOURCES" | |
| 369 .PP | |
| 370 For information about NSS and other tools related to NSS (like JSS), check out the NSS project wiki at | |
| 371 \m[blue]\fBhttp://www\&.mozilla\&.org/projects/security/pki/nss/\fR\m[]\&. The NSS site relates directly to NSS code changes and releases\&. | |
| 372 .PP | |
| 373 Mailing lists: https://lists\&.mozilla\&.org/listinfo/dev\-tech\-crypto | |
| 374 .PP | |
| 375 IRC: Freenode at #dogtag\-pki | |
| 376 .SH "AUTHORS" | |
| 377 .PP | |
| 378 The NSS tools were written and maintained by developers with Netscape, Red Hat, Sun, Oracle, Mozilla, and Google\&. | |
| 379 .PP | |
| 380 Authors: Elio Maldonado <emaldona@redhat\&.com>, Deon Lackey <dlackey@redhat\&.com>\&. | |
| 381 .SH "LICENSE" | |
| 382 .PP | |
| 383 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/\&. | |
| 384 .SH "NOTES" | |
| 385 .IP " 1." 4 | |
| 386 Mozilla NSS bug 836477 | |
| 387 .RS 4 | |
| 388 \%https://bugzilla.mozilla.org/show_bug.cgi?id=836477 | |
| 389 .RE |
