logstash-input-snmp 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 131263a5b332d433de705dac607ddecd0920f33827c0419c7a837adc735c4dc0
-  data.tar.gz: d1b6e99a2c8340470833dc83e2d2bb756342c332cc36ba22ac90b93caa32149b
+  metadata.gz: cb5609c18eaaec9aeef2b6061112def84acb1f2057d90bd507a785dcf452ccd4
+  data.tar.gz: 60bc0983f862f184d6b17b6e64c31c333998468d54610397b3ce4f1ed64e8163
 SHA512:
-  metadata.gz: 8b7b2c722a7eb4d81492b8f39b2aa05fd60131f1871b89ec0b122fbaed398336924a5c805bd3885a45906b2ba43a41d9579fb5d5ab456d42cc8a32df93557e51
-  data.tar.gz: c2f3d2d67868fdd602117dab01f371c76b3e8ea7406438965395e088f73db06a4b589635cb57989e7d90e6ebf9a7f0fcee4aa96aa6592572fb48686d9c3abb4d
+  metadata.gz: 0d34c2e4575a756c34dfa4680bfed5f003787aeaee5cd5a73d8408eb76dce677c540e8437d778b0875ec5c1f75677322d3dfb6d2a10f85572479c1da28e8e8a7
+  data.tar.gz: f53c711c10cc10d51b4a9919e9b0c3624176df89bc79116cb394ee10ab15266e8a61f8907346c670e9d959f2cce1c387586850dd98c9b3135d1b20a434863131

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.2.4
+  -  Fixed: support SNMPv3 multiple identical security name with different credentials [#84](https://github.com/logstash-plugins/logstash-input-snmp/pull/84)
+
 ## 1.2.3
   -  Fixed: multithreading problem when using multiple snmp inputs with multiple v3 credentials [#80](https://github.com/logstash-plugins/logstash-input-snmp/pull/80)
 

data/lib/logstash/inputs/snmp.rb

@@ -212,7 +212,14 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
     end
   end
 
-  def stop
+  def close
+    @client_definitions.each do |definition|
+      begin
+        definition[:client].close
+      rescue => e
+        logger.warn("error closing client on #{definition[:host_address]}, ignoring", :exception => e)
+      end
+    end
   end
 
   private

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

@@ -7,42 +7,6 @@ module LogStash
   class SnmpClientError < StandardError
   end
 
-  # Only one Snmp instance per transport should be created and listened on.
-  # The Snmp object is thread safe and can be shared across input threads and pipelines.
-  class SnmpFactory
-    java_import "org.snmp4j.Snmp"
-    java_import "org.snmp4j.transport.DefaultUdpTransportMapping"
-    java_import "org.snmp4j.transport.DefaultTcpTransportMapping"
-
-    include Singleton
-
-    def initialize
-      @lock = Mutex.new
-      @udp = nil
-      @tcp = nil
-    end
-
-    def udp
-      @lock.synchronize do
-        if @udp.nil?
-          @udp = Snmp.new(DefaultUdpTransportMapping.new)
-          @udp.listen
-        end
-      end
-      @udp
-    end
-
-    def tcp
-      @lock.synchronize do
-        if @tcp.nil?
-          @tcp = Snmp.new(DefaultTcpTransportMapping.new)
-          @tcp.listen
-        end
-      end
-      @tcp
-    end
-  end
-
   class BaseSnmpClient
     java_import "org.snmp4j.TransportMapping"
     java_import "org.snmp4j.mp.SnmpConstants"
@@ -51,20 +15,13 @@ module LogStash
     java_import "org.snmp4j.util.TableUtils"
     java_import "org.snmp4j.util.TreeUtils"
     java_import "org.snmp4j.asn1.BER"
+    java_import "org.snmp4j.transport.DefaultUdpTransportMapping"
+    java_import "org.snmp4j.transport.DefaultTcpTransportMapping"
 
     include LogStash::Util::Loggable
 
     def initialize(protocol, address, port, retries, timeout, mib)
       @mib = mib
-
-      transport = case protocol.to_s
-        when "udp"
-          @snmp = SnmpFactory.instance.udp
-        when "tcp"
-          @snmp = SnmpFactory.instance.tcp
-        else
-          raise(SnmpClientError, "invalid transport protocol specified '#{protocol.to_s}', expecting 'udp' or 'tcp'")
-      end
     end
 
     def get(oids, strip_root = 0, path_length = 0)
@@ -94,7 +51,6 @@ module LogStash
       result
     end
 
-
     def walk(oid, strip_root = 0, path_length = 0)
       result = {}
 
@@ -202,7 +158,6 @@ module LogStash
       end
     end
 
-
     def parse_version(version)
       case version.to_s
         when "3"
@@ -218,6 +173,17 @@ module LogStash
 
     private
 
+    def create_transport(protocol)
+      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
+    end
+
     def get_pdu
       raise("abstract method")
     end

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

@@ -18,9 +18,17 @@ module LogStash
     def initialize(protocol, address, port, community, version, retries, timeout, mib)
       super(protocol, address, port, retries, timeout, mib)
       raise(SnmpClientError, "SnmpClient is expecting verison '1' or '2c'") unless ["1", "2c"].include?(version.to_s)
+
+      @snmp = Snmp.new(create_transport(protocol))
+      @snmp.listen
+
       @target = build_target("#{protocol}:#{address}/#{port}", community, version, retries, timeout)
     end
 
+    def close
+      @snmp.close
+    end
+
     private
 
     def get_pdu

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

@@ -3,23 +3,6 @@ require 'logstash-input-snmp_jars.rb'
 
 module LogStash
 
-  # Only a single USM instance should be created and added to the SecurityModels
-  class USMFactory
-    java_import 'org.snmp4j.security.SecurityProtocols'
-    java_import 'org.snmp4j.security.SecurityModels'
-    java_import 'org.snmp4j.security.USM'
-    java_import 'org.snmp4j.smi.OctetString'
-    java_import 'org.snmp4j.mp.MPv3'
-
-    include Singleton
-    attr_reader :usm
-
-    def initialize
-      @usm = USM.new(SecurityProtocols.getInstance, OctetString.new(MPv3.createLocalEngineID), 0)
-      SecurityModels.getInstance.addSecurityModel(@usm)
-    end
-  end
-
   class SnmpClientV3 < BaseSnmpClient
     java_import 'org.snmp4j.PDU'
     java_import 'org.snmp4j.ScopedPDU'
@@ -41,11 +24,16 @@ module LogStash
     java_import 'org.snmp4j.security.PrivAES256'
     java_import 'org.snmp4j.security.UsmUser'
     java_import 'org.snmp4j.security.SecurityLevel'
+    java_import 'org.snmp4j.security.SecurityModels'
+    java_import 'org.snmp4j.security.SecurityProtocols'
+    java_import 'org.snmp4j.security.USM'
     java_import 'org.snmp4j.smi.Address'
     java_import 'org.snmp4j.smi.GenericAddress'
     java_import 'org.snmp4j.smi.OctetString'
     java_import 'org.snmp4j.UserTarget'
     java_import 'org.snmp4j.util.DefaultPDUFactory'
+    java_import 'org.snmp4j.mp.MPv3'
+    java_import "org.snmp4j.MessageDispatcherImpl"
 
     def initialize(protocol, address, port, retries, timeout, mib, security_name, auth_protocol, auth_pass, priv_protocol, priv_pass, security_level)
       super(protocol, address, port, retries, timeout, mib)
@@ -57,13 +45,29 @@ module LogStash
       auth_pass = auth_pass.nil? ? nil : OctetString.new(auth_pass)
       priv_pass = priv_pass.nil? ? nil : OctetString.new(priv_pass)
 
-      # make sure the USM is initialized
-      USMFactory.instance
+      engine_id = OctetString.new(MPv3.createLocalEngineID)
+
+      security_protocols = SecurityProtocols.getInstance
+      security_protocols.addDefaultProtocols
+
+      usm = USM.new(security_protocols, engine_id, 0)
+      usm.addUser(UsmUser.new(security_name, auth_protocol, auth_pass, priv_protocol, priv_pass))
+
+      SecurityModels.getInstance.addSecurityModel(usm)
+
+      dispatcher = MessageDispatcherImpl.new
+      dispatcher.addMessageProcessingModel(MPv3.new(usm))
+
+      @snmp =  Snmp.new(dispatcher, create_transport(protocol))
+      @snmp.listen
 
-      @snmp.getUSM.addUser(UsmUser.new(security_name, auth_protocol, auth_pass, priv_protocol, priv_pass))
       @target = build_target("#{protocol}:#{address}/#{port}", security_name, security_level, retries, timeout)
     end
 
+    def close
+      @snmp.close
+    end
+
     private
 
     def build_target(address, name, seclevel, retries, timeout)

data/logstash-input-snmp.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'logstash-input-snmp'
-  s.version       = '1.2.3'
+  s.version       = '1.2.4'
   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

@@ -15,6 +15,8 @@ describe LogStash::Inputs::Snmp do
     before do
       expect(LogStash::SnmpClient).to receive(:new).and_return(mock_client)
       expect(mock_client).to receive(:get).and_return({})
+      # devutils in v6 calls close on the test pipelines while it does not in v7+
+      expect(mock_client).to receive(:close).at_most(:once)
     end
   end
 
@@ -128,6 +130,8 @@ describe LogStash::Inputs::Snmp do
     before do
       expect(LogStash::SnmpClient).to receive(:new).and_return(mock_client)
       expect(mock_client).to receive(:get).and_return({"foo" => "bar"})
+      # devutils in v6 calls close on the test pipelines while it does not in v7+
+      expect(mock_client).to receive(:close).at_most(:once)
     end
 
     it "shoud add @metadata fields and add default host field" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-snmp
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - Elasticsearch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-14 00:00:00.000000000 Z
+date: 2020-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement