Module seppiko.commons.utils

Package org.seppiko.commons.utils.crypto

Class CryptoUtil

java.lang.Object

org.seppiko.commons.utils.crypto.CryptoUtil

public class CryptoUtil
extends Object

Crypto util

Author:

Leonard Woo

See Also:

• Java Security Standard Algorithm Names

Field Summary

Fields

Modifier and Type	Field	Description
static final Provider	NONPROVIDER	non provider

Constructor Summary

Constructors

Constructor	Description
CryptoUtil()

Method Summary

Modifier and Type	Method	Description
static byte[]	cipher(String algorithm, String providerName, int opmode, Key key, AlgorithmParameterSpec params, byte[] data)	Cipher util
static byte[]	cipher(String algorithm, Provider provider, int opmode, Key key, AlgorithmParameterSpec params, byte[] data)	Cipher util
static Provider	getProvider(String providerName)	Check and get provider object
static KeyFactory	keyFactory(String algorithm)	Returns a KeyFactory object that converts public/private keys of the specified algorithm.
static KeyFactory	keyFactory(String algorithm, Provider provider)	Returns a KeyFactory object that converts public/private keys of the specified algorithm.
static byte[]	keyGenerator(String algorithm, int keysize)	Cryptographic key generator
static byte[]	keyGenerator(String algorithm, Provider provider, int keysize)	Cryptographic key generator
static KeyPair	keyPairGenerator(String algorithm, int keysize)	Asymmetric cryptographic key pair generator
static KeyPair	keyPairGenerator(String algorithm, Provider provider, int keysize)	Asymmetric cryptographic key pair generator
static byte[]	mac(String algorithm, String keyAlgorithm, byte[] data, byte[] key)	Mac util
static byte[]	mac(String algorithm, Provider provider, String keyAlgorithm, byte[] data, byte[] key)	Mac util
static byte[]	md(String algorithm, byte[] data)	Message Digest util
static byte[]	md(String algorithm, Provider provider, byte[] data)	Message Digest util
static byte[]	secretKeyFactory(String algorithm, Provider provider, KeySpec keySpec)	Secret Key Factory util
static byte[]	secretKeyFactory(String algorithm, KeySpec keySpec)	Secret Key Factory util
static byte[]	secureRandom(String algorithm, int seedSize)
static byte[]	secureRandom(String algorithm, Provider provider, int seedSize)
static byte[]	secureRandom(String algorithm, Provider provider, SecureRandomParameters params, int seedSize)

Methods inherited from class java.lang.Object

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

Field Details

NONPROVIDER

public static final Provider NONPROVIDER

non provider

Constructor Details

CryptoUtil

public CryptoUtil()

Method Details

getProvider

public static Provider getProvider(String providerName)
                            throws IllegalArgumentException,
NoSuchProviderException

Check and get provider object

Parameters:

providerName - the name of the provider

Returns:

the provider

Throws:

IllegalArgumentException - if provider name is null or empty.

NoSuchProviderException - if it can not load provider.

cipher

public static byte[] cipher(String algorithm,
 Provider provider,
 int opmode,
 Key key,
 AlgorithmParameterSpec params,
 byte[] data)
                     throws NoSuchPaddingException,
NoSuchAlgorithmException,
InvalidKeyException,
InvalidAlgorithmParameterException,
IllegalBlockSizeException,
BadPaddingException

Cipher util

Parameters:

algorithm - cipher algorithm

provider - cipher provider, if you do not need this set null or CryptoUtil.NONPROVIDER see CryptoUtil.getProvider(providerName)

opmode - cipher mode

key - crypto key

params - Algorithm Parameter Spec, if you do not need this set null

data - raw data

Returns:

data

Throws:

NoSuchPaddingException - if transformation contains a padding scheme that is not available.

NoSuchAlgorithmException - if transformation is null, empty, in an invalid format, or if no Provider supports a CipherSpi implementation for the specified algorithm.

InvalidAlgorithmParameterException - if the given algorithm parameters are inappropriate for this cipher, or this cipher requires algorithm parameters and params is null, or the given algorithm parameters imply a cryptographic strength that would exceed the legal limits (as determined from the configured jurisdiction policy files).

InvalidKeyException - if the given key is inappropriate for initializing this cipher, or its keysize exceeds the maximum allowable keysize (as determined from the configured jurisdiction policy files).

IllegalBlockSizeException - if this cipher is a block cipher, no padding has been requested (only in encryption mode), and the total input length of the data processed by this cipher is not a multiple of block size; or if this encryption algorithm is unable to process the input data provided.

BadPaddingException - if this cipher is in decryption mode, and (un)padding has been requested, but the decrypted data is not bounded by the appropriate padding bytes.

AEADBadTagException - – if this cipher is decrypting in an AEAD mode (such as GCM/CCM), and the received authentication tag does not match the calculated value.

See Also:

• Cipher

cipher

public static byte[] cipher(String algorithm,
 String providerName,
 int opmode,
 Key key,
 AlgorithmParameterSpec params,
 byte[] data)
                     throws InvalidAlgorithmParameterException,
