mixlib-shellout 3.1.2 → 3.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f11a7758041e86b3243966f06c35f8c5e104286cd9658465442a1f15fb1483ec
-  data.tar.gz: 6ccd66f875c30ecab220f933bb35019a43f30b463ca9febf05a9d176133ebe46
+  metadata.gz: 5225855dde6ade866e318af03d650332d97965ea4748b58c872a86e9f8105095
+  data.tar.gz: d4f96cee9731d0fa4c83e9bbfae7115a7e0398ac1f4a2a8ba889468a86776c69
 SHA512:
-  metadata.gz: 528a473db4dba8fe3d67add2d7c618d23b0926b02640a09d64b98c520180e0ea9259b790d65523ddc43d57b6d19f577838f59c89c99d3caf1cb380a5a23921ec
-  data.tar.gz: 73b5d26d33f68670128e4c4debb265d2f9bb3c7f73a5b04c88fda71ea7de1d6d5e6fdedea3b1be836921a5ec2ff0d9122cc29b70f5021c742a24fb3485c7d7b3
+  metadata.gz: 37baa3739c95552ac72de806cbfe02eeef2cc5d2d611c83e335029379dc7d45ffc33a60e0013fbe32bfd2d3d4cacd6b97741656047a08de086adfd7cd9b42f8d
+  data.tar.gz: dcb06b4e91e7c88128e393af4b4691c72dd4f738bc77d27a1fe0ac4cae6fe35609f8726ad560155ecf93fc80079e7e1e0dd9cafd8473a93e08a0b83298f24183

data/lib/mixlib/shellout.rb

@@ -1,6 +1,6 @@
 #--
 # Author:: Daniel DeLeo (<dan@chef.io>)
-# Copyright:: Copyright (c) 2010-2016 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,8 +16,8 @@
 # limitations under the License.
 #
 
-require "etc"
-require "tmpdir"
+require "etc" unless defined?(Etc)
+require "tmpdir" unless defined?(Dir.mktmpdir)
 require "fcntl"
 require_relative "shellout/exceptions"
 
@@ -122,7 +122,7 @@ module Mixlib
     # === Options:
     # If the last argument is a Hash, it is removed from the list of args passed
     # to exec and used as an options hash. The following options are available:
-    # * +user+: the user the commmand should run as. if an integer is given, it is
+    # * +user+: the user the command should run as. if an integer is given, it is
     #   used as a uid. A string is treated as a username and resolved to a uid
     #   with Etc.getpwnam
     # * +group+: the group the command should run as. works similarly to +user+
@@ -248,7 +248,7 @@ module Mixlib
     # running or died without setting an exit status (e.g., terminated by
     # `kill -9`).
     def exitstatus
-      @status && @status.exitstatus
+      @status&.exitstatus
     end
 
     # Run the command, writing the command's standard out and standard error

data/lib/mixlib/shellout/helper.rb

@@ -16,7 +16,7 @@
 # limitations under the License.
 
 require_relative "../shellout"
-require "chef-utils"
+require "chef-utils" unless defined?(ChefUtils)
 require "chef-utils/dsl/default_paths"
 require "chef-utils/internal"
 
@@ -30,7 +30,7 @@ module Mixlib
       # These APIs are considered public for use in ohai and chef (by cookbooks and plugins, etc)
       # but are considered private/experimental for now for the direct users of mixlib-shellout.
       #
-      # You can see an example of how to handle the "dependenecy injection" in the rspec unit test.
+      # You can see an example of how to handle the "dependency injection" in the rspec unit test.
       # That backend API is left deliberately undocumented for now and may not follow SemVer and may
       # break at any time (at least for the rest of 2020).
       #
@@ -157,7 +157,7 @@ module Mixlib
       end
 
       def __io_for_live_stream
-        if STDOUT.tty? && !__config[:daemon] && __log.debug?
+        if !STDOUT.closed? && __log.trace?
           STDOUT
         else
           nil

data/lib/mixlib/shellout/unix.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Daniel DeLeo (<dan@chef.io>)
-# Copyright:: Copyright (c) 2010-2016 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -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") if logger
+        logger&.error("Command exceeded allowed execution time, sending TERM")
         Process.kill(:TERM, child_pgid)
         sleep 3
         attempt_reap
-        logger.error("Command exceeded allowed execution time, sending KILL") if logger
+        logger&.error("Command exceeded allowed execution time, sending KILL")
         Process.kill(:KILL, child_pgid)
         reap
 

data/lib/mixlib/shellout/version.rb

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

data/lib/mixlib/shellout/windows.rb

@@ -2,7 +2,7 @@
 # Author:: Daniel DeLeo (<dan@chef.io>)
 # Author:: John Keiser (<jkeiser@chef.io>)
 # Author:: Ho-Sheng Hsiao (<hosh@chef.io>)
-# Copyright:: Copyright (c) 2011-2019, Chef Software Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -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)) if logger
+          logger&.debug(format_process(process, app_name, command_line, timeout))
           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}") if logger
+                    logger&.warn("Failed to kill timed out process #{process.process_id}")
                   end
 
                   raise Mixlib::ShellOut::CommandTimeout, [
@@ -208,7 +208,7 @@ module Mixlib
       # 4.  if the argument must be quoted by #1 and terminates in a sequence of backslashes then all the backlashes must themselves
       #     be backslash excaped (double the backslashes).
       # 5.  if an interior quote that must be escaped by #2 has a sequence of backslashes before it then all the backslashes must
-      #     themselves be backslash excaped along with the backslash ecape of the interior quote (double plus one backslashes).
+      #     themselves be backslash excaped along with the backslash escape of the interior quote (double plus one backslashes).
       #
       # And to restate.  We are constructing a string which will be parsed by the windows parser into arguments, and we want those
       # arguments to match the *args array we are passed here.  So call the windows parser operation A then we need to apply A^-1 to
@@ -398,20 +398,16 @@ module Mixlib
 
       def kill_process(instance, logger)
         child_pid = instance.wmi_ole_object.processid
-        if logger
-          logger.debug([
+        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
-        if logger
-          logger.debug([
+        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

@@ -1,7 +1,7 @@
-#--
+#
 # Author:: Daniel DeLeo (<dan@chef.io>)
 # Author:: John Keiser (<jkeiser@chef.io>)
-# Copyright:: Copyright (c) 2011-2016 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,10 +18,10 @@
 #
 
 require "win32/process"
+require "ffi/win32/extensions"
 
 # Add new constants for Logon
 module Process::Constants
-  private
 
   LOGON32_LOGON_INTERACTIVE = 0x00000002
   LOGON32_LOGON_BATCH = 0x00000004
@@ -45,6 +45,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
@@ -78,6 +80,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,
@@ -148,15 +156,13 @@ module Process
       si_hash = {}
 
       # If the startup_info key is present, validate its subkeys
-      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
+      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
       end
 
       # The +command_line+ key is mandatory unless the +app_name+ key
@@ -172,9 +178,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)
@@ -396,6 +418,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)
 
@@ -530,5 +579,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.2
+  version: 3.2.2
 platform: ruby
 authors:
 - Chef Software Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-23 00:00:00.000000000 Z
+date: 2020-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef-utils