sloth-snmp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5cea4c07bc9f9ce8c5e8d21f486a58186450aec95d818187ca64d998d641ede9
+  data.tar.gz: d1b59278de3b73f751ac6b2cfb4510522b09f8c26ed248d90babc43211f71ddf
+SHA512:
+  metadata.gz: bb2092ad1507afc77094d4d21e7a1a215d4f96bf2bd6e93ba3e5f4dfb765159532107601b23382ebfdbf9da23525ddfc8c97cf98b4ccd34d0c33628783ac54b0
+  data.tar.gz: 8ac8f497c635fc6d63dff118dfce4fffd86acceacda57f18164ddd61e484edfc57039246d143d2f0cb7cac76da49c34d851310a66564bac4f2f814b70292a17e

data/.gitignore

@@ -0,0 +1,23 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/vendor/
+*.pid
+*.log
+*.log.*
+/var/
+/log/
+*.swp
+/.rspec_status
+

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in snmp_handler.gemspec
+gemspec
+

data/README.adoc

@@ -0,0 +1,213 @@
+= Sloth::Snmp
+
+Sloth::Snmp is yet another wrapper library for snmp.
+
+== Features
+
+* Handles SNMP asynchronously.
+* By referring to the YAML file generated from the MIB file, you can operate without describing raw OID.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'sloth/snmp'
+----
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sloth-snmp
+    or
+    $ gem install -l sloth-snmp-x.x.x.gem
+
+== Usage
+
+=== New
+[source,ruby]
+----
+require  "sloth/snmp"
+
+snmp  =  Sloth::Snmp.new
+snmp  =  Sloth::Snmp.new( bind: 1161 )
+snmp  =  Sloth::Snmp.new( bind: "127.0.0.1" )
+snmp  =  Sloth::Snmp.new( bind: "192.168.0.1:1161" )
+snmp  =  Sloth::Snmp.new( mibs: "RS-232-MIB.yaml" )
+snmp  =  Sloth::Snmp.new( mibs: "spec/sloth/RFC1414-MIB.yaml" )
+----
+
+=== Get
+
+[source,ruby]
+----
+require  "sloth/snmp"
+
+snmp  =  Sloth::Snmp.new
+peer  =  "127.0.0.1"
+topics  =  [ "sysDescr.0", "sysUpTime.0", "sysName.0" ],
+tuples  =  snmp.get( peer, topics )
+tuples.each do |oid, tuple|
+  p  tuple
+end
+----
+
+=== Set
+
+[source,ruby]
+----
+require  "sloth/snmp"
+
+snmp  =  Sloth::Snmp.new
+peer  =  "127.0.0.1"
+tuple  =  { topic: "sysName.0", type: SNMP::OctetString, value: Time.now.to_s },
+snmp.set( peer, tuple )
+
+tuples  =  snmp.get( peer, tuple[:topic] )
+tuples.each do |oid, tuple|
+  p  tuple
+end
+----
+
+=== Walk
+
+[source,ruby]
+----
+require  "sloth/snmp"
+
+snmp  =  Sloth::Snmp.new
+peer  =  "127.0.0.1"
+topic  =  "internet"
+tuples  =  snmp.walk( peer, topic )
+tuples.each do |oid, tuple|
+  p  tuple
+end
+----
+
+=== Trap
+
+[source,ruby]
+----
+require  "sloth/snmp"
+
+snmp  =  Sloth::Snmp.new( bind: 1162 )
+snmp.trap( "snmpInTraps", "snmpOutTraps" ) do |trapname, source_ip, tuples|
+  p [:trapname, trapname]
+  p [:source_ip, source_ip]
+  tuples.each do |oid, tuple|
+    p  tuple
+  end
+end
+
+sleep
+----
+
+== Reference
+
+=== Create a new Sloth::Snmp.
+
+[source,ruby]
+----
+Sloth::Snmp.new( mibs: nil, bind: nil, rocommunity: "public", rwcommunity: "private" )
+----
+
+* Result:
+  - Sloth::Snmp object.
+
+* Parameter:
+  ** mibs:  Additional MIB file path, or array of the paths. (default: nil)
+  ** bind:  Bind host and port for trap. (default: "0.0.0.0:162")
+  ** rocommunity:  Community string for Read Only. (default: "public")
+  ** rwcommunity:  Community string for Read/Write. (default: "private")
+
+=== SNMP Get.
+
+[source,ruby]
+----
+Sloth::Snmp#get( peer, topics, community: nil, bindto: nil, device: nil )
+----
+
+* Result:
+  * Hash of key=>oid, value=>{name, value}.
+
+* Parameter:
+  ** peer:  Target IP address and port. (default port: 162)
+  ** topics:  Topic(s) for SNMP Get Request.
+  ** community:  Community string. (default: nil)
+  ** bindto:  Interface address. (default: nil)
+  ** device:  Interface name. (default: nil)
+
+=== SNMP Set.
+
+[source,ruby]
+----
+Sloth::Snmp#set( peer, topics, community: nil, bindto: nil, device: nil )
+----
+
+* Result:
+  * Hash of key=>oid, value=>{name, value}.
+
+* Parameter:
+  ** peer:  Target IP address and port. (default port: 162)
+  ** tuple:  Hash of topic, type, value for SNMP Set Request.
+  ** community:  Community string. (default: nil)
+  ** bindto:  Interface address. (default: nil)
+  ** device:  Interface name. (default: nil)
+
+=== SNMP Walk.
+
+[source,ruby]
+----
+Sloth::Snmp#walk( target, topic, port: 162, community: "public", bindto: nil, device: nil )
+----
+
+* Result:
+  ** Hash of key=>oid, value=>{name, value}.
+
+* Parameter:
+  ** peer:  Target IP address and port. (default port: 162)
+  ** topic:  Topic for SNMP Get Next.
+  ** community:  Community string. (default: nil)
+  ** bindto:  Interface address. (default: nil)
+  ** device:  Interface name. (default: nil)
+
+=== SNMP Trap.
+
+[source,ruby]
+----
+Sloth::Snmp#trap( *topics, &block )
+----
+
+* Result:
+  ** nil.
+
+* Parameter:
+  ** topics:  The topic(s) that enables trap monitoring.
+  ** block:  Callback action.
+
+=== SNMP Untrap.
+
+[source,ruby]
+----
+Sloth::Snmp#untrap( *topics )
+----
+
+* Result:
+  ** nil.
+
+* Parameter:
+  ** topics:  The topic(s) that disables trap monitoring.
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/arimay/sloth-snmp.
+
+== License
+
+The gem is available as open source under the terms of the http://opensource.org/licenses/MIT[MIT License].
+
+Copyright (c) ARIMA Yasuhiro <arima.yasuhiro@gmail.com>

