File: //proc/self/root/lib/mysqlsh/lib/python3.8/site-packages/oci/key_management/models/key_shape.py
# coding: utf-8
# Copyright (c) 2016, 2025, Oracle and/or its affiliates. All rights reserved.
# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: release
from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401
from oci.decorators import init_model_state_from_kwargs
@init_model_state_from_kwargs
class KeyShape(object):
"""
The cryptographic properties of a key.
"""
#: A constant which can be used with the algorithm property of a KeyShape.
#: This constant has a value of "AES"
ALGORITHM_AES = "AES"
#: A constant which can be used with the algorithm property of a KeyShape.
#: This constant has a value of "RSA"
ALGORITHM_RSA = "RSA"
#: A constant which can be used with the algorithm property of a KeyShape.
#: This constant has a value of "ECDSA"
ALGORITHM_ECDSA = "ECDSA"
#: A constant which can be used with the curve_id property of a KeyShape.
#: This constant has a value of "NIST_P256"
CURVE_ID_NIST_P256 = "NIST_P256"
#: A constant which can be used with the curve_id property of a KeyShape.
#: This constant has a value of "NIST_P384"
CURVE_ID_NIST_P384 = "NIST_P384"
#: A constant which can be used with the curve_id property of a KeyShape.
#: This constant has a value of "NIST_P521"
CURVE_ID_NIST_P521 = "NIST_P521"
def __init__(self, **kwargs):
"""
Initializes a new KeyShape object with values from keyword arguments.
The following keyword arguments are supported (corresponding to the getters/setters of this class):
:param algorithm:
The value to assign to the algorithm property of this KeyShape.
Allowed values for this property are: "AES", "RSA", "ECDSA", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:type algorithm: str
:param length:
The value to assign to the length property of this KeyShape.
:type length: int
:param curve_id:
The value to assign to the curve_id property of this KeyShape.
Allowed values for this property are: "NIST_P256", "NIST_P384", "NIST_P521", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:type curve_id: str
"""
self.swagger_types = {
'algorithm': 'str',
'length': 'int',
'curve_id': 'str'
}
self.attribute_map = {
'algorithm': 'algorithm',
'length': 'length',
'curve_id': 'curveId'
}
self._algorithm = None
self._length = None
self._curve_id = None
@property
def algorithm(self):
"""
**[Required]** Gets the algorithm of this KeyShape.
The algorithm used by a key's key versions to encrypt or decrypt. Only AES algorithm is supported for `External` keys.
Allowed values for this property are: "AES", "RSA", "ECDSA", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:return: The algorithm of this KeyShape.
:rtype: str
"""
return self._algorithm
@algorithm.setter
def algorithm(self, algorithm):
"""
Sets the algorithm of this KeyShape.
The algorithm used by a key's key versions to encrypt or decrypt. Only AES algorithm is supported for `External` keys.
:param algorithm: The algorithm of this KeyShape.
:type: str
"""
allowed_values = ["AES", "RSA", "ECDSA"]
if not value_allowed_none_or_none_sentinel(algorithm, allowed_values):
algorithm = 'UNKNOWN_ENUM_VALUE'
self._algorithm = algorithm
@property
def length(self):
"""
**[Required]** Gets the length of this KeyShape.
The length of the key in bytes, expressed as an integer. Supported values include the following:
- AES: 16, 24, or 32
- RSA: 256, 384, or 512
- ECDSA: 32, 48, or 66
:return: The length of this KeyShape.
:rtype: int
"""
return self._length
@length.setter
def length(self, length):
"""
Sets the length of this KeyShape.
The length of the key in bytes, expressed as an integer. Supported values include the following:
- AES: 16, 24, or 32
- RSA: 256, 384, or 512
- ECDSA: 32, 48, or 66
:param length: The length of this KeyShape.
:type: int
"""
self._length = length
@property
def curve_id(self):
"""
Gets the curve_id of this KeyShape.
Supported curve IDs for ECDSA keys.
Allowed values for this property are: "NIST_P256", "NIST_P384", "NIST_P521", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:return: The curve_id of this KeyShape.
:rtype: str
"""
return self._curve_id
@curve_id.setter
def curve_id(self, curve_id):
"""
Sets the curve_id of this KeyShape.
Supported curve IDs for ECDSA keys.
:param curve_id: The curve_id of this KeyShape.
:type: str
"""
allowed_values = ["NIST_P256", "NIST_P384", "NIST_P521"]
if not value_allowed_none_or_none_sentinel(curve_id, allowed_values):
curve_id = 'UNKNOWN_ENUM_VALUE'
self._curve_id = curve_id
def __repr__(self):
return formatted_flat_dict(self)
def __eq__(self, other):
if other is None:
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
return not self == other