openvox 7.37.1 → 8.19.0

data/lib/puppet/application/ssl.rb

@@ -1,88 +1,95 @@
+# frozen_string_literal: true
+
 require_relative '../../puppet/application'
 require_relative '../../puppet/ssl/oids'
 
 class Puppet::Application::Ssl < Puppet::Application
-
   run_mode :agent
 
   def summary
-    _("Manage SSL keys and certificates for puppet SSL clients")
+    _("Manage SSL keys and certificates for OpenVox SSL clients")
   end
 
   def help
-    <<-HELP
-puppet-ssl(8) -- #{summary}
-========
-
-SYNOPSIS
---------
-Manage SSL keys and certificates for SSL clients needing
-to communicate with a puppet infrastructure.
-
-USAGE
------
-puppet ssl <action> [-h|--help] [-v|--verbose] [-d|--debug] [--localca] [--target CERTNAME]
-
-
-OPTIONS
--------
-
-* --help:
-  Print this help message.
-
-* --verbose:
-  Print extra information.
-
-* --debug:
-  Enable full debugging.
-
-* --localca
-  Also clean the local CA certificate and CRL.
-
-* --target CERTNAME
-  Clean the specified device certificate instead of this host's certificate.
-
-ACTIONS
--------
-
-* bootstrap:
-  Perform all of the steps necessary to request and download a client
-  certificate. If autosigning is disabled, then puppet will wait every
-  `waitforcert` seconds for its certificate to be signed. To only attempt
-  once and never wait, specify a time of 0. Since `waitforcert` is a
-  Puppet setting, it can be specified as a time interval, such as 30s,
-  5m, 1h.
-
-* submit_request:
-  Generate a certificate signing request (CSR) and submit it to the CA. If
-  a private and public key pair already exist, they will be used to generate
-  the CSR. Otherwise a new key pair will be generated. If a CSR has already
-  been submitted with the given `certname`, then the operation will fail.
-
-* generate_request:
-  Generate a certificate signing request (CSR). If
-  a private and public key pair already exist, they will be used to generate
-  the CSR. Otherwise a new key pair will be generated.
-
-* download_cert:
-  Download a certificate for this host. If the current private key matches
-  the downloaded certificate, then the certificate will be saved and used
-  for subsequent requests. If there is already an existing certificate, it
-  will be overwritten.
-
-* verify:
-  Verify the private key and certificate are present and match, verify the
-  certificate is issued by a trusted CA, and check revocation status.
-
-* clean:
-  Remove the private key and certificate related files for this host. If
-  `--localca` is specified, then also remove this host's local copy of the
-  CA certificate(s) and CRL bundle. if `--target CERTNAME` is specified, then
-  remove the files for the specified device on this host instead of this host.
-
- * show:
-  Print the full-text version of this host's certificate.
-HELP
+    <<~HELP
+      puppet-ssl(8) -- #{summary}
+      ========
+
+      SYNOPSIS
+      --------
+      Manage SSL keys and certificates for clients needing
+      to communicate with an OpenVox infrastructure.
+
+      USAGE
+      -----
+      puppet ssl <action> [-h|--help] [-v|--verbose] [-d|--debug] [--localca] [--target CERTNAME]
+
+
+      OPTIONS
+      -------
+
+      * --help:
+        Print this help message.
+
+      * --verbose:
+        Print extra information.
+
+      * --debug:
+        Enable full debugging.
+
+      * --localca
+        Also clean the local CA certificate and CRL.
+
+      * --target CERTNAME
+        Clean the specified device certificate instead of this host's certificate.
+
+      ACTIONS
+      -------
+
+      * bootstrap:
+        Perform all of the steps necessary to request and download a client
+        certificate. If autosigning is disabled, then puppet will wait every
+        `waitforcert` seconds for its certificate to be signed. To only attempt
+        once and never wait, specify a time of 0. Since `waitforcert` is a
+        Puppet setting, it can be specified as a time interval, such as 30s,
+        5m, 1h.
+
+      * submit_request:
+        Generate a certificate signing request (CSR) and submit it to the CA. If
+        a private and public key pair already exist, they will be used to generate
+        the CSR. Otherwise, a new key pair will be generated. If a CSR has already
+        been submitted with the given `certname`, then the operation will fail.
+
+      * generate_request:
+        Generate a certificate signing request (CSR). If a private and public key
+        pair exist, they will be used to generate the CSR. Otherwise a new key
+        pair will be generated.
+
+      * download_cert:
+        Download a certificate for this host. If the current private key matches
+        the downloaded certificate, then the certificate will be saved and used
+        for subsequent requests. If there is already an existing certificate, it
+        will be overwritten.
+
+      * verify:
+        Verify the private key and certificate are present and match, verify the
+        certificate is issued by a trusted CA, and check revocation status.
+
+      * clean:
+        Remove the private key and certificate related files for this host. If
+        `--localca` is specified, then also remove this host's local copy of the
+        CA certificate(s) and CRL bundle. if `--target CERTNAME` is specified, then
+        remove the files for the specified device on this host instead of this host.
+
+       * show:
+        Print the full-text version of this host's certificate.
+
+      COPYRIGHT
+        ---------
+        Copyright (c) 2011 Puppet Inc.
+        Copyright (c) 2024 Vox Pupuli
+        Licensed under the Apache 2.0 License
+    HELP
   end
 
   option('--target CERTNAME') do |arg|
