cisco 0.0.1

data/README

@@ -0,0 +1,73 @@
+Ruby-Cisco
+==========
+This tool aims to provide transport-flexible functionality, for easy communication
+with Cisco devices. It currently allows you to execute commands on a device and get
+back the output of those commands.
+
+To install:
+
+git clone git://github.com/yakischloba/ruby-cisco.git
+cd ruby-cisco
+gem build cisco.gemspec
+sudo gem install cisco-<version>.gem
+
+The library provides two styles to use:
+
+cisco = Cisco::Base.new(:host => "10.0.0.1", :password => "accesspass")
+cisco.cmd("sh ver")
+cisco.enable("enablepass")
+cisco.cmd("sh run")
+output = cisco.run
+
+This will return an array of results, one string for the output of each command. The
+following block style usage returns the same results, though some may prefer it:
+
+output = cisco.run do |x|
+	x.cmd("sh ver")
+	x.enable("enablepass")
+	x.cmd("sh run")
+end
+
+SSH and Telnet should be working OK at this time. Unfortunately due to the asynchronous
+design of the Net::SSH library's API, it is not easy to provide an interface for
+operating conditionally on output data in the middle of a session like you may be
+used to, for example:
+
+output = device.cmd("show version")
+if output =~ "IOS"
+	device.cmd("run some ios command")
+else
+	device.cmd("run some catos command")
+end
+
+Similar behavior could be achieved by setting up the SSH session yourself. You can peek
+at the #run method in ssh.rb for how to do this. Instead, the interface of this library 
+allows you to simply execute a series of commands all in one run, and get the output at 
+the end. I have limited the synchronous advantage of Net::Telnet by conforming it to this
+model, but I wanted to have them both be used in the same fashion.
+
+The Base class should be used unless you know what you're doing and what I have provided
+is not adequate. Telnet is used by default. To use SSH, you must specify:
+
+cisco = Cisco::Base.new(:host => "10.0.0.1", :user => "admin", :password => "accesspass", :transport => :ssh)
+
+You can also pass an array of direct arguments that are used to instantiate the transport object. 
+This is useful, if for instance, you want to use public key authentication with SSH:
+
+cisco = Cisco::Base.new(:directargs => ["10.0.0.1", "admin", :auth_methods => ["publickey"]])
+
+In the future, I would like to provide subclasses to retrieve, present and set configuration 
+parameters in an OO fashion, like:
+
+router.int["fa0/4"].speed
+=> 100
+router.int["fa0/4"].speed = 10
+router.apply!
+
+I have yet to come up with a good way for implementing this that will scale across
+a wide variety of devices. Please let me know if you have input and want to help.
+
+jakecdouglas@gmail.com
+yakischloba on Freenode
+
+Thanks to Jamis Buck for creating Net::SSH and helping me understand how to do this.

data/lib/cisco.rb

@@ -0,0 +1,5 @@
+$:.unshift File.expand_path(File.dirname(File.expand_path(__FILE__)))
+require 'cisco/common'
+require 'cisco/telnet'
+require 'cisco/ssh'
+require 'cisco/base'

data/lib/cisco/base.rb

