manageiq-ssh-util 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 58c774eec4755352ba4daf38939f8ab0d35ea8bd110eb34d7b772d0fdbecb574
+  data.tar.gz: b5ed3ef9f3c97ff0a998816db02442f44a98f6d648444138b5ad0f3759731763
+SHA512:
+  metadata.gz: af4a43b882154267c45a17c797c024f21aa75c6cd15316778e1d84bd159dc3dafffabfe8eca047efa1041b04b1c35479d7f114885b277533721efb1417202107
+  data.tar.gz: 360b674b19f26b8438d6d2d8857413ac189ef93c1e0cd3b86bc18f408d4bc1627f462667339c96fa59e5a9ce9c1cec7377634b14aefd44a492294fbb187ef057

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,17 @@
+manageiq-ssh-util
+
+The manageiq-ssh-util library is a wrapper library around net-ssh. Its
+main benefit is that it automatically handles channels and logging for
+various states when running remote commands. It also automatically handles
+terminal passwords and running commands via sudo, as well as automatic
+retry for host key mismatches.
+
+Some differences with the original MiqSshUtil library include:
+
+* The name has been changed and scoped under the ManageIQ namespace.
+* The ability to override the default value for the :use_agent option.
+* Bug fixes for the on_extended_data ssh channel.
+
+For details of the original bugs (and fixes) please see https://github.com/ManageIQ/manageiq-gems-pending/pull/437.
+
+The remaining differences are internal refactoring updates.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new('spec')
+task :test => :spec
+task :default => :spec

data/lib/manageiq-ssh-util.rb

@@ -0,0 +1 @@
+require "manageiq/ssh/util"

data/lib/manageiq/ssh/util.rb

