net.nicholaswilliams.java.licensing.encryption

Class FilePublicKeyDataProvider

java.lang.Object

net.nicholaswilliams.java.licensing.encryption.FilePublicKeyDataProvider

All Implemented Interfaces:

PublicKeyDataProvider

public class FilePublicKeyDataProvider
extends Object
implements PublicKeyDataProvider

A default implementation of PublicKeyDataProvider that reads the public key from a file.

This provider is immutable. Once created, the file that the public key is located at cannot be changed.

Since:

1.0.0

Version:

1.0.0

Author:

Nick Williams

Constructor Summary

Constructors

Constructor and Description
FilePublicKeyDataProvider(File publicKeyFile) Create a new provider, specifying the file from which the public key can be read.
FilePublicKeyDataProvider(String publicKeyFileName) Create a new provider, specifying the name of the file from which the public key can be read.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getEncryptedPublicKeyData() This method returns the data from the file containing the encrypted public key from the public/private key pair.
File	getPublicKeyFile() Gets the file that the public key is located at.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilePublicKeyDataProvider

public FilePublicKeyDataProvider(File publicKeyFile)

Create a new provider, specifying the file from which the public key can be read.

Parameters:

publicKeyFile - the public key file

FilePublicKeyDataProvider

public FilePublicKeyDataProvider(String publicKeyFileName)

Create a new provider, specifying the name of the file from which the public key can be read.

Parameters:

publicKeyFileName - The public key file name

Method Detail

getEncryptedPublicKeyData

public byte[] getEncryptedPublicKeyData()
                                 throws KeyNotFoundException

This method returns the data from the file containing the encrypted public key from the public/private key pair. The contract for this method can be fulfilled by storing the data in a byte array literal in the source code itself.

It is imperative that you obfuscate the bytecode for the implementation of this class. It is also imperative that the byte array exist only for the life of this method (i.e., DO NOT store it as an instance or class field).

Specified by:

getEncryptedPublicKeyData in interface PublicKeyDataProvider

Returns:

the encrypted file contents from the public key file.

Throws:

KeyNotFoundException - if the key data could not be retrieved; an acceptable message or chained cause must be provided.

getPublicKeyFile

public File getPublicKeyFile()

Gets the file that the public key is located at.

Returns:

the file.