NoSuchPaddingException,
IllegalBlockSizeException,
NoSuchAlgorithmException,
BadPaddingException,
InvalidKeyException

Cipher util

Parameters:

algorithm - cipher algorithm

providerName - cipher provider name, if you do not need this set null or ""

opmode - cipher mode

key - crypto key

params - Algorithm Parameter Spec, if you do not need this set null

data - raw data

Returns:

data

Throws:

NoSuchPaddingException - if transformation contains a padding scheme that is not available.

NoSuchAlgorithmException - if transformation is null, empty, in an invalid format, or if no Provider supports a CipherSpi implementation for the specified algorithm.

InvalidAlgorithmParameterException - if the given algorithm parameters are inappropriate for this cipher, or this cipher requires algorithm parameters and params is null, or the given algorithm parameters imply a cryptographic strength that would exceed the legal limits (as determined from the configured jurisdiction policy files).

InvalidKeyException - if the given key is inappropriate for initializing this cipher, or its keysize exceeds the maximum allowable keysize (as determined from the configured jurisdiction policy files).

IllegalBlockSizeException - if this cipher is a block cipher, no padding has been requested (only in encryption mode), and the total input length of the data processed by this cipher is not a multiple of block size; or if this encryption algorithm is unable to process the input data provided.

BadPaddingException - if this cipher is in decryption mode, and (un)padding has been requested, but the decrypted data is not bounded by the appropriate padding bytes.

AEADBadTagException - – if this cipher is decrypting in an AEAD mode (such as GCM/CCM), and the received authentication tag does not match the calculated value.

See Also:

• Cipher

md

public static byte[] md(String algorithm,
 byte[] data)
                 throws NoSuchAlgorithmException,
NullPointerException

Message Digest util

Parameters:

algorithm - Message Digest Algorithm

data - raw data

Returns:

data hash

Throws:

NoSuchAlgorithmException - if no Provider supports a MessageDigestSpi implementation for the specified algorithm.

NullPointerException - if algorithm is null.

See Also:

• MessageDigest

md

public static byte[] md(String algorithm,
 Provider provider,
 byte[] data)
                 throws NoSuchAlgorithmException,
NullPointerException,
IllegalArgumentException

Message Digest util

Parameters:

algorithm - Message Digest Algorithm

provider - the provider

data - raw data

Returns:

data hash

Throws:

NoSuchAlgorithmException - if no Provider supports a MessageDigestSpi implementation for the specified algorithm.

NullPointerException - if algorithm is null.

IllegalArgumentException - if provider is null.

See Also:

• MessageDigest

mac

public static byte[] mac(String algorithm,
 String keyAlgorithm,
 byte[] data,
 byte[] key)
                  throws NoSuchAlgorithmException,
InvalidKeyException,
NullPointerException

Mac util

Parameters:

algorithm - mac hash algorithm

keyAlgorithm - mac hash key algorithm

data - raw data

key - mac hash key

Returns:

data hash

Throws:

NoSuchAlgorithmException - if no Provider supports a MacSpi implementation for the specified algorithm.

InvalidKeyException - if the given key is inappropriate for initializing this MAC.

NullPointerException - if algorithm is null.

See Also:

• Mac

mac

public static byte[] mac(String algorithm,
 Provider provider,
 String keyAlgorithm,
 byte[] data,
 byte[] key)
                  throws NoSuchAlgorithmException,
InvalidKeyException,
NullPointerException

Mac util

Parameters:

algorithm - mac hash algorithm

provider - the provider

keyAlgorithm - mac hash key algorithm

data - raw data

key - mac hash key

Returns:

data hash

Throws:

NoSuchAlgorithmException - if no Provider supports a MacSpi implementation for the specified algorithm.

InvalidKeyException - if the given key is inappropriate for initializing this MAC.

NullPointerException - if algorithm is null.

See Also:

• Mac

secretKeyFactory

public static byte[] secretKeyFactory(String algorithm,
 KeySpec keySpec)
                               throws NoSuchAlgorithmException,
InvalidKeySpecException,
NullPointerException

Secret Key Factory util

Parameters:

algorithm - Secret Key Factory algorithm

keySpec - KeySpec impl e.g. PBEKeySpec

Returns:

KeySpec data result

Throws:

NoSuchAlgorithmException - if no Provider supports a SecretKeyFactorySpi implementation for the specified algorithm.

InvalidKeySpecException - if the given key specification is inappropriate for this secret-key factory to produce a secret key.

NullPointerException - if algorithm is null.

See Also:

• SecretKeyFactory

secretKeyFactory

public static byte[] secretKeyFactory(String algorithm,
 Provider provider,
 KeySpec keySpec)
                               throws NoSuchAlgorithmException,
InvalidKeySpecException,
IllegalArgumentException,
NullPointerException

Secret Key Factory util

Parameters:

algorithm - Secret Key Factory algorithm

provider - the provider

keySpec - KeySpec impl e.g. PBEKeySpec

Returns:

KeySpec data result

Throws:

