netdisco 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a0ce0d6214b2a7b6c2b0619f00c82a84656ad9c1b784336305f9bde8587fbfc8
+  data.tar.gz: f3d6b2d3ae31913f42f24ff065146a737da60cf38e36d2d6064ccb59e3e90aaf
+SHA512:
+  metadata.gz: fd1ae67b1b81632bf30e4166c1eb45c890352bf10e56bd14c1e6983943c09b3fff5449dba27ea2f23e7296477b25236720f1ecb7d2070792aa2e0aaea4437717
+  data.tar.gz: 71c515cfdc3ff4d03167053df28d64364381416f38e73273d7565292deb34ad670df87dbfc8a15378f94fa942c0d6a7b5b819fdd52cc3ce8f92e4c4bc2591cf9

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-04-14
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at careline@foxmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 WENWU.YAN
+
+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.md

@@ -0,0 +1,117 @@
+# netdisco
+
+Given snmp community and single device, discover the network via discovering
+LLDP/CDP neighbours, while producing list or dot file (for graphviz digraphs)
+
+## Install
+
+% gem install netdisco
+
+## Use
+
+% netdisco --graphiz router.example.com
+
+## Command line
+
+```shell
+Usage: netdisco [options] hostname
+    -g, --graphviz       dot output use 'dot -Tpng -o map.png map.dot'
+    -l, --list           list nodes
+    -j, --json           json output
+    -y, --yaml           yaml output
+    -a, --hash           hash/associative array output
+    -r, --resolve        resolve addresses to names
+    -p, --purge          remove peers not in configured CIDR
+    -c, --community      SNMP community to use
+    -d, --debug          turn debugging on
+    -h, --help           Display this help message.
+
+```
+
+* graphiz - graphis (dot) output
+* list - list nodes found
+* json - json output
+* yaml - yaml output
+* hash - ruby hash output
+* resolve - resolve IP addresses
+* purge - remove non-cidr matching peers from output
+* community - sets snmp community
+* debug - turn on debugging
+
+## Config
+
+```yaml
+---
+use:
+  - LLDP
+  - CDP
+poll:
+  - 192.0.2.0/24
+snmp:
+  community: public
+  timeout: 1
+  retries: 2
+  bulkrows: 35
+dot:
+  bothlinks: true
+  color:
+    - - cpe
+      - gold
+    - - -sw
+      - blue
+    - - -pe
+      - red
+    - - ' -p'
+      - yellow
+dns:
+  afi:
+log: STDERR
+debug: false
+namemap:
+  - - -re\d+
+    - ''
+  - - (.*(?<!as23456.net)$)
+    - \1.as23456.net
+```
+
+* use - methods to use for crawling
+* poll - cidrs to allow snmp for
+* snmp community - snmp community to use
+* snmp timout - snmp timout in seconds
+* snmp retries - snmp retries count
+* snmp bulkrows - snmp row count for bulkget
+* dot bothlinks - show a-b and b-a link
+* dot color - regexp to color, first hit used
+* dns afi - ipv4/ipv6 or nil
+* log - STDERR/STDOUT or file
+* debug - debugging
+* namemap - map (LLDP) name to FQDN (JunOS does not give domain)
+
+## Library use
+
+require 'netdisco'
+output = netdisco.new.discover('192.0.2.1').to_hash
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the
+version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/netdisco. This project is intended
+to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
+the [code of conduct](https://github.com/ciscolive/netdisco-ruby/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Netdisco project's codebases, issue trackers, chat rooms and mailing lists is expected to
+follow the [code of conduct](https://github.com/ciscolive/netdisco-ruby/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/bin/netdisco

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+begin
+  require "netdisco/cli"
+  puts Netdisco::CLI.new.run
+rescue StandardError => e
+  warn e.to_s
+  raise if Netdisco::CFG.debug
+end

data/lib/netdisco/cli.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative "../netdisco"
+require "slop"
+
+class Netdisco
+  class CLI
+    class MissingHost < NetdiscoError; end
+
+    class NoConfig < NetdiscoError; end
+
+    # 网络邻居发现入口函数
+    def run
+      output = Netdisco.new.discover @host
+
+      # 邻居关系发现后修正处理逻辑钩子函数
+      output.clean! if @opts[:purge]
+      output.resolve! if @opts[:resolve]
+      # 将计算结果转换格式打印
+      if @opts[:graphviz]
+        output.to_dot
+      elsif @opts[:list]
+        output.to_a
+      elsif @opts[:json]
+        output.to_json
+      elsif @opts[:yaml]
+        output.to_yaml
+      else
+        output.to_hash
+      end
+    end
+
+    # 类对象初始化入口函数
+    def initialize
+      raise NoConfig, "edit ~/.config/netdisco/config" if CONFIG.create
+      args, @opts = opt_parse
+      @host       = DNS.getip args.shift
+      raise MissingHost, "no hostname given as argument" unless @host
+
+      CFG.snmp.community = @opts[:community] if @opts[:community]
+      CFG.debug          = true if @opts[:debug]
+      CFG.ipname         = true if @opts[:ipname]
+    end
+
+    # CLI 命令行交互解析
+    def opt_parse
+      opts = Slop.parse do |o|
+        o.on "-h", "--help", "show usage" do
+          puts o
+          exit
+        end
+        o.on "-g", "--graphviz", "dot output use 'dot -Tpng -o map.png map.dot'"
+        o.on "-l", "--list", "list nodes"
+        o.on "-j", "--json", "json output"
+        o.on "-y", "--yaml", "yaml output"
+        o.on "-a", "--hash", "hash/associative array output"
+        o.on "-r", "--resolve", "resolve addresses to names"
+        o.on "-p", "--purge", "remove peers not in configured CIDR"
+        o.string "-c=", "--community", "SNMP community to use"
+        o.bool "-d", "--debug", "turn debugging on"
+        o.bool "-i", "--ipname", "use rev(ip) name instead of discovered name"
+        o.on "-v", "--version", "print the version" do
+          puts Slop::VERSION
+          exit
+        end
+      end
+      [opts.arguments, opts]
+    end
+  end
+end

data/lib/netdisco/config.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "strada"
+require "logger"
+
+class Netdisco
+  # 实例化配置对象
+  CONFIG = Strada.new name: "netdisco", load: false
+
+  # 设置默认参数
+  CONFIG.default.use            = %w(LLDP CDP)
+  CONFIG.default.poll           = %w[192.168.8.0/24]
+  CONFIG.default.snmp.community = "cisco"
+  CONFIG.default.snmp.timeout   = 15
+  CONFIG.default.snmp.retries   = 1
+  CONFIG.default.snmp.bulkrows  = 30 # 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
+    %w[cpe gold],
+    %w[-sw blue],
+    %w[-pe red],
+    %w[-p yellow],
+  ]
+  CONFIG.default.dns.afi        = nil # could be 'ipv4' or 'ipv6'
+  CONFIG.default.log            = "STDERR"
+  CONFIG.default.debug          = true
+  CONFIG.default.name_map       = [# regexp match+sub of hostname (needed for LLDP)
+    ['-re\d+', ""],
+    ["^KILLME(.*(?<!mojo.local)$)", '\1.mojo.local'], # adds missing domain name
+  ]
+  # 加载配置并设置对应常量
+  CONFIG.load
+  CFG = CONFIG.cfg
+  # 设置项目日志参数
+  log       = CFG.log
+  log       = STDERR if log == "STDERR"
+  log       = STDOUT if log == "STDOUT"
+  Log       = Logger.new log
+  Log.level = Logger::INFO
+  Log.level = Logger::DEBUG if CFG.debug
+end

data/lib/netdisco/dns.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "resolv"
+
+class Netdisco
+  class Resolve
+    # 对象实例化入口函数
+    def initialize
+      @cache_ip   = {}
+      @cache_name = {}
+    end
+
+    # @param [String] name DNS name which we try to resolve to IP
+    # @return [String, nil] string if name resolves to IP, otherwise nil
+    # 优先加载缓存，不能存在则实时采集
+    def getip(name)
+      if @cache_ip.has_key? name
+        @cache_ip[name]
+      else
+        # 可能一个 name 同时存在 IPV4 和 IPV6  解析
+        begin
+          if CFG.dns.afi == "ipv4"
+            @cache_ip[name] = Resolv::DNS.new.getresource(name, Resolv::DNS::Resource::IN::A).address
+          elsif CFG.dns.afi == "ipv6"
+            @cache_ip[name] = Resolv::DNS.new.getresource(name, Resolv::DNS::Resource::IN::AAAA).address
+          else
+            @cache_ip[name] = Resolv.getaddress name
+          end
+        rescue => error
+          Log.debug "DNS resolution for '#{name}' raised error '#{error.class}' with message '#{error.message}'"
+          nil
+        end
+      end
+    end
+
+    # @param [String] ip DNS IP which we try to resolve to name
+    # @return [String] name if it resolves, ip otherwise
+    # 优先加载缓存，不能存在则实时采集
+    def getname(ip)
+      if @cache_name.has_key? ip
+        @cache_name[ip]
+      else
+        begin
+          @cache_name[ip] = Resolv.getname ip
+        rescue => error
+          Log.debug "DNS resolution for '#{ip}' raised error '#{error.class}' with message '#{error.message}'"
+          @cache_name[ip] = ip
+        end
+      end
+    end
+  end
+
+  DNS = Resolve.new
+end

data/lib/netdisco/method/cdp.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+class Netdisco
+  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
+      # cdpInterfaceName:   "1.3.6.1.2.1.31.1.1.1.18",
+      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",
+    }
+    PEERS_BY = OID[:cdpCacheDeviceId]
+
+    private
+      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]
+          peer.src      = peer.src&.value if peer.src
+          peer.raw_ip   = @mib[OID[:cdpCacheAddress], peer_id].value
+          peers << peer
+        end
+        peers
+      end
+  end
+end

