jdk/src/solaris/doc/sun/man/man1/keytool.1
changeset 21743 3d979da7bdf0
parent 9734 b33a24d77590
child 31876 91b22707521a
equal deleted inserted replaced
21741:8cd632761233 21743:3d979da7bdf0
     1 ." Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.
     1 '\" t
     2 ." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     2 .\"  Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
     3 ."
     3 .\"
     4 ." This code is free software; you can redistribute it and/or modify it
     4 .\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     5 ." under the terms of the GNU General Public License version 2 only, as
     5 .\"
     6 ." published by the Free Software Foundation.
     6 .\" This code is free software; you can redistribute it and/or modify it
     7 ."
     7 .\" under the terms of the GNU General Public License version 2 only, as
     8 ." This code is distributed in the hope that it will be useful, but WITHOUT
     8 .\" published by the Free Software Foundation.
     9 ." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
     9 .\"
    10 ." FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    10 .\" This code is distributed in the hope that it will be useful, but WITHOUT
    11 ." version 2 for more details (a copy is included in the LICENSE file that
    11 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    12 ." accompanied this code).
    12 .\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
    13 ."
    13 .\" version 2 for more details (a copy is included in the LICENSE file that
    14 ." You should have received a copy of the GNU General Public License version
    14 .\" accompanied this code).
    15 ." 2 along with this work; if not, write to the Free Software Foundation,
    15 .\"
    16 ." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    16 .\" You should have received a copy of the GNU General Public License version
    17 ."
    17 .\" 2 along with this work; if not, write to the Free Software Foundation,
    18 ." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    18 .\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    19 ." or visit www.oracle.com if you need additional information or have any
    19 .\"
    20 ." questions.
    20 .\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    21 ."
    21 .\" or visit www.oracle.com if you need additional information or have any
    22 .TH keytool 1 "10 May 2011"
    22 .\" questions.
    23 
    23 .\"
    24 .LP
    24 .\"     Arch: generic
    25 .SH "Name"
    25 .\"     Software: JDK 8
    26 keytool \- Key and Certificate Management Tool
    26 .\"     Date: 6 August 2013
    27 .LP
    27 .\"     SectDesc: Security Tools
    28 .LP
    28 .\"     Title: keytool.1
    29 Manages a keystore (database) of cryptographic keys, X.509 certificate chains, and trusted certificates.
    29 .\"
    30 .LP
    30 .if n .pl 99999
    31 .SH "SYNOPSIS"
    31 .TH keytool 1 "6 August 2013" "JDK 8" "Security Tools"
    32 .LP
    32 .\" -----------------------------------------------------------------
    33 .nf
    33 .\" * Define some portability stuff
    34 \f3
    34 .\" -----------------------------------------------------------------
    35 .fl
    35 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    36 \fP\f3keytool\fP [ commands ]
    36 .\" http://bugs.debian.org/507673
    37 .fl
    37 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
    38 .fi
    38 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    39 
    39 .ie \n(.g .ds Aq \(aq
    40 .LP
    40 .el       .ds Aq '
    41 .LP
    41 .\" -----------------------------------------------------------------
    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.
    42 .\" * set default formatting
    43 .LP
    43 .\" -----------------------------------------------------------------
    44 .SH "DESCRIPTION"
    44 .\" disable hyphenation
    45 .LP
    45 .nh
    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. 
    46 .\" disable justification (adjust text to left margin only)
    47 .LP
    47 .ad l
    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.
    48 .\" -----------------------------------------------------------------
    49 .LP
    49 .\" * MAIN CONTENT STARTS HERE *
    50 .LP
    50 .\" -----------------------------------------------------------------
    51 \f3keytool\fP also enables users to administer secret keys used in symmetric encryption/decryption (e.g. DES).
    51 
    52 .LP
    52 .SH NAME    
    53 .LP
    53 keytool \- Manages a keystore (database) of cryptographic keys, X\&.509 certificate chains, and trusted certificates\&.
    54 \f3keytool\fP stores the keys and certificates in a \f2keystore\fP.
    54 .SH SYNOPSIS    
    55 .LP
    55 .sp     
    56 .SH "COMMAND AND OPTION NOTES"
    56 .nf     
    57 .LP
    57 
    58 .LP
    58 \fBkeytool\fR [\fIcommands\fR]
    59 The various commands and their options are listed and described below. Note:
    59 .fi     
    60 .LP
    60 .sp     
    61 .RS 3
    61 .TP     
    62 .TP 2
    62 \fIcommands\fR
    63 o
    63 See Commands\&. These commands are categorized by task as follows:
    64 All command and option names are preceded by a minus sign (\-). 
    64 .RS     
    65 .TP 2
    65 .TP 0.2i    
    66 o
    66 \(bu
    67 The options for each command may be provided in any order. 
    67 Create or Add Data to the Keystore
    68 .TP 2
    68 .RS     
    69 o
    69 .TP 0.2i    
    70 All items not italicized or in braces or square brackets are required to appear as is. 
    70 \(bu
    71 .TP 2
    71 -gencert
    72 o
    72 .TP 0.2i    
    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). 
    73 \(bu
    74 .TP 2
    74 -genkeypair
    75 o
    75 .TP 0.2i    
    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.) 
    76 \(bu
    77 .TP 2
    77 -genseckey
    78 o
    78 .TP 0.2i    
    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: 
    79 \(bu
    80 .nf
    80 -importcert
    81 \f3
    81 .TP 0.2i    
    82 .fl
    82 \(bu
    83   keytool \-printcert {\-file \fP\f4cert_file\fP\f3} {\-v}
    83 -importpassword
    84 .fl
    84 .RE     
    85 \fP
    85 
    86 .fi
    86 .TP 0.2i    
    87 .LP
    87 \(bu
    88 When specifying a \f2\-printcert\fP command, replace \f2cert_file\fP with the actual file name, as in: 
    88 Import Contents From Another Keystore
    89 .nf
    89 .RS     
    90 \f3
    90 .TP 0.2i    
    91 .fl
    91 \(bu
    92   keytool \-printcert \-file VScert.cer
    92 -importkeystore
    93 .fl
    93 .RE     
    94 \fP
    94 
    95 .fi
    95 .TP 0.2i    
    96 .TP 2
    96 \(bu
    97 o
    97 Generate Certificate Request
    98 Option values must be quoted if they contain a blank (space). 
    98 .RS     
    99 .TP 2
    99 .TP 0.2i    
   100 o
   100 \(bu
   101 The \f2\-help\fP command is the default. Thus, the command line 
   101 -certreq
   102 .nf
   102 .RE     
   103 \f3
   103 
   104 .fl
   104 .TP 0.2i    
   105   keytool
   105 \(bu
   106 .fl
   106 Export Data
   107 \fP
   107 .RS     
   108 .fi
   108 .TP 0.2i    
   109 .LP
   109 \(bu
   110 is equivalent to 
   110 -exportcert
   111 .nf
   111 .RE     
   112 \f3
   112 
   113 .fl
   113 .TP 0.2i    
   114   keytool \-help
   114 \(bu
   115 .fl
   115 Display Data
   116 \fP
   116 .RS     
   117 .fi
   117 .TP 0.2i    
       
   118 \(bu
       
   119 -list
       
   120 .TP 0.2i    
       
   121 \(bu
       
   122 -printcert
       
   123 .TP 0.2i    
       
   124 \(bu
       
   125 -printcertreq
       
   126 .TP 0.2i    
       
   127 \(bu
       
   128 -printcrl
       
   129 .RE     
       
   130 
       
   131 .TP 0.2i    
       
   132 \(bu
       
   133 Manage the Keystore
       
   134 .RS     
       
   135 .TP 0.2i    
       
   136 \(bu
       
   137 -storepasswd
       
   138 .TP 0.2i    
       
   139 \(bu
       
   140 -keypasswd
       
   141 .TP 0.2i    
       
   142 \(bu
       
   143 -delete
       
   144 .TP 0.2i    
       
   145 \(bu
       
   146 -changealias
       
   147 .RE     
       
   148 
       
   149 .TP 0.2i    
       
   150 \(bu
       
   151 Get Help
       
   152 .RS     
       
   153 .TP 0.2i    
       
   154 \(bu
       
   155 -help
       
   156 .RE     
       
   157 
       
   158 .RE     
       
   159 
       
   160 .SH DESCRIPTION    
       
   161 The \f3keytool\fR command is a key and certificate management utility\&. It enables users to administer their own public/private key pairs and associated certificates for use in self-authentication (where the user authenticates himself or herself to other users and services) or data integrity and authentication services, using digital signatures\&. The \f3keytool\fR command also enables users to cache the public keys (in the form of certificates) of their communicating peers\&.
       
   162 .PP
       
   163 A certificate is a digitally signed statement from one entity (person, company, and so on\&.), that says that the public key (and some other information) of some other entity has a particular value\&. (See Certificate\&.) When data is digitally signed, the signature can be verified to check the data integrity and authenticity\&. Integrity means that the data has not been modified or tampered with, and authenticity means the data comes from whoever claims to have created and signed it\&.
       
   164 .PP
       
   165 The \f3keytool\fR command also enables users to administer secret keys and passphrases used in symmetric encryption and decryption (DES)\&.
       
   166 .PP
       
   167 The \f3keytool\fR command stores the keys and certificates in a keystore\&. See KeyStore aliases\&.
       
   168 .SH COMMAND\ AND\ OPTION\ NOTES    
       
   169 See Commands for a listing and description of the various commands\&.
       
   170 .TP 0.2i    
       
   171 \(bu
       
   172 All command and option names are preceded by a minus sign (-)\&.
       
   173 .TP 0.2i    
       
   174 \(bu
       
   175 The options for each command can be provided in any order\&.
       
   176 .TP 0.2i    
       
   177 \(bu
       
   178 All items not italicized or in braces or brackets are required to appear as is\&.
       
   179 .TP 0.2i    
       
   180 \(bu
       
   181 Braces surrounding an option signify that a default value will be used when the option is not specified on the command line\&. See Option Defaults\&. Braces are also used around the \f3-v\fR, \f3-rfc\fR, and \f3-J\fR options, which only have meaning when they appear on the command line\&. They do not have any default values other than not existing\&.
       
   182 .TP 0.2i    
       
   183 \(bu
       
   184 Brackets surrounding an option signify that the user is prompted for the values when the option is not specified on the command line\&. For the \f3-keypass\fR option, if you do not specify the option on the command line, then the \f3keytool\fR command first attempts to use the keystore password to recover the private/secret key\&. If this attempt fails, then the \f3keytool\fR command prompts you for the private/secret key password\&.
       
   185 .TP 0.2i    
       
   186 \(bu
       
   187 Items in italics (option values) represent the actual values that must be supplied\&. For example, here is the format of the \f3-printcert\fR command:
       
   188 
       
   189 \f3keytool -printcert {-file cert_file} {-v}\fR
       
   190 
       
   191 When you specify a \f3-printcert\fR command, replace \f3cert_file\fR with the actual file name, as follows: \f3keytool -printcert -file VScert\&.cer\fR
       
   192 .TP 0.2i    
       
   193 \(bu
       
   194 Option values must be put in quotation marks when they contain a blank (space)\&.
       
   195 .TP 0.2i    
       
   196 \(bu
       
   197 The \f3-help\fR option is the default\&. The \f3keytool\fR command is the same as \f3keytool -help\fR\&.
       
   198 .SH OPTION\ DEFAULTS    
       
   199 The following examples show the defaults for various option values\&.
       
   200 .sp     
       
   201 .nf     
       
   202 \f3\-alias "mykey"\fP
       
   203 .fi     
       
   204 .nf     
       
   205 \f3\fP
       
   206 .fi     
       
   207 .nf     
       
   208 \f3\-keyalg\fP
       
   209 .fi     
       
   210 .nf     
       
   211 \f3    "DSA" (when using \-genkeypair)\fP
       
   212 .fi     
       
   213 .nf     
       
   214 \f3    "DES" (when using \-genseckey)\fP
       
   215 .fi     
       
   216 .nf     
       
   217 \f3\fP
       
   218 .fi     
       
   219 .nf     
       
   220 \f3\-keysize\fP
       
   221 .fi     
       
   222 .nf     
       
   223 \f3    2048 (when using \-genkeypair and \-keyalg is "RSA")\fP
       
   224 .fi     
       
   225 .nf     
       
   226 \f3    1024 (when using \-genkeypair and \-keyalg is "DSA")\fP
       
   227 .fi     
       
   228 .nf     
       
   229 \f3    256 (when using \-genkeypair and \-keyalg is "EC")\fP
       
   230 .fi     
       
   231 .nf     
       
   232 \f3    56 (when using \-genseckey and \-keyalg is "DES")\fP
       
   233 .fi     
       
   234 .nf     
       
   235 \f3    168 (when using \-genseckey and \-keyalg is "DESede")\fP
       
   236 .fi     
       
   237 .nf     
       
   238 \f3\fP
       
   239 .fi     
       
   240 .nf     
       
   241 \f3\-validity 90\fP
       
   242 .fi     
       
   243 .nf     
       
   244 \f3\fP
       
   245 .fi     
       
   246 .nf     
       
   247 \f3\-keystore <the file named \&.keystore in the user\&'s home directory>\fP
       
   248 .fi     
       
   249 .nf     
       
   250 \f3\fP
       
   251 .fi     
       
   252 .nf     
       
   253 \f3\-storetype <the value of the "keystore\&.type" property in the\fP
       
   254 .fi     
       
   255 .nf     
       
   256 \f3    security properties file, which is returned by the static\fP
       
   257 .fi     
       
   258 .nf     
       
   259 \f3    getDefaultType method in java\&.security\&.KeyStore>\fP
       
   260 .fi     
       
   261 .nf     
       
   262 \f3\fP
       
   263 .fi     
       
   264 .nf     
       
   265 \f3\-file\fP
       
   266 .fi     
       
   267 .nf     
       
   268 \f3    stdin (if reading)\fP
       
   269 .fi     
       
   270 .nf     
       
   271 \f3    stdout (if writing)\fP
       
   272 .fi     
       
   273 .nf     
       
   274 \f3\fP
       
   275 .fi     
       
   276 .nf     
       
   277 \f3\-protected false\fP
       
   278 .fi     
       
   279 .nf     
       
   280 \f3\fP
       
   281 .fi     
       
   282 .sp     
       
   283 In generating a public/private key pair, the signature algorithm (\f3-sigalg\fR option) is derived from the algorithm of the underlying private key:
       
   284 .TP 0.2i    
       
   285 \(bu
       
   286 If the underlying private key is of type DSA, then the \f3-sigalg\fR option defaults to SHA1withDSA\&.
       
   287 .TP 0.2i    
       
   288 \(bu
       
   289 If the underlying private key is of type RSA, then the \f3-sigalg\fR option defaults to SHA256withRSA\&.
       
   290 .TP 0.2i    
       
   291 \(bu
       
   292 If the underlying private key is of type EC, then the \f3-sigalg\fR option defaults to SHA256withECDSA\&.
       
   293 .PP
       
   294 For a full list of \f3-keyalg\fR and \f3-sigalg\fR arguments, see Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA
       
   295 .SH COMMON\ OPTIONS    
       
   296 The \f3-v\fR option can appear for all commands except \f3-help\fR\&. When the \f3-v\fR option appears, it signifies verbose mode, which means that more information is provided in the output\&.
       
   297 .PP
       
   298 There is also a \f3-Jjavaoption\fR argument that can appear for any command\&. When the \f3-Jjavaoption\fR appears, the specified \f3javaoption\fR string is passed directly to the Java interpreter\&. This option does not contain any spaces\&. It is useful for adjusting the execution environment or memory usage\&. For a list of possible interpreter options, type \f3java -h\fR or \f3java -X\fR at the command line\&.
       
   299 .PP
       
   300 These options can appear for all commands operating on a keystore:
       
   301 .TP
       
   302 -storetype \fIstoretype\fR
       
   303 .br
       
   304 This qualifier specifies the type of keystore to be instantiated\&.
       
   305 .TP
       
   306 -keystore \fIkeystore\fR
       
   307 .br
       
   308 The keystore location\&.
       
   309 
       
   310 If the JKS \f3storetype\fR is used and a keystore file does not yet exist, then certain \f3keytool\fR commands can result in a new keystore file being created\&. For example, if \f3keytool -genkeypair\fR is called and the \f3-keystore\fR option is not specified, the default keystore file named \f3\&.keystore\fR in the user\&'s home directory is created when it does not already exist\&. Similarly, if the \f3-keystore ks_file\fR option is specified but ks_file does not exist, then it is created\&. For more information on the JKS \f3storetype\fR, see the \fIKeyStore Implementation\fR section in KeyStore aliases\&.
       
   311 
       
   312 Note that the input stream from the \f3-keystore\fR option is passed to the \f3KeyStore\&.load\fR method\&. If \f3NONE\fR is specified as the URL, then a null stream is passed to the \f3KeyStore\&.load\fR method\&. \f3NONE\fR should be specified if the keystore is not file-based\&. For example, when it resides on a hardware token device\&.
       
   313 .TP
       
   314 -storepass[:\fIenv\fR| :\fIfile\fR] argument
       
   315 .br
       
   316 The password that is used to protect the integrity of the keystore\&.
       
   317 
       
   318 If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the \f3value\fR argument, which must be at least 6 characters long\&. Otherwise, the password is retrieved as follows:
       
   319 .RS     
       
   320 .TP 0.2i    
       
   321 \(bu
       
   322 \f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&.
       
   323 .TP 0.2i    
       
   324 \(bu
       
   325 \f3file\fR: Retrieve the password from the file named argument\&.
       
   326 .RE     
       
   327 
       
   328 
       
   329 \fINote:\fR All other options that require passwords, such as \f3-keypass\fR, \f3-srckeypass\fR, -\f3destkeypass\fR, \f3-srcstorepass\fR, and \f3-deststorepass\fR, accept the \fIenv\fR and \fIfile\fR modifiers\&. Remember to separate the password option and the modifier with a colon (:)\&.
       
   330 
       
   331 The password must be provided to all commands that access the keystore contents\&. For such commands, when the \f3-storepass\fR option is not provided at the command line, the user is prompted for it\&.
       
   332 
       
   333 When retrieving information from the keystore, the password is optional\&. If no password is specified, then the integrity of the retrieved information cannot be verified and a warning is displayed\&.
       
   334 .TP
       
   335 -providerName \fIprovider_name\fR
       
   336 .br
       
   337 Used to identify a cryptographic service provider\&'s name when listed in the security properties file\&.
       
   338 .TP
       
   339 -providerClass \fIprovider_class_name\fR
       
   340 .br
       
   341 Used to specify the name of a cryptographic service provider\&'s master class file when the service provider is not listed in the security properties file\&.
       
   342 .TP
       
   343 -providerArg \fIprovider_arg\fR
       
   344 .br
       
   345 Used with the \f3-providerClass\fR option to represent an optional string input argument for the constructor of \f3provider_class_name\fR\&.
       
   346 .TP
       
   347 -protected
       
   348 .br
       
   349 Either \f3true\fR or \f3false\fR\&. This value should be specified as \f3true\fR when a password must be specified by way of a protected authentication path such as a dedicated PIN reader\&.Because there are two keystores involved in the \f3-importkeystore\fR command, the following two options \f3-srcprotected\fR and -\f3destprotected\fR are provided for the source keystore and the destination keystore respectively\&.
       
   350 .TP
       
   351 -ext \fI{name{:critical} {=value}}\fR
       
   352 .br
       
   353 Denotes an X\&.509 certificate extension\&. The option can be used in \f3-genkeypair\fR and \f3-gencert\fR to embed extensions into the certificate generated, or in \f3-certreq\fR to show what extensions are requested in the certificate request\&. The option can appear multiple times\&. The \f3name\fR argument can be a supported extension name (see Named Extensions) or an arbitrary OID number\&. The \f3value\fR argument, when provided, denotes the argument for the extension\&. When \fIvalue\fR is omitted, that means that the default value of the extension or the extension requires no argument\&. The \f3:critical\fR modifier, when provided, means the extension\&'s \f3isCritical\fR attribute is \f3true\fR; otherwise, it is \f3false\fR\&. You can use \f3:c\fR in place of \f3:critical\fR\&.
       
   354 .SH NAMED\ EXTENSIONS    
       
   355 The \f3keytool\fR command supports these named extensions\&. The names are not case-sensitive)\&.
       
   356 .TP     
       
   357 BC or BasicContraints
       
   358 \fIValues\fR: The full form is: \f3ca:{true|false}[,pathlen:<len>]\fR or \f3<len>\fR, which is short for \f3ca:true,pathlen:<len>\fR\&. When <\f3len\fR> is omitted, you have \f3ca:true\fR\&.
       
   359 .TP     
       
   360 KU or KeyUsage
       
   361 \fIValues\fR: \f3usage\fR(,\f3usage\fR)*, where \fIusage\fR can be one of \f3digitalSignature\fR, \f3nonRepudiation\fR (contentCommitment), \f3keyEncipherment\fR, \f3dataEncipherment\fR, \f3keyAgreement\fR, \f3keyCertSign\fR, \f3cRLSign\fR, \f3encipherOnly\fR, \f3decipherOnly\fR\&. The \fIusage\fR argument can be abbreviated with the first few letters (\f3dig\fR for \f3digitalSignature\fR) or in camel-case style (\f3dS\fR for \f3digitalSignature\fR or \f3cRLS\fR for \f3cRLSign\fR), as long as no ambiguity is found\&. The \f3usage\fR values are case-sensitive\&.
       
   362 .TP     
       
   363 EKU or ExtendedKeyUsage
       
   364 \fIValues\fR: \f3usage\fR(,\f3usage\fR)*, where \fIusage\fR can be one of \f3anyExtendedKeyUsage\fR, \f3serverAuth\fR, \f3clientAuth\fR, \f3codeSigning\fR, \f3emailProtection\fR, \f3timeStamping\fR, \f3OCSPSigning\fR, or any \fIOID string\fR\&. The \fIusage\fR argument can be abbreviated with the first few letters or in camel-case style, as long as no ambiguity is found\&. The \f3usage\fR values are case-sensitive\&.
       
   365 .TP     
       
   366 SAN or SubjectAlternativeName
       
   367 \fIValues\fR: \f3type\fR:\f3value\fR(,t\f3ype:value\fR)*, where \f3type\fR can be \f3EMAIL\fR, \f3URI\fR, \f3DNS\fR, \f3IP\fR, or \f3OID\fR\&. The \f3value\fR argument is the string format value for the \f3type\fR\&.
       
   368 .TP     
       
   369 IAN or IssuerAlternativeName
       
   370 \fIValues\fR: Same as \f3SubjectAlternativeName\fR\&.
       
   371 .TP     
       
   372 SIA or SubjectInfoAccess
       
   373 \fIValues\fR: \f3method\fR:\f3location-type\fR:\f3location-value\fR (,\f3method:location-type\fR:\f3location-value\fR)*, where \f3method\fR can be \f3timeStamping\fR, \f3caRepository\fR or any OID\&. The \f3location-type\fR and \f3location-value\fR arguments can be any \f3type\fR:\f3value\fR supported by the \f3SubjectAlternativeName\fR extension\&.
       
   374 .TP     
       
   375 AIA or AuthorityInfoAccess
       
   376 \fIValues\fR: Same as \f3SubjectInfoAccess\fR\&. The \f3method\fR argument can be \f3ocsp\fR,\f3caIssuers\fR, or any OID\&.
       
   377 .PP
       
   378 When \f3name\fR is OID, the value is the hexadecimal dumped DER encoding of the \f3extnValue\fR for the extension excluding the OCTET STRING type and length bytes\&. Any extra character other than standard hexadecimal numbers (0-9, a-f, A-F) are ignored in the HEX string\&. Therefore, both 01:02:03:04 and 01020304 are accepted as identical values\&. When there is no value, the extension has an empty value field\&.
       
   379 .PP
       
   380 A special name \f3honored\fR, used in \f3-gencert\fR only, denotes how the extensions included in the certificate request should be honored\&. The value for this name is a comma separated list of \f3all\fR (all requested extensions are honored), \f3name{:[critical|non-critical]}\fR (the named extension is honored, but using a different \f3isCritical\fR attribute) and \f3-name\fR (used with \f3all\fR, denotes an exception)\&. Requested extensions are not honored by default\&.
       
   381 .PP
       
   382 If, besides the\f3-ext honored\fR option, another named or OID \f3-ext\fR option is provided, this extension is added to those already honored\&. However, if this name (or OID) also appears in the honored value, then its value and criticality overrides the one in the request\&.
       
   383 .PP
       
   384 The \f3subjectKeyIdentifier\fR extension is always created\&. For non-self-signed certificates, the \f3authorityKeyIdentifier\fR is created\&.
       
   385 .PP
       
   386 \fINote:\fR Users should be aware that some combinations of extensions (and other certificate fields) may not conform to the Internet standard\&. See Certificate Conformance Warning\&.
       
   387 .SH COMMANDS    
       
   388 .TP
       
   389 -gencert
       
   390 .br
       
   391 \f3{-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}\fR
       
   392 
       
   393 Generates a certificate as a response to a certificate request file (which can be created by the \f3keytool\fR\f3-certreq\fR command)\&. The command reads the request from \fIinfile\fR (if omitted, from the standard input), signs it using alias\&'s private key, and outputs the X\&.509 certificate into \fIoutfile\fR (if omitted, to the standard output)\&. When\f3-rfc\fR is specified, the output format is Base64-encoded PEM; otherwise, a binary DER is created\&.
       
   394 
       
   395 The \f3sigalg\fR value specifies the algorithm that should be used to sign the certificate\&. The \f3startdate\fR argument is the start time and date that the certificate is valid\&. The \f3valDays\fR argument tells the number of days for which the certificate should be considered valid\&.
       
   396 
       
   397 When \f3dname\fR is provided, it is used as the subject of the generated certificate\&. Otherwise, the one from the certificate request is used\&.
       
   398 
       
   399 The \f3ext\fR value shows what X\&.509 extensions will be embedded in the certificate\&. Read Common Options for the grammar of \f3-ext\fR\&.
       
   400 
       
   401 The \f3-gencert\fR option enables you to create certificate chains\&. The following example creates a certificate, \f3e1\fR, that contains three certificates in its certificate chain\&.
       
   402 
       
   403 The following commands creates four key pairs named \f3ca\fR, \f3ca1\fR, \f3ca2\fR, and \f3e1\fR:
       
   404 .sp     
       
   405 .nf     
       
   406 \f3keytool \-alias ca \-dname CN=CA \-genkeypair\fP
       
   407 .fi     
       
   408 .nf     
       
   409 \f3keytool \-alias ca1 \-dname CN=CA \-genkeypair\fP
       
   410 .fi     
       
   411 .nf     
       
   412 \f3keytool \-alias ca2 \-dname CN=CA \-genkeypair\fP
       
   413 .fi     
       
   414 .nf     
       
   415 \f3keytool \-alias e1 \-dname CN=E1 \-genkeypair\fP
       
   416 .fi     
       
   417 .nf     
       
   418 \f3\fP
       
   419 .fi     
       
   420 .sp     
       
   421 
       
   422 
       
   423 The following two commands create a chain of signed certificates; \f3ca\fR signs \f3ca1\fR and \f3ca1\fR signs \f3ca2\fR, all of which are self-issued:
       
   424 .sp     
       
   425 .nf     
       
   426 \f3keytool \-alias ca1 \-certreq |\fP
       
   427 .fi     
       
   428 .nf     
       
   429 \f3    keytool \-alias ca \-gencert \-ext san=dns:ca1 |\fP
       
   430 .fi     
       
   431 .nf     
       
   432 \f3    keytool \-alias ca1 \-importcert\fP
       
   433 .fi     
       
   434 .nf     
       
   435 \f3\fP
       
   436 .fi     
       
   437 .nf     
       
   438 \f3keytool \-alias ca2 \-certreq |\fP
       
   439 .fi     
       
   440 .nf     
       
   441 \f3    $KT \-alias ca1 \-gencert \-ext san=dns:ca2 |\fP
       
   442 .fi     
       
   443 .nf     
       
   444 \f3    $KT \-alias ca2 \-importcert\fP
       
   445 .fi     
       
   446 .nf     
       
   447 \f3\fP
       
   448 .fi     
       
   449 .sp     
       
   450 
       
   451 
       
   452 The following command creates the certificate \f3e1\fR and stores it in the file \f3e1\&.cert\fR, which is signed by \f3ca2\fR\&. As a result, \f3e1\fR should contain \f3ca\fR, \f3ca1\fR, and \f3ca2\fR in its certificate chain:
       
   453 .sp     
       
   454 .nf     
       
   455 \f3keytool \-alias e1 \-certreq | keytool \-alias ca2 \-gencert > e1\&.cert\fP
       
   456 .fi     
       
   457 .nf     
       
   458 \f3\fP
       
   459 .fi     
       
   460 .sp     
       
   461 
       
   462 .TP
       
   463 -genkeypair
       
   464 .br
       
   465 \f3{-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}\fR
       
   466 
       
   467 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 alias\&.
       
   468 
       
   469 The \f3keyalg\fR value specifies the algorithm to be used to generate the key pair, and the \f3keysize\fR value specifies the size of each key to be generated\&. The \f3sigalg\fR value specifies the algorithm that should be used to sign the self-signed certificate\&. This algorithm must be compatible with the \f3keyalg\fR value\&.
       
   470 
       
   471 The \f3dname\fR value specifies the X\&.500 Distinguished Name to be associated with the value of \f3alias\fR, and is used as the issuer and subject fields in the self-signed certificate\&. If no distinguished name is provided at the command line, then the user is prompted for one\&.
       
   472 
       
   473 The value of \f3keypass\fR is a password used to protect the private key of the generated key pair\&. If no password is provided, then the user is prompted for it\&. If you press \fIthe Return key\fR at the prompt, then the key password is set to the same password as the keystore password\&. The \f3keypass\fR value must be at least 6 characters\&.
       
   474 
       
   475 The value of \f3startdate\fR specifies the issue time of the certificate, also known as the "Not Before" value of the X\&.509 certificate\&'s Validity field\&.
       
   476 
       
   477 The option value can be set in one of these two forms:
       
   478 
       
   479 \f3([+-]nnn[ymdHMS])+\fR
       
   480 
       
   481 \f3[yyyy/mm/dd] [HH:MM:SS]\fR
       
   482 
       
   483 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 subvalues\&. Inside each subvalue, the plus sign (+) means shift forward, and the minus sign (-) means shift backward\&. The time to be shifted is \f3nnn\fR units of years, months, days, hours, minutes, or seconds (denoted by a single character of \f3y\fR, \f3m\fR, \f3d\fR, \f3H\fR, \f3M\fR, or \f3S\fR respectively)\&. The exact value of the issue time is calculated using the \f3java\&.util\&.GregorianCalendar\&.add(int field, int amount)\fR method on each subvalue, from left to right\&. For example, by specifying, the issue time will be:
       
   484 .sp     
       
   485 .nf     
       
   486 \f3Calendar c = new GregorianCalendar();\fP
       
   487 .fi     
       
   488 .nf     
       
   489 \f3c\&.add(Calendar\&.YEAR, \-1);\fP
       
   490 .fi     
       
   491 .nf     
       
   492 \f3c\&.add(Calendar\&.MONTH, 1);\fP
       
   493 .fi     
       
   494 .nf     
       
   495 \f3c\&.add(Calendar\&.DATE, \-1);\fP
       
   496 .fi     
       
   497 .nf     
       
   498 \f3return c\&.getTime()\fP
       
   499 .fi     
       
   500 .nf     
       
   501 \f3\fP
       
   502 .fi     
       
   503 .sp     
       
   504 
       
   505 
       
   506 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 can provide only one part, which means the other part is the same as the current date (or time)\&. The user must provide the exact number of digits as shown in the format definition (padding with 0 when 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\&.
       
   507 
       
   508 When the option is not provided, the start date is the current time\&. The option can be provided at most once\&.
       
   509 
       
   510 The value of \f3valDays\fR specifies the number of days (starting at the date specified by \f3-startdate\fR, or the current date when \f3-startdate\fR is not specified) for which the certificate should be considered valid\&.
       
   511 
       
   512 This command was named \f3-genkey\fR in earlier releases\&. The old name is still supported in this release\&. The new name, \f3-genkeypair\fR, is preferred going forward\&.
       
   513 .TP
       
   514 -genseckey
       
   515 .br
       
   516 \f3-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}\fR
       
   517 
       
   518 Generates a secret key and stores it in a new \f3KeyStore\&.SecretKeyEntry\fR identified by \f3alias\fR\&.
       
   519 
       
   520 The value of \f3keyalg\fR specifies the algorithm to be used to generate the secret key, and the value of \f3keysize\fR specifies the size of the key to be generated\&. The \f3keypass\fR value is a password that protects the secret key\&. If no password is provided, then the user is prompted for it\&. If you press the Return key at the prompt, then the key password is set to the same password that is used for the \f3keystore\fR\&. The \f3keypass\fR value must be at least 6 characters\&.
       
   521 .TP
       
   522 -importcert
       
   523 .br
       
   524 \f3-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}\fR
       
   525 
       
   526 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 \f3cert_file\fR, and stores it in the \f3keystore\fR entry identified by \f3alias\fR\&. If no file is specified, then the certificate or certificate chain is read from \f3stdin\fR\&.
       
   527 
       
   528 The \f3keytool\fR command 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 \f3-\fR\f3----BEGIN\fR, and bounded at the end by a string that starts with \f3-----END\fR\&.
       
   529 
       
   530 You import a certificate for two reasons: To add it to the list of trusted certificates, and to import a certificate reply received from a certificate authority (CA) as the result of submitting a Certificate Signing Request to that CA (see the \f3-certreq\fR option in Commands)\&.
       
   531 
       
   532 Which type of import is intended is indicated by the value of the \f3-alias\fR option\&. If the alias does not point to a key entry, then the \f3keytool\fR command 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 the \f3keytool\fR command outputs an error because there is already a trusted certificate for that alias, and does not import the certificate\&. If the alias points to a key entry, then the \f3keytool\fR command assumes you are importing a certificate reply\&.
       
   533 .TP
       
   534 -importpassword
       
   535 .br
       
   536 \f3{-alias alias} [-keypass keypass] {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR
       
   537 
       
   538 Imports a passphrase and stores it in a new \f3KeyStore\&.SecretKeyEntry\fR identified by \f3alias\fR\&. The passphrase may be supplied via the standard input stream; otherwise the user is prompted for it\&. \f3keypass\fR is a password used to protect the imported passphrase\&. If no password is provided, the user is prompted for it\&. If you press the Return key at the prompt, the key password is set to the same password as that used for the \f3keystore\fR\&. \f3keypass\fR must be at least 6 characters long\&.
       
   539 .TP
       
   540 -importkeystore
       
   541 .br
       
   542 \f3{-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}\fR
       
   543 
       
   544 Imports a single entry or all entries from a source keystore to a destination keystore\&.
       
   545 
       
   546 When the \f3-srcalias\fR 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 \f3destalias\fR, then \f3srcalias\fR is used as the destination alias\&. If the source entry is protected by a password, then \f3srckeypass\fR is used to recover the entry\&. If \fIsrckeypass\fR is not provided, then the \f3keytool\fR command attempts to use \f3srcstorepass\fR to recover the entry\&. If \f3srcstorepass\fR is either not provided or is incorrect, then the user is prompted for a password\&. The destination entry is protected with \f3destkeypass\fR\&. If \f3destkeypass\fR is not provided, then the destination entry is protected with the source entry password\&. For example, most third-party tools require \f3storepass\fR and \f3keypass\fR in a PKCS #12 keystore to be the same\&. In order to create a PKCS #12 keystore for these tools, always specify a \f3-destkeypass\fR to be the same as \f3-deststorepass\fR\&.
       
   547 
       
   548 If the \f3-srcalias\fR option is not provided, then all entries in the source keystore are imported into the destination keystore\&. Each destination entry is stored under the alias from the source entry\&. If the source entry is protected by a password, then \f3srcstorepass\fR is used to recover the entry\&. If \f3srcstorepass\fR is either not provided or is incorrect, then the user is 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, then the user is prompted whether to skip the entry and continue or to quit\&. The destination entry is protected with the source entry password\&.
       
   549 
       
   550 If the destination alias already exists in the destination keystore, then the user is prompted to either overwrite the entry or to create a new entry under a different alias name\&.
       
   551 
       
   552 If the \f3-noprompt\fR option is provided, then the user is not prompted for a new destination alias\&. Existing entries are overwritten with the destination alias name\&. Entries that cannot be imported are skipped and a warning is displayed\&.
       
   553 .TP
       
   554 -printcertreq
       
   555 .br
       
   556 \f3{-file file}\fR
       
   557 
       
   558 Prints the content of a PKCS #10 format certificate request, which can be generated by the \f3keytool\fR\f3-certreq\fR command\&. The command reads the request from file\&. If there is no file, then the request is read from the standard input\&.
       
   559 .TP
       
   560 -certreq
       
   561 .br
       
   562 \f3{-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}\fR
       
   563 
       
   564 Generates a Certificate Signing Request (CSR) using the PKCS #10 format\&.
       
   565 
       
   566 A CSR is intended to be sent to a certificate authority (CA)\&. The CA authenticates 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\&.
       
   567 
       
   568 The private key associated with alias is used to create the PKCS #10 certificate request\&. To access the private key, the correct password must be provided\&. If \f3keypass\fR is not provided at the command line and is different from the password used to protect the integrity of the keystore, then the user is prompted for it\&. If \f3dname\fR is provided, then it is used as the subject in the CSR\&. Otherwise, the X\&.500 Distinguished Name associated with alias is used\&.
       
   569 
       
   570 The \f3sigalg\fR value specifies the algorithm that should be used to sign the CSR\&.
       
   571 
       
   572 The CSR is stored in the file certreq_file\&. If no file is specified, then the CSR is output to \f3stdout\fR\&.
       
   573 
       
   574 Use the \f3importcert\fR command to import the response from the CA\&.
       
   575 .TP
       
   576 -exportcert
       
   577 .br
       
   578 \f3{-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}\fR
       
   579 
       
   580 Reads from the keystore the certificate associated with \fIalias\fR and stores it in the cert_file file\&. When no file is specified, the certificate is output to \f3stdout\fR\&.
       
   581 
       
   582 The certificate is by default output in binary encoding\&. If the \f3-rfc\fR option is specified, then the output in the printable encoding format defined by the Internet RFC 1421 Certificate Encoding Standard\&.
       
   583 
       
   584 If \f3alias\fR refers to a trusted certificate, then that certificate is output\&. Otherwise, \f3alias\fR 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 \f3alias\fR\&.
       
   585 
       
   586 This command was named \f3-export\fR in earlier releases\&. The old name is still supported in this release\&. The new name, \f3-exportcert\fR, is preferred going forward\&.
       
   587 .TP
       
   588 -list
       
   589 .br
       
   590 \f3{-alias alias} {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerName provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v | -rfc} {-protected} {-Jjavaoption}\fR
       
   591 
       
   592 Prints to \f3stdout\fR the contents of the keystore entry identified by \f3alias\fR\&. If no \f3alias\fR is specified, then the contents of the entire keystore are printed\&.
       
   593 
       
   594 This command by default prints the SHA1 fingerprint of a certificate\&. If the \f3-v\fR option is specified, then the certificate is printed in human-readable format, with additional information such as the owner, issuer, serial number, and any extensions\&. If the \f3-rfc\fR option is specified, then the certificate contents are printed using the printable encoding format, as defined by the Internet RFC 1421 Certificate Encoding Standard\&.
       
   595 
       
   596 You cannot specify both \f3-v\fR and \f3-rfc\fR\&.
       
   597 .TP
       
   598 -printcert
       
   599 .br
       
   600 \f3{-file cert_file | -sslserver host[:port]} {-jarfile JAR_file {-rfc} {-v} {-Jjavaoption}\fR
       
   601 
       
   602 Reads the certificate from the file cert_file, the SSL server located at host:port, or the signed JAR file \f3JAR_file\fR (with the \f3-jarfile\fR option and prints its contents in a human-readable format\&. When no port is specified, the standard HTTPS port 443 is assumed\&. Note that \f3-sslserver\fR and -file options cannot be provided at the same time\&. Otherwise, an error is reported\&. If neither option is specified, then the certificate is read from \f3stdin\fR\&.
       
   603 
       
   604 When\f3-rfc\fR is specified, the \f3keytool\fR command prints the certificate in PEM mode as defined by the Internet RFC 1421 Certificate Encoding standard\&. See Internet RFC 1421 Certificate Encoding Standard\&.
       
   605 
       
   606 If the certificate is read from a file or \f3stdin\fR, then it might be either binary encoded or in printable encoding format, as defined by the RFC 1421 Certificate Encoding standard\&.
       
   607 
       
   608 If the SSL server is behind a firewall, then the \f3-J-Dhttps\&.proxyHost=proxyhost\fR and \f3-J-Dhttps\&.proxyPort=proxyport\fR options can be specified on the command line for proxy tunneling\&. See Java Secure Socket Extension (JSSE) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide\&.html
       
   609 
       
   610 \fINote:\fR This option can be used independently of a keystore\&.
       
   611 .TP
       
   612 -printcrl
       
   613 .br
       
   614 \f3-file crl_ {-v}\fR
       
   615 
       
   616 Reads the Certificate Revocation List (CRL) from the file \f3crl_\fR\&. A CRL is a list of digital certificates that were revoked by the CA that issued them\&. The CA generates the \f3crl_\fR file\&.
       
   617 
       
   618 \fINote:\fR This option can be used independently of a keystore\&.
       
   619 .TP
       
   620 -storepasswd
       
   621 .br
       
   622 \f3[-new new_storepass] {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerName provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-Jjavaoption}\fR
       
   623 
       
   624 Changes the password used to protect the integrity of the keystore contents\&. The new password is \f3new_storepass\fR, which must be at least 6 characters\&.
       
   625 .TP
       
   626 -keypasswd
       
   627 .br
       
   628 \f3{-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}\fR
       
   629 
       
   630 Changes the password under which the private/secret key identified by \f3alias\fR is protected, from \f3old_keypass\fR to \f3new_keypass\fR, which must be at least 6 characters\&.
       
   631 
       
   632 If the \f3-keypass\fR option is not provided at the command line, and the key password is different from the keystore password, then the user is prompted for it\&.
       
   633 
       
   634 If the \f3-new\fR option is not provided at the command line, then the user is prompted for it
       
   635 .TP
       
   636 -delete
       
   637 .br
       
   638 \f3[-alias alias] {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerName provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR
       
   639 
       
   640 Deletes from the keystore the entry identified by \f3alias\fR\&. The user is prompted for the alias, when no alias is provided at the command line\&.
       
   641 .TP
       
   642 -changealias
       
   643 .br
       
   644 \f3{-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}\fR
       
   645 
       
   646 Move an existing keystore entry from the specified \f3alias\fR to a new alias, \f3destalias\fR\&. If no destination alias is provided, then the command prompts for one\&. If the original entry is protected with an entry password, then the password can be supplied with the \f3-keypass\fR option\&. If no key password is provided, then the \f3storepass\fR (if provided) is attempted first\&. If the attempt fails, then the user is prompted for a password\&.
       
   647 .TP
       
   648 -help
       
   649 .br
       
   650 Lists the basic commands and their options\&.
       
   651 
       
   652 For more information about a specific command, enter the following, where \f3command_name\fR is the name of the command: \f3keytool -command_name -help\fR\&.
       
   653 .SH EXAMPLES    
       
   654 This example walks through the sequence of steps to create a keystore for managing public/private key pair and certificates from trusted entities\&.
       
   655 .SS GENERATE\ THE\ KEY\ PAIR    
       
   656 First, create a keystore and generate the key pair\&. You can use a command such as the following typed as a single line:
       
   657 .sp     
       
   658 .nf     
       
   659 \f3keytool \-genkeypair \-dname "cn=Mark Jones, ou=Java, o=Oracle, c=US"\fP
       
   660 .fi     
       
   661 .nf     
       
   662 \f3    \-alias business \-keypass <new password for private key>\fP
       
   663 .fi     
       
   664 .nf     
       
   665 \f3    \-keystore /working/mykeystore\fP
       
   666 .fi     
       
   667 .nf     
       
   668 \f3    \-storepass <new password for keystore> \-validity 180\fP
       
   669 .fi     
       
   670 .nf     
       
   671 \f3\fP
       
   672 .fi     
       
   673 .sp     
       
   674 The command creates the keystore named \f3mykeystore\fR in the working directory (assuming it does not already exist), and assigns it the password specified by \f3<new password for keystore>\fR\&. 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 are 1024 bits\&.
       
   675 .PP
       
   676 The command uses the default SHA1withDSA signature algorithm to create a self-signed certificate that includes the public key and the distinguished name information\&. The certificate is valid for 180 days, and is associated with the private key in a keystore entry referred to by the alias \f3business\fR\&. The private key is assigned the password specified by \f3<new password for private key>\fR\&.
       
   677 .PP
       
   678 The command is significantly shorter when the option defaults are accepted\&. In this case, no options are required, and the defaults are used for unspecified options that have default values\&. You are prompted for any required values\&. You could have the following:
       
   679 .sp     
       
   680 .nf     
       
   681 \f3keytool \-genkeypair\fP
       
   682 .fi     
       
   683 .nf     
       
   684 \f3\fP
       
   685 .fi     
       
   686 .sp     
       
   687 In this case, a keystore entry with the alias \f3mykey\fR 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 \f3\&.keystore\fR in your home directory\&. The keystore is created when it does not already exist\&. You are prompted for the distinguished name information, the keystore password, and the private key password\&.
       
   688 .PP
       
   689 The rest of the examples assume you executed the \f3-genkeypair\fR command without options specified, and that you responded to the prompts with values equal to those specified in the first \f3-genkeypair\fR command\&. For example, a distinguished name of \f3cn=Mark Jones\fR, \f3ou=Java\fR, \f3o=Oracle\fR, \f3c=US\fR)\&.
       
   690 .SS REQUEST\ A\ SIGNED\ CERTIFICATE\ FROM\ A\ CA    
       
   691 Generating the key pair created a self-signed certificate\&. A certificate is more likely to be trusted by others when it is signed by a Certification Authority (CA)\&. To get a CA signature, first generate a Certificate Signing Request (CSR), as follows:
       
   692 .sp     
       
   693 .nf     
       
   694 \f3keytool \-certreq \-file MarkJ\&.csr\fP
       
   695 .fi     
       
   696 .nf     
       
   697 \f3\fP
       
   698 .fi     
       
   699 .sp     
       
   700 This creates a CSR for the entity identified by the default alias \f3mykey\fR and puts the request in the file named MarkJ\&.csr\&. Submit this file to a CA, such as VeriSign\&. The CA authenticates you, the requestor (usually off-line), and returns a certificate, signed by them, authenticating your public key\&. In some cases, the CA returns a chain of certificates, each one authenticating the public key of the signer of the previous certificate in the chain\&.
       
   701 .SS IMPORT\ A\ CERTIFICATE\ FOR\ THE\ CA    
       
   702 You now need to replace the 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\&.
       
   703 .PP
       
   704 Before you import the certificate reply from a CA, you need one or more trusted certificates in your keystore or in the \f3cacerts\fR keystore file\&. See \f3-importcert\fR in Commands\&.
       
   705 .TP 0.2i    
       
   706 \(bu
       
   707 If the certificate reply is a certificate chain, then you need the top certificate of the chain\&. The root CA certificate that authenticates the public key of the CA\&.
       
   708 .TP 0.2i    
       
   709 \(bu
       
   710 If the certificate reply is a single certificate, then you need a certificate for the issuing CA (the one that signed it)\&. If that certificate is not self-signed, then you need a certificate for its signer, and so on, up to a self-signed root CA certificate\&.
       
   711 .PP
       
   712 The \f3cacerts\fR keystore file ships with several VeriSign root CA certificates, so you probably will not 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 was not added to \f3cacerts\fR, then you must import a certificate from the CA as a trusted certificate\&.
       
   713 .PP
       
   714 A certificate from a CA is usually either self-signed or signed by another CA, in which case you need a certificate that authenticates that CA\&'s public key\&. Suppose company ABC, Inc\&., is a CA, and you obtain a file named A\f3BCCA\&.cer\fR that is supposed to be a self-signed certificate from ABC, that authenticates that CA\&'s public key\&. Be careful to ensure the certificate is valid before you import it as a trusted certificate\&. View it first with the \f3keytool -printcert\fR command or the \f3keytool -importcert\fR command without the \f3-noprompt\fR option, and make sure that the displayed certificate fingerprints match the expected ones\&. You can call the person who sent the certificate, and compare the fingerprints that you see with the ones that they show or that a secure public key repository shows\&. Only when the fingerprints are equal is it guaranteed that the certificate was not replaced in transit with somebody else\&'s (for example, an attacker\&'s) certificate\&. If such an attack takes place, and you did not check the certificate before you imported it, then you would be trusting anything the attacker has signed\&.
       
   715 .PP
       
   716 If you trust that the certificate is valid, then you can add it to your keystore with the following command:
       
   717 .sp     
       
   718 .nf     
       
   719 \f3keytool \-importcert \-alias abc \-file ABCCA\&.cer\fP
       
   720 .fi     
       
   721 .nf     
       
   722 \f3\fP
       
   723 .fi     
       
   724 .sp     
       
   725 This command creates a trusted certificate entry in the keystore, with the data from the file ABCCA\&.cer, and assigns the alias \f3abc\fR to the entry\&.
       
   726 .SS IMPORT\ THE\ CERTIFICATE\ REPLY\ FROM\ THE\ CA    
       
   727 After you import a certificate that authenticates the public key of the CA you submitted your certificate signing request to (or there is already such a certificate in the cacerts file), you can import the certificate reply and replace your self-signed certificate with a certificate chain\&. This chain is the one returned by the CA in response to your request (when the CA reply is a chain), or one constructed (when 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 \f3cacerts\fR keystore file\&.
       
   728 .PP
       
   729 For example, if you sent your certificate signing request to VeriSign, then you can import the reply with the following, which assumes the returned certificate is named VSMarkJ\&.cer:
       
   730 .sp     
       
   731 .nf     
       
   732 \f3keytool \-importcert \-trustcacerts \-file VSMarkJ\&.cer\fP
       
   733 .fi     
       
   734 .nf     
       
   735 \f3\fP
       
   736 .fi     
       
   737 .sp     
       
   738 .SS EXPORT\ A\ CERTIFICATE\ THAT\ AUTHENTICATES\ THE\ PUBLIC\ KEY    
       
   739 If you used the \f3jarsigner\fR command to sign a Java Archive (JAR) file, then clients that want to use the file will want to authenticate your signature\&. One way the clients can authenticate you is by first importing your public key certificate into their keystore as a trusted entry\&.
       
   740 .PP
       
   741 You can export the certificate and supply it to your clients\&. As an example, you can copy your certificate to a file named MJ\&.cer with the following command that assumes the entry has an alias of \f3mykey\fR:
       
   742 .sp     
       
   743 .nf     
       
   744 \f3keytool \-exportcert \-alias mykey \-file MJ\&.cer\fP
       
   745 .fi     
       
   746 .nf     
       
   747 \f3\fP
       
   748 .fi     
       
   749 .sp     
       
   750 With the certificate and the signed JAR file, a client can use the \f3jarsigner\fR command to authenticate your signature\&.
       
   751 .SS IMPORT\ KEYSTORE    
       
   752 The command \f3importkeystore\fR is used to import an entire keystore into another keystore, which means all entries from the source keystore, including keys and certificates, are all imported to the destination keystore within a single command\&. You can use this command to import entries from a different type of keystore\&. During the import, all new entries in the destination keystore will have the same alias names and protection passwords (for secret keys and private keys)\&. If the \f3keytool\fR command cannot recover the private keys or secret keys from the source keystore, then it prompts you for a password\&. If it detects alias duplication, then it asks you for a new alias, and you can specify a new alias or simply allow the \f3keytool\fR command to overwrite the existing one\&.
       
   753 .PP
       
   754 For example, to import entries from a typical JKS type keystore key\&.jks into a PKCS #11 type hardware-based keystore, use the command:
       
   755 .sp     
       
   756 .nf     
       
   757 \f3keytool \-importkeystore\fP
       
   758 .fi     
       
   759 .nf     
       
   760 \f3    \-srckeystore key\&.jks \-destkeystore NONE\fP
       
   761 .fi     
       
   762 .nf     
       
   763 \f3    \-srcstoretype JKS \-deststoretype PKCS11\fP
       
   764 .fi     
       
   765 .nf     
       
   766 \f3    \-srcstorepass <src keystore password>\fP
       
   767 .fi     
       
   768 .nf     
       
   769 \f3    \-deststorepass <destination keystore pwd>\fP
       
   770 .fi     
       
   771 .nf     
       
   772 \f3\fP
       
   773 .fi     
       
   774 .sp     
       
   775 The \f3importkeystore\fR command can also be used to import a single entry from a source keystore to a destination keystore\&. In this case, besides the options you see in the previous example, you need to specify the alias you want to import\&. With the \f3-srcalias\fR option specified, you can also specify the destination alias name in the command line, as well as protection password for a secret/private key and the destination protection password you want\&. The following command demonstrates this:
       
   776 .sp     
       
   777 .nf     
       
   778 \f3keytool \-importkeystore\fP
       
   779 .fi     
       
   780 .nf     
       
   781 \f3    \-srckeystore key\&.jks \-destkeystore NONE\fP
       
   782 .fi     
       
   783 .nf     
       
   784 \f3    \-srcstoretype JKS \-deststoretype PKCS11\fP
       
   785 .fi     
       
   786 .nf     
       
   787 \f3    \-srcstorepass <src keystore password>\fP
       
   788 .fi     
       
   789 .nf     
       
   790 \f3    \-deststorepass <destination keystore pwd>\fP
       
   791 .fi     
       
   792 .nf     
       
   793 \f3    \-srcalias myprivatekey \-destalias myoldprivatekey\fP
       
   794 .fi     
       
   795 .nf     
       
   796 \f3    \-srckeypass <source entry password>\fP
       
   797 .fi     
       
   798 .nf     
       
   799 \f3    \-destkeypass <destination entry password>\fP
       
   800 .fi     
       
   801 .nf     
       
   802 \f3    \-noprompt\fP
       
   803 .fi     
       
   804 .nf     
       
   805 \f3\fP
       
   806 .fi     
       
   807 .sp     
       
   808 .SS GENERATE\ CERTIFICATES\ FOR\ AN\ SSL\ SERVER    
       
   809 The following are \f3keytool\fR commands to generate key pairs and certificates for three entities: Root CA (\f3root\fR), Intermediate CA (\f3ca\fR), and SSL server (\f3server\fR)\&. Ensure that you store all the certificates in the same keystore\&. In these examples, RSA is the recommended the key algorithm\&.
       
   810 .sp     
       
   811 .nf     
       
   812 \f3keytool \-genkeypair \-keystore root\&.jks \-alias root \-ext bc:c\fP
       
   813 .fi     
       
   814 .nf     
       
   815 \f3keytool \-genkeypair \-keystore ca\&.jks \-alias ca \-ext bc:c\fP
       
   816 .fi     
       
   817 .nf     
       
   818 \f3keytool \-genkeypair \-keystore server\&.jks \-alias server\fP
       
   819 .fi     
       
   820 .nf     
       
   821 \f3\fP
       
   822 .fi     
       
   823 .nf     
       
   824 \f3keytool \-keystore root\&.jks \-alias root \-exportcert \-rfc > root\&.pem\fP
       
   825 .fi     
       
   826 .nf     
       
   827 \f3\fP
       
   828 .fi     
       
   829 .nf     
       
   830 \f3keytool \-storepass <storepass> \-keystore ca\&.jks \-certreq \-alias ca |\fP
       
   831 .fi     
       
   832 .nf     
       
   833 \f3    keytool \-storepass <storepass> \-keystore root\&.jks\fP
       
   834 .fi     
       
   835 .nf     
       
   836 \f3    \-gencert \-alias root \-ext BC=0 \-rfc > ca\&.pem\fP
       
   837 .fi     
       
   838 .nf     
       
   839 \f3keytool \-keystore ca\&.jks \-importcert \-alias ca \-file ca\&.pem\fP
       
   840 .fi     
       
   841 .nf     
       
   842 \f3\fP
       
   843 .fi     
       
   844 .nf     
       
   845 \f3keytool \-storepass <storepass> \-keystore server\&.jks \-certreq \-alias server |\fP
       
   846 .fi     
       
   847 .nf     
       
   848 \f3    keytool \-storepass <storepass> \-keystore ca\&.jks \-gencert \-alias ca\fP
       
   849 .fi     
       
   850 .nf     
       
   851 \f3    \-ext ku:c=dig,kE \-rfc > server\&.pem\fP
       
   852 .fi     
       
   853 .nf     
       
   854 \f3cat root\&.pem ca\&.pem server\&.pem |\fP
       
   855 .fi     
       
   856 .nf     
       
   857 \f3    keytool \-keystore server\&.jks \-importcert \-alias server\fP
       
   858 .fi     
       
   859 .nf     
       
   860 \f3\fP
       
   861 .fi     
       
   862 .sp     
       
   863 .SH TERMS    
       
   864 .TP     
       
   865 Keystore
       
   866 A keystore is a storage facility for cryptographic keys and certificates\&.
       
   867 .TP     
       
   868 Keystore entries
       
   869 Keystores can have different types of entries\&. The two most applicable entry types for the \f3keytool\fR command include the following:
       
   870 
       
   871 \fIKey entries\fR: Each entry holds very sensitive cryptographic key information, which is stored in a protected format to prevent unauthorized access\&. Typically, a key stored in this type of entry is a secret key, or a private key accompanied by the certificate chain for the corresponding public key\&. See Certificate Chains\&. The \f3keytool\fR command can handle both types of entries, while the \f3jarsigner\fR tool only handles the latter type of entry, that is private keys and their associated certificate chains\&.
       
   872 
       
   873 \fITrusted certificate entries\fR: Each entry contains a single public key certificate that belongs to another party\&. The entry is called a trusted certificate because the keystore owner trusts that the public key in the certificate belongs to the identity identified by the subject (owner) of the certificate\&. The issuer of the certificate vouches for this, by signing the certificate\&.
       
   874 .TP     
       
   875 KeyStore aliases
       
   876 All keystore entries (key and trusted certificate entries) are accessed by way of unique aliases\&.
       
   877 
       
   878 An alias is specified when you add an entity to the keystore with the \f3-genseckey\fR command to generate a secret key, the \f3-genkeypair\fR command to generate a key pair (public and private key), or the \f3-importcert\fR command to add a certificate or certificate chain to the list of trusted certificates\&. Subsequent \f3keytool\fR commands must use this same alias to refer to the entity\&.
       
   879 
       
   880 For example, you can use the alias \f3duke\fR to generate a new public/private key pair and wrap the public key into a self-signed certificate with the following command\&. See Certificate Chains\&.
       
   881 .sp     
       
   882 .nf     
       
   883 \f3keytool \-genkeypair \-alias duke \-keypass dukekeypasswd\fP
       
   884 .fi     
       
   885 .nf     
       
   886 \f3\fP
       
   887 .fi     
       
   888 .sp     
       
   889 
       
   890 
       
   891 This example specifies an initial password of \f3dukekeypasswd\fR required by subsequent commands to access the private key associated with the alias \f3duke\fR\&. If you later want to change Duke\&'s private key password, use a command such as the following:
       
   892 .sp     
       
   893 .nf     
       
   894 \f3keytool \-keypasswd \-alias duke \-keypass dukekeypasswd \-new newpass\fP
       
   895 .fi     
       
   896 .nf     
       
   897 \f3\fP
       
   898 .fi     
       
   899 .sp     
       
   900 
       
   901 
       
   902 This changes the password from \f3dukekeypasswd\fR to \f3newpass\fR\&. A password should not be specified on a command line or in a script unless it is for testing purposes, or you are on a secure system\&. If you do not specify a required password option on a command line, then you are prompted for it\&.
       
   903 .TP     
       
   904 KeyStore implementation
       
   905 The \f3KeyStore\fR class provided in the \f3java\&.security\fR package supplies well-defined interfaces to access and modify the information in a keystore\&. It is possible for there to be multiple different concrete implementations, where each implementation is that for a particular type of keystore\&.
       
   906 
       
   907 Currently, two command-line tools (\f3keytool\fR and \f3jarsigner\fR) and a GUI-based tool named Policy Tool make use of keystore implementations\&. Because the \f3KeyStore\fR class is \f3public\fR, users can write additional security applications that use it\&.
       
   908 
       
   909 There is a built-in default implementation, provided by Oracle\&. It implements the keystore as a file with a proprietary keystore type (format) named JKS\&. It protects each private key with its individual password, and also protects the integrity of the entire keystore with a (possibly different) password\&.
       
   910 
       
   911 Keystore implementations are provider-based\&. More specifically, the application interfaces supplied by \f3KeyStore\fR are implemented in terms of a Service Provider Interface (SPI)\&. That is, there is a corresponding abstract \f3KeystoreSpi\fR class, also in the \f3java\&.security package\fR, which defines the Service Provider Interface methods that providers must implement\&. The term \fIprovider\fR refers to a package or a set of packages that supply a concrete implementation of a subset of services that can be accessed by the Java Security API\&. To provide a keystore implementation, clients must implement a provider and supply a \f3KeystoreSpi\fR subclass implementation, as described in How to Implement a Provider in the Java Cryptography Architecture at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/HowToImplAProvider\&.html
       
   912 
       
   913 Applications can choose different types of keystore implementations from different providers, using the \f3getInstance\fR factory method supplied in the \f3KeyStore\fR class\&. A keystore type defines the storage and data format of the keystore information, and the algorithms used to protect private/secret keys in the keystore and the integrity of the keystore\&. Keystore implementations of different types are not compatible\&.
       
   914 
       
   915 The \f3keytool\fR command works on any file-based keystore implementation\&. It treats the keystore location that is passed to it at the command line as a file name and converts it to a \f3FileInputStream\fR, from which it loads the keystore information\&.)The \f3jarsigner\fR and \f3policytool\fR commands can read a keystore from any location that can be specified with a URL\&.
       
   916 
       
   917 For \f3keytool\fR and \f3jarsigner\fR, you can specify a keystore type at the command line, with the \f3-storetype\fR option\&. For Policy Tool, you can specify a keystore type with the \fIKeystore\fR menu\&.
       
   918 
       
   919 If you do not explicitly specify a keystore type, then the tools choose a keystore implementation based on the value of the \f3keystore\&.type\fR property specified in the security properties file\&. The security properties file is called \f3java\&.security\fR, and resides in the security properties directory, \f3java\&.home\elib\esecurity\fR on Windows and \f3java\&.home/lib/security\fR on Oracle Solaris, where \f3java\&.home\fR is the runtime environment directory\&. The \f3jre\fR directory in the SDK or the top-level directory of the Java Runtime Environment (JRE)\&.
       
   920 
       
   921 Each tool gets the \f3keystore\&.type\fR value and then examines all the currently installed providers until it finds one that implements a keystores of that type\&. It then uses the keystore implementation from that provider\&.The \f3KeyStore\fR class defines a static method named \f3getDefaultType\fR that lets applications and applets retrieve the value of the \f3keystore\&.type\fR property\&. The following line of code creates an instance of the default keystore type as specified in the \f3keystore\&.type\fR property:
       
   922 .sp     
       
   923 .nf     
       
   924 \f3KeyStore keyStore = KeyStore\&.getInstance(KeyStore\&.getDefaultType());\fP
       
   925 .fi     
       
   926 .nf     
       
   927 \f3\fP
       
   928 .fi     
       
   929 .sp     
       
   930 
       
   931 
       
   932 The default keystore type is \f3jks\fR, which is the proprietary type of the keystore implementation provided by Oracle\&. This is specified by the following line in the security properties file:
       
   933 .sp     
       
   934 .nf     
       
   935 \f3keystore\&.type=jks\fP
       
   936 .fi     
       
   937 .nf     
       
   938 \f3\fP
       
   939 .fi     
       
   940 .sp     
       
   941 
       
   942 
       
   943 To have the tools utilize a keystore implementation other than the default, you can change that line to specify a different keystore type\&. For example, if you have a provider package that supplies a keystore implementation for a keystore type called \f3pkcs12\fR, then change the line to the following:
       
   944 .sp     
       
   945 .nf     
       
   946 \f3keystore\&.type=pkcs12\fP
       
   947 .fi     
       
   948 .nf     
       
   949 \f3\fP
       
   950 .fi     
       
   951 .sp     
       
   952 
       
   953 
       
   954 \fINote:\fR Case does not matter in keystore type designations\&. For example, JKS would be considered the same as jks\&.
       
   955 .TP     
       
   956 Certificate
       
   957 A certificate (or public-key certificate) is a digitally signed statement from one entity (the issuer), saying that the public key and some other information of another entity (the subject) has some specific value\&. The following terms are related to certificates:
       
   958 
       
   959 \fIPublic Keys\fR: These are numbers associated with a particular entity, and are intended to be known to everyone who needs to have trusted interactions with that entity\&. Public keys are used to verify signatures\&.
       
   960 
       
   961 \fIDigitally Signed\fR: If some data is digitally signed, then it is stored with the identity of an entity and a signature that proves that entity knows about the data\&. The data is rendered unforgeable by signing with the entity\&'s private key\&.
       
   962 
       
   963 \fIIdentity\fR: A known way of addressing an entity\&. In some systems, the identity is the public key, and in others it can be anything from an Oracle Solaris UID to an email address to an X\&.509 distinguished name\&.
       
   964 
       
   965 \fISignature\fR: A signature is computed over some data using the private key of an entity\&. The signer, which in the case of a certificate is also known as the issuer\&.
       
   966 
       
   967 \fIPrivate Keys\fR: These are numbers, each of which is supposed to be known only to the particular entity whose private key it is (that is, it is supposed to be kept secret)\&. Private and public keys exist in pairs in all public key cryptography systems (also referred to as public key crypto systems)\&. In a typical public key crypto system, such as DSA, a private key corresponds to exactly one public key\&. Private keys are used to compute signatures\&.
       
   968 
       
   969 \fIEntity\fR: An entity is a person, organization, program, computer, business, bank, or something else you are trusting to some degree\&.
       
   970 
       
   971 Public key cryptography requires access to users\&' public keys\&. In a large-scale networked environment, it is impossible to guarantee that prior relationships between communicating entities were established or that a trusted repository exists with all used public keys\&. Certificates were invented as a solution to this public key distribution problem\&. Now a Certification Authority (CA) can act as a trusted third party\&. CAs are entities such as businesses that are trusted to sign (issue) certificates for other entities\&. It is assumed that CAs only create valid and reliable certificates because they are bound by legal agreements\&. There are many public Certification Authorities, such as VeriSign, Thawte, Entrust, and so on\&.
       
   972 
       
   973 You can also run your own Certification Authority using products such as Microsoft Certificate Server or the Entrust CA product for your organization\&. With the \f3keytool\fR command, it is possible to display, import, and export certificates\&. It is also possible to generate self-signed certificates\&.
       
   974 
       
   975 The \f3keytool\fR command currently handles X\&.509 certificates\&.
       
   976 .TP     
       
   977 X\&.509 Certificates
       
   978 The X\&.509 standard defines what information can go into a certificate and describes how to write it down (the data format)\&. All the data in a certificate is encoded with two related standards called ASN\&.1/DER\&. Abstract Syntax Notation 1 describes data\&. The Definite Encoding Rules describe a single way to store and transfer that data\&.
       
   979 
       
   980 All X\&.509 certificates have the following data, in addition to the signature:
       
   981 
       
   982 \fIVersion\fR: This identifies which version of the X\&.509 standard applies to this certificate, which affects what information can be specified in it\&. Thus far, three versions are defined\&. The \f3keytool\fR command can import and export v1, v2, and v3 certificates\&. It generates v3 certificates\&.
       
   983 
       
   984 X\&.509 Version 1 has been available since 1988, is widely deployed, and is the most generic\&.
       
   985 
       
   986 X\&.509 Version 2 introduced the concept of subject and issuer unique identifiers to handle the possibility of reuse of subject or issuer names over time\&. Most certificate profile documents strongly recommend that names not be reused and that certificates should not make use of unique identifiers\&. Version 2 certificates are not widely used\&.
       
   987 
       
   988 X\&.509 Version 3 is the most recent (1996) and supports the notion of extensions where anyone can define an extension and include it in the certificate\&. Some common extensions are: KeyUsage (limits the use of the keys to particular purposes such as \f3signing-only\fR) and AlternativeNames (allows other identities to also be associated with this public key, for example\&. DNS names, email addresses, IP addresses)\&. Extensions can be marked critical to indicate that the extension should be checked and enforced or used\&. For example, if a certificate has the KeyUsage extension marked critical and set to \f3keyCertSign\fR, then when this certificate is presented during SSL communication, it should be rejected because the certificate extension indicates that the associated private key should only be used for signing certificates and not for SSL use\&.
       
   989 
       
   990 \fISerial number\fR: The entity that created the certificate is responsible for assigning it a serial number to distinguish it from other certificates it issues\&. This information is used in numerous ways\&. For example, when a certificate is revoked its serial number is placed in a Certificate Revocation List (CRL)\&.
       
   991 
       
   992 \fISignature algorithm identifier\fR: This identifies the algorithm used by the CA to sign the certificate\&.
       
   993 
       
   994 \fIIssuer name\fR: The X\&.500 Distinguished Name of the entity that signed the certificate\&. See X\&.500 Distinguished Names\&. This is typically a CA\&. Using this certificate implies trusting the entity that signed this certificate\&. In some cases, such as root or top-level CA certificates, the issuer signs its own certificate\&.
       
   995 
       
   996 \fIValidity period\fR: Each certificate is valid only for a limited amount of time\&. This period is described by a start date and time and an end date and time, and can be as short as a few seconds or almost as long as a century\&. The validity period chosen depends on a number of factors, such as the strength of the private key used to sign the certificate, or the amount one is willing to pay for a certificate\&. This is the expected period that entities can rely on the public value, when the associated private key has not been compromised\&.
       
   997 
       
   998 \fISubject name\fR: The name of the entity whose public key the certificate identifies\&. This name uses the X\&.500 standard, so it is intended to be unique across the Internet\&. This is the X\&.500 Distinguished Name (DN) of the entity\&. See X\&.500 Distinguished Names\&. For example,
       
   999 .sp     
       
  1000 .nf     
       
  1001 \f3CN=Java Duke, OU=Java Software Division, O=Oracle Corporation, C=US\fP
       
  1002 .fi     
       
  1003 .nf     
       
  1004 \f3\fP
       
  1005 .fi     
       
  1006 .sp     
       
  1007 
       
  1008 
       
  1009 These refer to the subject\&'s common name (CN), organizational unit (OU), organization (O), and country (C)\&.
       
  1010 
       
  1011 \fISubject public key information\fR: This is the public key of the entity being named with an algorithm identifier that specifies which public key crypto system this key belongs to and any associated key parameters\&.
       
  1012 .TP     
       
  1013 Certificate Chains
       
  1014 The \f3keytool\fR command can create and manage keystore key entries that each contain a private key and an associated certificate chain\&. The first certificate in the chain contains the public key that corresponds to the private key\&.
       
  1015 
       
  1016 When keys are first generated, the chain starts off containing a single element, a self-signed certificate\&. See \f3-genkeypair\fR in Commands\&. A self-signed certificate is one for which the issuer (signer) is the same as the subject\&. The subject is the entity whose public key is being authenticated by the certificate\&. Whenever the \f3-genkeypair\fR command is called to generate a new public/private key pair, it also wraps the public key into a self-signed certificate\&.
       
  1017 
       
  1018 Later, after a Certificate Signing Request (CSR) was generated with the \f3-certreq\fR command and sent to a Certification Authority (CA), the response from the CA is imported with \f3-importcert\fR, and the self-signed certificate is replaced by a chain of certificates\&. See the \f3-certreq\fR and \f3-importcert\fR options in Commands\&. At the bottom of the chain is the certificate (reply) issued by the CA authenticating the subject\&'s public key\&. The next certificate in the chain is one that authenticates the CA\&'s public key\&.
       
  1019 
       
  1020 In many cases, this is a self-signed certificate, which is a certificate from the CA authenticating its own public key, and the last certificate in the chain\&. In other cases, the CA might return a chain of certificates\&. In this case, the bottom certificate in the chain is the same (a certificate signed by the CA, authenticating the public key of the key entry), but the second certificate in the chain is a certificate signed by a different CA that authenticates the public key of the CA you sent the CSR to\&. The next certificate in the chain is a certificate that authenticates the second CA\&'s key, and so on, until a self-signed root certificate is reached\&. Each certificate in the chain (after the first) authenticates the public key of the signer of the previous certificate in the chain\&.
       
  1021 
       
  1022 Many CAs only return the issued certificate, with no supporting chain, especially when there is a flat hierarchy (no intermediates CAs)\&. In this case, the certificate chain must be established from trusted certificate information already stored in the keystore\&.
       
  1023 
       
  1024 A different reply format (defined by the PKCS #7 standard) includes the supporting certificate chain in addition to the issued certificate\&. Both reply formats can be handled by the \f3keytool\fR command\&.
       
  1025 
       
  1026 The top-level (root) CA certificate is self-signed\&. However, the trust into the root\&'s public key does not come from the root certificate itself, but from other sources such as a newspaper\&. This is because anybody could generate a self-signed certificate with the distinguished name of, for example, the VeriSign root CA\&. The root CA public key is widely known\&. The only reason it is stored in a certificate is because this is the format understood by most tools, so the certificate in this case is only used as a vehicle to transport the root CA\&'s public key\&. Before you add the root CA certificate to your keystore, you should view it with the \f3-printcert\fR option and compare the displayed fingerprint with the well-known fingerprint obtained from a newspaper, the root CA\&'s Web page, and so on\&.
       
  1027 .TP     
       
  1028 The cacerts Certificates File
       
  1029 A certificates file named \f3cacerts\fR resides in the security properties directory, \f3java\&.home\elib\esecurity\fR on Windows and \f3java\&.home/lib/security\fR on Oracle Solaris, where \f3java\&.home\fR is the runtime environment\&'s directory, which would be the \f3jre\fR directory in the SDK or the top-level directory of the JRE\&.
       
  1030 
       
  1031 The \f3cacerts\fR file represents a system-wide keystore with CA certificates\&. System administrators can configure and manage that file with the \f3keytool\fR command by specifying \f3jks\fR as the keystore type\&. The \f3cacerts\fR keystore file ships with a default set of root CA certificates\&. You can list the default certificates with the following command:
       
  1032 .sp     
       
  1033 .nf     
       
  1034 \f3keytool \-list \-keystore java\&.home/lib/security/cacerts\fP
       
  1035 .fi     
       
  1036 .nf     
       
  1037 \f3\fP
       
  1038 .fi     
       
  1039 .sp     
       
  1040 
       
  1041 
       
  1042 The initial password of the \f3cacerts\fR keystore file is \f3changeit\fR\&. System administrators should change that password and the default access permission of that file upon installing the SDK\&.
       
  1043 
       
  1044 \fINote:\fR It is important to verify your \f3cacerts\fR file\&. Because you trust the CAs in the \f3cacerts\fR file as entities for signing and issuing certificates to other entities, you must manage the \f3cacerts\fR file carefully\&. The \f3cacerts\fR file should contain only certificates of the CAs you trust\&. It is your responsibility to verify the trusted root CA certificates bundled in the \f3cacerts\fR file and make your own trust decisions\&.
       
  1045 
       
  1046 To remove an untrusted CA certificate from the \f3cacerts\fR file, use the \f3delete\fR option of the \f3keytool\fR command\&. You can find the \f3cacerts\fR file in the JRE installation directory\&. Contact your system administrator if you do not have permission to edit this file
       
  1047 .TP     
       
  1048 Internet RFC 1421 Certificate Encoding Standard
       
  1049 Certificates are often stored using the printable encoding format defined by the Internet RFC 1421 standard, instead of their binary encoding\&. This certificate format, also known as Base64 encoding, makes it easy to export certificates to other applications by email or through some other mechanism\&.
       
  1050 
       
  1051 Certificates read by the \f3-importcert\fR and \f3-printcert\fR commands can be in either this format or binary encoded\&. The \f3-exportcert\fR command by default outputs a certificate in binary encoding, but will instead output a certificate in the printable encoding format, when the \f3-rfc\fR option is specified\&.
       
  1052 
       
  1053 The \f3-list\fR command by default prints the SHA1 fingerprint of a certificate\&. If the \f3-v\fR option is specified, then the certificate is printed in human-readable format\&. If the \f3-rfc\fR option is specified, then the certificate is output in the printable encoding format\&.
       
  1054 
       
  1055 In its printable encoding format, the encoded certificate is bounded at the beginning and end by the following text:
       
  1056 .sp     
       
  1057 .nf     
       
  1058 \f3\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-\fP
       
  1059 .fi     
       
  1060 .nf     
       
  1061 \f3\fP
       
  1062 .fi     
       
  1063 .nf     
       
  1064 \f3encoded certificate goes here\&. \fP
       
  1065 .fi     
       
  1066 .nf     
       
  1067 \f3\fP
       
  1068 .fi     
       
  1069 .nf     
       
  1070 \f3\-\-\-\-\-END CERTIFICATE\-\-\-\-\-\fP
       
  1071 .fi     
       
  1072 .nf     
       
  1073 \f3\fP
       
  1074 .fi     
       
  1075 .sp     
       
  1076 
       
  1077 .TP     
       
  1078 X\&.500 Distinguished Names
       
  1079 X\&.500 Distinguished Names are used to identify entities, such as those that are named by the \f3subject\fR and \f3issuer\fR (signer) fields of X\&.509 certificates\&. The \f3keytool\fR command supports the following subparts:
       
  1080 
       
  1081 \fIcommonName\fR: The common name of a person such as Susan Jones\&.
       
  1082 
       
  1083 \fIorganizationUnit\fR: The small organization (such as department or division) name\&. For example, Purchasing\&.
       
  1084 
       
  1085 \fIlocalityName\fR: The locality (city) name, for example, Palo Alto\&.
       
  1086 
       
  1087 \fIstateName\fR: State or province name, for example, California\&.
       
  1088 
       
  1089 \fIcountry\fR: Two-letter country code, for example, CH\&.
       
  1090 
       
  1091 When you supply a distinguished name string as the value of a \f3-dname\fR option, such as for the \f3-genkeypair\fR command, the string must be in the following format:
       
  1092 .sp     
       
  1093 .nf     
       
  1094 \f3CN=cName, OU=orgUnit, O=org, L=city, S=state, C=countryCode\fP
       
  1095 .fi     
       
  1096 .nf     
       
  1097 \f3\fP
       
  1098 .fi     
       
  1099 .sp     
       
  1100 
       
  1101 
       
  1102 All the italicized items represent actual values and the previous keywords are abbreviations for the following:
       
  1103 .sp     
       
  1104 .nf     
       
  1105 \f3CN=commonName\fP
       
  1106 .fi     
       
  1107 .nf     
       
  1108 \f3OU=organizationUnit\fP
       
  1109 .fi     
       
  1110 .nf     
       
  1111 \f3O=organizationName\fP
       
  1112 .fi     
       
  1113 .nf     
       
  1114 \f3L=localityName\fP
       
  1115 .fi     
       
  1116 .nf     
       
  1117 \f3S=stateName\fP
       
  1118 .fi     
       
  1119 .nf     
       
  1120 \f3C=country\fP
       
  1121 .fi     
       
  1122 .nf     
       
  1123 \f3\fP
       
  1124 .fi     
       
  1125 .sp     
       
  1126 
       
  1127 
       
  1128 A sample distinguished name string is:
       
  1129 .sp     
       
  1130 .nf     
       
  1131 \f3CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino, S=California, C=US\fP
       
  1132 .fi     
       
  1133 .nf     
       
  1134 \f3\fP
       
  1135 .fi     
       
  1136 .sp     
       
  1137 
       
  1138 
       
  1139 A sample command using such a string is:
       
  1140 .sp     
       
  1141 .nf     
       
  1142 \f3keytool \-genkeypair \-dname "CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino,\fP
       
  1143 .fi     
       
  1144 .nf     
       
  1145 \f3S=California, C=US" \-alias mark\fP
       
  1146 .fi     
       
  1147 .nf     
       
  1148 \f3\fP
       
  1149 .fi     
       
  1150 .sp     
       
  1151 
       
  1152 
       
  1153 Case does not matter for the keyword abbreviations\&. For example, CN, cn, and Cn are all treated the same\&.
       
  1154 
       
  1155 Order matters; each subcomponent must appear in the designated order\&. However, it is not necessary to have all the subcomponents\&. You can use a subset, for example:
       
  1156 .sp     
       
  1157 .nf     
       
  1158 \f3CN=Steve Meier, OU=Java, O=Oracle, C=US\fP
       
  1159 .fi     
       
  1160 .nf     
       
  1161 \f3\fP
       
  1162 .fi     
       
  1163 .sp     
       
  1164 
       
  1165 
       
  1166 If a distinguished name string value contains a comma, then the comma must be escaped by a backslash (\e) character when you specify the string on a command line, as in:
       
  1167 .sp     
       
  1168 .nf     
       
  1169 \f3cn=Peter Schuster, ou=Java\e, Product Development, o=Oracle, c=US\fP
       
  1170 .fi     
       
  1171 .nf     
       
  1172 \f3\fP
       
  1173 .fi     
       
  1174 .sp     
       
  1175 
       
  1176 
       
  1177 It is never necessary to specify a distinguished name string on a command line\&. When the distinguished name is needed for a command, but not supplied on the command line, the user is prompted for each of the subcomponents\&. In this case, a comma does not need to be escaped by a backslash (\e)\&.
       
  1178 .SH WARNINGS    
       
  1179 .SS IMPORTING\ TRUSTED\ CERTIFICATES\ WARNING    
       
  1180 \fIImportant\fR: Be sure to check a certificate very carefully before importing it as a trusted certificate\&.
       
  1181 .PP
       
  1182 Windows Example:
       
  1183 
       
  1184 View the certificate first with the \f3-printcert\fR command or the \f3-importcert\fR command without the \f3-noprompt\fR option\&. Ensure that the displayed certificate fingerprints match the expected ones\&. For example, suppose sends or emails you a certificate that you put it in a file named \f3\etmp\ecert\fR\&. Before you consider adding the certificate to your list of trusted certificates, you can execute a \f3-printcert\fR command to view its fingerprints, as follows:
       
  1185 .sp     
       
  1186 .nf     
       
  1187 \f3  keytool \-printcert \-file \etmp\ecert\fP
       
  1188 .fi     
       
  1189 .nf     
       
  1190 \f3    Owner: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP
       
  1191 .fi     
       
  1192 .nf     
       
  1193 \f3    Issuer: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP
       
  1194 .fi     
       
  1195 .nf     
       
  1196 \f3    Serial Number: 59092b34\fP
       
  1197 .fi     
       
  1198 .nf     
       
  1199 \f3    Valid from: Thu Sep 25 18:01:13 PDT 1997 until: Wed Dec 24 17:01:13 PST 1997\fP
       
  1200 .fi     
       
  1201 .nf     
       
  1202 \f3    Certificate Fingerprints:\fP
       
  1203 .fi     
       
  1204 .nf     
       
  1205 \f3         MD5:  11:81:AD:92:C8:E5:0E:A2:01:2E:D4:7A:D7:5F:07:6F\fP
       
  1206 .fi     
       
  1207 .nf     
       
  1208 \f3         SHA1: 20:B6:17:FA:EF:E5:55:8A:D0:71:1F:E8:D6:9D:C0:37:13:0E:5E:FE\fP
       
  1209 .fi     
       
  1210 .nf     
       
  1211 \f3         SHA256: 90:7B:70:0A:EA:DC:16:79:92:99:41:FF:8A:FE:EB:90:\fP
       
  1212 .fi     
       
  1213 .nf     
       
  1214 \f3                 17:75:E0:90:B2:24:4D:3A:2A:16:A6:E4:11:0F:67:A4\fP
       
  1215 .fi     
       
  1216 .sp     
       
  1217 
       
  1218 .PP
       
  1219 Oracle Solaris Example:
       
  1220 
       
  1221 View the certificate first with the \f3-printcert\fR command or the \f3-importcert\fR command without the \f3-noprompt\fR option\&. Ensure that the displayed certificate fingerprints match the expected ones\&. For example, suppose someone sends or emails you a certificate that you put it in a file named \f3/tmp/cert\fR\&. Before you consider adding the certificate to your list of trusted certificates, you can execute a \f3-printcert\fR command to view its fingerprints, as follows:
       
  1222 .sp     
       
  1223 .nf     
       
  1224 \f3  keytool \-printcert \-file /tmp/cert\fP
       
  1225 .fi     
       
  1226 .nf     
       
  1227 \f3    Owner: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP
       
  1228 .fi     
       
  1229 .nf     
       
  1230 \f3    Issuer: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP
       
  1231 .fi     
       
  1232 .nf     
       
  1233 \f3    Serial Number: 59092b34\fP
       
  1234 .fi     
       
  1235 .nf     
       
  1236 \f3    Valid from: Thu Sep 25 18:01:13 PDT 1997 until: Wed Dec 24 17:01:13 PST 1997\fP
       
  1237 .fi     
       
  1238 .nf     
       
  1239 \f3    Certificate Fingerprints:\fP
       
  1240 .fi     
       
  1241 .nf     
       
  1242 \f3         MD5:  11:81:AD:92:C8:E5:0E:A2:01:2E:D4:7A:D7:5F:07:6F\fP
       
  1243 .fi     
       
  1244 .nf     
       
  1245 \f3         SHA1: 20:B6:17:FA:EF:E5:55:8A:D0:71:1F:E8:D6:9D:C0:37:13:0E:5E:FE\fP
       
  1246 .fi     
       
  1247 .nf     
       
  1248 \f3         SHA256: 90:7B:70:0A:EA:DC:16:79:92:99:41:FF:8A:FE:EB:90:\fP
       
  1249 .fi     
       
  1250 .nf     
       
  1251 \f3                 17:75:E0:90:B2:24:4D:3A:2A:16:A6:E4:11:0F:67:A4\fP
       
  1252 .fi     
       
  1253 .nf     
       
  1254 \f3\fP
       
  1255 .fi     
       
  1256 .sp     
       
  1257 Then call or otherwise contact the person who sent the certificate and compare the fingerprints that you see with the ones that they show\&. Only when the fingerprints are equal is it guaranteed that the certificate was not replaced in transit with somebody else\&'s certificate such as an attacker\&'s certificate\&. If such an attack took place, and you did not check the certificate before you imported it, then you would be trusting anything the attacker signed, for example, a JAR file with malicious class files inside\&.
       
  1258 .PP
       
  1259 \fINote:\fR It is not required that you execute a \f3-printcert\fR command before importing a certificate\&. This is because before you add a certificate to the list of trusted certificates in the keystore, the \f3-importcert\fR command prints out the certificate information and prompts you to verify it\&. You can then stop the import operation\&. However, you can do this only when you call the \f3-importcert\fR command without the \f3-noprompt\fR option\&. If the \f3-noprompt\fR option is specified, then there is no interaction with the user\&.
       
  1260 .SS PASSWORDS\ WARNING    
       
  1261 Most commands that operate on a keystore require the store password\&. Some commands require a private/secret key password\&. Passwords can be specified on the command line in the \f3-storepass\fR and \f3-keypass\fR options\&. However, a password should not be specified on a command line or in a script unless it is for testing, or you are on a secure system\&. When you do not specify a required password option on a command line, you are prompted for it\&.
       
  1262 .SS CERTIFICATE\ CONFORMANCE\ WARNING    
       
  1263 The Internet standard RFC 5280 has defined a profile on conforming X\&.509 certificates, which includes what values and value combinations are valid for certificate fields and extensions\&. See the standard at http://tools\&.ietf\&.org/rfc/rfc5280\&.txt
       
  1264 .PP
       
  1265 The \f3keytool\fR command does not enforce all of these rules so it can generate certificates that do not conform to the standard\&. Certificates that do not conform to the standard might be rejected by JRE or other applications\&. Users should ensure that they provide the correct options for \f3-dname\fR, \f3-ext\fR, and so on\&.
       
  1266 .SH NOTES    
       
  1267 .SS IMPORT\ A\ NEW\ TRUSTED\ CERTIFICATE    
       
  1268 Before you add the certificate to the keystore, the \f3keytool\fR command verifies 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\&.
       
  1269 .PP
       
  1270 If the \f3-trustcacerts\fR option was specified, then additional certificates are considered for the chain of trust, namely the certificates in a file named \f3cacerts\fR\&.
       
  1271 .PP
       
  1272 If the \f3keytool\fR command fails to establish a trust path from the certificate to be imported up to a self-signed certificate (either from the keystore or the \f3cacerts\fR file), then the certificate information is printed, and the user is prompted to verify it by comparing the displayed certificate fingerprints with the fingerprints obtained from some other (trusted) source of information, which might be the certificate owner\&. Be very careful to ensure the certificate is valid before importing it as a trusted certificate\&. See Importing Trusted Certificates Warning\&. The user then has the option of stopping the import operation\&. If the \f3-noprompt\fR option is specified, then there is no interaction with the user\&.
       
  1273 .SS IMPORT\ A\ CERTIFICATE\ REPLY    
       
  1274 When you import a certificate reply, the certificate reply is validated with trusted certificates from the keystore, and optionally, the certificates configured in the \f3cacerts\fR keystore file when the \f3-trustcacert\fR\f3s\fR option is specified\&. See The cacerts Certificates File\&.
       
  1275 .PP
       
  1276 The methods of determining whether the certificate reply is trusted are as follows:
       
  1277 .TP 0.2i    
       
  1278 \(bu
       
  1279 If the reply is a single X\&.509 certificate, then the \f3keytool\fR command 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 is used to authenticate the certificate reply from the new certificate chain of aliases\&. If a trust chain cannot be established, then the certificate reply is not imported\&. In this case, the \f3keytool\fR command does not print the certificate and prompt the user to verify it, because it is very difficult for a user to determine the authenticity of the certificate reply\&.
       
  1280 .TP 0.2i    
       
  1281 \(bu
       
  1282 If the reply is a PKCS #7 formatted certificate chain or a sequence of X\&.509 certificates, then 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 the\f3-trustcacerts\fR option was specified, the \f3keytool\fR command attempts to match it with any of the trusted certificates in the keystore or the \f3cacerts\fR keystore file\&. If the chain does not end with a self-signed root CA certificate and the \f3-trustcacerts\fR option was specified, the \f3keytool\fR command tries to find one from the trusted certificates in the keystore or the \f3cacerts\fR keystore file and add it to the end of the chain\&. If the certificate is not found and the \f3-noprompt\fR option is not specified, the information of the last certificate in the chain is printed, and the user is prompted to verify it\&.
       
  1283 .PP
       
  1284 If the public key in the certificate reply matches the user\&'s public key already stored with \f3alias\fR, then the old certificate chain is replaced with the new certificate chain in the reply\&. The old chain can only be replaced with a valid \f3keypass\fR, and so 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\&.
       
  1285 .PP
       
  1286 This command was named \f3-import\fR in earlier releases\&. This old name is still supported in this release\&. The new name, \f3-importcert\fR, is preferred going forward\&.
       
  1287 .SH SEE\ ALSO    
       
  1288 .TP 0.2i    
       
  1289 \(bu
       
  1290 jar(1)
       
  1291 .TP 0.2i    
       
  1292 \(bu
       
  1293 jarsigner(1)
       
  1294 .TP 0.2i    
       
  1295 \(bu
       
  1296 Trail: Security Features in Java SE at http://docs\&.oracle\&.com/javase/tutorial/security/index\&.html
   118 .RE
  1297 .RE
   119 
  1298 .br
   120 .LP
  1299 'pl 8.5i
   121 .SS 
  1300 'bp
   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 .TS
       
   282 .if \n+(b.=1 .nr d. \n(.c-\n(c.-1
       
   283 .de 35
       
   284 .ps \n(.s
       
   285 .vs \n(.vu
       
   286 .in \n(.iu
       
   287 .if \n(.u .fi
       
   288 .if \n(.j .ad
       
   289 .if \n(.j=0 .na
       
   290 ..
       
   291 .nf
       
   292 .nr #~ 0
       
   293 .if n .nr #~ 0.6n
       
   294 .ds #d .d
       
   295 .if \(ts\n(.z\(ts\(ts .ds #d nl
       
   296 .fc
       
   297 .nr 33 \n(.s
       
   298 .rm 80 81
       
   299 .nr 34 \n(.lu
       
   300 .eo
       
   301 .am 81
       
   302 .br
       
   303 .di a+
       
   304 .35
       
   305 .ft \n(.f
       
   306 .ll \n(34u*1u/3u
       
   307 .if \n(.l<\n(81 .ll \n(81u
       
   308 .in 0
       
   309 The full form: "ca:{true|false}[,pathlen:<len>]"; or, <len>, a shorthand for "ca:true,pathlen:<len>"; or omitted, means "ca:true"
       
   310 .br
       
   311 .di
       
   312 .nr a| \n(dn
       
   313 .nr a- \n(dl
       
   314 ..
       
   315 .ec \
       
   316 .eo
       
   317 .am 81
       
   318 .br
       
   319 .di b+
       
   320 .35
       
   321 .ft \n(.f
       
   322 .ll \n(34u*1u/3u
       
   323 .if \n(.l<\n(81 .ll \n(81u
       
   324 .in 0
       
   325 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.
       
   326 .br
       
   327 .di
       
   328 .nr b| \n(dn
       
   329 .nr b- \n(dl
       
   330 ..
       
   331 .ec \
       
   332 .eo
       
   333 .am 81
       
   334 .br
       
   335 .di c+
       
   336 .35
       
   337 .ft \n(.f
       
   338 .ll \n(34u*1u/3u
       
   339 .if \n(.l<\n(81 .ll \n(81u
       
   340 .in 0
       
   341 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.
       
   342 .br
       
   343 .di
       
   344 .nr c| \n(dn
       
   345 .nr c- \n(dl
       
   346 ..
       
   347 .ec \
       
   348 .eo
       
   349 .am 80
       
   350 .br
       
   351 .di d+
       
   352 .35
       
   353 .ft \n(.f
       
   354 .ll \n(34u*1u/3u
       
   355 .if \n(.l<\n(80 .ll \n(80u
       
   356 .in 0
       
   357 SAN or SubjectAlternativeName
       
   358 .br
       
   359 .di
       
   360 .nr d| \n(dn
       
   361 .nr d- \n(dl
       
   362 ..
       
   363 .ec \
       
   364 .eo
       
   365 .am 81
       
   366 .br
       
   367 .di e+
       
   368 .35
       
   369 .ft \n(.f
       
   370 .ll \n(34u*1u/3u
       
   371 .if \n(.l<\n(81 .ll \n(81u
       
   372 .in 0
       
   373 type:value(,type:value)*, type can be EMAIL, URI, DNS, IP, or OID, value is the string format value for the type.
       
   374 .br
       
   375 .di
       
   376 .nr e| \n(dn
       
   377 .nr e- \n(dl
       
   378 ..
       
   379 .ec \
       
   380 .eo
       
   381 .am 80
       
   382 .br
       
   383 .di f+
       
   384 .35
       
   385 .ft \n(.f
       
   386 .ll \n(34u*1u/3u
       
   387 .if \n(.l<\n(80 .ll \n(80u
       
   388 .in 0
       
   389 IAN or IssuerAlternativeName
       
   390 .br
       
   391 .di
       
   392 .nr f| \n(dn
       
   393 .nr f- \n(dl
       
   394 ..
       
   395 .ec \
       
   396 .eo
       
   397 .am 81
       
   398 .br
       
   399 .di g+
       
   400 .35
       
   401 .ft \n(.f
       
   402 .ll \n(34u*1u/3u
       
   403 .if \n(.l<\n(81 .ll \n(81u
       
   404 .in 0
       
   405 same as SubjectAlternativeName
       
   406 .br
       
   407 .di
       
   408 .nr g| \n(dn
       
   409 .nr g- \n(dl
       
   410 ..
       
   411 .ec \
       
   412 .eo
       
   413 .am 81
       
   414 .br
       
   415 .di h+
       
   416 .35
       
   417 .ft \n(.f
       
   418 .ll \n(34u*1u/3u
       
   419 .if \n(.l<\n(81 .ll \n(81u
       
   420 .in 0
       
   421 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.
       
   422 .br
       
   423 .di
       
   424 .nr h| \n(dn
       
   425 .nr h- \n(dl
       
   426 ..
       
   427 .ec \
       
   428 .eo
       
   429 .am 80
       
   430 .br
       
   431 .di i+
       
   432 .35
       
   433 .ft \n(.f
       
   434 .ll \n(34u*1u/3u
       
   435 .if \n(.l<\n(80 .ll \n(80u
       
   436 .in 0
       
   437 AIA or AuthorityInfoAccess
       
   438 .br
       
   439 .di
       
   440 .nr i| \n(dn
       
   441 .nr i- \n(dl
       
   442 ..
       
   443 .ec \
       
   444 .eo
       
   445 .am 81
       
   446 .br
       
   447 .di j+
       
   448 .35
       
   449 .ft \n(.f
       
   450 .ll \n(34u*1u/3u
       
   451 .if \n(.l<\n(81 .ll \n(81u
       
   452 .in 0
       
   453 same as SubjectInfoAccess. method can be "ocsp","caIssuers" or any OID.
       
   454 .br
       
   455 .di
       
   456 .nr j| \n(dn
       
   457 .nr j- \n(dl
       
   458 ..
       
   459 .ec \
       
   460 .35
       
   461 .nf
       
   462 .ll \n(34u
       
   463 .nr 80 0
       
   464 .nr 38 \w\f3Name\fP
       
   465 .if \n(80<\n(38 .nr 80 \n(38
       
   466 .nr 38 \wBC or BasicConstraints
       
   467 .if \n(80<\n(38 .nr 80 \n(38
       
   468 .nr 38 \wKU or KeyUsage
       
   469 .if \n(80<\n(38 .nr 80 \n(38
       
   470 .nr 38 \wEKU or ExtendedkeyUsage
       
   471 .if \n(80<\n(38 .nr 80 \n(38
       
   472 .nr 38 \wSIA or SubjectInfoAccess
       
   473 .if \n(80<\n(38 .nr 80 \n(38
       
   474 .80
       
   475 .rm 80
       
   476 .nr 38 \n(d-
       
   477 .if \n(80<\n(38 .nr 80 \n(38
       
   478 .nr 38 \n(f-
       
   479 .if \n(80<\n(38 .nr 80 \n(38
       
   480 .nr 38 \n(i-
       
   481 .if \n(80<\n(38 .nr 80 \n(38
       
   482 .nr 81 0
       
   483 .nr 38 \w\f3Value\fP
       
   484 .if \n(81<\n(38 .nr 81 \n(38
       
   485 .81
       
   486 .rm 81
       
   487 .nr 38 \n(a-
       
   488 .if \n(81<\n(38 .nr 81 \n(38
       
   489 .nr 38 \n(b-
       
   490 .if \n(81<\n(38 .nr 81 \n(38
       
   491 .nr 38 \n(c-
       
   492 .if \n(81<\n(38 .nr 81 \n(38
       
   493 .nr 38 \n(e-
       
   494 .if \n(81<\n(38 .nr 81 \n(38
       
   495 .nr 38 \n(g-
       
   496 .if \n(81<\n(38 .nr 81 \n(38
       
   497 .nr 38 \n(h-
       
   498 .if \n(81<\n(38 .nr 81 \n(38
       
   499 .nr 38 \n(j-
       
   500 .if \n(81<\n(38 .nr 81 \n(38
       
   501 .35
       
   502 .nf
       
   503 .ll \n(34u
       
   504 .nr 38 1n
       
   505 .nr 79 0
       
   506 .nr 40 \n(79+(0*\n(38)
       
   507 .nr 80 +\n(40
       
   508 .nr 41 \n(80+(3*\n(38)
       
   509 .nr 81 +\n(41
       
   510 .nr TW \n(81
       
   511 .if t .if \n(TW>\n(.li .tm Table at line 319 file Input is too wide - \n(TW units
       
   512 .fc  
       
   513 .nr #T 0-1
       
   514 .nr #a 0-1
       
   515 .eo
       
   516 .de T#
       
   517 .ds #d .d
       
   518 .if \(ts\n(.z\(ts\(ts .ds #d nl
       
   519 .mk ##
       
   520 .nr ## -1v
       
   521 .ls 1
       
   522 .ls
       
   523 ..
       
   524 .ec
       
   525 .ta \n(80u \n(81u 
       
   526 .nr 31 \n(.f
       
   527 .nr 35 1m
       
   528 \&\h'|\n(40u'\f3Name\fP\h'|\n(41u'\f3Value\fP
       
   529 .ne \n(a|u+\n(.Vu
       
   530 .if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v)
       
   531 .ta \n(80u \n(81u 
       
   532 .nr 31 \n(.f
       
   533 .nr 35 1m
       
   534 \&\h'|\n(40u'BC or BasicConstraints\h'|\n(41u'
       
   535 .mk ##
       
   536 .nr 31 \n(##
       
   537 .sp |\n(##u-1v
       
   538 .nr 37 \n(41u
       
   539 .in +\n(37u
       
   540 .a+
       
   541 .in -\n(37u
       
   542 .mk 32
       
   543 .if \n(32>\n(31 .nr 31 \n(32
       
   544 .sp |\n(31u
       
   545 .ne \n(b|u+\n(.Vu
       
   546 .if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v)
       
   547 .ta \n(80u \n(81u 
       
   548 .nr 31 \n(.f
       
   549 .nr 35 1m
       
   550 \&\h'|\n(40u'KU or KeyUsage\h'|\n(41u'
       
   551 .mk ##
       
   552 .nr 31 \n(##
       
   553 .sp |\n(##u-1v
       
   554 .nr 37 \n(41u
       
   555 .in +\n(37u
       
   556 .b+
       
   557 .in -\n(37u
       
   558 .mk 32
       
   559 .if \n(32>\n(31 .nr 31 \n(32
       
   560 .sp |\n(31u
       
   561 .ne \n(c|u+\n(.Vu
       
   562 .if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v)
       
   563 .ta \n(80u \n(81u 
       
   564 .nr 31 \n(.f
       
   565 .nr 35 1m
       
   566 \&\h'|\n(40u'EKU or ExtendedkeyUsage\h'|\n(41u'
       
   567 .mk ##
       
   568 .nr 31 \n(##
       
   569 .sp |\n(##u-1v
       
   570 .nr 37 \n(41u
       
   571 .in +\n(37u
       
   572 .c+
       
   573 .in -\n(37u
       
   574 .mk 32
       
   575 .if \n(32>\n(31 .nr 31 \n(32
       
   576 .sp |\n(31u
       
   577 .ne \n(d|u+\n(.Vu
       
   578 .ne \n(e|u+\n(.Vu
       
   579 .if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v)
       
   580 .if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v)
       
   581 .ta \n(80u \n(81u 
       
   582 .nr 31 \n(.f
       
   583 .nr 35 1m
       
   584 \&\h'|\n(40u'\h'|\n(41u'
       
   585 .mk ##
       
   586 .nr 31 \n(##
       
   587 .sp |\n(##u-1v
       
   588 .nr 37 \n(40u
       
   589 .in +\n(37u
       
   590 .d+
       
   591 .in -\n(37u
       
   592 .mk 32
       
   593 .if \n(32>\n(31 .nr 31 \n(32
       
   594 .sp |\n(##u-1v
       
   595 .nr 37 \n(41u
       
   596 .in +\n(37u
       
   597 .e+
       
   598 .in -\n(37u
       
   599 .mk 32
       
   600 .if \n(32>\n(31 .nr 31 \n(32
       
   601 .sp |\n(31u
       
   602 .ne \n(f|u+\n(.Vu
       
   603 .ne \n(g|u+\n(.Vu
       
   604 .if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v)
       
   605 .if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v)
       
   606 .ta \n(80u \n(81u 
       
   607 .nr 31 \n(.f
       
   608 .nr 35 1m
       
   609 \&\h'|\n(40u'\h'|\n(41u'
       
   610 .mk ##
       
   611 .nr 31 \n(##
       
   612 .sp |\n(##u-1v
       
   613 .nr 37 \n(40u
       
   614 .in +\n(37u
       
   615 .f+
       
   616 .in -\n(37u
       
   617 .mk 32
       
   618 .if \n(32>\n(31 .nr 31 \n(32
       
   619 .sp |\n(##u-1v
       
   620 .nr 37 \n(41u
       
   621 .in +\n(37u
       
   622 .g+
       
   623 .in -\n(37u
       
   624 .mk 32
       
   625 .if \n(32>\n(31 .nr 31 \n(32
       
   626 .sp |\n(31u
       
   627 .ne \n(h|u+\n(.Vu
       
   628 .if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v)
       
   629 .ta \n(80u \n(81u 
       
   630 .nr 31 \n(.f
       
   631 .nr 35 1m
       
   632 \&\h'|\n(40u'SIA or SubjectInfoAccess\h'|\n(41u'
       
   633 .mk ##
       
   634 .nr 31 \n(##
       
   635 .sp |\n(##u-1v
       
   636 .nr 37 \n(41u
       
   637 .in +\n(37u
       
   638 .h+
       
   639 .in -\n(37u
       
   640 .mk 32
       
   641 .if \n(32>\n(31 .nr 31 \n(32
       
   642 .sp |\n(31u
       
   643 .ne \n(i|u+\n(.Vu
       
   644 .ne \n(j|u+\n(.Vu
       
   645 .if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v)
       
   646 .if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v)
       
   647 .ta \n(80u \n(81u 
       
   648 .nr 31 \n(.f
       
   649 .nr 35 1m
       
   650 \&\h'|\n(40u'\h'|\n(41u'
       
   651 .mk ##
       
   652 .nr 31 \n(##
       
   653 .sp |\n(##u-1v
       
   654 .nr 37 \n(40u
       
   655 .in +\n(37u
       
   656 .i+
       
   657 .in -\n(37u
       
   658 .mk 32
       
   659 .if \n(32>\n(31 .nr 31 \n(32
       
   660 .sp |\n(##u-1v
       
   661 .nr 37 \n(41u
       
   662 .in +\n(37u
       
   663 .j+
       
   664 .in -\n(37u
       
   665 .mk 32
       
   666 .if \n(32>\n(31 .nr 31 \n(32
       
   667 .sp |\n(31u
       
   668 .fc
       
   669 .nr T. 1
       
   670 .T# 1
       
   671 .35
       
   672 .rm a+
       
   673 .rm b+
       
   674 .rm c+
       
   675 .rm d+
       
   676 .rm e+
       
   677 .rm f+
       
   678 .rm g+
       
   679 .rm h+
       
   680 .rm i+
       
   681 .rm j+
       
   682 .TE
       
   683 .if \n-(b.=0 .nr c. \n(.c-\n(d.-38
       
   684 
       
   685 .LP
       
   686 .LP
       
   687 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.
       
   688 .LP
       
   689 .LP
       
   690 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.
       
   691 .LP
       
   692 .LP
       
   693 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.
       
   694 .LP
       
   695 .LP
       
   696 The subjectKeyIdentifier extension is always created. For non self\-signed certificates, the authorityKeyIdentifier is always created.
       
   697 .LP
       
   698 .LP
       
   699 \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.
       
   700 .LP
       
   701 .SH "COMMANDS"
       
   702 .LP
       
   703 .SS 
       
   704 Creating or Adding Data to the Keystore
       
   705 .LP
       
   706 .RS 3
       
   707 .TP 3
       
   708 \-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} 
       
   709 .LP
       
   710 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. 
       
   711 .LP
       
   712 \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. 
       
   713 .LP
       
   714 If \f2dname\fP is provided, it's used as the subject of the generated certificate. Otherwise, the one from the certificate request is used. 
       
   715 .LP
       
   716 \f2ext\fP shows what X.509 extensions will be embedded in the certificate. Read Common Options for the grammar of \f2\-ext\fP. 
       
   717 .LP
       
   718 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. 
       
   719 .LP
       
   720 The following commands creates four key pairs named \f2ca\fP, \f2ca1\fP, \f2ca2\fP, and \f2e1\fP: 
       
   721 .nf
       
   722 \f3
       
   723 .fl
       
   724 keytool \-alias ca \-dname CN=CA \-genkeypair
       
   725 .fl
       
   726 keytool \-alias ca1 \-dname CN=CA \-genkeypair
       
   727 .fl
       
   728 keytool \-alias ca2 \-dname CN=CA \-genkeypair
       
   729 .fl
       
   730 keytool \-alias e1 \-dname CN=E1 \-genkeypair
       
   731 .fl
       
   732 \fP
       
   733 .fi
       
   734 .LP
       
   735 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: 
       
   736 .nf
       
   737 \f3
       
   738 .fl
       
   739 keytool \-alias ca1 \-certreq | keytool \-alias ca \-gencert \-ext san=dns:ca1 | keytool \-alias ca1 \-importcert
       
   740 .fl
       
   741 keytool \-alias ca2 \-certreq | $KT \-alias ca1 \-gencert \-ext san=dns:ca2 | $KT \-alias ca2 \-importcert
       
   742 .fl
       
   743 \fP
       
   744 .fi
       
   745 .LP
       
   746 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: 
       
   747 .nf
       
   748 \f3
       
   749 .fl
       
   750 keytool \-alias e1 \-certreq | keytool \-alias ca2 \-gencert > e1.cert
       
   751 .fl
       
   752 \fP
       
   753 .fi
       
   754 .TP 3
       
   755 \-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} 
       
   756 .LP
       
   757 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. 
       
   758 .LP
       
   759 \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. 
       
   760 .LP
       
   761 \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. 
       
   762 .LP
       
   763 \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. 
       
   764 .LP
       
   765 \f2startdate\fP specifies the issue time of the certificate, also known as the "Not Before" value of the X.509 certificate's Validity field. 
       
   766 .LP
       
   767 The option value can be set in one of these two forms: 
       
   768 .RS 3
       
   769 .TP 3
       
   770 1.
       
   771 ([+\-]\f2nnn\fP[ymdHMS])+ 
       
   772 .TP 3
       
   773 2.
       
   774 [yyyy/mm/dd] [HH:MM:SS] 
       
   775 .RE
       
   776 .LP
       
   777 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: 
       
   778 .nf
       
   779 \f3
       
   780 .fl
       
   781    Calendar c = new GregorianCalendar();
       
   782 .fl
       
   783    c.add(Calendar.YEAR, \-1);
       
   784 .fl
       
   785    c.add(Calendar.MONTH, 1);
       
   786 .fl
       
   787    c.add(Calendar.DATE, \-1);
       
   788 .fl
       
   789    return c.getTime()
       
   790 .fl
       
   791 \fP
       
   792 .fi
       
   793 .LP
       
   794 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. 
       
   795 .LP
       
   796 When the option is not provided, the start date is the current time. The option can be provided at most once. 
       
   797 .LP
       
   798 \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. 
       
   799 .LP
       
   800 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.  
       
   801 .TP 3
       
   802 \-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} 
       
   803 .LP
       
   804 Generates a secret key and stores it in a new \f2KeyStore.SecretKeyEntry\fP identified by \f2alias\fP. 
       
   805 .LP
       
   806 \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.  
       
   807 .TP 3
       
   808 \-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} 
       
   809 .LP
       
   810 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. 
       
   811 .LP
       
   812 \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". 
       
   813 .LP
       
   814 You import a certificate for two reasons: 
       
   815 .RS 3
       
   816 .TP 3
       
   817 1.
       
   818 to add it to the list of trusted certificates, or 
       
   819 .TP 3
       
   820 2.
       
   821 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. 
       
   822 .RE
       
   823 .LP
       
   824 Which type of import is intended is indicated by the value of the \f2\-alias\fP option: 
       
   825 .RS 3
       
   826 .TP 3
       
   827 1.
       
   828 \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. 
       
   829 .TP 3
       
   830 2.
       
   831 \f3If the alias points to a key entry\fP, then \f3keytool\fP assumes you are importing a certificate reply. 
       
   832 .RE
       
   833 \f3Importing a New Trusted Certificate\fP 
       
   834 .LP
       
   835 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. 
       
   836 .LP
       
   837 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". 
       
   838 .LP
       
   839 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. 
       
   840 \f3Importing a Certificate Reply\fP 
       
   841 .LP
       
   842 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). 
       
   843 .LP
       
   844 The methods of determining whether the certificate reply is trusted are described in the following: 
       
   845 .RS 3
       
   846 .TP 2
       
   847 o
       
   848 \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. 
       
   849 .TP 2
       
   850 o
       
   851 \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. 
       
   852 .RE
       
   853 .LP
       
   854 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. 
       
   855 .LP
       
   856 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.    
       
   857 .TP 3
       
   858 \-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} 
       
   859 .LP
       
   860 Imports a single entry or all entries from a source keystore to a destination keystore. 
       
   861 .LP
       
   862 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. 
       
   863 .LP
       
   864 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. 
       
   865 .LP
       
   866 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. 
       
   867 .LP
       
   868 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.  
       
   869 .TP 3
       
   870 \-printcertreq {\-file file} 
       
   871 .LP
       
   872 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.  
       
   873 .RE
       
   874 
       
   875 .LP
       
   876 .SS 
       
   877 Exporting Data
       
   878 .LP
       
   879 .RS 3
       
   880 .TP 3
       
   881 \-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} 
       
   882 .LP
       
   883 Generates a Certificate Signing Request (CSR), using the PKCS#10 format. 
       
   884 .LP
       
   885 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. 
       
   886 .LP
       
   887 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. 
       
   888 .LP
       
   889 \f2sigalg\fP specifies the algorithm that should be used to sign the CSR. 
       
   890 .LP
       
   891 The CSR is stored in the file \f2certreq_file\fP. If no file is given, the CSR is output to stdout. 
       
   892 .LP
       
   893 Use the \f2importcert\fP command to import the response from the CA.  
       
   894 .TP 3
       
   895 \-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} 
       
   896 .LP
       
   897 Reads (from the keystore) the certificate associated with \f2alias\fP, and stores it in the file \f2cert_file\fP. 
       
   898 .LP
       
   899 If no file is given, the certificate is output to stdout. 
       
   900 .LP
       
   901 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. 
       
   902 .LP
       
   903 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. 
       
   904 .LP
       
   905 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.  
       
   906 .RE
       
   907 
       
   908 .LP
       
   909 .SS 
       
   910 Displaying Data
       
   911 .LP
       
   912 .RS 3
       
   913 .TP 3
       
   914 \-list {\-alias alias} {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v | \-rfc} {\-protected} {\-Jjavaoption} 
       
   915 .LP
       
   916 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. 
       
   917 .LP
       
   918 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 
       
   919 .LP
       
   920 You cannot specify both \f2\-v\fP and \f2\-rfc\fP.  
       
   921 .TP 3
       
   922 \-printcert {\-file cert_file | \-sslserver host[:port]} {\-jarfile JAR_file {\-rfc} {\-v} {\-Jjavaoption} 
       
   923 .LP
       
   924 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. 
       
   925 .LP
       
   926 If \f2\-rfc\fP is specified, keytool prints the certificate in PEM mode as defined by the Internet RFC 1421 standard. 
       
   927 .LP
       
   928 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 
       
   929 .LP
       
   930 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 
       
   931 .na
       
   932 \f2JSSE Reference Guide\fP @
       
   933 .fi
       
   934 http://download.oracle.com/javase/7/docs/technotes/guides/security/jsse/JSSERefGuide.html for more information. 
       
   935 .LP
       
   936 \f3Note\fP: This option can be used independently of a keystore.  
       
   937 .TP 3
       
   938 \-printcrl \-file crl_ {\-v} 
       
   939 .LP
       
   940 Reads the certificate revocation list (CRL) from the file \f2crl_file\fP. 
       
   941 .LP
       
   942 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. 
       
   943 .LP
       
   944 \f3Note\fP: This option can be used independently of a keystore.  
       
   945 .RE
       
   946 
       
   947 .LP
       
   948 .SS 
       
   949 Managing the Keystore
       
   950 .LP
       
   951 .RS 3
       
   952 .TP 3
       
   953 \-storepasswd [\-new new_storepass] {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-Jjavaoption} 
       
   954 .LP
       
   955 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.  
       
   956 .TP 3
       
   957 \-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} 
       
   958 .LP
       
   959 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. 
       
   960 .LP
       
   961 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. 
       
   962 .LP
       
   963 If the \f2\-new\fP option is not provided at the command line, the user is prompted for it.  
       
   964 .TP 3
       
   965 \-delete [\-alias alias] {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption} 
       
   966 .LP
       
   967 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.  
       
   968 .TP 3
       
   969 \-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} 
       
   970 .LP
       
   971 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.  
       
   972 .RE
       
   973 
       
   974 .LP
       
   975 .SS 
       
   976 Getting Help
       
   977 .LP
       
   978 .RS 3
       
   979 .TP 3
       
   980 \-help 
       
   981 .LP
       
   982 Lists the basic commands and their options. 
       
   983 .LP
       
   984 For more information about a specific command, enter the following, where \f2command_name\fP is the name of the command: 
       
   985 .nf
       
   986 \f3
       
   987 .fl
       
   988     keytool \-\fP\f4command_name\fP\f3 \-help
       
   989 .fl
       
   990 \fP
       
   991 .fi
       
   992 .RE
       
   993 
       
   994 .LP
       
   995 .SH "EXAMPLES"
       
   996 .LP
       
   997 .LP
       
   998 Suppose you want to create a keystore for managing your public/private key pair and certificates from entities you trust.
       
   999 .LP
       
  1000 .SS 
       
  1001 Generating Your Key Pair
       
  1002 .LP
       
  1003 .LP
       
  1004 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:
       
  1005 .LP
       
  1006 .nf
       
  1007 \f3
       
  1008 .fl
       
  1009     keytool \-genkeypair \-dname "cn=Mark Jones, ou=Java, o=Oracle, c=US"
       
  1010 .fl
       
  1011       \-alias business \-keypass \fP\f4<new password for private key>\fP\f3 \-keystore /working/mykeystore
       
  1012 .fl
       
  1013       \-storepass \fP\f4<new password for keystore>\fP\f3 \-validity 180
       
  1014 .fl
       
  1015 \fP
       
  1016 .fi
       
  1017 
       
  1018 .LP
       
  1019 .LP
       
  1020 (Please note: This must be typed as a single line. Multiple lines are used in the examples just for legibility purposes.)
       
  1021 .LP
       
  1022 .LP
       
  1023 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.
       
  1024 .LP
       
  1025 .LP
       
  1026 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.
       
  1027 .LP
       
  1028 .LP
       
  1029 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:
       
  1030 .LP
       
  1031 .nf
       
  1032 \f3
       
  1033 .fl
       
  1034     keytool \-genkeypair
       
  1035 .fl
       
  1036 \fP
       
  1037 .fi
       
  1038 
       
  1039 .LP
       
  1040 .LP
       
  1041 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.
       
  1042 .LP
       
  1043 .LP
       
  1044 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").
       
  1045 .LP
       
  1046 .SS 
       
  1047 Requesting a Signed Certificate from a Certification Authority
       
  1048 .LP
       
  1049 .LP
       
  1050 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:
       
  1051 .LP
       
  1052 .nf
       
  1053 \f3
       
  1054 .fl
       
  1055     keytool \-certreq \-file MarkJ.csr
       
  1056 .fl
       
  1057 \fP
       
  1058 .fi
       
  1059 
       
  1060 .LP
       
  1061 .LP
       
  1062 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.)
       
  1063 .LP
       
  1064 .SS 
       
  1065 Importing a Certificate for the CA
       
  1066 .LP
       
  1067 .LP
       
  1068 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.
       
  1069 .LP
       
  1070 .LP
       
  1071 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):
       
  1072 .LP
       
  1073 .RS 3
       
  1074 .TP 2
       
  1075 o
       
  1076 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). 
       
  1077 .TP 2
       
  1078 o
       
  1079 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. 
       
  1080 .RE
       
  1081 
       
  1082 .LP
       
  1083 .LP
       
  1084 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".
       
  1085 .LP
       
  1086 .LP
       
  1087 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.
       
  1088 .LP
       
  1089 .LP
       
  1090 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.
       
  1091 .LP
       
  1092 .LP
       
  1093 If you trust that the certificate is valid, then you can add it to your keystore via the following:
       
  1094 .LP
       
  1095 .nf
       
  1096 \f3
       
  1097 .fl
       
  1098     keytool \-importcert \-alias abc \-file ABCCA.cer
       
  1099 .fl
       
  1100 \fP
       
  1101 .fi
       
  1102 
       
  1103 .LP
       
  1104 .LP
       
  1105 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.
       
  1106 .LP
       
  1107 .SS 
       
  1108 Importing the Certificate Reply from the CA
       
  1109 .LP
       
  1110 .LP
       
  1111 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.
       
  1112 .LP
       
  1113 .LP
       
  1114 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":
       
  1115 .LP
       
  1116 .nf
       
  1117 \f3
       
  1118 .fl
       
  1119     keytool \-importcert \-trustcacerts \-file VSMarkJ.cer
       
  1120 .fl
       
  1121 \fP
       
  1122 .fi
       
  1123 
       
  1124 .LP
       
  1125 .SS 
       
  1126 Exporting a Certificate Authenticating Your Public Key
       
  1127 .LP
       
  1128 .LP
       
  1129 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.
       
  1130 .LP
       
  1131 .LP
       
  1132 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":
       
  1133 .LP
       
  1134 .nf
       
  1135 \f3
       
  1136 .fl
       
  1137     keytool \-exportcert \-alias mykey \-file MJ.cer
       
  1138 .fl
       
  1139 \fP
       
  1140 .fi
       
  1141 
       
  1142 .LP
       
  1143 .LP
       
  1144 Given that certificate, and the signed JAR file, a client can use the \f3jarsigner\fP tool to authenticate your signature.
       
  1145 .LP
       
  1146 .SS 
       
  1147 Importing Keystore
       
  1148 .LP
       
  1149 .LP
       
  1150 The command "importkeystore" is used to import an entire keystore into another keystore, which means all entries from the source keystore, including keys and certificates, are all imported to the destination keystore within a single command. You can use this command to import entries from a different type of keystore. During the import, all new entries in the destination keystore will have the same alias names and protection passwords (for secret keys and private keys). If \f3keytool\fP has difficulties recover the private keys or secret keys from the source keystore, it will prompt you for a password. If it detects alias duplication, it will ask you for a new one, you can specify a new alias or simply allow \f3keytool\fP to overwrite the existing one.
       
  1151 .LP
       
  1152 .LP
       
  1153 For example, to import entries from a normal JKS type keystore key.jks into a PKCS #11 type hardware based keystore, you can use the command:
       
  1154 .LP
       
  1155 .nf
       
  1156 \f3
       
  1157 .fl
       
  1158   keytool \-importkeystore
       
  1159 .fl
       
  1160     \-srckeystore key.jks \-destkeystore NONE
       
  1161 .fl
       
  1162     \-srcstoretype JKS \-deststoretype PKCS11
       
  1163 .fl
       
  1164     \-srcstorepass \fP\f4<source keystore password>\fP\f3 \-deststorepass \fP\f4<destination keystore password>\fP\f3
       
  1165 .fl
       
  1166 \fP
       
  1167 .fi
       
  1168 
       
  1169 .LP
       
  1170 .LP
       
  1171 The importkeystore command can also be used to import a single entry from a source keystore to a destination keystore. In this case, besides the options you see in the above example, you need to specify the alias you want to import. With the srcalias option given, you can also specify the destination alias name in the command line, as well as protection password for a secret/private key and the destination protection password you want. The following command demonstrates this:
       
  1172 .LP
       
  1173 .nf
       
  1174 \f3
       
  1175 .fl
       
  1176   keytool \-importkeystore
       
  1177 .fl
       
  1178     \-srckeystore key.jks \-destkeystore NONE
       
  1179 .fl
       
  1180     \-srcstoretype JKS \-deststoretype PKCS11
       
  1181 .fl
       
  1182     \-srcstorepass \fP\f4<source keystore password>\fP\f3 \-deststorepass \fP\f4<destination keystore password>\fP\f3
       
  1183 .fl
       
  1184     \-srcalias myprivatekey \-destalias myoldprivatekey
       
  1185 .fl
       
  1186     \-srckeypass \fP\f4<source entry password>\fP\f3 \-destkeypass \fP\f4<destination entry password>\fP\f3
       
  1187 .fl
       
  1188     \-noprompt
       
  1189 .fl
       
  1190 \fP
       
  1191 .fi
       
  1192 
       
  1193 .LP
       
  1194 .SS 
       
  1195 Generating Certificates for a Typical SSL Server
       
  1196 .LP
       
  1197 .LP
       
  1198 The following are keytool commands to generate keypairs and certificates for three entities, namely, Root CA (root), Intermediate CA (ca), and SSL server (server). Ensure that you store all the certificates in the same keystore. In these examples, it is recommended that you specify RSA as the key algorithm.
       
  1199 .LP
       
  1200 .nf
       
  1201 \f3
       
  1202 .fl
       
  1203 keytool \-genkeypair \-keystore root.jks \-alias root \-ext bc:c
       
  1204 .fl
       
  1205 keytool \-genkeypair \-keystore ca.jks \-alias ca \-ext bc:c
       
  1206 .fl
       
  1207 keytool \-genkeypair \-keystore server.jks \-alias server
       
  1208 .fl
       
  1209 
       
  1210 .fl
       
  1211 keytool \-keystore root.jks \-alias root \-exportcert \-rfc > root.pem
       
  1212 .fl
       
  1213 
       
  1214 .fl
       
  1215 keytool \-storepass \fP\f4<storepass>\fP\f3 \-keystore ca.jks \-certreq \-alias ca | keytool \-storepass \fP\f4<storepass>\fP\f3 \-keystore root.jks \-gencert \-alias root \-ext BC=0 \-rfc > ca.pem
       
  1216 .fl
       
  1217 keytool \-keystore ca.jks \-importcert \-alias ca \-file ca.pem
       
  1218 .fl
       
  1219 
       
  1220 .fl
       
  1221 keytool \-storepass \fP\f4<storepass>\fP\f3 \-keystore server.jks \-certreq \-alias server | keytool \-storepass \fP\f4<storepass>\fP\f3 \-keystore ca.jks \-gencert \-alias ca \-ext ku:c=dig,kE \-rfc > server.pem
       
  1222 .fl
       
  1223 cat root.pem ca.pem server.pem | keytool \-keystore server.jks \-importcert \-alias server
       
  1224 .fl
       
  1225 \fP
       
  1226 .fi
       
  1227 
       
  1228 .LP
       
  1229 .SH "TERMINOLOGY and WARNINGS"
       
  1230 .LP
       
  1231 .SS 
       
  1232 KeyStore
       
  1233 .LP
       
  1234 .LP
       
  1235 A keystore is a storage facility for cryptographic keys and certificates.
       
  1236 .LP
       
  1237 .RS 3
       
  1238 .TP 2
       
  1239 o
       
  1240 \f3KeyStore Entries\fP 
       
  1241 .LP
       
  1242 Keystores may have different types of entries. The two most applicable entry types for \f3keytool\fP include: 
       
  1243 .RS 3
       
  1244 .TP 3
       
  1245 1.
       
  1246 \f3key entries\fP \- each holds very sensitive cryptographic key information, which is stored in a protected format to prevent unauthorized access. Typically, a key stored in this type of entry is a secret key, or a private key accompanied by the certificate "chain" for the corresponding public key. The \f3keytool\fP can handle both types of entries, while the \f3jarsigner\fP tool only handle the latter type of entry, that is private keys and their associated certificate chains. 
       
  1247 .TP 3
       
  1248 2.
       
  1249 \f3trusted certificate entries\fP \- each contains a single public key certificate belonging to another party. It is called a "trusted certificate" because the keystore owner trusts that the public key in the certificate indeed belongs to the identity identified by the "subject" (owner) of the certificate. The issuer of the certificate vouches for this, by signing the certificate. 
       
  1250 .RE
       
  1251 .TP 2
       
  1252 o
       
  1253 \f3KeyStore Aliases\fP 
       
  1254 .LP
       
  1255 All keystore entries (key and trusted certificate entries) are accessed via unique \f2aliases\fP. 
       
  1256 .LP
       
  1257 An alias is specified when you add an entity to the keystore using the \-genseckey command to generate a secret key, \-genkeypair command to generate a key pair (public and private key) or the \-importcert command to add a certificate or certificate chain to the list of trusted certificates. Subsequent \f3keytool\fP commands must use this same alias to refer to the entity. 
       
  1258 .LP
       
  1259 For example, suppose you use the alias \f2duke\fP to generate a new public/private key pair and wrap the public key into a self\-signed certificate (see Certificate Chains) via the following command: 
       
  1260 .nf
       
  1261 \f3
       
  1262 .fl
       
  1263     keytool \-genkeypair \-alias duke \-keypass dukekeypasswd
       
  1264 .fl
       
  1265 \fP
       
  1266 .fi
       
  1267 .LP
       
  1268 This specifies an initial password of "dukekeypasswd" required by subsequent commands to access the private key associated with the alias \f2duke\fP. If you later want to change duke's private key password, you use a command like the following: 
       
  1269 .nf
       
  1270 \f3
       
  1271 .fl
       
  1272     keytool \-keypasswd \-alias duke \-keypass dukekeypasswd \-new newpass
       
  1273 .fl
       
  1274 \fP
       
  1275 .fi
       
  1276 .LP
       
  1277 This changes the password from "dukekeypasswd" to "newpass". 
       
  1278 .LP
       
  1279 Please note: A password should not actually be specified on a command line or in a script unless it is for testing purposes, or you are on a secure system. If you don't specify a required password option on a command line, you will be prompted for it.   
       
  1280 .TP 2
       
  1281 o
       
  1282 \f3KeyStore Implementation\fP 
       
  1283 .LP
       
  1284 The \f2KeyStore\fP class provided in the \f2java.security\fP package supplies well\-defined interfaces to access and modify the information in a keystore. It is possible for there to be multiple different concrete implementations, where each implementation is that for a particular \f2type\fP of keystore. 
       
  1285 .LP
       
  1286 Currently, two command\-line tools (\f3keytool\fP and \f3jarsigner\fP) and a GUI\-based tool named \f3Policy Tool\fP make use of keystore implementations. Since \f2KeyStore\fP is publicly available, users can write additional security applications that use it. 
       
  1287 .LP
       
  1288 There is a built\-in default implementation, provided by Oracle. It implements the keystore as a file, utilizing a proprietary keystore type (format) named "JKS". It protects each private key with its individual password, and also protects the integrity of the entire keystore with a (possibly different) password. 
       
  1289 .LP
       
  1290 Keystore implementations are provider\-based. More specifically, the application interfaces supplied by \f2KeyStore\fP are implemented in terms of a "Service Provider Interface" (SPI). That is, there is a corresponding abstract \f2KeystoreSpi\fP class, also in the \f2java.security\fP package, which defines the Service Provider Interface methods that "providers" must implement. (The term "provider" refers to a package or a set of packages that supply a concrete implementation of a subset of services that can be accessed by the Java Security API.) Thus, to provide a keystore implementation, clients must implement a "provider" and supply a KeystoreSpi subclass implementation, as described in 
       
  1291 .na
       
  1292 \f2How to Implement a Provider for the Java Cryptography Architecture\fP @
       
  1293 .fi
       
  1294 http://download.oracle.com/javase/7/docs/technotes/guides/security/crypto/HowToImplAProvider.html. 
       
  1295 .LP
       
  1296 Applications can choose different \f2types\fP of keystore implementations from different providers, using the "getInstance" factory method supplied in the \f2KeyStore\fP class. A keystore type defines the storage and data format of the keystore information, and the algorithms used to protect private/secret keys in the keystore and the integrity of the keystore itself. Keystore implementations of different types are not compatible. 
       
  1297 .LP
       
  1298 \f3keytool\fP works on any file\-based keystore implementation. (It treats the keystore location that is passed to it at the command line as a filename and converts it to a FileInputStream, from which it loads the keystore information.) The \f3jarsigner\fP and \f3policytool\fP tools, on the other hand, can read a keystore from any location that can be specified using a URL. 
       
  1299 .LP
       
  1300 For \f3keytool\fP and \f3jarsigner\fP, you can specify a keystore type at the command line, via the \f2\-storetype\fP option. For \f3Policy Tool\fP, you can specify a keystore type via the "Keystore" menu. 
       
  1301 .LP
       
  1302 If you don't explicitly specify a keystore type, the tools choose a keystore implementation based simply on the value of the \f2keystore.type\fP property specified in the security properties file. The security properties file is called \f2java.security\fP, and it resides in the security properties directory, \f2java.home\fP/lib/security, where \f2java.home\fP is the runtime environment's directory (the \f2jre\fP directory in the SDK or the top\-level directory of the Java 2 Runtime Environment).  
       
  1303 .LP
       
  1304 Each tool gets the \f2keystore.type\fP value and then examines all the currently\-installed providers until it finds one that implements keystores of that type. It then uses the keystore implementation from that provider. 
       
  1305 .LP
       
  1306 The \f2KeyStore\fP class defines a static method named \f2getDefaultType\fP that lets applications and applets retrieve the value of the \f2keystore.type\fP property. The following line of code creates an instance of the default keystore type (as specified in the \f2keystore.type\fP property): 
       
  1307 .nf
       
  1308 \f3
       
  1309 .fl
       
  1310     KeyStore keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
       
  1311 .fl
       
  1312 \fP
       
  1313 .fi
       
  1314 .LP
       
  1315 The default keystore type is "jks" (the proprietary type of the keystore implementation provided by Oracle). This is specified by the following line in the security properties file: 
       
  1316 .nf
       
  1317 \f3
       
  1318 .fl
       
  1319     keystore.type=jks
       
  1320 .fl
       
  1321 \fP
       
  1322 .fi
       
  1323 .LP
       
  1324 To have the tools utilize a keystore implementation other than the default, you can change that line to specify a different keystore type. 
       
  1325 .LP
       
  1326 For example, if you have a provider package that supplies a keystore implementation for a keystore type called "pkcs12", change the line to 
       
  1327 .nf
       
  1328 \f3
       
  1329 .fl
       
  1330     keystore.type=pkcs12
       
  1331 .fl
       
  1332 \fP
       
  1333 .fi
       
  1334 .LP
       
  1335 Note: case doesn't matter in keystore type designations. For example, "JKS" would be considered the same as "jks".  
       
  1336 .RE
       
  1337 
       
  1338 .LP
       
  1339 .SS 
       
  1340 Certificate
       
  1341 .LP
       
  1342 A \f3certificate\fP (also known as a \f3public\-key certificate\fP) is a digitally signed statement from one entity (the \f2issuer\fP), saying that the public key (and some other information) of another entity (the \f2subject\fP) has some specific value. 
       
  1343 .RS 3
       
  1344 .TP 2
       
  1345 o
       
  1346 \f3Certificate Terms\fP 
       
  1347 .RS 3
       
  1348 .TP 3
       
  1349 Public Keys 
       
  1350 .LP
       
  1351 These are numbers associated with a particular entity, and are intended to be known to everyone who needs to have trusted interactions with that entity. Public keys are used to verify signatures.  
       
  1352 .TP 3
       
  1353 Digitally Signed 
       
  1354 .LP
       
  1355 If some data is \f2digitally signed\fP it has been stored with the "identity" of an entity, and a signature that proves that entity knows about the data. The data is rendered unforgeable by signing with the entity's private key.  
       
  1356 .TP 3
       
  1357 Identity 
       
  1358 .LP
       
  1359 A known way of addressing an entity. In some systems the identity is the public key, in others it can be anything from a Unix UID to an Email address to an X.509 Distinguished Name.  
       
  1360 .TP 3
       
  1361 Signature 
       
  1362 .LP
       
  1363 A signature is computed over some data using the private key of an entity (the \f2signer\fP, which in the case of a certificate is also known as the \f2issuer\fP).  
       
  1364 .TP 3
       
  1365 Private Keys 
       
  1366 .LP
       
  1367 These are numbers, each of which is supposed to be known only to the particular entity whose private key it is (that is, it's supposed to be kept secret). Private and public keys exist in pairs in all public key cryptography systems (also referred to as "public key crypto systems"). In a typical public key crypto system, such as DSA, a private key corresponds to exactly one public key. Private keys are used to compute signatures.  
       
  1368 .TP 3
       
  1369 Entity 
       
  1370 .LP
       
  1371 An entity is a person, organization, program, computer, business, bank, or something else you are trusting to some degree.  
       
  1372 .RE
       
  1373 .LP
       
  1374 Basically, public key cryptography requires access to users' public keys. In a large\-scale networked environment it is impossible to guarantee that prior relationships between communicating entities have been established or that a trusted repository exists with all used public keys. Certificates were invented as a solution to this public key distribution problem. Now a \f2Certification Authority\fP (CA) can act as a trusted third party. CAs are entities (for example, businesses) that are trusted to sign (issue) certificates for other entities. It is assumed that CAs will only create valid and reliable certificates, as they are bound by legal agreements. There are many public Certification Authorities, such as 
       
  1375 .na
       
  1376 \f2VeriSign\fP @
       
  1377 .fi
       
  1378 http://www.verisign.com/, 
       
  1379 .na
       
  1380 \f2Thawte\fP @
       
  1381 .fi
       
  1382 http://www.thawte.com/, 
       
  1383 .na
       
  1384 \f2Entrust\fP @
       
  1385 .fi
       
  1386 http://www.entrust.com/, and so on. You can also run your own Certification Authority using products such as Microsoft Certificate Server or the Entrust CA product for your organization. 
       
  1387 .LP
       
  1388 Using \f3keytool\fP, it is possible to display, import, and export certificates. It is also possible to generate self\-signed certificates. 
       
  1389 .LP
       
  1390 \f3keytool\fP currently handles X.509 certificates.  
       
  1391 .TP 2
       
  1392 o
       
  1393 \f3X.509 Certificates\fP 
       
  1394 .LP
       
  1395 The X.509 standard defines what information can go into a certificate, and describes how to write it down (the data format). All the data in a certificate is encoded using two related standards called ASN.1/DER. \f2Abstract Syntax Notation 1\fP describes data. The \f2Definite Encoding Rules\fP describe a single way to store and transfer that data. 
       
  1396 .LP
       
  1397 All X.509 certificates have the following data, in addition to the signature: 
       
  1398 .RS 3
       
  1399 .TP 3
       
  1400 Version 
       
  1401 .LP
       
  1402 This identifies which version of the X.509 standard applies to this certificate, which affects what information can be specified in it. Thus far, three versions are defined. \f3keytool\fP can import and export v1, v2, and v3 certificates. It generates v3 certificates. 
       
  1403 .LP
       
  1404 \f2X.509 Version 1\fP has been available since 1988, is widely deployed, and is the most generic. 
       
  1405 .LP
       
  1406 \f2X.509 Version 2\fP introduced the concept of subject and issuer unique identifiers to handle the possibility of reuse of subject and/or issuer names over time. Most certificate profile documents strongly recommend that names not be reused, and that certificates should not make use of unique identifiers. Version 2 certificates are not widely used. 
       
  1407 .LP
       
  1408 \f2X.509 Version 3\fP is the most recent (1996) and supports the notion of extensions, whereby anyone can define an extension and include it in the certificate. Some common extensions in use today are: \f2KeyUsage\fP (limits the use of the keys to particular purposes such as "signing\-only") and \f2AlternativeNames\fP (allows other identities to also be associated with this public key, e.g. DNS names, Email addresses, IP addresses). Extensions can be marked \f2critical\fP to indicate that the extension should be checked and enforced/used. For example, if a certificate has the KeyUsage extension marked critical and set to "keyCertSign" then if this certificate is presented during SSL communication, it should be rejected, as the certificate extension indicates that the associated private key should only be used for signing certificates and not for SSL use.  
       
  1409 .TP 3
       
  1410 Serial Number 
       
  1411 .LP
       
  1412 The entity that created the certificate is responsible for assigning it a serial number to distinguish it from other certificates it issues. This information is used in numerous ways, for example when a certificate is revoked its serial number is placed in a Certificate Revocation List (CRL).  
       
  1413 .TP 3
       
  1414 Signature Algorithm Identifier 
       
  1415 .LP
       
  1416 This identifies the algorithm used by the CA to sign the certificate.  
       
  1417 .TP 3
       
  1418 Issuer Name 
       
  1419 .LP
       
  1420 The X.500 Distinguished Name of the entity that signed the certificate. This is normally a CA. Using this certificate implies trusting the entity that signed this certificate. (Note that in some cases, such as \f2root or top\-level\fP CA certificates, the issuer signs its own certificate.)  
       
  1421 .TP 3
       
  1422 Validity Period 
       
  1423 .LP
       
  1424 Each certificate is valid only for a limited amount of time. This period is described by a start date and time and an end date and time, and can be as short as a few seconds or almost as long as a century. The validity period chosen depends on a number of factors, such as the strength of the private key used to sign the certificate or the amount one is willing to pay for a certificate. This is the expected period that entities can rely on the public value, if the associated private key has not been compromised.  
       
  1425 .TP 3
       
  1426 Subject Name 
       
  1427 .LP
       
  1428 The name of the entity whose public key the certificate identifies. This name uses the X.500 standard, so it is intended to be unique across the Internet. This is the X.500 Distinguished Name (DN) of the entity, for example, 
       
  1429 .nf
       
  1430 \f3
       
  1431 .fl
       
  1432     CN=Java Duke, OU=Java Software Division, O=Oracle Corporation, C=US
       
  1433 .fl
       
  1434 \fP
       
  1435 .fi
       
  1436 .LP
       
  1437 (These refer to the subject's Common Name, Organizational Unit, Organization, and Country.)  
       
  1438 .TP 3
       
  1439 Subject Public Key Information 
       
  1440 .LP
       
  1441 This is the public key of the entity being named, together with an algorithm identifier which specifies which public key crypto system this key belongs to and any associated key parameters.  
       
  1442 .RE
       
  1443 .TP 2
       
  1444 o
       
  1445 \f3Certificate Chains\fP 
       
  1446 .LP
       
  1447 \f3keytool\fP can create and manage keystore "key" entries that each contain a private key and an associated certificate "chain". The first certificate in the chain contains the public key corresponding to the private key. 
       
  1448 .LP
       
  1449 When keys are first generated (see the \-genkeypair command), the chain starts off containing a single element, a \f2self\-signed certificate\fP. A self\-signed certificate is one for which the issuer (signer) is the same as the subject (the entity whose public key is being authenticated by the certificate). Whenever the \f2\-genkeypair\fP command is called to generate a new public/private key pair, it also wraps the public key into a self\-signed certificate. 
       
  1450 .LP
       
  1451 Later, after a Certificate Signing Request (CSR) has been generated (see the \-certreq command) and sent to a Certification Authority (CA), the response from the CA is imported (see \-importcert), and the self\-signed certificate is replaced by a chain of certificates. At the bottom of the chain is the certificate (reply) issued by the CA authenticating the subject's public key. The next certificate in the chain is one that authenticates the \f2CA\fP's public key. 
       
  1452 .LP
       
  1453 In many cases, this is a self\-signed certificate (that is, a certificate from the CA authenticating its own public key) and the last certificate in the chain. In other cases, the CA may return a chain of certificates. In this case, the bottom certificate in the chain is the same (a certificate signed by the CA, authenticating the public key of the key entry), but the second certificate in the chain is a certificate signed by a \f2different\fP CA, authenticating the public key of the CA you sent the CSR to. Then, the next certificate in the chain will be a certificate authenticating the second CA's key, and so on, until a self\-signed "root" certificate is reached. Each certificate in the chain (after the first) thus authenticates the public key of the signer of the previous certificate in the chain. 
       
  1454 .LP
       
  1455 Many CAs only return the issued certificate, with no supporting chain, especially when there is a flat hierarchy (no intermediates CAs). In this case, the certificate chain must be established from trusted certificate information already stored in the keystore. 
       
  1456 .LP
       
  1457 A different reply format (defined by the PKCS#7 standard) also includes the supporting certificate chain, in addition to the issued certificate. Both reply formats can be handled by \f3keytool\fP. 
       
  1458 .LP
       
  1459 The top\-level (root) CA certificate is self\-signed. However, the trust into the root's public key does not come from the root certificate itself (anybody could generate a self\-signed certificate with the distinguished name of say, the VeriSign root CA!), but from other sources like a newspaper. The root CA public key is widely known. The only reason it is stored in a certificate is because this is the format understood by most tools, so the certificate in this case is only used as a "vehicle" to transport the root CA's public key. Before you add the root CA certificate to your keystore, you should view it (using the \f2\-printcert\fP option) and compare the displayed fingerprint with the well\-known fingerprint (obtained from a newspaper, the root CA's Web page, etc.).   
       
  1460 .TP 2
       
  1461 o
       
  1462 \f3The cacerts Certificates File\fP 
       
  1463 .LP
       
  1464 A certificates file named \f3"cacerts"\fP resides in the security properties directory, \f2java.home\fP/lib/security, where \f2java.home\fP is the runtime environment's directory (the \f2jre\fP directory in the SDK or the top\-level directory of the Java 2 Runtime Environment).  
       
  1465 .LP
       
  1466 The "cacerts" file represents a system\-wide keystore with CA certificates. System administrators can configure and manage that file using \f3keytool\fP, specifying "jks" as the keystore type. The "cacerts" keystore file ships with a default set of root CA certificates; list them with the following command: 
       
  1467 .nf
       
  1468 \f3
       
  1469 .fl
       
  1470 keytool \-list \-keystore \fP\f4java.home\fP\f3/lib/security/cacerts
       
  1471 .fl
       
  1472 \fP
       
  1473 .fi
       
  1474 .LP
       
  1475 The initial password of the "cacerts" keystore file is "changeit". System administrators should change that password and the default access permission of that file upon installing the SDK. 
       
  1476 .LP
       
  1477 \f3IMPORTANT: Verify Your \fP\f4cacerts\fP\f3 File\fP: Since you trust the CAs in the \f2cacerts\fP file as entities for signing and issuing certificates to other entities, you must manage the \f2cacerts\fP file carefully. The \f2cacerts\fP file should contain only certificates of the CAs you trust. It is your responsibility to verify the trusted root CA certificates bundled in the \f2cacerts\fP file and make your own trust decisions. To remove an untrusted CA certificate from the \f2cacerts\fP file, use the delete option of the \f2keytool\fP command. You can find the \f2cacerts\fP file in the JRE installation directory. Contact your system administrator if you do not have permission to edit this file.  
       
  1478 .TP 2
       
  1479 o
       
  1480 \f3The Internet RFC 1421 Certificate Encoding Standard\fP 
       
  1481 .LP
       
  1482 Certificates are often stored using the printable encoding format defined by the Internet RFC 1421 standard, instead of their binary encoding. This certificate format, also known as "Base 64 encoding", facilitates exporting certificates to other applications by email or through some other mechanism. 
       
  1483 .LP
       
  1484 Certificates read by the \f2\-importcert\fP and \f2\-printcert\fP commands can be in either this format or binary encoded. 
       
  1485 .LP
       
  1486 The \f2\-exportcert\fP command by default outputs a certificate in binary encoding, but will instead output a certificate in the printable encoding format, if the \f2\-rfc\fP option is specified. 
       
  1487 .LP
       
  1488 The \f2\-list\fP 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, while if the \f2\-rfc\fP option is specified, the certificate is output in the printable encoding format. 
       
  1489 .LP
       
  1490 In its printable encoding format, the encoded certificate is bounded at the beginning by 
       
  1491 .nf
       
  1492 \f3
       
  1493 .fl
       
  1494 \-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-
       
  1495 .fl
       
  1496 \fP
       
  1497 .fi
       
  1498 .LP
       
  1499 and at the end by 
       
  1500 .nf
       
  1501 \f3
       
  1502 .fl
       
  1503 \-\-\-\-\-END CERTIFICATE\-\-\-\-\-
       
  1504 .fl
       
  1505 \fP
       
  1506 .fi
       
  1507 .RE
       
  1508 
       
  1509 .LP
       
  1510 .SS 
       
  1511 X.500 Distinguished Names
       
  1512 .LP
       
  1513 .LP
       
  1514 X.500 Distinguished Names are used to identify entities, such as those which are named by the \f2subject\fP and \f2issuer\fP (signer) fields of X.509 certificates. \f3keytool\fP supports the following subparts:
       
  1515 .LP
       
  1516 .RS 3
       
  1517 .TP 2
       
  1518 o
       
  1519 \f2commonName\fP \- common name of a person, e.g., "Susan Jones" 
       
  1520 .TP 2
       
  1521 o
       
  1522 \f2organizationUnit\fP \- small organization (e.g., department or division) name, e.g., "Purchasing" 
       
  1523 .TP 2
       
  1524 o
       
  1525 \f2organizationName\fP \- large organization name, e.g., "ABCSystems, Inc." 
       
  1526 .TP 2
       
  1527 o
       
  1528 \f2localityName\fP \- locality (city) name, e.g., "Palo Alto" 
       
  1529 .TP 2
       
  1530 o
       
  1531 \f2stateName\fP \- state or province name, e.g., "California" 
       
  1532 .TP 2
       
  1533 o
       
  1534 \f2country\fP \- two\-letter country code, e.g., "CH" 
       
  1535 .RE
       
  1536 
       
  1537 .LP
       
  1538 .LP
       
  1539 When supplying a distinguished name string as the value of a \f2\-dname\fP option, as for the \f2\-genkeypair\fP  command, the string must be in the following format:
       
  1540 .LP
       
  1541 .nf
       
  1542 \f3
       
  1543 .fl
       
  1544 CN=\fP\f4cName\fP\f3, OU=\fP\f4orgUnit\fP\f3, O=\fP\f4org\fP\f3, L=\fP\f4city\fP\f3, S=\fP\f4state\fP\f3, C=\fP\f4countryCode\fP\f3
       
  1545 .fl
       
  1546 \fP
       
  1547 .fi
       
  1548 
       
  1549 .LP
       
  1550 .LP
       
  1551 where all the italicized items represent actual values and the above keywords are abbreviations for the following:
       
  1552 .LP
       
  1553 .nf
       
  1554 \f3
       
  1555 .fl
       
  1556         CN=commonName
       
  1557 .fl
       
  1558         OU=organizationUnit
       
  1559 .fl
       
  1560         O=organizationName
       
  1561 .fl
       
  1562         L=localityName
       
  1563 .fl
       
  1564         S=stateName
       
  1565 .fl
       
  1566         C=country
       
  1567 .fl
       
  1568 \fP
       
  1569 .fi
       
  1570 
       
  1571 .LP
       
  1572 .LP
       
  1573 A sample distinguished name string is
       
  1574 .LP
       
  1575 .nf
       
  1576 \f3
       
  1577 .fl
       
  1578 CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino, S=California, C=US
       
  1579 .fl
       
  1580 \fP
       
  1581 .fi
       
  1582 
       
  1583 .LP
       
  1584 .LP
       
  1585 and a sample command using such a string is
       
  1586 .LP
       
  1587 .nf
       
  1588 \f3
       
  1589 .fl
       
  1590 keytool \-genkeypair \-dname "CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino,
       
  1591 .fl
       
  1592 S=California, C=US" \-alias mark
       
  1593 .fl
       
  1594 \fP
       
  1595 .fi
       
  1596 
       
  1597 .LP
       
  1598 .LP
       
  1599 Case does not matter for the keyword abbreviations. For example, "CN", "cn", and "Cn" are all treated the same.
       
  1600 .LP
       
  1601 .LP
       
  1602 Order matters; each subcomponent must appear in the designated order. However, it is not necessary to have all the subcomponents. You may use a subset, for example:
       
  1603 .LP
       
  1604 .nf
       
  1605 \f3
       
  1606 .fl
       
  1607 CN=Steve Meier, OU=Java, O=Oracle, C=US
       
  1608 .fl
       
  1609 \fP
       
  1610 .fi
       
  1611 
       
  1612 .LP
       
  1613 .LP
       
  1614 If a distinguished name string value contains a comma, the comma must be escaped by a "\\" character when you specify the string on a command line, as in
       
  1615 .LP
       
  1616 .nf
       
  1617 \f3
       
  1618 .fl
       
  1619    cn=Peter Schuster, ou=Java\\, Product Development, o=Oracle, c=US
       
  1620 .fl
       
  1621 \fP
       
  1622 .fi
       
  1623 
       
  1624 .LP
       
  1625 .LP
       
  1626 It is never necessary to specify a distinguished name string on a command line. If it is needed for a command, but not supplied on the command line, the user is prompted for each of the subcomponents. In this case, a comma does not need to be escaped by a "\\".
       
  1627 .LP
       
  1628 .SS 
       
  1629 WARNING Regarding Importing Trusted Certificates
       
  1630 .LP
       
  1631 .LP
       
  1632 IMPORTANT: Be sure to check a certificate very carefully before importing it as a trusted certificate!
       
  1633 .LP
       
  1634 .LP
       
  1635 View it first (using the \f2\-printcert\fP command, or the \f2\-importcert\fP command without the \f2\-noprompt\fP option), and make sure that the displayed certificate fingerprint(s) match the expected ones. For example, suppose someone sends or emails you a certificate, and you put it in a file named \f2/tmp/cert\fP. Before you consider adding the certificate to your list of trusted certificates, you can execute a \f2\-printcert\fP command to view its fingerprints, as in
       
  1636 .LP
       
  1637 .nf
       
  1638 \f3
       
  1639 .fl
       
  1640   keytool \-printcert \-file /tmp/cert
       
  1641 .fl
       
  1642     Owner: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll
       
  1643 .fl
       
  1644     Issuer: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll
       
  1645 .fl
       
  1646     Serial Number: 59092b34
       
  1647 .fl
       
  1648     Valid from: Thu Sep 25 18:01:13 PDT 1997 until: Wed Dec 24 17:01:13 PST 1997
       
  1649 .fl
       
  1650     Certificate Fingerprints:
       
  1651 .fl
       
  1652          MD5:  11:81:AD:92:C8:E5:0E:A2:01:2E:D4:7A:D7:5F:07:6F
       
  1653 .fl
       
  1654          SHA1: 20:B6:17:FA:EF:E5:55:8A:D0:71:1F:E8:D6:9D:C0:37:13:0E:5E:FE
       
  1655 .fl
       
  1656          SHA256: 90:7B:70:0A:EA:DC:16:79:92:99:41:FF:8A:FE:EB:90:
       
  1657 .fl
       
  1658                  17:75:E0:90:B2:24:4D:3A:2A:16:A6:E4:11:0F:67:A4
       
  1659 .fl
       
  1660 \fP
       
  1661 .fi
       
  1662 
       
  1663 .LP
       
  1664 .LP
       
  1665 Then call or otherwise contact the person who sent the certificate, and compare the fingerprint(s) that you see with the ones that they show. 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 (for example, a JAR file with malicious class files inside).
       
  1666 .LP
       
  1667 .LP
       
  1668 Note: it is not required that you execute a \f2\-printcert\fP command prior to importing a certificate, since before adding a certificate to the list of trusted certificates in the keystore, the \f2\-importcert\fP command prints out the certificate information and prompts you to verify it. You then have the option of aborting the import operation. Note, however, this is only the case if you invoke the \f2\-importcert\fP command without the \f2\-noprompt\fP option. If the \f2\-noprompt\fP option is given, there is no interaction with the user.
       
  1669 .LP
       
  1670 .SS 
       
  1671 Warning Regarding Passwords
       
  1672 .LP
       
  1673 .LP
       
  1674 Most commands operating on a keystore require the store password. Some commands require a private/secret key password.
       
  1675 .LP
       
  1676 .LP
       
  1677 Passwords can be specified on the command line (in the \f2\-storepass\fP and \f2\-keypass\fP options, respectively). However, a password should not be specified on a command line or in a script unless it is for testing purposes, or you are on a secure system.
       
  1678 .LP
       
  1679 .LP
       
  1680 If you don't specify a required password option on a command line, you will be prompted for it.
       
  1681 .LP
       
  1682 .SS 
       
  1683 Warning Regarding Certificate Conformance
       
  1684 .LP
       
  1685 .LP
       
  1686 The Internet standard 
       
  1687 .na
       
  1688 \f2RFC 5280\fP @
       
  1689 .fi
       
  1690 http://tools.ietf.org/rfc/rfc5280.txt has defined a profile on conforming X.509 certificates, which includes what values and value combinations are valid for certificate fields and extensions. \f3keytool\fP has not enforced all these rules so it can generate certificates which do not conform to the standard, and these certificates might be rejected by JRE or other applications. Users should make sure that they provide the correct options for \f2\-dname\fP, \f2\-ext\fP, etc.
       
  1691 .LP
       
  1692 .SH "SEE ALSO"
       
  1693 .LP
       
  1694 .RS 3
       
  1695 .TP 2
       
  1696 o
       
  1697 jar(1) tool documentation 
       
  1698 .TP 2
       
  1699 o
       
  1700 jarsigner(1) tool documentation 
       
  1701 .TP 2
       
  1702 o
       
  1703 the 
       
  1704 .na
       
  1705 \f4Security\fP @
       
  1706 .fi
       
  1707 http://download.oracle.com/javase/tutorial/security/index.html trail of the 
       
  1708 .na
       
  1709 \f4Java Tutorial\fP @
       
  1710 .fi
       
  1711 http://download.oracle.com/javase/tutorial/ for examples of the use of \f3keytool\fP 
       
  1712 .RE
       
  1713 
       
  1714 .LP
       
  1715 .SH "CHANGES"
       
  1716 .LP
       
  1717 .LP
       
  1718 The command interface for keytool changed in Java SE 6.
       
  1719 .LP
       
  1720 .LP
       
  1721 \f3keytool\fP no longer displays password input when entered by users. Since password input can no longer be viewed when entered, users will be prompted to re\-enter passwords any time a password is being set or changed (for example, when setting the initial keystore password, or when changing a key password).
       
  1722 .LP
       
  1723 .LP
       
  1724 Some commands have simply been renamed, and other commands deemed obsolete are no longer listed in this document. All previous commands (both renamed and obsolete) are still supported in this release and will continue to be supported in future releases. The following summarizes all of the changes made to the keytool command interface:
       
  1725 .LP
       
  1726 .LP
       
  1727 Renamed commands:
       
  1728 .LP
       
  1729 .RS 3
       
  1730 .TP 2
       
  1731 o
       
  1732 \f2\-export\fP, renamed to \f2\-exportcert\fP 
       
  1733 .TP 2
       
  1734 o
       
  1735 \f2\-genkey\fP, renamed to \f2\-genkeypair\fP 
       
  1736 .TP 2
       
  1737 o
       
  1738 \f2\-import\fP, renamed to \f2\-importcert\fP 
       
  1739 .RE
       
  1740 
       
  1741 .LP
       
  1742 .LP
       
  1743 Commands deemed obsolete and no longer documented:
       
  1744 .LP
       
  1745 .RS 3
       
  1746 .TP 2
       
  1747 o
       
  1748 .na
       
  1749 \f2\-keyclone\fP @
       
  1750 .fi
       
  1751 http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/keytool.html#keycloneCmd 
       
  1752 .TP 2
       
  1753 o
       
  1754 .na
       
  1755 \f2\-identitydb\fP @
       
  1756 .fi
       
  1757 http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/keytool.html#identitydbCmd 
       
  1758 .TP 2
       
  1759 o
       
  1760 .na
       
  1761 \f2\-selfcert\fP @
       
  1762 .fi
       
  1763 http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/keytool.html#selfcertCmd 
       
  1764 .RE
       
  1765 
       
  1766 .LP
       
  1767