Struct google_dlp2_beta1::GooglePrivacyDlpV2beta1CryptoReplaceFfxFpeConfig

pub struct GooglePrivacyDlpV2beta1CryptoReplaceFfxFpeConfig {
    pub crypto_key: Option<GooglePrivacyDlpV2beta1CryptoKey>,
    pub custom_alphabet: Option<String>,
    pub radix: Option<i32>,
    pub context: Option<GooglePrivacyDlpV2beta1FieldId>,
    pub surrogate_info_type: Option<GooglePrivacyDlpV2beta1InfoType>,
    pub common_alphabet: Option<String>,
}

Replaces an identifier with a surrogate using FPE with the FFX mode of operation. The identifier must be representable by the US-ASCII character set. 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.

This type is not used in any activity, and only used as part of another schema.

Fields

crypto_key: Option<GooglePrivacyDlpV2beta1CryptoKey>

The key used by the encryption algorithm. [required]

custom_alphabet: Option<String>

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, 62]. This must be encoded as ASCII. The order of characters does not matter.

radix: Option<i32>

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

context: Option<GooglePrivacyDlpV2beta1FieldId>

A context may be used for higher security since the same identifier in two different contexts likely will be given a distinct surrogate. The principle is that the likeliness is inversely related to the ratio of the number of distinct identifiers per context over the number of possible surrogates: As long as this ratio is small, the likehood is large.

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
2. 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 ContentItems. 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

This is also known as the 'tweak', as in tweakable encryption.

surrogate_info_type: Option<GooglePrivacyDlpV2beta1InfoType>

The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type 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 info type 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 info type SurrogateType. This facilitates reversal of the surrogate when it occurs in free text.

In order for inspection to work properly, the name of this info type 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 info type 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

common_alphabet: Option<String>

no description provided

Trait Implementations

impl Default for GooglePrivacyDlpV2beta1CryptoReplaceFfxFpeConfig

fn default() -> GooglePrivacyDlpV2beta1CryptoReplaceFfxFpeConfig

Returns the "default value" for a type.

impl Clone for GooglePrivacyDlpV2beta1CryptoReplaceFfxFpeConfig

fn clone(&self) -> GooglePrivacyDlpV2beta1CryptoReplaceFfxFpeConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GooglePrivacyDlpV2beta1CryptoReplaceFfxFpeConfig

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Part for GooglePrivacyDlpV2beta1CryptoReplaceFfxFpeConfig