data/lib/netdisco/method/lldp.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+class Netdisco
+  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
+      # ifsubtype is ifindex but value 0 for JunOS neighbours
+      # ifsubtype is systemportnumber for IOS neighbours (what ever that is)
+      # luckily some IP address is in the OID key itself, while dodgy, better than nothing
+      #   in JunOS it was some random RFC1918 address in VRF interface, not something I could poll
+      #   .1.0.8802.1.1.2.1.4.2.1.3.0.134.10.1.4.10.0.0.4
+      #   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",
+    }
+    PEERS_BY    = OID[:lldpRemChassisId]
+    PortSubType = {
+      mac_address: 3,
+    }
+
+    private
+      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_ip   ||= "192.0.2.255" # sometimes we can't fnd any IP (EX2200 talking Arista found)
+          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 rescue nil
+          peers << peer
+        end
+        peers
+      end
+  end
+end

data/lib/netdisco/method/xdp.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative "../snmp"
+
+class Netdisco
+  class XDP
+    # 类对象方法属性
+    attr_reader :mib
+
+    # 加载模块方法到类对象
+    include NameMap
+
+    # 对象实例化入口函数
+    def initialize(host)
+      @snmp = SNMP.new host
+    end
+
+    # 类属性方法
+    # @param [String] host host to query
+    # @return [Array(Netdisco::Peer)] neighbor information
+    def self.peers(host)
+      new(host).poll
+    end
+
+    # 轮询设备邻居关系
+    def poll
+      @mib = @snmp.hashwalk self.class::MIB
+      # require "pp"; PP.pp @mib
+      make_peers
+    rescue SNMP::NoResponse
+      []
+    end
+
+    private
+      def get_ip(ip, name)
+        DNS.getip(name_map(name)) || 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/netdisco/name_map.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class Netdisco
+  module NameMap
+    def name_map(origin_name)
+      name = origin_name.dup
+      CFG.name_map.each do |match, replace|
+        re   = Regexp.new match
+        name = name.sub re, replace
+      end
+      name
+    end
+  end
+end

