net.nicholaswilliams.java.licensing.encryption

Interface RSAKeyPairGeneratorInterface

All Known Implementing Classes:

RSAKeyPairGenerator

public interface RSAKeyPairGeneratorInterface

An interface for the key pair generator to make unit testing possible. This interface is only implemented by RSAKeyPairGenerator.

Since:

1.0.0

Version:

1.0.0

Author:

Nick Williams

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RSAKeyPairGeneratorInterface.GeneratedClassDescriptor

Method Summary

Methods

Modifier and Type	Method and Description
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.

Method Detail

generateKeyPair

KeyPair generateKeyPair()
                        throws RSA2048NotSupportedException

Generates a key pair with RSA 2048-bit security.

Returns:

a public/private key pair.

Throws:

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

saveKeyPairToFiles

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.

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

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.

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

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.

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

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.

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

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

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

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