SignDataDetails¶

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

Bases: object

The details of the message that you want to sign.

Attributes

`MESSAGE_TYPE_DIGEST`	A constant which can be used with the message_type property of a SignDataDetails.
`MESSAGE_TYPE_RAW`	A constant which can be used with the message_type property of a SignDataDetails.
`SIGNING_ALGORITHM_ECDSA_SHA_256`	A constant which can be used with the signing_algorithm property of a SignDataDetails.
`SIGNING_ALGORITHM_ECDSA_SHA_384`	A constant which can be used with the signing_algorithm property of a SignDataDetails.
`SIGNING_ALGORITHM_ECDSA_SHA_512`	A constant which can be used with the signing_algorithm property of a SignDataDetails.
`SIGNING_ALGORITHM_SHA_224_RSA_PKCS1_V1_5`	A constant which can be used with the signing_algorithm property of a SignDataDetails.
`SIGNING_ALGORITHM_SHA_224_RSA_PKCS_PSS`	A constant which can be used with the signing_algorithm property of a SignDataDetails.
`SIGNING_ALGORITHM_SHA_256_RSA_PKCS1_V1_5`	A constant which can be used with the signing_algorithm property of a SignDataDetails.
`SIGNING_ALGORITHM_SHA_256_RSA_PKCS_PSS`	A constant which can be used with the signing_algorithm property of a SignDataDetails.
`SIGNING_ALGORITHM_SHA_384_RSA_PKCS1_V1_5`	A constant which can be used with the signing_algorithm property of a SignDataDetails.
`SIGNING_ALGORITHM_SHA_384_RSA_PKCS_PSS`	A constant which can be used with the signing_algorithm property of a SignDataDetails.
`SIGNING_ALGORITHM_SHA_512_RSA_PKCS1_V1_5`	A constant which can be used with the signing_algorithm property of a SignDataDetails.
`SIGNING_ALGORITHM_SHA_512_RSA_PKCS_PSS`	A constant which can be used with the signing_algorithm property of a SignDataDetails.
`key_id`	[Required] Gets the key_id of this SignDataDetails.
`key_version_id`	Gets the key_version_id of this SignDataDetails.
`logging_context`	Gets the logging_context of this SignDataDetails.
`message`	[Required] Gets the message of this SignDataDetails.
`message_type`	Gets the message_type of this SignDataDetails.
`signing_algorithm`	[Required] Gets the signing_algorithm of this SignDataDetails.

Methods

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

MESSAGE_TYPE_DIGEST = 'DIGEST'¶: A constant which can be used with the message_type property of a SignDataDetails. This constant has a value of “DIGEST”

MESSAGE_TYPE_RAW = 'RAW'¶: A constant which can be used with the message_type property of a SignDataDetails. This constant has a value of “RAW”

SIGNING_ALGORITHM_ECDSA_SHA_256 = 'ECDSA_SHA_256'¶: A constant which can be used with the signing_algorithm property of a SignDataDetails. This constant has a value of “ECDSA_SHA_256”

SIGNING_ALGORITHM_ECDSA_SHA_384 = 'ECDSA_SHA_384'¶: A constant which can be used with the signing_algorithm property of a SignDataDetails. This constant has a value of “ECDSA_SHA_384”

SIGNING_ALGORITHM_ECDSA_SHA_512 = 'ECDSA_SHA_512'¶: A constant which can be used with the signing_algorithm property of a SignDataDetails. This constant has a value of “ECDSA_SHA_512”

SIGNING_ALGORITHM_SHA_224_RSA_PKCS1_V1_5 = 'SHA_224_RSA_PKCS1_V1_5'¶: A constant which can be used with the signing_algorithm property of a SignDataDetails. This constant has a value of “SHA_224_RSA_PKCS1_V1_5”

SIGNING_ALGORITHM_SHA_224_RSA_PKCS_PSS = 'SHA_224_RSA_PKCS_PSS'¶: A constant which can be used with the signing_algorithm property of a SignDataDetails. This constant has a value of “SHA_224_RSA_PKCS_PSS”

SIGNING_ALGORITHM_SHA_256_RSA_PKCS1_V1_5 = 'SHA_256_RSA_PKCS1_V1_5'¶: A constant which can be used with the signing_algorithm property of a SignDataDetails. This constant has a value of “SHA_256_RSA_PKCS1_V1_5”

