sdkms.v1.models.wrap_key_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.wrap_key_request.WrapKeyRequest(alg=None, kid=None, mode=None, key_format=None, iv=None, ad=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__(alg=None, kid=None, mode=None, key_format=None, iv=None, ad=None, tag_len=None)[source]: WrapKeyRequest - a model defined in Swagger

property ad

Gets the ad of this WrapKeyRequest. For symmetric ciphers with cipher mode GCM or CCM, this optionally specifies the authenticated data used by the cipher. This field must not be provided with other cipher modes.

Type: bytearray

Setter:: Sets the ad of this WrapKeyRequest.

property alg

Gets the alg of this WrapKeyRequest.

Type: ObjectType

Setter:: Sets the alg of this WrapKeyRequest.

property iv

Gets the iv of this WrapKeyRequest. For symmetric ciphers, this value will be used for the cipher initialization value. If not provided, DSM will generate a random iv and return it in the response. If provided, iv length must match the length required by the cipher and mode.

Type: bytearray

Setter:: Sets the iv of this WrapKeyRequest.

property key_format

Gets the key_format of this WrapKeyRequest.

Type: KeyFormat

Setter:: Sets the key_format of this WrapKeyRequest.

property kid

Gets the kid of this WrapKeyRequest. The key ID (not name or description) of the key being wrapped.

Type: str

Setter:: Sets the kid of this WrapKeyRequest.

property mode

Gets the mode of this WrapKeyRequest.

Type: CryptMode

Setter:: Sets the mode of this WrapKeyRequest.

property tag_len

Gets the tag_len of this WrapKeyRequest. For symmetric ciphers with cipher mode GCM or CCM, this field specifies the length of the authentication tag to be produced. This field is specified in bits (not bytes). This field is required for symmetric ciphers with cipher mode GCM or CCM. It must not be specified for asymmetric ciphers and symmetric ciphers with other cipher modes.

Type: int

Setter:: Sets the tag_len of this WrapKeyRequest.