net-snmp 0.1.0

data/lib/net-snmp.rb

@@ -0,0 +1,57 @@
+require 'forwardable'
+require 'nice-ffi'
+require 'fiber'
+%w(snmp snmp/constants snmp/oid snmp/error snmp/pdu snmp/wrapper snmp/session snmp/varbind snmp/mib snmp/mib/node).each do |f|
+  require "#{File.dirname(__FILE__)}/net/#{f}"
+end
+Net::SNMP::MIB.init
+Net::SNMP::MIB.read_all_mibs
+Net::SNMP.init
+
+
+
+#  XXX
+#  I just monkeypatched this to take a nil first argument.  Seems to work
+#  Should probably submit this as a patch
+
+class NiceFFI::Struct < FFI::Struct
+  def initialize( val = nil, options={} )
+    # Stores certain kinds of member values so that we don't need
+    # to create a new object every time they are read.
+    @member_cache = {}
+
+    options = {:autorelease => true}.merge!( options )
+
+    case val
+
+    when Hash
+      super(FFI::Buffer.new(size))
+      init_from_hash( val )         # Read the values from a Hash.
+
+    # Note: plain "Array" would mean FFI::Struct::Array in this scope.
+    when ::Array
+      super(FFI::Buffer.new(size))
+      init_from_array( val )        # Read the values from an Array.
+
+    when String
+      super(FFI::Buffer.new(size))
+      init_from_bytes( val )        # Read the values from a bytestring.
+
+    when self.class
+      super(FFI::Buffer.new(size))
+      init_from_bytes( val.to_bytes ) # Read the values from another instance.
+
+    when FFI::Pointer, FFI::Buffer
+      val = _make_autopointer( val, options[:autorelease] )
+
+      # Normal FFI::Struct behavior to wrap the pointer.
+      super( val )
+
+    when nil
+      super(val)
+    else
+      raise TypeError, "cannot create new #{self.class} from #{val.inspect}"
+
+    end
+  end
+end

data/lib/net/snmp.rb

@@ -0,0 +1,54 @@
+require 'net/snmp/constants'
+module Net
+  module SNMP
+    include Net::SNMP::Constants
+
+
+    def self.init(tag="snmp")
+      Wrapper.init_snmp(tag)
+    end
+
+    # timeout = nil  no block(poll),  timeout = false block forever, timeout = int, block int seconds
+    def self.dispatcher(timeout = nil)
+        fdset = Net::SNMP::Wrapper.get_fd_set
+        num_fds = FFI::MemoryPointer.new(:int)
+        tv_sec = timeout || 0
+        tval = Net::SNMP::Wrapper::TimeVal.new(:tv_sec => tv_sec, :tv_usec => 0)
+        block = FFI::MemoryPointer.new(:int)
+
+        if timeout.nil?
+          block.write_int(0)
+        else
+          block.write_int(1)
+        end
+
+        Net::SNMP::Wrapper.snmp_select_info(num_fds, fdset, tval.pointer, block )
+        num_ready = 0
+        if num_fds.read_int > 0
+          tv = timeout == false ? nil : tval
+          num_ready = Net::SNMP::Wrapper.select(num_fds.read_int, fdset, nil, nil, tv)
+          Net::SNMP::Wrapper.snmp_read(fdset)
+        end
+        num_ready
+    end
+
+
+    def self._get_oid(name)
+      oid_ptr = FFI::MemoryPointer.new(:ulong, Constants::MAX_OID_LEN)
+      oid_len_ptr = FFI::MemoryPointer.new(:size_t)
+      oid_len_ptr.write_int(Constants::MAX_OID_LEN)
+
+      if !Wrapper.snmp_parse_oid(name, oid_ptr, oid_len_ptr)
+        Wrapper.snmp_perror(name)
+      end
+      [oid_ptr, oid_len_ptr]
+    end
+
+    def self.get_oid(name)
+      oid_ptr, oid_len_ptr = _get_oid(name)
+      oid_ptr.read_array_of_long(oid_len_ptr.read_int).join(".")
+    end
+
+
+  end
+end

data/lib/net/snmp/constants.rb

