Class: Chef::HTTP::BasicClient

Inherits:
Object
  • Object
show all
Defined in:
lib/chef/http/basic_client.rb

Constant Summary collapse

HTTPS = 
"https".freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(url, opts = {}) ⇒ BasicClient

Instantiate a BasicClient.

Arguments:

url

An URI for the remote server.

Options:

ssl_policy

The SSL Policy to use, defaults to DefaultSSLPolicy



43
44
45
46
47
 
# File 'lib/chef/http/basic_client.rb', line 43

def initialize(url, opts = {})
  @url = url
  @ssl_policy = opts[:ssl_policy] || DefaultSSLPolicy
  @http_client = build_http_client
end

Instance Attribute Details

#http_client ⇒ Object (readonly)

Returns the value of attribute http_client.



35
36
37
 
# File 'lib/chef/http/basic_client.rb', line 35

def http_client
  @http_client
end

#ssl_policy ⇒ Object (readonly)

Returns the value of attribute ssl_policy.



36
37
38
 
# File 'lib/chef/http/basic_client.rb', line 36

def ssl_policy
  @ssl_policy
end

#url ⇒ Object (readonly)

Returns the value of attribute url.



34
35
36
 
# File 'lib/chef/http/basic_client.rb', line 34

def url
  @url
end

Instance Method Details

#build_http_client ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/chef/http/basic_client.rb', line 120

def build_http_client
  http_client = http_client_builder.new(host, port)

  if url.scheme == HTTPS
    configure_ssl(http_client)
  end

  http_client.read_timeout = config[:rest_timeout]
  http_client.open_timeout = config[:rest_timeout]
  http_client
end

#config ⇒ Object 



132
133
134
 
# File 'lib/chef/http/basic_client.rb', line 132

def config
  Chef::Config
end

#configure_ssl(http_client) ⇒ Object 



162
163
164
165
 
# File 'lib/chef/http/basic_client.rb', line 162

def configure_ssl(http_client)
  http_client.use_ssl = true
  ssl_policy.apply_to(http_client)
end

#env ⇒ Object 



136
137
138
 
# File 'lib/chef/http/basic_client.rb', line 136

def env
  ENV
end

#host ⇒ Object 



49
50
51
 
# File 'lib/chef/http/basic_client.rb', line 49

def host
  @url.hostname
end

#http_client_builder ⇒ Object 



140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/chef/http/basic_client.rb', line 140

def http_client_builder
  http_proxy = proxy_uri
  if http_proxy.nil?
    Net::HTTP
  else
    Chef::Log.debug("Using #{http_proxy.host}:#{http_proxy.port} for proxy")
    user = http_proxy_user(http_proxy)
    pass = http_proxy_pass(http_proxy)
    Net::HTTP.Proxy(http_proxy.host, http_proxy.port, user, pass)
  end
end

#http_proxy_pass(http_proxy) ⇒ Object 



157
158
159
160
 
# File 'lib/chef/http/basic_client.rb', line 157

def http_proxy_pass(http_proxy)
  http_proxy.password || Chef::Config["#{url.scheme}_proxy_pass"] ||
    env["#{url.scheme.upcase}_PROXY_PASS"] || env["#{url.scheme}_proxy_pass"]
end

#http_proxy_user(http_proxy) ⇒ Object 



152
153
154
155
 
# File 'lib/chef/http/basic_client.rb', line 152

def http_proxy_user(http_proxy)
  http_proxy.user || Chef::Config["#{url.scheme}_proxy_user"] ||
    env["#{url.scheme.upcase}_PROXY_USER"] || env["#{url.scheme}_proxy_user"]
end

#port ⇒ Object 



53
54
55
 
# File 'lib/chef/http/basic_client.rb', line 53

def port
  @url.port
end

#proxy_uri ⇒ Object

adapted from buildr/lib/buildr/core/transports.rb



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/chef/http/basic_client.rb', line 99

def proxy_uri
  proxy = Chef::Config["#{url.scheme}_proxy"] ||
    env["#{url.scheme.upcase}_PROXY"] || env["#{url.scheme}_proxy"]

  # Check if the proxy string contains a scheme. If not, add the url's scheme to the
  # proxy before parsing. The regex /^.*:\/\// matches, for example, http://. Reusing proxy
  # here since we are really just trying to get the string built correctly.
  if String === proxy && !proxy.strip.empty?
    if proxy =~ /^.*:\/\//
      proxy = URI.parse(proxy.strip)
    else
      proxy = URI.parse("#{url.scheme}://#{proxy.strip}")
    end
  end

  no_proxy = Chef::Config[:no_proxy] || env["NO_PROXY"] || env["no_proxy"]
  excludes = no_proxy.to_s.split(/\s*,\s*/).compact
  excludes = excludes.map { |exclude| exclude =~ /:\d+$/ ? exclude : "#{exclude}:*" }
  return proxy unless excludes.any? { |exclude| File.fnmatch(exclude, "#{host}:#{port}") }
end

#request(method, url, req_body, base_headers = {}) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/chef/http/basic_client.rb', line 57

def request(method, url, req_body, base_headers = {})
  http_request = HTTPRequest.new(method, url, req_body, base_headers).http_request
  Chef::Log.debug("Initiating #{method} to #{url}")
  Chef::Log.debug("---- HTTP Request Header Data: ----")
  base_headers.each do |name, value|
    Chef::Log.debug("#{name}: #{value}")
  end
  Chef::Log.debug("---- End HTTP Request Header Data ----")
  http_client.request(http_request) do |response|
    Chef::Log.debug("---- HTTP Status and Header Data: ----")
    Chef::Log.debug("HTTP #{response.http_version} #{response.code} #{response.msg}")

    response.each do |header, value|
      Chef::Log.debug("#{header}: #{value}")
    end
    Chef::Log.debug("---- End HTTP Status/Header Data ----")

    # For non-400's, log the request and response bodies
    if !response.code || !response.code.start_with?("2")
      if response.body
        Chef::Log.debug("---- HTTP Response Body ----")
        Chef::Log.debug(response.body)
        Chef::Log.debug("---- End HTTP Response Body -----")
      end
      if req_body
        Chef::Log.debug("---- HTTP Request Body ----")
        Chef::Log.debug(req_body)
        Chef::Log.debug("---- End HTTP Request Body ----")
      end
    end

    yield response if block_given?
    # http_client.request may not have the return signature we want, so
    # force the issue:
    return [http_request, response]
  end
rescue OpenSSL::SSL::SSLError => e
  Chef::Log.error("SSL Validation failure connecting to host: #{host} - #{e.message}")
  raise
end