data/README.ja.adoc

@@ -0,0 +1,213 @@
+= Sloth::Snmp
+
+Sloth::Snmp はさらにもうひとつの SNMP ラッパーライブラリ.
+
+== 特徴
+
+* 非同期で SNMP を扱う.
+* MIBファイルから生成したYAMLファイルを参照することで、生のOIDを記述することなく操作できる.
+
+== 導入
+
+アプリの Gemfile にこの行を追加
+
+[source,ruby]
+----
+gem 'sloth/snmp'
+----
+
+それから実行
+
+    $ bundle install
+
+または次のように手動で導入
+
+    $ gem install sloth-snmp
+    or
+    $ gem install -l sloth-snmp-x.x.x.gem
+
+== 使い方
+
+=== 新規
+[source,ruby]
+----
+require  "sloth/snmp"
+
+snmp  =  Sloth::Snmp.new
+snmp  =  Sloth::Snmp.new( bind: 1161 )
+snmp  =  Sloth::Snmp.new( bind: "127.0.0.1" )
+snmp  =  Sloth::Snmp.new( bind: "192.168.0.1:1161" )
+snmp  =  Sloth::Snmp.new( mibs: "RS-232-MIB.yaml" )
+snmp  =  Sloth::Snmp.new( mibs: "spec/sloth/RFC1414-MIB.yaml" )
+----
+
+=== 取得
+
+[source,ruby]
+----
+require  "sloth/snmp"
+
+snmp  =  Sloth::Snmp.new
+peer  =  "127.0.0.1"
+topics  =  [ "sysDescr.0", "sysUpTime.0", "sysName.0" ],
+tuples  =  snmp.get( peer, topics )
+tuples.each do |oid, tuple|
+  p  tuple
+end
+----
+
+=== 更新
+
+[source,ruby]
+----
+require  "sloth/snmp"
+
+snmp  =  Sloth::Snmp.new
+peer  =  "127.0.0.1"
+tuple  =  { topic: "sysName.0", type: SNMP::OctetString, value: Time.now.to_s },
+snmp.set( peer, tuple )
+
+tuples  =  snmp.get( peer, tuple[:topic] )
+tuples.each do |oid, tuple|
+  p  tuple
+end
+----
+
+=== 巡回
+
+[source,ruby]
+----
+require  "sloth/snmp"
+
+snmp  =  Sloth::Snmp.new
+peer  =  "127.0.0.1"
+topic  =  "internet"
+tuples  =  snmp.walk( peer, topic )
+tuples.each do |oid, tuple|
+  p  tuple
+end
+----
+
+=== トラップ
+
+[source,ruby]
+----
+require  "sloth/snmp"
+
+snmp  =  Sloth::Snmp.new( bind: 1162 )
+snmp.trap( "snmpInTraps", "snmpOutTraps" ) do |trapname, source_ip, tuples|
+  p [:trapname, trapname]
+  p [:source_ip, source_ip]
+  tuples.each do |oid, tuple|
+    p  tuple
+  end
+end
+
+sleep
+----
+
+== リファレンス
+
+=== 新たな Sloth::Snmp を作成する.
+
+[source,ruby]
+----
+Sloth::Snmp.new( mibs: nil, bind: nil, rocommunity: "public", rwcommunity: "private" )
+----
+
+* Result:
+  ** Sloth::Snmp オブジェクト.
+
+* Parameter:
+  ** mibs:  追加 MIB ファイルパスの文字列. またはその配列. (default: nil)
+  ** bind:  トラップ用のバインドホストとポート. (default: "0.0.0.0:162")
+  ** rocommunity:  読み取り用コミュニティ文字列. (default: "public")
+  ** rwcommunity:  読み書き用コミュニティ文字列. (default: "private")
+
+=== SNMP Get.
+
+[source,ruby]
+----
+Sloth::Snmp#get( peer, topics, community: nil, bindto: nil, device: nil )
+----
+
+* Result:
+  ** hash of key=>oid, value=>{name, value}.
+
+* Parameter:
+  ** peer:  宛先IPアドレスとポート. (default port: 162)
+  ** topics:  SNMP Get Request 用のトピック.
+  ** community:  コミュニティ文字列. (default: nil)
+  ** bindto:  インターフェースアドレス. (default: nil)
+  ** device:  インターフェース名称. (default: nil)
+
+=== SNMP Set.
+
+[source,ruby]
+----
+Sloth::Snmp#set( peer, topics, community: nil, bindto: nil, device: nil )
+----
+
+* Result:
+  ** hash of key=>oid, value=>{name, value}.
+
+* Parameter:
+  ** peer:  宛先IPアドレスとポート. (default port: 162)
+  ** tuple:  SNMP Set Request 用のトピック、型、値のハッシュ.
+  ** community:  コミュニティ文字列. (default: nil)
+  ** bindto:  インターフェースアドレス. (default: nil)
+  ** device:  インターフェース名称. (default: nil)
+
+=== SNMP Walk.
+
+[source,ruby]
+----
+Sloth::Snmp#walk( peer, topic, port: 162, community: "public", bindto: nil, device: nil )
+----
+
+* Result:
+  ** hash of key=>oid, value=>{name, value}.
+
+* Parameter:
+  ** peer:  宛先IPアドレスとポート. (default port: 162)
+  ** topic:  SNMP Get Next 用のトピック.
+  ** community:  コミュニティ文字列. (default: nil)
+  ** bindto:  インターフェースアドレス. (default: nil)
+  ** device:  インターフェース名称. (default: nil)
+
+=== SNMP Trap.
+
+[source,ruby]
+----
+Sloth::Snmp#trap( *topics, &block )
+----
+
+* Result:
+  ** nil.
+
+* Parameter:
+  ** topics:  トラップを有効化するトピック.
+  ** block:  コールバック動作.
+
+=== SNMP Untrap.
+
+[source,ruby]
+----
+Sloth::Snmp#untrap( *topics )
+----
+
+* Result:
+  ** nil.
+
+* Parameter:
+  ** topics:  トラップの監視を無効化するトピック.
+
+== 貢献
+
+不具合報告とプルリクエストは GitHub https://github.com/arimay/sloth-snmp まで. 
+
+== ライセンス
+
+この Gem は、 http://opensource.org/licenses/MIT[MITライセンス] の条件に基づいてオープンソースとして入手できる.
+
+Copyright (c) ARIMA Yasuhiro <arima.yasuhiro@gmail.com>

