org.antfarmer.ejce.util

Class CryptoUtil

java.lang.Object

org.antfarmer.ejce.util.CryptoUtil

public final class CryptoUtil
extends Object

Provides methods to generate random keys or keys based on a password for a given algorithm.

Method Summary

Modifier and Type	Method and Description
static PrivateKey	createPrivateKey(String algorithm, KeySpec keySpec) Returns a PrivateKey for the given algorithm and KeySpec.
static PublicKey	createPublicKey(String algorithm, KeySpec keySpec) Returns a PublicKey for the given algorithm and KeySpec.
static KeyPair	generateAsymmetricKeyPair(int keySize, String algorithm) Generates a new asymmetric key pair for the given algorithm and key size.
static KeyPair	generateAsymmetricKeyPair(int keySize, String algorithm, String providerName, Provider provider) Generates a new asymmetric key pair for the given algorithm, key size, and provider.
static KeyPair	generateAsymmetricKeyPair(String algorithm) Generates a new asymmetric key pair for the given algorithm.
static KeyPair	generateAsymmetricKeyPair(String algorithm, String providerName, Provider provider) Generates a new asymmetric key pair for the given algorithm and provider.
static SecretKey	generateSecretKey(int keySize, String algorithm) Generates a new secret key for the given algorithm and key size.
static SecretKey	generateSecretKey(int keySize, String algorithm, String providerName, Provider provider) Generates a new secret key for the given algorithm, key size, and provider.
static SecretKey	generateSecretKey(String algorithm) Generates a new secret key for the given algorithm.
static SecretKey	generateSecretKey(String algorithm, String providerName, Provider provider) Generates a new secret key for the given algorithm and provider.
static <T extends KeySpec> T	getKeySpec(Key key, Class<T> keySpec) Returns a KeySpec for the given key and KeySpec implementation class.
static SecretKey	getSecretKeyFromRawKey(byte[] rawKey, String algorithm) Creates a secret key from the supplied raw key byte array.
static SecretKey	getSecretKeyFromTextKey(String textKey, String algorithm) Creates a secret key from the supplied text.
static SecretKey	getSecretKeyFromTextKey(String textKey, String algorithm, TextEncoder textEncoder) Creates a secret key from the supplied text.

Methods inherited from class java.lang.Object

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

Method Detail

generateSecretKey

public static SecretKey generateSecretKey(String algorithm)
                                   throws NoSuchAlgorithmException

Generates a new secret key for the given algorithm.

Parameters:

algorithm - the algorithm that will be used for key generation

Returns:

the generated secret key

Throws:

NoSuchAlgorithmException - NoSuchAlgorithmException

generateSecretKey

public static SecretKey generateSecretKey(int keySize,
                                          String algorithm)
                                   throws NoSuchAlgorithmException

Generates a new secret key for the given algorithm and key size.

Parameters:

keySize - the size of the key in bits

algorithm - the algorithm that will be used for key generation

Returns:

the generated secret key

Throws:

NoSuchAlgorithmException - NoSuchAlgorithmException

generateSecretKey

public static SecretKey generateSecretKey(String algorithm,
                                          String providerName,
                                          Provider provider)
                                   throws NoSuchAlgorithmException,
                                          NoSuchProviderException

Generates a new secret key for the given algorithm and provider.

Parameters:

algorithm - the algorithm that will be used for key generation

providerName - the name of the JCE-compliant provider (may be null)

provider - the JCE-compliant provider (may be null)

Returns:

the generated secret key

Throws:

NoSuchAlgorithmException - NoSuchAlgorithmException

NoSuchProviderException - NoSuchProviderException

generateSecretKey

public static SecretKey generateSecretKey(int keySize,
                                          String algorithm,
                                          String providerName,
                                          Provider provider)
                                   throws NoSuchAlgorithmException,
                                          NoSuchProviderException

Generates a new secret key for the given algorithm, key size, and provider.

Parameters:

keySize - the size of the key in bits

algorithm - the algorithm that will be used for key generation

providerName - the name of the JCE-compliant provider (may be null)

provider - the JCE-compliant provider (may be null)

Returns:

the generated secret key

Throws:

NoSuchAlgorithmException - NoSuchAlgorithmException

NoSuchProviderException - NoSuchProviderException

generateAsymmetricKeyPair

public static KeyPair generateAsymmetricKeyPair(String algorithm)
                                         throws NoSuchAlgorithmException

Generates a new asymmetric key pair for the given algorithm.

Parameters:

algorithm - the algorithm that will be used for key generation