@@ -0,0 +1,239 @@
+module Net
+  module SNMP
+    module Constants
+      MAX_OID_LEN = 128
+      SNMP_VERSION_1 = 0
+      SNMP_VERSION_2c = 1
+      SNMP_VERSION_3 = 3
+
+      ASN_BOOLEAN         = 0x01
+      ASN_INTEGER         = 0x02
+      ASN_BIT_STR         = 0x03
+      ASN_OCTET_STR       = 0x04
+      ASN_NULL            = 0x05
+      ASN_OBJECT_ID       = 0x06
+      ASN_SEQUENCE        = 0x10
+      ASN_SET             = 0x11
+
+      ASN_UNIVERSAL       = 0x00
+      ASN_APPLICATION     = 0x40
+      ASN_CONTEXT         = 0x80
+      ASN_PRIVATE         = 0xC0
+
+      ASN_PRIMITIVE       = 0x00
+      ASN_CONSTRUCTOR     = 0x20
+
+      ASN_LONG_LEN        = 0x80
+      ASN_EXTENSION_ID    = 0x1F
+      ASN_BIT8            = 0x80
+
+
+      ASN_IPADDRESS   = (ASN_APPLICATION | 0)
+      ASN_COUNTER     = (ASN_APPLICATION | 1)
+      ASN_GAUGE       = (ASN_APPLICATION | 2)
+      ASN_UNSIGNED    = (ASN_APPLICATION | 2)   # RFC 1902 - same as GAUGE
+      ASN_TIMETICKS   = (ASN_APPLICATION | 3)
+      ASN_OPAQUE      = (ASN_APPLICATION | 4)
+
+      #define ASN_NSAP        (ASN_APPLICATION | 5)   /* historic - don't use */
+      #define ASN_COUNTER64   (ASN_APPLICATION | 6)
+      #define ASN_UINTEGER    (ASN_APPLICATION | 7)   /* historic - don't use */
+
+
+
+      SNMP_MSG_GET        = (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x0)
+      SNMP_MSG_GETNEXT    = (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x1) 
+      SNMP_MSG_RESPONSE   = (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x2) 
+      SNMP_MSG_SET        = (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x3)
+      SNMP_MSG_TRAP       = (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x4)
+      SNMP_MSG_GETBULK    = (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x5)
+      SNMP_MSG_INFORM     = (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x6)
+      SNMP_MSG_TRAP2      = (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x7)
+      SNMP_MSG_REPORT     = (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x8)
+      
+      NETSNMP_CALLBACK_OP_RECEIVED_MESSAGE  =  1
+      NETSNMP_CALLBACK_OP_TIMED_OUT         =  2
+      NETSNMP_CALLBACK_OP_SEND_FAILED       =  3
+      NETSNMP_CALLBACK_OP_CONNECT           =  4
+      NETSNMP_CALLBACK_OP_DISCONNECT        =  5
+      
+
+
+      USM_AUTH_KU_LEN = 32
+      USM_PRIV_KU_LEN = 32
+
+      SNMP_SEC_LEVEL_NOAUTH = 1
+      SNMP_SEC_LEVEL_AUTHNOPRIV = 2
+      SNMP_SEC_LEVEL_AUTHPRIV = 3
+
+      SNMP_DEFAULT_COMMUNITY_LEN = 0
+      SNMP_DEFAULT_RETRIES = -1
+      SNMP_DEFAULT_TIMEOUT = -1
+      SNMP_DEFAULT_REMPORT = 0
+      SNMP_DEFAULT_REQID = -1
+      SNMP_DEFAULT_MSGID = -1
+      SNMP_DEFAULT_ERRSTAT = -1
+      SNMP_DEFAULT_ERRINDEX = -1
+      SNMP_DEFAULT_ADDRESS = 0
+      SNMP_DEFAULT_ENTERPRISE_LENGTH = 0
+      SNMP_DEFAULT_TIME = 0
+      SNMP_DEFAULT_VERSION = -1
+      SNMP_DEFAULT_SECMODEL = -1
+      SNMP_DEFAULT_CONTEXT = 
+
+      SNMP_MAX_MSG_SIZE = 1472
+      SNMP_MAX_MSG_V3_HDRS = (4+3+4+7+7+3+7+16)
+      SNMP_MAX_ENG_SIZE = 32
+      SNMP_MAX_SEC_NAME_SIZE = 256
+      SNMP_MAX_CONTEXT_SIZE = 256
+      SNMP_SEC_PARAM_BUF_SIZE = 256
+      SNMPV3_IGNORE_UNAUTH_REPORTS = 0
+      SNMP_SESS_NONAUTHORITATIVE = 0
+      SNMP_SESS_AUTHORITATIVE = 1
+      SNMP_SESS_UNKNOWNAUTH = 2
+      REPORT_STATS_LEN = 9
+      REPORT_snmpUnknownSecurityModels_NUM = 1
+      REPORT_snmpInvalidMsgs_NUM = 2
+      REPORT_usmStatsUnsupportedSecLevels_NUM = 1
+      REPORT_usmStatsNotInTimeWindows_NUM = 2
+      REPORT_usmStatsUnknownUserNames_NUM = 3
+      REPORT_usmStatsUnknownEngineIDs_NUM = 4
+      REPORT_usmStatsWrongDigests_NUM = 5
+      REPORT_usmStatsDecryptionErrors_NUM = 6
+      SNMP_DETAIL_SIZE = 512
+      SNMP_FLAGS_RESP_CALLBACK = 0x400
+      SNMP_FLAGS_USER_CREATED = 0x200
+      SNMP_FLAGS_DONT_PROBE = 0x100
+      SNMP_FLAGS_STREAM_SOCKET = 0x80
+      SNMP_FLAGS_LISTENING = 0x40
+      SNMP_FLAGS_SUBSESSION = 0x20
+      SNMP_FLAGS_STRIKE2 = 0x02
+      SNMP_FLAGS_STRIKE1 = 0x01
+      SNMPERR_SUCCESS = (0)
+      SNMPERR_GENERR = (-1)
+      SNMPERR_BAD_LOCPORT = (-2)
+      SNMPERR_BAD_ADDRESS = (-3)
+      SNMPERR_BAD_SESSION = (-4)
+      SNMPERR_TOO_LONG = (-5)
+      SNMPERR_NO_SOCKET = (-6)
+      SNMPERR_V2_IN_V1 = (-7)
+      SNMPERR_V1_IN_V2 = (-8)
+      SNMPERR_BAD_REPEATERS = (-9)
+      SNMPERR_BAD_REPETITIONS = (-10)
+      SNMPERR_BAD_ASN1_BUILD = (-11)
+      SNMPERR_BAD_SENDTO = (-12)
+      SNMPERR_BAD_PARSE = (-13)
+      SNMPERR_BAD_VERSION = (-14)
+      SNMPERR_BAD_SRC_PARTY = (-15)
+      SNMPERR_BAD_DST_PARTY = (-16)
+      SNMPERR_BAD_CONTEXT = (-17)
+      SNMPERR_BAD_COMMUNITY = (-18)
+      SNMPERR_NOAUTH_DESPRIV = (-19)
+      SNMPERR_BAD_ACL = (-20)
+      SNMPERR_BAD_PARTY = (-21)
+      SNMPERR_ABORT = (-22)
+      SNMPERR_UNKNOWN_PDU = (-23)
+      SNMPERR_TIMEOUT = (-24)
+      SNMPERR_BAD_RECVFROM = (-25)
+      SNMPERR_BAD_ENG_ID = (-26)
+      SNMPERR_BAD_SEC_NAME = (-27)
+      SNMPERR_BAD_SEC_LEVEL = (-28)
+      SNMPERR_ASN_PARSE_ERR = (-29)
+      SNMPERR_UNKNOWN_SEC_MODEL = (-30)
+      SNMPERR_INVALID_MSG = (-31)
+      SNMPERR_UNKNOWN_ENG_ID = (-32)
+      SNMPERR_UNKNOWN_USER_NAME = (-33)
+      SNMPERR_UNSUPPORTED_SEC_LEVEL = (-34)
+      SNMPERR_AUTHENTICATION_FAILURE = (-35)
+      SNMPERR_NOT_IN_TIME_WINDOW = (-36)
+      SNMPERR_DECRYPTION_ERR = (-37)
+      SNMPERR_SC_GENERAL_FAILURE = (-38)
+      SNMPERR_SC_NOT_CONFIGURED = (-39)
+      SNMPERR_KT_NOT_AVAILABLE = (-40)
+      SNMPERR_UNKNOWN_REPORT = (-41)
+      SNMPERR_USM_GENERICERROR = (-42)
+      SNMPERR_USM_UNKNOWNSECURITYNAME = (-43)
+      SNMPERR_USM_UNSUPPORTEDSECURITYLEVEL = (-44)
+      SNMPERR_USM_ENCRYPTIONERROR = (-45)
+      SNMPERR_USM_AUTHENTICATIONFAILURE = (-46)
+      SNMPERR_USM_PARSEERROR = (-47)
+      SNMPERR_USM_UNKNOWNENGINEID = (-48)
+      SNMPERR_USM_NOTINTIMEWINDOW = (-49)
+      SNMPERR_USM_DECRYPTIONERROR = (-50)
+      SNMPERR_NOMIB = (-51)
+      SNMPERR_RANGE = (-52)
+      SNMPERR_MAX_SUBID = (-53)
+      SNMPERR_BAD_SUBID = (-54)
+      SNMPERR_LONG_OID = (-55)
+      SNMPERR_BAD_NAME = (-56)
+      SNMPERR_VALUE = (-57)
+      SNMPERR_UNKNOWN_OBJID = (-58)
+      SNMPERR_NULL_PDU = (-59)
+      SNMPERR_NO_VARS = (-60)
+      SNMPERR_VAR_TYPE = (-61)
+      SNMPERR_MALLOC = (-62)
+      SNMPERR_KRB5 = (-63)
+      SNMPERR_PROTOCOL = (-64)
+      SNMPERR_OID_NONINCREASING = (-65)
+      SNMPERR_MAX = (-65)
+
+
+      STAT_SNMPUNKNOWNSECURITYMODELS = 0
+      STAT_SNMPINVALIDMSGS = 1
+      STAT_SNMPUNKNOWNPDUHANDLERS = 2
+      STAT_MPD_STATS_START = 0
+      STAT_MPD_STATS_END = 2
+      STAT_USMSTATSUNSUPPORTEDSECLEVELS = 3
+      STAT_USMSTATSNOTINTIMEWINDOWS = 4
+      STAT_USMSTATSUNKNOWNUSERNAMES = 5
+      STAT_USMSTATSUNKNOWNENGINEIDS = 6
+      STAT_USMSTATSWRONGDIGESTS = 7
+      STAT_USMSTATSDECRYPTIONERRORS = 8
+      STAT_USM_STATS_START = 3
+      STAT_USM_STATS_END = 8
+      STAT_SNMPINPKTS = 9
+      STAT_SNMPOUTPKTS = 10
+      STAT_SNMPINBADVERSIONS = 11
+      STAT_SNMPINBADCOMMUNITYNAMES = 12
+      STAT_SNMPINBADCOMMUNITYUSES = 13
+      STAT_SNMPINASNPARSEERRS = 14
+      STAT_SNMPINTOOBIGS = 16
+      STAT_SNMPINNOSUCHNAMES = 17
+      STAT_SNMPINBADVALUES = 18
+      STAT_SNMPINREADONLYS = 19
+      STAT_SNMPINGENERRS = 20
+      STAT_SNMPINTOTALREQVARS = 21
+      STAT_SNMPINTOTALSETVARS = 22
+      STAT_SNMPINGETREQUESTS = 23
+      STAT_SNMPINGETNEXTS = 24
+      STAT_SNMPINSETREQUESTS = 25
+      STAT_SNMPINGETRESPONSES = 26
+      STAT_SNMPINTRAPS = 27
+      STAT_SNMPOUTTOOBIGS = 28
+      STAT_SNMPOUTNOSUCHNAMES = 29
+      STAT_SNMPOUTBADVALUES = 30
+      STAT_SNMPOUTGENERRS = 32
+      STAT_SNMPOUTGETREQUESTS = 33
+      STAT_SNMPOUTGETNEXTS = 34
+      STAT_SNMPOUTSETREQUESTS = 35
+      STAT_SNMPOUTGETRESPONSES = 36
+      STAT_SNMPOUTTRAPS = 37
+      STAT_SNMPSILENTDROPS = 39
+      STAT_SNMPPROXYDROPS = 40
+      STAT_SNMP_STATS_START = 9
+      STAT_SNMP_STATS_END = 40
+      STAT_SNMPUNAVAILABLECONTEXTS = 41
+      STAT_SNMPUNKNOWNCONTEXTS = 42
+      STAT_TARGET_STATS_START = 41
+      STAT_TARGET_STATS_END = 42
+      MAX_STATS = 43
+      PARSE_PACKET = 0
+      DUMP_PACKET = 1
+      MAX_SUBID = 0xFFFFFFFF
+      MIN_OID_LEN = 2
+
+      MAX_NAME_LEN = 128
+      
+    end
+  end
+end

