openvox 7.37.1 → 8.19.0

data/lib/puppet/http/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The HTTP client provides methods for making `GET`, `POST`, etc requests to
 # HTTP(S) servers. It also provides methods for resolving Puppetserver REST
 # service endpoints using SRV records and settings (such as `server_list`,
@@ -84,7 +86,6 @@
 #
 # @api public
 class Puppet::HTTP::Client
-
   attr_reader :pool
 
   # Create a new http client instance. Use `Puppet.runtime[:http]` to get
@@ -153,18 +154,18 @@ class Puppet::HTTP::Client
       end
     end
   rescue Net::OpenTimeout => e
-    raise_error(_("Request to %{uri} timed out connect operation after %{elapsed} seconds") % {uri: uri, elapsed: elapsed(start)}, e, connected)
+    raise_error(_("Request to %{uri} timed out connect operation after %{elapsed} seconds") % { uri: uri, elapsed: elapsed(start) }, e, connected)
   rescue Net::ReadTimeout => e
-    raise_error(_("Request to %{uri} timed out read operation after %{elapsed} seconds") % {uri: uri, elapsed: elapsed(start)}, e, connected)
+    raise_error(_("Request to %{uri} timed out read operation after %{elapsed} seconds") % { uri: uri, elapsed: elapsed(start) }, e, connected)
   rescue EOFError => e
-    raise_error(_("Request to %{uri} interrupted after %{elapsed} seconds") % {uri: uri, elapsed: elapsed(start)}, e, connected)
+    raise_error(_("Request to %{uri} interrupted after %{elapsed} seconds") % { uri: uri, elapsed: elapsed(start) }, e, connected)
   rescue Puppet::SSL::SSLError
     raise
   rescue Puppet::HTTP::HTTPError
     raise
   rescue => e
     raise_error(_("Request to %{uri} failed after %{elapsed} seconds: %{message}") %
-                {uri: uri, elapsed: elapsed(start), message: e.message}, e, connected)
+                { uri: uri, elapsed: elapsed(start), message: e.message }, e, connected)
   end
 
   # These options apply to all HTTP request methods
@@ -236,6 +237,7 @@ class Puppet::HTTP::Client
   # @api public
   def put(url, body, headers: {}, params: {}, options: {})
     raise ArgumentError, "'put' requires a string 'body' argument" unless body.is_a?(String)
+
     url = encode_query(url, params)
 
     request = Net::HTTP::Put.new(url, @default_headers.merge(headers))
@@ -264,6 +266,7 @@ class Puppet::HTTP::Client
   # @api public
   def post(url, body, headers: {}, params: {}, options: {}, &block)
     raise ArgumentError, "'post' requires a string 'body' argument" unless body.is_a?(String)
+
     url = encode_query(url, params)
 
     request = Net::HTTP::Post.new(url, @default_headers.merge(headers))
@@ -362,7 +365,7 @@ class Puppet::HTTP::Client
     response = nil
     done = false
 
-    while !done do
+    until done
       connect(request.uri, options: options) do |http|
         apply_auth(request, basic_auth) if redirects.zero?
 
@@ -468,6 +471,7 @@ class Puppet::HTTP::Client
   def resolve_ssl_context(ssl_context, include_system_store)
     if ssl_context
       raise Puppet::HTTP::HTTPError, "The ssl_context and include_system_store parameters are mutually exclusive" if include_system_store
+
       ssl_context
     elsif include_system_store
       system_ssl_context

data/lib/puppet/http/dns.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require 'resolv'
 
 module Puppet::HTTP
   class DNS
-
     class CacheEntry
       attr_reader :records, :ttl, :resolution_time
 
@@ -40,7 +41,7 @@ module Puppet::HTTP
     # @param [Symbol] service_name the key of the service we are querying
     # @yields [String, Integer] server and port of selected record
     def each_srv_record(domain, service_name = :puppet, &block)
-      if (domain.nil? or domain.empty?)
+      if domain.nil? or domain.empty?
         Puppet.debug "Domain not known; skipping SRV lookup"
         return
       end
