logstash-input-snmp 0.1.0.beta4 → 0.1.0.beta5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47e2417cd4748a579620be35c59d571e7a503a334c10d74fd3744c33432bd262
-  data.tar.gz: f625f7821f9470bf97da4d527c3f729fcd809e6d0367aba899c9168d0ac33315
+  metadata.gz: eb2edaea9339e4955345a99d3a7c36c3c11eb907d91ee91c7aadb9110a68c215
+  data.tar.gz: bcd78c64a492e9025f277a5139d7517d75e52aa741f8c7314b4b9c51c0285879
 SHA512:
-  metadata.gz: d708cb916fed7cc63dec16a548067e26edc4437feacdf7dd906d9289dc460c91e7333fe3f747d6de6613e2c586973001714404b06f6e5e7d9c8ca95c395a3ce2
-  data.tar.gz: 7463c5d563036eeafbcc0ea038d777b56f4e544575bf0d1a76cafef395605626357b1f975376838f27f7b3faa995f0974044d22cc229766fd2415eea6cce6206
+  metadata.gz: 4e6d4213da72a049d9d8f02a3e2ea9e6a93915746595bd14cb5e4c7115f74d549f97c069698090d89fc80a29095f4b399e05362e7449d2c84543cb7be0016d17
+  data.tar.gz: 50441d39a18880a799cbf444af8ddf424d7c348b9f6ef162af195cd221310008b90f5bf58805fdabeea33f21fb33deafd557f64390383a84b175480e90a69017

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.1.0.beta5
+  - Added OPAQUE type coercion [#29](https://github.com/logstash-plugins/logstash-input-snmp/pull/29)
+  - Added SNMPv3 support [#27](https://github.com/logstash-plugins/logstash-input-snmp/pull/27)
+  - Added support for provided MIBs [#25](https://github.com/logstash-plugins/logstash-input-snmp/pull/25)
+
 ## 0.1.0.beta4
   - Fixed missing coercions [#12](https://github.com/logstash-plugins/logstash-input-snmp/pull/12)
 

data/lib/logstash/inputs/snmp.rb

@@ -4,6 +4,7 @@ require "logstash/namespace"
 require "stud/interval"
 require "socket" # for Socket.gethostname
 require_relative "snmp/client"
+require_relative "snmp/clientv3"
 require_relative "snmp/mib"
 
 # Generate a repeating message.
@@ -26,11 +27,15 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
   #  for example `host => "udp:127.0.0.1/161"`
   # Each host definition can optionally include the following keys and values:
   #  `community` with a default value of `public`
-  #  `version` `1` or `2c` with a default value of `2c`
-  #  `retries` with a detault value of `2`
+  #  `version` `1`, `2c` or `3` with a default value of `2c`
+  #  `retries` with a default value of `2`
   #  `timeout` in milliseconds with a default value of `1000`
   config :hosts, :validate => :array  #[ {"host" => "udp:127.0.0.1/161", "community" => "public"} ]
 
+  # This plugin provides sets of MIBs publicly available. The full paths to these provided MIBs paths
+  # Will be displayed at plugin startup.
+  config :use_provided_mibs, :validate => :boolean, :default => true
+
   # List of paths of MIB .dic files of dirs. If a dir path is specified, all files with .dic extension will be loaded.
   #
   # ATTENTION: a MIB .dic file must be generated using the libsmi library `smidump` command line utility
@@ -50,28 +55,65 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
 
   # Set polling interval in seconds
   #
-  # The default, `30`, means poll each host every 30second.
+  # The default, `30`, means poll each host every 30 seconds.
   config :interval, :validate => :number, :default => 30
 
   # Add the default "host" field to the event.
   config :add_field, :validate => :hash, :default => { "host" => "%{[@metadata][host_address]}" }
 
+  # SNMPv3 Credentials
+  #
+  # A single user can be configured and will be used for all defined SNMPv3 hosts.
+  # Multiple snmp input declarations will be needed if multiple SNMPv3 users are required.
+  # If not using SNMPv3 simply leave options empty.
+
+  # The SNMPv3 security name or user name
+  config :security_name, :validate => :string
+
+  # The SNMPv3 authentication protocol or type
+  config :auth_protocol, :validate => ["md5", "sha", "sha2", "hmac128sha224", "hmac192sha256", "hmac256sha384", "hmac384sha512"]
+
+  # The SNMPv3 authentication passphrase or password
+  config :auth_pass, :validate => :password
+
+  # The SNMPv3 privacy/encryption protocol
+  config :priv_protocol, :validate => ["des", "3des", "aes", "aes128", "aes192", "aes256"]
+
+  # The SNMPv3 encryption password
+  config :priv_pass, :validate => :password
+
+  # The SNMPv3 security level can be Authentication, No Privacy; Authentication, Privacy; or no Authentication, no Privacy
+  config :security_level, :validate => ["noAuthNoPriv", "authNoPriv", "authPriv"]
+
+  BASE_MIB_PATH = ::File.join(__FILE__, "..", "..", "..", "mibs")
+  PROVIDED_MIB_PATHS = [::File.join(BASE_MIB_PATH, "logstash"), ::File.join(BASE_MIB_PATH, "ietf")].map { |path| ::File.expand_path(path) }
+
   def register
     validate_oids!
     validate_hosts!
 
     mib = LogStash::SnmpMib.new
+
+    if @use_provided_mibs
+      PROVIDED_MIB_PATHS.each do |path|
+        logger.info("using plugin provided MIB path #{path}")
+        mib.add_mib_path(path)
+      end
+    end
+
     Array(@mib_paths).each do |path|
-      # TODO handle errors
+      logger.info("using user provided MIB path #{path}")
       mib.add_mib_path(path)
     end
 
+    # setup client definitions per provided host
+
     @client_definitions = []
     @hosts.each do |host|
       host_name = host["host"]
       community = host["community"] || "public"
       version = host["version"] || "2c"
-      raise(LogStash::ConfigurationError, "only protocol version '1' and '2c' are supported for host option '#{host_name}'") unless version =~ VERSION_REGEX
+      raise(LogStash::ConfigurationError, "only protocol version '1', '2c' and '3' are supported for host option '#{host_name}'") unless version =~ VERSION_REGEX
 
       retries = host["retries"] || 2
       timeout = host["timeout"] || 1000
@@ -86,7 +128,6 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
       port = host_details[:host_port]
 
       definition = {
-        :client => LogStash::SnmpClient.new(protocol, address, port, community, version, retries, timeout, mib),
         :get => Array(get),
         :walk => Array(walk),
 
@@ -95,6 +136,15 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
         :host_port => port,
         :host_community => community,
       }
+
+      if version == "3"
+        validate_v3_user! # don't really care if verified for every host
+        auth_pass = @auth_pass.nil? ? nil : @auth_pass.value
+        priv_pass = @priv_pass.nil? ? nil : @priv_pass.value
+        definition[:client] = LogStash::SnmpClientV3.new(protocol, address, port, retries, timeout, mib, @security_name, @auth_protocol, auth_pass, @priv_protocol, priv_pass, @security_level)
+      else
+        definition[:client] = LogStash::SnmpClient.new(protocol, address, port, community, version, retries, timeout, mib)
+      end
       @client_definitions << definition
     end
   end
@@ -109,7 +159,7 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
           begin
             result = result.merge(definition[:client].get(definition[:get], @oid_root_skip))
           rescue => e
-            logger.error("error invoking get operation on OIDs: #{definition[:get]}, ignoring", :exception => e, :backtrace => e.backtrace)
+            logger.error("error invoking get operation on #{definition[:host_address]} for OIDs: #{definition[:get]}, ignoring", :exception => e, :backtrace => e.backtrace)
           end
         end
         if  !definition[:walk].empty?
@@ -124,10 +174,10 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
 
         unless result.empty?
           metadata = {
-              "host_protocol" => definition[:host_protocol],
-              "host_address" => definition[:host_address],
-              "host_port" => definition[:host_port],
-              "host_community" => definition[:host_community],
+            "host_protocol" => definition[:host_protocol],
+            "host_address" => definition[:host_address],
+            "host_port" => definition[:host_port],
+            "host_community" => definition[:host_community],
           }
           result["@metadata"] = metadata
 
@@ -148,7 +198,7 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
 
   OID_REGEX = /^\.?([0-9\.]+)$/
   HOST_REGEX = /^(?<host_protocol>udp|tcp):(?<host_address>.+)\/(?<host_port>\d+)$/i
-  VERSION_REGEX =/^1|2c$/
+  VERSION_REGEX =/^1|2c|3$/
 
   def validate_oids!
     @get = Array(@get).map do |oid|
@@ -170,6 +220,19 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
     raise(LogStash::ConfigurationError, "at least one get OID or one walk OID is required") if @get.empty? && @walk.empty?
   end
 
+  def validate_v3_user!
+    errors = []
+
+    errors << "v3 user must have a \"security_name\" option" if @security_name.nil?
+    errors << "you must specify an auth protocol if you specify an auth pass" if @auth_protocol.nil? && !@auth_pass.nil?
+    errors << "you must specify an auth pass if you specify an auth protocol" if !@auth_protocol.nil? && @auth_pass.nil?
+    errors << "you must specify a priv protocol if you specify a priv pass" if @priv_protocol.nil? && !@priv_pass.nil?
+    errors << "you must specify a priv pass if you specify a priv protocol" if !@priv_protocol.nil? &&  @priv_pass.nil?
+
+    raise(LogStash::ConfigurationError, errors.join(", ")) unless errors.empty?
+   end
+
+
   def validate_hosts!
     # TODO: for new we only validate the host part, not the other optional options
 

data/lib/logstash/inputs/snmp/base_client.rb

@@ -0,0 +1,162 @@
+require "java"
+require "logstash-input-snmp_jars.rb"
+
+java_import "org.snmp4j.CommunityTarget"
+java_import "org.snmp4j.PDU"
+java_import "org.snmp4j.ScopedPDU"
+java_import "org.snmp4j.Snmp"
+java_import "org.snmp4j.Target"
+java_import "org.snmp4j.TransportMapping"
+java_import "org.snmp4j.event.ResponseEvent"
+java_import "org.snmp4j.mp.SnmpConstants"
+java_import "org.snmp4j.smi.Address"
+java_import "org.snmp4j.smi.GenericAddress"
+java_import "org.snmp4j.smi.OID"
+java_import "org.snmp4j.smi.OctetString"
+java_import "org.snmp4j.smi.VariableBinding"
+java_import "org.snmp4j.transport.DefaultUdpTransportMapping"
+java_import "org.snmp4j.transport.DefaultTcpTransportMapping"
+java_import "org.snmp4j.util.TreeUtils"
+java_import "org.snmp4j.util.DefaultPDUFactory"
+java_import "org.snmp4j.asn1.BER"
+
+module LogStash
+  class SnmpClientError < StandardError
+  end
+
+  class BaseSnmpClient
+
+    def initialize(protocol, address, port, retries, timeout, mib)
+      transport = case protocol.to_s
+        when "udp"
+          DefaultUdpTransportMapping.new
+        when "tcp"
+          DefaultTcpTransportMapping.new
+        else
+          raise(SnmpClientError, "invalid transport protocol specified '#{protocol.to_s}', expecting 'udp' or 'tcp'")
+        end
+
+      @mib = mib
+      @snmp = Snmp.new(transport)
+      transport.listen()
+    end
+
+    def get(oids, strip_root = 0)
+      pdu = get_pdu
+      Array(oids).each { |oid| pdu.add(VariableBinding.new(OID.new(oid))) }
+
+      response_event = @snmp.send(pdu, @target, nil)
+      return nil if response_event.nil?
+
+      e = response_event.getError
+      raise(SnmpClientError, "error sending snmp get request: #{e.inspect}, #{e.getMessage}") if e
+
+      result = {}
+      response_pdu = response_event.getResponse
+      raise(SnmpClientError, "timeout sending snmp get request") if response_pdu.nil?
+
+      size = response_pdu.size
+      (0..size - 1).each do |i|
+        variable_binding = response_pdu.get(i)
+        oid = variable_binding.getOid.toString
+        variable = variable_binding.getVariable
+        value = coerce(variable)
+
+        result[@mib.map_oid(oid, strip_root)] = value
+      end
+
+      result
+    end
+
+
+    def walk(oid, strip_root = 0)
+      result = {}
+
+      pdufactory = get_pdu_factory
+      treeUtils = TreeUtils.new(@snmp, pdufactory)
+      events = treeUtils.getSubtree(@target, OID.new(oid))
+      return nil if events.nil? || events.size == 0
+
+      events.each do |event|
+        next if event.nil?
+
+        if event.isError
+          # TODO: see if we can salvage non errored event here
+          raise(SnmpClientError, "error sending snmp walk request: #{event.getErrorMessage}")
+        end
+
+        var_bindings = event.getVariableBindings
+        next if var_bindings.nil? || var_bindings.size == 0
+
+        var_bindings.each do |var_binding|
+          next if var_binding.nil?
+
+          oid = var_binding.getOid.toString
+          variable = var_binding.getVariable
+          value = coerce(variable)
+
+          result[@mib.map_oid(oid, strip_root)] = value
+        end
+      end
+
+      result
+    end
+
+    protected
+
+    NULL_STRING = "null".freeze
+
+    def coerce(variable)
+      variable_syntax = variable.getSyntax
+      # puts("variable.getSyntaxString=#{variable.getSyntaxString}")
+      case variable_syntax
+        when BER::OCTETSTRING, BER::BITSTRING
+          variable.toString
+        when BER::TIMETICKS, BER::COUNTER, BER::COUNTER32, BER::COUNTER64
+          variable.toLong
+        when BER::INTEGER, BER::INTEGER32, BER::GAUGE, BER::GAUGE32
+          variable.toInt
+        when BER::IPADDRESS
+          variable.toString
+        when BER::OID
+          variable.toString
+        when BER::NULL
+          NULL_STRING
+        when BER::OPAQUE
+          variable.toString
+        when BER::NOSUCHOBJECT
+          "Error: No Such Instance currently exists at this OID"
+        else
+          raise(SnmpClientError, "unknown variable syntax #{variable_syntax}, #{variable.getSyntaxString}")
+      end
+    end
+
+
+    def parse_version(version)
+      case version.to_s
+        when "3"
+          SnmpConstants.version3
+        when "2c"
+          SnmpConstants.version2c
+        when "1"
+          SnmpConstants.version1
+        else
+          raise(SnmpClientError, "protocol version '#{version}' is not supported, expected versions are '1', '2c' and '3'")
+      end
+    end
+
+    private
+
+    def get_pdu
+      raise("abstract method")
+    end
+
+    def get_pdu_factory
+      raise("abstract method")
+    end
+
+    def build_target(*args)
+      raise("abstract method")
+    end
+  end
+end

data/lib/logstash/inputs/snmp/client.rb

@@ -1,8 +1,10 @@
 require "java"
 require "logstash-input-snmp_jars.rb"
+require_relative "base_client"
 
 java_import "org.snmp4j.CommunityTarget"
 java_import "org.snmp4j.PDU"
+java_import "org.snmp4j.ScopedPDU"
 java_import "org.snmp4j.Snmp"
 java_import "org.snmp4j.Target"
 java_import "org.snmp4j.TransportMapping"
@@ -20,113 +22,24 @@ java_import "org.snmp4j.util.DefaultPDUFactory"
 java_import "org.snmp4j.asn1.BER"
 
 module LogStash
-  class SnmpClientError < StandardError
-  end
-
-  class SnmpClient
+  class SnmpClient < BaseSnmpClient
 
     def initialize(protocol, address, port, community, version, retries, timeout, mib)
-      transport = case protocol.to_s
-        when "udp"
-          DefaultUdpTransportMapping.new
-        when "tcp"
-          DefaultTcpTransportMapping.new
-        else
-          raise(SnmpClientError, "invalid transport protocol specified '#{protocol.to_s}', expecting 'udp' or 'tcp'")
-        end
-
+      super(protocol, address, port, retries, timeout, mib)
+      raise(SnmpClientError, "SnmpClient is expecting verison '1' or '2c'") unless ["1", "2c"].include?(version.to_s)
       @target = build_target("#{protocol}:#{address}/#{port}", community, version, retries, timeout)
-      @mib = mib
-
-      @snmp = Snmp.new(transport)
-      transport.listen()
     end
 
-    def get(oids, strip_root = 0)
+    private
+
+    def get_pdu
       pdu = PDU.new
-      Array(oids).each { |oid| pdu.add(VariableBinding.new(OID.new(oid))) }
       pdu.setType(PDU::GET)
-
-      response_event = @snmp.send(pdu, @target, nil)
-      return nil if response_event.nil?
-
-      e = response_event.getError
-      raise(SnmpClientError, "error sending snmp get request: #{e.inspect}, #{e.getMessage}") if e
-
-      result = {}
-      response_pdu = response_event.getResponse
-      raise(SnmpClientError, "timeout sending snmp get request") if response_pdu.nil?
-
-      size = response_pdu.size
-      (0..size - 1).each do |i|
-        variable_binding = response_pdu.get(i)
-        oid = variable_binding.getOid.toString
-        variable = variable_binding.getVariable
-        value = coerce(variable)
-
-        result[@mib.map_oid(oid, strip_root)] = value
-      end
-
-      result
+      pdu
     end
 
-
-    def walk(oid, strip_root = 0)
-      result = {}
-      treeUtils = TreeUtils.new(@snmp, DefaultPDUFactory.new)
-      events = treeUtils.getSubtree(@target, OID.new(oid))
-      return nil if events.nil? || events.size == 0
-
-      events.each do |event|
-        next if event.nil?
-
-        if event.isError
-          # TODO: see if we can salvage non errored event here
-          raise(SnmpClientError, "error sending snmp walk request: #{event.getErrorMessage}")
-        end
-
-        var_bindings = event.getVariableBindings
-        next if var_bindings.nil? || var_bindings.size == 0
-
-        var_bindings.each do |var_binding|
-          next if var_binding.nil?
-
-          oid = var_binding.getOid.toString
-          variable = var_binding.getVariable
-          value = coerce(variable)
-
-          result[@mib.map_oid(oid, strip_root)] = value
-         end
-      end
-
-      result
-    end
-
-    private
-
-    NULL_STRING = "null".freeze
-
-    def coerce(variable)
-      variable_syntax = variable.getSyntax
-      # puts("variable.getSyntaxString=#{variable.getSyntaxString}")
-      case variable_syntax
-      when BER::OCTETSTRING, BER::BITSTRING
-        variable.toString
-      when BER::TIMETICKS, BER::COUNTER, BER::COUNTER32, BER::COUNTER64
-        variable.toLong
-      when BER::INTEGER, BER::INTEGER32, BER::GAUGE, BER::GAUGE32
-        variable.toInt
-      when BER::IPADDRESS
-        variable.toString
-      when BER::OID
-        variable.toString
-      when BER::NULL
-        NULL_STRING
-      when BER::NOSUCHOBJECT
-        "Error: No Such Instance currently exists at this OID"
-      else
-        raise(SnmpClientError, "unknown variable syntax #{variable_syntax}, #{variable.getSyntaxString}")
-      end
+    def get_pdu_factory
+      DefaultPDUFactory.new
     end
 
     def build_target(address, community, version, retries, timeout)
@@ -138,16 +51,5 @@ module LogStash
       target.setVersion(parse_version(version))
       target
     end
-
-    def parse_version(version)
-      case version.to_s
-      when "2c"
-        SnmpConstants.version2c
-      when "1"
-        SnmpConstants.version1
-      else
-        raise(SnmpClientError, "protocol version '#{version}' is not supported, expected versions are '1' and '2c'")
-      end
-    end
   end
 end