java.lang.Object | |
↳ | java.security.KeyStore |
This class represents a storage facility for cryptographic keys and certificates.
A KeyStore
manages different types of entries.
Each type of entry implements the KeyStore.Entry
interface.
Three basic KeyStore.Entry
implementations are provided:
This type of entry holds a cryptographic PrivateKey
,
which is optionally stored in a protected format to prevent
unauthorized access. It is also accompanied by a certificate chain
for the corresponding public key.
Private keys and certificate chains are used by a given entity for self-authentication. Applications for this authentication include software distribution organizations which sign JAR files as part of releasing and/or licensing software.
This type of entry holds a cryptographic SecretKey
,
which is optionally stored in a protected format to prevent
unauthorized access.
This type of entry 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.
This type of entry can be used to authenticate other parties.
Each entry in a keystore is identified by an "alias" string. In the case of private keys and their associated certificate chains, these strings distinguish among the different ways in which the entity may authenticate itself. For example, the entity may authenticate itself using different certificate authorities, or using different public key algorithms.
Whether aliases are case sensitive is implementation dependent. In order to avoid problems, it is recommended not to use aliases in a KeyStore that only differ in case.
Whether keystores are persistent, and the mechanisms used by the keystore if it is persistent, are not specified here. This allows use of a variety of techniques for protecting sensitive (e.g., private or secret) keys. Smart cards or other integrated cryptographic engines (SafeKeyper) are one option, and simpler mechanisms such as files may also be used (in a variety of formats).
Typical ways to request a KeyStore object include relying on the default type and providing a specific keystore type.
KeyStore ks = KeyStore.getInstance(KeyStore.getDefaultType());The system will return a keystore implementation for the default type.
KeyStore ks = KeyStore.getInstance("JKS");The system will return the most preferred implementation of the specified keystore type available in the environment.
Before a keystore can be accessed, it must be
loaded
.
KeyStore ks = KeyStore.getInstance(KeyStore.getDefaultType()); // get user password and file input stream char[] password = getPassword(); java.io.FileInputStream fis = null; try { fis = new java.io.FileInputStream("keyStoreName"); ks.load(fis, password); } finally { if (fis != null) { fis.close(); } }To create an empty keystore using the above
load
method,
pass null
as the InputStream
argument.
Once the keystore has been loaded, it is possible to read existing entries from the keystore, or to write new entries into the keystore:
// get my private key KeyStore.PrivateKeyEntry pkEntry = (KeyStore.PrivateKeyEntry) ks.getEntry("privateKeyAlias", password); PrivateKey myPrivateKey = pkEntry.getPrivateKey(); // save my secret key javax.crypto.SecretKey mySecretKey; KeyStore.SecretKeyEntry skEntry = new KeyStore.SecretKeyEntry(mySecretKey); ks.setEntry("secretKeyAlias", skEntry, new KeyStore.PasswordProtection(password)); // store away the keystore java.io.FileOutputStream fos = null; try { fos = new java.io.FileOutputStream("newKeyStoreName"); ks.store(fos, password); } finally { if (fos != null) { fos.close(); } }Note that although the same password may be used to load the keystore, to protect the private key entry, to protect the secret key entry, and to store the keystore (as is shown in the sample code above), different passwords or other protection parameters may also be used.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
KeyStore.Builder | A description of a to-be-instantiated KeyStore object. | ||||||||||
KeyStore.CallbackHandlerProtection | A ProtectionParameter encapsulating a CallbackHandler. | ||||||||||
KeyStore.Entry | A marker interface for KeyStore entry types. |
||||||||||
KeyStore.LoadStoreParameter | A marker interface for KeyStore
load
and
store
parameters. |
||||||||||
KeyStore.PasswordProtection | A password-based implementation of ProtectionParameter . |
||||||||||
KeyStore.PrivateKeyEntry | A KeyStore entry that holds a PrivateKey
and corresponding certificate chain. |
||||||||||
KeyStore.ProtectionParameter | A marker interface for keystore protection parameters. | ||||||||||
KeyStore.SecretKeyEntry | A KeyStore entry that holds a SecretKey . |
||||||||||
KeyStore.TrustedCertificateEntry | A KeyStore entry that holds a trusted
Certificate . |
Protected Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates a KeyStore object of the given type, and encapsulates the given
provider implementation (SPI object) in it.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Lists all the alias names of this keystore.
| |||||||||||
Checks if the given alias exists in this keystore.
| |||||||||||
Deletes the entry identified by the given alias from this keystore.
| |||||||||||
Determines if the keystore
Entry for the specified
alias is an instance or subclass of the specified
entryClass . | |||||||||||
Returns the certificate associated with the given alias.
| |||||||||||
Returns the (alias) name of the first keystore entry whose certificate
matches the given certificate.
| |||||||||||
Returns the certificate chain associated with the given alias.
| |||||||||||
Returns the creation date of the entry identified by the given alias.
| |||||||||||
Returns the default keystore type as specified in the Java security
properties file, or the string
"jks" (acronym for "Java keystore")
if no such property exists.
| |||||||||||
Gets a keystore
Entry for the specified alias
with the specified protection parameter. | |||||||||||
Returns a keystore object of the specified type.
| |||||||||||
Returns a keystore object of the specified type.
| |||||||||||
Returns a keystore object of the specified type.
| |||||||||||
Returns the key associated with the given alias, using the given
password to recover it.
| |||||||||||
Returns the provider of this keystore.
| |||||||||||
Returns the type of this keystore.
| |||||||||||
Returns true if the entry identified by the given alias
was created by a call to
setCertificateEntry ,
or created by a call to setEntry with a
TrustedCertificateEntry . | |||||||||||
Returns true if the entry identified by the given alias
was created by a call to
setKeyEntry ,
or created by a call to setEntry with a
PrivateKeyEntry or a SecretKeyEntry . | |||||||||||
Loads this KeyStore from the given input stream.
| |||||||||||
Loads this keystore using the given
LoadStoreParameter . | |||||||||||
Assigns the given trusted certificate to the given alias.
| |||||||||||
Saves a keystore
Entry under the specified alias. | |||||||||||
Assigns the given key to the given alias, protecting it with the given
password.
| |||||||||||
Assigns the given key (that has already been protected) to the given
alias.
| |||||||||||
Retrieves the number of entries in this keystore.
| |||||||||||
Stores this keystore to the given output stream, and protects its
integrity with the given password.
| |||||||||||
Stores this keystore using the given
LoadStoreParameter . |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Creates a KeyStore object of the given type, and encapsulates the given provider implementation (SPI object) in it.
keyStoreSpi | the provider implementation. |
---|---|
provider | the provider. |
type | the keystore type. |
Lists all the alias names of this keystore.
KeyStoreException | if the keystore has not been initialized (loaded). |
---|
Checks if the given alias exists in this keystore.
alias | the alias name |
---|
KeyStoreException | if the keystore has not been initialized (loaded). |
---|
Deletes the entry identified by the given alias from this keystore.
alias | the alias name |
---|
KeyStoreException | if the keystore has not been initialized, or if the entry cannot be removed. |
---|
Determines if the keystore Entry
for the specified
alias
is an instance or subclass of the specified
entryClass
.
alias | the alias name |
---|---|
entryClass | the entry class |
Entry
for the specified
alias
is an instance or subclass of the
specified entryClass
, false otherwiseNullPointerException | if
alias or entryClass
is null |
---|---|
KeyStoreException | if the keystore has not been initialized (loaded) |
Returns the certificate associated with the given alias.
If the given alias name identifies an entry
created by a call to setCertificateEntry
,
or created by a call to setEntry
with a
TrustedCertificateEntry
,
then the trusted certificate contained in that entry is returned.
If the given alias name identifies an entry
created by a call to setKeyEntry
,
or created by a call to setEntry
with a
PrivateKeyEntry
,
then the first element of the certificate chain in that entry
is returned.
alias | the alias name |
---|
KeyStoreException | if the keystore has not been initialized (loaded). |
---|
Returns the (alias) name of the first keystore entry whose certificate matches the given certificate.
This method attempts to match the given certificate with each
keystore entry. If the entry being considered was
created by a call to setCertificateEntry
,
or created by a call to setEntry
with a
TrustedCertificateEntry
,
then the given certificate is compared to that entry's certificate.
If the entry being considered was
created by a call to setKeyEntry
,
or created by a call to setEntry
with a
PrivateKeyEntry
,
then the given certificate is compared to the first
element of that entry's certificate chain.
cert | the certificate to match with. |
---|
KeyStoreException | if the keystore has not been initialized (loaded). |
---|
Returns the certificate chain associated with the given alias.
The certificate chain must have been associated with the alias
by a call to setKeyEntry
,
or by a call to setEntry
with a
PrivateKeyEntry
.
alias | the alias name |
---|
KeyStoreException | if the keystore has not been initialized (loaded). |
---|
Returns the creation date of the entry identified by the given alias.
alias | the alias name |
---|
KeyStoreException | if the keystore has not been initialized (loaded). |
---|
Returns the default keystore type as specified in the Java security properties file, or the string "jks" (acronym for "Java keystore") if no such property exists. The Java security properties file is located in the file named <JAVA_HOME>/lib/security/java.security. <JAVA_HOME> refers to the value of the java.home system property, and specifies the directory where the JRE is installed.
The default keystore type can be used by applications that do not
want to use a hard-coded keystore type when calling one of the
getInstance
methods, and want to provide a default keystore
type in case a user does not specify its own.
The default keystore type can be changed by setting the value of the "keystore.type" security property (in the Java security properties file) to the desired keystore type.
Gets a keystore Entry
for the specified alias
with the specified protection parameter.
alias | get the keystore Entry for this alias |
---|---|
protParam | the ProtectionParameter
used to protect the Entry ,
which may be null |
Entry
for the specified alias,
or null
if there is no such entryNullPointerException | if
alias is null |
---|---|
NoSuchAlgorithmException | if the algorithm for recovering the entry cannot be found |
UnrecoverableEntryException | if the specified
protParam were insufficient or invalid |
UnrecoverableKeyException | if the entry is a
PrivateKeyEntry or SecretKeyEntry
and the specified protParam does not contain
the information needed to recover the key (e.g. wrong password) |
KeyStoreException | if the keystore has not been initialized (loaded). |
Returns a keystore object of the specified type.
A new KeyStore object encapsulating the KeyStoreSpi implementation from the specified provider is returned. The specified provider must be registered in the security provider list.
Note that the list of registered providers may be retrieved via
the Security.getProviders()
method.
type | the type of keystore. See Appendix A in the Java Cryptography Architecture API Specification & Reference for information about standard keystore types. |
---|---|
provider | the name of the provider. |
KeyStoreException | if a KeyStoreSpi implementation for the specified type is not available from the specified provider. |
---|---|
NoSuchProviderException | if the specified provider is not registered in the security provider list. |
IllegalArgumentException | if the provider name is null or empty. |
Returns a keystore object of the specified type.
A new KeyStore object encapsulating the KeyStoreSpi implementation from the specified Provider object is returned. Note that the specified Provider object does not have to be registered in the provider list.
type | the type of keystore. See Appendix A in the Java Cryptography Architecture API Specification & Reference for information about standard keystore types. |
---|---|
provider | the provider. |
KeyStoreException | if KeyStoreSpi implementation for the specified type is not available from the specified Provider object. |
---|---|
IllegalArgumentException | if the specified provider is null. |
Returns a keystore object of the specified type.
This method traverses the list of registered security Providers, starting with the most preferred Provider. A new KeyStore object encapsulating the KeyStoreSpi implementation from the first Provider that supports the specified type is returned.
Note that the list of registered providers may be retrieved via
the Security.getProviders()
method.
type | the type of keystore. See Appendix A in the Java Cryptography Architecture API Specification & Reference for information about standard keystore types. |
---|
KeyStoreException | if no Provider supports a KeyStoreSpi implementation for the specified type. |
---|
Returns the key associated with the given alias, using the given
password to recover it. The key must have been associated with
the alias by a call to setKeyEntry
,
or by a call to setEntry
with a
PrivateKeyEntry
or SecretKeyEntry
.
alias | the alias name |
---|---|
password | the password for recovering the key |
KeyStoreException | if the keystore has not been initialized (loaded). |
---|---|
NoSuchAlgorithmException | if the algorithm for recovering the key cannot be found |
UnrecoverableKeyException | if the key cannot be recovered (e.g., the given password is wrong). |
Returns the provider of this keystore.
Returns the type of this keystore.
Returns true if the entry identified by the given alias
was created by a call to setCertificateEntry
,
or created by a call to setEntry
with a
TrustedCertificateEntry
.
alias | the alias for the keystore entry to be checked |
---|
KeyStoreException | if the keystore has not been initialized (loaded). |
---|
Returns true if the entry identified by the given alias
was created by a call to setKeyEntry
,
or created by a call to setEntry
with a
PrivateKeyEntry
or a SecretKeyEntry
.
alias | the alias for the keystore entry to be checked |
---|
KeyStoreException | if the keystore has not been initialized (loaded). |
---|
Loads this KeyStore from the given input stream.
A password may be given to unlock the keystore (e.g. the keystore resides on a hardware token device), or to check the integrity of the keystore data. If a password is not given for integrity checking, then integrity checking is not performed.
In order to create an empty keystore, or if the keystore cannot
be initialized from a stream, pass null
as the stream
argument.
Note that if this keystore has already been loaded, it is reinitialized and loaded again from the given input stream.
stream | the input stream from which the keystore is loaded,
or null |
---|---|
password | the password used to check the integrity of
the keystore, the password used to unlock the keystore,
or null |
IOException | if there is an I/O or format problem with the
keystore data, if a password is required but not given,
or if the given password was incorrect. If the error is due to a
wrong password, the cause of the
IOException should be an
UnrecoverableKeyException |
---|---|
NoSuchAlgorithmException | if the algorithm used to check the integrity of the keystore cannot be found |
CertificateException | if any of the certificates in the keystore could not be loaded |
Loads this keystore using the given LoadStoreParameter
.
Note that if this KeyStore has already been loaded, it is reinitialized and loaded again from the given parameter.
param | the LoadStoreParameter
that specifies how to load the keystore,
which may be null |
---|
IllegalArgumentException | if the given
LoadStoreParameter
input is not recognized |
---|---|
IOException | if there is an I/O or format problem with the
keystore data. If the error is due to an incorrect
ProtectionParameter (e.g. wrong password)
the cause of the
IOException should be an
UnrecoverableKeyException |
NoSuchAlgorithmException | if the algorithm used to check the integrity of the keystore cannot be found |
CertificateException | if any of the certificates in the keystore could not be loaded |
Assigns the given trusted certificate to the given alias.
If the given alias identifies an existing entry
created by a call to setCertificateEntry
,
or created by a call to setEntry
with a
TrustedCertificateEntry
,
the trusted certificate in the existing entry
is overridden by the given certificate.
alias | the alias name |
---|---|
cert | the certificate |
KeyStoreException | if the keystore has not been initialized, or the given alias already exists and does not identify an entry containing a trusted certificate, or this operation fails for some other reason. |
---|
Saves a keystore Entry
under the specified alias.
The protection parameter is used to protect the
Entry
.
If an entry already exists for the specified alias, it is overridden.
alias | save the keystore Entry under this alias |
---|---|
entry | the Entry to save |
protParam | the ProtectionParameter
used to protect the Entry ,
which may be null |
NullPointerException | if
alias or entry
is null |
---|---|
KeyStoreException | if the keystore has not been initialized (loaded), or if this operation fails for some other reason |
Assigns the given key to the given alias, protecting it with the given password.
If the given key is of type java.security.PrivateKey
,
it must be accompanied by a certificate chain certifying the
corresponding public key.
If the given alias already exists, the keystore information associated with it is overridden by the given key (and possibly certificate chain).
alias | the alias name |
---|---|
key | the key to be associated with the alias |
password | the password to protect the key |
chain | the certificate chain for the corresponding public
key (only required if the given key is of type
java.security.PrivateKey ). |
KeyStoreException | if the keystore has not been initialized (loaded), the given key cannot be protected, or this operation fails for some other reason |
---|
Assigns the given key (that has already been protected) to the given alias.
If the protected key is of type
java.security.PrivateKey
, it must be accompanied by a
certificate chain certifying the corresponding public key. If the
underlying keystore implementation is of type jks
,
key
must be encoded as an
EncryptedPrivateKeyInfo
as defined in the PKCS #8 standard.
If the given alias already exists, the keystore information associated with it is overridden by the given key (and possibly certificate chain).
alias | the alias name |
---|---|
key | the key (in protected format) to be associated with the alias |
chain | the certificate chain for the corresponding public
key (only useful if the protected key is of type
java.security.PrivateKey ). |
KeyStoreException | if the keystore has not been initialized (loaded), or if this operation fails for some other reason. |
---|
Retrieves the number of entries in this keystore.
KeyStoreException | if the keystore has not been initialized (loaded). |
---|
Stores this keystore to the given output stream, and protects its integrity with the given password.
stream | the output stream to which this keystore is written. |
---|---|
password | the password to generate the keystore integrity check |
KeyStoreException | if the keystore has not been initialized (loaded). |
---|---|
IOException | if there was an I/O problem with data |
NoSuchAlgorithmException | if the appropriate data integrity algorithm could not be found |
CertificateException | if any of the certificates included in the keystore data could not be stored |
Stores this keystore using the given LoadStoreParameter
.
param | the LoadStoreParameter
that specifies how to store the keystore,
which may be null |
---|
IllegalArgumentException | if the given
LoadStoreParameter
input is not recognized |
---|---|
KeyStoreException | if the keystore has not been initialized (loaded) |
IOException | if there was an I/O problem with data |
NoSuchAlgorithmException | if the appropriate data integrity algorithm could not be found |
CertificateException | if any of the certificates included in the keystore data could not be stored |