@@ -48,9 +49,9 @@ module Puppet::HTTP
       Puppet.debug "Searching for SRV records for domain: #{domain}"
 
       case service_name
-        when :puppet then service = '_x-puppet'
-        when :file   then service = '_x-puppet-fileserver'
-        else              service = "_x-puppet-#{service_name}"
+      when :puppet then service = '_x-puppet'
+      when :file   then service = '_x-puppet-fileserver'
+      else              service = "_x-puppet-#{service_name}"
       end
       record_name = "#{service}._tcp.#{domain}"
 
@@ -71,7 +72,7 @@ module Puppet::HTTP
         each_srv_record(domain, :puppet, &block)
       else
         each_priority(records) do |recs|
-          while next_rr = recs.delete(find_weighted_server(recs)) #rubocop:disable Lint/AssignmentInCondition
+          while next_rr = recs.delete(find_weighted_server(recs)) # rubocop:disable Lint/AssignmentInCondition
             Puppet.debug "Yielding next server of #{next_rr.target}:#{next_rr.port}"
             yield next_rr.target.to_s, next_rr.port
           end
@@ -97,7 +98,7 @@ module Puppet::HTTP
       # We generate a random number 5, and iterate through the records, adding
       # the current record's weight to the accumulator until the weight of the
       # current record plus previous records is greater than the random number.
