Class: Akeyless::Connect

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

Overview

Connect is a command that performs secure remote access

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Connect

Initializes the object

Parameters:

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

    Model attributes in the form of hash



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
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
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/akeyless/models/connect.rb', line 167

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'sra_ctrl_port')
    self.sra_ctrl_port = attributes[:'sra_ctrl_port']
  else
    self.sra_ctrl_port = '9900'
  end

  if attributes.key?(:'sra_ctrl_proto')
    self.sra_ctrl_proto = attributes[:'sra_ctrl_proto']
  else
    self.sra_ctrl_proto = 'http'
  end

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

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

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

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

  if attributes.key?(:'target')
    self.target = attributes[:'target']
  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?(:'use_ssh_agent')
    self.use_ssh_agent = attributes[:'use_ssh_agent']
  end

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

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

Instance Attribute Details

#bastion_ctrl_path ⇒ Object

Deprecated. use bastion-ctrl-path



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

def bastion_ctrl_path
  @bastion_ctrl_path
end

#bastion_ctrl_port ⇒ Object

Deprecated. use sra-ctrl-port



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

def bastion_ctrl_port
  @bastion_ctrl_port
end

#bastion_ctrl_proto ⇒ Object

Deprecated. use sra-ctrl-proto



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

def bastion_ctrl_proto
  @bastion_ctrl_proto
end

#bastion_ctrl_subdomain ⇒ Object

Deprecated. use sra-ctrl-subdomain



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

def bastion_ctrl_subdomain
  @bastion_ctrl_subdomain
end

#cert_issuer_name ⇒ Object

The Akeyless certificate issuer name



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

def cert_issuer_name
  @cert_issuer_name
end

#gateway_url ⇒ Object

The Gateway URL (configuration management) address, e.g. localhost:8000



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

def gateway_url
  @gateway_url
end

#helper ⇒ Object

Returns the value of attribute helper.



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

def helper
  @helper
end

#identity_file ⇒ Object

The file from which the identity (private key) for public key authentication is read



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

def identity_file
  @identity_file
end

#json ⇒ Object

Set output format to JSON



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

def json
  @json
end

#justification ⇒ Object

Returns the value of attribute justification.



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

def justification
  @justification
end

#name ⇒ Object

The Secret name (for database and AWS producers - producer name)



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

def name
  @name
end

#rc_file_override ⇒ Object

used to override .akeyless-connect.rc in tests



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

def rc_file_override
  @rc_file_override
end

#sra_ctrl_path ⇒ Object

The Bastion API path



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

def sra_ctrl_path
  @sra_ctrl_path
end

#sra_ctrl_port ⇒ Object

The Bastion API Port



57
58
59
 
# File 'lib/akeyless/models/connect.rb', line 57

def sra_ctrl_port
  @sra_ctrl_port
end

#sra_ctrl_proto ⇒ Object

The SRA API protocol



60
61
62
 
# File 'lib/akeyless/models/connect.rb', line 60

def sra_ctrl_proto
  @sra_ctrl_proto
end

#sra_ctrl_subdomain ⇒ Object

The SRA API prefix



63
64
65
 
# File 'lib/akeyless/models/connect.rb', line 63

def sra_ctrl_subdomain
  @sra_ctrl_subdomain
end

#ssh_command ⇒ Object

Path to SSH executable. e.g. /usr/bin/ssh



66
67
68
 
# File 'lib/akeyless/models/connect.rb', line 66

def ssh_command
  @ssh_command
end

#ssh_extra_args ⇒ Object

Additional SSH arguments (except -i)



69
70
71
 
# File 'lib/akeyless/models/connect.rb', line 69

def ssh_extra_args
  @ssh_extra_args
end

#ssh_legacy_signing_alg ⇒ Object

Set this option to output legacy (‘ssh-rsa-cert-v01@openssh.com’) signing algorithm name in the ssh certificate.



72
73
74
 
# File 'lib/akeyless/models/connect.rb', line 72

def ssh_legacy_signing_alg
  @ssh_legacy_signing_alg
end

#target ⇒ Object

The target



75
76
77
 
# File 'lib/akeyless/models/connect.rb', line 75

def target
  @target
end

#token ⇒ Object

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



78
79
80
 
# File 'lib/akeyless/models/connect.rb', line 78

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



81
82
83
 
# File 'lib/akeyless/models/connect.rb', line 81

def uid_token
  @uid_token
end

#use_ssh_agent ⇒ Object

Enable ssh-agent



84
85
86
 
# File 'lib/akeyless/models/connect.rb', line 84

def use_ssh_agent
  @use_ssh_agent
end

#via_bastion ⇒ Object

Deprecated. Use via-sra



87
88
89
 
# File 'lib/akeyless/models/connect.rb', line 87

def via_bastion
  @via_bastion
end

#via_sra ⇒ Object

The jump box server



90
91
92
 
# File 'lib/akeyless/models/connect.rb', line 90

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



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/akeyless/models/connect.rb', line 375

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



124
125
126
 
# File 'lib/akeyless/models/connect.rb', line 124

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/akeyless/models/connect.rb', line 93

