train-telnet 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ce78fe5b33ad84efb95d26d49d28e52696dba529df1cde3873334248e7b05e25
+  data.tar.gz: c5d5aff8f5b333c837c01bbc22ea1b1c8ccaed7441d8685616210bfdcaf8dd5f
+SHA512:
+  metadata.gz: a5a5093d1cb53a10dc80a307e936993dc4bf619062e7e119e8c76273b0d4e3a6ecf7a042440681723448b48c5cdae0daf08f9d5f5fc66b7957d2e2257a0b1022
+  data.tar.gz: b01e9efcffaf31bb8074ecd180490f7d2b6d78302aec23f647164000d46a8efdaaf7c29b49b87e3b272c75371d016c7a4f57678035520ff0dcdad55532298ddc

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "pry"
+  gem "bundler"
+  gem "rake"
+  gem "chefstyle"
+end

data/README.md

@@ -0,0 +1,48 @@
+# train-telnet - Train Plugin for connecting via Telnet
+
+This plugin allows applications that rely on Train to communicate via Telnet.
+
+Of course you already know that this is an insecure protocol - but if you look
+for this plugin, you probably have some specific needs. Right? If not, please
+try the default SSH transport included in Train.
+
+## Installation
+
+You will have to build this gem yourself to install it as it is not yet on
+Rubygems.Org. For this there is a rake task which makes this a one-liner:
+
+```bash
+rake install:local
+```
+
+## Transport parameters
+
+| Option            | Explanation                  | Default          |
+| ----------------- | ---------------------------- | ---------------- |
+| `host`            | Hostname                     | (required)       |
+| `user`            | Username to connect          | (required)       |
+| `password`        | Password to connect          | (required)       |
+| `port`            | Remote port                  | `23`             |
+| `login_prompt`    | Username prompt on login     | `Username: `     |
+| `password_prompt` | Password prompt on login     | `Password: `     |
+| `setup`           | Commands to issue on open    | ` `              |
+| `teardown`        | Commands to issue on close   | ` `              |
+| `raw_output`      | Suppress stdout processing   | `false`          |
+| `error_pattern`   | Regex to match error lines   | `ERROR.*`        |
+| `prompt_pattern`  | Regex to match device prompt | `[-a-zA-Z0-9]+(?:\((?:config\|config-[a-z]+\|vlan)\))?[#>]\s*$` |
+
+## Example use
+
+This will work for a Cisco IOS XE device with Telnet enabled:
+```ruby
+require "train"
+train  = Train.create("telnet", {
+            host:     "10.0.0.1",
+            user:     "username",
+            password: "password",
+            setup:    "terminal length 0\n",
+            logger:   Logger.new($stdout, level: :info)
+         })
+conn   = train.connection
+result = conn.run_command("show version\n")
+conn.close

data/lib/train-telnet.rb

@@ -0,0 +1,7 @@
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require "train-telnet/version"
+
+require "train-telnet/transport"
+require "train-telnet/connection"

data/lib/train-telnet/connection.rb

@@ -0,0 +1,107 @@
+require "net/telnet"
+require "train"
+
+module TrainPlugins
+  module Telnet
+    class Connection < Train::Plugins::Transport::BaseConnection
+
+      def initialize(options)
+        super(options)
+      end
+
+      def close
+        return if @session.nil?
+
+        unless @options[:teardown]&.empty?
+          logger.debug format("[Telnet] Sending teardown commands to %s:%d", @options[:host], @options[:port])
+          execute_on_channel(@options[:teardown])
+        end
+
+        logger.info format("[Telnet] Closed connection to %s:%d", @options[:host], @options[:port])
+        session.close
+      ensure
+        @session = nil
+      end
+
+      def uri
+        "telnet://#{options[:user]}@#{@options[:host]}:#{@options[:port]}/"
+      end
+
+      def run_command_via_connection(cmd, &data_handler)
+        logger.debug format("[Telnet] Sending command to %s:%d", @options[:host], @options[:port])
+        exit_status, stdout, stderr = execute_on_channel(cmd, &data_handler)
+
+        CommandResult.new(stdout, stderr, exit_status)
+      end
+
+      def execute_on_channel(cmd, &data_handler)
+        if @options[:debug_telnet]
+          logger.debug "[Telnet] => #{cmd}\n"
+        end
+
+        stdout = session.cmd(cmd)
+        stderr = ""
+        exit_status = 0
+
+        # Output needs to be flushed first, so we don't skip a beat (Check why)
+        session.waitfor("Waittime" => 0.1, "Match" => /./, "Timeout" => 0.1) rescue Net::ReadTimeout
+
+        # Remove \r in linebreaks
+        stdout.delete!("\r")
+
+        if @options[:debug_telnet]
+          logger.debug "[Telnet] <= '#{stdout}'"
+        end
+
+        # Extract command output only (no leading/trailing prompts)
+        unless @options[:raw_output]
+          stdout = stdout.match(/#{Regexp.quote(cmd.strip)}\n(.*?)\n#{@options[:prompt_pattern]}/m)&.captures&.first
+        end
+        stdout = "" if stdout.nil?
+
+        # Simulate exit code and stderr
+        errors = stdout.match(/^(#{@options[:error_pattern]})/)
+        if errors
+          exit_status = 1
+          stderr = errors.captures.first
+          stdout.gsub!(/^#{@options[:error_pattern]}/, "")
+        end
+
+        [exit_status, stdout, stderr]
+      end
+
+      def session(retry_options = {})
+        @session ||= create_session
+      end
+
+      def create_session
+        logger.info format("[Telnet] Opening connection to %s:%d", @options[:host], @options[:port])
+
+        @session = Net::Telnet.new(
+          "Host"   => @options[:host],
+          "Port"   => @options[:port],
+          "Prompt" => Regexp.new(@options[:prompt_pattern])
+        )
+
+        @session.login(
+          "Name"           => @options[:user],
+          "Password"       => @options[:password],
+          "LoginPrompt"    => Regexp.new(@options[:login_prompt]),
+          "PasswordPrompt" => Regexp.new(@options[:password_prompt])
+        )
+
+        unless @options[:setup].empty?
+          logger.debug format("[Telnet] Sending setup commands to %s:%d", @options[:host], @options[:port])
+
+          execute_on_channel(@options[:setup])
+        end
+
+        @session
+      end
+
+      def reset_session
+        @session.close
+      end
+    end
+  end
+end

data/lib/train-telnet/transport.rb

@@ -0,0 +1,30 @@
+require "train-telnet/connection"
+
+module TrainPlugins
+  module Telnet
+    class Transport < Train.plugin(1)
+      name "telnet"
+
+      option :host,            required: true
+      option :user,            required: true
+      option :password,        required: true
+
+      option :port,            default: 23
+      option :raw_output,      default: false
+
+      option :login_prompt,    default: "Username: "
+      option :password_prompt, default: "Password: "
+      option :setup,           default: ""
+      option :teardown,        default: ""
+      option :error_pattern,   default: "ERROR: .*$"
+      option :prompt_pattern,  default: "[-a-zA-Z0-9]+(?:\((?:config|config-[a-z]+|vlan)\))?[#>]\s*$"
+
+      # Non documented options for development
+      option :debug_telnet,   default: false
+
+      def connection(_instance_opts = nil)
+        @connection ||= TrainPlugins::Telnet::Connection.new(@options)
+      end
+    end
+  end
+end

data/lib/train-telnet/version.rb

@@ -0,0 +1,5 @@
+module TrainPlugins
+  module Telnet
+    VERSION = "0.1.0".freeze
+  end
+end

data/train-telnet.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "train-telnet/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "train-telnet"
+  spec.version       = TrainPlugins::Telnet::VERSION
+  spec.authors       = ["Thomas Heinen"]
+  spec.email         = ["theinen@tecracer.de"]
+  spec.summary       = "Train Transport for Telnet connections"
+  spec.description   = "Allows applications using Train connect via Telnet"
+  spec.homepage      = "https://github.com/tecracer_theinen/train-telnet"
+  spec.license       = "Apache-2.0"
+
+  spec.files = %w{
+    README.md train-telnet.gemspec Gemfile
+  } + Dir.glob(
+    "lib/**/*", File::FNM_DOTMATCH
+  ).reject { |f| File.directory?(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "train", "~> 2.0"
+  spec.add_dependency "net-telnet", "~> 0.2"
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: train-telnet
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas Heinen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: train
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: net-telnet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Allows applications using Train connect via Telnet
+email:
+- theinen@tecracer.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- lib/train-telnet.rb
+- lib/train-telnet/connection.rb
+- lib/train-telnet/transport.rb
+- lib/train-telnet/version.rb
+- train-telnet.gemspec
+homepage: https://github.com/tecracer_theinen/train-telnet
+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.3
+signing_key: 
+specification_version: 4
+summary: Train Transport for Telnet connections
+test_files: []