netsnmp 0.0.0

data/Rakefile

@@ -0,0 +1,26 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'coveralls/rake/task'
+
+desc "runs the tests and sends to coveralls server"
+Coveralls::RakeTask.new
+
+desc "runs the tests"
+RSpec::Core::RakeTask.new
+
+task default: [:spec]
+
+
+
+namespace :spec do
+  desc "runs the tests in coverage mode"
+  task :coverage do
+    ENV['COVERAGE'] = "true"
+    Rake::Task["spec"].execute
+  end
+
+  desc "runs tests, check coverage, pushes to coverage server"
+  task :ci => ['spec:coverage', 'coveralls:push']
+end
+
+

data/lib/netsnmp.rb

@@ -0,0 +1,16 @@
+require 'netsnmp/version'
+
+# core structures
+require 'netsnmp/core'
+
+module NETSNMP
+  # @return [String] the version of the netsnmp C library
+  def self.version ; Core.version ; end
+end
+
+require 'netsnmp/errors'
+require 'netsnmp/varbind'
+require 'netsnmp/oid'
+require 'netsnmp/pdu'
+require 'netsnmp/session'
+require 'netsnmp/client'

data/lib/netsnmp/client.rb

@@ -0,0 +1,131 @@
+module NETSNMP
+  # Main Entity, provides the user-facing API to communicate with SNMP Agents
+  #
+  # Under the hood it creates a "session" (analogous to the net-snmp C session), which will be used
+  # to proxy all the communication to the agent. the Client ensures that you only write pure ruby and
+  # read pure ruby, not concerning with snmp-speak like PDUs, varbinds and the like. 
+  #
+  #
+  class Client
+    
+    # @param [String] hostname the hostname of the agent
+    # @param [Hash] options the set of options to open the session.
+    #
+    # @see Session#initialize
+    def initialize(hostname, options)
+      @session ||= Session.new(hostname, options)
+    end
+
+    # @see Session#close
+    def close
+      @session.close
+    end
+
+    # Performs an SNMP GET Request
+    # 
+    # @param [OID, String] oid_code the oid to get
+    # @param [Hash] options the varbind options (see Varbind)
+    # @option options [true, false] :response_pdu if true, the method returns a PDU
+    #
+    # @return [String] the value for the oid
+    #
+    def get(oid_code, **options)
+      request_pdu = RequestPDU.build(:get)
+      oid = oid_code.is_a?(OID) ? oid_code : OID.new(oid_code)
+      request_pdu.add_varbind(oid, options)
+      yield request_pdu if block_given? 
+      response_pdu = @session.send(request_pdu)
+      case options[:response_type] 
+        when :pdu then response_pdu
+        else response_pdu.value
+      end
+    end
+
+    # Performs an SNMP GETNEXT Request
+    # 
+    # @param [OID, String] oid_code the oid to get
+    # @param [Hash] options the varbind options (see Varbind)
+    # @option options [true, false] :response_pdu if true, the method returns a PDU
+    #
+    # @return [String] the value for the next oid
+    # 
+    # @note this method is used as a sub-routine for the walk
+    #
+    def get_next(oid_code, **options)
+      request_pdu = RequestPDU.build(:getnext)
+      oid = oid_code.is_a?(OID) ? oid_code : OID.new(oid_code)
+      request_pdu.add_varbind(oid, options)
+      yield request_pdu if block_given? 
+      response_pdu = @session.send(request_pdu)
+      case options[:response_type] 
+        when :pdu then response_pdu
+        else response_pdu.value
+      end
+    end
+
+    # Perform a SNMP Walk (issues multiple subsequent GENEXT requests within the subtree rooted on an OID)
+    #
+    # @param [OID, String] oid_code the root oid from the subtree
+    # @param [Hash] options the varbind options 
+    #
+    # @return [Enumerator] the enumerator-collection of the oid-value pairs
+    #
+    def walk(oid_code, **options)
+      options[:response_type] = :pdu
+      walkoid = oid_code.is_a?(OID) ? oid_code : OID.new(oid_code)
+      Enumerator.new do |y|
+        code = walkoid.code
+        catch(:walk) do
+          loop do
+            response_pdu = get_next(code, options)
+            response_pdu.varbinds.each do |varbind|
+              code = varbind.oid_code
+              if !walkoid.parent_of?(code) or varbind.value.eql?(:endofmibview)
+                throw(:walk)             
+              else
+                y << [code, varbind.value]
+              end
+            end
+          end
+        end
+      end
+    end
+
+    # Perform a SNMP GETBULK Request (performs multiple GETNEXT)
+    #
+    # @param [OID, String] oid_code the first oid
+    # @param [Hash] options the varbind options 
+    # @option options [Integer] :errstat sets the number of objects expected for the getnext instance
+    # @option options [Integer] :errindex number of objects repeating for all the repeating IODs. 
+    #
+    # @return [Enumerator] the enumerator-collection of the oid-value pairs
+    #
+    def get_bulk(oid_code, **options)
+      request_pdu = RequestPDU.build(:getbulk)
+      request_pdu[:errstat]  = options.delete(:non_repeaters) || 0
+      request_pdu[:errindex] = options.delete(:max_repetitions) || 10
+      request_pdu.add_varbind(OID.new(oid_code), options)
+      yield request_pdu if block_given? 
+      response_pdu = @session.send(request_pdu)
+      Enumerator.new do |y|
+        response_pdu.varbinds.each do |varbind|
+          y << [ varbind.oid_code, varbind.value ]
+        end
+      end
+    end
+
+    # Perform a SNMP SET Request
+    #
+    # @param [OID, String] oid_code the oid to update
+    # @param [Hash] options the varbind options 
+    # @option options [Object] :value value to update the oid with. 
+    #
+    def set(oid_code, **options)
+      request_pdu = PDU.build(:set)
+      request_pdu.add_varbind(OID.new(oid_code), options)
+      yield request_pdu if block_given? 
+      response_pdu = @session.send(request_pdu)
+      response_pdu.value
+    end
+  end
+end

