Class: SDM::KeyfactorX509Store

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(ca_file_path: nil, certificate_file_path: nil, default_certificate_authority_name: nil, default_certificate_profile_name: nil, default_end_entity_profile_name: nil, enrollment_code_env_var: nil, enrollment_username_env_var: nil, id: nil, key_file_path: nil, name: nil, server_address: nil, tags: nil) ⇒ KeyfactorX509Store

Returns a new instance of KeyfactorX509Store.



5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
 
# File 'lib/models/porcelain.rb', line 5357

def initialize(
  ca_file_path: nil,
  certificate_file_path: nil,
  default_certificate_authority_name: nil,
  default_certificate_profile_name: nil,
  default_end_entity_profile_name: nil,
  enrollment_code_env_var: nil,
  enrollment_username_env_var: nil,
  id: nil,
  key_file_path: nil,
  name: nil,
  server_address: nil,
  tags: nil
)
  @ca_file_path = ca_file_path == nil ? "" : ca_file_path
  @certificate_file_path = certificate_file_path == nil ? "" : certificate_file_path
  @default_certificate_authority_name = default_certificate_authority_name == nil ? "" : default_certificate_authority_name
  @default_certificate_profile_name = default_certificate_profile_name == nil ? "" : default_certificate_profile_name
  @default_end_entity_profile_name = default_end_entity_profile_name == nil ? "" : default_end_entity_profile_name
  @enrollment_code_env_var = enrollment_code_env_var == nil ? "" : enrollment_code_env_var
  @enrollment_username_env_var = enrollment_username_env_var == nil ? "" : enrollment_username_env_var
  @id = id == nil ? "" : id
  @key_file_path = key_file_path == nil ? "" : key_file_path
  @name = name == nil ? "" : name
  @server_address = server_address == nil ? "" : server_address
  @tags = tags == nil ? SDM::_porcelain_zero_value_tags() : tags
end

Instance Attribute Details

#ca_file_path ⇒ Object

Path to the root CA that signed the certificate passed to the client for HTTPS connection. This is not required if the CA is trusted by the host operating system. This should be a PEM formatted certificate, and doesn't necessarily have to be the CA that signed CertificateFile.



5329
5330
5331
 
# File 'lib/models/porcelain.rb', line 5329

def ca_file_path
  @ca_file_path
end

#certificate_file_path ⇒ Object

Path to client certificate in PEM format. This certificate must contain a client certificate that is recognized by the EJBCA instance represented by Hostname. This PEM file may also contain the private key associated with the certificate, but KeyFile can also be set to configure the private key.



5333
5334
5335
 
# File 'lib/models/porcelain.rb', line 5333

def certificate_file_path
  @certificate_file_path
end

#default_certificate_authority_name ⇒ Object

Name of EJBCA certificate authority that will enroll CSR.



5335
5336
5337
 
# File 'lib/models/porcelain.rb', line 5335

def default_certificate_authority_name
  @default_certificate_authority_name
end

#default_certificate_profile_name ⇒ Object

Certificate profile name that EJBCA will enroll the CSR with.



5337
5338
5339
 
# File 'lib/models/porcelain.rb', line 5337

def default_certificate_profile_name
  @default_certificate_profile_name
end

#default_end_entity_profile_name ⇒ Object

End entity profile that EJBCA will enroll the CSR with.



5339
5340
5341
 
# File 'lib/models/porcelain.rb', line 5339

def default_end_entity_profile_name
  @default_end_entity_profile_name
end

#enrollment_code_env_var ⇒ Object

code used by EJBCA during enrollment. May be left blank if no code is required.



5341
5342
5343
 
# File 'lib/models/porcelain.rb', line 5341

def enrollment_code_env_var
  @enrollment_code_env_var
end

#enrollment_username_env_var ⇒ Object

username that used by the EJBCA during enrollment. This can be left out. If so, the username must be auto-generated on the Keyfactor side.



5344
5345
5346
 
# File 'lib/models/porcelain.rb', line 5344

def enrollment_username_env_var
  @enrollment_username_env_var
end

#id ⇒ Object

Unique identifier of the SecretStore.



5346
5347
5348
 
# File 'lib/models/porcelain.rb', line 5346

def id
  @id
end

#key_file_path ⇒ Object

Path to private key in PEM format. This file should contain the private key associated with the client certificate configured in CertificateFile.



5349
5350
5351
 
# File 'lib/models/porcelain.rb', line 5349

def key_file_path
  @key_file_path
end

#name ⇒ Object

Unique human-readable name of the SecretStore.



5351
5352
5353
 
# File 'lib/models/porcelain.rb', line 5351

def name
  @name
end

#server_address ⇒ Object

the host of the Key Factor CA



5353
5354
5355
 
# File 'lib/models/porcelain.rb', line 5353

def server_address
  @server_address
end

#tags ⇒ Object

Tags is a map of key, value pairs.



5355
5356
5357
 
# File 'lib/models/porcelain.rb', line 5355

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



5385
5386
5387
5388
5389
5390
5391
 
# File 'lib/models/porcelain.rb', line 5385

def to_json(options = {})
  hash = {}
  self.instance_variables.each do |var|
    hash[var.id2name.delete_prefix("@")] = self.instance_variable_get var
  end
  hash.to_json
end