Package org.zkoss.zkex.license

Class LicenseNotary

java.lang.Object
org.zkoss.zkex.license.LicenseNotary
public class LicenseNotary extends Object
This notary knows how to sign and verify a GenericCertificate.

This class is not thread safe.

Version:
$Id$
Author:
Christian Schlichtherle

  • Constructor Details

    • LicenseNotary

      protected LicenseNotary()
      Creates a new License Notary.

      Warning: The notary created by this constructor is not valid and cannot be used unless setKeyStoreParam(KeyStoreParam) is called!

    • LicenseNotary

      public LicenseNotary(KeyStoreParam param)
      Creates a new License Notary.
      Parameters:
      param - the keyStore configuration parameters - may not be null.
      Throws:
      NullPointerException - if the given parameter object does not obey the contract of its interface due to a null pointer.
      IllegalPasswordException - if any password in the parameter object does not comply to the current policy.

  • Method Details

    • getKeyStoreParam

      public KeyStoreParam getKeyStoreParam()
      Returns the keyStore configuration parameters.

    • setKeyStoreParam

      public void setKeyStoreParam(KeyStoreParam param)
      Sets the keyStore configuration parameters. Calling this method resets the notary as if it had just been created.
      Parameters:
      param - the keyStore configuration parameters - may not be null.
      Throws:
      NullPointerException - if the given parameter object does not obey the contract of its interface due to a null pointer.
      IllegalPasswordException - if any password in the parameter object does not comply to the current policy.

    • sign

      public GenericCertificate sign(Object content) throws Exception
      Encodes and signs the given content and returns a locked generic certificate holding the encoded content and its digital signature.

      Please note the following:

      • Because this method locks the certificate, a subsequent call to sign(GenericCertificate, Object) or verify(GenericCertificate) is redundant and will throw a PropertyVetoException. Use GenericCertificate.isLocked() to detect whether a generic certificate has been successfuly signed or verified before or call GenericCertificate.getContent() and expect an Exception to be thrown if it hasn't.
      • There is no way to unlock the returned certificate. Call the copy constructor of GenericCertificate if you need an unlocked copy of the certificate.
      Parameters:
      content - the object to sign. This must either be a JavaBean or an instance of any other class which is supported by PersistenceService - maybe null.
      Returns:
      A locked generic certificate holding the encoded content and its digital signature.
      Throws:
      Exception - for various reasons.

    • verify

      public void verify(GenericCertificate certificate) throws Exception
      Verifies the digital signature of the encoded content in the given certificate and locks it.

      Please note the following:

      • This method will throw a PropertyVetoException if the certificate is already locked, i.e. if it has been signed or verified before.
      • Because this method locks the certificate, a subsequent call to sign(GenericCertificate, Object) or verify(GenericCertificate) is redundant and will throw a PropertyVetoException. Use GenericCertificate.isLocked() to detect whether a generic certificate has been successfuly signed or verified before or call GenericCertificate.getContent() and expect an Exception to be thrown if it hasn't.
      • There is no way to unlock the certificate. Call the copy constructor of GenericCertificate if you need an unlocked copy of the certificate.
      Parameters:
      certificate - the generic certificate to verify - may not be null.
      Throws:
      Exception - a subclass of this class may be thrown for various reasons.

    • getPrivateKey

      protected PrivateKey getPrivateKey() throws LicenseNotaryException, IOException, CertificateException, NoSuchAlgorithmException, UnrecoverableKeyException
      Returns the private key from the keyStore.
      Throws:
      LicenseNotaryException - if the parameters used to access the corresponding key store are insufficient or incorrect. Note that you should always use Throwable.getLocalizedMessage() to get a (possibly localized) meaningful detail message.
      IOException - if there is an I/O or format problem with the keyStore data.
      CertificateException - if any of the certificates in the keyStore could not be loaded.
      NoSuchAlgorithmException - if the algorithm used to check the integrity of the keyStore cannot be found.
      UnrecoverableKeyException - if the key cannot get recovered (e.g. the given password is wrong).

    • getPublicKey

      protected PublicKey getPublicKey() throws LicenseNotaryException, IOException, CertificateException, NoSuchAlgorithmException
      Returns the public key from the keyStore
      Throws:
      LicenseNotaryException - if the parameters used to access the corresponding key store are insufficient or incorrect. Note that you should always use Throwable.getLocalizedMessage() to get a (possibly localized) meaningful detail message.
      IOException - if there is an I/O or format problem with the keyStore data.
      CertificateException - if any of the certificates in the keyStore could not be loaded.
      NoSuchAlgorithmException - if the algorithm used to check the integrity of the keyStore cannot be found.

    • getSignatureEngine

      protected Signature getSignatureEngine()
      Returns a valid signature engine to be used for signing and verifying a GenericCertificate - null is never returned.

    • getKeyStore

      protected KeyStore getKeyStore() throws IOException, CertificateException, NoSuchAlgorithmException
      Returns a loaded/initialized keyStore.
      Throws:
      IOException - if there is an I/O or format problem with the keyStore data.
      CertificateException - if any of the certificates in the keyStore could not be loaded.
      NoSuchAlgorithmException - if the algorithm used to check the integrity of the keyStore cannot be found.