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.



7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
 
# File 'lib/models/porcelain.rb', line 7738

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.



7710
7711
7712
 
# File 'lib/models/porcelain.rb', line 7710

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.



7714
7715
7716
 
# File 'lib/models/porcelain.rb', line 7714

def certificate_file_path
  @certificate_file_path
end

#default_certificate_authority_name ⇒ Object

Name of EJBCA certificate authority that will enroll CSR.



7716
7717
7718
 
# File 'lib/models/porcelain.rb', line 7716

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.



7718
7719
7720
 
# File 'lib/models/porcelain.rb', line 7718

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.



7720
7721
7722
 
# File 'lib/models/porcelain.rb', line 7720

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.



7722
7723
7724
 
# File 'lib/models/porcelain.rb', line 7722

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.



7725
7726
7727
 
# File 'lib/models/porcelain.rb', line 7725

def enrollment_username_env_var
  @enrollment_username_env_var
end

#id ⇒ Object

Unique identifier of the SecretStore.



7727
7728
7729
 
# File 'lib/models/porcelain.rb', line 7727

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.



7730
7731
7732
 
# File 'lib/models/porcelain.rb', line 7730

def key_file_path
  @key_file_path
end

#name ⇒ Object

Unique human-readable name of the SecretStore.



7732
7733
7734
 
# File 'lib/models/porcelain.rb', line 7732

def name
  @name
end

#server_address ⇒ Object

the host of the Key Factor CA



7734
7735
7736
 
# File 'lib/models/porcelain.rb', line 7734

def server_address
  @server_address
end

#tags ⇒ Object

Tags is a map of key, value pairs.



7736
7737
7738
 
# File 'lib/models/porcelain.rb', line 7736

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



7766
7767
7768
7769
7770
7771
7772
 
# File 'lib/models/porcelain.rb', line 7766

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