Class: OCI::KeyManagement::Models::SignDataDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/key_management/models/sign_data_details.rb

Overview

The details of the message that you want to sign.

Constant Summary collapse

MESSAGE_TYPE_ENUM = 
[
  MESSAGE_TYPE_RAW = 'RAW'.freeze,
  MESSAGE_TYPE_DIGEST = 'DIGEST'.freeze
].freeze
SIGNING_ALGORITHM_ENUM = 
[
  SIGNING_ALGORITHM_SHA_224_RSA_PKCS_PSS = 'SHA_224_RSA_PKCS_PSS'.freeze,
  SIGNING_ALGORITHM_SHA_256_RSA_PKCS_PSS = 'SHA_256_RSA_PKCS_PSS'.freeze,
  SIGNING_ALGORITHM_SHA_384_RSA_PKCS_PSS = 'SHA_384_RSA_PKCS_PSS'.freeze,
  SIGNING_ALGORITHM_SHA_512_RSA_PKCS_PSS = 'SHA_512_RSA_PKCS_PSS'.freeze,
  SIGNING_ALGORITHM_SHA_224_RSA_PKCS1_V1_5 = 'SHA_224_RSA_PKCS1_V1_5'.freeze,
  SIGNING_ALGORITHM_SHA_256_RSA_PKCS1_V1_5 = 'SHA_256_RSA_PKCS1_V1_5'.freeze,
  SIGNING_ALGORITHM_SHA_384_RSA_PKCS1_V1_5 = 'SHA_384_RSA_PKCS1_V1_5'.freeze,
  SIGNING_ALGORITHM_SHA_512_RSA_PKCS1_V1_5 = 'SHA_512_RSA_PKCS1_V1_5'.freeze,
  SIGNING_ALGORITHM_ECDSA_SHA_256 = 'ECDSA_SHA_256'.freeze,
  SIGNING_ALGORITHM_ECDSA_SHA_384 = 'ECDSA_SHA_384'.freeze,
  SIGNING_ALGORITHM_ECDSA_SHA_512 = 'ECDSA_SHA_512'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SignDataDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :message (String) —

    The value to assign to the #message property

  • :key_id (String) —

    The value to assign to the #key_id property

  • :key_version_id (String) —

    The value to assign to the #key_version_id property

  • :message_type (String) —

    The value to assign to the #message_type property

  • :signing_algorithm (String) —

    The value to assign to the #signing_algorithm property

  • :logging_context (Hash<String, String>) —

    The value to assign to the #logging_context property



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oci/key_management/models/sign_data_details.rb', line 104

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.message = attributes[:'message'] if attributes[:'message']

  self.key_id = attributes[:'keyId'] if attributes[:'keyId']

  raise 'You cannot provide both :keyId and :key_id' if attributes.key?(:'keyId') && attributes.key?(:'key_id')

  self.key_id = attributes[:'key_id'] if attributes[:'key_id']

  self.key_version_id = attributes[:'keyVersionId'] if attributes[:'keyVersionId']

  raise 'You cannot provide both :keyVersionId and :key_version_id' if attributes.key?(:'keyVersionId') && attributes.key?(:'key_version_id')

  self.key_version_id = attributes[:'key_version_id'] if attributes[:'key_version_id']

  self.message_type = attributes[:'messageType'] if attributes[:'messageType']
  self.message_type = "RAW" if message_type.nil? && !attributes.key?(:'messageType') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :messageType and :message_type' if attributes.key?(:'messageType') && attributes.key?(:'message_type')

  self.message_type = attributes[:'message_type'] if attributes[:'message_type']
  self.message_type = "RAW" if message_type.nil? && !attributes.key?(:'messageType') && !attributes.key?(:'message_type') # rubocop:disable Style/StringLiterals

  self.signing_algorithm = attributes[:'signingAlgorithm'] if attributes[:'signingAlgorithm']

  raise 'You cannot provide both :signingAlgorithm and :signing_algorithm' if attributes.key?(:'signingAlgorithm') && attributes.key?(:'signing_algorithm')

  self.signing_algorithm = attributes[:'signing_algorithm'] if attributes[:'signing_algorithm']

  self.logging_context = attributes[:'loggingContext'] if attributes[:'loggingContext']

  raise 'You cannot provide both :loggingContext and :logging_context' if attributes.key?(:'loggingContext') && attributes.key?(:'logging_context')

  self.logging_context = attributes[:'logging_context'] if attributes[:'logging_context']
end

Instance Attribute Details

#key_id ⇒ String

[Required] The OCID of the key used to sign the message.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/key_management/models/sign_data_details.rb', line 36

def key_id
  @key_id
end

#key_version_id ⇒ String

The OCID of the key version used to sign the message.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/key_management/models/sign_data_details.rb', line 40

def key_version_id
  @key_version_id
end

#logging_context ⇒ Hash<String, String>

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:

  • (Hash<String, String>) 


62
63
64
 
# File 'lib/oci/key_management/models/sign_data_details.rb', line 62

def logging_context
  @logging_context
end

#message ⇒ String

[Required] 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:

  • (String) 


32
33
34
 
# File 'lib/oci/key_management/models/sign_data_details.rb', line 32

def message
  @message
end

#message_type ⇒ String

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.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/key_management/models/sign_data_details.rb', line 46

def message_type
  @message_type
end

#signing_algorithm ⇒ String

[Required] 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.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/key_management/models/sign_data_details.rb', line 56

def signing_algorithm
  @signing_algorithm
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oci/key_management/models/sign_data_details.rb', line 65

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'message': :'message',
    'key_id': :'keyId',
    'key_version_id': :'keyVersionId',
    'message_type': :'messageType',
    'signing_algorithm': :'signingAlgorithm',
    'logging_context': :'loggingContext'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/oci/key_management/models/sign_data_details.rb', line 79

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'message': :'String',
    'key_id': :'String',
    'key_version_id': :'String',
    'message_type': :'String',
    'signing_algorithm': :'String',
    'logging_context': :'Hash<String, String>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/oci/key_management/models/sign_data_details.rb', line 168

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    message == other.message &&
    key_id == other.key_id &&
    key_version_id == other.key_version_id &&
    message_type == other.message_type &&
    signing_algorithm == other.signing_algorithm &&
    logging_context == other.logging_context
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/oci/key_management/models/sign_data_details.rb', line 203

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


183
184
185
 
# File 'lib/oci/key_management/models/sign_data_details.rb', line 183

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



192
193
194
 
# File 'lib/oci/key_management/models/sign_data_details.rb', line 192

def hash
  [message, key_id, key_version_id, message_type, signing_algorithm, logging_context].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



236
237
238
239
240
241
242
243
244
245
 
# File 'lib/oci/key_management/models/sign_data_details.rb', line 236

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



230
231
232
 
# File 'lib/oci/key_management/models/sign_data_details.rb', line 230

def to_s
  to_hash.to_s
end