sdkms.v1.models.encrypt_request_frame_init 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.encrypt_request_frame_init.EncryptRequestFrameInit(key=None, mode=None, alg=None, iv=None, tag_len=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__(key=None, mode=None, alg=None, iv=None, tag_len=None)[source]: EncryptRequestFrameInit - a model defined in Swagger

property alg

Gets the alg of this EncryptRequestFrameInit.

Type: ObjectType

Setter:: Sets the alg of this EncryptRequestFrameInit.

property iv

Gets the iv of this EncryptRequestFrameInit. The initialization vector to use for encryption. In CBOR, this is encoded directly as a byte string, not a UTF-8 string. If not provided, one is randomly generated. If provided, the length must match the length required by the cipher and mode.

Type: str

Setter:: Sets the iv of this EncryptRequestFrameInit.

property key

Gets the key of this EncryptRequestFrameInit.

Type: SobjectDescriptor

Setter:: Sets the key of this EncryptRequestFrameInit.

property mode

Gets the mode of this EncryptRequestFrameInit.

Type: CipherMode

Setter:: Sets the mode of this EncryptRequestFrameInit.

property tag_len

Gets the tag_len of this EncryptRequestFrameInit. In AEAD modes, this field specifies the length of the authentication tag to be produced. This field is specified in bits (not bytes). This field is required in AEAD modes, and forbidden otherwise.

Type: int

Setter:: Sets the tag_len of this EncryptRequestFrameInit.