Interface KeyStoreParam

  • All Known Implementing Classes:
    AbstractKeyStoreParam, DefaultKeyStoreParam

    public interface KeyStoreParam
    Configures access parameters for a KeyStore which holds the private and public keys to sign and verify a GenericCertificate by the LicenseNotary. All methods in this class should return constant references when called multiple times because the return values might get cached.

    Note: To protect your application against reverse engineering and thus reduce the risk to compromise the privacy of your passwords, it is highly recommended to obfuscate all JAR files which contain class files that implement this interface with a tool like e.g. ProGuard.

    Author:
    Christian Schlichtherle, Christian Schlichtherle
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getAlias()
      Returns the alias for the key entry in the key store - null is never returned.
      java.lang.String getKeyPwd()
      Returns the password for the private key in the keystore.
      java.lang.String getStorePwd()
      Returns the password for the keystore - null is never returned.
      java.io.InputStream getStream()
      Returns the keystore as an input stream - null is never returned.
    • Method Detail

      • getStream

        java.io.InputStream getStream()
                               throws java.io.IOException
        Returns the keystore as an input stream - null is never returned.
        Throws:
        java.io.IOException - If the key store cannot get opened.
      • getAlias

        java.lang.String getAlias()
        Returns the alias for the key entry in the key store - null is never returned.
      • getStorePwd

        java.lang.String getStorePwd()
        Returns the password for the keystore - null is never returned.

        Note that the Policy class provides additional constraints for the returned password.

        See Also:
        Policy.checkPwd(String)
      • getKeyPwd

        java.lang.String getKeyPwd()
        Returns the password for the private key in the keystore. This password is only required to sign a GenericCertificate and must be null in your client application (the one which just needs to install or verify license certificates rather than creating them). The LicenseNotary class may check that there is no private key in the Java key store if this password is null and vice versa and throw an exception if you don't adhere to this contract.

        Note that the Policy class provides additional constraints for the returned password.

        See Also:
        Policy.checkPwd(String)