data/lib/netdisco/output/dot.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+class Netdisco
+  class Output
+    class Dot
+      INDENT        = " " * 2
+      DEFAULT_COLOR = "black"
+      def self.output(output)
+        new(output).to_s
+      end
+
+      def to_s
+        str = "graph Netdisco {\n"
+        @output.to_a.each do |host|
+          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) && @connections.include?([peer_name, host].sort)
+              @connections << [peer_name, host].sort
+              labels = ""
+              labels = "[headlabel=\"#{peer.dst}\" taillabel=\"#{peer.src}\"]" if CFG.dot.linklabel
+              str << INDENT + INDENT + id(host) + " -- " + id(peer_name) + labels + "\n"
+            end
+          end
+        end
+        str += "}\n"
+        str
+      end
+
+      private
+        def initialize(output)
+          @output      = output
+          @connections = []
+          @peers       = @output.peers
+          @resolve     = @output.resolve
+        end
+
+        def id(host)
+          host = host.gsub(/[-.]/, "_")
+          "_" + host
+        end
+
+        def label(want_host)
+          label = nil
+          return want_host if CFG.ipname == true
+          @peers.each do |host, peers|
+            peers.each do |peer|
+              got_host = @resolve ? peer.name : peer.ip
+              if want_host == got_host
+                label = peer.raw_name
+                break
+              end
+            end
+            break if label
+          end
+          label or want_host
+        end
+
+        def color(host)
+          color = nil
+          CFG.dot.color.each do |re, clr|
+            if host.match re
+              color = clr
+              break
+            end
+          end
+          color or DEFAULT_COLOR
+        end
+    end
+  end
+end