NoSuchAlgorithmException - if no Provider supports a SecretKeyFactorySpi implementation for the specified algorithm.

InvalidKeySpecException - if the given key specification is inappropriate for this secret-key factory to produce a secret key.

IllegalArgumentException - if the provider is null.

NullPointerException - if algorithm is null.

See Also:

• SecretKeyFactory

keyFactory

public static KeyFactory keyFactory(String algorithm)
                             throws NullPointerException,
NoSuchAlgorithmException

Returns a KeyFactory object that converts public/private keys of the specified algorithm.

Parameters:

algorithm - key algorithm

Returns:

KeyFactory object

Throws:

NullPointerException - if algorithm is null.

NoSuchAlgorithmException - the name of the requested key algorithm.

keyFactory

public static KeyFactory keyFactory(String algorithm,
 Provider provider)
                             throws NullPointerException,
NoSuchAlgorithmException,
IllegalArgumentException

Returns a KeyFactory object that converts public/private keys of the specified algorithm.

Parameters:

algorithm - key algorithm

provider - algorithm provider

Returns:

KeyFactory object

Throws:

NullPointerException - if algorithm is null

NoSuchAlgorithmException - if a KeyFactorySpi implementation for the specified algorithm is not available from the specified provider

IllegalArgumentException - if the specified provider is null

keyGenerator

public static byte[] keyGenerator(String algorithm,
 int keysize)
                           throws NoSuchAlgorithmException,
NullPointerException

Cryptographic key generator

Parameters:

algorithm - the standard name of the requested key algorithm

keysize - key size

Returns:

secret key byte array

Throws:

NoSuchAlgorithmException - if a KeyGeneratorSpi implementation for the specified algorithm is not available from the specified Provider object

NullPointerException - if algorithm is null

keyGenerator

public static byte[] keyGenerator(String algorithm,
 Provider provider,
 int keysize)
                           throws NoSuchAlgorithmException,
NullPointerException,
IllegalArgumentException

Cryptographic key generator

Parameters:

algorithm - the standard name of the requested key algorithm

provider - the provider

keysize - key size

Returns:

secret key byte array

Throws:

NoSuchAlgorithmException - if a KeyGeneratorSpi implementation for the specified algorithm is not available from the specified Provider object

NullPointerException - if algorithm is null

IllegalArgumentException - if the provider is null

keyPairGenerator

public static KeyPair keyPairGenerator(String algorithm,
 int keysize)
                                throws NoSuchAlgorithmException

Asymmetric cryptographic key pair generator

Parameters:

algorithm - the standard string name of the algorithm

keysize - key size

Returns:

key pair

Throws:

NoSuchAlgorithmException - if no Provider supports a KeyPairGeneratorSpi implementation for the specified algorithm.

See Also:

• KeyPairGenerator

keyPairGenerator

public static KeyPair keyPairGenerator(String algorithm,
 Provider provider,
 int keysize)
                                throws NoSuchAlgorithmException,
IllegalArgumentException,
NullPointerException

Asymmetric cryptographic key pair generator

Parameters:

algorithm - the standard string name of the algorithm

provider - the provider

keysize - key size

Returns:

key pair

Throws:

NoSuchAlgorithmException - if no Provider supports a KeyPairGeneratorSpi implementation for the specified algorithm.

IllegalArgumentException - if the provider is null.

NullPointerException - if algorithm is null.

See Also:

• KeyPairGenerator

secureRandom

public static byte[] secureRandom(String algorithm,
 int seedSize)
                           throws NoSuchAlgorithmException,
NullPointerException,
IllegalArgumentException

Parameters:

algorithm - the name of the RNG algorithm.

seedSize - the number of seed bytes to generate.

Returns:

the seed bytes.

Throws:

NoSuchAlgorithmException - if no Provider supports the specified algorithm.

NullPointerException - if algorithm is null or empty.

IllegalArgumentException - if seedSize is negative.

secureRandom

public static byte[] secureRandom(String algorithm,
 Provider provider,
 int seedSize)
                           throws NoSuchAlgorithmException,
NullPointerException,
IllegalArgumentException

Parameters:

algorithm - the name of the RNG algorithm.

provider - the provider.

seedSize - the number of seed bytes to generate.

Returns:

the seed bytes.

Throws:

NoSuchAlgorithmException - if no Provider supports the specified algorithm.

NullPointerException - if algorithm is null or empty, if the specified provider is null.

IllegalArgumentException - if seedSize is negative.

secureRandom

public static byte[] secureRandom(String algorithm,
 Provider provider,
 SecureRandomParameters params,
 int seedSize)
                           throws NoSuchAlgorithmException,
NullPointerException,
IllegalArgumentException

Parameters:

algorithm - the name of the RNG algorithm.

provider - the provider.

params - the SecureRandomParameters the newly created SecureRandom object must support.

seedSize - the number of seed bytes to generate.

Returns:

the seed bytes.

Throws:

NoSuchAlgorithmException - if no Provider supports the specified algorithm.

NullPointerException - if algorithm is null or empty, if the specified provider or params is null.

IllegalArgumentException - if seedSize is negative.