data/Rakefile

@@ -0,0 +1,96 @@
+require "bundler/gem_helper"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+class Bundler::GemHelper
+
+  def git_archive( dir = "../zip" )
+    FileUtils.mkdir_p  dir
+    dest_path  =  File.join(dir, "#{name}-#{version}.zip")
+    cmnd  =  "git archive --format zip --prefix=#{name}/ HEAD > #{dest_path}"
+
+    _, code = sh_with_status( cmnd )
+    raise "Couldn't archive gem,"  unless  code == 0
+
+    Bundler.ui.confirm "#{name} #{version} archived to #{dest_path}."
+  end
+
+  def git_push
+    ver  =  version.to_s
+
+    cmnd  =  "git push origin  #{ver} "
+    _, code = sh_with_status( cmnd )
+    raise "Couldn't git push origin."  unless  code == 0
+
+    cmnd  =  "git push "
+    _, code = sh_with_status( cmnd )
+    raise "Couldn't git push."         unless  code == 0
+
+    Bundler.ui.confirm "Git Push #{ver}."
+  end
+
+  def update_version( new_version )
+    version_filename  =  %x[ find . -type f -name "version.rb" | grep -v vendor | head -1 ].chomp
+    version_pathname  =  File.expand_path( version_filename )
+    lines  =  File.open( version_pathname ).read
+    lines  =  lines.gsub( /VERSION\s*=\s*\"\d+\.\d+\.\d+\"/, "VERSION = \"#{new_version}\"" )
+    File.open( version_pathname, "w" ) do |file|
+      file.write( lines )
+    end
+
+    cmnd  =  "git add  #{version_pathname} "
+    _, code = sh_with_status( cmnd )
+    raise "Couldn't git add,"  unless  code == 0
+
+    cmnd  =  "git commit -m  '#{new_version}' "
+    _, code = sh_with_status( cmnd )
+    raise "Couldn't git commit."  unless  code == 0
+
+    cmnd  =  "git tag        #{new_version} "
+    _, code = sh_with_status( cmnd )
+    raise "Couldn't git tag."          unless  code == 0
+
+    Bundler.ui.confirm "Update Tags to #{new_version}."
+  end
+
+end
+
+Bundler::GemHelper.new(Dir.pwd).instance_eval do
+
+  desc "Archive #{name}-#{version}.zip from repository"
+  task 'zip' do
+    git_archive
+  end
+
+  desc "Git Push"
+  task 'push' do
+    git_push
+  end
+
+  desc "Update Version Tiny"
+  task 'tiny' do
+    major, minor, tiny  =  version.to_s.split('.')
+    new_version  =  [major, minor, tiny.to_i + 1].join('.')
+    update_version( new_version )
+  end
+
+  desc "Update Version Minor"
+  task 'minor' do
+    major, minor, _tiny  =  version.to_s.split('.')
+    new_version  =  [major, minor.to_i + 1, 0].join('.')
+    update_version( new_version )
+  end
+
+  desc "Update Version Major"
+  task 'major' do
+    major, _minor, _tiny  =  version.to_s.split('.')
+    new_version  =  [major.to_i + 1, 0, 0].join('.')
+    update_version( new_version )
+  end
+
+end
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sloth/snmp"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sloth/snmp.rb