data/lib/net/snmp/error.rb

@@ -0,0 +1,23 @@
+module Net
+  module SNMP
+    class Error < RuntimeError
+      #attr :status, :errno, :snmp_err, :snmp_msg
+      
+      def initialize(opts = {})
+        @status = opts[:status]
+        if opts[:session]
+          errno_ptr = FFI::MemoryPointer.new(:int)
+          snmp_err_ptr = FFI::MemoryPointer.new(:int)
+          msg_ptr = FFI::MemoryPointer.new(:pointer)
+          Wrapper.snmp_error(opts[:session].pointer, errno_ptr, snmp_err_ptr, msg_ptr)
+
+          @errno = errno_ptr.read_int
+          @snmp_err = snmp_err_ptr.read_int
+          @snmp_msg = msg_ptr.read_pointer.read_string
+        end
+      end
+    end
+  end
+end
+
+      

data/lib/net/snmp/inline.rb

@@ -0,0 +1,39 @@
+module Net
+  module SNMP
+    module Inline
+      extend Inliner
+      
+      #module LibC
+      #  extend FFI::Library
+      #  ffi_lib 'C'
+      #  attach_function :malloc, [ :uint ], :pointer
+      #  attach_function :free, [ :pointer ], :void
+      #end
+
+      inline do |builder|
+        builder.include "sys/select.h"
+        builder.include "stdio.h"
+        builder.library "netsnmp"
+        builder.c %q{
+          int snmp_process_callbacks() {
+            int fds = 0, block = 1;
+            fd_set fdset;
+            struct timeval timeout;
+            FD_ZERO(&fdset);
+            snmp_select_info(&fds, &fdset, &timeout, &block);
+            fds = select(fds, &fdset, 0,0, block ? 0 : &timeout);
+            if(fds) {
+              snmp_read(&fdset);
+            } else {
+              snmp_timeout();
+            }
+          }
+        }
+
+      end
+
+
+      
+    end
+  end
+end

