snmpdumper 0.0.2

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2006 Sebastian de Castelberg
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of 
+this software and associated documentation files (the "Software"), to deal in 
+the Software without restriction, including without limitation the rights to 
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 
+the Software, and to permit persons to whom the Software is furnished to do so, 
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all 
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,28 @@
+= snmpdumper - create snmpdumps for 3rd party tools
+ 
+This tool dumps snmp walks into a set of output formats.
+ 
+* Plain Text (same as running snmpwalk)
+* Jalasoft Device Dump (http://www.jalasoft.com)
+
+== Sample Workflows
+ 
+Create an SNMP Device Dump for jalasoft Simulator of a Cisco SNMP Agent running on 192.168.1.10
+and store it in ./cisco.xml.
+ 
+  snmpdump -D JalasoftDumper -C "Cisco Switches" -o ./cisco.xml 192.168.1.10
+ 
+== Setup
+ 
+  gem install snmp
+  gem install snmpdumper
+ 
+== Meta
+ 
+Created and maintained by Sebastian de Castelberg
+ 
+Patches contributed by: -
+ 
+Released under the MIT license: http://www.opensource.org/licenses/mit-license.php
+ 
+http://github.com/sdecastelberg/snmpdumper

data/bin/snmpdumper

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'runner'
+runner = SnmpDumper::Runner.new(ARGV)
+runner.run

data/lib/dumper/jalasoft_dumper.rb

@@ -0,0 +1,100 @@
+%w(builder).each { |f| require f }
+
+module SnmpDumper
+  GENERIC_VALUE_CALLBACK = lambda do |value_set, name, values| 
+    value = values.first
+    value_set.JSVALUE("value" => value)
+  end
+
+  OCTETSTRING_VALUE_CALLBACK = lambda do |value_set, name, values|
+    value = values.first
+    if value =~ /[[:cntrl:]]/ then
+      value_set.JSVALUE("value" => value.unpack('H*').first.upcase.scan(/.{1,2}/).join(" "), "hexa" => 1)
+    else
+      value_set.JSVALUE("value" => "foo")
+    end
+  end
+
+  TIMETICKS_VALUE_CALLBACK = lambda do |value_set, name, values| 
+    value_set.JSVALUE("value" => values.first.to_i)
+  end
+
+  INTEGER_VALUE_CALLBACK = lambda do |value_set, name, values|
+    values = values.collect {|x| x.to_i}
+    values.uniq!
+
+    if values.size > 1 then
+      values.each do |value|
+        value_set.JSVALUE("value" => value.to_i, "weight" => 100 / values.size)
+      end
+    else
+      value_set.JSVALUE("value" => values.first.to_i)
+    end
+  end
+
+  DATA_TYPE_MAP = {
+    SNMP::Counter32 => {:syntax => "COUNTER", :callback => GENERIC_VALUE_CALLBACK},
+    SNMP::Counter64 => {:syntax => "COUNTER", :callback => GENERIC_VALUE_CALLBACK},
+    SNMP::Gauge32 => {:syntax => "GAUGE", :callback => GENERIC_VALUE_CALLBACK},
+    SNMP::Integer => {:syntax => "INTEGER", :callback => INTEGER_VALUE_CALLBACK},
+    SNMP::IpAddress => {:syntax => "IPADDRESS", :callback => GENERIC_VALUE_CALLBACK},
+    SNMP::ObjectId => {:syntax => "OBJECTIDENTIFIER", :callback => GENERIC_VALUE_CALLBACK},
+    SNMP::OctetString => {:syntax => "OCTETSTRING", :callback => OCTETSTRING_VALUE_CALLBACK},
+    SNMP::TimeTicks => {:syntax => "TIMETICKS", :callback => TIMETICKS_VALUE_CALLBACK},
+    String => {:syntax => "OCTETSTRING", :callback => GENERIC_VALUE_CALLBACK},
+  }
+  
+  class SnmpVar
+    attr_accessor :name, :values
+    def initialize(args)
+      raise ArgumentError.new("Wrong paramters: ") unless args[:name]
+      self.name = args[:name]
+      self.values = []
+    end
+
+    def dump(jssnmpdevice)
+      jssnmpdevice.JSSNMPVAR do |jssnmpvar|
+        syntax_hash = DATA_TYPE_MAP[values.first.class] || {:syntax => "OCTETSTRING", :callback => OCTETSTRING_VALUE_CALLBACK}
+        jssnmpvar.JSOID("syntax" => syntax_hash[:syntax], "value" => name)
+        jssnmpvar.JSVALUESET { |value_set| DATA_TYPE_MAP[values.first.class][:callback].call(value_set, name, values) }
+      end
+    end
+  end
+
+  class JalasoftDumper
+    attr_accessor :category
+    attr_accessor :model
+    attr_accessor :snmp_vars
+    attr_accessor :model
+    attr_accessor :category
+
+    def initialize(options)
+      @model = options.model
+      @category = options.category
+      @snmp_vars = Hash.new
+    end
+
+    def dump
+      builder = Builder::XmlMarkup.new(:indent=>2)
+      
+      builder.JSSNMPDEVICE("category" => @category, "model" => get_model) do |jssnmpdevice|
+        @snmp_vars.values.each do |snmp_var|
+          snmp_var.dump(jssnmpdevice)
+        end
+      end
+    end
+
+    def add_snmp_var(args)
+      raise ArgumentError.new("Invalid arguments") unless args[:name] && args[:value]
+      @snmp_vars[args[:name]] ||= SnmpVar.new(:name => args[:name])
+      @snmp_vars[args[:name]].values << args[:value]
+    end
+
+    def get_model
+      return @model if @model
+      m = @snmp_vars[".1.3.6.1.2.1.1.1.0"]
+      return "Unknown Model" unless m
+      m.values.first
+    end
+  end
+end

data/lib/dumper/simple_text_dumper.rb

@@ -0,0 +1,17 @@
+module SnmpDumper
+  class SimpleTextDumper
+    attr_accessor :model
+    attr_accessor :category
+    
+    def initialize(options)
+    end
+    
+    def snmp_vars
+    end
+    
+    def snmp_vars=(args)
+      puts args.inspect
+    end
+
+  end
+end

data/lib/options.rb

@@ -0,0 +1,206 @@
+require 'optparse'
+require 'ostruct'
+require 'pp'
+
+module SnmpDumper
+  class Options
+    SNMP_VERSIONS = {"1" => :SNMPv1, "2c" => :SNMPv2c, "3" => :SNMPv3}
+    DEFAULT_PORT = 161
+
+    DEFAULT_INTERVAL = 10
+    DEFAULT_WALKS = 3
+
+    DEFAULT_COMMUNITY = "public"
+    DEFAULT_CATEGORY = "Unknown Category"
+    DEFAULT_DUMPER = "JalasoftDumper"
+    
+    attr_reader :options
+
+    def initialize(argv)
+      parse(argv)
+    end
+
+    private
+    def parse(argv)
+      @options = OpenStruct.new
+      @options.port = DEFAULT_PORT
+      @options.interval = DEFAULT_INTERVAL
+      @options.walks = DEFAULT_WALKS
+      @options.oids = [
+        "1",
+        "1.3.6.1.2.1.10",
+        "1.3.6.1.2.1.1",
+        "1.3.6.1.2.1.11",
+        "1.3.6.1.2.1.16",
+        "1.3.6.1.2.1.17",
+        "1.3.6.1.2.1.2",
+        "1.3.6.1.2.1.4",
+        "1.3.6.1.2.1.47",
+        "1.3.6.1.4.1.9.2.1.40.0",
+        "1.3.6.1.4.1.9.2.1.41.0",
+        "1.3.6.1.4.1.9.2.1.42.0",
+        "1.3.6.1.4.1.9.2.1.43.0",
+        "1.3.6.1.4.1.9.2.1.44.0",
+        "1.3.6.1.4.1.9.2.1.45.0",
+        "1.3.6.1.4.1.9.2.1.46.0",
+        "1.3.6.1.4.1.9.2.1.47.0",
+        "1.3.6.1.4.1.9.2.1.48.0",
+        "1.3.6.1.4.1.9.2.1.49.0",
+        "1.3.6.1.4.1.9.2.4.1.1",
+        "1.3.6.1.4.1.9.9.10.1.1.3.1.1.2.1.1",
+        "1.3.6.1.4.1.9.9.10.1.1.3.1.1.3.1.1",
+        "1.3.6.1.4.1.9.9.10.1.1.3.1.1.4.1.1",
+        "1.3.6.1.4.1.9.9.10.1.1.3.1.1.5.1.1",
+        "1.3.6.1.4.1.9.9.10.1.1.3.1.1.6.1.1",
+        "1.3.6.1.4.1.9.9.10.1.1.3.1.1.7.1.1",
+        "1.3.6.1.4.1.9.9.10.1.1.4.1.1.10.1.1",
+        "1.3.6.1.4.1.9.9.10.1.1.4.1.1.11.1.1",
+        "1.3.6.1.4.1.9.9.10.1.1.4.1.1.12.1.1",
+        "1.3.6.1.4.1.9.9.10.1.1.4.1.1.2.1.1",
+        "1.3.6.1.4.1.9.9.10.1.1.4.1.1.3.1.1",
+        "1.3.6.1.4.1.9.9.10.1.1.4.1.1.4.1.1",
+        "1.3.6.1.4.1.9.9.10.1.1.4.1.1.5.1.1",
+        "1.3.6.1.4.1.9.9.10.1.1.4.1.1.6.1.1",
+        "1.3.6.1.4.1.9.9.10.1.1.4.1.1.7.1.1",
+        "1.3.6.1.4.1.9.9.10.1.1.4.1.1.8.1.1",
+        "1.3.6.1.4.1.9.9.10.1.1.4.1.1.9.1.1",
+        "1.3.6.1.4.1.9.9.106.1.1.1.0",
+        "1.3.6.1.4.1.9.2.1",
+        "1.3.6.1.4.1.9.2.2",
+        "1.3.6.1.4.1.9.3.6",
+        "1.3.6.1.4.1.9.2.9",
+        "1.3.6.1.4.1.9.2.10",
+        "1.3.6.1.4.1.9.9.10",
+        "1.3.6.1.4.1.9.9.23",
+        "1.3.6.1.4.1.9.9.46",
+        "1.3.6.1.4.1.9.9.48",
+        "1.3.6.1.4.1.9.9.68",
+        "1.3.6.1.4.1.9.9.87",
+        "1.3.6.1.4.1.9.9.109",
+        "1.3.6.1.4.1.9.1.324",
+        "1.3.6.1.4.1.9.9.134"
+      ]
+
+      @options.version = :SNMPv2c
+      @options.community = DEFAULT_COMMUNITY
+      @options.category = DEFAULT_CATEGORY
+      @options.dumper = DEFAULT_DUMPER
+
+      opts = OptionParser.new do |opts|
+        opts.banner = "Usage: snmpdumper [options] [host] [oids]"
+
+        opts.separator ""        
+        opts.separator "Specific options:"
+
+        opts.on("-p", "--port PORT", Integer, "SNMP agent port  (Default: #{DEFAULT_PORT})") do |port|
+          @options.port = port
+        end
+
+        opts.on("-i", "--interval INTERVAL", Integer, "walk interval in seconds (Default: #{DEFAULT_INTERVAL})") do |interval|
+          @options.interval = interval
+        end
+
+        opts.on("-w walks", "--walks WALKS", Integer, "number of walks (Default: #{DEFAULT_WALKS})") do |walks|
+          @options.walks = walks
+        end
+
+        opts.on("-O", "--output FILENAME", "file to save SNMP dump") do |out_filename|
+          @options.out_filename = out_filename
+        end
+        
+        opts.on("-I", "--input FILENAME", "file with output of snmpwalk") do |in_filename|
+          @options.in_filename = in_filename
+        end
+        
+        opts.on("-m", "--model MODELNAME", "model name (Default: dynamically taken from sysDescr)") do |model|
+          @options.model = model
+        end
+        
+        opts.on("-C", "--category CATEGORY", "category name (Default: #{DEFAULT_CATEGORY})") do |category|
+          @options.category = category
+        end
+        
+        opts.on("-D", "--dumper DUMPER_CLASS", "which dumper to use (Default: #{DEFAULT_DUMPER})") do |dumper|
+          @options.dumper = dumper
+        end        
+        
+        opts.separator ""
+        opts.separator "snmpwalk options:"
+
+        opts.on("-r", "--retries RETRIES", Integer, "set the number of retries") do |retries|
+          @options.retries = retries
+        end
+
+        opts.on("-t", "--timeout TIMEOUT", Integer, "set the request timeout (in seconds)") do |timeout|
+          @options.timeout = timeout
+        end
+
+        opts.on("-v VERSION", SNMP_VERSIONS,
+        "specifies SNMP version to use #{SNMP_VERSIONS.keys.join(', ')} (Default: #{@options.version})") do |version|
+          options.version =  version if version
+        end
+
+        opts.separator ""
+        opts.separator "SNMP Version 1 or 2c specific:"
+
+        opts.on("-c", "--community COMMUNITY", "set the community string") do |community|
+          @options.community = community
+        end
+
+        opts.separator ""
+        opts.separator "SNMP Version 3 specific:"
+
+        opts.on("-A PASSPHRASE", "set authentication protocol pass phrase") do |auth_passphrase|
+          @options.auth_passphrase = auth_passphrase
+        end
+
+        opts.on("-X PASSPHRASE", "set privacy protocol pass phrase") do |privacy_passphrase|
+          @options.privacy_passphrase = privacy_passphrase
+        end
+
+        opts.separator ""
+        opts.separator "Common options:"
+
+        opts.on("-d", "--[no-]debug", "print debug messages") do |d|
+          $DEBUG = d
+        end
+        
+        opts.on("-f", "--force", "do not stop on errors") do |f|
+          @options.force = f
+        end
+
+        opts.on("-h", "--help", "display this help message") do 
+          puts opts
+          exit
+        end
+
+        opts.on_tail("-V", "--version", "show version") do
+          puts OptionParser::Version.join('.')
+          exit
+        end
+
+        begin
+          opts.parse!(argv)
+          raise OptionParser::MissingArgument.new("Please provide AUTH and PRIVACY passphrase") if 
+          @options.version == :SNMPv3 && 
+          (@options.auth_passphrase.nil? || @options.privacy_passphrase.nil?)
+
+          raise OptionParser::MissingArgument.new("No hostname provided") if $stdin.tty? && argv.empty? && !@options.in_filename
+
+          @options.host = argv.shift
+          @options.oids = argv unless argv.empty?
+
+          STDERR.puts @options if $DEBUG
+
+        rescue OptionParser::ParseError => e
+          STDERR.puts e.message, "\n", opts
+          exit(-1)
+        end
+
+
+      end #OptionParser.new
+
+    end #parse(argv)
+
+  end #class Options
+end # module SnmpDumper

data/lib/runner.rb

@@ -0,0 +1,40 @@
+require 'walker'
+require 'snmpwalk_reader'
+require 'options'
+
+Dir.glob(File.join(File.dirname(__FILE__), 'dumper/*.rb')).each {|f| require f }
+
+module SnmpDumper
+  class Runner
+    def initialize(argv)
+      @options = Options.new(argv)
+    end
+
+    def run
+      begin
+        ## interactive shell?
+        if !$stdin.tty? || @options.options.inputfile then
+          walker = SnmpwalkReader.new(@options.options)
+        else
+          walker = Walker.new(@options.options)
+        end
+
+        dumper = SnmpDumper.const_get(@options.options.dumper)::new(@options.options)
+
+        walker.walk(dumper)
+
+        if @options.options.out_filename
+          File.open(@options.options.out_filename, 'w') { |f| f.write(dumper.dump) }  
+        else
+          puts dumper.dump
+        end
+
+      rescue Exception => e
+        STDERR.puts e.message
+        STDERR.puts e.backtrace.join("\n") if $DEBUG
+        exit(-1)
+      end
+      exit(0)
+    end
+  end
+end

data/lib/snmpwalk_reader.rb

@@ -0,0 +1,85 @@
+module SnmpDumper
+  class SnmpwalkReader
+    CLASS_CALLBACK = {
+      "Gauge32" => lambda { |value| SNMP::Gauge32.new(Integer(value)) },
+      "Counter32" => lambda { |value| SNMP::Counter32.new(Integer(value)) },
+      "Counter64" => lambda { |value| SNMP::Counter64.new(Integer(value)) },
+      "Hex-STRING" => lambda { |value| SNMP::OctetString.new(value) },
+      "IpAddress" => lambda { |value| SNMP::IpAddress.new(value) },
+      "OID" => lambda { |value|
+        value.strip!
+        /^\.?((?:\d+\.)*\d+)$/ =~ value
+        raise ArgumentError, value if Regexp.last_match(0).nil?
+        SNMP::ObjectId.new(Regexp.last_match(1))
+        }, "Timeticks" => lambda { |value|
+          value.strip!
+          /^\((\d+)\).*$/ =~ value
+          raise value if Regexp.last_match(0).nil?
+          SNMP::TimeTicks.new(Integer(Regexp.last_match(1)))
+          }, "INTEGER" => lambda { |value|
+            /^(.*\()*(\d+)(\))*$/ =~ value
+            return nil if Regexp.last_match(0).nil?
+            SNMP::Integer.new(Integer(Regexp.last_match(2)))
+            },
+          }
+
+
+    def initialize(options)
+      STDERR.puts "SnmpwalkReader: initialize" if $DEBUG
+      @options = options
+    end
+
+    def parse_snmpwalk_line(line)
+      result = {}
+      /^(\.?\d+(?:\.?\d)+)\s*=\s*([^:]+):\s*\"?([^"]*)\"?$/ =~ line
+
+      if Regexp.last_match(0).nil?
+        raise ArgumentError,  "Invalid line: #{line}"
+      end
+      result = {:oid => Regexp.last_match(1), :class => Regexp.last_match(2) }
+      callback = CLASS_CALLBACK[result[:class]]
+
+      value = Regexp.last_match(3)
+      value = callback.call(value) if callback
+      result[:value] = value
+
+      STDERR.puts "SnmpwalkReader: oid = #{result[:oid]} / class = #{result[:class]} / value = #{result[:value]}" if $DEBUG
+      result
+    end
+
+    def walk(dumper)
+      STDERR.puts "SnmpwalkReader: walk start" if $DEBUG
+
+      if $stdin.tty? || @options.in_filename then
+        STDERR.puts "SnmpwalkReader: read from file #{@options.in_filename}" if $DEBUG
+        input = File.open(@options.in_filename, 'r')
+      else
+        STDERR.puts "SnmpwalkReader: read from stdin" if $DEBUG
+        input = $stdin
+      end
+
+      input.each_line do |line|
+        line.rstrip! # Remove trailing newline
+        STDERR.puts "SnmpwalkReader: processing line #{line}" if $DEBUG
+
+        begin
+          result = parse_snmpwalk_line line
+          dumper.add_snmp_var({:name => result[:oid], :value => result[:value]})
+        rescue Exception => e
+          raise ArgumentError, "Error encountered while parsing the line (-f ignore errors): \n
+          #{line}\n
+          Format for input:\n
+          <numerical oid> = <Type>: <value>\n
+          Example: .1.3.6.1.2.1.1.1.0 = STRING: Linux host.local 2.6.17.6 #1 SMP Thu Mar 8 15:32:13 CET 2007 i686\n
+          snmpwalk command example: snmpwalk -v 3 -u user -A PW -X PW -a MD5 -x DES -l authPriv -On -Oa 192.168.1.1" unless @options.force
+        end
+
+      end
+
+      input.close
+
+      STDERR.puts "SnmpwalkReader: walk start" if $DEBUG
+
+    end
+  end
+end

