sdkms.v1.models.decrypt_request 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

http://www.apache.org/licenses/LICENSE-2.0

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.decrypt_request.DecryptRequest(alg=None, cipher=None, mode=None, iv=None, ad=None, tag=None, masked=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__(alg=None, cipher=None, mode=None, iv=None, ad=None, tag=None, masked=None)[source]: DecryptRequest - a model defined in Swagger

property ad

Gets the ad of this DecryptRequest. The authenticated data used with this ciphertext and authentication tag. This field is required for symmetric ciphers using cipher mode GCM or CCM, and must not be specified for all other ciphers.

Type: bytearray

Setter:: Sets the ad of this DecryptRequest.

property alg

Gets the alg of this DecryptRequest.

Type: ObjectType

Setter:: Sets the alg of this DecryptRequest.

property cipher

Gets the cipher of this DecryptRequest. The ciphertext to decrypt.

Type: bytearray

Setter:: Sets the cipher of this DecryptRequest.

property iv

Gets the iv of this DecryptRequest. The initialization value used to encrypt this ciphertext. This field is required for symmetric ciphers, and ignored for asymmetric ciphers.

Type: bytearray

Setter:: Sets the iv of this DecryptRequest.

property masked

Gets the masked of this DecryptRequest. This flag is only useful with DECRYPT permission. When this flag is true, decryption returns masked output. Setting it to false is equivalent to not using this flag. With MASKDECRYPT permission, this flag is ignored.

Type: bool

Setter:: Sets the masked of this DecryptRequest.

property mode

Gets the mode of this DecryptRequest.

Type: CryptMode

Setter:: Sets the mode of this DecryptRequest.

property tag

Gets the tag of this DecryptRequest. The authentication tag used with this ciphertext and authenticated data. This field is required for symmetric ciphers using cipher mode GCM or CCM, and must not be specified for all other ciphers.

Type: bytearray

Setter:: Sets the tag of this DecryptRequest.