Parent

Files

Class/Module Index [+]

Quicksearch

Chef::HTTP::Authenticator

Attributes

attr_names[R]
auth_credentials[R]
raw_key[R]
sign_request[RW]
signing_key_filename[R]

Public Class Methods

new(opts={}) click to toggle source
# File lib/chef/http/authenticator.rb, line 34
def initialize(opts={})
  @raw_key = nil
  @sign_request = true
  @signing_key_filename = opts[:signing_key_filename]
  @key = load_signing_key(opts[:signing_key_filename], opts[:raw_key])
  @auth_credentials = AuthCredentials.new(opts[:client_name], @key)
end

Public Instance Methods

authentication_headers(method, url, json_body=nil) click to toggle source
# File lib/chef/http/authenticator.rb, line 85
def authentication_headers(method, url, json_body=nil)
  request_params = {:http_method => method, :path => url.path, :body => json_body, :host => "#{url.host}:#{url.port}"}
  request_params[:body] ||= ""
  auth_credentials.signature_headers(request_params)
end
client_name() click to toggle source
# File lib/chef/http/authenticator.rb, line 63
def client_name
  @auth_credentials.client_name
end
handle_request(method, url, headers={}, data=false) click to toggle source
# File lib/chef/http/authenticator.rb, line 42
def handle_request(method, url, headers={}, data=false)
  headers.merge!(authentication_headers(method, url, data)) if sign_requests?
  [method, url, headers, data]
end
handle_response(http_response, rest_request, return_value) click to toggle source
# File lib/chef/http/authenticator.rb, line 47
def handle_response(http_response, rest_request, return_value)
  [http_response, rest_request, return_value]
end
handle_stream_complete(http_response, rest_request, return_value) click to toggle source
# File lib/chef/http/authenticator.rb, line 55
def handle_stream_complete(http_response, rest_request, return_value)
  [http_response, rest_request, return_value]
end
load_signing_key(key_file, raw_key = nil) click to toggle source
# File lib/chef/http/authenticator.rb, line 67
def load_signing_key(key_file, raw_key = nil)
  if (!!key_file)
    @raw_key = IO.read(key_file).strip
  elsif (!!raw_key)
    @raw_key = raw_key.strip
  else
    return nil
  end
  @key = OpenSSL::PKey::RSA.new(@raw_key)
rescue SystemCallError, IOError => e
  Chef::Log.warn "Failed to read the private key #{key_file}: #{e.inspect}"
  raise Chef::Exceptions::PrivateKeyMissing, "I cannot read #{key_file}, which you told me to use to sign requests!"
rescue OpenSSL::PKey::RSAError
  msg = "The file #{key_file} or :raw_key option does not contain a correctly formatted private key.\n"
  msg << "The key file should begin with '-----BEGIN RSA PRIVATE KEY-----' and end with '-----END RSA PRIVATE KEY-----'"
  raise Chef::Exceptions::InvalidPrivateKey, msg
end
sign_requests?() click to toggle source
# File lib/chef/http/authenticator.rb, line 59
def sign_requests?
  auth_credentials.sign_requests? && @sign_request
end
stream_response_handler(response) click to toggle source
# File lib/chef/http/authenticator.rb, line 51
def stream_response_handler(response)
  nil
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.