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 class represents an in-memory collection of keys and certificates. It manages two types of entries:
This type of
keystore
entry holds
a
very sensitive
cryptographic
PrivateKey,
key information,
which is
optionally
stored in a protected format to prevent unauthorized access.
It
Typically, a key stored in this type of entry
is
also
a secret key, or a private key
accompanied by
a
the
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
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 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.
There are two ways to request a KeyStore object: by specifying either just a keystore type, or both a keystore type and a package provider.
KeyStore ks = KeyStore.getInstance(KeyStore.getDefaultType());The system will return a keystore implementation for the default type.
KeyStore ks = KeyStore.getInstance("JKS");
KeyStore ks = KeyStore.getInstance("JKS");The system will return the most preferred implementation of the specified keystore type available in the environment.KeyStore.getInstance("JKS", "SUN");
the system will determine if there is an implementation of the keystore type in the package requested, and throw an exception if there is not.
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 = new java.io.FileInputStream("keyStoreName"); ks.load(fis, password); 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, password); // store away the keystore java.io.FileOutputStream fos = new java.io.FileOutputStream("newKeyStoreName"); ks.store(fos, password); 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 Class Summary | |
---|---|
static class |
KeyStore.Builder
A description of a to-be-instantiated KeyStore object. |
static interface |
KeyStore.Entry
A marker interface for KeyStore entry types. |
static interface |
KeyStore.LoadStoreParameter
A marker interface for KeyStore load and store |
static class |
KeyStore.PasswordProtection
A password-based implementation of ProtectionParameter. |
static class |
KeyStore.PrivateKeyEntry
A KeyStore entry that holds a PrivateKey and corresponding certificate chain. |
static interface |
KeyStore.ProtectionParameter
A marker interface for keystore protection parameters. |
static class |
KeyStore.SecretKeyEntry
A KeyStore entry that holds a SecretKey. |
static class |
KeyStore.TrustedCertificateEntry
A KeyStore entry that holds a trusted Certificate. |
Constructor Summary | |
---|---|
protected |
KeyStore
(
KeyStoreSpi
keyStoreSpi,
Provider
provider,
String
type) Creates a KeyStore object of the given type, and encapsulates the given provider implementation (SPI object) in it. |
Method Summary | |
---|---|
Enumeration |
aliases
() Lists all the alias names of this keystore. |
boolean |
containsAlias
(
String
alias) Checks if the given alias exists in this keystore. |
void |
deleteEntry
(
String
alias) Deletes the entry identified by the given alias from this keystore. |
boolean |
entryInstanceOf
(
String
alias,
Class
Determines if the keystore Entry for the specified alias is an instance or subclass of the specified entryClass |
Certificate |
getCertificate
(
String
alias) Returns the certificate associated with the given alias. |
String |
getCertificateAlias
(
Certificate
cert) Returns the (alias) name of the first keystore entry whose certificate matches the given certificate. |
Certificate [] |
getCertificateChain
(
String
alias) Returns the certificate chain associated with the given alias. |
Date |
getCreationDate
(
String
alias) Returns the creation date of the entry identified by the given alias. |
static String |
getDefaultType
() 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. |
KeyStore.Entry |
getEntry
(
String
alias,
KeyStore.ProtectionParameter
Gets a keystore Entry for the specified alias with the specified protection parameter. |
static KeyStore |
getInstance
(
String
type) Generates a keystore object of the given type. |
static KeyStore |
getInstance
(
String
type,
Provider
provider) Generates a keystore object for the specified keystore type from the specified provider. |
static KeyStore |
getInstance
(
String
type,
String
provider) Generates a keystore object for the specified keystore type from the specified provider. |
Key |
getKey
(
String
alias, char[] password) Returns the key associated with the given alias, using the given password to recover it. |
Provider |
getProvider
() Returns the provider of this keystore. |
String |
getType
() Returns the type of this keystore. |
boolean |
isCertificateEntry
(
String
Returns true if the entry identified by the given alias was created by |
boolean |
isKeyEntry
(
String
Returns true if the entry identified by the given alias was created by |
void |
load
(
InputStream
stream, char[] password) Loads this KeyStore from the given input stream. |
void |
load
Loads this keystore using |
void |
setCertificateEntry
(
String
alias,
Certificate
Assigns the given trusted certificate to the given alias. |
void |
setEntry
(
String
alias,
KeyStore.Entry
entry,
KeyStore.ProtectionParameter
Saves a keystore Entry under the specified alias. |
void |
setKeyEntry
(
String
alias, byte[] key,
Certificate
[] chain) Assigns the given key (that has already been protected) to the given alias. |
void |
setKeyEntry
(
String
alias,
Key
key, char[] password,
Certificate
[] chain) Assigns the given key to the given alias, protecting it with the given password. |
int |
size
() Retrieves the number of entries in this keystore. |
void |
store
(
KeyStore.LoadStoreParameter
Stores this keystore using the given LoadStoreParameter. |
void |
store
(
OutputStream
stream, char[] password) Stores this keystore to the given output stream, and protects its integrity with the given password. |
Methods inherited from class java.lang. Object |
---|
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait |
Constructor Detail |
---|
protected KeyStore(KeyStoreSpi keyStoreSpi, Provider provider, String type)
Method Detail |
---|
public static KeyStore getInstance(String type) throws KeyStoreException
If the default provider package provides a keystore implementation of the given type, an instance of KeyStore containing that implementation is returned. If the requested keystore type is not available in the default package, other packages are searched.
public static KeyStore getInstance(String type, String provider) throws KeyStoreException, NoSuchProviderException
public static KeyStore getInstance(String type, Provider provider) throws KeyStoreException
public static final StringgetDefaultType ()
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.
public final Provider getProvider()
public final String getType()
public final Key getKey(String alias, char[] password) throws KeyStoreException, NoSuchAlgorithmException, UnrecoverableKeyException
public final Certificate[] getCertificateChain(String alias) throws KeyStoreException
public final Certificate getCertificate(String alias) throws KeyStoreException
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 a
trusted certificate entry
, the certificate associated with that entry is returned. If the given alias name identifies a
key entry
, the first element of the certificate chain of that entry is returned, or null if that entry does not have a certificate chain.
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.
public final Date getCreationDate(String alias) throws KeyStoreException
public final void setKeyEntry(String alias, Key key, char[] password, Certificate[] chain) throws KeyStoreException
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).
public final void setKeyEntry(String alias, byte[] key, Certificate[] chain) throws KeyStoreException
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).
public final void setCertificateEntry(String alias, Certificate cert) throws KeyStoreException
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.
If the given alias already exists in this keystore and identifies a
trusted certificate entry
, the certificate associated with it is overridden by the given certificate.
public final void deleteEntry(String alias) throws KeyStoreException
public final Enumeration aliases() throws KeyStoreException
public final boolean containsAlias(String alias) throws KeyStoreException
public final int size() throws KeyStoreException
public final boolean isKeyEntry(String alias) throws KeyStoreException
public final boolean isCertificateEntry(String alias) throws KeyStoreException
public final String getCertificateAlias(Certificate cert) throws KeyStoreException
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 is a
trusted certificate entry
, the given certificate is compared to that entry's certificate. If the entry being considered is a
key entry
, the given certificate is compared to the first element of that entry's certificate chain (if a chain exists).
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.
public final void store(OutputStream stream, char[] password) throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
public final void store ( KeyStore.LoadStoreParameter param) throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
public final void load(InputStream stream, char[] password) throws IOException, NoSuchAlgorithmException, CertificateException
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.
If a password is given, it is used to check the integrity of the keystore data. Otherwise, the integrity of the keystore is not checked.
In order to create an empty keystore, or if the keystore cannot be initialized from a
stream,
stream (e.g., because it is stored on a hardware token device), you
pass null as the stream argument.
Note that if this
keystore
KeyStore
has already been loaded, it is reinitialized and loaded again from the given input stream.
publicstaticfinal voidStringloadgetDefaultType( KeyStore.LoadStoreParameter param) throws IOException, NoSuchAlgorithmException, CertificateException()
Note that if this KeyStore has already been loaded, it is reinitialized and loaded again from the given parameter.
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.
public final KeyStore.EntrygetEntry ( String alias, KeyStore.ProtectionParameter protParam) throws NoSuchAlgorithmException, UnrecoverableEntryException, KeyStoreException
public final void setEntry ( String alias, KeyStore.Entry entry, KeyStore.ProtectionParameter protParam) throws KeyStoreException
If an entry already exists for the specified alias, it is overridden.
public final boolean entryInstanceOf ( String alias, Class entryClass) throws KeyStoreException