Class: Conjur::Configuration
- Inherits:
-
Object
- Object
- Conjur::Configuration
- Defined in:
- lib/conjur/configuration.rb
Overview
Stores a configuration for the Conjur API client. This class provides global and thread local storage for common options used by the Conjur API. Most importantly, it specifies the
- REST endpoints, derived from the #appliance_url and #account options
- The certificate used for secure connections to the Conjur appliance (#cert_file)
Environment Variables
Option values used by Conjur can be given by environment variables, using a standard naming scheme. Specifically,
an environment variable named CONJUR_ACCOUNT
will be used to provide a default value for the #account
option.
Required Options
The #account and #appliance_url are always required. Except in special cases, the #cert_file is also required, but you may omit it if your Conjur root certificate is in the OpenSSl default certificate store.
Thread Local Configuration
While using a globally available configuration is convenient for most applications, sometimes you will need to use different configurations in different threads. This is supported by returning a thread local version from configuration if one has been set by with_configuration.
Instance Attribute Summary collapse
-
#account ⇒ String
The organizational account used by Conjur.
-
#appliance_url ⇒ String
The url for your Conjur appliance.
-
#authn_local_socket ⇒ Object
File path to the Unix socket used for local authentication.
-
#authn_url ⇒ String
The url for the Conjur authentication service.
-
#cert_file ⇒ String?
Path to the certificate file to use when making secure connections to your Conjur appliance.
-
#core_url ⇒ String
The url for the core Conjur services.
-
#ssl_certificate ⇒ Object
Contents of a certificate file.
-
#version ⇒ Object
Selects the major API version of the Conjur server.
Instance Method Summary collapse
-
#apply_cert_config!(store = OpenSSL::SSL::SSLContext::DEFAULT_CERT_STORE) ⇒ Boolean
Add the certificate configured by the #ssl_certificate and #cert_file options to the certificate store used by Conjur clients.
-
#clone(override_options = {}) ⇒ Conjur::Configuration
Return a copy of this Configuration instance, optionally updating the copy with options from the
override_options
hash. -
#initialize(options = {}) ⇒ Configuration
constructor
Create a new Configuration, setting initial values from
options
. -
#version_logic(v4_logic, v5_logic) ⇒ Object
Calls a major-version-specific function.
Constructor Details
#initialize(options = {}) ⇒ Configuration
options
must use symbols for keys.
Create a new Conjur::Configuration, setting initial values from
options
.
189 190 191 192 193 |
# File 'lib/conjur/configuration.rb', line 189 def initialize = {} @explicit = .dup @supplied = .dup @computed = Hash.new end |
Instance Attribute Details
#account ⇒ String
this option is required, and attempting to make any api calls prior to setting it (either
explicitly or with the "CONJUR_ACCOUNT"
environment variable) will raise an exception.
The organizational account used by Conjur.
On Conjur appliances, this option will be set once when the appliance is first configured. You can get the value for the acccount option from your conjur administrator, or if you have installed the Conjur command line tools by running conjur authn whoami, or examining your .conjurrc file.
347 |
# File 'lib/conjur/configuration.rb', line 347 add_option :account, required: true |
#appliance_url ⇒ String
If you are using an appliance (if you're not sure, you probably are), this option is required.
The url for your Conjur appliance.
If your appliance's hostname is 'conjur.companyname.com'
, then your appliance_url
will
be 'https://conjur.companyname.com/api'
.
324 |
# File 'lib/conjur/configuration.rb', line 324 add_option :appliance_url |
#authn_local_socket ⇒ Object
File path to the Unix socket used for local authentication. This is only available when the API client is running on the Conjur server.
384 |
# File 'lib/conjur/configuration.rb', line 384 add_option :authn_local_socket, default: "/run/authn-local/.socket" |
#authn_url ⇒ String
The url for the Conjur authentication service.
By default, this will be built from the +appliance_url+. To use a custom authenticator,
set this option in code or set CONJUR_AUTHN_URL
.
298 299 300 |
# File 'lib/conjur/configuration.rb', line 298 add_option :authn_url do global_service_url 0, service_name: 'authn' end |
#cert_file ⇒ String?
Path to the certificate file to use when making secure connections to your Conjur appliance.
This should be the path to the root Conjur SSL certificate in PEM format. You will normally get the certificate file using the conjur init command. This option is not required if the certificate or its root is in the OpenSSL default cert store. If your program throws an error indicating that SSL verification has failed, you probably need to set or fix this option.
360 |
# File 'lib/conjur/configuration.rb', line 360 add_option :cert_file |
#core_url ⇒ String
You should not generally set this value. Instead, Conjur will derive it from the #account and #appliance_url properties.
The url for the core Conjur services.
311 312 313 |
# File 'lib/conjur/configuration.rb', line 311 add_option :core_url do global_service_url 0 end |
#ssl_certificate ⇒ Object
Contents of a certificate file. This can be used instead of :cert_file in environments like Heroku where you can't use a certificate file.
This option overrides the value of #cert_file if both are given, and issues a warning.
370 |
# File 'lib/conjur/configuration.rb', line 370 add_option :ssl_certificate |
#version ⇒ Object
Selects the major API version of the Conjur server. With this setting, the API
will use the routing scheme for API version 4
or 5
.
Methods which are not available in the selected version will raise NoMethodError.
378 |
# File 'lib/conjur/configuration.rb', line 378 add_option :version, default: 5 |
Instance Method Details
#apply_cert_config!(store = OpenSSL::SSL::SSLContext::DEFAULT_CERT_STORE) ⇒ Boolean
Add the certificate configured by the #ssl_certificate and #cert_file options to the certificate store used by Conjur clients.
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 |
# File 'lib/conjur/configuration.rb', line 403 def apply_cert_config! store=OpenSSL::SSL::SSLContext::DEFAULT_CERT_STORE if ssl_certificate CertUtils.parse_certs(ssl_certificate).each do |cert| begin store.add_cert cert rescue OpenSSL::X509::StoreError => ex raise unless ex. == 'cert already in hash table' end end elsif cert_file ensure_cert_readable!(cert_file) store.add_file cert_file else return false end true end |
#clone(override_options = {}) ⇒ Conjur::Configuration
Return a copy of this Conjur::Configuration instance, optionally
updating the copy with options from the override_options
hash.
272 273 274 |
# File 'lib/conjur/configuration.rb', line 272 def clone = {} self.class.new self.explicit.dup.merge() end |
#version_logic(v4_logic, v5_logic) ⇒ Object
Calls a major-version-specific function.
387 388 389 390 391 392 393 394 395 396 |
# File 'lib/conjur/configuration.rb', line 387 def version_logic v4_logic, v5_logic case version.to_s when "4" v4_logic.call when "5" v5_logic.call else raise "Unsupported major version #{version}" end end |