ExportKeyDetails¶

class oci.key_management.models.ExportKeyDetails(**kwargs)¶

Bases: object

The details of the key that you want to wrap and export.

Attributes

`ALGORITHM_RSA_OAEP_AES_SHA256`	A constant which can be used with the algorithm property of a ExportKeyDetails.
`ALGORITHM_RSA_OAEP_SHA256`	A constant which can be used with the algorithm property of a ExportKeyDetails.
`algorithm`	[Required] Gets the algorithm of this ExportKeyDetails.
`key_id`	[Required] Gets the key_id of this ExportKeyDetails.
`key_version_id`	Gets the key_version_id of this ExportKeyDetails.
`logging_context`	Gets the logging_context of this ExportKeyDetails.
`public_key`	[Required] Gets the public_key of this ExportKeyDetails.

Methods

__init__(**kwargs) Initializes a new ExportKeyDetails object with values from keyword arguments.

ALGORITHM_RSA_OAEP_AES_SHA256 = 'RSA_OAEP_AES_SHA256'¶: A constant which can be used with the algorithm property of a ExportKeyDetails. This constant has a value of “RSA_OAEP_AES_SHA256”

ALGORITHM_RSA_OAEP_SHA256 = 'RSA_OAEP_SHA256'¶: A constant which can be used with the algorithm property of a ExportKeyDetails. This constant has a value of “RSA_OAEP_SHA256”

__init__(**kwargs)¶

Initializes a new ExportKeyDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

key_id (str) – The value to assign to the key_id property of this ExportKeyDetails.
key_version_id (str) – The value to assign to the key_version_id property of this ExportKeyDetails.
algorithm (str) – The value to assign to the algorithm property of this ExportKeyDetails. Allowed values for this property are: “RSA_OAEP_AES_SHA256”, “RSA_OAEP_SHA256”
public_key (str) – The value to assign to the public_key property of this ExportKeyDetails.
logging_context (dict(str, str)) – The value to assign to the logging_context property of this ExportKeyDetails.

algorithm¶

[Required] Gets the algorithm of this ExportKeyDetails. The encryption algorithm to use to encrypt exportable key material from a software-backed key. Specifying RSA_OAEP_AES_SHA256 invokes the RSA AES key wrap mechanism, which generates a temporary AES key. The temporary AES key is wrapped by the RSA public wrapping key provided along with the request, creating a wrapped temporary AES key. The temporary AES key is also used to wrap the exportable key material. The wrapped temporary AES key and the wrapped exportable key material are concatenated, producing concatenated blob output that jointly represents them. Specifying RSA_OAEP_SHA256 means that the software key is wrapped by the RSA public wrapping key provided along with the request.

Allowed values for this property are: “RSA_OAEP_AES_SHA256”, “RSA_OAEP_SHA256”

Returns:	The algorithm of this ExportKeyDetails.
Return type:	str

key_id¶

[Required] Gets the key_id of this ExportKeyDetails. The OCID of the master encryption key associated with the key version you want to export.

Returns:	The key_id of this ExportKeyDetails.
Return type:	str

key_version_id¶

Gets the key_version_id of this ExportKeyDetails. The OCID of the specific key version to export. If not specified, the service exports the current key version.

Returns:	The key_version_id of this ExportKeyDetails.
Return type:	str

logging_context¶

Gets the logging_context of this ExportKeyDetails. Information that provides context for audit logging. You can provide this additional data as key-value pairs to include in the audit logs when audit logging is enabled.

Returns:	The logging_context of this ExportKeyDetails.
Return type:	dict(str, str)

public_key¶

[Required] Gets the public_key of this ExportKeyDetails. The PEM format of the 2048-bit, 3072-bit, or 4096-bit RSA wrapping key in your possession that you want to use to encrypt the key.

Returns:	The public_key of this ExportKeyDetails.
Return type:	str