@@ -0,0 +1,3 @@
+require "sloth/snmp/version"
+require "sloth/snmp/impl"
+

data/lib/sloth/snmp/impl.rb

@@ -0,0 +1,302 @@
+require "snmp"
+
+module Sloth
+  class Snmp
+
+    class Error < StandardError; end
+
+    class UDPTransportExt < ::SNMP::UDPTransport
+      def initialize( address_family, bindto: nil, device: nil )
+        super
+        @socket  =  UDPSocket.open( address_family )
+        if  bindto
+          host, port  =  bindto.split(':')    rescue nil
+          @socket.bind( host, port.to_i )
+        end
+        if  device
+          @socket.setsockopt( Socket::SOL_SOCKET, Socket::SO_BINDTODEVICE, device )
+        end
+      end
+    end
+
+    def initialize( mibs: nil, bind: nil, rocommunity: "public", rwcommunity: "private" )
+      case  bind
+      when  Integer, NilClass
+        @host  =  "0.0.0.0"
+        @port  =  bind || 162
+      when  String
+        host, port  =  bind.split(':')    rescue  nil
+        if host.nil? || host.empty?
+          @host  =  "0.0.0.0"
+        else
+          @host  =  host
+        end
+        if port.nil? || port.empty?
+          @port  =  162
+        else
+          @port  =  port.to_i
+        end
+      else
+        raise  Sloth::Snmp::Error, "invalid class. : %s" % bind.class
+      end
+      @rocommunity  =  rocommunity
+      @rwcommunity  =  rwcommunity
+
+      @mibs  =  SNMP::MIB.new
+      @mibs.load_module( "RFC1155-SMI" )
+      @mibs.load_module( "RFC1158-MIB" )
+
+      case  mibs
+      when  NilClass
+        mibs  =  []
+      when  Array
+        # noop
+      when  String
+        mibs  =  [mibs]
+      else
+        raise  Sloth::Snmp::Error, "invalid class. : %s" % mibs.class
+      end
+
+      mibpath  =  mibs.shift
+      while  mibpath
+        mibbase  =  File.basename( mibpath )
+        mibdir  =  File.dirname( mibpath )
+        if ( mibdir == "." && mibbase == mibpath )
+          @mibs.load_module( mibbase.gsub( /\..*\Z/, "" ) )
+        else
+          @mibs.load_module( mibbase.gsub( /\..*\Z/, "" ), mibdir )
+        end
+        mibpath  =  mibs.shift
+      end
+
+      @topics  =  {}
+      @mutex  =  ::Mutex.new
+    end
+
+    def start_listener
+      @thread  ||=  Thread.start do
+        listener  =  SNMP::TrapListener.new( host: @host, port: @port, community: @rocommunity ) do |manager|
+          manager.on_trap_v2c do |mesg|
+            begin
+              next    if mesg.error_status  !=  :noError
+
+              source_ip  =  mesg.source_ip
+              trap_oid  =  mesg.trap_oid.join(".")
+              trapname  =  @mibs.name( trap_oid )
+              items  =  {}
+              mesg.each_varbind do |varbind|
+                oid, item  =  * parse_varbind( varbind )
+                items[oid]  =  item
+              end
+              Thread.start do
+                @mutex.synchronize do
+                  @topics[ trap_oid ]&.call( trapname, source_ip, items )
+                end
+              end
+
+            rescue => e
+              raise  Sloth::Snmp::Error, e.message
+
+            end
+          end
+        end
+        Thread.current[:listener]  =  listener
+        listener.join
+      end
+    end
+
+    def stop_listener
+      @mutex.synchronize do
+        @topics.clear
+        @thread[:listener].exit
+        @thread  =  nil
+      end
+    end
+
+    def trap( *topics, &block )
+      @mutex.synchronize do
+        topics.each do |topic|
+          trap_oid  =  SNMP::ObjectId.new( topic )  rescue  @mibs.oid( topic )
+          @topics[trap_oid.to_str]  =  block
+        end
+      end
+      start_listener
+    end
+
+    def untrap( *topics )
+      @mutex.synchronize do
+        topics.each do |topic|
+          trap_oid  =  SNMP::ObjectId.new( topic )  rescue  @mibs.oid( topic )
+          @topics.delete( trap_oid.to_str )
+        end
+      end
+      stop_listener    if @topics.empty?
+    end
+
+    def get( peer, topics, **options )
+      host, port  =  peer.split(':')  rescue  nil
+      host  =  "127.0.0.1"    if  host.nil? || host.empty?
+      port  =  (port || 161).to_i
+      community  =  options[:rocommunity]  ||  @rocommunity
+
+      case  topics
+      when  String
+        oids  =  [ ( SNMP::ObjectId.new( topics )  rescue  @mibs.oid( topics ) ) ]
+      when  Array
+        oids  =  topics.map do |topic|
+          SNMP::ObjectId.new( topic )  rescue  @mibs.oid( topic )
+        end
+      else
+        raise  Sloth::Snmp::Error, "topics missing."
+      end
+
+      if  options[:bindto] && options[:device]
+        transport  =  UDPTransportExt.new( Socket::AF_INET, bindto: options[:bindto], device: options[:device] )
+      end
+
+      manager  =  SNMP::Manager.new( host: host, port: port, community: community, transport: transport )
+
+      items  =  {}
+      begin
+        response  =  Thread.handle_interrupt( ::Timeout::Error => :on_blocking ) do
+          manager.get( oids )
+        end
+
+        response.each_varbind do |varbind|
+          oid, item  =  * parse_varbind( varbind )
+          items[oid]  =  item
+        end
+
+      rescue  SNMP::RequestTimeout => e
+        raise  Sloth::Snmp::Error, e.message
+
+      rescue  => e
+        raise  Sloth::Snmp::Error, e.message
+
+      end
+      items
+    end
+
+    def walk( peer, topic, **options )
+      host, port  =  peer.split(':')  rescue  nil
+      host  =  "127.0.0.1"    if  host.nil? || host.empty?
+      port  =  (port || 161).to_i
+      community  =  options[:rocommunity]  ||  @rocommunity
+
+      if  options[:bindto] && options[:device]
+        transport  =  UDPTransportExt.new( Socket::AF_INET, bindto: options[:bindto], device: options[:device] )
+      end
+
+      manager  =  SNMP::Manager.new( host: host, port: port, community: community, transport: transport )
+
+      topic  ||=  "internet"
+      base_oid  =  SNMP::ObjectId.new( topic )  rescue  @mibs.oid( topic )
+
+      items  =  {}
+      begin
+        Thread.handle_interrupt( ::Timeout::Error => :on_blocking ) do
+          manager.walk( base_oid ) do |varbind|
+            oid, item  =  * parse_varbind( varbind )
+            items[oid]  =  item
+          end
+        end
+
+      rescue  SNMP::RequestTimeout => e
+        raise  Sloth::Snmp::Error, e.message
+
+      rescue  => e
+        raise  Sloth::Snmp::Error, e.message
+
+      end
+      items
+    end
+
+    def set( peer, tuple, **options )
+      host, port  =  peer.split(':')  rescue  nil
+      host  =  "127.0.0.1"    if  host.nil? || host.empty?
+      port  =  (port || 161).to_i
+      community  =  options[:rwcommunity]  ||  @rwcommunity
+
+      if  options[:bindto] && options[:device]
+        transport  =  UDPTransportExt.new( Socket::AF_INET, bindto: options[:bindto], device: options[:device] )
+      end
+
+      varbind  =  build_varbind( tuple[:topic], tuple[:type], tuple[:value] )
+
+      manager  =  SNMP::Manager.new( host: host, port: port, community: community, transport: transport )
+
+      begin
+        response  =  Thread.handle_interrupt( ::Timeout::Error => :on_blocking ) do
+          manager.set( varbind )
+        end
+        response
+
+      rescue  SNMP::RequestTimeout => e
+        raise  Sloth::Snmp::Error, e.message
+
+      rescue  => e
+        raise  Sloth::Snmp::Error, e.message
+
+      ensure
+        manager.close
+      end
+    end
+
+    def parse_varbind( varbind, keys: nil )
+      keys  =  [:name, :value]    if keys.nil? || keys.empty?
+      oid   =  varbind.name.to_str
+      name  =  @mibs.name( oid )
+      case  varbind.value
+      when  SNMP::OctetString
+        type  =  SNMP::OctetString
+        valu  =  varbind.value.to_s
+        if  /[^[:print:]]/.match( valu )
+          valu  =  "0x" + valu.unpack("H*").shift
+        end
+      when  SNMP::Integer
+        type  =  SNMP::Integer
+        valu  =  varbind.value.to_i
+      when  SNMP::Counter32
+        type  =  SNMP::Counter32
+        valu  =  varbind.value.to_i
+      when  SNMP::IpAddress
+        type  =  SNMP::IpAddress
+        valu  =  varbind.value.to_s
+      when  SNMP::ObjectId
+        type  =  SNMP::ObjectId
+        valu  =  varbind.value
+      when  SNMP::NoSuchInstance, SNMP::NoSuchObject
+        type  =  varbind.value
+        valu  =  nil
+      else
+        type  =  varbind.value
+        valu  =  nil
+      end
+
+      tuple  =  {}
+      tuple[:name]  =  name    if keys.include?( :name )
+      tuple[:type]  =  type    if keys.include?( :type )
+      tuple[:value]  =  valu    if keys.include?( :value )
+      [oid, tuple]
+    end
+
+    def build_varbind( topic, type, value )
+      oid  =  SNMP::ObjectId.new( topic )  rescue  @mibs.oid( topic )
+      case  type
+      when  SNMP::OctetString
+        SNMP::VarBind.new( oid, SNMP::OctetString.new( value ))
+      when  SNMP::Integer
+        SNMP::VarBind.new( oid, SNMP::Integer.new( value ))
+      when  SNMP::Counter32
+        SNMP::VarBind.new( oid, SNMP::Counter32.new( value ))
+      when  SNMP::IpAddress
+        SNMP::VarBind.new( oid, SNMP::IpAddress.new( value ))
+      when  SNMP::ObjectId
+        SNMP::VarBind.new( oid, SNMP::ObjectId.new( value ))
+      else
+        SNMP::VarBind.new( oid, SNMP::OctetString.new( value.to_s ))
+      end
+    end
+
+  end
+end

