Class JceRACFKeyStore


  • public final class JceRACFKeyStore
    extends java.security.KeyStoreSpi
    This class provides the keystore implementation referred to as "JCERACFKS". 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.
    Version:
    1.14.1.4 updated on 14/11/14 at 10:38:25
    See Also:
    KeyStoreSpi
    • Constructor Summary

      Constructors 
      Constructor Description
      JceRACFKeyStore()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Enumeration 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[] passwd)
      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 engineSetEntry​(java.lang.String alias, java.security.KeyStore.Entry entry, java.security.KeyStore.ProtectionParameter protParam)
      Saves a KeyStore.Entry under the specified alias.
      void engineSetKeyEntry​(java.lang.String alias, byte[] key, java.security.cert.Certificate[] chain)
      This an unsupported function, because key encodings are not supported.
      void engineSetKeyEntry​(java.lang.String alias, java.security.Key key, char[] passwd, java.security.cert.Certificate[] chain)
      Assigns the given key to the given alias, protecting it with the given password.
      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.
      • Methods inherited from class java.security.KeyStoreSpi

        engineEntryInstanceOf, engineGetEntry, engineLoad, engineProbe, engineStore
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • JceRACFKeyStore

        public JceRACFKeyStore()
    • Method Detail

      • engineGetKey

        public java.security.Key engineGetKey​(java.lang.String alias,
                                              char[] passwd)
                                       throws java.security.NoSuchAlgorithmException,
                                              java.security.UnrecoverableKeyException
        Returns the key associated with the given alias, using the given password to recover it.
        Specified by:
        engineGetKey in class java.security.KeyStoreSpi
        Parameters:
        alias - the alias name
        passwd - 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:
        java.security.NoSuchAlgorithmException - if the algorithm for recovering the key cannot be found.
        java.security.UnrecoverableKeyException - if the key cannot be recovered (e.g., the given password is wrong).
      • engineGetCertificateChain

        public java.security.cert.Certificate[] engineGetCertificateChain​(java.lang.String alias)
        Returns the certificate chain associated with the given alias.
        Specified by:
        engineGetCertificateChain in class java.security.KeyStoreSpi
        Parameters:
        alias - the alias name
        Returns:
        the certificate chain (ordered with the user's certificate first followed by zero or more certificate authorities), or null if the given alias does not exist or does not contain a certificate chain (i.e., the given alias identifies a key entry without a certificate chain).
      • engineGetCertificate

        public java.security.cert.Certificate engineGetCertificate​(java.lang.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.

        Specified by:
        engineGetCertificate in class java.security.KeyStoreSpi
        Parameters:
        alias - the alias name
        Returns:
        the certificate, or null if the given alias does not exist or does not contain a certificate.
      • engineGetCreationDate

        public java.util.Date engineGetCreationDate​(java.lang.String alias)
        Returns the creation date of the entry identified by the given alias.
        Specified by:
        engineGetCreationDate in class java.security.KeyStoreSpi
        Parameters:
        alias - the alias name
        Returns:
        the creation date of this entry, or null if the given alias does not exist.
      • engineSetEntry

        public void engineSetEntry​(java.lang.String alias,
                                   java.security.KeyStore.Entry entry,
                                   java.security.KeyStore.ProtectionParameter protParam)
                            throws java.security.KeyStoreException
        Saves a KeyStore.Entry under the specified alias. The specified protection parameter is used to protect the KeyStore.Entry.
        Overrides:
        engineSetEntry in class java.security.KeyStoreSpi
        Parameters:
        alias - save the keystore KeyStore.Entry under this alias (mixed case supported)
        entry - the KeyStore.Entry to save
        protParam - the KeyStore.ProtectionParameter used to protect the KeyStore.Entry, which may be null
        Throws:
        java.security.KeyStoreException - if an entry already exists for this alias or this operation fails for some other reason.
      • engineSetKeyEntry

        public void engineSetKeyEntry​(java.lang.String alias,
                                      java.security.Key key,
                                      char[] passwd,
                                      java.security.cert.Certificate[] chain)
                               throws java.security.KeyStoreException
        Assigns the given key to the given alias, protecting it with the given password.

        If the given key is of type 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).

        Specified by:
        engineSetKeyEntry in class java.security.KeyStoreSpi
        Parameters:
        alias - the alias name
        key - the key to be associated with the alias
        passwd - the password to protect the key
        chain - the certificate chain for the corresponding public key
        Throws:
        java.security.KeyStoreException - if the given key cannot be protected, or this operation fails for some other reason.
      • engineSetKeyEntry

        public void engineSetKeyEntry​(java.lang.String alias,
                                      byte[] key,
                                      java.security.cert.Certificate[] chain)
                               throws java.security.KeyStoreException
        This an unsupported function, because key encodings are not supported. This method always throws a KeyStoreException.
        Specified by:
        engineSetKeyEntry in class java.security.KeyStoreSpi
        Parameters:
        alias - the alias name
        key - the key to be associated with the alias
        chain - the certificate chain for the corresponding public key
        Throws:
        java.security.KeyStoreException - is always thrown.
      • engineSetCertificateEntry

        public void engineSetCertificateEntry​(java.lang.String alias,
                                              java.security.cert.Certificate cert)
                                       throws java.security.KeyStoreException
        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.
        Specified by:
        engineSetCertificateEntry in class java.security.KeyStoreSpi
        Parameters:
        alias - the alias name
        cert - the certificate
        Throws:
        java.security.KeyStoreException - if the given alias already exists and does not identify a trusted certificate entry, or this operation fails for some other reason.
      • engineDeleteEntry

        public void engineDeleteEntry​(java.lang.String alias)
                               throws java.security.KeyStoreException
        Deletes the entry identified by the given alias from this keystore.
        Specified by:
        engineDeleteEntry in class java.security.KeyStoreSpi
        Parameters:
        alias - the alias name
        Throws:
        java.security.KeyStoreException - if the entry cannot be removed.
      • engineAliases

        public java.util.Enumeration engineAliases()
        Lists all the alias names of this keystore.
        Specified by:
        engineAliases in class java.security.KeyStoreSpi
        Returns:
        enumeration of the alias names.
      • engineContainsAlias

        public boolean engineContainsAlias​(java.lang.String alias)
        Checks if the given alias exists in this keystore.
        Specified by:
        engineContainsAlias in class java.security.KeyStoreSpi
        Parameters:
        alias - the alias name
        Returns:
        true if the alias exists, false otherwise.
      • engineSize

        public int engineSize()
        Retrieves the number of entries in this keystore.
        Specified by:
        engineSize in class java.security.KeyStoreSpi
        Returns:
        the number of entries in this keystore.
      • engineIsKeyEntry

        public boolean engineIsKeyEntry​(java.lang.String alias)
        Returns true if the entry identified by the given alias is a key entry, and false otherwise.
        Specified by:
        engineIsKeyEntry in class java.security.KeyStoreSpi
        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.
      • engineIsCertificateEntry

        public boolean engineIsCertificateEntry​(java.lang.String alias)
        Returns true if the entry identified by the given alias is a trusted certificate entry, and false otherwise.
        Specified by:
        engineIsCertificateEntry in class java.security.KeyStoreSpi
        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.
      • engineGetCertificateAlias

        public java.lang.String engineGetCertificateAlias​(java.security.cert.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).

        Specified by:
        engineGetCertificateAlias in class java.security.KeyStoreSpi
        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.
      • engineStore

        public void engineStore​(java.io.OutputStream stream,
                                char[] password)
                         throws java.io.IOException,
                                java.security.NoSuchAlgorithmException,
                                java.security.cert.CertificateException
        Stores this keystore to the given output stream, and protects its integrity with the given password.
        Specified by:
        engineStore in class java.security.KeyStoreSpi
        Parameters:
        stream - the output stream to which this keystore is written
        password - the password to generate the keystore integrity check
        Throws:
        java.io.IOException - if there was an I/O problem with data.
        java.security.NoSuchAlgorithmException - if the appropriate data integrity algorithm could not be found.
        java.security.cert.CertificateException - if any of the certificates included in the keystore data could not be stored.
      • engineLoad

        public void engineLoad​(java.io.InputStream stream,
                               char[] password)
                        throws java.io.IOException,
                               java.security.NoSuchAlgorithmException,
                               java.security.cert.CertificateException
        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.

        Specified by:
        engineLoad in class java.security.KeyStoreSpi
        Parameters:
        stream - the input stream from which the keystore is loaded
        password - the (optional) password used to check the integrity of the keystore
        Throws:
        java.io.IOException - if there is an I/O or format problem with the keystore data.
        java.security.NoSuchAlgorithmException - if the algorithm used to check the integrity of the keystore cannot be found.
        java.security.cert.CertificateException - if any of the certificates in the keystore could not be loaded.