data/lib/netsnmp/core.rb

@@ -0,0 +1,12 @@
+require 'ffi'
+
+require 'netsnmp/core/libc'
+require 'netsnmp/core/constants'
+require 'netsnmp/core/structures'
+require 'netsnmp/core/libsnmp'
+require 'netsnmp/core/inline'
+require 'netsnmp/core/utilities'
+
+module NETSNMP::Core
+  LibSNMP.init_snmp("snmp")
+end

data/lib/netsnmp/core/client.rb

@@ -0,0 +1,15 @@
+require 'socket'
+module SNMP
+  module Client
+    # RFC 2571
+
+    def bang(options={})
+      hostname, port = options.values_at(:hostname, :port)
+
+      sock = UDPSocket.new
+      sock.bind(hostname, port)
+
+    end
+
+  end
+end

data/lib/netsnmp/core/constants.rb

@@ -0,0 +1,153 @@
+module NETSNMP::Core
+  # Sets all the constants necessary to recognize from the structures
+  module Constants
+    MAX_OID_LEN = 128
+
+    # Return values of various send functions
+    STAT_SUCCESS        = 0
+    STAT_ERROR          = 1
+    STAT_TIMEOUT        = 2
+
+    SNMP_VERSION_1 = 0
+    SNMP_VERSION_2c = 1
+    SNMP_VERSION_3 = 3
+
+
+    USM_AUTH_KU_LEN = 32
+    USM_PRIV_KU_LEN = 32
+
+    # SNMPv3 Security Levels
+    SNMP_SEC_LEVEL_NOAUTH = 1
+    SNMP_SEC_LEVEL_AUTHNOPRIV = 2
+    SNMP_SEC_LEVEL_AUTHPRIV = 3
+
+    # SNMP Errors
+    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)
+
+    # PDU variable types
+    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)
+    ASN_NSAP        = (ASN_APPLICATION | 5)  # historic - don't use
+    ASN_COUNTER64   = (ASN_APPLICATION | 6)
+    ASN_UINTEGER    = (ASN_APPLICATION | 7)   # historic - don't use
+
+    # Exception types for SNMPv2 and SNMPv3 (no value needed)
+    SNMP_NOSUCHOBJECT   = (ASN_CONTEXT | ASN_PRIMITIVE | 0x0)
+    SNMP_NOSUCHINSTANCE = (ASN_CONTEXT | ASN_PRIMITIVE | 0x1)
+    SNMP_ENDOFMIBVIEW   = (ASN_CONTEXT | ASN_PRIMITIVE | 0x2)
+
+
+    # PDU types
+    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)
+
+
+    # Callback status codes
+    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
+
+  end
+end
+

data/lib/netsnmp/core/inline.rb

