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

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 byte[]	keyAgreement(String algorithm, Provider provider, Key privateKey, Key publicKey)	get secret key
static KeyFactory	keyFactory(String algorithm, Provider provider)	Returns a KeyFactory object that converts public/private keys of the specified algorithm.
static byte[]	mac(String algorithm, Provider provider, String keyAlgorithm, byte[] data, byte[] key)	Mac util
static byte[]	md(String algorithm, Provider provider, byte[] data)	Message Digest util
static SecretKeyFactory	secretKeyFactory(String algorithm, Provider provider)	Secret Key Factory util
static byte[]	secretKeyFactory(String algorithm, Provider provider, KeySpec keySpec)	Secret Key Factory util

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

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 NONPROVIDER.

opmode - cipher mode.

key - crypto key.

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

data - the input data buffer.

Returns:

the new data buffer with the result.

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
• getProvider(String)

cipher

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

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 - the input data buffer.

Returns:

the new data buffer with the result.

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.

NoSuchProviderException

See Also:

• Cipher

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. if you do not need this set NONPROVIDER.

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,
 Provider provider,
 String keyAlgorithm,
 byte[] data,
 byte[] key)
                  throws NoSuchAlgorithmException,
InvalidKeyException,
NullPointerException

Mac util

Parameters:

algorithm - mac hash algorithm.

provider - the provider. if you do not need this set NONPROVIDER.

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,
 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

secretKeyFactory

public static SecretKeyFactory secretKeyFactory(String algorithm,
 Provider provider)
                                         throws NoSuchAlgorithmException,
IllegalArgumentException,
NullPointerException

Secret Key Factory util

Parameters:

algorithm - Secret Key Factory algorithm.

provider - the provider.

Returns:

KeySpec data result.

Throws:

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

IllegalArgumentException - if the provider is null.

NullPointerException - if algorithm is null.

See Also:

• SecretKeyFactory

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.

keyAgreement

public static byte[] keyAgreement(String algorithm,
 Provider provider,
 Key privateKey,
 Key publicKey)
                           throws NoSuchAlgorithmException,
NullPointerException,
InvalidKeyException

get secret key

Parameters:

algorithm - the standard name of the requested key agreement algorithm.

provider - the provider.

privateKey - the party's private information.

publicKey - the key for this phase.

Returns:

the new buffer with the shared secret.

Throws:

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

NullPointerException - if algorithm is null.

InvalidKeyException - if the given key is inappropriate for this key agreement or phase.