SIGNING_ALGORITHM_SHA_256_RSA_PKCS_PSS = 'SHA_256_RSA_PKCS_PSS'¶: A constant which can be used with the signing_algorithm property of a SignDataDetails. This constant has a value of “SHA_256_RSA_PKCS_PSS”

SIGNING_ALGORITHM_SHA_384_RSA_PKCS1_V1_5 = 'SHA_384_RSA_PKCS1_V1_5'¶: A constant which can be used with the signing_algorithm property of a SignDataDetails. This constant has a value of “SHA_384_RSA_PKCS1_V1_5”

SIGNING_ALGORITHM_SHA_384_RSA_PKCS_PSS = 'SHA_384_RSA_PKCS_PSS'¶: A constant which can be used with the signing_algorithm property of a SignDataDetails. This constant has a value of “SHA_384_RSA_PKCS_PSS”

SIGNING_ALGORITHM_SHA_512_RSA_PKCS1_V1_5 = 'SHA_512_RSA_PKCS1_V1_5'¶: A constant which can be used with the signing_algorithm property of a SignDataDetails. This constant has a value of “SHA_512_RSA_PKCS1_V1_5”

SIGNING_ALGORITHM_SHA_512_RSA_PKCS_PSS = 'SHA_512_RSA_PKCS_PSS'¶: A constant which can be used with the signing_algorithm property of a SignDataDetails. This constant has a value of “SHA_512_RSA_PKCS_PSS”

__init__(**kwargs)¶

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

Parameters:

message (str) – The value to assign to the message property of this SignDataDetails.
key_id (str) – The value to assign to the key_id property of this SignDataDetails.
key_version_id (str) – The value to assign to the key_version_id property of this SignDataDetails.
message_type (str) – The value to assign to the message_type property of this SignDataDetails. Allowed values for this property are: “RAW”, “DIGEST”
signing_algorithm (str) – The value to assign to the signing_algorithm property of this SignDataDetails. Allowed values for this property are: “SHA_224_RSA_PKCS_PSS”, “SHA_256_RSA_PKCS_PSS”, “SHA_384_RSA_PKCS_PSS”, “SHA_512_RSA_PKCS_PSS”, “SHA_224_RSA_PKCS1_V1_5”, “SHA_256_RSA_PKCS1_V1_5”, “SHA_384_RSA_PKCS1_V1_5”, “SHA_512_RSA_PKCS1_V1_5”, “ECDSA_SHA_256”, “ECDSA_SHA_384”, “ECDSA_SHA_512”
logging_context (dict(str, str)) – The value to assign to the logging_context property of this SignDataDetails.

key_id¶

[Required] Gets the key_id of this SignDataDetails. The OCID of the key used to sign the message.

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

key_version_id¶

Gets the key_version_id of this SignDataDetails. The OCID of the key version used to sign the message.

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

logging_context¶

Gets the logging_context of this SignDataDetails. Information that can be used to provide context for audit logging. It is a map that contains any additional data that you provide to include with audit logs, if audit logging is enabled.

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

message¶

[Required] Gets the message of this SignDataDetails. The base64-encoded binary data object denoting the message or message digest to sign. You can have a message up to 4096 bytes in size. To sign a larger message, provide the message digest.

Returns:	The message of this SignDataDetails.
Return type:	str

message_type¶

Gets the message_type of this SignDataDetails. Denotes whether the value of the message parameter is a raw message or a message digest. The default value, RAW, indicates a message. To indicate a message digest, use DIGEST.

Allowed values for this property are: “RAW”, “DIGEST”

Returns:	The message_type of this SignDataDetails.
Return type:	str

signing_algorithm¶

[Required] Gets the signing_algorithm of this SignDataDetails. The algorithm to use to sign the message or message digest. For RSA keys, supported signature schemes include PKCS #1 and RSASSA-PSS, along with different hashing algorithms. For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms. When you pass a message digest for signing, ensure that you specify the same hashing algorithm as used when creating the message digest.

Allowed values for this property are: “SHA_224_RSA_PKCS_PSS”, “SHA_256_RSA_PKCS_PSS”, “SHA_384_RSA_PKCS_PSS”, “SHA_512_RSA_PKCS_PSS”, “SHA_224_RSA_PKCS1_V1_5”, “SHA_256_RSA_PKCS1_V1_5”, “SHA_384_RSA_PKCS1_V1_5”, “SHA_512_RSA_PKCS1_V1_5”, “ECDSA_SHA_256”, “ECDSA_SHA_384”, “ECDSA_SHA_512”

Returns:	The signing_algorithm of this SignDataDetails.
Return type:	str