Class: Akeyless::SignPKCS1

Inherits:
Object
  • Object
show all
Defined in:
lib/akeyless/models/sign_pkcs1.rb

Overview

signPKCS1 is a command that calculates the signature of hashed data using RSASSA-PKCS1-V1_5-SIGN from RSA PKCS#1 v1.5.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SignPKCS1

Initializes the object

Parameters:

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

    Model attributes in the form of hash



99
100
101
102
103
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/akeyless/models/sign_pkcs1.rb', line 99

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Akeyless::SignPKCS1` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Akeyless::SignPKCS1`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'display_id')
    self.display_id = attributes[:'display_id']
  end

  if attributes.key?(:'hash_function')
    self.hash_function = attributes[:'hash_function']
  end

  if attributes.key?(:'input_format')
    self.input_format = attributes[:'input_format']
  end

  if attributes.key?(:'item_id')
    self.item_id = attributes[:'item_id']
  end

  if attributes.key?(:'json')
    self.json = attributes[:'json']
  else
    self.json = false
  end

  if attributes.key?(:'key_name')
    self.key_name = attributes[:'key_name']
  end

  if attributes.key?(:'message')
    self.message = attributes[:'message']
  else
    self.message = nil
  end

  if attributes.key?(:'prehashed')
    self.prehashed = attributes[:'prehashed']
  end

  if attributes.key?(:'token')
    self.token = attributes[:'token']
  end

  if attributes.key?(:'uid_token')
    self.uid_token = attributes[:'uid_token']
  end

  if attributes.key?(:'version')
    self.version = attributes[:'version']
  end
end

Instance Attribute Details

#display_id ⇒ Object

The display id of the key to use in the signing process



20
21
22
 
# File 'lib/akeyless/models/sign_pkcs1.rb', line 20

def display_id
  @display_id
end

#hash_function ⇒ Object

HashFunction defines the hash function (e.g. sha-256)



23
24
25
 
# File 'lib/akeyless/models/sign_pkcs1.rb', line 23

def hash_function
  @hash_function
end

#input_format ⇒ Object

Select default assumed format for the plaintext message. Currently supported options: [base64]



26
27
28
 
# File 'lib/akeyless/models/sign_pkcs1.rb', line 26

def input_format
  @input_format
end

#item_id ⇒ Object

The item id of the key to use in the signing process



29
30
31
 
# File 'lib/akeyless/models/sign_pkcs1.rb', line 29

def item_id
  @item_id
end

#json ⇒ Object

Set output format to JSON



32
33
34
 
# File 'lib/akeyless/models/sign_pkcs1.rb', line 32

def json
  @json
end

#key_name ⇒ Object

The name of the RSA key to use in the signing process



35
36
37
 
# File 'lib/akeyless/models/sign_pkcs1.rb', line 35

def key_name
  @key_name
end

#message ⇒ Object

The message to be signed



38
39
40
 
# File 'lib/akeyless/models/sign_pkcs1.rb', line 38

def message
  @message
end

#prehashed ⇒ Object

Markes that the message is already hashed



41
42
43
 
# File 'lib/akeyless/models/sign_pkcs1.rb', line 41

def prehashed
  @prehashed
end

#token ⇒ Object

Authentication token (see ‘/auth` and `/configure`)



44
45
46
 
# File 'lib/akeyless/models/sign_pkcs1.rb', line 44

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



47
48
49
 
# File 'lib/akeyless/models/sign_pkcs1.rb', line 47

def uid_token
  @uid_token
end

#version ⇒ Object

The version of the key to use for signing



50
51
52
 
# File 'lib/akeyless/models/sign_pkcs1.rb', line 50

def version
  @version
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/akeyless/models/sign_pkcs1.rb', line 238

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Akeyless.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



70
71
72
 
# File 'lib/akeyless/models/sign_pkcs1.rb', line 70

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/akeyless/models/sign_pkcs1.rb', line 53

def self.attribute_map
  {
    :'display_id' => :'display-id',
    :'hash_function' => :'hash-function',
    :'input_format' => :'input-format',
    :'item_id' => :'item-id',
    :'json' => :'json',
    :'key_name' => :'key-name',
    :'message' => :'message',
    :'prehashed' => :'prehashed',
    :'token' => :'token',
    :'uid_token' => :'uid-token',
    :'version' => :'version'
  }
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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/akeyless/models/sign_pkcs1.rb', line 214

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



92
93
94
95
 
# File 'lib/akeyless/models/sign_pkcs1.rb', line 92

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/akeyless/models/sign_pkcs1.rb', line 75

def self.openapi_types
  {
    :'display_id' => :'String',
    :'hash_function' => :'String',
    :'input_format' => :'String',
    :'item_id' => :'Integer',
    :'json' => :'Boolean',
    :'key_name' => :'String',
    :'message' => :'String',
    :'prehashed' => :'Boolean',
    :'token' => :'String',
    :'uid_token' => :'String',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/akeyless/models/sign_pkcs1.rb', line 183

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      display_id == o.display_id &&
      hash_function == o.hash_function &&
      input_format == o.input_format &&
      item_id == o.item_id &&
      json == o.json &&
      key_name == o.key_name &&
      message == o.message &&
      prehashed == o.prehashed &&
      token == o.token &&
      uid_token == o.uid_token &&
      version == o.version
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/akeyless/models/sign_pkcs1.rb', line 309

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


201
202
203
 
# File 'lib/akeyless/models/sign_pkcs1.rb', line 201

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



207
208
209
 
# File 'lib/akeyless/models/sign_pkcs1.rb', line 207

def hash
  [display_id, hash_function, input_format, item_id, json, key_name, message, prehashed, token, uid_token, version].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



163
164
165
166
167
168
169
170
171
 
# File 'lib/akeyless/models/sign_pkcs1.rb', line 163

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @message.nil?
    invalid_properties.push('invalid value for "message", message cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



285
286
287
 
# File 'lib/akeyless/models/sign_pkcs1.rb', line 285

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/akeyless/models/sign_pkcs1.rb', line 291

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



279
280
281
 
# File 'lib/akeyless/models/sign_pkcs1.rb', line 279

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



175
176
177
178
179
 
# File 'lib/akeyless/models/sign_pkcs1.rb', line 175

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @message.nil?
  true
end