data/lib/walker.rb

@@ -0,0 +1,53 @@
+%w(snmp).each { |f| require f }
+
+module SnmpDumper
+  class Walker
+    def initialize(options)
+      @options = options
+    end
+
+    def walk(dumper)
+      snmpconfig = { :Host => @options.host, :Port => @options.port, :Version => @options.version}
+
+      snmpconfig.merge!({:Timeout => @options.timeout }) if @options.timeout
+      snmpconfig.merge!({:Retries => @options.retries }) if @options.retries
+
+      if @options.version == :SNMPv3 then
+        snmpconfig.merge! Hash.new()
+      else
+        snmpconfig.merge! :Community => @options.community
+      end
+
+      STDERR.puts snmpconfig if $DEBUG
+      manager = SNMP::Manager.new(snmpconfig)
+
+      model = @options.model || manager.get_value('sysDescr.0')
+
+      dumper.model = model
+      dumper.category = @options.category
+      
+      (1..@options.walks).each do |i|
+        STDERR.puts "Walk #{i}/#{@options.walks}: start" if $DEBUG
+
+        @options.oids.each do |oid|
+          begin
+            manager.walk(oid) do |var_bind|
+              dumper.add_snmp_var({:name => var_bind.name, :value => var_bind.value})
+            end
+          rescue SNMP::RequestTimeout => e
+            raise e if dumper.snmp_vars.empty?
+          end
+        end
+
+        STDERR.puts "Walk #{i}/#{@options.walks}: end" if $DEBUG
+        if i != @options.walks then
+          STDERR.puts "Sleep for #{@options.interval} seconds" if $DEBUG
+          sleep @options.interval 
+        end
+      end
+      manager.close
+
+    end # (1..@options.walks).each
+
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: snmpdumper
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Sebastian de Castelberg
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-23 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: snmp
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.0.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.1.2
+    version: 
+description: Dump snmp walks in various formats
+email: snmpdumper@kpricorn.org
+executables: 
+- snmpdumper
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- LICENSE
+- bin/snmpdumper
+- lib/dumper/jalasoft_dumper.rb
+- lib/dumper/simple_text_dumper.rb
+- lib/options.rb
+- lib/runner.rb
+- lib/snmpwalk_reader.rb
+- lib/walker.rb
+has_rdoc: true
+homepage: http://github.com/sdecastelberg/snmpdumper
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Dumps SNMP walk output in different format.
+test_files: []
+