data/lib/sloth/snmp/version.rb

@@ -0,0 +1,5 @@
+module Sloth
+  class Snmp
+    VERSION = "0.1.0"
+  end
+end

data/sample/snmpcustom.rb

@@ -0,0 +1,22 @@
+#
+# bundle exec ruby sample/snmp_custom.rb
+# bundle exec ruby sample/snmp_custom.rb  sample/SAMPLE-MIB.yml  10.0.2.1
+#
+
+require  "sloth/snmp"
+
+config  =  {}
+mibpath  =  ARGV.shift
+if  mibpath
+  config.merge!( mibs: mibpath )
+end
+
+Snmp  =  Sloth::Snmp.new( **config )
+
+peer  =  ARGV.shift  ||  "127.0.0.1:161"
+
+topic  =  "internet"
+tuples  =  Snmp.walk( peer, topic )
+tuples.each do |_oid, tuple|
+  p  tuple
+end

data/sample/snmpget.rb

@@ -0,0 +1,27 @@
+#
+# bundle exec ruby sample/snmpget.rb
+#
+
+require  "sloth/snmp"
+
+Snmp  =  Sloth::Snmp.new
+
+options = {
+#  bindto:    "10.0.2.15",
+#  device:    "enp0s3",
+}
+
+peer  =  ARGV.shift  ||  "127.0.0.1:161"
+
+[
+  [ "sysDescr.0", "sysUpTime.0", "sysName.0" ],
+  [ "1.3.6.1.2.1.1.1.0", "1.3.6.1.2.1.1.3.0" ],
+  "1.3.6.1.2.1.1.5.0",
+].each do |topics|
+  p [:get, topics]
+  tuples  =  Snmp.get( peer, topics, **options )
+  tuples.each do |_oid, tuple|
+    p  tuple
+  end
+  puts
+end

