puppet 7.4.0-universal-darwin → 7.8.0-universal-darwin

data/lib/puppet/provider/package_targetable.rb

@@ -7,7 +7,7 @@
 # possibly via a `prefetchV2` method that could take a better data structure.)
 #
 # In addition, `Puppet::Provider::Package::properties` calls `query` in the provider.
-require 'puppet/provider/package'
+require_relative '../../puppet/provider/package'
 
 # But `query` in the provider depends upon whether a `command` attribute is defined for the resource.
 # This is a Catch-22.

data/lib/puppet/provider/parsedfile.rb

@@ -1,6 +1,6 @@
-require 'puppet'
-require 'puppet/util/filetype'
-require 'puppet/util/fileparsing'
+require_relative '../../puppet'
+require_relative '../../puppet/util/filetype'
+require_relative '../../puppet/util/fileparsing'
 
 # This provider can be used as the parent class for a provider that
 # parses and generates files.  Its content must be loaded via the

data/lib/puppet/provider/service/base.rb

@@ -68,10 +68,10 @@ Puppet::Type.type(:service).provide :base, :parent => :service do
   def status
     if @resource[:status] or statuscmd
       # Don't fail when the exit status is not 0.
-      ucommand(:status, false)
+      status = service_command(:status, false)
 
       # Explicitly calling exitstatus to facilitate testing
-      if $CHILD_STATUS.exitstatus == 0
+      if status.exitstatus == 0
         return :running
       else
         return :stopped
@@ -93,7 +93,8 @@ Puppet::Type.type(:service).provide :base, :parent => :service do
 
   # Run the 'start' parameter command, or the specified 'startcmd'.
   def start
-    ucommand(:start)
+    service_command(:start)
+    nil
   end
 
   # The command used to start.  Generated if the 'binary' argument
@@ -114,7 +115,8 @@ Puppet::Type.type(:service).provide :base, :parent => :service do
   # This method will generally not be overridden by submodules.
   def stop
     if @resource[:stop] or stopcmd
-      ucommand(:stop)
+      service_command(:stop)
+      nil
     else
       pid = getpid
       unless pid

data/lib/puppet/provider/service/daemontools.rb

@@ -128,7 +128,6 @@ Puppet::Type.type(:service).provide :daemontools, :parent => :base do
       if resource[:manifest]
         Puppet.notice "Configuring #{resource[:name]}"
         command = [ resource[:manifest], resource[:name] ]
-        #texecute("setupservice", command)
         system("#{command}")
       end
   rescue Puppet::ExecutionFailure => detail

data/lib/puppet/provider/service/debian.rb

@@ -34,16 +34,14 @@ Puppet::Type.type(:service).provide :debian, :parent => :init do
   end
 
   def enabled?
-    # TODO: Replace system call when Puppet::Util::Execution.execute gives us a way
-    # to determine exit status.  https://projects.puppetlabs.com/issues/2538
-    system("/usr/sbin/invoke-rc.d", "--quiet", "--query", @resource[:name], "start")
+    status = execute(["/usr/sbin/invoke-rc.d", "--quiet", "--query", @resource[:name], "start"], :failonfail => false)
 
     # 104 is the exit status when you query start an enabled service.
     # 106 is the exit status when the policy layer supplies a fallback action
     # See x-man-page://invoke-rc.d
-    if [104, 106].include?($CHILD_STATUS.exitstatus)
+    if [104, 106].include?(status.exitstatus)
       return :true
-    elsif [101, 105].include?($CHILD_STATUS.exitstatus)
+    elsif [101, 105].include?(status.exitstatus)
       # 101 is action not allowed, which means we have to do the check manually.
       # 105 is unknown, which generally means the initscript does not support query
       # The debian policy states that the initscript should support methods of query

data/lib/puppet/provider/service/freebsd.rb

