train-core 2.0.8 → 2.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6296676d2fb3138e2e4e3f660e6bc9d871f10419318ba3344ca472c1eca7f0d2
-  data.tar.gz: 8c5d1f00ee0c1e4dffa9520c8c622cd5333716a90576d52dfc5856f2ce7bf6de
+  metadata.gz: 6428f10f1fcb461fff9d6a262ed8a8c643ca0aaf21cc60a0ddeff1573f4e3c0e
+  data.tar.gz: a1d8450b00960078fb2116ec40dd3f1e61a5976a4aa6aa14e4c0a3e73596f27b
 SHA512:
-  metadata.gz: 97150adffc1f18041eb3c1f7c77c439920674a2f1d40ef90b7720eeb808bc98709d4cd646af0fae949a47229703dc19988ac2ca54b21e1de5aeb2b71a873a4d1
-  data.tar.gz: '028b9286800362e7e945c6fa5d3efde308e5b917233e7e9367b00ba289e87902ac4a8ccfcb55bf6879d7548340a40156e0cf2a05035c139d86d216dd27bda036'
+  metadata.gz: 338cd5ee7abda4182c71c3132336b647ab5353d90934673fdf156577506167e109e557b6c139288b5dcc89476742a34eb692b95bfd99ad7159775f531f90c3ee
+  data.tar.gz: d15361a0bc4362272ea783c5198dea4ef6dbb5beb1a3878e04eb4484126f0b5daa2fdb0dbe725b5828da9cf48519f3d43730860a5a4e7de3ceaac7284b13f765

data/lib/train/transports/cisco_ios_connection.rb

@@ -0,0 +1,128 @@
+# encoding: utf-8
+
+class Train::Transports::SSH
+  class CiscoIOSConnection < BaseConnection
+    class BadEnablePassword < Train::TransportError; end
+
+    def initialize(options)
+      super(options)
+
+      # Extract options to avoid passing them in to `Net::SSH.start` later
+      @host = options.delete(:host)
+      @user = options.delete(:user)
+      @port = options.delete(:port)
+      @enable_password = options.delete(:enable_password)
+
+      # Use all options left that are not `nil` for `Net::SSH.start` later
+      @ssh_options = options.reject { |_key, value| value.nil? }
+
+      @prompt = /^\S+[>#]\r\n.*$/
+    end
+
+    def uri
+      "ssh://#{@user}@#{@host}:#{@port}"
+    end
+
+    def unique_identifier
+      result = run_command_via_connection('show version | include Processor')
+      result.stdout.split(' ')[-1]
+    end
+
+    private
+
+    def establish_connection
+      logger.debug("[SSH] opening connection to #{self}")
+
+      Net::SSH.start(@host, @user, @ssh_options)
+    end
+
+    def session
+      return @session unless @session.nil?
+
+      @session = open_channel(establish_connection)
+
+      # Escalate privilege to enable mode if password is given
+      if @enable_password
+        # This verifies we are not in privileged exec mode before running the
+        # enable command. Otherwise, the password will be in history.
+        if run_command_via_connection('show privilege').stdout.split[-1] != '15'
+          run_command_via_connection("enable\r\n#{@enable_password}")
+        end
+      end
+
+      # Prevent `--MORE--` by removing terminal length limit
+      run_command_via_connection('terminal length 0')
+
+      @session
+    end
+
+    def run_command_via_connection(cmd, &_data_handler)
+      # Ensure buffer is empty before sending data
+      @buf = ''
+
+      logger.debug("[SSH] Running `#{cmd}` on #{self}")
+      session.send_data(cmd + "\r\n")
+
+      logger.debug('[SSH] waiting for prompt')
+      until @buf =~ @prompt
+        raise BadEnablePassword if @buf =~ /Bad secrets/
+        session.connection.process(0)
+      end
+
+      # Save the buffer and clear it for the next command
+      output = @buf.dup
+      @buf = ''
+
+      format_result(format_output(output, cmd))
+    end
+
+    ERROR_MATCHERS = [
+      'Bad IP address',
+      'Incomplete command',
+      'Invalid input detected',
+      'Unrecognized host',
+    ].freeze
+
+    # IOS commands do not have an exit code so we must compare the command
+    # output with partial segments of known errors. Then, we return a
+    # `CommandResult` with arguments in the correct position based on the
+    # result.
+    def format_result(result)
+      if ERROR_MATCHERS.none? { |e| result.include?(e) }
+        CommandResult.new(result, '', 0)
+      else
+        CommandResult.new('', result, 1)
+      end
+    end
+
+    # The buffer (@buf) contains all data sent/received on the SSH channel so
+    # we need to format the data to match what we would expect from Train
+    def format_output(output, cmd)
+      leading_prompt = /(\r\n|^)\S+[>#]/
+      command_string = /#{Regexp.quote(cmd)}\r\n/
+      trailing_prompt = /\S+[>#](\r\n|$)/
+      trailing_line_endings = /(\r\n)+$/
+
+      output
+        .sub(leading_prompt, '')
+        .sub(command_string, '')
+        .gsub(trailing_prompt, '')
+        .gsub(trailing_line_endings, '')
+    end
+
+    # Create an SSH channel that writes to @buf when data is received
+    def open_channel(ssh)
+      logger.debug("[SSH] opening SSH channel to #{self}")
+      ssh.open_channel do |ch|
+        ch.on_data do |_, data|
+          @buf += data
+        end
+
+        ch.send_channel_request('shell') do |_, success|
+          raise 'Failed to open SSH shell' unless success
+          logger.debug('[SSH] shell opened')
+        end
+      end
+    end
+  end
+end

data/lib/train/version.rb

@@ -3,5 +3,5 @@
 # Author:: Dominik Richter (<dominik.richter@gmail.com>)
 
 module Train
-  VERSION = '2.0.8'.freeze
+  VERSION = '2.0.12'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train-core
 version: !ruby/object:Gem::Version
-  version: 2.0.8
+  version: 2.0.12
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-19 00:00:00.000000000 Z
+date: 2019-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -90,34 +90,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: ed25519
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: bcrypt_pbkdf
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: winrm
   requirement: !ruby/object:Gem::Requirement
@@ -187,6 +159,7 @@ files:
 - lib/train/plugins.rb
 - lib/train/plugins/base_connection.rb
 - lib/train/plugins/transport.rb
+- lib/train/transports/cisco_ios_connection.rb
 - lib/train/transports/local.rb
 - lib/train/transports/mock.rb
 - lib/train/transports/ssh.rb
@@ -206,7 +179,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="