Class: OCI::KeyManagement::Models::SignedData

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

Overview

The response to a request to sign the message.

Constant Summary collapse

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,
  SIGNING_ALGORITHM_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SignedData

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :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

  • :signature (String) —

    The value to assign to the #signature property

  • :signing_algorithm (String) —

    The value to assign to the #signing_algorithm property



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/oci/key_management/models/signed_data.rb', line 84

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.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.signature = attributes[:'signature'] if attributes[:'signature']

  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']
end

Instance Attribute Details

#key_id ⇒ String

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

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/key_management/models/signed_data.rb', line 29

def key_id
  @key_id
end

#key_version_id ⇒ String

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

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/key_management/models/signed_data.rb', line 33

def key_version_id
  @key_version_id
end

#signature ⇒ String

[Required] The base64-encoded binary data object denoting the cryptographic signature generated for the message or message digest.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/key_management/models/signed_data.rb', line 38

def signature
  @signature
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) 


48
49
50
 
# File 'lib/oci/key_management/models/signed_data.rb', line 48

def signing_algorithm
  @signing_algorithm
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
 
# File 'lib/oci/key_management/models/signed_data.rb', line 51

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key_id': :'keyId',
    'key_version_id': :'keyVersionId',
    'signature': :'signature',
    'signing_algorithm': :'signingAlgorithm'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
 
# File 'lib/oci/key_management/models/signed_data.rb', line 63

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key_id': :'String',
    'key_version_id': :'String',
    'signature': :'String',
    'signing_algorithm': :'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



131
132
133
134
135
136
137
138
139
 
# File 'lib/oci/key_management/models/signed_data.rb', line 131

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

  self.class == other.class &&
    key_id == other.key_id &&
    key_version_id == other.key_version_id &&
    signature == other.signature &&
    signing_algorithm == other.signing_algorithm
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



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/oci/key_management/models/signed_data.rb', line 164

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


144
145
146
 
# File 'lib/oci/key_management/models/signed_data.rb', line 144

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



153
154
155
 
# File 'lib/oci/key_management/models/signed_data.rb', line 153

def hash
  [key_id, key_version_id, signature, signing_algorithm].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



197
198
199
200
201
202
203
204
205
206
 
# File 'lib/oci/key_management/models/signed_data.rb', line 197

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



191
192
193
 
# File 'lib/oci/key_management/models/signed_data.rb', line 191

def to_s
  to_hash.to_s
end