def self.attribute_map
  {
    :'helper' => :'Helper',
    :'rc_file_override' => :'RcFileOverride',
    :'bastion_ctrl_path' => :'bastion-ctrl-path',
    :'bastion_ctrl_port' => :'bastion-ctrl-port',
    :'bastion_ctrl_proto' => :'bastion-ctrl-proto',
    :'bastion_ctrl_subdomain' => :'bastion-ctrl-subdomain',
    :'cert_issuer_name' => :'cert-issuer-name',
    :'gateway_url' => :'gateway-url',
    :'identity_file' => :'identity-file',
    :'json' => :'json',
    :'justification' => :'justification',
    :'name' => :'name',
    :'sra_ctrl_path' => :'sra-ctrl-path',
    :'sra_ctrl_port' => :'sra-ctrl-port',
    :'sra_ctrl_proto' => :'sra-ctrl-proto',
    :'sra_ctrl_subdomain' => :'sra-ctrl-subdomain',
    :'ssh_command' => :'ssh-command',
    :'ssh_extra_args' => :'ssh-extra-args',
    :'ssh_legacy_signing_alg' => :'ssh-legacy-signing-alg',
    :'target' => :'target',
    :'token' => :'token',
    :'uid_token' => :'uid-token',
    :'use_ssh_agent' => :'use-ssh-agent',
    :'via_bastion' => :'via-bastion',
    :'via_sra' => :'via-sra'
  }
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



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/akeyless/models/connect.rb', line 351

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



160
161
162
163
 
# File 'lib/akeyless/models/connect.rb', line 160

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

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/akeyless/models/connect.rb', line 129

def self.openapi_types
  {
    :'helper' => :'Object',
    :'rc_file_override' => :'String',
    :'bastion_ctrl_path' => :'String',
    :'bastion_ctrl_port' => :'String',
    :'bastion_ctrl_proto' => :'String',
    :'bastion_ctrl_subdomain' => :'String',
    :'cert_issuer_name' => :'String',
    :'gateway_url' => :'String',
    :'identity_file' => :'String',
    :'json' => :'Boolean',
    :'justification' => :'String',
    :'name' => :'String',
    :'sra_ctrl_path' => :'String',
    :'sra_ctrl_port' => :'String',
    :'sra_ctrl_proto' => :'String',
    :'sra_ctrl_subdomain' => :'String',
    :'ssh_command' => :'String',
    :'ssh_extra_args' => :'String',
    :'ssh_legacy_signing_alg' => :'Boolean',
    :'target' => :'String',
    :'token' => :'String',
    :'uid_token' => :'String',
    :'use_ssh_agent' => :'Boolean',
    :'via_bastion' => :'String',
    :'via_sra' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/akeyless/models/connect.rb', line 306

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      helper == o.helper &&
      rc_file_override == o.rc_file_override &&
      bastion_ctrl_path == o.bastion_ctrl_path &&
      bastion_ctrl_port == o.bastion_ctrl_port &&
      bastion_ctrl_proto == o.bastion_ctrl_proto &&
      bastion_ctrl_subdomain == o.bastion_ctrl_subdomain &&
      cert_issuer_name == o.cert_issuer_name &&
      gateway_url == o.gateway_url &&
      identity_file == o.identity_file &&
      json == o.json &&
      justification == o.justification &&
      name == o.name &&
      sra_ctrl_path == o.sra_ctrl_path &&
      sra_ctrl_port == o.sra_ctrl_port &&
      sra_ctrl_proto == o.sra_ctrl_proto &&
      sra_ctrl_subdomain == o.sra_ctrl_subdomain &&
      ssh_command == o.ssh_command &&
      ssh_extra_args == o.ssh_extra_args &&
      ssh_legacy_signing_alg == o.ssh_legacy_signing_alg &&
      target == o.target &&
      token == o.token &&
      uid_token == o.uid_token &&
      use_ssh_agent == o.use_ssh_agent &&
      via_bastion == o.via_bastion &&
      via_sra == o.via_sra
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



446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/akeyless/models/connect.rb', line 446

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


338
339
340
 
# File 'lib/akeyless/models/connect.rb', line 338

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



344
345
346
 
# File 'lib/akeyless/models/connect.rb', line 344

def hash
  [helper, rc_file_override, bastion_ctrl_path, bastion_ctrl_port, bastion_ctrl_proto, bastion_ctrl_subdomain, cert_issuer_name, gateway_url, identity_file, json, justification, name, sra_ctrl_path, sra_ctrl_port, sra_ctrl_proto, sra_ctrl_subdomain, ssh_command, ssh_extra_args, ssh_legacy_signing_alg, target, token, uid_token, use_ssh_agent, via_bastion, via_sra].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



291
292
293
294
295
 
# File 'lib/akeyless/models/connect.rb', line 291

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



422
423
424
 
# File 'lib/akeyless/models/connect.rb', line 422

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



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/akeyless/models/connect.rb', line 428

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



416
417
418
 
# File 'lib/akeyless/models/connect.rb', line 416

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



299
300
301
302
 
# File 'lib/akeyless/models/connect.rb', line 299

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end