de.alpharogroup.crypto.key.reader

Class PrivateKeyReader

java.lang.Object

de.alpharogroup.crypto.key.reader.PrivateKeyReader

public class PrivateKeyReader
extends Object

The class PrivateKeyReader is a utility class for reading private keys in *.der or *.pem format.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BEGIN_PRIVATE_KEY_PREFIX The Constant BEGIN_PRIVATE_KEY_PREFIX.
static String	BEGIN_RSA_PRIVATE_KEY_PREFIX The Constant BEGIN_RSA_PRIVATE_KEY_PREFIX.
static String	END_PRIVATE_KEY_SUFFIX The Constant END_PRIVATE_KEY_SUFFIX.
static String	END_RSA_PRIVATE_KEY_SUFFIX The Constant END_RSA_PRIVATE_KEY_SUFFIX.
static String	RSA_PRIVATE_KEY The Constant RSA_PRIVATE_KEY.

Constructor Summary

Constructors

Constructor and Description
PrivateKeyReader()

Method Summary

Modifier and Type	Method and Description
static boolean	isPemFormat(File file) Checks if the given File is in pem format.
static boolean	isPrivateKeyPasswordProtected(File file) Checks if the given File( in *.der format) is password protected
static String	readPemFileAsBase64(File file) Read the private key from a pem file as base64 encoded String value.
static PrivateKey	readPemPrivateKey(File file) Reads the given File( in *.pem format) with the default RSA algorithm and returns the PrivateKey object.
static PrivateKey	readPemPrivateKey(File file, String algorithm) Reads the given File( in *.pem format) with given algorithm and returns the PrivateKey object.
static PrivateKey	readPemPrivateKey(String privateKeyAsString, String algorithm) Reads the given String( in *.pem format) with given algorithm and returns the PrivateKey object.
static PrivateKey	readPrivateKey(byte[] privateKeyBytes) Reads the given byte array with the default RSA algorithm and returns the PrivateKey object.
static PrivateKey	readPrivateKey(byte[] privateKeyBytes, String algorithm) Reads the given byte array with the given algorithm and returns the PrivateKey object.
static PrivateKey	readPrivateKey(File file) Reads the given File( in *.der format) with the default RSA algorithm and returns the PrivateKey object.
static PrivateKey	readPrivateKey(File file, String algorithm) Reads the given File( in *.der format) with the given algorithm and returns the PrivateKey object.
static PrivateKey	readPrivateKey(File root, String directory, String fileName) Constructs from the given root, parent directory and file name the file and reads the private key.

Methods inherited from class java.lang.Object

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

Field Detail

RSA_PRIVATE_KEY

public static final String RSA_PRIVATE_KEY

The Constant RSA_PRIVATE_KEY.

See Also:

Constant Field Values

BEGIN_PRIVATE_KEY_PREFIX

public static final String BEGIN_PRIVATE_KEY_PREFIX

The Constant BEGIN_PRIVATE_KEY_PREFIX.

See Also:

Constant Field Values

END_PRIVATE_KEY_SUFFIX

public static final String END_PRIVATE_KEY_SUFFIX

The Constant END_PRIVATE_KEY_SUFFIX.

See Also:

Constant Field Values

BEGIN_RSA_PRIVATE_KEY_PREFIX

public static final String BEGIN_RSA_PRIVATE_KEY_PREFIX

The Constant BEGIN_RSA_PRIVATE_KEY_PREFIX.

See Also:

Constant Field Values

END_RSA_PRIVATE_KEY_SUFFIX

public static final String END_RSA_PRIVATE_KEY_SUFFIX

The Constant END_RSA_PRIVATE_KEY_SUFFIX.

See Also:

Constant Field Values

Constructor Detail

PrivateKeyReader

public PrivateKeyReader()

Method Detail

isPrivateKeyPasswordProtected

public static boolean isPrivateKeyPasswordProtected(File file)
                                             throws IOException

Checks if the given File( in *.der format) is password protected

Parameters:

file - the file( in *.der format) that contains the private key

Returns:

true, if if the given File( in *.der format) is password protected otherwise false

Throws:

IOException - Signals that an I/O exception has occurred.

isPemFormat

public static boolean isPemFormat(File file)
                           throws IOException

Checks if the given File is in pem format.

Parameters:

file - the file

Returns:

true, if the given File is in pem format otherwise false

Throws:

IOException - Signals that an I/O exception has occurred.

readPrivateKey

public static PrivateKey readPrivateKey(File file)
                                 throws IOException,
                                        NoSuchAlgorithmException,
                                        InvalidKeySpecException,
                                        NoSuchProviderException

Reads the given File( in *.der format) with the default RSA algorithm and returns the PrivateKey object.

Parameters:

file - the file( in *.der format) that contains the private key

Returns:

the PrivateKey object

Throws:

IOException - Signals that an I/O exception has occurred.

NoSuchAlgorithmException - is thrown if instantiation of the cypher object fails.

InvalidKeySpecException - is thrown if generation of the SecretKey object fails.

NoSuchProviderException - is thrown if the specified provider is not registered in the security provider list.

readPrivateKey

public static PrivateKey readPrivateKey(File file,
                                        String algorithm)
                                 throws IOException,
                                        NoSuchAlgorithmException,
                                        InvalidKeySpecException,
                                        NoSuchProviderException

