public classKeyStoreextendsObject
AKeyStore manages different types of entries. Each type of entry implements theKeyStore.Entry interface. Three basicKeyStore.Entry implementations are provided:
This type of entry holds a cryptographicPrivateKey, 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 cryptographicSecretKey, which is optionally stored in a protected format to prevent unauthorized access.
This type of entry contains a single public keyCertificate belonging to another party. It is called atrusted certificate because the keystore owner trusts that the public key in the certificate indeed belongs to the identity identified by thesubject (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 beloaded.
KeyStore ks = KeyStore.getInstance(KeyStore.getDefaultType()); // get user password and file input stream char[] password = getPassword(); try (FileInputStream fis = new FileInputStream("keyStoreName")) { ks.load(fis, password); } To create an empty keystore using the aboveload method, passnull as theInputStream 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:
KeyStore.ProtectionParameter protParam = new KeyStore.PasswordProtection(password); // get my private key KeyStore.PrivateKeyEntry pkEntry = (KeyStore.PrivateKeyEntry) ks.getEntry("privateKeyAlias", protParam); PrivateKey myPrivateKey = pkEntry.getPrivateKey(); // save my secret key javax.crypto.SecretKey mySecretKey; KeyStore.SecretKeyEntry skEntry = new KeyStore.SecretKeyEntry(mySecretKey); ks.setEntry("secretKeyAlias", skEntry, protParam); // store away the keystore try (FileOutputStream fos = new FileOutputStream("newKeyStoreName")) { ks.store(fos, password); } 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. Every implementation of the Java platform is required to support the following standardKeyStore type:
PKCS12PrivateKey,SecretKey,Certificate| Modifier and Type | Class | Description |
|---|---|---|
static class | KeyStore.Builder | A description of a to-be-instantiated KeyStore object. |
static class | KeyStore.CallbackHandlerProtection | A ProtectionParameter encapsulating a CallbackHandler. |
static interface | KeyStore.Entry | A marker interface for KeyStore entry types. |
static interface | KeyStore.LoadStoreParameter | |
static class | KeyStore.PasswordProtection | A password-based implementation of ProtectionParameter. |
static class | KeyStore.PrivateKeyEntry | A KeyStore entry that holds aPrivateKey and corresponding certificate chain. |
static interface | KeyStore.ProtectionParameter | A marker interface for keystore protection parameters. |
static class | KeyStore.SecretKeyEntry | A KeyStore entry that holds aSecretKey. |
static class | KeyStore.TrustedCertificateEntry | A KeyStore entry that holds a trustedCertificate. |
| Modifier | Constructor | Description |
|---|---|---|
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. |
| Modifier and Type | Method | Description |
|---|---|---|
Enumeration<String> | 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<? extendsKeyStore.Entry> entryClass) | Determines if the keystore Entry for the specifiedalias is an instance or subclass of the specifiedentryClass. |
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. |
staticString | getDefaultType() | Returns the default keystore type as specified by the keystore.type security property, or the string "jks" (acronym for "Java keystore") if no such property exists. |
KeyStore.Entry | getEntry(String alias,KeyStore.ProtectionParameter protParam) | Gets a keystore Entry for the specified alias with the specified protection parameter. |
staticKeyStore | getInstance(String type) | Returns a keystore object of the specified type. |
staticKeyStore | getInstance(String type,Provider provider) | Returns a keystore object of the specified type. |
staticKeyStore | getInstance(String type,String provider) | Returns a keystore object of the specified type. |
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 alias) | Returns true if the entry identified by the given alias was created by a call to setCertificateEntry, or created by a call tosetEntry with aTrustedCertificateEntry. |
boolean | isKeyEntry(String alias) | Returns true if the entry identified by the given alias was created by a call to setKeyEntry, or created by a call tosetEntry with aPrivateKeyEntry or aSecretKeyEntry. |
void | load(InputStream stream, char[] password) | Loads this KeyStore from the given input stream. |
void | load(KeyStore.LoadStoreParameter param) | Loads this keystore using the given LoadStoreParameter. |
void | setCertificateEntry(String alias,Certificate cert) | Assigns the given trusted certificate to the given alias. |
void | setEntry(String alias,KeyStore.Entry entry,KeyStore.ProtectionParameter protParam) | 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 param) | 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. |
protected KeyStore(KeyStoreSpi keyStoreSpi,Provider provider,String type)
keyStoreSpi - the provider implementation.provider - the provider.type - the keystore type.public static KeyStore getInstance(String type) throwsKeyStoreException
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 theSecurity.getProviders() method.
type - the type of keystore. See the KeyStore section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard keystore types.KeyStoreException - if no Provider supports a KeyStoreSpi implementation for the specified type.Providerpublic static KeyStore getInstance(String type,String provider) throwsKeyStoreException,NoSuchProviderException
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 theSecurity.getProviders() method.
type - the type of keystore. See the KeyStore section in the Java Cryptography Architecture Standard Algorithm Name Documentation 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.Providerpublic static KeyStore getInstance(String type,Provider provider) throwsKeyStoreException
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 the KeyStore section in the Java Cryptography Architecture Standard Algorithm Name Documentation 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.Providerpublic static final String getDefaultType()
keystore.type security property, or the string "jks" (acronym for "Java keystore") if no such property exists.The default keystore type can be used by applications that do not want to use a hard-coded keystore type when calling one of thegetInstance 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 thekeystore.type security property to the desired keystore type.
keystore.type security property, or the string "jks" if no such property exists.security propertiespublic final Provider getProvider()
public final String getType()
public final Key getKey(String alias, char[] password) throwsKeyStoreException,NoSuchAlgorithmException,UnrecoverableKeyException
setKeyEntry, or by a call tosetEntry with aPrivateKeyEntry orSecretKeyEntry.alias - the alias namepassword - the password for recovering the keyKeyStoreException - if the keystore has not been initialized (loaded).NoSuchAlgorithmException - if the algorithm for recovering the key cannot be foundUnrecoverableKeyException - if the key cannot be recovered (e.g., the given password is wrong).public final Certificate[] getCertificateChain(String alias) throwsKeyStoreException
setKeyEntry, or by a call tosetEntry with aPrivateKeyEntry.alias - the alias nameKeyStoreException - if the keystore has not been initialized (loaded).public final Certificate getCertificate(String alias) throwsKeyStoreException
If the given alias name identifies an entry created by a call tosetCertificateEntry, or created by a call tosetEntry with aTrustedCertificateEntry, then the trusted certificate contained in that entry is returned.
If the given alias name identifies an entry created by a call tosetKeyEntry, or created by a call tosetEntry with aPrivateKeyEntry, then the first element of the certificate chain in that entry is returned.
alias - the alias nameKeyStoreException - if the keystore has not been initialized (loaded).public final Date getCreationDate(String alias) throwsKeyStoreException
alias - the alias nameKeyStoreException - if the keystore has not been initialized (loaded).public final void setKeyEntry(String alias,Key key, char[] password,Certificate[] chain) throwsKeyStoreException
If the given key is of typejava.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 namekey - the key to be associated with the aliaspassword - the password to protect the keychain - the certificate chain for the corresponding public key (only required if the given key is of typejava.security.PrivateKey).KeyStoreException - if the keystore has not been initialized (loaded), the given key cannot be protected, or this operation fails for some other reasonpublic final void setKeyEntry(String alias, byte[] key,Certificate[] chain) throwsKeyStoreException
If the protected key is of typejava.security.PrivateKey, it must be accompanied by a certificate chain certifying the corresponding public key. If the underlying keystore implementation is of typejks,key must be encoded as anEncryptedPrivateKeyInfo 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 namekey - the key (in protected format) to be associated with the aliaschain - the certificate chain for the corresponding public key (only useful if the protected key is of typejava.security.PrivateKey).KeyStoreException - if the keystore has not been initialized (loaded), or if this operation fails for some other reason.public final void setCertificateEntry(String alias,Certificate cert) throwsKeyStoreException
If the given alias identifies an existing entry created by a call tosetCertificateEntry, or created by a call tosetEntry with aTrustedCertificateEntry, the trusted certificate in the existing entry is overridden by the given certificate.
alias - the alias namecert - the certificateKeyStoreException - 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.public final void deleteEntry(String alias) throwsKeyStoreException
alias - the alias nameKeyStoreException - if the keystore has not been initialized, or if the entry cannot be removed.public final Enumeration<String> aliases() throwsKeyStoreException
KeyStoreException - if the keystore has not been initialized (loaded).public final boolean containsAlias(String alias) throwsKeyStoreException
alias - the alias nameKeyStoreException - if the keystore has not been initialized (loaded).public final int size() throwsKeyStoreException
KeyStoreException - if the keystore has not been initialized (loaded).public final boolean isKeyEntry(String alias) throwsKeyStoreException
setKeyEntry, or created by a call tosetEntry with aPrivateKeyEntry or aSecretKeyEntry.alias - the alias for the keystore entry to be checkedKeyStoreException - if the keystore has not been initialized (loaded).public final boolean isCertificateEntry(String alias) throwsKeyStoreException
setCertificateEntry, or created by a call tosetEntry with aTrustedCertificateEntry.alias - the alias for the keystore entry to be checkedKeyStoreException - if the keystore has not been initialized (loaded).public final String getCertificateAlias(Certificate cert) throwsKeyStoreException
This method attempts to match the given certificate with each keystore entry. If the entry being considered was created by a call tosetCertificateEntry, or created by a call tosetEntry with aTrustedCertificateEntry, then the given certificate is compared to that entry's certificate.
If the entry being considered was created by a call tosetKeyEntry, or created by a call tosetEntry with aPrivateKeyEntry, 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).public final void store(OutputStream stream, char[] password) throwsKeyStoreException,IOException,NoSuchAlgorithmException,CertificateException
stream - the output stream to which this keystore is written.password - the password to generate the keystore integrity checkKeyStoreException - if the keystore has not been initialized (loaded).IOException - if there was an I/O problem with dataNoSuchAlgorithmException - if the appropriate data integrity algorithm could not be foundCertificateException - if any of the certificates included in the keystore data could not be storedpublic final void store(KeyStore.LoadStoreParameter param) throwsKeyStoreException,IOException,NoSuchAlgorithmException,CertificateException
LoadStoreParameter.param - theLoadStoreParameter that specifies how to store the keystore, which may benullIllegalArgumentException - if the givenLoadStoreParameter input is not recognizedKeyStoreException - if the keystore has not been initialized (loaded)IOException - if there was an I/O problem with dataNoSuchAlgorithmException - if the appropriate data integrity algorithm could not be foundCertificateException - if any of the certificates included in the keystore data could not be storedpublic final void load(InputStream stream, char[] password) throwsIOException,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.
In order to create an empty keystore, or if the keystore cannot be initialized from a stream, passnull as thestream 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, ornullpassword - the password used to check the integrity of the keystore, the password used to unlock the keystore, ornullIOException - 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, thecause of theIOException should be anUnrecoverableKeyExceptionNoSuchAlgorithmException - if the algorithm used to check the integrity of the keystore cannot be foundCertificateException - if any of the certificates in the keystore could not be loadedpublic final void load(KeyStore.LoadStoreParameter param) throwsIOException,NoSuchAlgorithmException,CertificateException
LoadStoreParameter.Note that if this KeyStore has already been loaded, it is reinitialized and loaded again from the given parameter.
param - theLoadStoreParameter that specifies how to load the keystore, which may benullIllegalArgumentException - if the givenLoadStoreParameter input is not recognizedIOException - if there is an I/O or format problem with the keystore data. If the error is due to an incorrectProtectionParameter (e.g. wrong password) thecause of theIOException should be anUnrecoverableKeyExceptionNoSuchAlgorithmException - if the algorithm used to check the integrity of the keystore cannot be foundCertificateException - if any of the certificates in the keystore could not be loadedpublic final KeyStore.Entry getEntry(String alias,KeyStore.ProtectionParameter protParam) throwsNoSuchAlgorithmException,UnrecoverableEntryException,KeyStoreException
Entry for the specified alias with the specified protection parameter.alias - get the keystoreEntry for this aliasprotParam - theProtectionParameter used to protect theEntry, which may benullEntry for the specified alias, ornull if there is no such entryNullPointerException - ifalias isnullNoSuchAlgorithmException - if the algorithm for recovering the entry cannot be foundUnrecoverableEntryException - if the specifiedprotParam were insufficient or invalidUnrecoverableKeyException - if the entry is aPrivateKeyEntry orSecretKeyEntry and the specifiedprotParam does not contain the information needed to recover the key (e.g. wrong password)KeyStoreException - if the keystore has not been initialized (loaded).setEntry(String, KeyStore.Entry, KeyStore.ProtectionParameter)public final void setEntry(String alias,KeyStore.Entry entry,KeyStore.ProtectionParameter protParam) throwsKeyStoreException
Entry under the specified alias. The protection parameter is used to protect theEntry.If an entry already exists for the specified alias, it is overridden.
alias - save the keystoreEntry under this aliasentry - theEntry to saveprotParam - theProtectionParameter used to protect theEntry, which may benullNullPointerException - ifalias orentry isnullKeyStoreException - if the keystore has not been initialized (loaded), or if this operation fails for some other reasongetEntry(String, KeyStore.ProtectionParameter)public final boolean entryInstanceOf(String alias,Class<? extendsKeyStore.Entry> entryClass) throwsKeyStoreException
Entry for the specifiedalias is an instance or subclass of the specifiedentryClass.alias - the alias nameentryClass - the entry classEntry for the specifiedalias is an instance or subclass of the specifiedentryClass, false otherwiseNullPointerException - ifalias orentryClass isnullKeyStoreException - if the keystore has not been initialized (loaded)