com.google.api.services.dlp.v2.model

Class GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dlp.v2.model.GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig
extends GenericJson

Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/dlp/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Data Loss Prevention (DLP) API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig()

Method Summary

Modifier and Type	Method and Description
GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig	clone()
String	getCommonAlphabet() Common alphabets.
GooglePrivacyDlpV2FieldId	getContext() The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate.
GooglePrivacyDlpV2CryptoKey	getCryptoKey() Required.
String	getCustomAlphabet() This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports.
Integer	getRadix() The native way to select the alphabet.
GooglePrivacyDlpV2InfoType	getSurrogateInfoType() The custom infoType to annotate the surrogate with.
GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig	set(String fieldName, Object value)
GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig	setCommonAlphabet(String commonAlphabet) Common alphabets.
GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig	setContext(GooglePrivacyDlpV2FieldId context) The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate.
GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig	setCryptoKey(GooglePrivacyDlpV2CryptoKey cryptoKey) Required.
GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig	setCustomAlphabet(String customAlphabet) This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports.
GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig	setRadix(Integer radix) The native way to select the alphabet.
GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig	setSurrogateInfoType(GooglePrivacyDlpV2InfoType surrogateInfoType) The custom infoType to annotate the surrogate with.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig

public GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig()

Method Detail

getCommonAlphabet

public String getCommonAlphabet()

Common alphabets.

Returns:

value or null for none

setCommonAlphabet

public GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig setCommonAlphabet(String commonAlphabet)

Common alphabets.

Parameters:

commonAlphabet - commonAlphabet or null for none

getContext

public GooglePrivacyDlpV2FieldId getContext()

The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and non-structured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2

Returns:

value or null for none

setContext

public GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig setContext(GooglePrivacyDlpV2FieldId context)

The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and non-structured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2

Parameters:

context - context or null for none

getCryptoKey

public GooglePrivacyDlpV2CryptoKey getCryptoKey()

Required. The key used by the encryption algorithm.

Returns:

value or null for none

setCryptoKey

public GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig setCryptoKey(GooglePrivacyDlpV2CryptoKey cryptoKey)

Required. The key used by the encryption algorithm.

Parameters:

cryptoKey - cryptoKey or null for none

getCustomAlphabet

public String getCustomAlphabet()

This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/

Returns:

value or null for none

setCustomAlphabet

public GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig setCustomAlphabet(String customAlphabet)

This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/

Parameters:

customAlphabet - customAlphabet or null for none

getRadix

public Integer getRadix()

The native way to select the alphabet. Must be in the range [2, 95].

Returns:

value or null for none

setRadix

public GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig setRadix(Integer radix)

The native way to select the alphabet. Must be in the range [2, 95].

Parameters:

radix - radix or null for none

getSurrogateInfoType

public GooglePrivacyDlpV2InfoType getSurrogateInfoType()

The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/dlp/docs/reference/rest/v2 /InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE

Returns:

value or null for none

setSurrogateInfoType

public GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig setSurrogateInfoType(GooglePrivacyDlpV2InfoType surrogateInfoType)

The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/dlp/docs/reference/rest/v2 /InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE

Parameters:

surrogateInfoType - surrogateInfoType or null for none

set

public GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig set(String fieldName,
                                                       Object value)

Overrides:

set in class GenericJson

clone

public GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig clone()

Overrides:

clone in class GenericJson