logstash-input-snmp 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd8a28a27d093bbc5502b4475514220ae85d3f4a33c851db6cd0934b19ea830a
-  data.tar.gz: 86504f9ffcffa46a208ba8198409959de6515a4e1bef0efb021caee93b139c33
+  metadata.gz: 131263a5b332d433de705dac607ddecd0920f33827c0419c7a837adc735c4dc0
+  data.tar.gz: d1b6e99a2c8340470833dc83e2d2bb756342c332cc36ba22ac90b93caa32149b
 SHA512:
-  metadata.gz: b9ba8535100826e6c8ba053c6189a7d96e2b385de5430c9fbd295489d47324783d3cf23e50d32386819c3d993e625095c859cc672a3af3bb760df4c1e024fb55
-  data.tar.gz: 6254f5b522aeadf2720d13ef0191f492882da868588d1c46d1f717fbdf2b6b20c85c394a557175b8a2fc38e4a0133bfc37905f0ee7f137ad85abd18dfcfd9c07
+  metadata.gz: 8b7b2c722a7eb4d81492b8f39b2aa05fd60131f1871b89ec0b122fbaed398336924a5c805bd3885a45906b2ba43a41d9579fb5d5ab456d42cc8a32df93557e51
+  data.tar.gz: c2f3d2d67868fdd602117dab01f371c76b3e8ea7406438965395e088f73db06a4b589635cb57989e7d90e6ebf9a7f0fcee4aa96aa6592572fb48686d9c3abb4d

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 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)
+
 ## 1.2.2
   -  Refactor: scope and review java_imports [#72](https://github.com/logstash-plugins/logstash-input-snmp/pull/72)
 

data/LICENSE

@@ -1,11 +1,202 @@
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
 
-    http://www.apache.org/licenses/LICENSE-2.0
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Elastic and contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

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

@@ -7,15 +7,47 @@ module LogStash
   class SnmpClientError < StandardError
   end
 
-  class BaseSnmpClient
-
+  # 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"
     java_import "org.snmp4j.smi.OID"
     java_import "org.snmp4j.smi.VariableBinding"
-    java_import "org.snmp4j.transport.DefaultUdpTransportMapping"
-    java_import "org.snmp4j.transport.DefaultTcpTransportMapping"
     java_import "org.snmp4j.util.TableUtils"
     java_import "org.snmp4j.util.TreeUtils"
     java_import "org.snmp4j.asn1.BER"
@@ -23,18 +55,16 @@ module LogStash
     include LogStash::Util::Loggable
 
     def initialize(protocol, address, port, retries, timeout, mib)
+      @mib = mib
+
       transport = case protocol.to_s
         when "udp"
-          DefaultUdpTransportMapping.new
+          @snmp = SnmpFactory.instance.udp
         when "tcp"
-          DefaultTcpTransportMapping.new
+          @snmp = SnmpFactory.instance.tcp
         else
           raise(SnmpClientError, "invalid transport protocol specified '#{protocol.to_s}', expecting 'udp' or 'tcp'")
-        end
-
-      @mib = mib
-      @snmp = Snmp.new(transport)
-      transport.listen()
+      end
     end
 
     def get(oids, strip_root = 0, path_length = 0)

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

@@ -2,14 +2,30 @@ require 'java'
 require 'logstash-input-snmp_jars.rb'
 
 module LogStash
-  class SnmpClientV3 < BaseSnmpClient
 
+  # 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'
     java_import 'org.snmp4j.Snmp'
     java_import 'org.snmp4j.Target'
     java_import 'org.snmp4j.event.ResponseEvent'
-    java_import 'org.snmp4j.mp.MPv3'
     java_import 'org.snmp4j.mp.SnmpConstants'
     java_import 'org.snmp4j.security.AuthMD5'
     java_import 'org.snmp4j.security.AuthSHA'
@@ -23,9 +39,6 @@ module LogStash
     java_import 'org.snmp4j.security.PrivAES128'
     java_import 'org.snmp4j.security.PrivAES192'
     java_import 'org.snmp4j.security.PrivAES256'
-    java_import 'org.snmp4j.security.SecurityModels'
-    java_import 'org.snmp4j.security.SecurityProtocols'
-    java_import 'org.snmp4j.security.USM'
     java_import 'org.snmp4j.security.UsmUser'
     java_import 'org.snmp4j.security.SecurityLevel'
     java_import 'org.snmp4j.smi.Address'
@@ -44,8 +57,8 @@ module LogStash
       auth_pass = auth_pass.nil? ? nil : OctetString.new(auth_pass)
       priv_pass = priv_pass.nil? ? nil : OctetString.new(priv_pass)
 
-      usm = USM.new(SecurityProtocols.getInstance, OctetString.new(MPv3.createLocalEngineID), 0)
-      SecurityModels.getInstance.addSecurityModel(usm)
+      # make sure the USM is initialized
+      USMFactory.instance
 
       @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)

data/logstash-input-snmp.gemspec

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

metadata

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