net.nicholaswilliams.java.licensing.encryption

Class RSAKeyPairGenerator

java.lang.Object

net.nicholaswilliams.java.licensing.encryption.RSAKeyPairGenerator

All Implemented Interfaces:

RSAKeyPairGeneratorInterface

public final class RSAKeyPairGenerator
extends Object
implements RSAKeyPairGeneratorInterface

The generator one should use to create public/private key pairs for use with the application.

Since:

1.0.0

Version:

1.0.0

Author:

Nick Williams

Nested Class Summary

Nested classes/interfaces inherited from interface net.nicholaswilliams.java.licensing.encryption.RSAKeyPairGeneratorInterface

RSAKeyPairGeneratorInterface.GeneratedClassDescriptor

Constructor Summary

Constructors

Constructor and Description
RSAKeyPairGenerator()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	arrayToCodeString(int[] values, String type) Takes an array of integer-representable primitives (byte, char, short, int) and returns a Java code array-literal instantiation of the array, with values in hexadecimal literal format.
protected int[]	byteArrayToIntArray(byte[] array) Converts a byte array to an int array.
protected int[]	charArrayToIntArray(char[] array) Converts a char array to an int array.
protected String	generateJavaCode(String packageName, String className, String interfaceName, String[] imports, String methodSignature, String returnValue) Generates a final, compilable Java class implementing the specified interface with a single, one-statement method that returns a simple value.
KeyPair	generateKeyPair() Generates a key pair with RSA 2048-bit security.
void	saveKeyPairToFiles(KeyPair keyPair, String privateOutputFileName, String publicOutputFileName, char[] password) Saves the key pair specified to output files specified, encrypting both with the specified password.
void	saveKeyPairToFiles(KeyPair keyPair, String privateOutputFileName, String publicOutputFileName, char[] privatePassword, char[] publicPassword) Saves the key pair specified to output files specified, encrypting each with their specified passwords.
void	saveKeyPairToProviders(KeyPair keyPair, RSAKeyPairGeneratorInterface.GeneratedClassDescriptor privateKeyProvider, RSAKeyPairGeneratorInterface.GeneratedClassDescriptor publicKeyProvider, char[] password) Saves the public and private keys specified to the respective javaFileContents fields in the provided RSAKeyPairGeneratorInterface.GeneratedClassDescriptors, encrypting both with the specified password.
void	saveKeyPairToProviders(KeyPair keyPair, RSAKeyPairGeneratorInterface.GeneratedClassDescriptor privateKeyProvider, RSAKeyPairGeneratorInterface.GeneratedClassDescriptor publicKeyProvider, char[] privatePassword, char[] publicPassword) Saves the public and private keys specified to the respective javaFileContents fields in the provided RSAKeyPairGeneratorInterface.GeneratedClassDescriptors, encrypting each with their respective passwords.
void	savePasswordToProvider(char[] password, RSAKeyPairGeneratorInterface.GeneratedClassDescriptor passwordProvider) Saves the password specified to the javaFileContents field in the provided RSAKeyPairGeneratorInterface.GeneratedClassDescriptor.

Methods inherited from class java.lang.Object

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

Constructor Detail

RSAKeyPairGenerator

public RSAKeyPairGenerator()

Method Detail

generateKeyPair

public KeyPair generateKeyPair()
                        throws RSA2048NotSupportedException

Generates a key pair with RSA 2048-bit security.

Specified by:

generateKeyPair in interface RSAKeyPairGeneratorInterface

Returns:

a public/private key pair.

Throws:

RSA2048NotSupportedException - if RSA or 2048-bit encryption are not supported.

saveKeyPairToFiles

public void saveKeyPairToFiles(KeyPair keyPair,
                      String privateOutputFileName,
                      String publicOutputFileName,
                      char[] password)
                        throws IOException,
                               AlgorithmNotSupportedException,
                               InappropriateKeyException,
                               InappropriateKeySpecificationException

Saves the key pair specified to output files specified, encrypting both with the specified password.

Specified by:

saveKeyPairToFiles in interface RSAKeyPairGeneratorInterface

Parameters:

keyPair - The key pair to save to the files specified

privateOutputFileName - The name of the file to save the encrypted private key to

publicOutputFileName - The name of the file to save the encrypted public key to

password - The password to encrypt both keys with

Throws:

IOException - if an error occurs while writing to the files.

AlgorithmNotSupportedException - If the encryption algorithm is not supported

InappropriateKeyException - If the public or private keys are invalid

InappropriateKeySpecificationException - If the public or private keys are invalid

saveKeyPairToFiles

public void saveKeyPairToFiles(KeyPair keyPair,
                      String privateOutputFileName,
                      String publicOutputFileName,
                      char[] privatePassword,
                      char[] publicPassword)
                        throws IOException,
                               AlgorithmNotSupportedException,
                               InappropriateKeyException,
                               InappropriateKeySpecificationException

Saves the key pair specified to output files specified, encrypting each with their specified passwords.

Specified by:

saveKeyPairToFiles in interface RSAKeyPairGeneratorInterface