data/sample/snmpset.rb

@@ -0,0 +1,30 @@
+#
+# bundle exec ruby sample/snmpset.rb
+#
+
+require  "sloth/snmp"
+
+Snmp  =  Sloth::Snmp.new
+
+options = {
+#  bindto:    "10.0.2.15",
+#  device:    "enp0s3",
+}
+
+peer  =  ARGV.shift  ||  "127.0.0.1:161"
+
+[
+  { topic: "sysName.0", type: SNMP::OctetString, value: Time.now.to_s },
+].each do |tuple|
+  p [:set, tuple]
+  pp Snmp.set( peer, tuple, **options )
+
+# topics  =  [tuple[:topic]]
+  topics  =   tuple[:topic]
+  p [:get, topics]
+  tuples  =  Snmp.get( peer, topics, **options )
+  tuples.each do |_oid, tuple_|
+    p  tuple_
+  end
+  puts
+end

data/sample/snmptrap.rb

@@ -0,0 +1,45 @@
+#
+#      bundle exec ruby sample/snmptrap.rb
+# sudo bundle exec ruby sample/snmptrap.rb
+#
+# RFC1158-MIB.yaml:191:snmpInTraps: 1.3.6.1.2.1.11.19
+# RFC1158-MIB.yaml:201:snmpOutTraps: 1.3.6.1.2.1.11.29
+#
+
+require  "sloth/snmp"
+
+port  =  ( ARGV.shift || ( Process::Sys.getuid  ==  0  ?  162  :  1162 ) )
+p [:port, port]
+
+Snmp  =  Sloth::Snmp.new( bind: port )
+
+queue  =  Queue.new
+
+p :ready
+Snmp.trap( "snmpInTraps", "snmpOutTraps" ) do |trapname, source_ip, tuples|
+#Snmp.trap( "1.3.6.1.2.1.11.19", "1.3.6.1.2.1.11.29" ) do |trapname, source_ip, tuples|
+  p ["TRAP!!", :trapname, trapname, :source_ip, source_ip]
+  tuples.each do |_oid, tuple|
+    p  tuple
+  end
+  queue.push  trapname
+end
+
+p :wait
+sleep  1
+puts
+
+p cmnd  =  "snmptrap  -v 2c  -c public   127.0.0.1:#{port}  ''  .1.3.6.1.2.1.11.19  2> /dev/null "
+%x[#{cmnd}]
+p queue.pop
+
+p cmnd  =  "snmptrap  -v 2c  -c public   127.0.0.1:#{port}  ''  .1.3.6.1.2.1.11.29  2> /dev/null "
+%x[#{cmnd}]
+p queue.pop
+
+p :untrap
+Snmp.untrap( "snmpInTraps", "snmpOutTraps" )
+# Snmp.untrap( "1.3.6.1.2.1.11.19", "1.3.6.1.2.1.11.29" )
+
+sleep  1
+p :quit

data/sample/snmpwalk.rb

@@ -0,0 +1,29 @@
+#
+# bundle exec ruby sample/snmpwalk.rb
+#
+
+require  "sloth/snmp"
+
+Snmp  =  Sloth::Snmp.new
+
+options = {
+#  bindto:    "10.0.2.15",
+#  device:    "enp0s3",
+}
+
+peer  =  ARGV.shift  ||  "127.0.0.1:161"
+
+[
+  "system.8",
+  "system.9",
+  "mib-2.25.1",
+  "internet",
+  nil,
+].each do |topic|
+  p [:walk, topic] 
+  tuples  =  Snmp.walk( peer, topic, **options )
+  tuples.each do |_oid, tuple|
+    p  tuple
+  end
+  puts
+end

data/sloth-snmp.gemspec

@@ -0,0 +1,25 @@
+require_relative 'lib/sloth/snmp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sloth-snmp"
+  spec.version       = Sloth::Snmp::VERSION
+  spec.authors       = ["arimay"]
+  spec.email         = ["arima.yasuhiro@gmail.com"]
+
+  spec.summary       = %q{ Sloth Snmp Library. }
+  spec.description   = %q{ Sloth::Snmp is yet another wrapper library for snmp. }
+  spec.homepage      = "https://github.com/arimay/sloth-snmp"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "snmp"
+
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: sloth-snmp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- arimay
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: snmp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: " Sloth::Snmp is yet another wrapper library for snmp. "
+email:
+- arima.yasuhiro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.adoc
+- README.ja.adoc
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sloth/snmp.rb
+- lib/sloth/snmp/impl.rb
+- lib/sloth/snmp/version.rb
+- sample/snmpcustom.rb
+- sample/snmpget.rb
+- sample/snmpset.rb
+- sample/snmptrap.rb
+- sample/snmpwalk.rb
+- sloth-snmp.gemspec
+homepage: https://github.com/arimay/sloth-snmp
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Sloth Snmp Library.
+test_files: []