@@ -0,0 +1,432 @@
+require 'net/ssh'
+require 'net/sftp'
+require 'tempfile'
+require 'active_support/core_ext/object/blank'
+
+module ManageIQ
+  class SSH
+    # Utility wrapper around the net-ssh library.
+    class Util
+      # The exit status of the ssh command.
+      attr_reader :status
+
+      # The name of the host provided to the constructor.
+      attr_reader :host
+
+      # The options hash passed to the constructor.
+      attr_reader :options
+
+      # The username passed to the constructor.
+      attr_reader :user
+
+      # Create and return a ManageIQ::SSH::Util object. A host, user and
+      # password must be specified.
+      #
+      # The +options+ param may contain options that are passed directly
+      # to the Net::SSH constructor. By default the :non_interactive option is
+      # set to true (meaning it will fail instead of prompting for a password),
+      # the :verbose level is set to :warn, and the :use_agent option is
+      # set to false.
+      #
+      # The :logger option is not set by default. If you do set it, you should
+      # NOT use an existing logger, but instead use a separate custom log.
+      # If the log already exists, then the option is effectively ignored. Some
+      # additional logging will be written to the global ManageIQ log in
+      # debug mode.
+      #
+      # The following local options are also supported:
+      #
+      # :passwordless_sudo - If set to true, then it is assumed that the sudo
+      # command does not require a password, and 'sudo' will automatically be
+      # prepended to your command. For sudo that requires a password, set
+      # the :su_user and :su_password options instead.
+      #
+      # :remember_host - Setting this to true will cause a HostKeyMismatch
+      # error to be rescued and retried once after recording the host and
+      # key in the known hosts file. By default this is false.
+      #
+      # :su_user - If set, ssh commands for that object will be executed via
+      # sudo. Do not use if :passwordless_sudo is set to true.
+      #
+      # :su_password - When used in conjunction with :su_user, the password sent
+      # to the command prompt when asked for as the result of using the su
+      # command. Do not use if :passwordless_sudo is set to true.
+      #
+      def initialize(host, user, password = nil, options = {})
+        @host     = host
+        @user     = user
+        @password = password
+
+        @options  = {
+          :remember_host   => false,
+          :verbose         => :warn,
+          :non_interactive => true,
+          :use_agent       => false
+        }.merge(options)
+
+        options[:password] = password if password
+
+        # Pull our custom keys out of the hash because the SSH initializer will complain
+        @remember_host     = @options.delete(:remember_host)
+        @su_user           = @options.delete(:su_user)
+        @su_password       = @options.delete(:su_password)
+        @passwordless_sudo = @options.delete(:passwordless_sudo)
+
+        # Obsolete, delete if passed in
+        @options.delete(:authentication_prompt_delay)
+      end
+
+      # Returns a boolean value indicating whether or not the +remember_host+
+      # option is set. This tells Net::SSH to record the host and key in the
+      # known hosts file, so that subsequent connections will remember them.
+      #
+      def remember_host?
+        !!@remember_host
+      end
+
+      # Download the contents of the remote +from+ file to the local +to+ file. Some
+      # messages will be written to the global ManageIQ log in debug mode.
+      #
+      # Note that the returned data is normally a Net::SFTP::Operations::Download
+      # object. If you want to store the file contents in memory, pass an IO object
+      # as the second argument.
+      #
+      def get_file(from, to)
+        run_session do |ssh|
+          $log&.debug("#{self.class}##{__method__} - Copying file #{host}:#{from} to #{to}.")
+          data = ssh.sftp.download!(from, to)
+          $log&.debug("#{self.class}##{__method__} - Copying of #{host}:#{from} to #{to}, complete.")
+          return data
+        end
+      end
+
+      # Upload the contents of local file +to+ to remote location +path+. You may
+      # use the specified +content+ instead of the content of the local file.
+      #
+      # At least one of the +content+ or +path+ parameters must be specified or
+      # an error is raised.
+      #
+      def put_file(to, content = nil, path = nil)
+        raise ArgumentError, "Need to provide either content or path" if content.nil? && path.nil?
+        run_session do |ssh|
+          content ||= IO.binread(path)
+          $log&.debug("#{self.class}##{__method__} - Copying file to #{@host}:#{to}.")
+          ssh.sftp.file.open(to, 'wb') { |f| f.write(content) }
+          $log&.debug("#{self.class}##{__method__} - Copying of file to #{@host}:#{to}, complete.")
+        end
+      end
+
+      # Execute the remote +cmd+ via ssh. This is automatically handled via
+      # channels on the ssh session so that various states can be checked,
+      # stored and logged independently and asynchronously.
+      #
+      # If the :passwordless_sudo option was set to true in the constructor
+      # then the +cmd+ will automatically be prepended with "sudo".
+      #
+      # If specified, the data collection will stop the first time a +done_string+
+      # argument is encountered at the end of a line. In practice you would
+      # typically specify a newline character.
+      #
+      # If present, the +stdin+ argument will be sent to the underlying
+      # command as input for those commands that expect it, e.g. tee.
+      #
+      # If a signal is received, the command returns any sort of non-zero
+      # error status, or if any stderr output is encountered then an exception
+      # is raised.
+      #
+      def exec(cmd, done_string = nil, stdin = nil)
+        error_buffer = ""
+        output_buffer = ""
+        status = 0
+        signal = nil
+        header = "#{self.class}##{__method__}"
+
+        # If passwordless sudo is true then prepend every command with 'sudo'.
+        cmd = 'sudo ' + cmd if @passwordless_sudo
+
+        run_session do |ssh|
+          ssh.open_channel do |channel|
+            channel.exec(cmd) do |chan, success|
+              raise "#{header} - Could not execute command #{cmd}" unless success
+
+              $log&.debug("#{header} - Command: #{cmd} started.")
+
+              if stdin.present?
+                chan.send_data(stdin)
+                chan.eof!
+              end
+
+              channel.on_data do |_channel, data|
+                $log&.debug("#{header} - STDOUT: #{data}")
+                output_buffer << data
+                data.each_line { |l| return output_buffer if done_string == l.chomp } unless done_string.nil?
+              end
+
+              channel.on_extended_data do |_channel, _type, data|
+                $log&.debug("#{header} - STDERR: #{data}")
+                error_buffer << data
+              end
+
+              channel.on_request('exit-status') do |_channel, data|
+                status = data.read_long || 0
+                $log&.debug("#{header} - STATUS: #{status}")
+              end
+
+              channel.on_request('exit-signal') do |_channel, data|
+                signal = data.read_string
+                $log&.debug("#{header} - SIGNAL: #{signal}")
+              end
+
+              channel.on_eof do |_channel|
+                $log&.debug("#{header} - EOF RECEIVED")
+              end
+
+              channel.on_close do |_channel|
+                $log&.debug("#{header} - Command: #{cmd}, exit status: #{status}")
+                if signal.present? || status.nonzero? || error_buffer.present?
+                  raise "#{header} - Command '#{cmd}' exited with signal #{signal}" if signal.present?
+                  raise "#{header} - Command '#{cmd}' exited with status #{status}" if status.nonzero?
+                  raise "#{header} - Command '#{cmd}' failed: #{error_buffer}"
+                end
+                return output_buffer
+              end
+            end # exec
+          end # open_channel
+          ssh.loop
+        end # run_session
+      end
+
+      # Execute the remote +cmd+ via ssh. This is nearly identical to the exec
+      # method, and is used only if the :su_user and :su_password options are
+      # set in the constructor.
+      #
+      # The difference between this method and the exec method are primarily in
+      # the underlying handling of the sudo user and sudo password parameters, i.e
+      # creating a PTY session and dealing with prompts. From the perspective of
+      # an end user they are essentially identical.
+      #
+      def suexec(cmd_str, done_string = nil, stdin = nil)
+        error_buffer = ""
+        output_buffer = ""
+        prompt = ""
+        cmd_rx = ""
+        status = 0
+        signal = nil
+        state  = :initial
+        header = "#{self.class}##{__method__}"
+
+        run_session do |ssh|
+          temp_cmd_file(cmd_str) do |cmd|
+            ssh.open_channel do |channel|
+              # now we request a "pty" (i.e. interactive) session so we can send data back and forth if needed.
+              # it WILL NOT WORK without this, and it has to be done before any call to exec.
+              channel.request_pty(:chars_wide => 256) do |_channel, success|
+                raise "Could not obtain pty (i.e. an interactive ssh session)" unless success
+              end
+
+              channel.on_data do |channel, data|
+                $log&.debug("#{header} - state: [#{state.inspect}] STDOUT: [#{data.hex_dump.chomp}]")
+                if state == :prompt
+                  # Detect the common prompts
+                  # someuser@somehost ... $  rootuser@somehost ... #  [someuser@somehost ...] $  [rootuser@somehost ...] #
+                  prompt = data if data =~ /^\[*[\w\-\.]+@[\w\-\.]+.+\]*[\#\$]\s*$/
+                  output_buffer << data
+                  unless done_string.nil?
+                    data.each_line { |l| return output_buffer if done_string == l.chomp }
+                  end
+
+                  if output_buffer[-prompt.length, prompt.length] == prompt
+                    return output_buffer[0..(output_buffer.length - prompt.length)]
+                  end
+                end
+
+                if state == :command_sent
+                  cmd_rx << data
+                  state = :prompt if cmd_rx == "#{cmd}\r\n"
+                end
+
+                if state == :password_sent
+                  prompt << data.lstrip
+                  if data.strip =~ /\#/
+                    $log&.debug("#{header} - Superuser Prompt detected: sending command #{cmd}")
+                    channel.send_data("#{cmd}\n")
+                    state = :command_sent
+                  end
+                end
+
+                if state == :initial
+                  prompt << data.lstrip
+                  if data.strip =~ /[Pp]assword:/
+                    prompt = ""
+                    $log&.debug("#{header} - Password Prompt detected: sending su password")
+                    channel.send_data("#{@su_password}\n")
+                    state = :password_sent
+                  end
+                end
+              end
+
+              channel.on_extended_data do |_channel, _type, data|
+                $log&.debug("#{header} - STDERR: #{data}")
+                error_buffer << data
+              end
+
+              channel.on_request('exit-status') do |_channel, data|
+                status = data.read_long
+                $log&.debug("#{header} - STATUS: #{status}")
+              end
+
+              channel.on_request('exit-signal') do |_channel, data|
+                signal = data.read_string
+                $log&.debug("#{header} - SIGNAL: #{signal}")
+              end
+
+              channel.on_eof do |_channel|
+                $log&.debug("#{header} - EOF RECEIVED")
+              end
+
+              channel.on_close do |_channel|
+                error_buffer << prompt if [:initial, :password_sent].include?(state)
+                $log&.debug("#{header} - Command: #{cmd}, exit status: #{status}")
+                raise "#{header} - Command #{cmd}, exited with signal #{signal}" unless signal.nil?
+                unless status.zero?
+                  raise "#{header} - Command #{cmd}, exited with status #{status}" if error_buffer.empty?
+                  raise "#{header} - Command #{cmd} failed: #{error_buffer}, status: #{status}"
+                end
+                return output_buffer
+              end
+
+              $log&.debug("#{header} - Command: [#{cmd_str}] started.")
+              su_command = @su_user == 'root' ? "su -l\n" : "su -l #{@su_user}\n"
+
+              channel.exec(su_command) do |chan, success|
+                raise "#{header} - Could not execute command #{cmd}" unless success
+                if stdin.present?
+                  chan.send_data(stdin)
+                  chan.eof!
+                end
+              end
+            end
+          end
+          ssh.loop
+        end
+      end
+
+      # Creates a local temporary file under /var/tmp with +cmd+ as its contents.
+      # The tempfile name is the name of the command with "miq-" prepended and ".sh"
+      # appended to the end.
+      #
+      # The end result is a string meant to be run via the suexec method. For example:
+      #
+      # "chmod 700 /var/tmp/miq-foo.sh; /var/tmp/miq-foo.sh; rm -f /var/tmp/miq-foo.sh
+      #
+      def temp_cmd_file(cmd)
+        temp_remote_script = Tempfile.new(["miq-", ".sh"], "/var/tmp")
+        temp_file          = temp_remote_script.path
+        begin
+          temp_remote_script.write(cmd)
+          temp_remote_script.close
+          remote_cmd = "chmod 700 #{temp_file}; #{temp_file}; rm -f #{temp_file}"
+          yield(remote_cmd)
+        ensure
+          temp_remote_script.close!
+        end
+      end
+
+      # Shortcut method that creates and yields a ManageIQ::SSH::Util object, with the +host+,
+      # +remote_user+ and +remote_password+ options passed in as the first three
+      # params to the constructor, while the +su_user+ and +su_password+ parameters
+      # automatically set the corresponding :su_user and :su_password options. The
+      # remaining options are passed normally.
+      #
+      # This method is functionally identical to the following code, except that it
+      # yields itself (and nil) and re-raises certain Net::SSH exceptions as
+      # ManageIQ exceptions.
+      #
+      #   ManageIQ::SSH::Util.new(host, remote_user, remote_password, {:su_user => su_user, :su_password => su_password})
+      #
+      def self.shell_with_su(host, remote_user, remote_password, su_user, su_password, options = {})
+        options[:su_user], options[:su_password] = su_user, su_password
+        ssu = new(host, remote_user, remote_password, options)
+        yield(ssu, nil)
+      rescue Net::SSH::AuthenticationFailed
+        raise MiqException::MiqInvalidCredentialsError
+      rescue Net::SSH::HostKeyMismatch
+        raise MiqException::MiqSshUtilHostKeyMismatch
+      end
+
+      # Executes the provided +cmd+ using the exec or suexec method, depending on
+      # whether or not the :su_user option is set. The +done_string+ and +stdin+
+      # arguments are passed along to the appropriate method as well.
+      #
+      # In the case of suexec, escape characters are automatically removed from
+      # the final output.
+      #
+      #--
+      # The _shell argument appears to be an artifact that has been retained
+      # over time for reasons that aren't immediately apparent.
+      #
+      def shell_exec(cmd, done_string = nil, _shell = nil, stdin = nil)
+        return exec(cmd, done_string, stdin) if @su_user.nil?
+        ret = suexec(cmd, done_string, stdin)
+        # Remove escape character from the end of the line
+        ret.sub!(/\e$/, '')
+        ret
+      end
+
+      # Copies the remote +file_path+ to a local temporary file, and then
+      # yields or returns a filehandle to the local temporary file.
+      #--
+      # Presumably this method was meant for use with the SCVMM provider
+      # given the hardcoded name of the temporary file.
+      #
+      def file_open(file_path, perm = 'r')
+        if block_given?
+          Tempfile.open('miqscvmm') do |tf|
+            tf.close
+            get_file(file_path, tf.path)
+            File.open(tf.path, perm) { |f| yield(f) }
+          end
+        else
+          tf = Tempfile.open('miqscvmm')
+          tf.close
+          get_file(file_path, tf.path)
+          File.open(tf.path, perm)
+        end
+      end
+
+      # Returns whether or not the remote +filename+ exists.
+      #
+      def file_exists?(filename)
+        shell_exec("test -f #{filename}")
+      rescue
+        false
+      else
+        true
+      end
+
+      # This method creates and yields an ssh object. If the :remember_host option
+      # was set to true, it will record this host and key in the known hosts file
+      # and retry once.
+      #
+      def run_session
+        first_try = true
+
+        begin
+          Net::SSH.start(@host, @user, @options) do |ssh|
+            yield(ssh)
+          end
+        rescue Net::SSH::HostKeyMismatch => err
+          if remember_host? && first_try
+            # Save fingerprint and try again
+            first_try = false
+            err.remember_host!
+            retry
+          else
+            # Re-raise error
+            raise err
+          end
+        end
+      end
+    end # Util
+  end # SSH
+end # ManageIQ

data/lib/manageiq/ssh/util/version.rb

@@ -0,0 +1,8 @@
+module ManageIQ
+  class SSH
+    class Util
+      # The version of the manageiq-ssh-util library
+      VERSION = '0.1.0'.freeze
+    end
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: manageiq-ssh-util
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ManageIQ Developers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ManageIQ wrapper library for net-ssh
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/manageiq-ssh-util.rb
+- lib/manageiq/ssh/util.rb
+- lib/manageiq/ssh/util/version.rb
+homepage: https://github.com/ManageIQ/manageiq-ssh-util
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: ManageIQ wrapper library for net-ssh
+test_files: []