-      total_weight = records.inject(0) { |sum,record|
+      total_weight = records.inject(0) { |sum, record|
         sum + weight(record)
       }
       current_weight = 0
@@ -117,7 +118,7 @@ module Puppet::HTTP
     # @param [String] service_name the service whose TTL we want
     # @return [Integer] the TTL for this service, in seconds
     def ttl(service_name)
-      return @record_cache[service_name].ttl
+      @record_cache[service_name].ttl
     end
 
     # Checks if the cached entry for the given service has expired.
@@ -127,9 +128,9 @@ module Puppet::HTTP
     def expired?(service_name)
       entry = @record_cache[service_name]
       if entry
-        return Time.now > (entry.resolution_time + entry.ttl)
+        Time.now > (entry.resolution_time + entry.ttl)
       else
-        return true
+        true
       end
     end
 
@@ -145,10 +146,9 @@ module Puppet::HTTP
     # @yields [[Resolv::DNS::Resource::IN::SRV]] a group of records of
     #         the same priority
     def each_priority(records)
-      pri_hash = records.inject({}) do |groups, element|
+      pri_hash = records.each_with_object({}) do |element, groups|
         groups[element.priority] ||= []
         groups[element.priority] << element
-        groups
       end
 
       pri_hash.keys.sort.each do |key|

data/lib/puppet/http/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Puppet::HTTP
   # A base class for puppet http errors
   # @api public
@@ -34,7 +36,7 @@ module Puppet::HTTP
   # @api public
   class TooManyRedirects < HTTPError
     def initialize(addr)
-      super(_("Too many HTTP redirections for %{addr}") % { addr: addr})
+      super(_("Too many HTTP redirections for %{addr}") % { addr: addr })
     end
   end
 
@@ -42,7 +44,7 @@ module Puppet::HTTP
   # @api public
   class TooManyRetryAfters < HTTPError
     def initialize(addr)
-      super(_("Too many HTTP retries for %{addr}") % { addr: addr})
+      super(_("Too many HTTP retries for %{addr}") % { addr: addr })
     end
   end
 end

data/lib/puppet/http/external_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Adapts an external http_client_class to the HTTP client API. The former
 # is typically registered by puppetserver and only implements a subset of
 # the Puppet::Network::HTTP::Connection methods. As a result, only the
@@ -6,7 +8,6 @@
 #
 # @api private
 class Puppet::HTTP::ExternalClient < Puppet::HTTP::Client
-
   # Create an external http client.
   #
   # @param [Class] http_client_class The class to create to handle the request
@@ -38,7 +39,8 @@ class Puppet::HTTP::ExternalClient < Puppet::HTTP::Client
   # (see Puppet::HTTP::Client#post)
   # @api private
   def post(url, body, headers: {}, params: {}, options: {}, &block)
-    raise ArgumentError.new("'post' requires a string 'body' argument") unless body.is_a?(String)
+    raise ArgumentError, "'post' requires a string 'body' argument" unless body.is_a?(String)
+
     url = encode_query(url, params)
 
     options[:use_ssl] = url.scheme == 'https'
@@ -84,5 +86,4 @@ class Puppet::HTTP::ExternalClient < Puppet::HTTP::Client
   def delete(url, headers: {}, params: {}, options: {})
     raise NotImplementedError
   end
-
 end

data/lib/puppet/http/factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../puppet/ssl/openssl_loader'
 require 'net/http'
 require_relative '../../puppet/http'
@@ -15,7 +17,7 @@ class Puppet::HTTP::Factory
 
   def initialize
     # PUP-1411, make sure that openssl is initialized before we try to connect
-    if ! @@openssl_initialized
+    unless @@openssl_initialized
       OpenSSL::SSL::SSLContext.new
       @@openssl_initialized = true
     end

data/lib/puppet/http/pool.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # A pool for persistent `Net::HTTP` connections. Connections are
 # stored in the pool indexed by their {Site}.
 # Connections are borrowed from the pool, yielded to the caller, and
@@ -70,13 +72,13 @@ class Puppet::HTTP::Pool
     end
   end
 
-
   # Safely close a persistent connection.
   # Don't try to close a connection that's already closed.
   #
   # @api private
   def close_connection(site, http)
     return false unless http.started?
+
     Puppet.debug("Closing connection for #{site}")
     http.finish
     true

data/lib/puppet/http/pool_entry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # An entry in the peristent HTTP pool that references the connection and
 # an expiration time for the connection.
 #

data/lib/puppet/http/proxy.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'uri'
 require_relative '../../puppet/ssl/openssl_loader'
 
 module Puppet::HTTP::Proxy
   def self.proxy(uri)
     if http_proxy_host && !no_proxy?(uri)
-      Net::HTTP.new(uri.host, uri.port, self.http_proxy_host, self.http_proxy_port, self.http_proxy_user, self.http_proxy_password)
+      Net::HTTP.new(uri.host, uri.port, http_proxy_host, http_proxy_port, http_proxy_user, http_proxy_password)
     else
       http = Net::HTTP.new(uri.host, uri.port, nil, nil, nil, nil)
       # Net::HTTP defaults the proxy port even though we said not to
@@ -16,13 +18,13 @@ module Puppet::HTTP::Proxy
 
   def self.http_proxy_env
     # Returns a URI object if proxy is set, or nil
-    proxy_env = ENV["http_proxy"] || ENV["HTTP_PROXY"]
+    proxy_env = ENV.fetch("http_proxy", nil) || ENV.fetch("HTTP_PROXY", nil)
     begin
       return URI.parse(proxy_env) if proxy_env
     rescue URI::InvalidURIError
       return nil
     end
-    return nil
+    nil
   end
 
   # The documentation around the format of the no_proxy variable seems
@@ -51,14 +53,14 @@ module Puppet::HTTP::Proxy
       host, port = d.split(':')
       host = Regexp.escape(host).gsub('\*', '.*')
 
-      #If this no_proxy entry specifies a port, we want to match it against
-      #the destination port.  Otherwise just match hosts.
+      # If this no_proxy entry specifies a port, we want to match it against
+      # the destination port.  Otherwise just match hosts.
       if port
-        no_proxy_regex  = %r(#{host}:#{port}$)
+        no_proxy_regex  = /#{host}:#{port}$/
         dest_string     = "#{dest.host}:#{dest.port}"
       else
-        no_proxy_regex  = %r(#{host}$)
-        dest_string     = "#{dest.host}"
+        no_proxy_regex  = /#{host}$/
+        dest_string     = dest.host.to_s
       end
 
       if no_proxy_regex.match(dest_string)
@@ -66,11 +68,11 @@ module Puppet::HTTP::Proxy
       end
     end
 
-    return false
+    false
   end
 
   def self.http_proxy_host
-    env = self.http_proxy_env
+    env = http_proxy_env
 
     if env and env.host
       return env.host
@@ -80,21 +82,21 @@ module Puppet::HTTP::Proxy
       return nil
     end
 
-    return Puppet.settings[:http_proxy_host]
+    Puppet.settings[:http_proxy_host]
   end
 
   def self.http_proxy_port
-    env = self.http_proxy_env
+    env = http_proxy_env
 
     if env and env.port
       return env.port
     end
 
-    return Puppet.settings[:http_proxy_port]
+    Puppet.settings[:http_proxy_port]
   end
 
   def self.http_proxy_user
-    env = self.http_proxy_env
+    env = http_proxy_env
 
     if env and env.user
       return env.user
@@ -104,11 +106,11 @@ module Puppet::HTTP::Proxy
       return nil
     end
 
-    return Puppet.settings[:http_proxy_user]
+    Puppet.settings[:http_proxy_user]
   end
 
   def self.http_proxy_password
-    env = self.http_proxy_env
+    env = http_proxy_env
 
     if env and env.password
       return env.password
@@ -118,11 +120,11 @@ module Puppet::HTTP::Proxy
       return nil
     end
 
-    return Puppet.settings[:http_proxy_password]
+    Puppet.settings[:http_proxy_password]
   end
 
   def self.no_proxy
-    no_proxy_env = ENV["no_proxy"] || ENV["NO_PROXY"]
+    no_proxy_env = ENV.fetch("no_proxy", nil) || ENV.fetch("NO_PROXY", nil)
 
     if no_proxy_env
       return no_proxy_env
@@ -132,6 +134,6 @@ module Puppet::HTTP::Proxy
       return nil
     end
 
-    return Puppet.settings[:no_proxy]
+    Puppet.settings[:no_proxy]
   end
 end

data/lib/puppet/http/redirector.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Handle HTTP redirects
 #
 # @api private
@@ -41,7 +43,7 @@ class Puppet::HTTP::Redirector
   #
   # @api private
   def redirect_to(request, response, redirects)
-    raise Puppet::HTTP::TooManyRedirects.new(request.uri) if redirects >= @redirect_limit
+    raise Puppet::HTTP::TooManyRedirects, request.uri if redirects >= @redirect_limit
 
     location = parse_location(response)
     url = request.uri.merge(location)
@@ -76,10 +78,10 @@ class Puppet::HTTP::Redirector
 
   def parse_location(response)
     location = response['location']
-    raise Puppet::HTTP::ProtocolError.new(_("Location response header is missing")) unless location
+    raise Puppet::HTTP::ProtocolError, _("Location response header is missing") unless location
 
     URI.parse(location)
   rescue URI::InvalidURIError => e
-    raise Puppet::HTTP::ProtocolError.new(_("Location URI is invalid: %{detail}") % { detail: e.message}, e)
+    raise Puppet::HTTP::ProtocolError.new(_("Location URI is invalid: %{detail}") % { detail: e.message }, e)
   end
 end

data/lib/puppet/http/resolver/server_list.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 # Use the server_list setting to resolve a service. This resolver is only used
 # if server_list is set either on the command line or in the configuration file.
 #
 # @api public
 class Puppet::HTTP::Resolver::ServerList < Puppet::HTTP::Resolver
-
   # Create a server list resolver.
   #
   # @param [Puppet::HTTP::Client] client
@@ -15,7 +16,7 @@ class Puppet::HTTP::Resolver::ServerList < Puppet::HTTP::Resolver
   #   used to resolve. If a service is not included in this array, this resolver
   #   will return nil.
   #
-  def initialize(client, server_list_setting:, default_port:, services: )
+  def initialize(client, server_list_setting:, default_port:, services:)
     @client = client
     @server_list_setting = server_list_setting
     @default_port = default_port
@@ -70,10 +71,10 @@ class Puppet::HTTP::Resolver::ServerList < Puppet::HTTP::Resolver
         end
       rescue Puppet::HTTP::HTTPError => detail
         if index < @server_list_setting.value.length - 1
-          Puppet.warning(_("Unable to connect to server from server_list setting: %{detail}") % {detail: detail} +
+          Puppet.warning(_("Unable to connect to server from server_list setting: %{detail}") % { detail: detail } +
                              ' ' + _("Trying with next server from server_list."))
         else
-          Puppet.log_exception(detail, _("Unable to connect to server from server_list setting: %{detail}") % {detail: detail})
+          Puppet.log_exception(detail, _("Unable to connect to server from server_list setting: %{detail}") % { detail: detail })
         end
       end
     end

data/lib/puppet/http/resolver/settings.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 # Resolve a service using settings. This is the default resolver if none of the
 # other resolvers find a functional connection.
 #
 # @api public
 class Puppet::HTTP::Resolver::Settings < Puppet::HTTP::Resolver
-
   # Resolve a service using the default server and port settings for this service.
   #
   # @param [Puppet::HTTP::Session] session

data/lib/puppet/http/resolver/srv.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 # Resolve a service using DNS SRV records.
 #
 # @api public
 class Puppet::HTTP::Resolver::SRV < Puppet::HTTP::Resolver
-
   # Create an DNS SRV resolver.
   #
   # @param [Puppet::HTTP::Client] client

data/lib/puppet/http/resolver.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Resolver base class. Each resolver represents a different strategy for
 # resolving a service name into a list of candidate servers and ports.
 #
@@ -40,9 +42,9 @@ class Puppet::HTTP::Resolver
   # @api public
   def check_connection?(session, service, ssl_context: nil)
     service.connect(ssl_context: ssl_context)
-    return true
+    true
   rescue Puppet::HTTP::ConnectionError => e
     Puppet.log_exception(e, "Connection to #{service.url} failed, trying next route: #{e.message}")
-    return false
+    false
   end
 end

data/lib/puppet/http/response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Represents the response returned from the server from an HTTP request.
 #
 # @api abstract

data/lib/puppet/http/response_converter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Puppet::HTTP::ResponseConverter
   module_function
 
@@ -7,7 +9,7 @@ module Puppet::HTTP::ResponseConverter
 
     # Copied from Net::HTTPResponse because it is private there.
     clazz = Net::HTTPResponse::CODE_TO_OBJ[str_code] or
-      Net::HTTPResponse::CODE_CLASS_TO_OBJ[str_code[0,1]] or
+      Net::HTTPResponse::CODE_CLASS_TO_OBJ[str_code[0, 1]] or
       Net::HTTPUnknownResponse
     result = clazz.new(nil, str_code, nil)
     result.body = response.body
@@ -15,10 +17,9 @@ module Puppet::HTTP::ResponseConverter
     # an instance of Net::HttpResponse from outside of the library and have
     # the body be readable, unless you do stupid things like this.
     result.instance_variable_set(:@read, true)
-    response.each_header do |k,v|
+    response.each_header do |k, v|
       result[k] = v
     end
     result
   end
 end
-

data/lib/puppet/http/response_net_http.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 # Adapts Net::HTTPResponse to Puppet::HTTP::Response
 #
 # @api public
 class Puppet::HTTP::ResponseNetHTTP < Puppet::HTTP::Response
-
   # Create a response associated with the URL.
   #
   # @param [URI] url

data/lib/puppet/http/retry_after_handler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'date'
 require 'time'
 
@@ -5,7 +7,6 @@ require 'time'
 #
 # @api private
 class Puppet::HTTP::RetryAfterHandler
-
   # Create a handler to allow the system to sleep between HTTP requests
   #
   # @param [Integer] retry_limit number of retries allowed
@@ -47,7 +48,7 @@ class Puppet::HTTP::RetryAfterHandler
   #
   # @api private
   def retry_after_interval(request, response, retries)
-    raise Puppet::HTTP::TooManyRetryAfters.new(request.uri) if retries >= @retry_limit
+    raise Puppet::HTTP::TooManyRetryAfters, request.uri if retries >= @retry_limit
 
     retry_after = response['Retry-After']
     return nil unless retry_after
@@ -71,7 +72,7 @@ class Puppet::HTTP::RetryAfterHandler
       seconds = (tm.to_time - DateTime.now.to_time).to_i
       [seconds, 0].max
     rescue ArgumentError
-      raise Puppet::HTTP::ProtocolError.new(_("Failed to parse Retry-After header '%{retry_after}' as an integer or RFC 2822 date") % { retry_after: retry_after })
+      raise Puppet::HTTP::ProtocolError, _("Failed to parse Retry-After header '%{retry_after}' as an integer or RFC 2822 date") % { retry_after: retry_after }
     end
   end
 end

data/lib/puppet/http/service/ca.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The CA service is used to handle certificate related REST requests.
 #
 # @api public
@@ -6,7 +8,7 @@ class Puppet::HTTP::Service::Ca < Puppet::HTTP::Service
   HEADERS = { 'Accept' => 'text/plain' }.freeze
 
   # @return [String] default API for the ca service
-  API = '/puppet-ca/v1'.freeze
+  API = '/puppet-ca/v1'
 
   # Use `Puppet::HTTP::Session.route_to(:ca)` to create or get an instance of this class.
   #
@@ -27,17 +29,22 @@ class Puppet::HTTP::Service::Ca < Puppet::HTTP::Service
   # Submit a GET request to retrieve the named certificate from the server.
   #
   # @param [String] name name of the certificate to request
+  # @param [Time] if_modified_since If not nil, only download the cert if it has
+  #   been modified since the specified time.
   # @param [Puppet::SSL::SSLContext] ssl_context
   #
   # @return [Array<Puppet::HTTP::Response, String>] An array containing the
   #   request response and the stringified body of the request response
   #
   # @api public
-  def get_certificate(name, ssl_context: nil)
+  def get_certificate(name, if_modified_since: nil, ssl_context: nil)
+    headers = add_puppet_headers(HEADERS)
+    headers['If-Modified-Since'] = if_modified_since.httpdate if if_modified_since
+
     response = @client.get(
       with_base_url("/certificate/#{name}"),
-      headers: add_puppet_headers(HEADERS),
-      options: {ssl_context: ssl_context}
+      headers: headers,
+      options: { ssl_context: ssl_context }
     )
 
     process_response(response)
@@ -63,7 +70,7 @@ class Puppet::HTTP::Service::Ca < Puppet::HTTP::Service
     response = @client.get(
       with_base_url("/certificate_revocation_list/ca"),
       headers: headers,
-      options: {ssl_context: ssl_context}
+      options: { ssl_context: ssl_context }
     )
 
     process_response(response)
@@ -98,4 +105,29 @@ class Puppet::HTTP::Service::Ca < Puppet::HTTP::Service
 
     response
   end
+
+  # Submit a POST request to send a certificate renewal request to the server
+  #
+  # @param [Puppet::SSL::SSLContext] ssl_context
+  #
+  # @return [Array<Puppet::HTTP::Response, String>] The request response
+  #
+  # @api public
+  def post_certificate_renewal(ssl_context)
+    headers = add_puppet_headers(HEADERS)
+    headers['Content-Type'] = 'text/plain'
+
+    response = @client.post(
+      with_base_url('/certificate_renewal'),
+      '', # Puppet::HTTP::Client.post requires a body, the API endpoint does not
+      headers: headers,
+      options: { ssl_context: ssl_context }
+    )
+
+    raise ArgumentError, _('SSL context must contain a client certificate.') unless ssl_context.client_cert
+
+    process_response(response)
+
+    [response, response.body.to_s]
+  end
 end