@@ -0,0 +1,57 @@
+module Cisco
+
+  class CiscoError < StandardError
+  end
+
+  class Base
+
+    attr_reader :transport
+
+    def initialize(options)
+      @transport = options[:transport] || :telnet
+      options[:prompt] ||= /[#>]\s?\z/n
+      options[:password] ||= ""
+      options[:autoinit] ||= true
+      @transport = Cisco.const_get(Cisco.constants.find {|const| const =~ Regexp.new(@transport.to_s, Regexp::IGNORECASE)}).new(options)
+      extra_init("terminal length 0")
+    end
+
+    def host
+      @transport.host
+    end
+    
+    def password
+      @transport.password
+    end
+    
+    def prompt
+      @transport.prompt
+    end
+
+    def clear_cmd
+      @transport.clear_cmd
+    end
+
+    def extra_init(*args)
+      @transport.extra_init(*args)
+    end
+
+    def clear_init
+      @transport.clear_init
+    end
+
+    def cmd(*args)
+      @transport.cmd(*args)
+    end
+
+    def run(&block)
+      @transport.run(&block)
+    end
+
+    def enable(*args)
+      @transport.enable(*args)
+    end
+
+  end
+
+end

data/lib/cisco/common.rb

@@ -0,0 +1,29 @@
+module Cisco
+  
+  module Common
+    
+    attr_accessor :host, :password, :prompt
+    
+    def enable(password, pwprompt = nil)
+      @pwprompt = pwprompt || @pwprompt
+      old = @prompt
+      cmd("enable", @pwprompt)
+      cmd(password, old)
+    end
+
+    def extra_init(*args)
+			cmd(*args)
+			@extra_init << @cmdbuf.pop
+		end
+		
+		def clear_init
+			@extra_init = []
+		end
+		
+		def clear_cmd
+			@cmdbuf = []
+		end    
+    
+  end
+  
+end

data/lib/cisco/ssh.rb

@@ -0,0 +1,83 @@
+require 'net/ssh'
+
+module Cisco
+
+	class SSH
+	  
+	  include Common
+	
+		def initialize(options)
+		  @host    = options[:host]
+		  @user    = options[:user]
+		  @password = options[:password]
+		  @prompt  = options[:prompt]
+		  @sshargs = options[:directargs] || [@host, @user, {:password => @password, :auth_methods => ["password"]}]
+		  @pwprompt = options[:pwprompt] || "Password:"
+		  @cmdbuf, @extra_init = [], []
+		end
+   	
+   	def cmd(cmd, prompt = nil, &block)
+			@cmdbuf << [cmd + "\n", prompt, block]
+		end
+		
+		def run
+			@inbuf = ""
+			@results = []
+			@ssh = Net::SSH.start(*@sshargs)
+			@ssh.open_channel do |chan|
+				chan.send_channel_request("shell") do |ch, success|
+					if !success
+						abort "Could not open shell channel"
+					else
+						ch.on_data do |chn, data|
+							@outblock.call(data) if @outblock
+							@inbuf << data
+							check_and_send(chn)
+						end
+						(@cmdbuf = [] and yield self) if block_given?
+						@cmdbuf.insert(0, *@extra_init) if @extra_init.any?
+					end
+				end
+			end
+			@ssh.loop
+			
+			@results
+		end
+		
+		# Disconnect the session. Either Net::SSH has a bug, or the Cisco implementation is sometimes whacky,
+		# causing an exception to be thrown when trying to close the channel via the SSH protocol. To get around
+		# this, this method simply sends "exit" until the device disconnects us.
+		def close(chn)
+      10.times do
+        chn.send_data("exit\n") unless (!chn.active? || chn.closing?)
+      end
+    end
+		
+		private
+				
+		def check_and_send(chn)
+			if @inbuf =~ @prompt
+				@results << @inbuf.gsub(Regexp.new("\r\n"), "\n")
+				@inbuf = ""
+				if @cmdbuf.any?
+					send_next(chn)
+				else
+					close(chn)
+				end
+			elsif (@inbuf =~ Regexp.new(@pwprompt) and @prompt != Regexp.new(@pwprompt))
+				@cmdbuf = []
+				close(chn)
+				raise CiscoError.new("Enable password was not correct.")
+			end
+		end
+
+		def	send_next(chn)
+			cmd = @cmdbuf.shift
+			@prompt = Regexp.new(cmd[1]) if cmd[1]
+			@outblock = cmd[2] if cmd[2]
+			chn.send_data(cmd.first)
+		end
+
+	end
+	
+end

data/lib/cisco/telnet.rb

@@ -0,0 +1,60 @@
+require 'net/telnet'
+
+module Cisco
+
+  class Telnet
+    
+    include Common
+
+    def initialize(options)
+      @host    = options[:host]
+      @password = options[:password]
+      @prompt  = options[:prompt]
+      @targs   = options[:directargs] || ["Host" => @host]
+		  @pwprompt = options[:pwprompt] || "Password:"
+      @cmdbuf, @extra_init = [], []
+    end
+
+    def run
+      @results = []
+      (@cmdbuf = [] and yield self) if block_given?
+      @cmdbuf.insert(0, *@extra_init) if @extra_init.any?
+      @telnet = Net::Telnet.new(*@targs)
+      login
+      until @cmdbuf.empty?
+        send_next
+        @results << @telnet.waitfor(@prompt) {|x| @outblock.call(x) if @outblock}
+      end
+      
+      @results
+    end
+
+    def cmd(cmd, prompt = nil, &block)
+      @cmdbuf << [cmd, prompt, block]
+    end
+    
+    def close
+      10.times do
+        chn.send_data("exit\n") while @telnet.sock
+      end
+    end
+
+    private
+
+    def login
+      raise CiscoError.new("No login password provided.") unless @password
+      @results << @telnet.waitfor(Regexp.new("Password:"))
+      @telnet.puts(@password)
+      @results << @telnet.waitfor(@prompt)
+    end
+
+    def	send_next
+      cmd = @cmdbuf.shift
+      @prompt = Regexp.new(cmd[1]) if cmd[1]
+      @outblock = cmd[2] if cmd[2]
+      @telnet.puts(cmd.first)
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: cisco
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jake Douglas
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-13 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: net-ssh
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: |-
+  This tool aims to provide transport-flexible functionality, for easy communication
+                    with Cisco devices. It currently allows you to execute commands on a device and get
+                    back the output of those commands.
+email: jakecdouglas@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- lib/cisco.rb
+- lib/cisco/common.rb
+- lib/cisco/telnet.rb
+- lib/cisco/base.rb
+- lib/cisco/ssh.rb
+has_rdoc: true
+homepage: http://www.github.com/yakischloba/ruby-cisco
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: cisco
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Library for accessing Cisco devices via Telnet and SSH
+test_files: []
+