data/lib/netdisco/output.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+class Netdisco
+  class Output
+    # 类对象属性
+    attr_reader :peers, :resolve, :poll_map
+
+    # 对象初始化入口函数
+    # 将邻居发现清单以及本地的轮询列表清单比对后，格式化输出相关数据
+    def initialize(peers, poll_map)
+      @peers    = peers
+      @poll_map = poll_map
+      @resolve  = false
+    end
+
+    # 动态方法
+    def method_missing(name, *args)
+      raise NoMethodError, "invalid method #{name} for #{inspect}:#{self.class}" unless name.match?(/to_.*/)
+      output = File.basename name[3..-1]
+      require_relative "output/" + output
+      output = Netdisco::Output.const_get output.capitalize
+      output.send :output, self
+    end
+
+    # 自动更新设备主机名，并更新解析状态
+    # resolves ip addresses of peers and @peers keys
+    # @return [void]
+    def resolve!
+      @resolve  = true
+      new_peers = {}
+      @peers.each do |host, peers|
+        peers.each { |peer| peer.name }
+        name            = DNS.getname host
+        new_peers[name] = peers
+      end
+      @peers = new_peers
+    end
+
+    # 自动移除非探测名单范围内的设备
+    # remove peers not matching to configured CIDR
+    # @return [void]
+    def clean!
+      @peers.values.each do |peers|
+        peers.delete_if { |peer| not @poll_map.include? peer.ip }
+      end
+    end
+
+    # @return [Hash] of nodes found
+    def to_h
+      hash = {}
+      @peers.each do |host, peers|
+        array = []
+        peers.each do |peer|
+          array << peer.to_h
+        end
+        hash[host] = array
+      end
+      hash
+    end
+
+    # @return [Array] of nodes found
+    def to_a
+      nodes = []
+      @peers.each do |host, peers|
+        nodes << host
+        peers.each do |peer|
+          nodes << @resolve ? peer.name : peer.ip
+        end
+      end
+      # 将 nodes 展开为属组并去重排序
+      nodes.flatten.uniq
+    end
+
+    # @return [String] pretty print of hash
+    def to_hash
+      require "pp"
+      out = ""
+      PP.pp to_h, out
+      out
+    end
+
+    # @return [String] yaml of hosts and peers found
+    def to_yaml
+      require "yaml"
+      YAML.dump to_h
+    end
+
+    # @return [String] json of hosts and peers found
+    def to_json
+      require "json"
+      JSON.pretty_generate to_h
+    end
+  end
+end