Returns:

the generated asymmetric key pair

Throws:

NoSuchAlgorithmException - NoSuchAlgorithmException

generateAsymmetricKeyPair

public static KeyPair generateAsymmetricKeyPair(int keySize,
                                                String algorithm)
                                         throws NoSuchAlgorithmException

Generates a new asymmetric key pair for the given algorithm and key size.

Parameters:

keySize - the size of the key in bits

algorithm - the algorithm that will be used for key generation

Returns:

the generated asymmetric key pair

Throws:

NoSuchAlgorithmException - NoSuchAlgorithmException

generateAsymmetricKeyPair

public static KeyPair generateAsymmetricKeyPair(String algorithm,
                                                String providerName,
                                                Provider provider)
                                         throws NoSuchAlgorithmException,
                                                NoSuchProviderException

Generates a new asymmetric key pair for the given algorithm and provider.

Parameters:

algorithm - the algorithm that will be used for key generation

providerName - the name of the JCE-compliant provider (may be null)

provider - the JCE-compliant provider (may be null)

Returns:

the generated asymmetric key pair

Throws:

NoSuchAlgorithmException - NoSuchAlgorithmException

NoSuchProviderException - NoSuchProviderException

generateAsymmetricKeyPair

public static KeyPair generateAsymmetricKeyPair(int keySize,
                                                String algorithm,
                                                String providerName,
                                                Provider provider)
                                         throws NoSuchAlgorithmException,
                                                NoSuchProviderException

Generates a new asymmetric key pair for the given algorithm, key size, and provider.

Parameters:

keySize - the size of the key in bits

algorithm - the algorithm that will be used for key generation

providerName - the name of the JCE-compliant provider (may be null)

provider - the JCE-compliant provider (may be null)

Returns:

the generated asymmetric key pair

Throws:

NoSuchAlgorithmException - NoSuchAlgorithmException

NoSuchProviderException - NoSuchProviderException

getSecretKeyFromTextKey

public static SecretKey getSecretKeyFromTextKey(String textKey,
                                                String algorithm)

Creates a secret key from the supplied text.

Parameters:

textKey - the text key

algorithm - the algorithm that the will be used for key generation

Returns:

the key value

getSecretKeyFromTextKey

public static SecretKey getSecretKeyFromTextKey(String textKey,
                                                String algorithm,
                                                TextEncoder textEncoder)

Creates a secret key from the supplied text. The optional text encoder is used to decode the key before generating the key.

Parameters:

textKey - the text key

algorithm - the algorithm that will be used for key generation

textEncoder - the text encoder that will be used to decode the text key (if null, the raw bytes will be used).

Returns:

the key value

getSecretKeyFromRawKey

public static SecretKey getSecretKeyFromRawKey(byte[] rawKey,
                                               String algorithm)

Creates a secret key from the supplied raw key byte array.

Parameters:

rawKey - the raw key byte array

algorithm - the algorithm that will be used for key generation

Returns:

the key value

createPublicKey

public static PublicKey createPublicKey(String algorithm,
                                        KeySpec keySpec)
                                 throws InvalidKeySpecException,
                                        NoSuchAlgorithmException

Returns a PublicKey for the given algorithm and KeySpec.

Parameters:

algorithm - the algorithm

keySpec - the KeySpec

Returns:

a PublicKey

Throws:

InvalidKeySpecException - InvalidKeySpecException

NoSuchAlgorithmException - NoSuchAlgorithmException

createPrivateKey

public static PrivateKey createPrivateKey(String algorithm,
                                          KeySpec keySpec)
                                   throws InvalidKeySpecException,
                                          NoSuchAlgorithmException

Returns a PrivateKey for the given algorithm and KeySpec.

Parameters:

algorithm - the algorithm

keySpec - the KeySpec

Returns:

a PrivateKey

Throws:

InvalidKeySpecException - InvalidKeySpecException

NoSuchAlgorithmException - NoSuchAlgorithmException

getKeySpec

public static <T extends KeySpec> T getKeySpec(Key key,
                                               Class<T> keySpec)
                                        throws InvalidKeySpecException,
                                               NoSuchAlgorithmException

Returns a KeySpec for the given key and KeySpec implementation class.

Type Parameters:

T - the KeySpec implementation type

Parameters:

key - the Key

keySpec - the KeySpec implementation class

Returns:

a KeySpec

Throws:

InvalidKeySpecException - InvalidKeySpecException

NoSuchAlgorithmException - NoSuchAlgorithmException