sdkms.v1.models.encrypt_request_frame 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.EncryptRequestFrame(init=None, ad=None, plain=None, final=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__(init=None, ad=None, plain=None, final=None)[source]: EncryptRequestFrame - a model defined in Swagger

property ad

Gets the ad of this EncryptRequestFrame. A chunk of additional data for authentication in AEAD modes. In CBOR, this is encoded directly as a byte string, not a UTF-8 string. All “ad” frames must come before any “plain” frames.

Type: str

Setter:: Sets the ad of this EncryptRequestFrame.

property final

Gets the final of this EncryptRequestFrame. All requests must end with a “final” frame. The value is the empty object (a CBOR map with zero items).

Type: object

Setter:: Sets the final of this EncryptRequestFrame.

property init

Gets the init of this EncryptRequestFrame.

Type: EncryptRequestFrameInit

Setter:: Sets the init of this EncryptRequestFrame.

property plain

Gets the plain of this EncryptRequestFrame. A chunk of ciphertext. In CBOR, this is encoded directly as a byte string, not a UTF-8 string. In addition to the 512 KiB limit on the total size of all frames, the content of this field may be at most 511 KiB.

Type: str

Setter:: Sets the plain of this EncryptRequestFrame.