com.delphix.masking.api.provider

Interface CryptoService

All Known Implementing Classes:

CryptoServiceImpl

public interface CryptoService

This interface provides access to keys and other key-based cryptographic operations. Objects implementing this interface act as lightweight wrappers around a single key. More keys may be generated deterministically using the derive methods provided.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MINIMUM_KEY_SIZE_BYTES The minimum length allowed for keys in bytes.

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[] key) Create a new cryptographic service provider by wrapping the provided key.

Field Detail

MINIMUM_KEY_SIZE_BYTES

static final int MINIMUM_KEY_SIZE_BYTES

The minimum length allowed for keys in bytes. Attempting to wrap a smaller key will result in an exception.

See Also:

Constant Field Values

Method Detail

getRawKey

byte[] getRawKey()

Retrieve the raw key wrapped by this service provider.

Returns:

The key

wrap

CryptoService wrap(@Nonnull
                   byte[] key)

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

Parameters:

key - The key value to use

Returns:

The new cryptographic service provider

deriveNewKey

CryptoService deriveNewKey()

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

Returns:

The new cryptographic service provider

deriveNewKey

CryptoService deriveNewKey(@Nullable
                           byte[] salt)

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

Parameters:

salt - The salt value to use

Returns:

The new cryptographic service provider

deriveNewKey

CryptoService deriveNewKey(@Nullable
                           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.

Parameters:

salt - The salt value to use

Returns:

The new cryptographic service provider

computeHashedLookupIndex

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

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.

Parameters:

input - The value to hash

modulus - The modulus, which must be greater than 0

Returns:

The lookup index

computeHashedLookupIndex

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

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.

Parameters:

input - The value to hash

modulus - The modulus, which must be greater than 0

Returns:

The lookup index

computeHashedLookupIndex

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

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.

Parameters:

input - The value to hash

modulus - The modulus, which must be greater than 0

Returns:

The lookup index

computeHashedLookupIndex

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

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.

Parameters:

input - The value to hash

modulus - The modulus, which must be greater than 0

Returns:

The lookup index

computeHashedLookupIndex

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

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.

Parameters:

input - The value to hash

modulus - The modulus, which must be greater than 0

Returns:

The lookup index

shuffleList

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

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

Parameters:

list - The list to shuffle.

shuffleListNoCollisions

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

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.

Parameters:

list - The list to shuffle.