netcrawl 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e88a7108f8469c3a858d557c74ffea3a00f4ed7e
+  data.tar.gz: e80b670c19a52eda6e64b59408ec18aee2528653
+SHA512:
+  metadata.gz: 9a0ad9ec096098a890da9214f1fc97a10d3de0d279c4a39e70c41992583de1e5310cf1f604bdc1181267754f9226fc1bd040ec3aa174714d50c98b0ce3917266
+  data.tar.gz: a5519ab481db54c1c4cd7b6259b59e36e4b59261b3f72fa22c04575a2b69e53f0e1a8633fdbacaf041aeae5ab79baf14fedf82aed9257237030050044f70b048

data/lib/netcrawl.rb

@@ -16,9 +16,9 @@ class NetCrawl
   def get host
     peers = []
     @methods.each do |method|
-      peers += method.send(:get, host)
+      peers += method.send(:peers, host)
     end
-    peers.uniq
+    peers.uniq { |peer| peer.ip }
   end
 
   # Given string of IP address, recurses through peers seen and populates @hosts hash
@@ -28,9 +28,9 @@ class NetCrawl
     peers = get host
     @hosts[host] = peers
     peers.each do |peer|
-      next if     @hosts.has_key? peer
-      next unless @poll.include?  peer
-      crawl peer
+      next if     @hosts.has_key? peer.ip
+      next unless @poll.include?  peer.ip
+      crawl peer.ip
     end
   end
 
@@ -46,7 +46,7 @@ class NetCrawl
         file = 'netcrawl/method/' + method.downcase
         require_relative file
         @methods.push NetCrawl.const_get(method)
-      rescue NameError, LoadError => error
+      rescue NameError, LoadError
         raise MethodNotFound, "unable to find method '#{method}'"
       end
     end
@@ -56,8 +56,7 @@ class NetCrawl
 end
 require_relative 'netcrawl/pollmap'
 require_relative 'netcrawl/namemap'
-require_relative 'netcrawl/pollmap'
-require_relative 'netcrawl/method/cdp'
-require_relative 'netcrawl/method/lldp'
+require_relative 'netcrawl/peer'
+require_relative 'netcrawl/method/xdp'
 require_relative 'netcrawl/dns'
 require_relative 'netcrawl/output'

data/lib/netcrawl/cli.rb

@@ -8,8 +8,8 @@ class NetCrawl
 
     def run
       output = NetCrawl.new.crawl @host
-      output.clean   if @opts[:purge]
-      output.resolve if @opts[:resolve]
+      output.clean!   if @opts[:purge]
+      output.resolve! if @opts[:resolve]
       if @opts[:graphviz]
         output.to_dot
       elsif @opts[:list]
@@ -36,12 +36,13 @@ class NetCrawl
       @host = DNS.getip args.shift
       CFG.snmp.community = @opts[:community] if @opts[:community]
       CFG.debug          = true if @opts[:debug]
+      CFG.ipname         = true if @opts[:ipname]
       raise MissingHost, 'no hostname given as argument' unless @host
     end
 
 
     def opt_parse
-      opts = Slop.parse(:help=>true) do
+      Slop.parse(:help=>true) do
         banner 'Usage: netcrawl [options] hostname'
         on 'g',  'graphviz',  'dot output use \'dot -Tpng -o map.png map.dot\''
         on 'l',  'list',      'list nodes'
@@ -52,6 +53,7 @@ class NetCrawl
         on 'p',  'purge',     'remove peers not in configured CIDR'
         on 'c=', 'community', 'SNMP community to use'
         on 'd',  'debug',     'turn debugging on'
+        on 'i',  'ipname',    'use rev(ip) name instead of discovered name'
       end
     end
 

data/lib/netcrawl/config.rb

@@ -13,6 +13,7 @@ class NetCrawl
   Config.default.snmp.retries    = 2
   Config.default.snmp.bulkrows   = 35    # 1500B packet should fit about 50 :cdpCacheAddress rows
   Config.default.dot.bothlinks   = false # keep both a-b and b-a links