Reads the given File( in *.der format) with the given algorithm and returns the PrivateKey object.

Parameters:

file - the file( in *.der format) that contains the private key

algorithm - the algorithm

Returns:

the PrivateKey object

Throws:

IOException - Signals that an I/O exception has occurred.

NoSuchAlgorithmException - is thrown if instantiation of the cypher object fails.

InvalidKeySpecException - is thrown if generation of the SecretKey object fails.

NoSuchProviderException - is thrown if the specified provider is not registered in the security provider list.

readPrivateKey

public static PrivateKey readPrivateKey(byte[] privateKeyBytes)
                                 throws NoSuchAlgorithmException,
                                        InvalidKeySpecException,
                                        NoSuchProviderException

Reads the given byte array with the default RSA algorithm and returns the PrivateKey object.

Parameters:

privateKeyBytes - the byte array that contains the private key bytes

Returns:

the PrivateKey object

Throws:

NoSuchAlgorithmException - is thrown if instantiation of the cypher object fails.

InvalidKeySpecException - is thrown if generation of the SecretKey object fails.

NoSuchProviderException - is thrown if the specified provider is not registered in the security provider list.

readPrivateKey

public static PrivateKey readPrivateKey(byte[] privateKeyBytes,
                                        String algorithm)
                                 throws NoSuchAlgorithmException,
                                        InvalidKeySpecException,
                                        NoSuchProviderException

Reads the given byte array with the given algorithm and returns the PrivateKey object.

Parameters:

privateKeyBytes - the byte array that contains the private key bytes

algorithm - the algorithm for the KeyFactory

Returns:

the PrivateKey object

Throws:

NoSuchAlgorithmException - is thrown if instantiation of the cypher object fails.

InvalidKeySpecException - is thrown if generation of the SecretKey object fails.

NoSuchProviderException - is thrown if the specified provider is not registered in the security provider list.

readPemPrivateKey

public static PrivateKey readPemPrivateKey(File file)
                                    throws IOException,
                                           NoSuchAlgorithmException,
                                           InvalidKeySpecException,
                                           NoSuchProviderException

Reads the given File( in *.pem format) with the default RSA algorithm and returns the PrivateKey object.

Parameters:

file - the file( in *.pem format) that contains the private key

Returns:

the PrivateKey object

Throws:

IOException - Signals that an I/O exception has occurred.

NoSuchAlgorithmException - is thrown if instantiation of the cypher object fails.

InvalidKeySpecException - is thrown if generation of the SecretKey object fails.

NoSuchProviderException - is thrown if the specified provider is not registered in the security provider list.

readPemPrivateKey

public static PrivateKey readPemPrivateKey(File file,
                                           String algorithm)
                                    throws IOException,
                                           NoSuchAlgorithmException,
                                           InvalidKeySpecException,
                                           NoSuchProviderException

Reads the given File( in *.pem format) with given algorithm and returns the PrivateKey object.

Parameters:

file - the file( in *.pem format) that contains the private key

algorithm - the algorithm

Returns:

the PrivateKey object

Throws:

IOException - Signals that an I/O exception has occurred.

NoSuchAlgorithmException - is thrown if instantiation of the SecretKeyFactory object fails.

InvalidKeySpecException - is thrown if generation of the SecretKey object fails.

NoSuchProviderException - is thrown if the specified provider is not registered in the security provider list.

readPemPrivateKey

public static PrivateKey readPemPrivateKey(String privateKeyAsString,
                                           String algorithm)
                                    throws NoSuchAlgorithmException,
                                           InvalidKeySpecException,
                                           NoSuchProviderException

Reads the given String( in *.pem format) with given algorithm and returns the PrivateKey object.

Parameters:

privateKeyAsString - the private key as string( in *.pem format)

algorithm - the algorithm

Returns:

the PrivateKey object

Throws:

NoSuchAlgorithmException - is thrown if instantiation of the SecretKeyFactory object fails.

InvalidKeySpecException - is thrown if generation of the SecretKey object fails.

NoSuchProviderException - is thrown if the specified provider is not registered in the security provider list.

readPemFileAsBase64

public static String readPemFileAsBase64(File file)
                                  throws IOException

Read the private key from a pem file as base64 encoded String value.

Parameters:

file - the file( in *.pem format) that contains the private key

Returns:

the base64 encoded String value.

Throws:

IOException - Signals that an I/O exception has occurred.

readPrivateKey

public static PrivateKey readPrivateKey(File root,
                                        String directory,
                                        String fileName)
                                 throws NoSuchAlgorithmException,
                                        InvalidKeySpecException,
                                        NoSuchProviderException,
                                        IOException

Constructs from the given root, parent directory and file name the file and reads the private key.

Parameters:

root - the root directory of the parent directory

directory - the parent directory of the private key file

fileName - the file name of the file that contains the private key

Returns:

the private key

Throws:

NoSuchAlgorithmException - is thrown if instantiation of the SecretKeyFactory object fails.

InvalidKeySpecException - is thrown if generation of the SecretKey object fails.

NoSuchProviderException - the no such provider exception

IOException - Signals that an I/O exception has occurred.