com.lf.commons.crypto

Class LicenseManager

java.lang.Object

com.lf.commons.crypto.LicenseManager

public class LicenseManager
extends java.lang.Object

Manager class for licensing issues provided for Leisenfels applications.

Remember that the term "license" is American English (AmE) and "licence" is British English (BrE). The source code variables, comments etc. normally use AmE, but in the future there may be different locali(z|s)ations for eng_GB and eng_US :-) See http://en.wikipedia.org/wiki/License.

Since:

1.5

Version:

$Revision: 1.41 $, $Date: 2012/12/28 11:44:24 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	applicationID The identification of the application to be checked.
protected java.util.Date	build The build date of the application to be checked.
static java.lang.String	CONFIG_AGREE_REQUIRED Configuration variable.
static java.lang.String	CONFIG_SUPPORT_FROM Configuration variable.
static java.lang.String	CONFIG_SUPPORT_LEVEL Configuration variable.
static java.lang.String	CONFIG_SUPPORT_UNTIL Configuration variable.
protected CryptoManager	cryptoManager The key management helper.
protected byte[]	encryptedData The raw license key data.
static java.lang.String	ID_EVALUATION_LICENSE License type identifier.
static java.lang.String	ID_FLOATING_LICENSE Server-based licensing for configurable n IP addresses.
static java.lang.String	ID_SINGLE_MACHINE_LICENSE One single license for a specific IP address like 192.168.1.100
static java.lang.String	ID_SINGLE_USER_LICENSE One single license for personal use on multiple machines.
static java.lang.String	ID_SITE_LICENSE Server-based licensing for class C net like 192.168.1.x
protected License	license The instance holding the license data like "product_id".
static int	MAXLENGTH The maximum length of the license key (currently 64 kilo bytes).
protected PassphraseProvider	providerAES The AES key provider (optional).
protected PassphraseProvider	providerSignature The license signature provider (optional).
protected java.lang.String	recipientUserID The hexadecimal recipient user ID to decrypt the license file.
protected java.lang.String	signerUserID The hexadecimal signer user ID to verify the license file (optional).

Constructor Summary

Constructors

Constructor and Description
LicenseManager() Constructor method for i18n purposes only.
LicenseManager(java.lang.String appid, java.util.Date build, java.lang.String recipient, java.lang.String signer, CryptoManager manager, PassphraseProvider provideraes, PassphraseProvider providersig) Constructor for the license manager.

Method Summary

Methods