+  Config.default.dot.linklabels  = true  # label link with interface names
   Config.default.dot.color       = [     # regexp of host => color
     [ 'cpe', 'gold'   ],
     [ '-sw', 'blue'   ],

data/lib/netcrawl/method/cdp.rb

@@ -1,32 +1,32 @@
-require_relative '../snmp'
 class NetCrawl
-  class CDP
-    include NameMap
+  class CDP < XDP
+    MIB = '1.3.6.1.4.1.9.9.23'  # ciscoCdpMIB
     OID = {
       # http://tools.cisco.com/Support/SNMP/do/BrowseOID.do?local=en&translate=Translate&objectInput=1.3.6.1.4.1.9.9.23.1.2.1.1
-      :cdpCacheAddress  => '1.3.6.1.4.1.9.9.23.1.2.1.1.4',
-      :cdpCacheDeviceId => '1.3.6.1.4.1.9.9.23.1.2.1.1.6',
+      :cdpInterfaceName   => '1.3.6.1.4.1.9.9.23.1.1.1.1.6',
+      :cdpCacheAddress    => '1.3.6.1.4.1.9.9.23.1.2.1.1.4',
+      :cdpCacheDeviceId   => '1.3.6.1.4.1.9.9.23.1.2.1.1.6',
+      :cdpCacheDevicePort => '1.3.6.1.4.1.9.9.23.1.2.1.1.7',
     }
-
-    # @param [String] host host to query
-    # @return [Hash] neighbor information
-    def self.get host
-      cdp = new(host)
-      cdp.peers
-    end
-
-    def peers
-      addrs = @snmp.walk2hash(OID[:cdpCacheAddress])  { |vb| vb.as_ip }
-      names = @snmp.walk2hash(OID[:cdpCacheDeviceId]) { |vb| DNS.getip namemap(vb.value) }
-      names.keys.map { |id| names[id] or addrs[id] }.compact
-    rescue SNMP::NoResponse
-      []
-    end
+    PEERS_BY = OID[:cdpCacheDeviceId]
 
     private
 
-    def initialize host
-      @snmp = SNMP.new host
+    def make_peers
+      peers = []
+      @mib.by_oid(PEERS_BY).each do |_, vb|
+        peer          = Peer.new
+        peer_id       = vb.oid_id(PEERS_BY)
+        peer.oid      = get_oid_hash peer_id
+        peer.raw_ip   = @mib[OID[:cdpCacheAddress], peer_id].as_ip
+        peer.raw_name = @mib[OID[:cdpCacheDeviceId], peer_id].value
+        peer.ip       = get_ip peer.raw_ip, peer.raw_name
+        peer.dst      = @mib[OID[:cdpCacheDevicePort], peer_id].value
+        peer.src      = @mib[OID[:cdpInterfaceName], peer_id.first].value
+        peer.raw_ip   = @mib[OID[:cdpCacheAddress], peer_id].value
+        peers << peer
+      end
+      peers
     end
 
   end

data/lib/netcrawl/method/lldp.rb

@@ -1,7 +1,6 @@
-require_relative '../snmp'
 class NetCrawl
-  class LLDP
-    include NameMap
+  class LLDP < XDP
+    MIB = '1.0.8802.1.1.2' # lldpMIB
     OID = {
       # http://standards.ieee.org/getieee802/download/802.1AB-2009.pdf
       # finding IP address for LLDP neighbour as of JunOS 13.3R1 and IOS 15.0(2)SG8 is not practical
@@ -13,34 +12,40 @@ class NetCrawl
       #   in IOS it was usable address
       #   .1.0.8802.1.1.2.1.4.2.1.3.0.257.1.1.4.62.243.146.245
       #   (1.4 is IPv4)
+      #  as well LocPortId/RemPortId is hard, it is 'local' (snmpifindex really) in JunOS, but ifName in IOS
+      :lldpLocPortId           => '1.0.8802.1.1.2.1.3.7.1.3',
       :lldpRemChassisIdSubtype => '1.0.8802.1.1.2.1.4.1.1.4', # CSCO and JNPR use 4 (MAC address) rendering ChassisID useless
       :lldpRemChassisId        => '1.0.8802.1.1.2.1.4.1.1.5',
+      :lldpRemPortIdSubtype    => '1.0.8802.1.1.2.1.4.1.1.6',
+      :lldpRemPortId           => '1.0.8802.1.1.2.1.4.1.1.7',
       :lldpRemSysName          => '1.0.8802.1.1.2.1.4.1.1.9',
       :lldpRemManAddrIfSubtype => '1.0.8802.1.1.2.1.4.2.1.3',
     }
-
-    # @param [String] host host to query
-    # @return [Hash] neighbor information
-    def self.get host
-      lldp = new(host)
-      lldp.peers
-    end
-
-    def peers
-      addrs = @snmp.walk2hash(OID[:lldpRemManAddrIfSubtype]) do |vb|
-        key = vb.oid[OID[:lldpRemManAddrIfSubtype].split('.').size .. -7]
-        [vb.oid.last(4).join('.'), key]
-      end  # FIXME: I am IPv4 specific and generally dodgy
-      names = @snmp.walk2hash(OID[:lldpRemSysName]) { |vb| DNS.getip namemap(vb.value) }
-      names.keys.map { |id| names[id] or addrs[id] }.compact
-    rescue SNMP::NoResponse
-      []
-    end
+    PEERS_BY = OID[:lldpRemChassisId]
+    PortSubType = {
+      :mac_address => 3,
+    }
 
     private
 
-    def initialize host
-      @snmp = SNMP.new host
+    def make_peers
+      peers = []
+      @mib.by_oid(PEERS_BY).each do |_, vb|
+        peer          = Peer.new
+        peer_id       = vb.oid_id(PEERS_BY)
+        peer.oid      = get_oid_hash peer_id
+        ip            = @mib.by_partial OID[:lldpRemManAddrIfSubtype], peer_id
+        peer.raw_ip   = ip.oid[-4..-1].join('.') if ip # FIXME: IPv4 specific 
+        peer.raw_name = @mib[OID[:lldpRemSysName], peer_id].value
+        peer.ip       = get_ip peer.raw_ip, peer.raw_name
+        peer.dst      = @mib[OID[:lldpRemPortId], peer_id].value
+        if @mib[OID[:lldpRemPortIdSubtype], peer_id].value.to_i == PortSubType[:mac_address]
+          peer.dst    = peer.dst.each_char.map{|e|"%02x" % e.ord}.join.scan(/..../).join('.')
+        end
+        peer.src      = @mib[OID[:lldpLocPortId], peer_id[1]].value
+        peers << peer
+      end
+      peers
     end
 
   end

data/lib/netcrawl/method/xdp.rb

@@ -0,0 +1,41 @@
+require_relative '../snmp'
+class NetCrawl
+  class XDP
+    attr_reader :mib
+    include NameMap
+
+    # @param [String] host host to query
+    # @return [Array(NetCrawl::Peer)] neighbor information
+    def self.peers host
+      new(host).poll
+    end
+
+    def poll
+      @mib = @snmp.hashwalk self.class::MIB
+      make_peers
+    rescue SNMP::NoResponse
+      []
+    end
+
+    private
+
+    def initialize host
+      @snmp = SNMP.new host
+    end
+
+    def get_ip ip, name
+      name = DNS.getip namemap(name)
+      name or ip
+    end
+
+    def get_oid_hash peer_id
+      oid_hash = {}
+      self.class::OID.each do |name, oid|
+        oid_hash[name] = @mib[oid, peer_id]
+      end
+      oid_hash
+    end
+  end
+end
+require_relative 'cdp'
+require_relative 'lldp'

data/lib/netcrawl/output.rb

@@ -1,64 +1,66 @@
 class NetCrawl
   class Output
-    attr_reader :iphash, :namehash, :hash
+    attr_reader :peers, :resolve
 
     # @return [String] pretty print of hash
     def to_hash
       require 'pp'
       out = ''
-      PP.pp @hash, out
+      PP.pp to_h, out
       out
     end
 
     # @return [String] yaml of hosts and peers found
     def to_yaml
       require 'yaml'
-      YAML.dump @hash
+      YAML.dump to_h
     end
 
     # @return [String] json of hosts and peers found
     def to_json
       require 'json'
-      JSON.pretty_generate @hash
+      JSON.pretty_generate to_h
     end
 
     # @return [Array] of nodes found
     def to_list
       nodes = []
-      @hash.each do |host, peers|
+      @peers.each do |host, peers|
         nodes << host
-        nodes << peers
+        peers.each do |peer|
+          nodes.push @resolve ? peer.name : peer.ip
+        end
       end
       nodes.flatten.uniq.sort
     end
 
-    # resolves ip addresses and changes @hash to point to the resolved hash
+    # resolves ip addresses of peers and @peers keys
     # @return [void]
-    def resolve
-      @namehash = {}
-      @iphash.each do |host, peers|
-        host = DNS.getname host
-        @namehash[host] = []
-        peers.each do |peer|
-          @namehash[host].push DNS.getname(peer)
-        end
+    def resolve!
+      @resolve = true
+      newpeers = {}
+      @peers.each do |host, peers|
+        peers.each { |peer| peer.name }
+        name = DNS.getname host
+        newpeers[name] = peers
       end
-      @hash = @namehash
+      @peers = newpeers
     end
 
-    # remove peers not matchin configured CIDR
-    def clean
-      @hash.each do |host, peers|
-        peers = peers.delete_if{|peer|not @pollmap.include? peer}
+    # remove peers not matching to configured CIDR
+    # @return [void]
+    def clean!
+      @peers.each do |host, peers|
+        peers.delete_if{|peer|not @pollmap.include? peer.ip}
       end
     end
 
     private
 
-    def initialize hash, pollmap
-      @iphash  = hash
-      @hash    = @iphash
+    def initialize peers, pollmap
+      @peers   = peers
       @pollmap = pollmap
+      @resolve = false
     end
 
     def method_missing name, *args
@@ -68,5 +70,17 @@ class NetCrawl
       output = NetCrawl::Output.const_get output.capitalize
       output.send :output, self
     end
+
+    def to_h
+      hash = {}
+      @peers.each do |host, peers|
+        ary = []
+        peers.each do |peer|
+          ary << peer.to_hash
+        end
+        hash[host] = ary
+      end
+      hash
+    end
   end
 end

data/lib/netcrawl/output/dot.rb

@@ -10,13 +10,16 @@ class NetCrawl
       def to_s
         str = "graph NetCrawl {\n"
         @output.to_list.each do |host|
-          str << INDENT + id(host) + "[color=\"#{color(host)}\"]\n"
-          str << INDENT + id(host) + "[label=\"#{host}\"]\n"
-          if @hash.has_key? host
-            @hash[host].each do |peer|
-              next if not CFG.dot.bothlinks and @connections.include?([peer, host].sort)
-              @connections << [peer, host].sort
-              str << INDENT + INDENT + id(host) + ' -- ' + id(peer) + "\n"
+          host_label = label(host)
+          str << INDENT + id(host) + "[label=\"#{host_label}\" color=\"#{color(host_label)}\"]\n"
+          if @peers.has_key? host
+            @peers[host].each do |peer|
+              peer_name = @resolve ? peer.name : peer.ip
+              next if not CFG.dot.bothlinks and @connections.include?([peer_name, host].sort)
+              @connections << [peer_name, host].sort
+              labels = ''
+              labels = "[headlabel=\"#{peer.dst.to_s}\" taillabel=\"#{peer.src.to_s}\"]" if CFG.dot.linklabel
+              str << INDENT + INDENT + id(host) + ' -- ' + id(peer_name) + labels + "\n"
             end
           end
         end
@@ -29,7 +32,8 @@ class NetCrawl
       def initialize output
         @output      = output
         @connections = []
-        @hash        = @output.hash
+        @peers       = @output.peers
+        @resolve     = @output.resolve
       end
 
       def id host
@@ -37,6 +41,22 @@ class NetCrawl
         '_' + host
       end
 
+      def label wanthost
+        label = nil
+        return wanthost if CFG.ipname == true
+        @peers.each do |host, peers|
+          peers.each do |peer|
+            gothost = @resolve ? peer.name : peer.ip
+            if wanthost == gothost
+              label = peer.raw_name
+              break
+            end
+          end
+          break if label
+        end
+        label or wanthost
+      end
+
       def color host
         color = nil
         CFG.dot.color.each do |re, clr|

data/lib/netcrawl/peer.rb

@@ -0,0 +1,31 @@
+class NetCrawl
+  class Peer
+    attr_accessor :ip, :raw_ip, :raw_name, :src, :dst, :oid
+    def initialize
+      @ip       = nil  # Best guess of system IP
+      @name     = nil  # Reverse of said IP
+      @raw_ip   = nil  # IP as seen in polling
+      @raw_name = nil  # Name as seen in polling
+      @src      = nil  # SRC/local interface
+      @dst      = nil  # DSR/remote interface
+      @oid      = {}   # Hash of oids collected
+    end
+    def name
+      @name ||= DNS.getname @ip
+    end
+    def to_hash
+      {
+        'ip'   => ip.to_s,
+        'name' => name.to_s,
+        'interface' => {
+           'source' => src.to_s,
+           'destination' => dst.to_s,
+        },
+        'raw' => {
+          'ip'   => raw_ip.to_s,
+          'name' => raw_name.to_s,
+        },
+      }
+    end
+  end
+end

data/lib/netcrawl/snmp.rb

@@ -39,20 +39,16 @@ class NetCrawl
       results
     end
 
-    # bulkwalks oid returning hash based on block block gets SNMP::VarBind and
-    # shold rturn either hash_value or [hash_value, hash_key]
-    # if block does not return hash_key, hash_key is oid-root, e.g. if root is
-    # 1.2 and oid is 1.2.3.4.5 then key is 3.4.5
+    # bulkwalks oid and returns hash with oid as key
     # @param [String] oid root oid to walk
-    # @yield [SNMP::VarBind] gives vb to block, expect back hash_value or [hash_value, hash_key]
+    # @yield [VBHash] hash containing oids found
     # @return [Hash] resulting hash
-    def walk2hash oid, &block
-      index = oid.split('.').size
-      hash  = {}
+    def hashwalk oid, &block
+      hash  = VBHash.new
       bulkwalk(oid).each do |vb|
-        value, key = block.call(vb)
-        key ||= vb.oid[index..-1]
-        hash[key] = value
+        #value, key = block.call(vb)
+        key ||= vb.oid
+        hash[key] = vb
       end
       hash
     end
@@ -74,13 +70,72 @@ class NetCrawl
       raise NoResponse, msg
     end
 
+    # Hash with some helper methods to easier work with VarBinds
+    class VBHash < Hash
+      alias :org_bracket :[]
+      undef :[]
+
+      # @param [Array(Strin, Array)] oid root oid under which you want all oids below it
+      # @return [VBHash] oids which start with param oid
+      def by_oid *oid
+        oid = arg_to_oid(*oid)
+        hash = select do |key, value|
+          key[0..oid.size-1] == oid
+        end
+        newhash = VBHash.new
+        newhash.merge hash
+      end
+
+      # @param [Array(String, Array)] args partial match 3.4.6 would match to 1.2.3.4.6.7.8
+      # @return [SNMP::VarBind] matching element
+      def by_partial *args
+        oid = arg_to_oid(*args)
+        got = nil
+        keys.each do |key|
+          if key.each_cons(oid.size).find{|e|e==oid}
+            got = self[key]
+            break
+          end
+        end
+        got
+      end
+
+      # @param [Array[String, Array)] key which you want, multiple arguments compiled into single key
+      # @return [SNMP::VarBind] matching element
+      def [] *args
+        org_bracket arg_to_oid(*args)
+      end
+
+      private
+
+      def arg_to_oid *args
+        key = []
+        args.each do |arg|
+          if Array === arg
+            key += arg.map{|e|e.to_i}
+          elsif Fixnum === arg
+            key << arg
+          else
+            key += arg.split('.').map{|e|e.to_i}
+          end
+        end
+        key
+      end
+    end
   end
 end
 
 module SNMP
   class VarBind
+    # @return [String] VarBind value as IP address
     def as_ip
       SNMP::IpAddress.new(value).to_s
     end
+    # @param [String] root oid which is removed from self.oid
+    # @return [Array] oid remaining after specified root oid
+    def oid_id root
+      root = root.split('.').map{|e|e.to_i}
+      oid[root.size..-1]
+    end
   end
 end

data/netcrawl.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name              = 'netcrawl'
-  s.version           = '0.0.2'
+  s.version           = '0.0.3'
   s.platform          = Gem::Platform::RUBY
   s.authors           = [ 'Saku Ytti' ]
   s.email             = %w( saku@ytti.fi )

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: netcrawl
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - Saku Ytti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-31 00:00:00.000000000 Z
+date: 2014-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: snmp
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: asetus
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -79,40 +72,35 @@ files:
 - lib/netcrawl/dns.rb
 - lib/netcrawl/method/cdp.rb
 - lib/netcrawl/method/lldp.rb
+- lib/netcrawl/method/xdp.rb
 - lib/netcrawl/namemap.rb
 - lib/netcrawl/output.rb
 - lib/netcrawl/output/dot.rb
+- lib/netcrawl/peer.rb
 - lib/netcrawl/pollmap.rb
 - lib/netcrawl/snmp.rb
 - netcrawl.gemspec
 homepage: http://github.com/ytti/netcrawl
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2137776821860602171
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2137776821860602171
 requirements: []
 rubyforge_project: netcrawl
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: lldp/cdp crawler
 test_files: []