data/lib/netdisco/peer.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+class Netdisco
+  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 # DST/remote interface
+      @oid      = {} # Hash of oids collected
+    end
+
+    # 设置邻居名称
+    def name
+      @name ||= DNS.getname @ip
+    end
+
+    # 将邻居对象转换为 HASH
+    def to_h
+      {
+        "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/netdisco/poll_map.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "ipaddr"
+
+class Netdisco
+  class PollMap
+    attr_reader :poll
+
+    # 类对象初始化函数入口
+    def initialize
+      @poll = CFG.poll.map { |cidr| IPAddr.new cidr }
+    end
+
+    # 判断是否包含某个地址
+    def include?(addr)
+      @poll.any? { |cidr| cidr.include? addr }
+    end
+  end
+end

data/lib/netdisco/snmp.rb

@@ -0,0 +1,155 @@
+require "snmp"
+
+class Netdisco
+  class SNMP
+    class NetdiscoError < StandardError; end
+
+    class NoResponse < NetdiscoError; end
+
+    # 类对象初始化入口函数
+    def initialize(host, community = CFG.snmp.community, timeout = CFG.snmp.timeout, retries = CFG.snmp.retries)
+      @host = host
+      @snmp = ::SNMP::Manager.new(Host: @host, Community: community, Timeout: timeout, Retries: retries, MibModules: [])
+    end
+
+    # Closes the SNMP connection
+    # @return [void]
+    def close
+      @snmp.close
+    end
+
+    # 查询某个 oid 监控值
+    # Gets one oid, return value
+    # @param [String] oid to get
+    # @return [SNMP::VarBind]
+    def get(oid)
+      mget([oid]).first
+    end
+
+    # 批量查询多个 oids 监控值
+    # Get multiple oids, return array of values
+    # @param [Array(String)] oids to get
+    # @return [SNMP::VarBindList]
+    def mget(oids)
+      snmp :get, oids
+    end
+
+    # 遍历 root_oid 监控值
+    # Bulkwalk everything below root oid
+    # @param [String] root oid to start from
+    # @return [Array(SNMP::VarBind)]
+    def bulkwalk(root)
+      # 初始化变量
+      last, oid, results = false, root.dup, []
+      # 将点分10进制字串转换为数组对象
+      root = root.split(".").map { |chr| chr.to_i }
+      # 遍历 root_oid
+      until last
+        vbs = snmp(:get_bulk, 0, CFG.snmp.bulkrows, oid).varbind_list
+        vbs.each do |vb|
+          oid = vb.oid
+          # 解析到的 oid 不匹配 root 跳出循环
+          (last = true; break) unless oid[0..root.size - 1] == root
+          results << vb
+        end
+      end
+      results
+    end
+
+    # 将遍历的 root 监控值转换为 VBHash 样式
+    # bulkwalks oid and returns hash with oid as key
+    # @param [String] oid root oid to walk
+    # @yield [VBHash] hash containing oids found
+    # @return [Hash] resulting hash
+    def hashwalk(oid, &block)
+      hash = VBHash.new
+      bulkwalk(oid).each do |vb|
+        # value, key = block.call(vb)
+        # key       ||= vb.oid
+        hash[vb.oid] = vb
+      end
+      hash
+    end
+
+    private
+      def snmp(method, *args)
+        @snmp.send method, *args
+      rescue ::SNMP::RequestTimeout, Errno::EACCES => error
+        msg = "host '#{@host}' raised '#{error.class}' with message '#{error.message}' for method '#{method}' with args '#{args}'"
+        Log.warn msg
+        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
+          new_hash = VBHash.new
+          new_hash.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, nil] matching element
+        def by_partial(*args)
+          oid = arg_to_oid(*args)
+          # got = nil
+          keys.each do |key|
+            return self[key] if key.each_cons(oid.size).find { |e| e == oid }
+            # if key.each_cons(oid.size).find { |e| e == oid }
+            #   got = self[key]
+            #   break
+            # end
+          end
+          nil
+        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)
+            # FIXME && TODO
+            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/lib/netdisco/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Netdisco
+  VERSION = "0.0.2"
+end

