| java.lang.Object | ||
| ↳ | java.security.KeyStoreSpi | |
| ↳ | com.sun.crypto.provider.JceKeyStore | |
Class Overview
This class provides the keystore implementation referred to as "jceks".
This implementation strongly protects the keystore private keys using
triple-DES, where the triple-DES encryption/decryption key is derived from
the user's password.
The encrypted private keys are stored in the keystore in a standard format,
namely the EncryptedPrivateKeyInfo format defined in PKCS #8.
See Also
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 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.
| |||||||||||
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 key associated with the given alias, using the given
password to recover it.
| |||||||||||
Returns true if the entry identified by the given alias is a
trusted certificate entry, and false otherwise.
| |||||||||||
Returns true if the entry identified by the given alias is a
key entry, and false otherwise.
| |||||||||||
Loads the keystore from the given input stream.
| |||||||||||
Assigns the given certificate to the given 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.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.security.KeyStoreSpi
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Public Constructors
public JceKeyStore ()
Public Methods
public Enumeration engineAliases ()
Lists all the alias names of this keystore.
Returns
- enumeration of the alias names
public boolean engineContainsAlias (String alias)
Checks if the given alias exists in this keystore.
Parameters
| alias | the alias name |
|---|
Returns
- true if the alias exists, false otherwise
public void engineDeleteEntry (String alias)
Deletes the entry identified by the given alias from this keystore.
Parameters
| alias | the alias name |
|---|
Throws
| KeyStoreException | if the entry cannot be removed. |
|---|
public Certificate engineGetCertificate (String alias)
Returns the certificate associated with the given alias.
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.
Parameters
| alias | the alias name |
|---|
Returns
- the certificate, or null if the given alias does not exist or does not contain a certificate.
public String engineGetCertificateAlias (Certificate cert)
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 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).
Parameters
| cert | the certificate to match with. |
|---|
Returns
- the (alias) name of the first entry with matching certificate, or null if no such entry exists in this keystore.
public Certificate[] engineGetCertificateChain (String alias)
Returns the certificate chain associated with the given alias.
Parameters
| alias | the alias name |
|---|
Returns
- the certificate chain (ordered with the user's certificate first and the root certificate authority last), or null if the given alias does not exist or does not contain a certificate chain (i.e., the given alias identifies either a trusted certificate entry or a key entry without a certificate chain).
public Date engineGetCreationDate (String alias)
Returns the creation date of the entry identified by the given alias.
Parameters
| alias | the alias name |
|---|
Returns
- the creation date of this entry, or null if the given alias does not exist
public Key engineGetKey (String alias, char[] password)
Returns the key associated with the given alias, using the given password to recover it.
Parameters
| alias | the alias name |
|---|---|
| password | the password for recovering the key |
Returns
- the requested key, or null if the given alias does not exist or does not identify a key entry.
Throws
| 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). |
public boolean engineIsCertificateEntry (String alias)
Returns true if the entry identified by the given alias is a trusted certificate entry, and false otherwise.
Parameters
| alias | the alias for the keystore entry to be checked |
|---|
Returns
- true if the entry identified by the given alias is a trusted certificate entry, false otherwise.
public boolean engineIsKeyEntry (String alias)
Returns true if the entry identified by the given alias is a key entry, and false otherwise.
Parameters
| alias | the alias for the keystore entry to be checked |
|---|
Returns
- true if the entry identified by the given alias is a key entry, false otherwise.
public void engineLoad (InputStream stream, char[] password)
Loads the keystore from the given input stream.
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.
Parameters
| stream | the input stream from which the keystore is loaded |
|---|---|
| password | the (optional) password used to check the integrity of the keystore. |
Throws
| IOException | if there is an I/O or format problem with the keystore data |
|---|---|
| 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 |
public void engineSetCertificateEntry (String alias, Certificate cert)
Assigns the given certificate to the given alias.
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.
Parameters
| alias | the alias name |
|---|---|
| cert | the certificate |
Throws
| KeyStoreException | if the given alias already exists and does not identify a trusted certificate entry, or this operation fails for some other reason. |
|---|
public void engineSetKeyEntry (String alias, Key key, char[] password, Certificate[] chain)
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).
Parameters
| 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). |
Throws
| KeyStoreException | if the given key cannot be protected, or this operation fails for some other reason |
|---|
public void engineSetKeyEntry (String alias, byte[] key, Certificate[] chain)
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 given alias already exists, the keystore information associated with it is overridden by the given key (and possibly certificate chain).
Parameters
| 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). |
Throws
| KeyStoreException | if this operation fails. |
|---|
public int engineSize ()
Retrieves the number of entries in this keystore.
Returns
- the number of entries in this keystore
public void engineStore (OutputStream stream, char[] password)
Stores this keystore to the given output stream, and protects its integrity with the given password.
Parameters
| stream | the output stream to which this keystore is written. |
|---|---|
| password | the password to generate the keystore integrity check |
Throws
| 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 |