Module ibm.crypto.hdwrcca
Package com.ibm.crypto.hdwrCCA.provider

Class JceCCAKeyStore

java.lang.Object
java.security.KeyStoreSpi
com.ibm.crypto.hdwrCCA.provider.JceCCAKeyStore
public final class JceCCAKeyStore extends KeyStoreSpi
This class provides the keystore implementation referred to as "JCECCAKS". 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.
See Also:

  • Constructor Details

    • JceCCAKeyStore

      public JceCCAKeyStore()
      Constructor

  • Method Details

    • engineGetKey

      public Key engineGetKey(String alias, char[] password) throws NoSuchAlgorithmException, UnrecoverableKeyException
      Returns a clone of the key associated with the given alias, using the given password to recover it.

      Note that this method returns a clone of sensitive information. It is the caller's responsibility to zero out the information after it is no longer needed.

      Specified by:
      engineGetKey in class KeyStoreSpi
      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).

    • engineGetCertificateChain

      public Certificate[] engineGetCertificateChain(String alias)
      Returns the certificate chain associated with the given alias.
      Specified by:
      engineGetCertificateChain in class KeyStoreSpi
      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).

    • engineGetCertificate

      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.

      Specified by:
      engineGetCertificate in class 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 Date engineGetCreationDate(String alias)
      Returns the creation date of the entry identified by the given alias.
      Specified by:
      engineGetCreationDate in class KeyStoreSpi
      Parameters:
      alias - the alias name
      Returns:
      the creation date of this entry, or null if the given alias does not exist

    • engineSetKeyEntry

      public void engineSetKeyEntry(String alias, Key key, char[] password, Certificate[] chain) throws KeyStoreException
      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.

      Also, if the given key is a software key that implements one of the following interfaces RSAPrivateKey, RSAPrivateCrtKey, or DSAPrivateKey then the key will be migrated to a hardware key usable by the IBMJCECCA provider.

      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 KeyStoreSpi
      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 or key is of unknown instance.

    • engineSetKeyEntry

      public void engineSetKeyEntry(String alias, byte[] key, Certificate[] chain) throws KeyStoreException
      This an unsupported function, because hardware does not support key encodings. Therefore, the method always throws a KeyStoreException.
      Specified by:
      engineSetKeyEntry in class KeyStoreSpi
      Throws:
      KeyStoreException - is always thrown.

    • engineSetCertificateEntry

      public void engineSetCertificateEntry(String alias, Certificate cert) throws 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 KeyStoreSpi
      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.

    • engineDeleteEntry

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

    • engineAliases

      public Enumeration<String> engineAliases()
      Lists all the alias names of this keystore.
      Specified by:
      engineAliases in class KeyStoreSpi
      Returns:
      enumeration of the alias names

    • engineContainsAlias

      public boolean engineContainsAlias(String alias)
      Checks if the given alias exists in this keystore.
      Specified by:
      engineContainsAlias in class 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 KeyStoreSpi
      Returns:
      the number of entries in this keystore

    • engineIsKeyEntry

      public boolean engineIsKeyEntry(String alias)
      Returns true if the entry identified by the given alias is a key entry, and false otherwise.
      Specified by:
      engineIsKeyEntry in class KeyStoreSpi
      Returns:
      true if the entry identified by the given alias is a key entry, false otherwise.

    • engineIsCertificateEntry

      public boolean engineIsCertificateEntry(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 KeyStoreSpi
      Returns:
      true if the entry identified by the given alias is a trusted certificate entry, false otherwise.

    • engineGetCertificateAlias

      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).

      Specified by:
      engineGetCertificateAlias in class 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(OutputStream stream, char[] password) throws IOException, NoSuchAlgorithmException, CertificateException
      Stores this keystore to the given output stream, and protects its integrity with the given password.
      Specified by:
      engineStore in class KeyStoreSpi
      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

    • engineLoad

      public void engineLoad(InputStream stream, char[] password) throws IOException, NoSuchAlgorithmException, 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 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:
      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