com.delphix.masking.api.plugin.utils

Class CryptoServiceImpl

java.lang.Object

com.delphix.masking.api.plugin.utils.CryptoServiceImpl

All Implemented Interfaces:

CryptoService

public class CryptoServiceImpl
extends java.lang.Object
implements CryptoService

This class provides the actual implementation of the cryptographic service interface in the Masking API. Each object of this class wraps a key, as well as any in-use cryptographic sessions associated with that key. The masking engine generates and stores 256-bit keys. For all current usage - SHA-256, AES-128/256, this is sufficient. In the future, we can handle larger key sizes, though it might be necessary to enforce a minimum key size for particular usages. SHA-256 works with any size, so we don't enforce any maximum key size. We do enforce a minimum key size to prevent overly weak keys from being used.

Field Summary

Fields

Modifier and Type	Field and Description
static int	KEY_LENGTH

Fields inherited from interface com.delphix.masking.api.provider.CryptoService

MINIMUM_KEY_SIZE_BYTES

Constructor Summary

Constructors

Constructor and Description
CryptoServiceImpl(byte[] key)

Method Summary

Modifier and Type	Method and Description
long	computeHashedLookupIndex(java.math.BigDecimal input, long modulus) Compute the cryptographic hash of a number, compressed into the range 0 to modulus - 1.
long	computeHashedLookupIndex(java.nio.ByteBuffer input, long modulus) Compute the cryptographic hash of a byte buffer, compressed into the range 0 to modulus - 1.
long	computeHashedLookupIndex(java.util.Date input, long modulus) Compute the cryptographic hash of a date, compressed into the range 0 to modulus - 1.
long	computeHashedLookupIndex(java.time.LocalDateTime input, long modulus) Compute the cryptographic hash of a localdatetime, compressed into the range 0 to modulus - 1.
long	computeHashedLookupIndex(java.lang.String input, long modulus) Compute the cryptographic hash of a string, compressed into the range 0 to modulus - 1.
CryptoService	deriveNewKey() Create a new cryptographic service provider by deriving a new key from this provider's key.
CryptoService	deriveNewKey(byte[] salt) Create a new cryptographic service provider by deriving a new key from this provider's key combined with the provided salt value.
CryptoService	deriveNewKey(java.lang.String salt) Create a new cryptographic service provider by deriving a new key from this provider's key combined with the provided salt value.
byte[]	getRawKey() Retrieve the raw key wrapped by this service provider.
void	shuffleList(java.util.List<?> list) Shuffle the provided list in-place.
void	shuffleListNoCollisions(java.util.List<?> list) Shuffle the provided list in-place.
CryptoService	wrap(byte[] keyIn) Create a new cryptographic service provider by wrapping the provided key.

Methods inherited from class java.lang.Object

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

Field Detail

KEY_LENGTH

public static final int KEY_LENGTH

See Also:

Constant Field Values

Constructor Detail

CryptoServiceImpl

public CryptoServiceImpl(byte[] key)

Method Detail

getRawKey

public byte[] getRawKey()

Description copied from interface: CryptoService

Retrieve the raw key wrapped by this service provider.

Specified by:

getRawKey in interface CryptoService

Returns:

The key

wrap

public CryptoService wrap(@Nonnull
                          byte[] keyIn)

Description copied from interface: CryptoService

Create a new cryptographic service provider by wrapping the provided key.

Specified by:

wrap in interface CryptoService

Parameters:

keyIn - The key value to use

Returns:

The new cryptographic service provider

deriveNewKey

public CryptoService deriveNewKey()

Description copied from interface: CryptoService

Create a new cryptographic service provider by deriving a new key from this provider's key.

Specified by:

deriveNewKey in interface CryptoService

Returns:

The new cryptographic service provider

deriveNewKey

public CryptoService deriveNewKey(@Nullable
                                  byte[] salt)

Description copied from interface: CryptoService

