Class: Google::Cloud::Dlp::V2::CryptoReplaceFfxFpeConfig

Inherits:

Object

• Object
• Google::Cloud::Dlp::V2::CryptoReplaceFfxFpeConfig

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/privacy/dlp/v2/dlp.rb

Overview

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/sensitive-data-protection/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.

Defined Under Namespace

Modules: FfxCommonNativeAlphabet

Instance Attribute Summary

• #common_alphabet ⇒ ::Google::Cloud::Dlp::V2::CryptoReplaceFfxFpeConfig::FfxCommonNativeAlphabet

  Common alphabets.

• #context ⇒ ::Google::Cloud::Dlp::V2::FieldId

  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.

• #crypto_key ⇒ ::Google::Cloud::Dlp::V2::CryptoKey

  Required.

• #custom_alphabet ⇒ ::String

  This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports.

• #radix ⇒ ::Integer

  The native way to select the alphabet.

• #surrogate_info_type ⇒ ::Google::Cloud::Dlp::V2::InfoType

  The custom infoType to annotate the surrogate with.

Instance Attribute Details

#common_alphabet ⇒ ::Google::Cloud::Dlp::V2::CryptoReplaceFfxFpeConfig::FfxCommonNativeAlphabet

# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 2665

class CryptoReplaceFfxFpeConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # These are commonly used subsets of the alphabet that the FFX mode
  # natively supports. In the algorithm, the alphabet is selected using
  # the "radix". Therefore each corresponds to a particular radix.
  module FfxCommonNativeAlphabet
    # Unused.
    FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED = 0

    # `[0-9]` (radix of 10)
    NUMERIC = 1

    # `[0-9A-F]` (radix of 16)
    HEXADECIMAL = 2

    # `[0-9A-Z]` (radix of 36)
    UPPER_CASE_ALPHA_NUMERIC = 3

    # `[0-9A-Za-z]` (radix of 62)
    ALPHA_NUMERIC = 4
  end
end

#context ⇒ ::Google::Cloud::Dlp::V2::FieldId

# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 2665

class CryptoReplaceFfxFpeConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # These are commonly used subsets of the alphabet that the FFX mode
  # natively supports. In the algorithm, the alphabet is selected using
  # the "radix". Therefore each corresponds to a particular radix.
  module FfxCommonNativeAlphabet
    # Unused.
    FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED = 0

    # `[0-9]` (radix of 10)
    NUMERIC = 1

    # `[0-9A-F]` (radix of 16)
    HEXADECIMAL = 2

    # `[0-9A-Z]` (radix of 36)
    UPPER_CASE_ALPHA_NUMERIC = 3

    # `[0-9A-Za-z]` (radix of 62)
    ALPHA_NUMERIC = 4
  end
end

#crypto_key ⇒ ::Google::Cloud::Dlp::V2::CryptoKey

# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 2665

class CryptoReplaceFfxFpeConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # These are commonly used subsets of the alphabet that the FFX mode
  # natively supports. In the algorithm, the alphabet is selected using
  # the "radix". Therefore each corresponds to a particular radix.
  module FfxCommonNativeAlphabet
    # Unused.
    FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED = 0

    # `[0-9]` (radix of 10)
    NUMERIC = 1

    # `[0-9A-F]` (radix of 16)
    HEXADECIMAL = 2

    # `[0-9A-Z]` (radix of 36)
    UPPER_CASE_ALPHA_NUMERIC = 3

    # `[0-9A-Za-z]` (radix of 62)
    ALPHA_NUMERIC = 4
  end
end

#custom_alphabet ⇒ ::String

# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 2665

class CryptoReplaceFfxFpeConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # These are commonly used subsets of the alphabet that the FFX mode
  # natively supports. In the algorithm, the alphabet is selected using
  # the "radix". Therefore each corresponds to a particular radix.
  module FfxCommonNativeAlphabet
    # Unused.
    FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED = 0

    # `[0-9]` (radix of 10)
    NUMERIC = 1

    # `[0-9A-F]` (radix of 16)
    HEXADECIMAL = 2

    # `[0-9A-Z]` (radix of 36)
    UPPER_CASE_ALPHA_NUMERIC = 3

    # `[0-9A-Za-z]` (radix of 62)
    ALPHA_NUMERIC = 4
  end
end

#radix ⇒ ::Integer

# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 2665

class CryptoReplaceFfxFpeConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # These are commonly used subsets of the alphabet that the FFX mode
  # natively supports. In the algorithm, the alphabet is selected using
  # the "radix". Therefore each corresponds to a particular radix.
  module FfxCommonNativeAlphabet
    # Unused.
    FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED = 0

    # `[0-9]` (radix of 10)
    NUMERIC = 1

    # `[0-9A-F]` (radix of 16)
    HEXADECIMAL = 2

    # `[0-9A-Z]` (radix of 36)
    UPPER_CASE_ALPHA_NUMERIC = 3

    # `[0-9A-Za-z]` (radix of 62)
    ALPHA_NUMERIC = 4
  end
end

#surrogate_info_type ⇒ ::Google::Cloud::Dlp::V2::InfoType

# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 2665

class CryptoReplaceFfxFpeConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # These are commonly used subsets of the alphabet that the FFX mode
  # natively supports. In the algorithm, the alphabet is selected using
  # the "radix". Therefore each corresponds to a particular radix.
  module FfxCommonNativeAlphabet
    # Unused.
    FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED = 0

    # `[0-9]` (radix of 10)
    NUMERIC = 1

    # `[0-9A-F]` (radix of 16)
    HEXADECIMAL = 2

    # `[0-9A-Z]` (radix of 36)
    UPPER_CASE_ALPHA_NUMERIC = 3

    # `[0-9A-Za-z]` (radix of 62)
    ALPHA_NUMERIC = 4
  end
end