@@ -148,17 +155,18 @@ HELP
     when 'clean'
       possible_extra_args = command_line.args.drop(1)
       unless possible_extra_args.empty?
-        raise Puppet::Error, _(<<END) % { args: possible_extra_args.join(' ')}
-Extra arguments detected: %{args}
-Did you mean to run:
-  puppetserver ca clean --certname <name>
-Or:
-  puppet ssl clean --target <name>
-END
+        raise Puppet::Error, _(<<~END) % { args: possible_extra_args.join(' ') }
+          Extra arguments detected: %{args}
+          Did you mean to run:
+            puppetserver ca clean --certname <name>
+          Or:
+            puppet ssl clean --target <name>
+        END
       end
+
       clean(certname)
     when 'bootstrap'
-      if !Puppet::Util::Log.sendlevel?(:info)
+      unless Puppet::Util::Log.sendlevel?(:info)
         Puppet::Util::Log.level = :info
       end
       @machine.ensure_client_certificate
@@ -190,7 +198,7 @@ END
     Puppet.notice _("Submitted certificate request for '%{name}' to %{url}") % { name: Puppet[:certname], url: route.url }
   rescue Puppet::HTTP::ResponseError => e
     if e.response.code == 400
-      raise Puppet::Error.new(_("Could not submit certificate request for '%{name}' to %{url} due to a conflict on the server") % { name: Puppet[:certname], url: route.url })
+      raise Puppet::Error, _("Could not submit certificate request for '%{name}' to %{url} due to a conflict on the server") % { name: Puppet[:certname], url: route.url }
     else
       raise Puppet::Error.new(_("Failed to submit certificate request: %{message}") % { message: e.message }, e)
     end
@@ -232,7 +240,7 @@ END
     cert
   rescue Puppet::HTTP::ResponseError => e
     if e.response.code == 404
-      return nil
+      nil
     else
       raise Puppet::Error.new(_("Failed to download certificate: %{message}") % { message: e.message }, e)
     end
@@ -273,18 +281,18 @@ END
       end
 
       if cert