Create a new cryptographic service provider by deriving a new key from this provider's key combined with the provided salt value.

Specified by:

deriveNewKey in interface CryptoService

Parameters:

salt - The salt value to use

Returns:

The new cryptographic service provider

deriveNewKey

public CryptoService deriveNewKey(@Nullable
                                  java.lang.String salt)

Description copied from interface: CryptoService

Create a new cryptographic service provider by deriving a new key from this provider's key combined with the provided salt value.

Specified by:

deriveNewKey in interface CryptoService

Parameters:

salt - The salt value to use

Returns:

The new cryptographic service provider

computeHashedLookupIndex

public final long computeHashedLookupIndex(@Nonnull
                                           java.math.BigDecimal input,
                                           long modulus)

Description copied from interface: CryptoService

Compute the cryptographic hash of a number, compressed into the range 0 to modulus - 1. When used to compute the index of a replacement value from a replacement set, Modulus should be the size of the replacement set.

Specified by:

computeHashedLookupIndex in interface CryptoService

Parameters:

input - The value to hash

modulus - The modulus, which must be greater than 0

Returns:

The lookup index

computeHashedLookupIndex

public final long computeHashedLookupIndex(@Nonnull
                                           java.nio.ByteBuffer input,
                                           long modulus)

Description copied from interface: CryptoService

Compute the cryptographic hash of a byte buffer, compressed into the range 0 to modulus - 1. When used to compute the index of a replacement value from a replacement set, Modulus should be the size of the replacement set.

Specified by:

computeHashedLookupIndex in interface CryptoService

Parameters:

input - The value to hash

modulus - The modulus, which must be greater than 0

Returns:

The lookup index

computeHashedLookupIndex

public final long computeHashedLookupIndex(@Nonnull
                                           java.util.Date input,
                                           long modulus)

Description copied from interface: CryptoService

Compute the cryptographic hash of a date, compressed into the range 0 to modulus - 1. When used to compute the index of a replacement value from a replacement set, Modulus should be the size of the replacement set.

Specified by:

computeHashedLookupIndex in interface CryptoService

Parameters:

input - The value to hash

modulus - The modulus, which must be greater than 0

Returns:

The lookup index

computeHashedLookupIndex

public final long computeHashedLookupIndex(@Nonnull
                                           java.time.LocalDateTime input,
                                           long modulus)

Description copied from interface: CryptoService

Compute the cryptographic hash of a localdatetime, compressed into the range 0 to modulus - 1. When used to compute the index of a replacement value from a replacement set, Modulus should be the size of the replacement set.

Specified by:

computeHashedLookupIndex in interface CryptoService

Parameters:

input - The value to hash

modulus - The modulus, which must be greater than 0

Returns:

The lookup index

computeHashedLookupIndex

public final long computeHashedLookupIndex(@Nonnull
                                           java.lang.String input,
                                           long modulus)

Description copied from interface: CryptoService

Compute the cryptographic hash of a string, compressed into the range 0 to modulus - 1. When used to compute the index of a replacement value from a replacement set, Modulus should be the size of the replacement set.

Specified by:

computeHashedLookupIndex in interface CryptoService

Parameters:

input - The value to hash

modulus - The modulus, which must be greater than 0

Returns:

The lookup index

shuffleList

public void shuffleList(@Nonnull
                        java.util.List<?> list)

Description copied from interface: CryptoService

Shuffle the provided list in-place. The resulting permutation depends on this provider's key.

Specified by:

shuffleList in interface CryptoService

Parameters:

list - The list to shuffle.

shuffleListNoCollisions

public void shuffleListNoCollisions(@Nonnull
                                    java.util.List<?> list)

Description copied from interface: CryptoService

Shuffle the provided list in-place. The resulting permutation depends on this provider's key. For lists with at least two items, the resulting permutation is guaranteed to move each item to a new position.

Specified by:

shuffleListNoCollisions in interface CryptoService

Parameters:

list - The list to shuffle.