Parameters:

keyPair - The key pair to save to the files specified

privateOutputFileName - The name of the file to save the encrypted private key to

publicOutputFileName - The name of the file to save the encrypted public key to

privatePassword - The password to encrypt the private key with

publicPassword - The password to encrypt the public key with

Throws:

IOException - if an error occurs while writing to the files.

AlgorithmNotSupportedException - If the encryption algorithm is not supported

InappropriateKeyException - If the public or private keys are invalid

InappropriateKeySpecificationException - If the public or private keys are invalid

saveKeyPairToProviders

public void saveKeyPairToProviders(KeyPair keyPair,
                          RSAKeyPairGeneratorInterface.GeneratedClassDescriptor privateKeyProvider,
                          RSAKeyPairGeneratorInterface.GeneratedClassDescriptor publicKeyProvider,
                          char[] password)
                            throws AlgorithmNotSupportedException,
                                   InappropriateKeyException,
                                   InappropriateKeySpecificationException

Saves the public and private keys specified to the respective javaFileContents fields in the provided RSAKeyPairGeneratorInterface.GeneratedClassDescriptors, encrypting both with the specified password.

Specified by:

saveKeyPairToProviders in interface RSAKeyPairGeneratorInterface

Parameters:

keyPair - The key pair to save

privateKeyProvider - An object describing the PrivateKeyDataProvider class to generate, and into which the generated code will be saved

publicKeyProvider - An object describing the PublicKeyDataProvider class to generate, and into which the generated code will be saved

password - The password to encrypt the keys with

Throws:

AlgorithmNotSupportedException - If the encryption algorithm is not supported

InappropriateKeyException - If the public or private keys are invalid

InappropriateKeySpecificationException - If the public or private keys are invalid

saveKeyPairToProviders

public void saveKeyPairToProviders(KeyPair keyPair,
                          RSAKeyPairGeneratorInterface.GeneratedClassDescriptor privateKeyProvider,
                          RSAKeyPairGeneratorInterface.GeneratedClassDescriptor publicKeyProvider,
                          char[] privatePassword,
                          char[] publicPassword)
                            throws AlgorithmNotSupportedException,
                                   InappropriateKeyException,
                                   InappropriateKeySpecificationException

Saves the public and private keys specified to the respective javaFileContents fields in the provided RSAKeyPairGeneratorInterface.GeneratedClassDescriptors, encrypting each with their respective passwords.

Specified by:

saveKeyPairToProviders in interface RSAKeyPairGeneratorInterface

Parameters:

keyPair - The key pair to save

privateKeyProvider - An object describing the PrivateKeyDataProvider class to generate, and into which the generated code will be saved

publicKeyProvider - An object describing the PublicKeyDataProvider class to generate, and into which the generated code will be saved

privatePassword - The password to encrypt the private key with

publicPassword - The password to encrypt the public key with

Throws:

AlgorithmNotSupportedException - If the encryption algorithm is not supported

InappropriateKeyException - If the public or private keys are invalid

InappropriateKeySpecificationException - If the public or private keys are invalid

savePasswordToProvider

public void savePasswordToProvider(char[] password,
                          RSAKeyPairGeneratorInterface.GeneratedClassDescriptor passwordProvider)

Saves the password specified to the javaFileContents field in the provided RSAKeyPairGeneratorInterface.GeneratedClassDescriptor.

Specified by:

savePasswordToProvider in interface RSAKeyPairGeneratorInterface

Parameters:

password - The password to save to the specified Java class

passwordProvider - An object describing the PasswordProvider class to generate, and into which the generated code will be saved

generateJavaCode

protected String generateJavaCode(String packageName,
                      String className,
                      String interfaceName,
                      String[] imports,
                      String methodSignature,
                      String returnValue)

Generates a final, compilable Java class implementing the specified interface with a single, one-statement method that returns a simple value.

Parameters:

packageName - The package name the class should be contained in, or null if no package

className - The name of the class to create

interfaceName - The interface this class should implement, or null if no interface

imports - An array of classes to import at the top of the Java code

methodSignature - The signature of the sole method in the class

returnValue - The statement that the method should return (will be prepended with "return ")

Returns:

the Java code for the specified class.

arrayToCodeString

protected String arrayToCodeString(int[] values,
                       String type)

Takes an array of integer-representable primitives (byte, char, short, int) and returns a Java code array-literal instantiation of the array, with values in hexadecimal literal format. It is the user's responsibility to ensure that the values contained in the array can fit within the smaller precision of the array type, if applicable.

Parameters:

values - The array of values to include in the array code

type - The data type (byte, char, short, int) of the array to return

Returns:

the Java code representation of this array.

byteArrayToIntArray

protected int[] byteArrayToIntArray(byte[] array)

Converts a byte array to an int array.

Parameters:

array - The byte array to convert

Returns:

the converted array as an int array.

charArrayToIntArray

protected int[] charArrayToIntArray(char[] array)

Converts a char array to an int array.

Parameters:

array - The char array to convert

Returns:

the converted array as an int array.