data/lib/net/snmp/mib.rb

@@ -0,0 +1,20 @@
+module Net
+  module SNMP
+    module MIB
+      def self.init
+        Wrapper.init_mib
+      end
+      
+      def self.read_all_mibs
+        Wrapper.read_all_mibs
+      end
+      
+      def self.get_node(oid)
+        Node.get_node(oid)
+      end
+
+
+      
+    end
+  end
+end

data/lib/net/snmp/mib/node.rb

@@ -0,0 +1,58 @@
+
+module Net::SNMP
+  module MIB
+    class Node
+      extend Forwardable
+      attr_accessor :struct
+      def_delegators :struct, :label, :type, :access, :status
+      
+      class << self
+        def get_node(oid)
+          oid_ptr, oid_len_ptr = Net::SNMP._get_oid(oid)
+          struct = Wrapper.get_tree(oid_ptr, oid_len_ptr.read_int, Wrapper.get_tree_head().pointer)
+          new(struct.pointer)
+        end
+      end
+      
+      def initialize(arg)
+        case arg
+        when FFI::Pointer
+          @struct = Wrapper::Tree.new(arg)
+        else
+          raise "invalid type"
+        end
+      end
+      
+      def oid
+        return @oid if @oid
+        @oid = Net::SNMP.get_oid(label)
+      end
+
+      # actually seems like list is linked backward, so this will retrieve the previous oid numerically
+      def next
+        return nil unless @struct.next_peer
+        self.class.new(@struct.next_peer)
+      end
+      
+      def parent
+        return nil unless @struct.parent
+        self.class.new(@struct.parent)
+      end
+      
+      def children
+        return nil unless @struct.child_list
+        child = self.class.new(@struct.child_list)
+        children = [child]
+        while child = child.next
+          children << child
+        end
+        children.reverse  # For some reason, net-snmp returns everything backwards
+      end
+      
+      def siblings
+        parent.children
+      end
+      
+    end
+  end
+end