@@ -0,0 +1,20 @@
+module NETSNMP::Core
+  module Inline
+    if RUBY_PLATFORM == "java"
+      def self.oid_size ; FFI::Pointer.size ; end
+    else
+      require 'inline'
+        inline do |builder|
+    #      builder.include "sys/select.h"
+          builder.include "<net-snmp/net-snmp-config.h>"
+          builder.include "<net-snmp/types.h>"
+          #builder.include "stdio.h"
+          builder.c_singleton %q{
+            int oid_size() {
+              return sizeof(oid);
+            }
+          }
+      end
+    end
+  end
+end

data/lib/netsnmp/core/libc.rb

@@ -0,0 +1,48 @@
+module NETSNMP::Core
+  module C
+    extend FFI::Library
+    ffi_lib(FFI::Library::LIBC).first
+  
+    typedef :pointer, :FILE
+    typedef :uint32, :in_addr_t
+    typedef :uint16, :in_port_t
+  
+    unless FFI::Platform::IS_WINDOWS
+      attach_function :getdtablesize, [], :int
+    end
+  
+    class Timeval < FFI::Struct
+      if FFI::Platform::IS_WINDOWS
+        layout(
+          :sec, :long,  
+          :usec, :long
+        )
+      else
+        layout(
+          :tv_sec, :time_t,
+          :tv_usec, :suseconds_t
+        )
+      end
+    end
+  
+    class FDSet < ::FFI::Struct
+      if FFI::Platform::IS_WINDOWS
+        layout(
+          :fd_count, :uint,
+          # TODO: Make it future proof by dynamically grabbing FD_SETSIZE.
+          :fd_array, [:uint, 2048]
+        )
+        def clear; self[:fd_count] = 0; end
+      else
+        # FD Set size.
+        FD_SETSIZE = C.getdtablesize
+        layout(
+          :fds_bits, [:long, FD_SETSIZE / FFI::Type::LONG.size]
+        )
+  
+        # :nodoc:
+        def clear; super; end
+      end
+    end
+  end
+end

data/lib/netsnmp/core/libsnmp.rb

@@ -0,0 +1,44 @@
+module NETSNMP::Core
+  module LibSNMP
+    extend FFI::Library
+    ffi_lib ["libnetsnmp", "netsnmp"]
+  
+    callback(:snmp_callback, [ :int, :pointer, :int, :pointer, :pointer ], :int)
+    callback(:netsnmp_callback, [ :int, :pointer, :int, :pointer, :pointer ], :int)
+  
+    # checks whether the oid is supported
+    attach_function :read_objid, [:string, :pointer, :pointer], :int, blocking: true
+    # checks whether the mib is supported
+    attach_function :get_node, [:string, :pointer, :pointer], :int, blocking: true
+  
+    # initializes internal stuff, loads mibs, etc etc etc...
+    attach_function :init_snmp, [ :string ], :void, blocking: true
+  
+    # PDU API
+    attach_function :snmp_clone_pdu, [ :pointer ], :pointer
+    attach_function :snmp_pdu_type, [ :int ], :string
+    attach_function :snmp_pdu_add_variable, [ :pointer, :pointer, :uint, :u_char, :pointer, :size_t ], :pointer, blocking: true
+    attach_function :snmp_free_pdu, [ :pointer ], :void, blocking: true
+    attach_function :snmp_pdu_create, [:int], :pointer, blocking: true
+  
+    # session handling
+    attach_function :generate_Ku, [:pointer, :int, :string, :int, :pointer, :pointer], :int, blocking: true
+    attach_function :snmp_sess_init, [ :pointer ], :void, blocking: true
+    attach_function :snmp_sess_open, [ :pointer ], :pointer, blocking: true
+    attach_function :snmp_sess_session, [ :pointer ], :pointer, blocking: true
+    attach_function :snmp_sess_close, [ :pointer ], :int, blocking: true
+  
+    # send/receive API
+    attach_function :snmp_sess_send, [ :pointer, :pointer ], :int
+    attach_function :snmp_sess_async_send, [ :pointer, :pointer, :snmp_callback, :pointer ], :int, blocking: true
+    attach_function :snmp_sess_select_info, [ :pointer, :pointer, :pointer, :pointer, :pointer ], :int, blocking: true
+    attach_function :snmp_sess_read, [ :pointer, :pointer ], :int, blocking: true
+    attach_function :snmp_sess_timeout, [ :pointer ], :void
+    attach_function :snmp_sess_synch_response, [:pointer, :pointer, :pointer], :int, blocking: true
+  
+  
+    attach_function :snmp_perror, [ :string ], :void
+  
+    attach_function :netsnmp_get_version, [], :string
+  end
+end