Class: Akeyless::DeriveKey

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DeriveKey

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/akeyless/models/derive_key.rb', line 103

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Akeyless::DeriveKey` 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::DeriveKey`. 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?(:'accessibility')
    self.accessibility = attributes[:'accessibility']
  else
    self.accessibility = 'regular'
  end

  if attributes.key?(:'alg')
    self.alg = attributes[:'alg']
  else
    self.alg = 'pbkdf2'
  end

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

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

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

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

  if attributes.key?(:'mem')
    self.mem = attributes[:'mem']
  else
    self.mem = 16384
  end

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

  if attributes.key?(:'parallelism')
    self.parallelism = attributes[:'parallelism']
  else
    self.parallelism = 1
  end

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

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

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

Instance Attribute Details

#accessibility ⇒ Object

for personal password manager



19
20
21
 
# File 'lib/akeyless/models/derive_key.rb', line 19

def accessibility
  @accessibility
end

#alg ⇒ Object

Kdf algorithm



22
23
24
 
# File 'lib/akeyless/models/derive_key.rb', line 22

def alg
  @alg
end

#hash_function ⇒ Object

HashFunction the hash function to use (relevant for pbkdf2)



25
26
27
 
# File 'lib/akeyless/models/derive_key.rb', line 25

def hash_function
  @hash_function
end

#iter ⇒ Object

IterationCount the number of iterations



28
29
30
 
# File 'lib/akeyless/models/derive_key.rb', line 28

def iter
  @iter
end

#json ⇒ Object

Set output format to JSON



31
32
33
 
# File 'lib/akeyless/models/derive_key.rb', line 31

def json
  @json
end

#key_len ⇒ Object

KeyLength the byte length of the generated key



34
35
36
 
# File 'lib/akeyless/models/derive_key.rb', line 34

def key_len
  @key_len
end

#mem ⇒ Object

MemorySizeInKb the memory paramter in kb (relevant for argon2id)



37
38
39
 
# File 'lib/akeyless/models/derive_key.rb', line 37

def mem
  @mem
end

#name ⇒ Object

Static Secret full name



40
41
42
 
# File 'lib/akeyless/models/derive_key.rb', line 40

def name
  @name
end

#parallelism ⇒ Object

Parallelism the number of threads to use (relevant for argon2id)



43
44
45
 
# File 'lib/akeyless/models/derive_key.rb', line 43

def parallelism
  @parallelism
end

#salt ⇒ Object

Salt Base64 encoded salt value. If not provided, the salt will be generated as part of the operation. The salt should be securely-generated random bytes, minimum 64 bits, 128 bits is recommended



46
47
48
 
# File 'lib/akeyless/models/derive_key.rb', line 46

def salt
  @salt
end

#token ⇒ Object

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



49
50
51
 
# File 'lib/akeyless/models/derive_key.rb', line 49

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



52
53
54
 
# File 'lib/akeyless/models/derive_key.rb', line 52

def uid_token
  @uid_token
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



73
74
75
 
# File 'lib/akeyless/models/derive_key.rb', line 73

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/akeyless/models/derive_key.rb', line 55

def self.attribute_map
  {
    :'accessibility' => :'accessibility',
    :'alg' => :'alg',
    :'hash_function' => :'hash-function',
    :'iter' => :'iter',
    :'json' => :'json',
    :'key_len' => :'key-len',
    :'mem' => :'mem',
    :'name' => :'name',
    :'parallelism' => :'parallelism',
    :'salt' => :'salt',
    :'token' => :'token',
    :'uid_token' => :'uid-token'
  }
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



244
245
246
 
# File 'lib/akeyless/models/derive_key.rb', line 244

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



96
97
98
99
 
# File 'lib/akeyless/models/derive_key.rb', line 96

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

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/akeyless/models/derive_key.rb', line 78

def self.openapi_types
  {
    :'accessibility' => :'String',
    :'alg' => :'String',
    :'hash_function' => :'String',
    :'iter' => :'Integer',
    :'json' => :'Boolean',
    :'key_len' => :'Integer',
    :'mem' => :'Integer',
    :'name' => :'String',
    :'parallelism' => :'Integer',
    :'salt' => :'String',
    :'token' => :'String',
    :'uid_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/akeyless/models/derive_key.rb', line 212

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      accessibility == o.accessibility &&
      alg == o.alg &&
      hash_function == o.hash_function &&
      iter == o.iter &&
      json == o.json &&
      key_len == o.key_len &&
      mem == o.mem &&
      name == o.name &&
      parallelism == o.parallelism &&
      salt == o.salt &&
      token == o.token &&
      uid_token == o.uid_token
end

#_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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/akeyless/models/derive_key.rb', line 275

def _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_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
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



346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/akeyless/models/derive_key.rb', line 346

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

#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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/akeyless/models/derive_key.rb', line 251

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


231
232
233
 
# File 'lib/akeyless/models/derive_key.rb', line 231

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



237
238
239
 
# File 'lib/akeyless/models/derive_key.rb', line 237

def hash
  [accessibility, alg, hash_function, iter, json, key_len, mem, name, parallelism, salt, token, uid_token].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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/akeyless/models/derive_key.rb', line 179

def list_invalid_properties
  invalid_properties = Array.new
  if @alg.nil?
    invalid_properties.push('invalid value for "alg", alg cannot be nil.')
  end

  if @iter.nil?
    invalid_properties.push('invalid value for "iter", iter cannot be nil.')
  end

  if @key_len.nil?
    invalid_properties.push('invalid value for "key_len", key_len cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name 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



322
323
324
 
# File 'lib/akeyless/models/derive_key.rb', line 322

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



328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/akeyless/models/derive_key.rb', line 328

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



316
317
318
 
# File 'lib/akeyless/models/derive_key.rb', line 316

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



202
203
204
205
206
207
208
 
# File 'lib/akeyless/models/derive_key.rb', line 202

def valid?
  return false if @alg.nil?
  return false if @iter.nil?
  return false if @key_len.nil?
  return false if @name.nil?
  true
end