public abstract class JavaKeyStore
extends java.security.KeyStoreSpi
KeyProtector,
KeyStoreSpi| Modifier and Type | Class and Description |
|---|---|
static class |
JavaKeyStore.CaseExactJKS |
static class |
JavaKeyStore.DualFormatJKS |
static class |
JavaKeyStore.JKS |
| Modifier and Type | Method and Description |
|---|---|
java.util.Enumeration<java.lang.String> |
engineAliases()
Lists all the alias names of this keystore.
|
boolean |
engineContainsAlias(java.lang.String alias)
Checks if the given alias exists in this keystore.
|
void |
engineDeleteEntry(java.lang.String alias)
Deletes the entry identified by the given alias from this keystore.
|
java.security.cert.Certificate |
engineGetCertificate(java.lang.String alias)
Returns the certificate associated with the given alias.
|
java.lang.String |
engineGetCertificateAlias(java.security.cert.Certificate cert)
Returns the (alias) name of the first keystore entry whose certificate
matches the given certificate.
|
java.security.cert.Certificate[] |
engineGetCertificateChain(java.lang.String alias)
Returns the certificate chain associated with the given alias.
|
java.util.Date |
engineGetCreationDate(java.lang.String alias)
Returns the creation date of the entry identified by the given alias.
|
java.security.Key |
engineGetKey(java.lang.String alias,
char[] password)
Returns the key associated with the given alias, using the given
password to recover it.
|
boolean |
engineIsCertificateEntry(java.lang.String alias)
Returns true if the entry identified by the given alias is a
trusted certificate entry, and false otherwise.
|
boolean |
engineIsKeyEntry(java.lang.String alias)
Returns true if the entry identified by the given alias is a
key entry, and false otherwise.
|
void |
engineLoad(java.io.InputStream stream,
char[] password)
Loads the keystore from the given input stream.
|
void |
engineSetCertificateEntry(java.lang.String alias,
java.security.cert.Certificate cert)
Assigns the given certificate to the given alias.
|
void |
engineSetKeyEntry(java.lang.String alias,
byte[] key,
java.security.cert.Certificate[] chain)
Assigns the given key (that has already been protected) to the given
alias.
|
void |
engineSetKeyEntry(java.lang.String alias,
java.security.Key key,
char[] password,
java.security.cert.Certificate[] chain)
Assigns the given private key to the given alias, protecting
it with the given password as defined in PKCS8.
|
int |
engineSize()
Retrieves the number of entries in this keystore.
|
void |
engineStore(java.io.OutputStream stream,
char[] password)
Stores this keystore to the given output stream, and protects its
integrity with the given password.
|
public java.security.Key engineGetKey(java.lang.String alias,
char[] password)
throws java.security.NoSuchAlgorithmException,
java.security.UnrecoverableKeyException
engineGetKey in class java.security.KeyStoreSpialias - the alias namepassword - the password for recovering the keyjava.security.NoSuchAlgorithmException - if the algorithm for recovering the
key cannot be foundjava.security.UnrecoverableKeyException - if the key cannot be recovered
(e.g., the given password is wrong).public java.security.cert.Certificate[] engineGetCertificateChain(java.lang.String alias)
engineGetCertificateChain in class java.security.KeyStoreSpialias - the alias namepublic java.security.cert.Certificate engineGetCertificate(java.lang.String 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.
engineGetCertificate in class java.security.KeyStoreSpialias - the alias namepublic java.util.Date engineGetCreationDate(java.lang.String alias)
engineGetCreationDate in class java.security.KeyStoreSpialias - the alias namepublic void engineSetKeyEntry(java.lang.String alias,
java.security.Key key,
char[] password,
java.security.cert.Certificate[] chain)
throws java.security.KeyStoreException
The given java.security.PrivateKey key 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 certificate chain.
engineSetKeyEntry in class java.security.KeyStoreSpialias - the alias namekey - the private 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 type
java.security.PrivateKey).java.security.KeyStoreException - if the given key is not a private key,
cannot be protected, or this operation fails for some other reasonpublic void engineSetKeyEntry(java.lang.String alias,
byte[] key,
java.security.cert.Certificate[] chain)
throws java.security.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).
engineSetKeyEntry in class java.security.KeyStoreSpialias - 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 type
java.security.PrivateKey).java.security.KeyStoreException - if this operation fails.public void engineSetCertificateEntry(java.lang.String alias,
java.security.cert.Certificate cert)
throws java.security.KeyStoreException
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.
engineSetCertificateEntry in class java.security.KeyStoreSpialias - the alias namecert - the certificatejava.security.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 engineDeleteEntry(java.lang.String alias)
throws java.security.KeyStoreException
engineDeleteEntry in class java.security.KeyStoreSpialias - the alias namejava.security.KeyStoreException - if the entry cannot be removed.public java.util.Enumeration<java.lang.String> engineAliases()
engineAliases in class java.security.KeyStoreSpipublic boolean engineContainsAlias(java.lang.String alias)
engineContainsAlias in class java.security.KeyStoreSpialias - the alias namepublic int engineSize()
engineSize in class java.security.KeyStoreSpipublic boolean engineIsKeyEntry(java.lang.String alias)
engineIsKeyEntry in class java.security.KeyStoreSpipublic boolean engineIsCertificateEntry(java.lang.String alias)
engineIsCertificateEntry in class java.security.KeyStoreSpipublic java.lang.String engineGetCertificateAlias(java.security.cert.Certificate cert)
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).
engineGetCertificateAlias in class java.security.KeyStoreSpicert - the certificate to match with.public void engineStore(java.io.OutputStream stream,
char[] password)
throws java.io.IOException,
java.security.NoSuchAlgorithmException,
java.security.cert.CertificateException
engineStore in class java.security.KeyStoreSpistream - the output stream to which this keystore is written.password - the password to generate the keystore integrity checkjava.io.IOException - if there was an I/O problem with datajava.security.NoSuchAlgorithmException - if the appropriate data integrity
algorithm could not be foundjava.security.cert.CertificateException - if any of the certificates included in
the keystore data could not be storedpublic void engineLoad(java.io.InputStream stream,
char[] password)
throws java.io.IOException,
java.security.NoSuchAlgorithmException,
java.security.cert.CertificateException
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.
engineLoad in class java.security.KeyStoreSpistream - the input stream from which the keystore is loadedpassword - the (optional) password used to check the integrity of
the keystore.java.io.IOException - if there is an I/O or format problem with the
keystore datajava.security.NoSuchAlgorithmException - if the algorithm used to check
the integrity of the keystore cannot be foundjava.security.cert.CertificateException - if any of the certificates in the
keystore could not be loaded