module Conjur

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

rubocop:disable Metrics/ModuleLength

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

Public Class Methods

cache() click to toggle source

Gets the global cache.

# File lib/conjur/cache.rb, line 19
def cache; @@cache; end

cache=(cache) click to toggle source

Sets the global cache. It should implement fetch_:method methods. The easy way to accomplish this is to extend BaseCache.

# File lib/conjur/cache.rb, line 14
def cache= cache
  @@cache = cache
end

cache_key(username, url, path = nil) click to toggle source

Builds a cache key from a username, url and optional path.

# File lib/conjur/cache.rb, line 22
def cache_key username, url, path = nil
  [ username, [ url, path ].compact.join ].join(".")
end

config()

Alias for: configuration

config=(config)

Alias for: configuration=

configuration() click to toggle source

Gets the current thread-local or global configuration.

The thread-local Conjur configuration can only be set using the {Conjur.with_configuration} method. This method will try to return that value first, then the global configuration as set with {Conjur.configuration=} (which is lazily initialized if not set).

@return [Conjur::Configuration] the thread-local or global Conjur configuration.

# File lib/conjur/configuration.rb, line 78
def configuration
  Thread.current[:conjur_configuration] || (@config ||= Configuration.new)
end

Also aliased as: config

configuration=(config) click to toggle source

Sets the global configuration.

This method *has no effect* on the thread local configuration. Use {Conjur.with_configuration} instead if that’s what you want.

@param [Conjur::Configuration] config the new configuration @return [Conjur::Configuration] the new value of the configuration

# File lib/conjur/configuration.rb, line 89
def configuration=(config)
  @config = config
end

Also aliased as: config=

configure() { |configuration| ... } click to toggle source

Configure Conjur with a block.

@example

Conjur.configure do |c|
  c.account = 'some-account'
  c.appliance_url = 'https://conjur.companyname.com/api'
end

@yieldparam [Conjur::Configuration] c the configuration instance to modify.

# File lib/conjur/configuration.rb, line 105
def configure
  yield configuration
end

create_log(param) click to toggle source

@api private Create a log from a String or Logger param

@param [String, Logger, nil] param the value to create the logger from @return Logger

# File lib/conjur/log.rb, line 44
def self.create_log param
  if param
    if param.is_a? String
      if param == 'stdout'
        Logger.new $stdout
      elsif param == 'stderr'
        Logger.new $stderr
      else
        Logger.new param
      end
    else
      param
    end
  end
end

log() click to toggle source

@api private @note this method may return nil if no log has been set, so you must check the value before attempting to use the logger.

You should consider using {Conjur::LogSource} instead.

# File lib/conjur/log.rb, line 69
def self.log
  @@env_log || @@log
end

log=(log) click to toggle source

Assign a Logger for use by Conjur API methods. This method accepts several argument forms:

The strings ‘stdout’ and ‘stderr’ cause log messages to be sent to the corresponding stream.
Other stings are treated as paths and will cause log messages to be sent to those files.
A ‘Logger` instance will be used as is.

Note that the logger specified by the ‘CONJURAPI_LOG` environment variable will override the value set here.

@param [String, Logger,nil] log the new logger to use @return [void]

# File lib/conjur/log.rb, line 35
def self.log= log
  @@log = create_log log
end

with_configuration(config) { || ... } click to toggle source

Saves the current thread local {Conjur::Configuration}, sets the thread local {Conjur::Configuration} to ‘config`, yields to the block, and ensures that the original thread local configuration is restored.

Because Conjur configuration is accessed from the ‘global’ {Conjur.configuration} method by all Conjur API methods, this method provides the ability to set a thread local value for use within the current, or within a block in a single threaded application.

Note that the {Conjur.configuration=} method sets the global {Conjur::Configuration}, not the thread-local value.

@example Override Configuration in a Thread

# in this rather contrived example, we'll override the {Conjur::Configuration#appliance_url} parameter
# used by calls within a thread.

# Set up the configuration in the main thread
Conjur.configure do |c|
  # ...
  c.appliance_url = 'https://conjur.main-url.com/api'
end

# Start a new thread that will perform requests to another server.  In practice, you might
# have a web server that uses a Conjur endpoint specified by a request header.
Thread.new do
   Conjur.with_configuration Conjur.config.clone(appliance_url: 'https://conjur.local-url.com/api') do
      sleep 2
      puts "Thread local url is #{Conjur.config.appliance_url}"
   end
end
puts "Global url is #{Conjur.config.appliance_url}"
# Outputs:
Global url is https://conjur.main-url.com/api
Thread local url is https://conjur.local-url.com/api

@return [void]

# File lib/conjur/configuration.rb, line 63
def with_configuration(config)
  oldvalue = Thread.current[:conjur_configuration]
  Thread.current[:conjur_configuration] = config
  yield
ensure
  Thread.current[:conjur_configuration] = oldvalue
end