Modifier and Type	Method and Description
int	calculateTrialDaysLeft() Calculates the remaining days left for evaluation (evaluation license only).
void	debugPrint() Prints the current license document to System.out.
Agreement[]	getAgreements() Provides the license agreements in various localizations.
Configuration	getConfiguration() Provides the application configuration included in the license document.
java.lang.Object[][]	getConfigurationForDisplay(Configuration config) Provides the application configuration included in the license document to be displayed.
java.lang.String	getConfigUserTextBoolean(boolean value) Convenience method to get commonly used user texts for displayed configurations.
byte[]	getEncryptedData() Provides the encrypted license key data.
java.util.Date	getLicenseDate() Provides the current license creation date.
java.lang.String	getLicenseID() Provides the current unique license identifier like "lima-0000011111".
java.lang.String	getLicenseProductType() Provides the product type (e.g.
java.lang.String	getLicenseType() Provides the current license type like "Single-User License".
int	getLicenseUsers() Provides the user count for this license.
java.util.Properties	getProperties() Provides the license data as Properties.
boolean	isAgreeRequired() Shall the dialog to let the user agree to the license be presented (again)?
boolean	isEvaluationLicense() Determines whether the license is for evaluation use.
boolean	isFloatingLicense() Determines whether the license is floating.
java.lang.String	isLicenseValid() Determines whether the application can be used with the current license.
java.lang.String	isLicenseValid(java.lang.String appid, java.util.Date build) Determines whether the given application can be used with the current license.
boolean	isSingleMachineLicense() Determines whether the license is for a single machine.
boolean	isSingleUserLicense() Determines whether the license is for a single user.
boolean	isSiteLicense() Determines whether the license is for sites.
boolean	loadLicense(byte[] rawdata) Tries to load the license from an array of bytes.
boolean	loadLicense(java.io.File file) Tries to load the license associated with a name.
boolean	loadLicense(org.apache.commons.vfs2.FileObject file) Tries to load the license associated with a name.
boolean	loadLicense(java.io.InputStream istream) Tries to load the license associated with a name.
boolean	loadLicense(java.lang.String filename) Tries to load the license associated with a name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ID_EVALUATION_LICENSE

public static final java.lang.String ID_EVALUATION_LICENSE

License type identifier.

See Also:

Constant Field Values

ID_SINGLE_USER_LICENSE

public static final java.lang.String ID_SINGLE_USER_LICENSE

One single license for personal use on multiple machines.

See Also:

Constant Field Values

ID_SINGLE_MACHINE_LICENSE

public static final java.lang.String ID_SINGLE_MACHINE_LICENSE

One single license for a specific IP address like 192.168.1.100

See Also:

Constant Field Values

ID_FLOATING_LICENSE

public static final java.lang.String ID_FLOATING_LICENSE

Server-based licensing for configurable n IP addresses.

See Also:

Constant Field Values

ID_SITE_LICENSE

public static final java.lang.String ID_SITE_LICENSE

Server-based licensing for class C net like 192.168.1.x

See Also:

Constant Field Values

MAXLENGTH

public static final int MAXLENGTH

The maximum length of the license key (currently 64 kilo bytes).

See Also:

Constant Field Values

CONFIG_AGREE_REQUIRED

public static final java.lang.String CONFIG_AGREE_REQUIRED

Configuration variable.

See Also:

Constant Field Values

CONFIG_SUPPORT_LEVEL

public static final java.lang.String CONFIG_SUPPORT_LEVEL

Configuration variable.

See Also:

Constant Field Values

CONFIG_SUPPORT_FROM

public static final java.lang.String CONFIG_SUPPORT_FROM

Configuration variable.

See Also:

Constant Field Values

CONFIG_SUPPORT_UNTIL

public static final java.lang.String CONFIG_SUPPORT_UNTIL

Configuration variable.

See Also:

Constant Field Values

applicationID

protected java.lang.String applicationID

The identification of the application to be checked.

build

protected java.util.Date build

The build date of the application to be checked.

recipientUserID

protected java.lang.String recipientUserID

The hexadecimal recipient user ID to decrypt the license file.

signerUserID

protected java.lang.String signerUserID

The hexadecimal signer user ID to verify the license file (optional).

license

protected License license

The instance holding the license data like "product_id".

encryptedData

protected byte[] encryptedData

The raw license key data.

cryptoManager

protected CryptoManager cryptoManager

The key management helper.

providerAES

protected PassphraseProvider providerAES

The AES key provider (optional).

providerSignature

protected PassphraseProvider providerSignature

The license signature provider (optional).

Constructor Detail

LicenseManager

public LicenseManager()
               throws java.lang.InstantiationException

Constructor method for i18n purposes only.

Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

LicenseManager

public LicenseManager(java.lang.String appid,
              java.util.Date build,
              java.lang.String recipient,
              java.lang.String signer,
              CryptoManager manager,
              PassphraseProvider provideraes,
              PassphraseProvider providersig)

Constructor for the license manager.

If the signer key is not configured then no verification will be performed. It is possible but should not be the preferred way to import a license file since the source of the file cannot be trusted. Anyone having access to the client private key and passphrase would be able to create new license files for the application. Especially the passphrase could be hacked theoretically, although this could not be easily done.

Parameters:

appid - The identification of the application

build - The build date of the application to be checked

recipient - The recipient user ID

signer - The signer user ID (optional)

manager - The key management helper

provideraes - The AES key provider (optional)

providersig - The signature provider (optional)

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

Method Detail

loadLicense

public boolean loadLicense(java.lang.String filename)
                    throws java.io.IOException

Tries to load the license associated with a name.

Parameters:

filename - Name of the file to load as license

Returns:

Loading was successful?

Throws:

java.io.IOException - An I/O error occurred

java.lang.NullPointerException - Given file name was null

java.io.FileNotFoundException - Given file does not exist

Since:

1.5

loadLicense

public boolean loadLicense(java.io.File file)
                    throws java.io.IOException

Tries to load the license associated with a name.

Parameters:

file - The file to load as license

Returns:

Loading was successful?

Throws:

java.io.IOException - An I/O error occurred

java.lang.NullPointerException - Given file name was null

java.io.FileNotFoundException - Given file does not exist

Since:

1.5

loadLicense

public boolean loadLicense(org.apache.commons.vfs2.FileObject file)
                    throws java.io.IOException

Tries to load the license associated with a name.

Parameters:

file - The VFS file to load as license

Returns:

Loading was successful?

Throws:

java.io.IOException - An I/O error occurred

java.lang.NullPointerException - Given file name was null

java.io.FileNotFoundException - Given file does not exist

Since:

1.5

loadLicense

public boolean loadLicense(byte[] rawdata)
                    throws java.io.IOException

Tries to load the license from an array of bytes.

Parameters:

rawdata - The binary data

Returns:

Loading was successful?

Throws:

java.io.IOException - An I/O error occurred

java.lang.NullPointerException - Given array was null

Since:

1.6

loadLicense

public boolean loadLicense(java.io.InputStream istream)

Tries to load the license associated with a name.

Parameters:

istream - The input stream to load as license

Returns:

Loading was successful?

Since:

1.5

getProperties

public java.util.Properties getProperties()

Provides the license data as Properties.

The supported properties follow the underlying DTD and use a prefix according to the data block. For instance the childs are specified product_id, product_type, product_orderid, and product_npgrade since several child tags can be used for multiple blocks.

Returns:

License properties, may be null or empty

getAgreements

public Agreement[] getAgreements()

Provides the license agreements in various localizations.

Returns:

XML data, may be null if parsing went wrong or license is not armed

Since:

1.5

getEncryptedData

public byte[] getEncryptedData()

Provides the encrypted license key data.

Returns:

Encrypted data, may be null if parsing went wrong or license is not armed

Since:

1.5

isLicenseValid

public java.lang.String isLicenseValid()

Determines whether the application can be used with the current license.

Returns:

"OK" if the license is good, localized error message else

Since:

1.5

isLicenseValid

public java.lang.String isLicenseValid(java.lang.String appid,
                              java.util.Date build)

Determines whether the given application can be used with the current license.

Parameters:

appid - Unique application id like "lima-1.6.1_213"

build - The build date, will be normalized to midnight

Returns:

"OK" if the license is good, localized error message else

Since:

1.5

isEvaluationLicense

public boolean isEvaluationLicense()

Determines whether the license is for evaluation use.

Returns:

Evaluation license?

Since:

1.5

isSingleUserLicense

public boolean isSingleUserLicense()

Determines whether the license is for a single user.

Returns:

Single-user license?

Since:

1.6

isSingleMachineLicense

public boolean isSingleMachineLicense()

Determines whether the license is for a single machine.

Returns:

Single-machine license?

Since:

1.6

isFloatingLicense

public boolean isFloatingLicense()

Determines whether the license is floating.

Returns:

Floating license?

Since:

1.6

isSiteLicense

public boolean isSiteLicense()

Determines whether the license is for sites.

Returns:

Site license?

Since:

1.6

getLicenseType

public java.lang.String getLicenseType()

Provides the current license type like "Single-User License".

Returns:

The type identifier or null if not available

Since:

1.6

getLicenseID

public java.lang.String getLicenseID()

Provides the current unique license identifier like "lima-0000011111".

Returns:

The license identifier or null if not available

Since:

1.6

getLicenseDate

public java.util.Date getLicenseDate()

Provides the current license creation date.

Returns:

The license creation date or null if not available

Since:

1.6

getLicenseProductType

public java.lang.String getLicenseProductType()

Provides the product type (e.g. "Personal Edition").

Returns:

The product type or null if not available

Since:

1.6

getLicenseUsers

public int getLicenseUsers()

Provides the user count for this license.

Returns:

The number of users, -1 if not available

Since:

1.6

calculateTrialDaysLeft

public int calculateTrialDaysLeft()

Calculates the remaining days left for evaluation (evaluation license only).

Returns:

The days left, -1 if not available

Since:

1.6

getConfiguration

public Configuration getConfiguration()

Provides the application configuration included in the license document.

The configuration section can be used to grant access to plugin modules, ask the user to agree to the license agreement etc.

Returns:

The variables, may be empty

Since:

1.6

getConfigurationForDisplay

public java.lang.Object[][] getConfigurationForDisplay(Configuration config)

Provides the application configuration included in the license document to be displayed.

Features need to be pre-processed by the application license manager since there may be single config entries invisible for the user. This method return a zero-length array so it should be overridden by application specific subclasses.

Parameters:

config - The variables

Returns:

The table data with columns feature and value (String), may be null

Since:

1.6

isAgreeRequired

public boolean isAgreeRequired()

Shall the dialog to let the user agree to the license be presented (again)?

This method should be overriden by application specific subclasses if this behaviour may be extracted e.g. from the configuration section of the license document.

Returns:

Requires commit (default: true)?

Since:

1.6

getConfigUserTextBoolean

public java.lang.String getConfigUserTextBoolean(boolean value)

Convenience method to get commonly used user texts for displayed configurations.

Parameters:

value - Value to map

Returns:

Requires commit (default: true)?

Since:

1.6

debugPrint

public void debugPrint()

Prints the current license document to System.out.

Since:

1.6