sdkms.v1.models.unwrap_key_request_ex 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.unwrap_key_request_ex.UnwrapKeyRequestEx(key=None, alg=None, group_id=None, obj_type=None, wrapped_key=None, mode=None, iv=None, ad=None, tag=None, name=None, description=None, key_ops=None, custom_metadata=None, enabled=None, rsa=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, alg=None, group_id=None, obj_type=None, wrapped_key=None, mode=None, iv=None, ad=None, tag=None, name=None, description=None, key_ops=None, custom_metadata=None, enabled=None, rsa=None)[source]: UnwrapKeyRequestEx - a model defined in Swagger

property ad

Gets the ad of this UnwrapKeyRequestEx. 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 UnwrapKeyRequestEx.

property alg

Gets the alg of this UnwrapKeyRequestEx.

Type: ObjectType

Setter:: Sets the alg of this UnwrapKeyRequestEx.

property custom_metadata

Gets the custom_metadata of this UnwrapKeyRequestEx. User-defined metadata for this key. Stored as key-value pairs.

Type: map[str]

Setter:: Sets the custom_metadata of this UnwrapKeyRequestEx.

property description

Gets the description of this UnwrapKeyRequestEx. Description of the Security object to unwrap.

Type: str

Setter:: Sets the description of this UnwrapKeyRequestEx.

property enabled

Gets the enabled of this UnwrapKeyRequestEx. Whether the new security object should be enabled. Disabled security objects may not perform cryptographic operations.

Type: bool

Setter:: Sets the enabled of this UnwrapKeyRequestEx.

property group_id

Gets the group_id of this UnwrapKeyRequestEx. Group ID (not name) of the security group that this security object should belong to. The user or application creating this security object must be a member of this group. If no group is specified, the default group for the user or application will be used.

Type: str

Setter:: Sets the group_id of this UnwrapKeyRequestEx.

property iv

Gets the iv of this UnwrapKeyRequestEx. 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 UnwrapKeyRequestEx.

property key

Gets the key of this UnwrapKeyRequestEx.

Type: SobjectDescriptor

Setter:: Sets the key of this UnwrapKeyRequestEx.

property key_ops

Gets the key_ops of this UnwrapKeyRequestEx. Optional array of key operations to be enabled for this security object. If this property is not provided, the DSM server will provide a default set of key operations. Note that if you provide an empty array, all key operations will be disabled.

Type: list[KeyOperations]

Setter:: Sets the key_ops of this UnwrapKeyRequestEx.

property mode

Gets the mode of this UnwrapKeyRequestEx.

Type: CryptMode

Setter:: Sets the mode of this UnwrapKeyRequestEx.

property name

Gets the name of this UnwrapKeyRequestEx. Name of the security object to unwrap. Security object names must be unique within an account.

Type: str

Setter:: Sets the name of this UnwrapKeyRequestEx.

property obj_type

Gets the obj_type of this UnwrapKeyRequestEx.

Type: ObjectType

Setter:: Sets the obj_type of this UnwrapKeyRequestEx.

property rsa

Gets the rsa of this UnwrapKeyRequestEx.

Type: RsaOptions

Setter:: Sets the rsa of this UnwrapKeyRequestEx.

property tag

Gets the tag of this UnwrapKeyRequestEx. 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 UnwrapKeyRequestEx.

property wrapped_key

Gets the wrapped_key of this UnwrapKeyRequestEx. A Security Object previously wrapped with another key.

Type: bytearray

Setter:: Sets the wrapped_key of this UnwrapKeyRequestEx.