Class: Akeyless::GenerateCA

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

Overview

GenerateCA is a command that creates a new PKI CA and Intermediate issuers

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GenerateCA

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/akeyless/models/generate_ca.rb', line 107

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

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

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

  if attributes.key?(:'extended_key_usage')
    self.extended_key_usage = attributes[:'extended_key_usage']
  else
    self.extended_key_usage = 'serverauth,clientauth'
  end

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

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

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

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

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

  if attributes.key?(:'split_level')
    self.split_level = attributes[:'split_level']
  else
    self.split_level = 3
  end

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

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

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

Instance Attribute Details

#alg ⇒ Object

Returns the value of attribute alg.



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

def alg
  @alg
end

#allowed_domains ⇒ Object

A list of the allowed domains that clients can request to be included in the certificate (in a comma-delimited list)



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

def allowed_domains
  @allowed_domains
end

#delete_protection ⇒ Object

Protection from accidental deletion of this object [true/false]



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

def delete_protection
  @delete_protection
end

#extended_key_usage ⇒ Object

A comma sepereted list of extended key usage for the intermediate (serverauth / clientauth / codesigning)



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

def extended_key_usage
  @extended_key_usage
end

#json ⇒ Object

Set output format to JSON



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

def json
  @json
end

#key_type ⇒ Object

Returns the value of attribute key_type.



33
34
35
 
# File 'lib/akeyless/models/generate_ca.rb', line 33

def key_type
  @key_type
end

#max_path_len ⇒ Object

The maximum number of intermediate certificates that can appear in a certification path



36
37
38
 
# File 'lib/akeyless/models/generate_ca.rb', line 36

def max_path_len
  @max_path_len
end

#pki_chain_name ⇒ Object

PKI chain name



39
40
41
 
# File 'lib/akeyless/models/generate_ca.rb', line 39

def pki_chain_name
  @pki_chain_name
end

#protection_key_name ⇒ Object

The name of a key that used to encrypt the secrets values (if empty, the account default protectionKey key will be used)



42
43
44
 
# File 'lib/akeyless/models/generate_ca.rb', line 42

def protection_key_name
  @protection_key_name
end

#split_level ⇒ Object

The number of fragments that the item will be split into



45
46
47
 
# File 'lib/akeyless/models/generate_ca.rb', line 45

def split_level
  @split_level
end

#token ⇒ Object

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



48
49
50
 
# File 'lib/akeyless/models/generate_ca.rb', line 48

def token
  @token
end

#ttl ⇒ Object

The maximum requested Time To Live for issued certificate by default in seconds, supported formats are s,m,h,d



51
52
53
 
# File 'lib/akeyless/models/generate_ca.rb', line 51

def ttl
  @ttl
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



54
55
56
 
# File 'lib/akeyless/models/generate_ca.rb', line 54

def uid_token
  @uid_token
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



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
313
 
# File 'lib/akeyless/models/generate_ca.rb', line 276

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



76
77
78
 
# File 'lib/akeyless/models/generate_ca.rb', line 76

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/akeyless/models/generate_ca.rb', line 57

def self.attribute_map
  {
    :'alg' => :'alg',
    :'allowed_domains' => :'allowed-domains',
    :'delete_protection' => :'delete_protection',
    :'extended_key_usage' => :'extended-key-usage',
    :'json' => :'json',
    :'key_type' => :'key-type',
    :'max_path_len' => :'max-path-len',
    :'pki_chain_name' => :'pki-chain-name',
    :'protection_key_name' => :'protection-key-name',
    :'split_level' => :'split-level',
    :'token' => :'token',
    :'ttl' => :'ttl',
    :'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



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

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



100
101
102
103
 
# File 'lib/akeyless/models/generate_ca.rb', line 100

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

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/akeyless/models/generate_ca.rb', line 81

def self.openapi_types
  {
    :'alg' => :'String',
    :'allowed_domains' => :'String',
    :'delete_protection' => :'String',
    :'extended_key_usage' => :'String',
    :'json' => :'Boolean',
    :'key_type' => :'String',
    :'max_path_len' => :'Integer',
    :'pki_chain_name' => :'String',
    :'protection_key_name' => :'String',
    :'split_level' => :'Integer',
    :'token' => :'String',
    :'ttl' => :'String',
    :'uid_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/akeyless/models/generate_ca.rb', line 219

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      alg == o.alg &&
      allowed_domains == o.allowed_domains &&
      delete_protection == o.delete_protection &&
      extended_key_usage == o.extended_key_usage &&
      json == o.json &&
      key_type == o.key_type &&
      max_path_len == o.max_path_len &&
      pki_chain_name == o.pki_chain_name &&
      protection_key_name == o.protection_key_name &&
      split_level == o.split_level &&
      token == o.token &&
      ttl == o.ttl &&
      uid_token == o.uid_token
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



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

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


239
240
241
 
# File 'lib/akeyless/models/generate_ca.rb', line 239

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



245
246
247
 
# File 'lib/akeyless/models/generate_ca.rb', line 245

def hash
  [alg, allowed_domains, delete_protection, extended_key_usage, json, key_type, max_path_len, pki_chain_name, protection_key_name, split_level, token, ttl, 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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/akeyless/models/generate_ca.rb', line 189

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

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

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



323
324
325
 
# File 'lib/akeyless/models/generate_ca.rb', line 323

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



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

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



317
318
319
 
# File 'lib/akeyless/models/generate_ca.rb', line 317

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



209
210
211
212
213
214
215
 
# File 'lib/akeyless/models/generate_ca.rb', line 209

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