-        raise Puppet::Error, _(<<END) % { certname: certname }
-The certificate %{certname} must be cleaned from the CA first. To fix this,
-run the following commands on the CA:
-  puppetserver ca clean --certname %{certname}
-  puppet ssl clean
-END
+        raise Puppet::Error, _(<<~END) % { certname: certname }
+          The certificate %{certname} must be cleaned from the CA first. To fix this,
+          run the following commands on the CA:
+            puppetserver ca clean --certname %{certname}
+            puppet ssl clean
+        END
       end
     end
 
     paths = {
       'private key' => Puppet[:hostprivkey],
-      'public key'  => Puppet[:hostpubkey],
+      'public key' => Puppet[:hostpubkey],
       'certificate request' => Puppet[:hostcsr],
       'certificate' => Puppet[:hostcert],
       'private key password file' => Puppet[:passfile]

data/lib/puppet/application.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'optparse'
 require_relative '../puppet/util/command_line'
 require_relative '../puppet/util/constant_inflector'
@@ -5,7 +7,6 @@ require_relative '../puppet/error'
 require_relative '../puppet/application_support'
 
 module Puppet
-
 # Defines an abstract Puppet application.
 #
 # # Usage
@@ -108,7 +109,7 @@ class Application
   require_relative '../puppet/util'
   include Puppet::Util
 
-  DOCPATTERN = ::File.expand_path(::File.dirname(__FILE__) + "/util/command_line/*" )
+  DOCPATTERN = ::File.expand_path(::File.dirname(__FILE__) + "/util/command_line/*")
   CommandLineArgs = Struct.new(:subcommand_name, :args)
 
   @loader = Puppet::Util::Autoload.new(self, 'puppet/application')
@@ -169,6 +170,7 @@ class Application
     # Thus, long-running background processes can potentially finish their work before a restart.
     def controlled_run(&block)
       return unless clear?
+
       result = block.call
       Process.kill(:HUP, $PID) if restart_requested?
       result
@@ -176,16 +178,16 @@ class Application
 
     # used to declare code that handle an option
     def option(*options, &block)
-      long = options.find { |opt| opt =~ /^--/ }.gsub(/^--(?:\[no-\])?([^ =]+).*$/, '\1' ).tr('-','_')
+      long = options.find { |opt| opt =~ /^--/ }.gsub(/^--(?:\[no-\])?([^ =]+).*$/, '\1').tr('-', '_')
       fname = "handle_#{long}".intern
-      if (block_given?)
+      if block_given?
         define_method(fname, &block)
       else
         define_method(fname) do |value|
-          self.options["#{long}".to_sym] = value
+          self.options[long.to_s.to_sym] = value
         end
       end
-      self.option_parser_commands << [options, fname]
+      option_parser_commands << [options, fname]
     end
 
     def banner(banner = nil)
@@ -240,7 +242,7 @@ class Application
       ####  eventually we need to issue a deprecation warning here,
       ####  and then get rid of this stanza in a subsequent release.
       ################################################################
-      if (clazz.nil?)
+      if clazz.nil?
         class_name = application_name.capitalize
         clazz = try_load_class(class_name)
       end
@@ -249,17 +251,17 @@ class Application
       ################################################################
 
       if clazz.nil?
-        raise Puppet::Error.new(_("Unable to load application class '%{class_name}' from file 'puppet/application/%{application_name}.rb'") % { class_name: class_name, application_name: application_name })
+        raise Puppet::Error, _("Unable to load application class '%{class_name}' from file 'puppet/application/%{application_name}.rb'") % { class_name: class_name, application_name: application_name }
       end
 
-      return clazz
+      clazz
     end
 
     # Given the fully qualified name of a class, attempt to get the class instance.
     # @param [String] class_name the fully qualified name of the class to try to load
     # @return [Class] the Class instance, or nil? if it could not be loaded.
     def try_load_class(class_name)
-        return self.const_defined?(class_name) ? const_get(class_name) : nil
+      const_defined?(class_name) ? const_get(class_name) : nil
     end
     private :try_load_class
 
@@ -282,10 +284,10 @@ class Application
         Puppet.settings.preferred_run_mode = mode_name
       end
 
-      return @run_mode if @run_mode and not mode_name
+      return @run_mode if @run_mode and !mode_name
 
       require_relative '../puppet/util/run_mode'
-      @run_mode = Puppet::Util::RunMode[ mode_name || Puppet.settings.preferred_run_mode ]
+      @run_mode = Puppet::Util::RunMode[mode_name || Puppet.settings.preferred_run_mode]
     end
 
     # Sets environment_mode name. When acting as a compiler, the environment mode
@@ -303,6 +305,7 @@ class Application
     # @api public
     def environment_mode(mode_name)
       raise Puppet::Error, _("Invalid environment mode '%{mode_name}'") % { mode_name: mode_name } unless [:local, :remote, :not_required].include?(mode_name)
+
       @environment_mode = mode_name
     end
 
@@ -326,13 +329,13 @@ class Application
   # Every app responds to --version
   # See also `lib/puppet/util/command_line.rb` for some special case early
   # handling of this.
-  option("--version", "-V") do |arg|
-    puts "#{Puppet.version}"
+  option("--version", "-V") do |_arg|
+    puts Puppet.version
     exit(0)
   end
 
   # Every app responds to --help
-  option("--help", "-h") do |v|
+  option("--help", "-h") do |_v|
     puts help
     exit(0)
   end
@@ -362,14 +365,14 @@ class Application
   # @api public
   def app_defaults
     Puppet::Settings.app_defaults_for_run_mode(self.class.run_mode).merge(
-        :name => name
+      :name => name
     )
   end
 
   # Initialize application defaults. It's usually not necessary to override this method.
   # @return [void]
   # @api public
-  def initialize_app_defaults()
+  def initialize_app_defaults
     Puppet.settings.initialize_app_defaults(app_defaults)
   end
 
@@ -398,7 +401,6 @@ class Application
   # @return [void]
   # @api public
   def run
-
     # I don't really like the names of these lifecycle phases.  It would be nice to change them to some more meaningful
     # names, and make deprecated aliases.  --cprice 2012-03-16
 
@@ -450,7 +452,7 @@ class Application
   # @return [void]
   # @api public
   def setup_logs
-    handle_logdest_arg(Puppet[:logdest]) if !options[:setdest]
+    handle_logdest_arg(Puppet[:logdest]) unless options[:setdest]
 
     unless options[:setdest]
       if options[:debug] || options[:verbose]
@@ -479,12 +481,10 @@ class Application
     Puppet[:logdest] = arg
 
     logdest.each do |dest|
-      begin
-        Puppet::Util::Log.newdestination(dest)
-        options[:setdest] = true
-      rescue => detail
-        Puppet.log_and_raise(detail, _("Could not set logdest to %{dest}.") % { dest: arg })
-      end
+      Puppet::Util::Log.newdestination(dest)
+      options[:setdest] = true
+    rescue => detail
+      Puppet.log_and_raise(detail, _("Could not set logdest to %{dest}.") % { dest: arg })
     end
   end
 
@@ -499,11 +499,11 @@ class Application
   #   to log. Intended to be passed to super by subclasses.
   # @return [void]
   # @api public
-  def log_runtime_environment(extra_info=nil)
+  def log_runtime_environment(extra_info = nil)
     runtime_info = {
       'puppet_version' => Puppet.version,
-      'ruby_version'   => RUBY_VERSION,
-      'run_mode'       => self.class.run_mode.name
+      'ruby_version' => RUBY_VERSION,
+      'run_mode' => self.class.run_mode.name
     }
     unless Puppet::Util::Platform.jruby_fips?
       runtime_info['openssl_version'] = "'#{OpenSSL::OPENSSL_VERSION}'"
@@ -512,7 +512,7 @@ class Application
     runtime_info['default_encoding'] = Encoding.default_external
     runtime_info.merge!(extra_info) unless extra_info.nil?
 
-    Puppet.debug 'Runtime environment: ' + runtime_info.map{|k,v| k + '=' + v.to_s}.join(', ')
+    Puppet.debug 'Runtime environment: ' + runtime_info.map { |k, v| k + '=' + v.to_s }.join(', ')
   end
 
   # Options defined with the `option` method are parsed from settings and the command line.
@@ -553,14 +553,14 @@ class Application
     self.class.option_parser_commands.each do |options, fname|
       option_parser.on(*options) do |value|
         # Call the method that "option()" created.
-        self.send(fname, value)
+        send(fname, value)
       end
     end
 
     # Scan command line.  We just hand any exceptions to our upper levels,
     # rather than printing help and exiting, so that we can meaningfully
     # respond with context-sensitive help if we want to. --daniel 2011-04-12
-    option_parser.parse!(self.command_line.args)
+    option_parser.parse!(command_line.args)
   end
 
   def handlearg(opt, val)
@@ -574,7 +574,7 @@ class Application
   end
 
   def name
-    self.class.to_s.sub(/.*::/,"").downcase.to_sym
+    self.class.to_s.sub(/.*::/, "").downcase.to_sym
   end
 
   # Return the text to display when running `puppet help`.

data/lib/puppet/application_support.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 
 require_relative '../puppet'
@@ -7,7 +9,6 @@ require_relative '../puppet/indirector'
 
 module Puppet
   module ApplicationSupport
-
     # Pushes a Puppet Context configured with a remote environment for an agent
     # (one that exists at the master end), and a regular environment for other
     # modes. The configuration is overridden with options from the command line
@@ -36,7 +37,7 @@ module Puppet
       configured_environment = configured_environment.override_from_commandline(Puppet.settings)
 
       # Setup a new context using the app's configuration
-      Puppet.push_context({:current_environment => configured_environment},
+      Puppet.push_context({ :current_environment => configured_environment },
                           "Update current environment from application's configuration")
     end
 

data/lib/puppet/coercion.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Various methods used to coerce values into a canonical form.
 #
 # @api private
@@ -18,9 +20,9 @@ module Puppet::Coercion
     end
 
     case value
-    when true, :true, 'true', :yes, 'yes'
+    when true, :true, 'true', :yes, 'yes' # rubocop:disable Lint/BooleanSymbol
       true
-    when false, :false, 'false', :no, 'no'
+    when false, :false, 'false', :no, 'no' # rubocop:disable Lint/BooleanSymbol
       false
     else
       fail('expected a boolean value')
@@ -35,6 +37,6 @@ module Puppet::Coercion
   # @raise
   # @api private
   def self.boolean_values
-    ['true', 'false', 'yes', 'no']
+    %w[true false yes no]
   end
 end

data/lib/puppet/compilable_resource_type.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../puppet'
 # The CompilableResourceType module should be either included in a class or used as a class extension
 # to mark that the instance used as the 'resource type' of a resource instance
@@ -5,11 +7,11 @@ require_relative '../puppet'
 # Puppet Resource Types written in Ruby use a meta programmed Ruby Class as the type. Those classes
 # are subtypes of Puppet::Type. Meta data (Pcore/puppet language) based resource types uses instances of
 # a class instead.
-# 
+#
 module Puppet::CompilableResourceType
   # All 3.x resource types implemented in Ruby using Puppet::Type respond true.
   # Other kinds of implementations should reimplement and return false.
   def is_3x_ruby_plugin?
     true
   end
-end
+end

data/lib/puppet/concurrent/lock.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require_relative '../../puppet/concurrent/synchronized'
 
 module Puppet
 module Concurrent
-
 # A simple lock that at the moment only does any locking on jruby
 class Lock
   include Puppet::Concurrent::Synchronized
@@ -10,7 +11,5 @@ class Lock
     yield
   end
 end
-
 end
 end
-

data/lib/puppet/concurrent/synchronized.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module Puppet
 module Concurrent
-
 # Including Puppet::Concurrent::Synchronized into a class when running on JRuby
 # causes all of its instance methods to be synchronized on the instance itself.
 # When running on MRI it has no effect.
@@ -10,6 +11,5 @@ if RUBY_PLATFORM == 'java'
 else
   module Synchronized; end
 end
-
 end
 end

data/lib/puppet/concurrent/thread_local_singleton.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Puppet
   module Concurrent
     module ThreadLocalSingleton

data/lib/puppet/concurrent.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 module Puppet::Concurrent
 end

data/lib/puppet/configurer/downloader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../puppet/configurer'
 require_relative '../../puppet/resource/catalog'
 
@@ -18,7 +20,7 @@ class Puppet::Configurer::Downloader
           if first_failure
             event = (first_failure.events || []).first
             detail = event ? event.message : 'unknown'
-            raise Puppet::Error.new(_("Failed to retrieve %{name}: %{detail}") % { name: name, detail: detail })
+            raise Puppet::Error, _("Failed to retrieve %{name}: %{detail}") % { name: name, detail: detail }
           end
         end
 
@@ -38,8 +40,12 @@ class Puppet::Configurer::Downloader
   end
 
   def initialize(name, path, source, ignore = nil, environment = nil, source_permissions = :ignore)
-    @name, @path, @source, @ignore, @environment, @source_permissions = name, path, source, ignore, environment, source_permissions
-
+    @name = name
+    @path = path
+    @source = source
+    @ignore = ignore
+    @environment = environment
+    @source_permissions = source_permissions
   end
 
   def file
@@ -76,10 +82,10 @@ class Puppet::Configurer::Downloader
       :noop => false,
       :max_files => -1
     }
-    if !Puppet::Util::Platform.windows?
+    unless Puppet::Util::Platform.windows?
       defargs[:owner] = Process.uid
       defargs[:group] = Process.gid
     end
-    return defargs
+    defargs
   end
 end

data/lib/puppet/configurer/fact_handler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../puppet/indirector/facts/facter'
 
 require_relative '../../puppet/configurer'
@@ -11,20 +13,19 @@ module Puppet::Configurer::FactHandler
     # This works because puppet agent configures Facts to use 'facter' for
     # finding facts and the 'rest' terminus for caching them.  Thus, we'll
     # compile them and then "cache" them on the server.
-    begin
-      facts = Puppet::Node::Facts.indirection.find(Puppet[:node_name_value], :environment => Puppet::Node::Environment.remote(@environment))
-      unless Puppet[:node_name_fact].empty?
-        Puppet[:node_name_value] = facts.values[Puppet[:node_name_fact]]
-        facts.name = Puppet[:node_name_value]
-      end
-      facts
-    rescue SystemExit,NoMemoryError
-      raise
-    rescue Exception => detail
-      message = _("Could not retrieve local facts: %{detail}") % { detail: detail }
-      Puppet.log_exception(detail, message)
-      raise Puppet::Error, message, detail.backtrace
+
+    facts = Puppet::Node::Facts.indirection.find(Puppet[:node_name_value], :environment => Puppet::Node::Environment.remote(@environment))
+    unless Puppet[:node_name_fact].empty?
+      Puppet[:node_name_value] = facts.values[Puppet[:node_name_fact]]
+      facts.name = Puppet[:node_name_value]
     end
+    facts
+  rescue SystemExit, NoMemoryError
+    raise
+  rescue Exception => detail
+    message = _("Could not retrieve local facts: %{detail}") % { detail: detail }
+    Puppet.log_exception(detail, message)
+    raise Puppet::Error, message, detail.backtrace
   end
 
   def facts_for_uploading
@@ -32,7 +33,7 @@ module Puppet::Configurer::FactHandler
   end
 
   def encode_facts(facts)
-    #facts = find_facts
+    # facts = find_facts
 
     # NOTE: :facts specified as parameters are URI encoded here,
     # then  encoded for a second time depending on their length:
@@ -42,9 +43,9 @@ module Puppet::Configurer::FactHandler
     # so it's only important that encoding method here return original values
     # correctly when CGI.unescape called against it (in compiler code)
     if Puppet[:preferred_serialization_format] == "pson"
-      {:facts_format => :pson, :facts => Puppet::Util.uri_query_encode(facts.render(:pson)) }
+      { :facts_format => :pson, :facts => Puppet::Util.uri_query_encode(facts.render(:pson)) }
     else
-      {:facts_format => 'application/json', :facts => Puppet::Util.uri_query_encode(facts.render(:json)) }
+      { :facts_format => 'application/json', :facts => Puppet::Util.uri_query_encode(facts.render(:json)) }
     end
   end
 end