1 ." Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.

     2 ." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     3 ."

     4 ." This code is free software; you can redistribute it and/or modify it

     5 ." under the terms of the GNU General Public License version 2 only, as

     6 ." published by the Free Software Foundation.

     7 ."

     8 ." This code is distributed in the hope that it will be useful, but WITHOUT

     9 ." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    10 ." FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    11 ." version 2 for more details (a copy is included in the LICENSE file that

    12 ." accompanied this code).

    13 ."

    14 ." You should have received a copy of the GNU General Public License version

    15 ." 2 along with this work; if not, write to the Free Software Foundation,

    16 ." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    17 ."

    18 ." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    19 ." or visit www.oracle.com if you need additional information or have any

    20 ." questions.

    21 ."

    22 .TH keytool 1 "10 May 2011"

    23 

    24 .LP

    25 .SH "Name"

    26 keytool \- Key and Certificate Management Tool

    27 .LP

    28 .LP

    29 Manages a keystore (database) of cryptographic keys, X.509 certificate chains, and trusted certificates.

    30 .LP

    31 .SH "SYNOPSIS"

    32 .LP

    33 .nf

    34 \f3

    35 .fl

    36 \fP\f3keytool\fP [ commands ]

    37 .fl

    38 .fi

    39 

    40 .LP

    41 .LP

    42 The keytool command interface has changed in Java SE 6. See the Changes Section for a detailed description. Note that previously defined commands are still supported.

    43 .LP

    44 .SH "DESCRIPTION"

    45 .LP

    46 \f3keytool\fP is a key and certificate management utility. It allows users to administer their own public/private key pairs and associated certificates for use in self\-authentication (where the user authenticates himself/herself to other users/services) or data integrity and authentication services, using digital signatures. It also allows users to cache the public keys (in the form of certificates) of their communicating peers.

    47 .LP

    48 A \f2certificate\fP is a digitally signed statement from one entity (person, company, etc.), saying that the public key (and some other information) of some other entity has a particular value. (See Certificates.) When data is digitally signed, the signature can be verified to check the data integrity and authenticity. \f2Integrity\fP means that the data has not been modified or tampered with, and \f2authenticity\fP means the data indeed comes from whoever claims to have created and signed it.

    49 .LP

    50 .LP

    51 \f3keytool\fP also enables users to administer secret keys used in symmetric encryption/decryption (e.g. DES).

    52 .LP

    53 .LP

    54 \f3keytool\fP stores the keys and certificates in a \f2keystore\fP.

    55 .LP

    56 .SH "COMMAND AND OPTION NOTES"

    57 .LP

    58 .LP

    59 The various commands and their options are listed and described below. Note:

    60 .LP

    61 .RS 3

    62 .TP 2

    63 o

    64 All command and option names are preceded by a minus sign (\-).

    65 .TP 2

    66 o

    67 The options for each command may be provided in any order.

    68 .TP 2

    69 o

    70 All items not italicized or in braces or square brackets are required to appear as is.

    71 .TP 2

    72 o

    73 Braces surrounding an option generally signify that a default value will be used if the option is not specified on the command line. Braces are also used around the \f2\-v\fP, \f2\-rfc\fP, and \f2\-J\fP options, which only have meaning if they appear on the command line (that is, they don't have any "default" values other than not existing).

    74 .TP 2

    75 o

    76 Brackets surrounding an option signify that the user is prompted for the value(s) if the option is not specified on the command line. (For a \f2\-keypass\fP option, if you do not specify the option on the command line, \f3keytool\fP will first attempt to use the keystore password to recover the private/secret key, and if this fails, will then prompt you for the private/secret key password.)

    77 .TP 2

    78 o

    79 Items in italics (option values) represent the actual values that must be supplied. For example, here is the format of the \f2\-printcert\fP command:

    80 .nf

    81 \f3

    82 .fl

    83   keytool \-printcert {\-file \fP\f4cert_file\fP\f3} {\-v}

    84 .fl

    85 \fP

    86 .fi

    87 .LP

    88 When specifying a \f2\-printcert\fP command, replace \f2cert_file\fP with the actual file name, as in:

    89 .nf

    90 \f3

    91 .fl

    92   keytool \-printcert \-file VScert.cer

    93 .fl

    94 \fP

    95 .fi

    96 .TP 2

    97 o

    98 Option values must be quoted if they contain a blank (space).

    99 .TP 2

   100 o

   101 The \f2\-help\fP command is the default. Thus, the command line

   102 .nf

   103 \f3

   104 .fl

   105   keytool

   106 .fl

   107 \fP

   108 .fi

   109 .LP

   110 is equivalent to

   111 .nf

   112 \f3

   113 .fl

   114   keytool \-help

   115 .fl

   116 \fP

   117 .fi

   118 .RE

   119 

   120 .LP

   121 .SS

   122 Option Defaults

   123 .LP

   124 .LP

   125 Below are the defaults for various option values.

   126 .LP

   127 .nf

   128 \f3

   129 .fl

   130 \-alias "mykey"

   131 .fl

   132 

   133 .fl

   134 \-keyalg

   135 .fl

   136     "DSA" (when using \fP\f3\-genkeypair\fP\f3)

   137 .fl

   138     "DES" (when using \fP\f3\-genseckey\fP\f3)

   139 .fl

   140 

   141 .fl

   142 \-keysize

   143 .fl

   144     2048 (when using \fP\f3\-genkeypair\fP\f3 and \-keyalg is "RSA")

   145 .fl

   146     1024 (when using \fP\f3\-genkeypair\fP\f3 and \-keyalg is "DSA")

   147 .fl

   148     256 (when using \fP\f3\-genkeypair\fP\f3 and \-keyalg is "EC")

   149 .fl

   150     56 (when using \fP\f3\-genseckey\fP\f3 and \-keyalg is "DES")

   151 .fl

   152     168 (when using \fP\f3\-genseckey\fP\f3 and \-keyalg is "DESede")

   153 .fl

   154 

   155 .fl

   156 

   157 .fl

   158 \-validity 90

   159 .fl

   160 

   161 .fl

   162 \-keystore the file named \fP\f4.keystore\fP\f3 in the user's home directory

   163 .fl

   164 

   165 .fl

   166 \-storetype the value of the "keystore.type" property in the security properties file,

   167 .fl

   168            which is returned by the static \fP\f4getDefaultType\fP\f3 method in

   169 .fl

   170            \fP\f4java.security.KeyStore\fP\f3

   171 .fl

   172 

   173 .fl

   174 \-file stdin if reading, stdout if writing

   175 .fl

   176 

   177 .fl

   178 \-protected false

   179 .fl

   180 \fP

   181 .fi

   182 

   183 .LP

   184 .LP

   185 In generating a public/private key pair, the signature algorithm (\f2\-sigalg\fP option) is derived from the algorithm of the underlying private key:

   186 .LP

   187 .RS 3

   188 .TP 2

   189 o

   190 If the underlying private key is of type "DSA", the \f2\-sigalg\fP option defaults to "SHA1withDSA"

   191 .TP 2

   192 o

   193 If the underlying private key is of type "RSA", the \f2\-sigalg\fP option defaults to "SHA256withRSA".

   194 .TP 2

   195 o

   196 If the underlying private key is of type "EC", the \f2\-sigalg\fP option defaults to "SHA256withECDSA".

   197 .RE

   198 

   199 .LP

   200 .LP

   201 Please consult the

   202 .na

   203 \f2Java Cryptography Architecture API Specification & Reference\fP @

   204 .fi

   205 http://download.oracle.com/javase/7/docs/technotes/guides/security/crypto/CryptoSpec.html#AppA for a full list of \f2\-keyalg\fP and \f2\-sigalg\fP you can choose from.

   206 .LP

   207 .SS

   208 Common Options

   209 .LP

   210 .LP

   211 The \f2\-v\fP option can appear for all commands except \f2\-help\fP. If it appears, it signifies "verbose" mode; more information will be provided in the output.

   212 .LP

   213 .LP

   214 There is also a \f2\-J\fP\f2javaoption\fP option that may appear for any command. If it appears, the specified \f2javaoption\fP string is passed through directly to the Java interpreter. This option should not contain any spaces. It is useful for adjusting the execution environment or memory usage. For a list of possible interpreter options, type \f2java \-h\fP or \f2java \-X\fP at the command line.

   215 .LP

   216 .LP

   217 These options may appear for all commands operating on a keystore:

   218 .LP

   219 .RS 3

   220 .TP 3

   221 \-storetype storetype

   222 .LP

   223 This qualifier specifies the type of keystore to be instantiated.

   224 .TP 3

   225 \-keystore keystore

   226 .LP

   227 The keystore location.

   228 .LP

   229 If the JKS storetype is used and a keystore file does not yet exist, then certain \f3keytool\fP commands may result in a new keystore file being created. For example, if \f2keytool \-genkeypair\fP is invoked and the \f2\-keystore\fP option is not specified, the default keystore file named \f2.keystore\fP in the user's home directory will be created if it does not already exist. Similarly, if the \f2\-keystore \fP\f2ks_file\fP option is specified but \f2ks_file\fP does not exist, then it will be created

   230 .LP

   231 Note that the input stream from the \f2\-keystore\fP option is passed to the \f2KeyStore.load\fP method. If \f2NONE\fP is specified as the URL, then a null stream is passed to the \f2KeyStore.load\fP method. \f2NONE\fP should be specified if the \f2KeyStore\fP is not file\-based (for example, if it resides on a hardware token device).

   232 .TP 3

   233 \-storepass[:env|:file] argument

   234 .LP

   235 The password which is used to protect the integrity of the keystore.

   236 .LP

   237 If the modifier \f2env\fP or \f2file\fP is not specified, then the password has the value \f2argument\fP, which must be at least 6 characters long. Otherwise, the password is retrieved as follows:

   238 .RS 3

   239 .TP 2

   240 o

   241 \f2env\fP: Retrieve the password from the environment variable named \f2argument\fP

   242 .TP 2

   243 o

   244 \f2file\fP: Retrieve the password from the file named \f2argument\fP

   245 .RE

   246 .LP

   247 \f3Note\fP: All other options that require passwords, such as \f2\-keypass\fP, \f2\-srckeypass\fP, \f2\-destkeypass\fP \f2\-srcstorepass\fP, and \f2\-deststorepass\fP, accept the \f2env\fP and \f2file\fP modifiers. (Remember to separate the password option and the modifier with a colon, (\f2:\fP).)

   248 .LP

   249 The password must be provided to all commands that access the keystore contents. For such commands, if a \f2\-storepass\fP option is not provided at the command line, the user is prompted for it.

   250 .LP

   251 When retrieving information from the keystore, the password is optional; if no password is given, the integrity of the retrieved information cannot be checked and a warning is displayed.

   252 .TP 3

   253 \-providerName provider_name

   254 .LP

   255 Used to identify a cryptographic service provider's name when listed in the security properties file.

   256 .TP 3

   257 \-providerClass provider_class_name

   258 .LP

   259 Used to specify the name of cryptographic service provider's master class file when the service provider is not listed in the security properties file.

   260 .TP 3

   261 \-providerArg provider_arg

   262 .LP

   263 Used in conjunction with \f2\-providerClass\fP. Represents an optional string input argument for the constructor of \f2provider_class_name\fP.

   264 .TP 3

   265 \-protected

   266 .LP

   267 Either \f2true\fP or \f2false\fP. This value should be specified as \f2true\fP if a password must be given via a protected authentication path such as a dedicated PIN reader.

   268 .LP

   269 Note: Since there are two keystores involved in \f2\-importkeystore\fP command, two options, namely, \f2\-srcprotected\fP and \f2\-destprotected\fP are provided for the source keystore and the destination keystore respectively.

   270 .TP 3

   271 \-ext {name{:critical}{=value}}

   272 .LP

   273 Denotes an X.509 certificate extension. The option can be used in \-genkeypair and \-gencert to embed extensions into the certificate generated, or in \f2\-certreq\fP to show what extensions are requested in the certificate request. The option can appear multiple times. name can be a supported extension name (see below) or an arbitrary OID number. value, if provided, denotes the parameter for the extension; if omitted, denotes the default value (if defined) of the extension or the extension requires no parameter. The \f2:critical\fP modifier, if provided, means the extension's isCritical attribute is true; otherwise, false. You may use \f2:c\fP in place of \f2:critical\fP.

   274 .RE

   275 

   276 .LP

   277 .LP

   278 Currently keytool supports these named extensions (case\-insensitive):

   279 .LP

   280 .LP

   281 .if \n+(b.=1 .nr d. \n(.c-\n(c.-1

   282 .de 35

   283 .ps \n(.s

   284 .vs \n(.vu

   285 .in \n(.iu

   286 .if \n(.u .fi

   287 .if \n(.j .ad

   288 .if \n(.j=0 .na

   289 ..

   290 .nf

   291 .nr #~ 0

   292 .if n .nr #~ 0.6n

   293 .ds #d .d

   294 .if \(ts\n(.z\(ts\(ts .ds #d nl

   295 .fc

   296 .nr 33 \n(.s

   297 .rm 80 81

   298 .nr 34 \n(.lu

   299 .eo

   300 .am 81

   301 .br

   302 .di a+

   303 .35

   304 .ft \n(.f

   305 .ll \n(34u*1u/3u

   306 .if \n(.l<\n(81 .ll \n(81u

   307 .in 0

   308 The full form: "ca:{true|false}[,pathlen:<len>]"; or, <len>, a shorthand for "ca:true,pathlen:<len>"; or omitted, means "ca:true"

   309 .br

   310 .di

   311 .nr a| \n(dn

   312 .nr a- \n(dl

   313 ..

   314 .ec \

   315 .eo

   316 .am 81

   317 .br

   318 .di b+

   319 .35

   320 .ft \n(.f

   321 .ll \n(34u*1u/3u

   322 .if \n(.l<\n(81 .ll \n(81u

   323 .in 0

   324 usage(,usage)*, usage can be one of digitalSignature, nonRepudiation (contentCommitment), keyEncipherment, dataEncipherment, keyAgreement, keyCertSign, cRLSign, encipherOnly, decipherOnly. Usage can be abbreviated with the first few letters (say, dig for digitalSignature) or in camel\-case style (say, dS for digitalSignature, cRLS for cRLSign), as long as no ambiguity is found. Usage is case\-insensitive.

   325 .br

   326 .di

   327 .nr b| \n(dn

   328 .nr b- \n(dl

   329 ..

   330 .ec \

   331 .eo

   332 .am 81

   333 .br

   334 .di c+

   335 .35

   336 .ft \n(.f

   337 .ll \n(34u*1u/3u

   338 .if \n(.l<\n(81 .ll \n(81u

   339 .in 0

   340 usage(,usage)*, usage can be one of anyExtendedKeyUsage, serverAuth, clientAuth, codeSigning, emailProtection, timeStamping, OCSPSigning, or any OID string. Named usage can be abbreviated with the first few letters or in camel\-case style, as long as no ambiguity is found. Usage is case\-insensitive.

   341 .br

   342 .di

   343 .nr c| \n(dn

   344 .nr c- \n(dl

   345 ..

   346 .ec \

   347 .eo

   348 .am 80

   349 .br

   350 .di d+

   351 .35

   352 .ft \n(.f

   353 .ll \n(34u*1u/3u

   354 .if \n(.l<\n(80 .ll \n(80u

   355 .in 0

   356 SAN or SubjectAlternativeName

   357 .br

   358 .di

   359 .nr d| \n(dn

   360 .nr d- \n(dl

   361 ..

   362 .ec \

   363 .eo

   364 .am 81

   365 .br

   366 .di e+

   367 .35

   368 .ft \n(.f

   369 .ll \n(34u*1u/3u

   370 .if \n(.l<\n(81 .ll \n(81u

   371 .in 0

   372 type:value(,type:value)*, type can be EMAIL, URI, DNS, IP, or OID, value is the string format value for the type.

   373 .br

   374 .di

   375 .nr e| \n(dn

   376 .nr e- \n(dl

   377 ..

   378 .ec \

   379 .eo

   380 .am 80

   381 .br

   382 .di f+

   383 .35

   384 .ft \n(.f

   385 .ll \n(34u*1u/3u

   386 .if \n(.l<\n(80 .ll \n(80u

   387 .in 0

   388 IAN or IssuerAlternativeName

   389 .br

   390 .di

   391 .nr f| \n(dn

   392 .nr f- \n(dl

   393 ..

   394 .ec \

   395 .eo

   396 .am 81

   397 .br

   398 .di g+

   399 .35

   400 .ft \n(.f

   401 .ll \n(34u*1u/3u

   402 .if \n(.l<\n(81 .ll \n(81u

   403 .in 0

   404 same as SubjectAlternativeName

   405 .br

   406 .di

   407 .nr g| \n(dn

   408 .nr g- \n(dl

   409 ..

   410 .ec \

   411 .eo

   412 .am 81

   413 .br

   414 .di h+

   415 .35

   416 .ft \n(.f

   417 .ll \n(34u*1u/3u

   418 .if \n(.l<\n(81 .ll \n(81u

   419 .in 0

   420 method:location\-type:location\-value (,method:location\-type:location\-value)*, method can be "timeStamping", "caRepository" or any OID. location\-type and location\-value can be any type:value supported by the SubjectAlternativeName extension.

   421 .br

   422 .di

   423 .nr h| \n(dn

   424 .nr h- \n(dl

   425 ..

   426 .ec \

   427 .eo

   428 .am 80

   429 .br

   430 .di i+

   431 .35

   432 .ft \n(.f

   433 .ll \n(34u*1u/3u

   434 .if \n(.l<\n(80 .ll \n(80u

   435 .in 0

   436 AIA or AuthorityInfoAccess

   437 .br

   438 .di

   439 .nr i| \n(dn

   440 .nr i- \n(dl

   441 ..

   442 .ec \

   443 .eo

   444 .am 81

   445 .br

   446 .di j+

   447 .35

   448 .ft \n(.f

   449 .ll \n(34u*1u/3u

   450 .if \n(.l<\n(81 .ll \n(81u

   451 .in 0

   452 same as SubjectInfoAccess. method can be "ocsp","caIssuers" or any OID.

   453 .br

   454 .di

   455 .nr j| \n(dn

   456 .nr j- \n(dl

   457 ..

   458 .ec \

   459 .35

   460 .nf

   461 .ll \n(34u

   462 .nr 80 0

   463 .nr 38 \w\f3Name\fP

   464 .if \n(80<\n(38 .nr 80 \n(38

   465 .nr 38 \wBC or BasicConstraints

   466 .if \n(80<\n(38 .nr 80 \n(38

   467 .nr 38 \wKU or KeyUsage

   468 .if \n(80<\n(38 .nr 80 \n(38

   469 .nr 38 \wEKU or ExtendedkeyUsage

   470 .if \n(80<\n(38 .nr 80 \n(38

   471 .nr 38 \wSIA or SubjectInfoAccess

   472 .if \n(80<\n(38 .nr 80 \n(38

   473 .80

   474 .rm 80

   475 .nr 38 \n(d-

   476 .if \n(80<\n(38 .nr 80 \n(38

   477 .nr 38 \n(f-

   478 .if \n(80<\n(38 .nr 80 \n(38

   479 .nr 38 \n(i-

   480 .if \n(80<\n(38 .nr 80 \n(38

   481 .nr 81 0

   482 .nr 38 \w\f3Value\fP

   483 .if \n(81<\n(38 .nr 81 \n(38

   484 .81

   485 .rm 81

   486 .nr 38 \n(a-

   487 .if \n(81<\n(38 .nr 81 \n(38

   488 .nr 38 \n(b-

   489 .if \n(81<\n(38 .nr 81 \n(38

   490 .nr 38 \n(c-

   491 .if \n(81<\n(38 .nr 81 \n(38

   492 .nr 38 \n(e-

   493 .if \n(81<\n(38 .nr 81 \n(38

   494 .nr 38 \n(g-

   495 .if \n(81<\n(38 .nr 81 \n(38

   496 .nr 38 \n(h-

   497 .if \n(81<\n(38 .nr 81 \n(38

   498 .nr 38 \n(j-

   499 .if \n(81<\n(38 .nr 81 \n(38

   500 .35

   501 .nf

   502 .ll \n(34u

   503 .nr 38 1n

   504 .nr 79 0

   505 .nr 40 \n(79+(0*\n(38)

   506 .nr 80 +\n(40

   507 .nr 41 \n(80+(3*\n(38)

   508 .nr 81 +\n(41

   509 .nr TW \n(81

   510 .if t .if \n(TW>\n(.li .tm Table at line 319 file Input is too wide - \n(TW units

   511 .fc  

   512 .nr #T 0-1

   513 .nr #a 0-1

   514 .eo

   515 .de T#

   516 .ds #d .d

   517 .if \(ts\n(.z\(ts\(ts .ds #d nl

   518 .mk ##

   519 .nr ## -1v

   520 .ls 1

   521 .ls

   522 ..

   523 .ec

   524 .ta \n(80u \n(81u

   525 .nr 31 \n(.f

   526 .nr 35 1m

   527 \&\h'|\n(40u'\f3Name\fP\h'|\n(41u'\f3Value\fP

   528 .ne \n(a|u+\n(.Vu

   529 .if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v)

   530 .ta \n(80u \n(81u

   531 .nr 31 \n(.f

   532 .nr 35 1m

   533 \&\h'|\n(40u'BC or BasicConstraints\h'|\n(41u'

   534 .mk ##

   535 .nr 31 \n(##

   536 .sp |\n(##u-1v

   537 .nr 37 \n(41u

   538 .in +\n(37u

   539 .a+

   540 .in -\n(37u

   541 .mk 32

   542 .if \n(32>\n(31 .nr 31 \n(32

   543 .sp |\n(31u

   544 .ne \n(b|u+\n(.Vu

   545 .if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v)

   546 .ta \n(80u \n(81u

   547 .nr 31 \n(.f

   548 .nr 35 1m

   549 \&\h'|\n(40u'KU or KeyUsage\h'|\n(41u'

   550 .mk ##

   551 .nr 31 \n(##

   552 .sp |\n(##u-1v

   553 .nr 37 \n(41u

   554 .in +\n(37u

   555 .b+

   556 .in -\n(37u

   557 .mk 32

   558 .if \n(32>\n(31 .nr 31 \n(32

   559 .sp |\n(31u

   560 .ne \n(c|u+\n(.Vu

   561 .if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v)

   562 .ta \n(80u \n(81u

   563 .nr 31 \n(.f

   564 .nr 35 1m

   565 \&\h'|\n(40u'EKU or ExtendedkeyUsage\h'|\n(41u'

   566 .mk ##

   567 .nr 31 \n(##

   568 .sp |\n(##u-1v

   569 .nr 37 \n(41u

   570 .in +\n(37u

   571 .c+

   572 .in -\n(37u

   573 .mk 32

   574 .if \n(32>\n(31 .nr 31 \n(32

   575 .sp |\n(31u

   576 .ne \n(d|u+\n(.Vu

   577 .ne \n(e|u+\n(.Vu

   578 .if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v)

   579 .if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v)

   580 .ta \n(80u \n(81u

   581 .nr 31 \n(.f

   582 .nr 35 1m

   583 \&\h'|\n(40u'\h'|\n(41u'

   584 .mk ##

   585 .nr 31 \n(##

   586 .sp |\n(##u-1v

   587 .nr 37 \n(40u

   588 .in +\n(37u

   589 .d+

   590 .in -\n(37u

   591 .mk 32

   592 .if \n(32>\n(31 .nr 31 \n(32

   593 .sp |\n(##u-1v

   594 .nr 37 \n(41u

   595 .in +\n(37u

   596 .e+

   597 .in -\n(37u

   598 .mk 32

   599 .if \n(32>\n(31 .nr 31 \n(32

   600 .sp |\n(31u

   601 .ne \n(f|u+\n(.Vu

   602 .ne \n(g|u+\n(.Vu

   603 .if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v)

   604 .if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v)

   605 .ta \n(80u \n(81u

   606 .nr 31 \n(.f

   607 .nr 35 1m

   608 \&\h'|\n(40u'\h'|\n(41u'

   609 .mk ##

   610 .nr 31 \n(##

   611 .sp |\n(##u-1v

   612 .nr 37 \n(40u

   613 .in +\n(37u

   614 .f+

   615 .in -\n(37u

   616 .mk 32

   617 .if \n(32>\n(31 .nr 31 \n(32

   618 .sp |\n(##u-1v

   619 .nr 37 \n(41u

   620 .in +\n(37u

   621 .g+

   622 .in -\n(37u

   623 .mk 32

   624 .if \n(32>\n(31 .nr 31 \n(32

   625 .sp |\n(31u

   626 .ne \n(h|u+\n(.Vu

   627 .if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v)

   628 .ta \n(80u \n(81u

   629 .nr 31 \n(.f

   630 .nr 35 1m

   631 \&\h'|\n(40u'SIA or SubjectInfoAccess\h'|\n(41u'

   632 .mk ##

   633 .nr 31 \n(##

   634 .sp |\n(##u-1v

   635 .nr 37 \n(41u

   636 .in +\n(37u

   637 .h+

   638 .in -\n(37u

   639 .mk 32

   640 .if \n(32>\n(31 .nr 31 \n(32

   641 .sp |\n(31u

   642 .ne \n(i|u+\n(.Vu

   643 .ne \n(j|u+\n(.Vu

   644 .if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v)

   645 .if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v)

   646 .ta \n(80u \n(81u

   647 .nr 31 \n(.f

   648 .nr 35 1m

   649 \&\h'|\n(40u'\h'|\n(41u'

   650 .mk ##

   651 .nr 31 \n(##

   652 .sp |\n(##u-1v

   653 .nr 37 \n(40u

   654 .in +\n(37u

   655 .i+

   656 .in -\n(37u

   657 .mk 32

   658 .if \n(32>\n(31 .nr 31 \n(32

   659 .sp |\n(##u-1v

   660 .nr 37 \n(41u

   661 .in +\n(37u

   662 .j+

   663 .in -\n(37u

   664 .mk 32

   665 .if \n(32>\n(31 .nr 31 \n(32

   666 .sp |\n(31u

   667 .fc

   668 .nr T. 1

   669 .T# 1

   670 .35

   671 .rm a+

   672 .rm b+

   673 .rm c+

   674 .rm d+

   675 .rm e+

   676 .rm f+

   677 .rm g+

   678 .rm h+

   679 .rm i+

   680 .rm j+

   681 .if \n-(b.=0 .nr c. \n(.c-\n(d.-38

   682 

   683 .LP

   684 .LP

   685 For name as OID, value is the HEX dumped DER encoding of the extnValue for the extension excluding the OCTET STRING type and length bytes. Any extra character other than standard HEX numbers (0\-9, a\-f, A\-F) are ignored in the HEX string. Therefore, both \f2"01:02:03:04"\fP and \f2"01020304"\fP are accepted as identical values. If there's no value, the extension has an empty value field then.

   686 .LP

   687 .LP

   688 A special name \f2'honored'\fP, used in \f2\-gencert\fP only, denotes how the extensions included in the certificate request should be honored. The value for this name is a comma separated list of \f2"all"\fP (all requested extensions are honored), \f2"name{:[critical|non\-critical]}"\fP (the named extension is honored, but using a different isCritical attribute) and \f2"\-name"\fP (used with all, denotes an exception). Requested extensions are not honored by default.

   689 .LP

   690 .LP

   691 If, besides the \-ext honored option, another named or OID \-ext option is provided, this extension will be added to those already honored. However, if this name (or OID) also appears in the honored value, its value and criticality overrides the one in the request.

   692 .LP

   693 .LP

   694 The subjectKeyIdentifier extension is always created. For non self\-signed certificates, the authorityKeyIdentifier is always created.

   695 .LP

   696 .LP

   697 \f3Note:\fP Users should be aware that some combinations of extensions (and other certificate fields) may not conform to the Internet standard. See Warning Regarding Certificate Conformance for details.

   698 .LP

   699 .SH "COMMANDS"

   700 .LP

   701 .SS

   702 Creating or Adding Data to the Keystore

   703 .LP

   704 .RS 3

   705 .TP 3

   706 \-gencert {\-rfc} {\-infile infile} {\-outfile outfile} {\-alias alias} {\-sigalg sigalg} {\-dname dname} {\-startdate startdate {\-ext ext}* {\-validity valDays} [\-keypass keypass] {\-keystore keystore} [\-storepass storepass] {\-storetype storetype} {\-providername provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption}

   707 .LP

   708 Generates a certificate as a response to a certificate request file (which can be created by the \f2keytool \-certreq\fP command). The command reads the request from \f2infile\fP (if omitted, from the standard input), signs it using alias's private key, and output the X.509 certificate into \f2outfile\fP (if omitted, to the standard output). If \f2\-rfc\fP is specified, output format is BASE64\-encoded PEM; otherwise, a binary DER is created.

   709 .LP

   710 \f2sigalg\fP specifies the algorithm that should be used to sign the certificate. \f2startdate\fP is the start time/date that the certificate is valid. \f2valDays\fP tells the number of days for which the certificate should be considered valid.

   711 .LP

   712 If \f2dname\fP is provided, it's used as the subject of the generated certificate. Otherwise, the one from the certificate request is used.

   713 .LP

   714 \f2ext\fP shows what X.509 extensions will be embedded in the certificate. Read Common Options for the grammar of \f2\-ext\fP.

   715 .LP

   716 The \f2\-gencert\fP command enables you to create certificate chains. The following example creates a certificate, \f2e1\fP, that contains three certificates in its certificate chain.

   717 .LP

   718 The following commands creates four key pairs named \f2ca\fP, \f2ca1\fP, \f2ca2\fP, and \f2e1\fP:

   719 .nf

   720 \f3

   721 .fl

   722 keytool \-alias ca \-dname CN=CA \-genkeypair

   723 .fl

   724 keytool \-alias ca1 \-dname CN=CA \-genkeypair

   725 .fl

   726 keytool \-alias ca2 \-dname CN=CA \-genkeypair

   727 .fl

   728 keytool \-alias e1 \-dname CN=E1 \-genkeypair

   729 .fl

   730 \fP

   731 .fi

   732 .LP

   733 The following two commands create a chain of signed certificates; \f2ca\fP signs ca1 and \f2ca1 signs ca2\fP, all of which are self\-issued:

   734 .nf

   735 \f3

   736 .fl

   737 keytool \-alias ca1 \-certreq | keytool \-alias ca \-gencert \-ext san=dns:ca1 | keytool \-alias ca1 \-importcert

   738 .fl

   739 keytool \-alias ca2 \-certreq | $KT \-alias ca1 \-gencert \-ext san=dns:ca2 | $KT \-alias ca2 \-importcert

   740 .fl

   741 \fP

   742 .fi

   743 .LP

   744 The following command creates the certificate \f2e1\fP and stores it in the file \f2e1.cert\fP, which is signed by \f2ca2\fP. As a result, \f2e1\fP should contain \f2ca\fP, \f2ca1\fP, and \f2ca2\fP in its certificate chain:

   745 .nf

   746 \f3

   747 .fl

   748 keytool \-alias e1 \-certreq | keytool \-alias ca2 \-gencert > e1.cert

   749 .fl

   750 \fP

   751 .fi

   752 .TP 3

   753 \-genkeypair {\-alias alias} {\-keyalg keyalg} {\-keysize keysize} {\-sigalg sigalg} [\-dname dname] [\-keypass keypass] {\-startdate value} {\-ext ext}* {\-validity valDays} {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption}

   754 .LP

   755 Generates a key pair (a public key and associated private key). Wraps the public key into an X.509 v3 self\-signed certificate, which is stored as a single\-element certificate chain. This certificate chain and the private key are stored in a new keystore entry identified by \f2alias\fP.

   756 .LP

   757 \f2keyalg\fP specifies the algorithm to be used to generate the key pair, and \f2keysize\fP specifies the size of each key to be generated. \f2sigalg\fP specifies the algorithm that should be used to sign the self\-signed certificate; this algorithm must be compatible with \f2keyalg\fP.

   758 .LP

   759 \f2dname\fP specifies the X.500 Distinguished Name to be associated with \f2alias\fP, and is used as the \f2issuer\fP and \f2subject\fP fields in the self\-signed certificate. If no distinguished name is provided at the command line, the user will be prompted for one.

   760 .LP

   761 \f2keypass\fP is a password used to protect the private key of the generated key pair. If no password is provided, the user is prompted for it. If you press RETURN at the prompt, the key password is set to the same password as that used for the keystore. \f2keypass\fP must be at least 6 characters long.

   762 .LP

   763 \f2startdate\fP specifies the issue time of the certificate, also known as the "Not Before" value of the X.509 certificate's Validity field.

   764 .LP

   765 The option value can be set in one of these two forms:

   766 .RS 3

   767 .TP 3

   768 1.

   769 ([+\-]\f2nnn\fP[ymdHMS])+

   770 .TP 3

   771 2.

   772 [yyyy/mm/dd] [HH:MM:SS]

   773 .RE

   774 .LP

   775 With the first form, the issue time is shifted by the specified value from the current time. The value is a concatenation of a sequence of sub values. Inside each sub value, the plus sign ("+") means shifting forward, and the minus sign ("\-") means shifting backward. The time to be shifted is \f2nnn\fP units of years, months, days, hours, minutes, or seconds (denoted by a single character of "y", "m", "d", "H", "M", or "S" respectively). The exact value of the issue time is calculated using the \f2java.util.GregorianCalendar.add(int field, int amount)\fP method on each sub value, from left to right. For example, by specifying \f2"\-startdate \-1y+1m\-1d"\fP, the issue time will be:

   776 .nf

   777 \f3

   778 .fl

   779    Calendar c = new GregorianCalendar();

   780 .fl

   781    c.add(Calendar.YEAR, \-1);

   782 .fl

   783    c.add(Calendar.MONTH, 1);

   784 .fl

   785    c.add(Calendar.DATE, \-1);

   786 .fl

   787    return c.getTime()

   788 .fl

   789 \fP

   790 .fi

   791 .LP

   792 With the second form, the user sets the exact issue time in two parts, year/month/day and hour:minute:second (using the local time zone). The user may provide only one part, which means the other part is the same as the current date (or time). User must provide the exact number of digits as shown in the format definition (padding with 0 if shorter). When both the date and time are provided, there is one (and only one) space character between the two parts. The hour should always be provided in 24 hour format.

   793 .LP

   794 When the option is not provided, the start date is the current time. The option can be provided at most once.

   795 .LP

   796 \f2valDays\fP specifies the number of days (starting at the date specified by \f2\-startdate\fP, or the current date if \f2\-startdate\fP is not specified) for which the certificate should be considered valid.

   797 .LP

   798 This command was named \f2\-genkey\fP in previous releases. This old name is still supported in this release and will be supported in future releases, but for clarity the new name, \f2\-genkeypair\fP, is preferred going forward.

   799 .TP 3

   800 \-genseckey {\-alias alias} {\-keyalg keyalg} {\-keysize keysize} [\-keypass keypass] {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption}

   801 .LP

   802 Generates a secret key and stores it in a new \f2KeyStore.SecretKeyEntry\fP identified by \f2alias\fP.

   803 .LP

   804 \f2keyalg\fP specifies the algorithm to be used to generate the secret key, and \f2keysize\fP specifies the size of the key to be generated. \f2keypass\fP is a password used to protect the secret key. If no password is provided, the user is prompted for it. If you press RETURN at the prompt, the key password is set to the same password as that used for the keystore. \f2keypass\fP must be at least 6 characters long.

   805 .TP 3

   806 \-importcert {\-alias alias} {\-file cert_file} [\-keypass keypass] {\-noprompt} {\-trustcacerts} {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption}

   807 .LP

   808 Reads the certificate or certificate chain (where the latter is supplied in a PKCS#7 formatted reply or a sequence of X.509 certificates) from the file \f2cert_file\fP, and stores it in the keystore entry identified by \f2alias\fP. If no file is given, the certificate or certificate chain is read from stdin.

   809 .LP

   810 \f3keytool\fP can import X.509 v1, v2, and v3 certificates, and PKCS#7 formatted certificate chains consisting of certificates of that type. The data to be imported must be provided either in binary encoding format, or in printable encoding format (also known as Base64 encoding) as defined by the Internet RFC 1421 standard. In the latter case, the encoding must be bounded at the beginning by a string that starts with "\-\-\-\-\-BEGIN", and bounded at the end by a string that starts with "\-\-\-\-\-END".

   811 .LP

   812 You import a certificate for two reasons:

   813 .RS 3

   814 .TP 3

   815 1.

   816 to add it to the list of trusted certificates, or

   817 .TP 3

   818 2.

   819 to import a certificate reply received from a CA as the result of submitting a Certificate Signing Request (see the \-certreq command) to that CA.

   820 .RE

   821 .LP

   822 Which type of import is intended is indicated by the value of the \f2\-alias\fP option:

   823 .RS 3

   824 .TP 3

   825 1.

   826 \f3If the alias does not point to a key entry\fP, then \f3keytool\fP assumes you are adding a trusted certificate entry. In this case, the alias should not already exist in the keystore. If the alias does already exist, then \f3keytool\fP outputs an error, since there is already a trusted certificate for that alias, and does not import the certificate.

   827 .TP 3

   828 2.

   829 \f3If the alias points to a key entry\fP, then \f3keytool\fP assumes you are importing a certificate reply.

   830 .RE

   831 \f3Importing a New Trusted Certificate\fP

   832 .LP

   833 Before adding the certificate to the keystore, \f3keytool\fP tries to verify it by attempting to construct a chain of trust from that certificate to a self\-signed certificate (belonging to a root CA), using trusted certificates that are already available in the keystore.

   834 .LP

   835 If the \f2\-trustcacerts\fP option has been specified, additional certificates are considered for the chain of trust, namely the certificates in a file named "cacerts".

   836 .LP

   837 If \f3keytool\fP fails to establish a trust path from the certificate to be imported up to a self\-signed certificate (either from the keystore or the "cacerts" file), the certificate information is printed out, and the user is prompted to verify it, e.g., by comparing the displayed certificate fingerprints with the fingerprints obtained from some other (trusted) source of information, which might be the certificate owner himself/herself. Be very careful to ensure the certificate is valid prior to importing it as a "trusted" certificate! \-\- see WARNING Regarding Importing Trusted Certificates. The user then has the option of aborting the import operation. If the \f2\-noprompt\fP option is given, however, there will be no interaction with the user.

   838 \f3Importing a Certificate Reply\fP

   839 .LP

   840 When importing a certificate reply, the certificate reply is validated using trusted certificates from the keystore, and optionally using the certificates configured in the "cacerts" keystore file (if the \f2\-trustcacerts\fP option was specified).

   841 .LP

   842 The methods of determining whether the certificate reply is trusted are described in the following:

   843 .RS 3

   844 .TP 2

   845 o

   846 \f3If the reply is a single X.509 certificate\fP, \f3keytool\fP attempts to establish a trust chain, starting at the certificate reply and ending at a self\-signed certificate (belonging to a root CA). The certificate reply and the hierarchy of certificates used to authenticate the certificate reply form the new certificate chain of \f2alias\fP. If a trust chain cannot be established, the certificate reply is not imported. In this case, \f3keytool\fP does not print out the certificate and prompt the user to verify it, because it is very hard (if not impossible) for a user to determine the authenticity of the certificate reply.

   847 .TP 2

   848 o

   849 \f3If the reply is a PKCS#7 formatted certificate chain or a sequence of X.509 certificates\fP, the chain is ordered with the user certificate first followed by zero or more CA certificates. If the chain ends with a self\-signed root CA certificate and \f2\-trustcacerts\fP option was specified, \f3keytool\fP will attempt to match it with any of the trusted certificates in the keystore or the "cacerts" keystore file. If the chain does not end with a self\-signed root CA certificate and the \f2\-trustcacerts\fP option was specified, \f3keytool\fP will try to find one from the trusted certificates in the keystore or the "cacerts" keystore file and add it to the end of the chain. If the certificate is not found and \f2\-noprompt\fP option is not specified, the information of the last certificate in the chain is printed out, and the user is prompted to verify it.

   850 .RE

   851 .LP

   852 If the public key in the certificate reply matches the user's public key already stored with under \f2alias\fP, the old certificate chain is replaced with the new certificate chain in the reply. The old chain can only be replaced if a valid \f2keypass\fP, the password used to protect the private key of the entry, is supplied. If no password is provided, and the private key password is different from the keystore password, the user is prompted for it.

   853 .LP

   854 This command was named \f2\-import\fP in previous releases. This old name is still supported in this release and will be supported in future releases, but for clarify the new name, \f2\-importcert\fP, is preferred going forward.

   855 .TP 3

   856 \-importkeystore \-srckeystore srckeystore \-destkeystore destkeystore {\-srcstoretype srcstoretype} {\-deststoretype deststoretype} [\-srcstorepass srcstorepass] [\-deststorepass deststorepass] {\-srcprotected} {\-destprotected} {\-srcalias srcalias {\-destalias destalias} [\-srckeypass srckeypass] [\-destkeypass destkeypass] } {\-noprompt} {\-srcProviderName src_provider_name} {\-destProviderName dest_provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption}

   857 .LP

   858 Imports a single entry or all entries from a source keystore to a destination keystore.

   859 .LP

   860 When the \f2srcalias\fP option is provided, the command imports the single entry identified by the alias to the destination keystore. If a destination alias is not provided with \f2destalias\fP, then \f2srcalias\fP is used as the destination alias. If the source entry is protected by a password, \f2srckeypass\fP will be used to recover the entry. If \f2srckeypass\fP is not provided, then \f3keytool\fP will attempt to use \f2srcstorepass\fP to recover the entry. If \f2srcstorepass\fP is either not provided or is incorrect, the user will be prompted for a password. The destination entry will be protected using \f2destkeypass\fP. If \f2destkeypass\fP is not provided, the destination entry will be protected with the source entry password.

   861 .LP

   862 If the \f2srcalias\fP option is not provided, then all entries in the source keystore are imported into the destination keystore. Each destination entry will be stored under the alias from the source entry. If the source entry is protected by a password, \f2srcstorepass\fP will be used to recover the entry. If \f2srcstorepass\fP is either not provided or is incorrect, the user will be prompted for a password. If a source keystore entry type is not supported in the destination keystore, or if an error occurs while storing an entry into the destination keystore, the user will be prompted whether to skip the entry and continue, or to quit. The destination entry will be protected with the source entry password.

   863 .LP

   864 If the destination alias already exists in the destination keystore, the user is prompted to either overwrite the entry, or to create a new entry under a different alias name.

   865 .LP

   866 Note that if \f2\-noprompt\fP is provided, the user will not be prompted for a new destination alias. Existing entries will automatically be overwritten with the destination alias name. Finally, entries that can not be imported are automatically skipped and a warning is output.

   867 .TP 3

   868 \-printcertreq {\-file file}

   869 .LP

   870 Prints the content of a PKCS #10 format certificate request, which can be generated by the keytool \-certreq command. The command reads the request from file; if omitted, from the standard input.

   871 .RE

   872 

   873 .LP

   874 .SS

   875 Exporting Data

   876 .LP

   877 .RS 3

   878 .TP 3

   879 \-certreq {\-alias alias} {\-dname dname} {\-sigalg sigalg} {\-file certreq_file} [\-keypass keypass] {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption}

   880 .LP

   881 Generates a Certificate Signing Request (CSR), using the PKCS#10 format.

   882 .LP

   883 A CSR is intended to be sent to a certificate authority (CA). The CA will authenticate the certificate requestor (usually off\-line) and will return a certificate or certificate chain, used to replace the existing certificate chain (which initially consists of a self\-signed certificate) in the keystore.

   884 .LP

   885 The private key associated with \f2alias\fP is used to create the PKCS#10 certificate request. In order to access the private key, the appropriate password must be provided, since private keys are protected in the keystore with a password. If \f2keypass\fP is not provided at the command line, and is different from the password used to protect the integrity of the keystore, the user is prompted for it. If dname is provided, it's used as the subject in the CSR. Otherwise, the X.500 Distinguished Name associated with alias is used.

   886 .LP

   887 \f2sigalg\fP specifies the algorithm that should be used to sign the CSR.

   888 .LP

   889 The CSR is stored in the file \f2certreq_file\fP. If no file is given, the CSR is output to stdout.

   890 .LP

   891 Use the \f2importcert\fP command to import the response from the CA.

   892 .TP 3

   893 \-exportcert {\-alias alias} {\-file cert_file} {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-rfc} {\-v} {\-protected} {\-Jjavaoption}

   894 .LP

   895 Reads (from the keystore) the certificate associated with \f2alias\fP, and stores it in the file \f2cert_file\fP.

   896 .LP

   897 If no file is given, the certificate is output to stdout.

   898 .LP

   899 The certificate is by default output in binary encoding, but will instead be output in the printable encoding format, as defined by the Internet RFC 1421 standard, if the \f2\-rfc\fP option is specified.

   900 .LP

   901 If \f2alias\fP refers to a trusted certificate, that certificate is output. Otherwise, \f2alias\fP refers to a key entry with an associated certificate chain. In that case, the first certificate in the chain is returned. This certificate authenticates the public key of the entity addressed by \f2alias\fP.

   902 .LP

   903 This command was named \f2\-export\fP in previous releases. This old name is still supported in this release and will be supported in future releases, but for clarify the new name, \f2\-exportcert\fP, is preferred going forward.

   904 .RE

   905 

   906 .LP

   907 .SS

   908 Displaying Data

   909 .LP

   910 .RS 3

   911 .TP 3

   912 \-list {\-alias alias} {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v | \-rfc} {\-protected} {\-Jjavaoption}

   913 .LP

   914 Prints (to stdout) the contents of the keystore entry identified by \f2alias\fP. If no alias is specified, the contents of the entire keystore are printed.

   915 .LP

   916 This command by default prints the SHA1 fingerprint of a certificate. If the \f2\-v\fP option is specified, the certificate is printed in human\-readable format, with additional information such as the owner, issuer, serial number, and any extensions. If the \f2\-rfc\fP option is specified, certificate contents are printed using the printable encoding format, as defined by the Internet RFC 1421 standard

   917 .LP

   918 You cannot specify both \f2\-v\fP and \f2\-rfc\fP.

   919 .TP 3

   920 \-printcert {\-file cert_file | \-sslserver host[:port]} {\-jarfile JAR_file {\-rfc} {\-v} {\-Jjavaoption}

   921 .LP

   922 Reads the certificate from the file \f2cert_file\fP, the SSL server located at \f2host:port\fP, or the signed JAR file \f2JAR_file\fP (with the option \f2\-jarfile\fP and prints its contents in a human\-readable format. When no port is specified, the standard HTTPS port 443 is assumed. Note that \f2\-sslserver\fP and \f2\-file\fP options cannot be provided at the same time. Otherwise, an error is reported. If neither option is given, the certificate is read from stdin.

   923 .LP

   924 If \f2\-rfc\fP is specified, keytool prints the certificate in PEM mode as defined by the Internet RFC 1421 standard.

   925 .LP

   926 If the certificate is read from a file or stdin, it may be either binary encoded or in printable encoding format, as defined by the Internet RFC 1421 standard

   927 .LP

   928 If the SSL server is behind a firewall, \f2\-J\-Dhttps.proxyHost=proxyhost\fP and \f2\-J\-Dhttps.proxyPort=proxyport\fP can be specified on the command line for proxy tunneling. See the

   929 .na

   930 \f2JSSE Reference Guide\fP @

   931 .fi

   932 http://download.oracle.com/javase/7/docs/technotes/guides/security/jsse/JSSERefGuide.html for more information.

   933 .LP

   934 \f3Note\fP: This option can be used independently of a keystore.

   935 .TP 3

   936 \-printcrl \-file crl_ {\-v}

   937 .LP

   938 Reads the certificate revocation list (CRL) from the file \f2crl_file\fP.

   939 .LP

   940 A Certificate Revocation List (CRL) is a list of digital certificates which have been revoked by the Certificate Authority (CA) that issued them. The CA generates \f2crl_file\fP.

   941 .LP

   942 \f3Note\fP: This option can be used independently of a keystore.

   943 .RE

   944 

   945 .LP

   946 .SS

   947 Managing the Keystore

   948 .LP

   949 .RS 3

   950 .TP 3

   951 \-storepasswd [\-new new_storepass] {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-Jjavaoption}

   952 .LP

   953 Changes the password used to protect the integrity of the keystore contents. The new password is \f2new_storepass\fP, which must be at least 6 characters long.

   954 .TP 3

   955 \-keypasswd {\-alias alias} [\-keypass old_keypass] [\-new new_keypass] {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-Jjavaoption}

   956 .LP

   957 Changes the password under which the private/secret key identified by \f2alias\fP is protected, from \f2old_keypass\fP to \f2new_keypass\fP, which must be at least 6 characters long.

   958 .LP

   959 If the \f2\-keypass\fP option is not provided at the command line, and the key password is different from the keystore password, the user is prompted for it.

   960 .LP

   961 If the \f2\-new\fP option is not provided at the command line, the user is prompted for it.

   962 .TP 3

   963 \-delete [\-alias alias] {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption}

   964 .LP

   965 Deletes from the keystore the entry identified by \f2alias\fP. The user is prompted for the alias, if no alias is provided at the command line.

   966 .TP 3

   967 \-changealias {\-alias alias} [\-destalias destalias] [\-keypass keypass] {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption}

   968 .LP

   969 Move an existing keystore entry from the specified \f2alias\fP to a new alias, \f2destalias\fP. If no destination alias is provided, the command will prompt for one. If the original entry is protected with an entry password, the password can be supplied via the "\-keypass" option. If no key password is provided, the \f2storepass\fP (if given) will be attempted first. If that attempt fails, the user will be prompted for a password.

   970 .RE

   971 

   972 .LP

   973 .SS

   974 Getting Help

   975 .LP

   976 .RS 3

   977 .TP 3

   978 \-help

   979 .LP

   980 Lists the basic commands and their options.

   981 .LP

   982 For more information about a specific command, enter the following, where \f2command_name\fP is the name of the command:

   983 .nf

   984 \f3

   985 .fl

   986     keytool \-\fP\f4command_name\fP\f3 \-help

   987 .fl

   988 \fP

   989 .fi

   990 .RE

   991 

   992 .LP

   993 .SH "EXAMPLES"

   994 .LP

   995 .LP

   996 Suppose you want to create a keystore for managing your public/private key pair and certificates from entities you trust.

   997 .LP

   998 .SS

   999 Generating Your Key Pair

  1000 .LP

  1001 .LP

  1002 The first thing you need to do is create a keystore and generate the key pair. You could use a command such as the following:

  1003 .LP

  1004 .nf

  1005 \f3

  1006 .fl

  1007     keytool \-genkeypair \-dname "cn=Mark Jones, ou=Java, o=Oracle, c=US"

  1008 .fl

  1009       \-alias business \-keypass \fP\f4<new password for private key>\fP\f3 \-keystore /working/mykeystore

  1010 .fl

  1011       \-storepass \fP\f4<new password for keystore>\fP\f3 \-validity 180

  1012 .fl

  1013 \fP

  1014 .fi

  1015 

  1016 .LP

  1017 .LP

  1018 (Please note: This must be typed as a single line. Multiple lines are used in the examples just for legibility purposes.)

  1019 .LP

  1020 .LP

  1021 This command creates the keystore named "mykeystore" in the "working" directory (assuming it doesn't already exist), and assigns it the password specified by \f2<new password for keystore>\fP. It generates a public/private key pair for the entity whose "distinguished name" has a common name of "Mark Jones", organizational unit of "Java", organization of "Oracle" and two\-letter country code of "US". It uses the default "DSA" key generation algorithm to create the keys, both 1024 bits long.

  1022 .LP

  1023 .LP

  1024 It creates a self\-signed certificate (using the default "SHA1withDSA" signature algorithm) that includes the public key and the distinguished name information. This certificate will be valid for 180 days, and is associated with the private key in a keystore entry referred to by the alias "business". The private key is assigned the password specified by \f2<new password for private key>\fP.

  1025 .LP

  1026 .LP

  1027 The command could be significantly shorter if option defaults were accepted. As a matter of fact, no options are required; defaults are used for unspecified options that have default values, and you are prompted for any required values. Thus, you could simply have the following:

  1028 .LP

  1029 .nf

  1030 \f3

  1031 .fl

  1032     keytool \-genkeypair

  1033 .fl

  1034 \fP

  1035 .fi

  1036 

  1037 .LP

  1038 .LP

  1039 In this case, a keystore entry with alias "mykey" is created, with a newly\-generated key pair and a certificate that is valid for 90 days. This entry is placed in the keystore named ".keystore" in your home directory. (The keystore is created if it doesn't already exist.) You will be prompted for the distinguished name information, the keystore password, and the private key password.

  1040 .LP

  1041 .LP

  1042 The rest of the examples assume you executed the \f2\-genkeypair\fP command without options specified, and that you responded to the prompts with values equal to those given in the first \f2\-genkeypair\fP command, above (for example, a distinguished name of "cn=Mark Jones, ou=Java, o=Oracle, c=US").

  1043 .LP

  1044 .SS

  1045 Requesting a Signed Certificate from a Certification Authority

  1046 .LP

  1047 .LP

  1048 So far all we've got is a self\-signed certificate. A certificate is more likely to be trusted by others if it is signed by a Certification Authority (CA). To get such a signature, you first generate a Certificate Signing Request (CSR), via the following:

  1049 .LP

  1050 .nf

  1051 \f3

  1052 .fl

  1053     keytool \-certreq \-file MarkJ.csr

  1054 .fl

  1055 \fP

  1056 .fi

  1057 

  1058 .LP

  1059 .LP

  1060 This creates a CSR (for the entity identified by the default alias "mykey") and puts the request in the file named "MarkJ.csr". Submit this file to a CA, such as VeriSign, Inc. The CA will authenticate you, the requestor (usually off\-line), and then will return a certificate, signed by them, authenticating your public key. (In some cases, they will actually return a chain of certificates, each one authenticating the public key of the signer of the previous certificate in the chain.)

  1061 .LP

  1062 .SS

  1063 Importing a Certificate for the CA

  1064 .LP

  1065 .LP

  1066 You need to replace your self\-signed certificate with a certificate chain, where each certificate in the chain authenticates the public key of the signer of the previous certificate in the chain, up to a "root" CA.

  1067 .LP

  1068 .LP

  1069 Before you import the certificate reply from a CA, you need one or more "trusted certificates" in your keystore or in the \f2cacerts\fP keystore file (which is described in importcert command):

  1070 .LP

  1071 .RS 3

  1072 .TP 2

  1073 o

  1074 If the certificate reply is a certificate chain, you just need the top certificate of the chain (that is, the "root" CA certificate authenticating that CA's public key).

  1075 .TP 2

  1076 o

  1077 If the certificate reply is a single certificate, you need a certificate for the issuing CA (the one that signed it), and if that certificate is not self\-signed, you need a certificate for its signer, and so on, up to a self\-signed "root" CA certificate.

  1078 .RE

  1079 

  1080 .LP

  1081 .LP

  1082 The "cacerts" keystore file ships with several VeriSign root CA certificates, so you probably won't need to import a VeriSign certificate as a trusted certificate in your keystore. But if you request a signed certificate from a different CA, and a certificate authenticating that CA's public key hasn't been added to "cacerts", you will need to import a certificate from the CA as a "trusted certificate".

  1083 .LP

  1084 .LP

  1085 A certificate from a CA is usually either self\-signed, or signed by another CA (in which case you also need a certificate authenticating that CA's public key). Suppose company ABC, Inc., is a CA, and you obtain a file named "ABCCA.cer" that is purportedly a self\-signed certificate from ABC, authenticating that CA's public key.

  1086 .LP

  1087 .LP

  1088 Be very careful to ensure the certificate is valid prior to importing it as a "trusted" certificate! View it first (using the \f3keytool\fP \f2\-printcert\fP command, or the \f3keytool\fP \f2\-importcert\fP command without the \f2\-noprompt\fP option), and make sure that the displayed certificate fingerprint(s) match the expected ones. You can call the person who sent the certificate, and compare the fingerprint(s) that you see with the ones that they show (or that a secure public key repository shows). Only if the fingerprints are equal is it guaranteed that the certificate has not been replaced in transit with somebody else's (for example, an attacker's) certificate. If such an attack took place, and you did not check the certificate before you imported it, you would end up trusting anything the attacker has signed.

  1089 .LP

  1090 .LP

  1091 If you trust that the certificate is valid, then you can add it to your keystore via the following:

  1092 .LP

  1093 .nf

  1094 \f3

  1095 .fl

  1096     keytool \-importcert \-alias abc \-file ABCCA.cer

  1097 .fl

  1098 \fP

  1099 .fi

  1100 

  1101 .LP

  1102 .LP

  1103 This creates a "trusted certificate" entry in the keystore, with the data from the file "ABCCA.cer", and assigns the alias "abc" to the entry.

  1104 .LP

  1105 .SS

  1106 Importing the Certificate Reply from the CA

  1107 .LP

  1108 .LP

  1109 Once you've imported a certificate authenticating the public key of the CA you submitted your certificate signing request to (or there's already such a certificate in the "cacerts" file), you can import the certificate reply and thereby replace your self\-signed certificate with a certificate chain. This chain is the one returned by the CA in response to your request (if the CA reply is a chain), or one constructed (if the CA reply is a single certificate) using the certificate reply and trusted certificates that are already available in the keystore where you import the reply or in the "cacerts" keystore file.

  1110 .LP

  1111 .LP

  1112 For example, suppose you sent your certificate signing request to VeriSign. You can then import the reply via the following, which assumes the returned certificate is named "VSMarkJ.cer":

  1113 .LP

  1114 .nf

  1115 \f3

  1116 .fl

  1117     keytool \-importcert \-trustcacerts \-file VSMarkJ.cer

  1118 .fl

  1119 \fP

  1120 .fi

  1121 

  1122 .LP

  1123 .SS

  1124 Exporting a Certificate Authenticating Your Public Key

  1125 .LP

  1126 .LP

  1127 Suppose you have used the jarsigner(1) tool to sign a Java ARchive (JAR) file. Clients that want to use the file will want to authenticate your signature.

  1128 .LP

  1129 .LP

  1130 One way they can do this is by first importing your public key certificate into their keystore as a "trusted" entry. You can export the certificate and supply it to your clients. As an example, you can copy your certificate to a file named \f2MJ.cer\fP via the following, assuming the entry is aliased by "mykey":

  1131 .LP

  1132 .nf

  1133 \f3

  1134 .fl

  1135     keytool \-exportcert \-alias mykey \-file MJ.cer