riscos 0.1.1 → 0.1.2

data/lib/riscos.rb

@@ -1,12 +1,12 @@
 require 'expect'
 require 'pty'
+
 module Cisco
   
   class Base
     attr_accessor  :timeout, :prompt, :output, :info
   
     def initialize(options)
-
       @host       = options[:host] || "nil"
       @user       = options[:user] || "nil"
       @pw         = options[:pw]   || "nil" #login pass
@@ -15,57 +15,52 @@ module Cisco
       @w          = "/dev/null"       #writer socket
       @p          = nil               #pid to kill later
       @prompt     = /\r\n\r.*[#>]\s?\z/n
-      @timeout    = 30
+      @timeout    = 10
       @output = Array.new
-      @info   = Array.new             #store configuration info gleaned from config
+      @info   = Array.new #store configuration info gleaned from config
+      @error  = Array.new             
     end
-
+    # Quickly logs into the device. 
+    #
+    # * runs a login, enable, and conft to get you where you need to be
     def loginquick()
       self.login
       self.enable
       self.conft
     end
-    
-
-  
-    def enable()
-      begin
+    # Turns on enable or superuser mode on the device. 
+    #
+    # * gives you the ability to use the superuser's console
+    def enable() 
         @w.print("enable\n")
-        @w.print(@enpw + "\n")
-        read(@r,@timeout, @prompt)
-      rescue Exception => ee
-        @info.push("ERROR: Exception for host in enable:#{ee.to_s}\n")
-      end
+        run(@enpw)
     end
-  
+    # Turns on 'configuration mode' on the device
+    #
+    # * gives you the set system parameters on the device 
     def conft()
-       begin
-          @w.print("conf t\n")
-          read(@r,@timeout, @prompt)
-          @w.print("pager 0 \n")
-          read(@r,@timeout, @prompt)
-        rescue Exception => ee
-          @info.push("ERROR: Exception for host in conft :#{ee.to_s}\n")
-        end
-    
+      run("conf t")
+      run("pager 0")
     end
-  
-
+    # Runs a technical diagnostic on the device. This outputs a lot of information. 
+    #
+    # * this is basically one command that gives you almost everything you'd ever want to know
     def showtech()
-      begin
-        @w.print("show tech\n")
-        #it would be real nice to take this then populate the information about the device
-        read(@r,@timeout, @prompt)
-      rescue Exception => ee
-        @info.push("ERROR: Exception for host in show tech:#{ee.to_s}\n")
-      end
+      run("show tech")
     end
-  
-    def read(r,timeout,exp)
+    # Lets us read the command line output of the device. If we error, we return the error in the @error array and the command that failed. We 
+    # will also close the reading and writing sockets if we get a timeout. If we don't we end up with stray ruby processes. 
+    #
+    # * these can change for each call
+    # * @r is the reader socket
+    # * @timeout is how log we want to wait for this particular read
+    # * @prompt is the prompt we'll wait for on this read
+    def read(r=@r,timeout=@timeout,prompt=@prompt)
+
       begin
-        r.expect(exp,timeout) do |rec|
+        r.expect(prompt,timeout) do |rec|
           if rec == nil then
-            @info.push("ERROR: Timeout talking to device")
+            @error.push("ERROR: Timeout talking to device")
             close()
           else
             @output.push(rec)
@@ -73,96 +68,200 @@ module Cisco
           end
         end
       rescue Exception => ee
-        @info.push "ERROR:Exception trying to read stream: #{ee.to_s}\n"
+        @error.push "ERROR:Exception trying to read stream: #{ee.to_s}"
         return @output
       end 
-    
     end
+    # Logout of the device
+    #
+    # 
   
     def logout()
-      begin 
-        @w.print("pager 30\n")
-        read(@r,@timeout, @prompt)
-        @w.print("write mem\n")
-        read(@r,@timeout, @prompt)
-        @w.print("exit\n")
-      rescue Exception => ee
-        @info.push("ERROR: Exception for host in logout:#{ee.to_s}\n\nAlready closed connection?")
-      end
+      run("pager 30")
+      run("write mem")
+      @w.print("exit")
     end
 
-    def run(cmd)
-      buffer = []
+    # Individual commands to run on the device. These would be good for scripts and batch processes. 
+    #
+    # * cmd is the command you're sending to the device
+    # * @prompt is the particular prompt we're going to look for. We do a "read" after each run and return the output from the device
+    def run(cmd,prompt=@prompt)
       begin
         @w.print("#{cmd}\n")
-        buffer.push(read(@r,@timeout,@prompt))
+        buffer = read(@r,@timeout,prompt)
       rescue Exception => ee
-        @info.push("ERROR: Exception for host while executing run: #{ee.to_s}\n")
+        @error.push("ERROR: Exception for host while executing #{cmd}: #{ee.to_s}")
       end  
       return buffer
     end    
   
+    # Close the connection. We're through.
+    #
+    # * close the sockets then kill the pid to make sure.
+  
     def close
-      
       begin
         @w.close
         @r.close
         #just to be sure, nuke it
         Process.kill(:SIGKILL, @p)
-
         @output.push("connection closed")
       rescue Exception => ee
-        @info.push("ERROR: Problem closing connection: #{ee.to_s}")
+        @error.push("ERROR: Problem closing connection: #{ee.to_s}")
       end
     end
-  
-  
   end
   
   class Asa < Base
+    
+    # Login specific to ASAs and FWSMs (since they behave just like ASAs) 
+    #
+    # 
     def login()
       cmd="ssh -o StrictHostKeyChecking=no #{@user}@#{@host}\n"
       begin
         PTY.spawn(cmd) do |r,w,p| 
           @r,@w,@p=r,w,p
           read(@r,@timeout, "word:")
-          w.print(@pw+"\n")
-          read(@r,@timeout, @prompt)
+          run(@pw)
         end
       
       rescue Exception => ee
-        @info.push("ERROR: Exception for host in login:#{ee.to_s}\n\nBad ip address?")
+        @error.push("ERROR: Exception for host in login:#{ee.to_s}\n\nBad ip address?")
       end
     end
-    
-    
-    
   end
   
+  # Login specific to Pixes (since they behave differently than ASAs.)
+  #
+  #
   
   class Pix < Base
     
     def login()
       cmd="ssh -o StrictHostKeyChecking=no #{@user}@#{@host}\n"
-      begin
-        PTY.spawn(cmd) do |r,w,p| 
-          @r,@w,@p=r,w,p
-          read(@r,@timeout, "word:")
-          w.print(@pw+"\n")
-          read(@r,@timeout, @prompt)
-          
-          #Pix adds an extra <CR> on login, so we remove it for you
-          read(@r,@timeout, @prompt)
-          @output.pop
+      PTY.spawn(cmd) do |r,w,p| 
+        @r,@w,@p=r,w,p
+        read(@r,@timeout, "word:")
+        run(@pw)
+        read()
+        #Pix adds an extra <CR> on login, so we remove it for you
+        @output.pop
+      end
+    end
+  end
+  
+  
+  ## these are still being developed.
+  class Css < Base
+    attr_accessor  :owner, :service, :sslproxy, :sslfiles
+  
+    def initialize(options)
+      super(options)
+      @owner        = Hash.new{|h,k| h[k]=Hash.new(&h.default_proc) }
+      @service      = Array.new
+      @sslproxy     = Hash.new{|h,k| h[k]=Hash.new(&h.default_proc) }
+      @sslfiles     = Array.new
+    end
+    
+    def login
+      cmd="ssh -o StrictHostKeyChecking=no #{@host}"   
+      PTY.spawn(cmd) do |r,w,p| 
+        @r,@w,@p=r,w,p
+        read(@r,@timeout, "name:")
+        run(@user, "word:")
+        run(@pw)
+        run("terminal length 65535")         
+      end
+    end    
+  
+    def logout()
+      run("terminal length 30")
+      run("write mem")
+      @w.print("exit")
+    end
+    
+    # Runs a 'show service summary' on the related CSS. 
+    #
+    # * the output is parsed into Service Name
+    # * next field is State
+    # * next field is Conn
+    # * next field is Weight
+    # * next field is Avg Load
+    # * last field is State Transitions
+    
+    def showservices
+      s = run("show service summary")
+      #s = read()
+      s=s.first.split("\r\r\r\n")
+      s[5..-2].each do |l|
+        @service.push(l.split)
+      end
+    end
+    
+    def owners
+      o = run("show run owner")
+      o = o.first.split("\r\r\r\n")
+      # we need to chomp the first and last lines
+      o.delete_at(0)
+      o.delete_at(-1)
+      #change to when/case
+        o[2..-1].each do |l| 
+          next if l.empty?
+          l = l.split
+          line = case l
+            when /^owner/
+              @ow=l.last
+              @owner[@ow]
+            when /content/
+              @serv=[]
+              @co=l.last
+              @owner[@ow][@co]       
+            when /^active/
+              @owner[@ow][@co][l.first]=true
+            when /add service/
+              @serv.push(l.last)
+              @owner[@ow][@co]["add service"]=@serv  
+            else
+              @owner[@ow][@co][l[0..-2].to_s]=l.last
+            end            
         end
+    end
+    
+  def sslproxies
+    s= run("show run ssl-proxy-list")
+    s=s.first.split("\r\r\r\n")
+    s[3..-2].each do |l|
+      l=l.split
+      #puts l
+      line = case l.first
+        when /ssl-proxy-list/
+        @proxy=l.last
+        @sslproxy[l.last]
+        when /^active/
+        @sslproxy[@proxy]["active"]=true
+        when /ssl-server/
+        @details=[]
+        @server=l[1]
+        @sslproxy[@proxy][@server]
+        when /.*?\\s.*?/
+          puts "here"
+        @details.push((l.last[2..-1].collect {|x| x + " " }).to_s)
+        # @details.delete("")
+         @sslproxy[@proxy][@server]=@details
       
-      rescue Exception => ee
-        @info.push("ERROR: Exception for host in login:#{ee.to_s}\n\nBad ip address?")
-      end
+      else
+        @sslproxy[@proxy]["active"]=false
+      end 
     end
-
-
+  end
+  
+  def sslfile
+      @sslfiles = run("show ssl files")
     
   end
+ 
+  end
    
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: riscos
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Paul Voccio
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-23 00:00:00 -06:00
+date: 2009-02-16 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
-description: Provides a common easy to use interface to talk to Cisco Pix and Cisco ASAs.
+description: Provides a common easy to use interface to talk to Cisco Pix, ASA, FWSM and Cisco CSSes.
 email: paul@substation9.com
 executables: []
 
@@ -26,7 +26,7 @@ files:
 - Changelog
 - LICENSE
 - lib/riscos.rb
-has_rdoc: false
+has_rdoc: true
 homepage: http://riscos.rubyforge.org/
 post_install_message: 
 rdoc_options: []
@@ -51,6 +51,6 @@ rubyforge_project: riscos
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
-summary: Provides a common easy to use interface to talk to Cisco Pix and Cisco ASAs.
+summary: Provides a common easy to use interface to talk to Cisco Pix, ASA, FWSM and Cisco CSSes.
 test_files: []