data/lib/netdisco.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# 加载项目依赖
+require_relative "netdisco/config"
+require_relative "netdisco/poll_map"
+require_relative "netdisco/name_map"
+require_relative "netdisco/peer"
+require_relative "netdisco/method/xdp"
+require_relative "netdisco/dns"
+require_relative "netdisco/output"
+
+class Netdisco
+  class NetdiscoError < StandardError; end
+
+  class MethodNotFound < NetdiscoError; end
+
+  # 类对象方法属性
+  attr_reader :hosts
+
+  # 类对象初始化函数
+  def initialize
+    @methods = []
+    @hosts   = {}
+    @poll    = PollMap.new
+
+    # 动态加载邻居发现协议
+    CFG.use.each do |method|
+      method = File.basename method.to_s
+      file   = "netdisco/method/#{method.downcase}"
+      require_relative file
+      @methods << Netdisco.const_get(method)
+    rescue NameError, LoadError
+      raise MethodNotFound, "unable to find method '#{method}'"
+    end
+  end
+
+  # @param [String] host host to start discover from
+  # @return [Netdisco::Output]
+  def discover(host)
+    recurse host
+    Output.new @hosts, @poll
+  end
+
+  # @param [String] host host to get list of peers from
+  # @return [Array] list of peers seen connected to host
+  def neighbors(host)
+    peers = []
+    # 不同协议可能发现相同的联结关系，处理完成后根据 ip 自动去重
+    @methods.each do |method|
+      peers << method.send(:peers, host)
+    end
+    peers.flatten.uniq { |peer| peer.ip }
+  end
+
+  # Given string of IP address, recurses through peers seen and populates @hosts hash
+  # @param [String] host host to start recurse from
+  # @return [void]
+  def recurse(host)
+    # 第一步获取设备的邻居关系，同时将邻居关系缓存下来
+    @hosts[host] = peers = neighbors(host)
+    # 第二步遍历邻居的邻居关系
+    require "pp"; PP.pp @hosts[host]
+    peers.each do |peer|
+      next if @hosts.has_key? peer.ip
+      next unless @poll.include? peer.ip
+      discover peer.ip
+    end
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: netdisco
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- WENWU.YAN
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: snmp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: strada
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+description: Netdisco is working for network snmp discovery
+email:
+- careline@foxmail.com
+executables:
+- netdisco
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/netdisco
+- lib/netdisco.rb
+- lib/netdisco/cli.rb
+- lib/netdisco/config.rb
+- lib/netdisco/dns.rb
+- lib/netdisco/method/cdp.rb
+- lib/netdisco/method/lldp.rb
+- lib/netdisco/method/xdp.rb
+- lib/netdisco/name_map.rb
+- lib/netdisco/output.rb
+- lib/netdisco/output/dot.rb
+- lib/netdisco/peer.rb
+- lib/netdisco/poll_map.rb
+- lib/netdisco/snmp.rb
+- lib/netdisco/version.rb
+homepage: https://github.com/ciscolive/netdisco-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ciscolive/netdisco-ruby
+  source_code_uri: https://github.com/ciscolive/zabbix-rails
+  changelog_uri: https://github.com/ciscolive/zabbix-rails/blob/main/README.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key: 
+specification_version: 4
+summary: Netdisco is working for network snmp discovery
+test_files: []