Transform: FPE - Strings

class gretel_client.transformers.transformers.fpe_string.FpeString(config: gretel_client.transformers.transformers.fpe_string.FpeStringConfig)
config_class

alias of FpeStringConfig

class gretel_client.transformers.transformers.fpe_string.FpeStringConfig(labels: List[str] = None, minimum_score: Optional[float] = None, radix: int = None, secret: str = None, aes_mode: gretel_client.transformers.fpe.crypto_aes.Mode = <Mode.CBC: 2>, mask: List[gretel_client.transformers.string_mask.StringMask] = None)

FpeString transformer applies a format preserving encryption as defined by https://www.nist.gov/ to the data value. The encryption works on strings. The result is stateless and given the correct key, the original value can be restored.

Parameters
  • radix – Base from 2 to 62, determines base of incoming data types. Base2 = binary, Base62 = alphanumeric including upper and lower case characters.

  • secret – 256bit AES encryption string specified as 64 hexadecimal characters.

  • mask – An optional list of StringMask objects. If provided only the parts of the string defined by the masks will be encrypted.