@@ -74,7 +74,7 @@ Puppet::Type.type(:service).provide :freebsd, :parent => :init do
       if Puppet::FileSystem.exist?(filename)
         s = File.read(filename)
         if s.gsub!(/^(#{rcvar}(_enable)?)=\"?(YES|NO)\"?/, "\\1=\"#{yesno}\"")
-          File.open(filename, File::WRONLY) { |f| f << s }
+          Puppet::FileSystem.replace_file(filename) { |f| f << s  }
           self.debug("Replaced in #{filename}")
           success = true
         end

data/lib/puppet/provider/service/init.rb

@@ -170,7 +170,7 @@ Puppet::Type.type(:service).provide :init, :parent => :base do
     (@resource[:hasrestart] == :true) && [initscript, :restart]
   end
 
-  def texecute(type, command, fof = true, squelch = false, combine = true)
+  def service_execute(type, command, fof = true, squelch = false, combine = true)
     if type == :start && Facter.value(:osfamily) == "Solaris"
         command =  ["/usr/bin/ctrun -l child", command].flatten.join(" ")
     end

data/lib/puppet/provider/service/launchd.rb

@@ -1,4 +1,4 @@
-require 'puppet/util/plist'
+require_relative '../../../puppet/util/plist'
 Puppet::Type.type(:service).provide :launchd, :parent => :base do
   desc <<-'EOT'
     This provider manages jobs with `launchd`, which is the default service
@@ -262,7 +262,10 @@ Puppet::Type.type(:service).provide :launchd, :parent => :base do
   # conditionally enable at load, then disable by modifying the plist file
   # directly.
   def start
-    return ucommand(:start) if resource[:start]
+    if resource[:start]
+      service_command(:start)
+      return nil
+    end
     job_path, _ = plist_from_label(resource[:name])
     did_enable_job = false
     cmds = []
@@ -285,7 +288,10 @@ Puppet::Type.type(:service).provide :launchd, :parent => :base do
 
 
   def stop
-    return ucommand(:stop) if resource[:stop]
+    if resource[:stop]
+      service_command(:stop)
+      return nil
+    end
     job_path, _ = plist_from_label(resource[:name])
     did_disable_job = false
     cmds = []

data/lib/puppet/provider/service/service.rb

@@ -8,7 +8,8 @@ Puppet::Type.type(:service).provide :service do
   # How to restart the process.
   def restart
     if @resource[:restart] or restartcmd
-      ucommand(:restart)
+      service_command(:restart)
+      nil
     else
       self.stop
       self.start
@@ -19,7 +20,7 @@ Puppet::Type.type(:service).provide :service do
   def restartcmd
   end
 
-  # A simple wrapper so execution failures are a bit more informative.
+  # @deprecated because the exit status is not returned, use service_execute instead
   def texecute(type, command, fof = true, squelch = false, combine = true)
     begin
       execute(command, :failonfail => fof, :override_locale => false, :squelch => squelch, :combine => combine)
@@ -29,7 +30,7 @@ Puppet::Type.type(:service).provide :service do
     nil
   end
 
-  # Use either a specified command or the default for our provider.
+  # @deprecated because the exitstatus is not returned, use service_command instead
   def ucommand(type, fof = true)
     c = @resource[type]
     if c
@@ -39,5 +40,29 @@ Puppet::Type.type(:service).provide :service do
     end
     texecute(type, cmd, fof)
   end
+
+  # Execute a command, failing the resource if the command fails.
+  #
+  # @return [Puppet::Util::Execution::ProcessOutput]
+  def service_execute(type, command, fof = true, squelch = false, combine = true)
+    begin
+      execute(command, :failonfail => fof, :override_locale => false, :squelch => squelch, :combine => combine)
+    rescue Puppet::ExecutionFailure => detail
+      @resource.fail Puppet::Error, "Could not #{type} #{@resource.ref}: #{detail}", detail
+    end
+  end
+
+  # Use either a specified command or the default for our provider.
+  #
+  # @return [Puppet::Util::Execution::ProcessOutput]
+  def service_command(type, fof = true)
+    c = @resource[type]
+    if c
+      cmd = [c]
+    else
+      cmd = [send("#{type}cmd")].flatten
+    end
+    service_execute(type, cmd, fof)
+  end
 end
 

data/lib/puppet/provider/service/smf.rb

@@ -77,30 +77,6 @@ Puppet::Type.type(:service).provide :smf, :parent => :base do
     raise Puppet::Error.new( "Cannot config #{@resource[:name]} to enable it: #{detail}", detail )
   end
 
-  # Returns the service's FMRI. We fail if multiple FMRIs correspond to
-  # @resource[:name].
-  #
-  # If the service does not exist or we fail to get any FMRIs from svcs,
-  # this method will raise a Puppet::ExecutionFailure
-  def service_fmri
-    return @fmri if @fmri
-
-    # `svcs -l` is better to use because we can detect service instances
-    # that have not yet been activated or enabled (i.e. it lets us detect
-    # services that svcadm has not yet touched). `svcs -H -o fmri` is a bit
-    # more limited.
-    lines = svcs("-l", @resource[:name]).chomp.lines.to_a
-    lines.select! { |line| line =~ /^fmri/ }
-    fmris = lines.map! { |line| line.split(' ')[-1].chomp }
-    unless fmris.length == 1
-      raise Puppet::Error.new(
-        "Failed to get #{@resource[:name]}'s FMRI: The pattern '#{@resource[:name]}' matches multiple FMRIs! These are the FMRIs it matches: #{fmris.join(', ')}"
-      )
-    end
-
-    @fmri = fmris.first
-  end
-
   # Returns the service's FMRI. We fail if multiple FMRIs correspond to
   # @resource[:name].
   #

data/lib/puppet/provider/service/src.rb

@@ -53,8 +53,8 @@ Puppet::Type.type(:service).provide :src, :parent => :base do
   end
 
   def enabled?
-    execute([command(:lsitab), @resource[:name]], {:failonfail => false, :combine => true})
-    $CHILD_STATUS.exitstatus == 0 ? :true : :false
+    output = execute([command(:lsitab), @resource[:name]], {:failonfail => false, :combine => true})
+    output.exitstatus == 0 ? :true : :false
   end
 
   def enable

data/lib/puppet/provider/service/systemd.rb

@@ -1,6 +1,6 @@
 # Manage systemd services using systemctl
 
-require 'puppet/file_system'
+require_relative '../../../puppet/file_system'
 
 Puppet::Type.type(:service).provide :systemd, :parent => :base do
   desc "Manages `systemd` services using `systemctl`.
@@ -30,7 +30,7 @@ Puppet::Type.type(:service).provide :systemd, :parent => :base do
   def self.instances
     i = []
     output = systemctl('list-unit-files', '--type', 'service', '--full', '--all',  '--no-pager')
-    output.scan(/^(\S+)\s+(disabled|enabled|masked|indirect|bad|static)\s*$/i).each do |m|
+    output.scan(/^(\S+)\s+(disabled|enabled|masked|indirect|bad|static)\s*([^-]\S+)?\s*$/i).each do |m|
       Puppet.debug("#{m[0]} marked as bad by `systemctl`. It is recommended to be further checked.") if m[1] == "bad"
       i << new(:name => m[0])
     end
@@ -45,8 +45,13 @@ Puppet::Type.type(:service).provide :systemd, :parent => :base do
   def enabled_insync?(current)
     case cached_enabled?[:output]
     when 'static'
-      Puppet.debug("Unable to enable or disable static service #{@resource[:name]}")
-      return true
+      # masking static services is OK, but enabling/disabling them is not
+      if @resource[:enable] == :mask
+        current == @resource[:enable]
+      else
+        Puppet.debug("Unable to enable or disable static service #{@resource[:name]}")
+        return true
+      end
     when 'indirect'
       Puppet.debug("Service #{@resource[:name]} is in 'indirect' state and cannot be enabled/disabled")
       return true
@@ -119,10 +124,10 @@ Puppet::Type.type(:service).provide :systemd, :parent => :base do
   # whether it is enabled or not. See PUP-5016 for more details.
   #
   def debian_enabled?
-    system("/usr/sbin/invoke-rc.d", "--quiet", "--query", @resource[:name], "start")
-    if [104, 106].include?($CHILD_STATUS.exitstatus)
+    status = execute(["/usr/sbin/invoke-rc.d", "--quiet", "--query", @resource[:name], "start"], :failonfail => false)
+    if [104, 106].include?(status.exitstatus)
       return :true
-    elsif [101, 105].include?($CHILD_STATUS.exitstatus)
+    elsif [101, 105].include?(status.exitstatus)
       # 101 is action not allowed, which means we have to do the check manually.
       # 105 is unknown, which generally means the initscript does not support query
       # The debian policy states that the initscript should support methods of query
@@ -159,10 +164,15 @@ Puppet::Type.type(:service).provide :systemd, :parent => :base do
   end
 
   def mask
-    self.disable
+    disable if exist?
     systemctl_change_enable(:mask)
   end
 
+  def exist?
+    result = execute([command(:systemctl), 'cat', '--', @resource[:name]], :failonfail => false)
+    result.exitstatus == 0
+  end
+
   def unmask
     systemctl_change_enable(:unmask)
   end

data/lib/puppet/provider/service/windows.rb

@@ -128,17 +128,55 @@ Puppet::Type.type(:service).provide :windows, :parent => :service do
     services
   end
 
+  def logonaccount_insync?(current)
+    @normalized_logon_account ||= normalize_logonaccount
+    @resource[:logonaccount] = @normalized_logon_account
+
+    insync = @resource[:logonaccount] == current
+    self.logonpassword = @resource[:logonpassword] if insync
+    insync
+  end
+
   def logonaccount
     return unless Puppet::Util::Windows::Service.exists?(@resource[:name])
     Puppet::Util::Windows::Service.logon_account(@resource[:name])
   end
 
   def logonaccount=(value)
+    validate_logon_credentials
     Puppet::Util::Windows::Service.set_startup_configuration(@resource[:name], options: {logon_account: value, logon_password: @resource[:logonpassword]})
     restart if @resource[:ensure] == :running && [:running, :paused].include?(status)
   end
 
   def logonpassword=(value)
+    validate_logon_credentials
     Puppet::Util::Windows::Service.set_startup_configuration(@resource[:name], options: {logon_password: value})
   end
+
+  private
+
+  def normalize_logonaccount
+    logon_account = @resource[:logonaccount].sub(/^\.\\/, "#{Puppet::Util::Windows::ADSI.computer_name}\\")
+    return 'LocalSystem' if Puppet::Util::Windows::User::localsystem?(logon_account)
+
+    @logonaccount_information ||= Puppet::Util::Windows::SID.name_to_principal(logon_account)
+    return logon_account unless @logonaccount_information
+    return ".\\#{@logonaccount_information.account}" if @logonaccount_information.domain == Puppet::Util::Windows::ADSI.computer_name
+    @logonaccount_information.domain_account
+  end
+
+  def validate_logon_credentials
+    unless Puppet::Util::Windows::User::localsystem?(@normalized_logon_account)
+      raise Puppet::Error.new("\"#{@normalized_logon_account}\" is not a valid account") unless @logonaccount_information && [:SidTypeUser, :SidTypeWellKnownGroup].include?(@logonaccount_information.account_type)
+
+      user_rights = Puppet::Util::Windows::User::get_rights(@logonaccount_information.domain_account) unless Puppet::Util::Windows::User::default_system_account?(@normalized_logon_account)
+      raise Puppet::Error.new("\"#{@normalized_logon_account}\" has the 'Log On As A Service' right set to denied.") if user_rights =~ /SeDenyServiceLogonRight/
+      raise Puppet::Error.new("\"#{@normalized_logon_account}\" is missing the 'Log On As A Service' right.") unless user_rights.nil? || user_rights =~ /SeServiceLogonRight/
+    end
+
+    is_a_predefined_local_account = Puppet::Util::Windows::User::default_system_account?(@normalized_logon_account) || @normalized_logon_account == 'LocalSystem'
+    account_info = @normalized_logon_account.split("\\")
+    able_to_logon = Puppet::Util::Windows::User.password_is?(account_info[1], @resource[:logonpassword], account_info[0]) unless is_a_predefined_local_account
+    raise Puppet::Error.new("The given password is invalid for user '#{@normalized_logon_account}'.") unless is_a_predefined_local_account || able_to_logon
+  end
 end

data/lib/puppet/provider/user/aix.rb

@@ -9,8 +9,8 @@
 #
 # See https://puppet.com/docs/puppet/latest/provider_development.html
 # for more information
-require 'puppet/provider/aix_object'
-require 'puppet/util/posix'
+require_relative '../../../puppet/provider/aix_object'
+require_relative '../../../puppet/util/posix'
 require 'tempfile'
 require 'date'
 

data/lib/puppet/provider/user/directoryservice.rb

@@ -1,5 +1,5 @@
-require 'puppet'
-require 'puppet/util/plist' if Puppet.features.cfpropertylist?
+require_relative '../../../puppet'
+require_relative '../../../puppet/util/plist' if Puppet.features.cfpropertylist?
 require 'base64'
 
 Puppet::Type.type(:user).provide :directoryservice do
@@ -435,7 +435,7 @@ Puppet::Type.type(:user).provide :directoryservice do
   ['home', 'uid', 'gid', 'comment', 'shell'].each do |setter_method|
     define_method("#{setter_method}=") do |value|
       if @property_hash[setter_method.intern]
-        if self.class.get_os_version.split('.').last.to_i >= 14 && %w(home uid).include?(setter_method)
+        if %w(home uid).include?(setter_method)
           raise Puppet::Error, "OS X version #{self.class.get_os_version} does not allow changing #{setter_method} using puppet"
         end
         begin
@@ -536,6 +536,14 @@ Puppet::Type.type(:user).provide :directoryservice do
       if (shadow_hash_data.class == Hash) && (shadow_hash_data.has_key?('SALTED-SHA512'))
         shadow_hash_data.delete('SALTED-SHA512')
       end
+
+      # Starting with macOS 11 Big Sur, the AuthenticationAuthority field
+      # could be missing entirely and without it the managed user cannot log in
+      if needs_sha512_pbkdf2_authentication_authority_to_be_added?(users_plist)
+        Puppet.debug("Adding 'SALTED-SHA512-PBKDF2' AuthenticationAuthority key for ShadowHash to user '#{@resource.name}'")
+        merge_attribute_with_dscl('Users', @resource.name, 'AuthenticationAuthority', ERB::Util.html_escape(SHA512_PBKDF2_AUTHENTICATION_AUTHORITY))
+      end
+
       set_salted_pbkdf2(users_plist, shadow_hash_data, 'entropy', value)
     end
   end
@@ -562,6 +570,17 @@ Puppet::Type.type(:user).provide :directoryservice do
     end
   end
 
+  # This method will check if authentication_authority key of a user's plist
+  # needs SALTED_SHA512_PBKDF2 to be added. This is a valid case for macOS 11 (Big Sur)
+  # where users created with `dscl` started to have this field missing
+  def needs_sha512_pbkdf2_authentication_authority_to_be_added?(users_plist)
+    authority = users_plist['authentication_authority']
+    return false if Puppet::Util::Package.versioncmp(self.class.get_os_version, '11.0.0') < 0 && authority && authority.include?(SHA512_PBKDF2_AUTHENTICATION_AUTHORITY)
+
+    Puppet.debug("User '#{@resource.name}' is missing the 'SALTED-SHA512-PBKDF2' AuthenticationAuthority key for ShadowHash")
+    true
+  end
+
   # This method will embed the binary plist data comprising the user's
   # password hash (and Salt/Iterations value if the OS is 10.8 or greater)
   # into the ShadowHashData key of the user's plist.
@@ -572,11 +591,7 @@ Puppet::Type.type(:user).provide :directoryservice do
     else
       users_plist['ShadowHashData'] = [binary_plist]
     end
-    if Puppet::Util::Package.versioncmp(self.class.get_os_version, '10.15') < 0
-      write_users_plist_to_disk(users_plist)
-    else
-      write_and_import_shadow_hash_data(users_plist['ShadowHashData'].first)
-    end
+    write_and_import_shadow_hash_data(users_plist['ShadowHashData'].first)
   end
 
   # This method writes the ShadowHashData plist in a temporary file,
@@ -652,9 +667,7 @@ Puppet::Type.type(:user).provide :directoryservice do
     set_shadow_hash_data(users_plist, binary_plist)
   end
 
-  # This method will accept a plist in XML format, save it to disk, convert
-  # the plist to a binary format, and flush the dscl cache.
-  def write_users_plist_to_disk(users_plist)
-    Puppet::Util::Plist.write_plist_file(users_plist, "#{users_plist_dir}/#{@resource.name}.plist", :binary)
-  end
+  private
+
+  SHA512_PBKDF2_AUTHENTICATION_AUTHORITY = ';ShadowHash;HASHLIST:<SALTED-SHA512-PBKDF2,SRP-RFC5054-4096-SHA512-PBKDF2>'
 end

data/lib/puppet/provider/user/ldap.rb

@@ -1,4 +1,4 @@
-require 'puppet/provider/ldap'
+require_relative '../../../puppet/provider/ldap'
 
 Puppet::Type.type(:user).provide :ldap, :parent => Puppet::Provider::Ldap do
   desc "User management via LDAP.