logstash-input-snmp 0.1.0.beta2 → 0.1.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5599c9705618d89025096ef93521fc9af9c3459b34e57e1dabe3b697918ffca1
-  data.tar.gz: 3b86026c9b6239f0628408d39926a757d7308c0d72b6fdf6a5742f2cc2cc2c1b
+  metadata.gz: 4cbe158bdaf1a09765f4f5590c770c85cd5005a094ee867ac97b720f39b69bab
+  data.tar.gz: 4be94637f117dd5e5e31d29c58c25e8c50aa307266f4b15b37bc749dcee3e462
 SHA512:
-  metadata.gz: c03af9c1da2efbbdccff38d322ed7b8f15331cca3de4b987d22145c2b150d1c93a65035a664d88a245c89e0461ba3a89236a429b3d806cc996503ecce55fa60a
-  data.tar.gz: da07ed21485a35b58b915f974003ad747c3ff6d4a36ed1b6ccb07d3f8066e7910ed826e8ff5f63454f2fb4af5cc663aceb8755f18959f35d016bc19e137e46a2
+  metadata.gz: dbe55fe3d13e49d62c4a7376aef50f3daf38e19aeaddcb9dd32c933d648a1dc2fb69adb6625e3cc24d05559cf20faa25bf6785192299ae5da3781c1bf7a240fd
+  data.tar.gz: 8f93b7fbb5005b8c4321e7d39534b7f2a540da3f2aa0b6d30c433d66f59578bcf5af042db64533fd54b2869404aff9ecf0af4bd6feb91f4f1400c33511ffe1cd

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.0.beta3
+  - add tcp transport protocol support, https://github.com/logstash-plugins/logstash-input-snmp/pull/8
+  - add SNMPv1 protocol version support, https://github.com/logstash-plugins/logstash-input-snmp/pull/9
+
 ## 0.1.0.beta2
   - add host info in metadata and host field, https://github.com/logstash-plugins/logstash-input-snmp/pull/7
 

data/lib/logstash/inputs/snmp.rb

@@ -26,7 +26,7 @@ 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` with a default value of `2c`
+  #  `version` `1` or `2c` with a default value of `2c`
   #  `retries` with a detault 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"} ]
@@ -71,21 +71,28 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
       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
+
       retries = host["retries"] || 2
       timeout = host["timeout"] || 1000
 
+      # TODO: move these validations in a custom validator so it happens before the register method is called.
       host_details = host_name.match(HOST_REGEX)
       raise(LogStash::ConfigurationError, "invalid format for host option '#{host_name}'") unless host_details
-      raise(LogStash::ConfigurationError, "only the udp protocol is supported for now") unless host_details[:host_protocol].to_s =~ /udp/i
+      raise(LogStash::ConfigurationError, "only udp & tcp protocols are supported for host option '#{host_name}'") unless host_details[:host_protocol].to_s =~ /^(?:udp|tcp)$/i
+
+      protocol = host_details[:host_protocol]
+      address = host_details[:host_address]
+      port = host_details[:host_port]
 
       definition = {
-        :client => LogStash::SnmpClient.new(host_name, community, version, retries, timeout, mib),
+        :client => LogStash::SnmpClient.new(protocol, address, port, community, version, retries, timeout, mib),
         :get => Array(get),
         :walk => Array(walk),
 
-        :host_protocol => host_details[:host_protocol],
-        :host_address => host_details[:host_address],
-        :host_port => host_details[:host_port],
+        :host_protocol => protocol,
+        :host_address => address,
+        :host_port => port,
         :host_community => community,
       }
       @client_definitions << definition
@@ -141,6 +148,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$/
 
   def validate_oids!
     @get = Array(@get).map do |oid|

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

@@ -14,6 +14,7 @@ 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"
@@ -24,12 +25,19 @@ module LogStash
 
   class SnmpClient
 
-    def initialize(address, community, version, retries, timeout, mib)
-      @target = build_target(address, community, version, retries, timeout)
+    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
+
+      @target = build_target("#{protocol}:#{address}/#{port}", community, version, retries, timeout)
       @mib = mib
 
-      # for now hardwired udp transport
-      transport = DefaultUdpTransportMapping.new
       @snmp = Snmp.new(transport)
       transport.listen()
     end
@@ -128,8 +136,14 @@ module LogStash
     end
 
     def parse_version(version)
-      # TODO implement
-      SnmpConstants.version2c
+      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

data/logstash-input-snmp.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'logstash-input-snmp'
-  s.version       = '0.1.0.beta2'
+  s.version       = '0.1.0.beta3'
   s.licenses      = ['Apache-2.0']
   s.summary       = "SNMP input plugin"
   s.description   = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"

data/spec/inputs/snmp_spec.rb

@@ -54,19 +54,25 @@ describe LogStash::Inputs::Snmp do
           {"get" => ["1.0"], "hosts" => [{"host" => "udp:localhost/161"}]},
           {"get" => ["1.0"], "hosts" => [{"host" => "udp:127.0.0.1/112345"}]},
           {"get" => ["1.0"], "hosts" => [{"host" => "udp:127.0.0.1/161", "community" => "public"}]},
+          {"get" => ["1.0"], "hosts" => [{"host" => "tcp:127.0.0.1/112345"}]},
+          {"get" => ["1.0"], "hosts" => [{"host" => "tcp:127.0.0.1/161", "community" => "public"}]},
+          {"get" => ["1.0"], "hosts" => [{"host" => "udp:127.0.0.1/161", "version" => "1"}]},
+          {"get" => ["1.0"], "hosts" => [{"host" => "udp:127.0.0.1/161", "version" => "2c"}]},
       ]
     }
 
     let(:invalid_configs) {
       [
           {"get" => ["1.0"], "hosts" => [{"host" => "aaa:127.0.0.1/161"}]},
-          {"get" => ["1.0"], "hosts" => [{"host" => "tcp:127.0.0.1/161"}]},
+          {"get" => ["1.0"], "hosts" => [{"host" => "tcp.127.0.0.1/161"}]},
           {"get" => ["1.0"], "hosts" => [{"host" => "localhost"}]},
           {"get" => ["1.0"], "hosts" => [{"host" => "localhost/161"}]},
           {"get" => ["1.0"], "hosts" => [{"host" => "udp:127.0.0.1"}]},
           {"get" => ["1.0"], "hosts" => [{"host" => "udp:127.0.0.1/"}]},
           {"get" => ["1.0"], "hosts" => [{"host" => "udp:127.0.0.1/aaa"}]},
           {"get" => ["1.0"], "hosts" => [{"host" => "udp:127.0.0.1/161"}, {"host" => "udp:127.0.0.1/aaa"}]},
+          {"get" => ["1.0"], "hosts" => [{"host" => "udp:127.0.0.1/161", "version" => "2"}]},
+          {"get" => ["1.0"], "hosts" => [{"host" => "udp:127.0.0.1/161", "version" => "3"}]},
           {"get" => ["1.0"], "hosts" => ""},
           {"get" => ["1.0"], "hosts" => []},
           {"get" => ["1.0"] },

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-snmp
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta2
+  version: 0.1.0.beta3
 platform: ruby
 authors:
 - Elasticsearch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-05-30 00:00:00.000000000 Z
+date: 2018-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement