mixlib-shellout 3.1.7 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06626b906743fd932b0921f90d24e9aeee3c51fbdecfec571ee9547e1ac701ef
-  data.tar.gz: c2255e8cf8b72ad727fb076e2eafafef51cdf7b0f17fef0d0e526424dc986c25
+  metadata.gz: 82102f99cbf59a6ec48f6b7685e470ecd94bc629e27ae83b36a3eaa7e02ace33
+  data.tar.gz: 83d3a8aeb7bf139a209440bc8877b63f524b7d30c783b99af2c7406d237618ef
 SHA512:
-  metadata.gz: a8bbe1757af6c210b789decff30f35126ae1348481461a3b05eac662a295ec849fe293ede7d361b0598d04799e10e8aea89e18eea048de03a303b0a077d2b471
-  data.tar.gz: 0f5cce16bfa678c486ee46ee1c84f218507825070ef86a3eb8a6498d3b98277982ea9c457e10a8cde131969e5cdf1251b02fa16f36cecc6afdfcc835b72fd2c2
+  metadata.gz: 201ec59f8e4dd8f20443e9d78f880037cd65f91a890321647d95347d29bf478968554548efc311d2a1da82ae3a7c00220cb27021c13d21c8b2ecc28bdfbd20cc
+  data.tar.gz: 3c1caed9698c8820fb70b2245b134e303fcb55343323ea1c51350d625ceeee5f9c3ec8a68d5f81355aafad3c30d89a244316576b674a13eb922f7b0d8fb10948

data/lib/mixlib/shellout.rb

@@ -248,7 +248,7 @@ module Mixlib
     # running or died without setting an exit status (e.g., terminated by
     # `kill -9`).
     def exitstatus
-      @status&.exitstatus
+      @status && @status.exitstatus
     end
 
     # Run the command, writing the command's standard out and standard error

data/lib/mixlib/shellout/helper.rb

@@ -157,7 +157,7 @@ module Mixlib
       end
 
       def __io_for_live_stream
-        if !STDOUT.closed? && __log.trace?
+        if STDOUT.tty? && !__config[:daemon] && __log.debug?
           STDOUT
         else
           nil

data/lib/mixlib/shellout/unix.rb

@@ -370,11 +370,11 @@ module Mixlib
         return if attempt_reap
 
         @terminate_reason = "Command exceeded allowed execution time, process terminated"
-        logger&.error("Command exceeded allowed execution time, sending TERM")
+        logger.error("Command exceeded allowed execution time, sending TERM") if logger
         Process.kill(:TERM, child_pgid)
         sleep 3
         attempt_reap
-        logger&.error("Command exceeded allowed execution time, sending KILL")
+        logger.error("Command exceeded allowed execution time, sending KILL") if logger
         Process.kill(:KILL, child_pgid)
         reap
 

data/lib/mixlib/shellout/version.rb

@@ -1,5 +1,5 @@
 module Mixlib
   class ShellOut
-    VERSION = "3.1.7".freeze
+    VERSION = "3.2.0".freeze
   end
 end

data/lib/mixlib/shellout/windows.rb

@@ -89,7 +89,7 @@ module Mixlib
           # Start the process
           #
           process, profile, token = Process.create3(create_process_args)
-          logger&.debug(format_process(process, app_name, command_line, timeout))
+          logger.debug(format_process(process, app_name, command_line, timeout)) if logger
           begin
             # Start pushing data into input
             stdin_write << input if input
@@ -124,7 +124,7 @@ module Mixlib
                     kill_process_tree(process.process_id, wmi, logger)
                     Process.kill(:KILL, process.process_id)
                   rescue SystemCallError
-                    logger&.warn("Failed to kill timed out process #{process.process_id}")
+                    logger.warn("Failed to kill timed out process #{process.process_id}") if logger
                   end
 
                   raise Mixlib::ShellOut::CommandTimeout, [
@@ -398,16 +398,20 @@ module Mixlib
 
       def kill_process(instance, logger)
         child_pid = instance.wmi_ole_object.processid
-        logger&.debug([
+        if logger
+          logger.debug([
             "killing child process #{child_pid}::",
             "#{instance.wmi_ole_object.Name} of parent #{pid}",
           ].join)
+        end
         Process.kill(:KILL, instance.wmi_ole_object.processid)
       rescue SystemCallError
-        logger&.debug([
+        if logger
+          logger.debug([
             "Failed to kill child process #{child_pid}::",
             "#{instance.wmi_ole_object.Name} of parent #{pid}",
           ].join)
+        end
       end
 
       def format_process(process, app_name, command_line, timeout)

data/lib/mixlib/shellout/windows/core_ext.rb

@@ -18,9 +18,11 @@
 #
 
 require "win32/process"
+require "ffi/win32/extensions"
 
 # Add new constants for Logon
 module Process::Constants
+  private
 
   LOGON32_LOGON_INTERACTIVE = 0x00000002
   LOGON32_LOGON_BATCH = 0x00000004
@@ -44,6 +46,8 @@ module Process::Constants
   WIN32_PROFILETYPE_PT_MANDATORY           = 0x04
   WIN32_PROFILETYPE_PT_ROAMING_PREEXISTING = 0x08
 
+  # The environment block list ends with two nulls (\0\0).
+  ENVIRONMENT_BLOCK_ENDS = "\0\0".freeze
 end
 
 # Structs required for data handling
@@ -77,6 +81,12 @@ module Process::Functions
   attach_pfunc :UnloadUserProfile,
     %i{handle handle}, :bool
 
+  attach_pfunc :CreateEnvironmentBlock,
+    %i{pointer ulong bool}, :bool
+
+  attach_pfunc :DestroyEnvironmentBlock,
+    %i{pointer}, :bool
+
   ffi_lib :advapi32
 
   attach_pfunc :LogonUserW,
@@ -147,13 +157,15 @@ module Process
       si_hash = {}
 
       # If the startup_info key is present, validate its subkeys
-      hash["startup_info"]&.each do |key, val|
-        key = key.to_s.downcase
-        unless valid_si_keys.include?(key)
-          raise ArgumentError, "invalid startup_info key '#{key}'"
-        end
+      if hash["startup_info"]
+        hash["startup_info"].each do |key, val|
+          key = key.to_s.downcase
+          unless valid_si_keys.include?(key)
+            raise ArgumentError, "invalid startup_info key '#{key}'"
+          end
 
-        si_hash[key] = val
+          si_hash[key] = val
+        end
       end
 
       # The +command_line+ key is mandatory unless the +app_name+ key
@@ -169,9 +181,25 @@ module Process
 
       env = nil
 
+      # Retrieve the environment variables for the specified user.
+      if hash["with_logon"]
+        logon, passwd, domain = format_creds_from_hash(hash)
+        logon_type = hash["elevated"] ? LOGON32_LOGON_BATCH : LOGON32_LOGON_INTERACTIVE
+        token = logon_user(logon, domain, passwd, logon_type)
+        logon_ptr = FFI::MemoryPointer.from_string(logon)
+        profile = PROFILEINFO.new.tap do |dat|
+          dat[:dwSize]     = dat.size
+          dat[:dwFlags]    = 1
+          dat[:lpUserName] = logon_ptr
+        end
+
+        load_user_profile(token, profile.pointer)
+        env_list = retrieve_environment_variables(token)
+      end
+
       # The env string should be passed as a string of ';' separated paths.
       if hash["environment"]
-        env = hash["environment"]
+        env = env_list.nil? ? hash["environment"] : merge_env_variables(env_list, hash["environment"])
 
         unless env.respond_to?(:join)
           env = hash["environment"].split(File::PATH_SEPARATOR)
@@ -393,6 +421,33 @@ module Process
       true
     end
 
+    # Retrieves the environment variables for the specified user.
+    #
+    # @param env_pointer [Pointer] The environment block is an array of null-terminated Unicode strings.
+    # @param token [Integer] User token handle.
+    # @return [Boolean] true if successfully retrieves the environment variables for the specified user.
+    #
+    def create_environment_block(env_pointer, token)
+      unless CreateEnvironmentBlock(env_pointer, token, false)
+        raise SystemCallError.new("CreateEnvironmentBlock", FFI.errno)
+      end
+
+      true
+    end
+
+    # Frees environment variables created by the CreateEnvironmentBlock function.
+    #
+    # @param env_pointer [Pointer] The environment block is an array of null-terminated Unicode strings.
+    # @return [Boolean] true if successfully frees environment variables created by the CreateEnvironmentBlock function.
+    #
+    def destroy_environment_block(env_pointer)
+      unless DestroyEnvironmentBlock(env_pointer)
+        raise SystemCallError.new("DestroyEnvironmentBlock", FFI.errno)
+      end
+
+      true
+    end
+
     def create_process_as_user(token, app, cmd, process_security,
       thread_security, inherit, creation_flags, env, cwd, startinfo, procinfo)
 
@@ -527,5 +582,51 @@ module Process
       [ logon, passwd, domain ]
     end
 
+    # Retrieves the environment variables for the specified user.
+    #
+    # @param token [Integer] User token handle.
+    # @return env_list [Array<String>] Environment variables of specified user.
+    #
+    def retrieve_environment_variables(token)
+      env_list = []
+      env_pointer = FFI::MemoryPointer.new(:pointer)
+      create_environment_block(env_pointer, token)
+      str_ptr = env_pointer.read_pointer
+      offset = 0
+      loop do
+        new_str_pointer = str_ptr + offset
+        break if new_str_pointer.read_string(2) == ENVIRONMENT_BLOCK_ENDS
+
+        environment = new_str_pointer.read_wstring
+        env_list << environment
+        offset = offset + environment.length * 2 + 2
+      end
+
+      # To free the buffer when we have finished with the environment block
+      destroy_environment_block(str_ptr)
+      env_list
+    end
+
+    # Merge environment variables of specified user and current environment variables.
+    #
+    # @param fetched_env [Array<String>] environment variables of specified user.
+    # @param current_env [Array<String>] current environment variables.
+    # @return [Array<String>] Merged environment variables.
+    #
+    def merge_env_variables(fetched_env, current_env)
+      env_hash_1 = environment_list_to_hash(fetched_env)
+      env_hash_2 = environment_list_to_hash(current_env)
+      merged_env = env_hash_2.merge(env_hash_1)
+      merged_env.map { |k, v| "#{k}=#{v}" }
+    end
+
+    # Convert an array to a hash.
+    #
+    # @param env_var [Array<String>] Environment variables.
+    # @return [Hash] Converted an array to hash.
+    #
+    def environment_list_to_hash(env_var)
+      Hash[ env_var.map { |pair| pair.split("=", 2) } ]
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mixlib-shellout
 version: !ruby/object:Gem::Version
-  version: 3.1.7
+  version: 3.2.0
 platform: ruby
 authors:
 - Chef Software Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-29 00:00:00.000000000 Z
+date: 2020-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef-utils