Module: Puppet::Network::HttpPool

Defined in:
lib/puppet/network/http_pool.rb

Overview

This module contains the factory methods that should be used for getting a Puppet::Network::HTTP::Connection instance. The pool may return a new connection or a persistent cached connection, depending on the underlying pool implementation in use.

Class Method Summary collapse

Class Method Details

.connection(host, port, use_ssl: true, ssl_context: nil) ⇒ Puppet::Network::HTTP::Connection

Retrieve a connection for the given host and port.

Parameters:

  • host (String)

    The host to connect to

  • port (Integer)

    The port to connect to

  • use_ssl (Boolean) (defaults to: true)

    Whether to use SSL, defaults to `true`.

  • ssl_context (Puppet::SSL:SSLContext, nil) (defaults to: nil)

    The ssl context to use when making HTTPS connections. Required when `use_ssl` is `true`.

Returns:


76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# File 'lib/puppet/network/http_pool.rb', line 76

def self.connection(host, port, use_ssl: true, ssl_context: nil)
  if use_ssl
    unless ssl_context      # TRANSLATORS 'ssl_context' is an argument and should not be translated

      raise ArgumentError, _("An ssl_context is required when connecting to 'https://%{host}:%{port}'") % { host: host, port: port }
    end

    verifier = Puppet::SSL::Verifier.new(host, ssl_context)
    http_client_class.new(host, port, use_ssl: true, verifier: verifier)
  else
    if ssl_context      # TRANSLATORS 'ssl_context' is an argument and should not be translated

      Puppet.warning(_("An ssl_context is unnecessary when connecting to 'http://%{host}:%{port}' and will be ignored") % { host: host, port: port })
    end

    http_client_class.new(host, port, use_ssl: false)
  end
end

.http_client_classObject


17
18
19
# File 'lib/puppet/network/http_pool.rb', line 17

def self.http_client_class
  @http_client_class
end

.http_client_class=(klass) ⇒ Object


20
21
22
# File 'lib/puppet/network/http_pool.rb', line 20

def self.http_client_class=(klass)
  @http_client_class = klass
end

.http_instance(host, port, use_ssl = true, verify_peer = true) ⇒ Puppet::Network::HTTP::Connection

Deprecated.

Use #http_connection instead.

Retrieve a connection for the given host and port.

Parameters:

  • host (String)

    The hostname to connect to

  • port (Integer)

    The port on the host to connect to

  • use_ssl (Boolean) (defaults to: true)

    Whether to use an SSL connection

  • verify_peer (Boolean) (defaults to: true)

    Whether to verify the peer credentials, if possible. Verification will not take place if the CA certificate is missing.

Returns:


35
36
37
38
39
40
41
42
43
44
45
# File 'lib/puppet/network/http_pool.rb', line 35

def self.http_instance(host, port, use_ssl = true, verify_peer = true)
  verifier = if verify_peer
               Puppet::SSL::Validator.default_validator()
             else
               Puppet::SSL::Validator.no_validator()
             end

  http_client_class.new(host, port,
                          :use_ssl => use_ssl,
                          :verify => verifier)
end

.http_ssl_instance(host, port, verifier = Puppet::SSL::Validator.default_validator()) ⇒ Puppet::Network::HTTP::Connection

Deprecated.

Use #http_connection instead.

Get an http connection that will be secured with SSL and have the connection verified with the given verifier

Parameters:

  • host (String)

    the DNS name to connect to

  • port (Integer)

    the port to connect to

  • verifier (#setup_connection, #peer_certs, #verify_errors) (defaults to: Puppet::SSL::Validator.default_validator())

    An object that will setup the appropriate verification on a Net::HTTP instance and report any errors and the certificates used.

Returns:


59
60
61
62
63
# File 'lib/puppet/network/http_pool.rb', line 59

def self.http_ssl_instance(host, port, verifier = Puppet::SSL::Validator.default_validator())
  http_client_class.new(host, port,
                          :use_ssl => true,
                          :verify => verifier)
end