sdkms.v1.models.fpe_options_basic module

Fortanix DSM REST API

This is a set of REST APIs for accessing the Fortanix Data Security Manager. This includes APIs for managing accounts, and for performing cryptographic and key management operations.

OpenAPI spec version: 1.0.0-20200608 Contact: support@fortanix.com Generated by: https://github.com/swagger-api/swagger-codegen.git

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

class sdkms.v1.models.fpe_options_basic.FpeOptionsBasic(radix=None, min_length=None, max_length=None, preserve=None, mask=None, luhn_check=None, name=None)[source]

Bases: object

swagger_types

The key is attribute name and the value is attribute type.

Type:

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type:

dict

__init__(radix=None, min_length=None, max_length=None, preserve=None, mask=None, luhn_check=None, name=None)[source]

FpeOptionsBasic - a model defined in Swagger

property luhn_check

Gets the luhn_check of this FpeOptionsBasic. Whether encrypted/decrypted data should satisfy LUHN checksum formula.

Type: bool

Setter:

Sets the luhn_check of this FpeOptionsBasic.

property mask

Gets the mask of this FpeOptionsBasic. The list of indices of characters to be masked while performing masked decryption. Indices are Python-like, where negative indices index from the back of the token, with -1 referring to the end of the token. It is an error to specify indices greater than (min_length - 1) or less than (-min_length).

Type: list[int]

Setter:

Sets the mask of this FpeOptionsBasic.

property max_length

Gets the max_length of this FpeOptionsBasic. The maximum allowed length for the input data. If not specified, a default max length of 2^16 will be used.

Type: int

Setter:

Sets the max_length of this FpeOptionsBasic.

property min_length

Gets the min_length of this FpeOptionsBasic. The minimum allowed length for the input data. If not specified, as a default, the min length will be set to the smallest value that allows the condition radix^min_length >= 100 to be satisfied.

Type: int

Setter:

Sets the min_length of this FpeOptionsBasic.

property name

Gets the name of this FpeOptionsBasic. The user-friendly name for the data type that represents the input data.

Type: str

Setter:

Sets the name of this FpeOptionsBasic.

property preserve

Gets the preserve of this FpeOptionsBasic. The list of indices of characters to be preserved while performing encryption/decryption. Indices are Python-like, where negative indices index from the back of the token, with -1 referring to the end of the token. It is an error to specify indices greater than (min_length - 1) or less than (-min_length).

Type: list[int]

Setter:

Sets the preserve of this FpeOptionsBasic.

property radix

Gets the radix of this FpeOptionsBasic. The base for input data. The radix should be a number from 2 to 36, inclusive. Each radix corresponds to a subset of ASCII alphanumeric characters (with all letters being uppercase). For instance, a radix of 10 corresponds to a character set consisting of the digits from 0 to 9, while a character set of 16 corresponds to a character set consisting of all hexadecimal digits (with letters A-F being uppercase).

Type: int

Setter:

Sets the radix of this FpeOptionsBasic.