netsnmp 0.6.1 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5acdf8864505d464308db6119493b5c8726e4717f4f54a7b658fa8c770c6c4be
-  data.tar.gz: 135e35c9a90823f738690caf97be28617e7dbcea100757665691a7c58f6dbfad
+  metadata.gz: 3349a60dfb4bd19c4ae8b1f1f0ad76638ab3e384ed4d03419ddc71ab4770ada7
+  data.tar.gz: 54c2d8c1414abff53cdd3687a69265447d24923ad3ee5dfd97f0e4395257696c
 SHA512:
-  metadata.gz: e96a1f2246ace296fa6db9270ab7cd0a9b28aa31e7db22358e76e80cc2dfdc4a6faeb08083b12cb441de6b48f64e2e7a6e0cfe88b42552bad56902d3eb4f8c66
-  data.tar.gz: 6b304c5debc7966d25b51d92017863c3330f40559cdd74ae2b283c0ef729e1f29ad3336f2734441466b58bb17d33e9235d38bec31712a43576668e7956e56090
+  metadata.gz: 48d7735ee7785d200a27318df71a8f60cc25fb7b9902c203471768b0f8da4333faf4a304eb8c23ff44f6a11c7e08e74c76afe7a993470c938d24af47576d34cf
+  data.tar.gz: 557778f9e177cff84382ffcbae103d0245f6ece90f8169e41b3dffdbd7f6a505630d7ff9ace61980765824b2c5554ee5ca71f9d7bca0792933dc91dbed1abf02

data/lib/netsnmp/client.rb

@@ -28,12 +28,14 @@ module NETSNMP
                 when Integer then version # assume the use know what he's doing
                 when /v?1/ then 0
                 when /v?2c?/ then 1
-                when /v?3/, nil then 3
+                when /v?3/ then 3
+                else 3 # rubocop:disable Lint/DuplicateBranch
                 end
 
-      @retries = options.fetch(:retries, RETRIES)
+      @retries = options.fetch(:retries, RETRIES).to_i
       @session ||= version == 3 ? V3Session.new(**options) : Session.new(version: version, **options)
       return unless block_given?
+
       begin
         yield self
       ensure
@@ -155,6 +157,7 @@ module NETSNMP
         yield
       rescue Timeout::Error, IdNotInTimeWindowError => e
         raise e if retries.zero?
+
         retries -= 1
         retry
       end

data/lib/netsnmp/encryption/aes.rb

@@ -9,7 +9,7 @@ module NETSNMP
       end
 
       def encrypt(decrypted_data, engine_boots:, engine_time:)
-        cipher = OpenSSL::Cipher::AES128.new(:CFB)
+        cipher = OpenSSL::Cipher.new("aes-128-cfb")
 
         iv, salt = generate_encryption_key(engine_boots, engine_time)
 
@@ -29,7 +29,7 @@ module NETSNMP
       def decrypt(encrypted_data, salt:, engine_boots:, engine_time:)
         raise Error, "invalid priv salt received" unless !salt.empty? && (salt.length % 8).zero?
 
-        cipher = OpenSSL::Cipher::AES128.new(:CFB)
+        cipher = OpenSSL::Cipher.new("aes-128-cfb")
         cipher.padding = 0
 
         iv = generate_decryption_key(engine_boots, engine_time, salt)
@@ -40,7 +40,7 @@ module NETSNMP
         decrypted_data = cipher.update(encrypted_data) + cipher.final
 
         hlen, bodylen = OpenSSL::ASN1.traverse(decrypted_data) { |_, _, x, y, *| break x, y }
-        decrypted_data.byteslice(0, hlen + bodylen)
+        decrypted_data.byteslice(0, hlen + bodylen) || "".b
       end
 
       private

data/lib/netsnmp/encryption/des.rb

@@ -11,7 +11,7 @@ module NETSNMP
       end
 
       def encrypt(decrypted_data, engine_boots:, **)
-        cipher = OpenSSL::Cipher::DES.new(:CBC)
+        cipher = OpenSSL::Cipher.new("des-cbc")
 
         iv, salt = generate_encryption_key(engine_boots)
 
@@ -31,7 +31,7 @@ module NETSNMP
         raise Error, "invalid priv salt received" unless (salt.length % 8).zero?
         raise Error, "invalid encrypted PDU received" unless (encrypted_data.length % 8).zero?
 
-        cipher = OpenSSL::Cipher::DES.new(:CBC)
+        cipher = OpenSSL::Cipher.new("des-cbc")
         cipher.padding = 0
 
         iv = generate_decryption_key(salt)
@@ -42,7 +42,7 @@ module NETSNMP
         decrypted_data = cipher.update(encrypted_data) + cipher.final
 
         hlen, bodylen = OpenSSL::ASN1.traverse(decrypted_data) { |_, _, x, y, *| break x, y }
-        decrypted_data.byteslice(0, hlen + bodylen)
+        decrypted_data.byteslice(0, hlen + bodylen) || "".b
       end
 
       private
@@ -70,7 +70,7 @@ module NETSNMP
       end
 
       def des_key
-        @priv_key[0, 8]
+        @priv_key[0, 8] || "".b
       end
     end
   end

data/lib/netsnmp/errors.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
 module NETSNMP
-  Error = Class.new(StandardError)
-  ConnectionFailed = Class.new(Error)
-  AuthenticationFailed = Class.new(Error)
-  IdNotInTimeWindowError = Class.new(Error)
+  class Error < StandardError; end
+
+  class ConnectionFailed < Error; end
+
+  class AuthenticationFailed < Error; end
+
+  class IdNotInTimeWindowError < Error; end
+
+  class OidNotFound < StandardError; end
 end

data/lib/netsnmp/extensions.rb

@@ -14,6 +14,17 @@ module NETSNMP
 
   module StringExtensions
     refine(String) do
+      unless String.method_defined?(:delete_prefix)
+        def delete_prefix(prefix)
+          prefix = String(prefix)
+          if rindex(prefix, 0)
+            self[prefix.length..-1]
+          else
+            dup
+          end
+        end
+      end
+
       unless String.method_defined?(:match?)
         def match?(*args)
           !match(*args).nil?
@@ -107,7 +118,7 @@ module NETSNMP
   # Like a string, but it prints an hex-string version of itself
   class HexString < String
     def inspect
-      Hexdump.dump(self, in_groups_of: 2, separator: " ")
+      Hexdump.dump(to_s, in_groups_of: 2, separator: " ")
     end
   end
 end

data/lib/netsnmp/loggable.rb

@@ -3,10 +3,9 @@
 module NETSNMP
   module Loggable
     DEBUG = ENV.key?("NETSNMP_DEBUG") ? $stderr : nil
-    DEBUG_LEVEL = (ENV["NETSNMP_DEBUG"] || 1).to_i
+    DEBUG_LEVEL = ENV.fetch("NETSNMP_DEBUG", 1).to_i
 
-    def initialize(debug: DEBUG, debug_level: DEBUG_LEVEL, **opts)
-      super(**opts)
+    def initialize_logger(debug: DEBUG, debug_level: DEBUG_LEVEL, **)
       @debug = debug
       @debug_level = debug_level
     end

data/lib/netsnmp/message.rb

@@ -5,7 +5,7 @@ module NETSNMP
   class Message
     using ASNExtensions
 
-    prepend Loggable
+    include Loggable
 
     PRIVNONE           = OpenSSL::ASN1::OctetString.new("")
     MSG_MAX_SIZE       = OpenSSL::ASN1::Integer.new(65507).with_label(:max_message_size)
@@ -13,7 +13,9 @@ module NETSNMP
     MSG_VERSION        = OpenSSL::ASN1::Integer.new(3).with_label(:message_version)
     MSG_REPORTABLE     = 4
 
-    def initialize(**); end
+    def initialize(**args)
+      initialize_logger(**args)
+    end
 
     def verify(stream, auth_param, security_level, security_parameters:)
       security_parameters.verify(stream.sub(auth_param, authnone(security_parameters.auth_protocol).value), auth_param, security_level: security_level)
@@ -65,12 +67,10 @@ module NETSNMP
                                                             security_level: security_level)
 
       log { "received response PDU" }
-      pdu = ScopedPDU.decode(encoded_pdu)
-      pdu.auth_param = auth_param
-      pdu.security_level = security_level
+      pdu = ScopedPDU.decode(encoded_pdu, auth_param: auth_param, security_level: security_level)
 
       log(level: 2) { pdu.to_hex }
-      [pdu, engine_id.value, engine_boots, engine_time]
+      [pdu, engine_id.value.to_s, engine_boots, engine_time]
     end
 
     # @param [NETSNMP::ScopedPDU] the PDU to encode in the message
@@ -131,9 +131,13 @@ module NETSNMP
     # https://datatracker.ietf.org/doc/html/rfc7860#section-4.2.2 part 3
     # https://datatracker.ietf.org/doc/html/rfc3414#section-6.3.2 part 3
     def authnone(auth_protocol)
+      # https://datatracker.ietf.org/doc/html/rfc3414#section-3.1 part 8b
+      return OpenSSL::ASN1::OctetString.new("").with_label(:auth_mask) unless auth_protocol
+
       # The digest in the msgAuthenticationParameters field is replaced by the 12 zero octets.
       # 24 octets for sha256
       number_of_octets = auth_protocol == :sha256 ? 24 : 12
+
       OpenSSL::ASN1::OctetString.new("\x00" * number_of_octets).with_label(:auth_mask)
     end
   end

data/lib/netsnmp/mib/parser.rb

@@ -194,7 +194,7 @@ module NETSNMP::MIB
     end
 
     rule(:module_name_capabilities) do
-      spaced { uppercase_identifier } >> object_identifier | uppercase_identifier
+      (spaced { uppercase_identifier } >> object_identifier) | uppercase_identifier
     end
 
     rule(:capabilities_groups) do
@@ -368,7 +368,7 @@ module NETSNMP::MIB
     end
 
     rule(:category_id) do
-      spaced { lowercase_identifier } >> bracketed(number) | lowercase_identifier
+      (spaced { lowercase_identifier } >> bracketed(number)) | lowercase_identifier
     end
 
     rule(:notification_type_clause) do
@@ -407,8 +407,8 @@ module NETSNMP::MIB
     end
 
     rule(:enterprise_part) do
-      spaced("ENTERPRISE") >> object_identifier |
-        spaced("ENTERPRISE") >> curly(object_identifier)
+      (spaced("ENTERPRISE") >> object_identifier) |
+        (spaced("ENTERPRISE") >> curly(object_identifier))
     end
 
     rule(:var_part) do
@@ -454,7 +454,7 @@ module NETSNMP::MIB
     end
 
     rule(:max_access_part) do
-      spaced("MAX-ACCESS") >> access | spaced("ACCESS") >> access
+      (spaced("MAX-ACCESS") >> access) | (spaced("ACCESS") >> access)
     end
 
     rule(:access) { lowercase_identifier }
@@ -484,7 +484,7 @@ module NETSNMP::MIB
     end
 
     rule(:object_identifier_defval) do
-      spaced { lowercase_identifier } >> bracketed(number) |
+      (spaced { lowercase_identifier } >> bracketed(number)) |
         number
     end
 
@@ -493,7 +493,7 @@ module NETSNMP::MIB
     end
 
     rule(:index_type) do
-      spaced("IMPLIED") >> idx | idx
+      (spaced("IMPLIED") >> idx) | idx
     end
 
     rule(:idx) do
@@ -525,7 +525,7 @@ module NETSNMP::MIB
     rule(:sub_identifier) do
       fuzzy_lowercase_identifier |
         number |
-        spaced { lowercase_identifier } >> bracketed(number)
+        (spaced { lowercase_identifier } >> bracketed(number))
     end
 
     rule(:type_declaration) do
@@ -542,12 +542,12 @@ module NETSNMP::MIB
 
     rule(:type_declaration_rhs) do
       spaced { choice_clause } |
-        spaced { str("TEXTUAL-CONVENTION") } >>
+        (spaced { str("TEXTUAL-CONVENTION") } >>
         spaced { display_part }.maybe >>
         spaced("STATUS") >> spaced { status } >>
         spaced("DESCRIPTION") >> spaced { text } >>
         spaced { refer_part }.maybe >>
-        spaced("SYNTAX") >> syntax |
+        spaced("SYNTAX") >> syntax) |
         syntax
     end
 
@@ -561,7 +561,7 @@ module NETSNMP::MIB
     end
 
     rule(:syntax) do
-      object_syntax | spaced("BITS").as(:type) >> curly(named_bits)
+      object_syntax | (spaced("BITS").as(:type) >> curly(named_bits))
     end
 
     rule(:display_part) do
@@ -581,27 +581,27 @@ module NETSNMP::MIB
         entry_type |
         simple_syntax |
         application_syntax |
-        type_tag >> simple_syntax |
+        (type_tag >> simple_syntax) |
         row.as(:value)
     end
 
     rule(:simple_syntax) do
-      spaced { str("INTEGER").as(:type) } >> (integer_subtype | enum_spec).maybe |
-        spaced { str("Integer32").as(:type) >> space } >> integer_subtype.maybe |
-        spaced { str("OCTET STRING").as(:type) } >> octetstring_subtype.maybe |
-        spaced { str("OBJECT IDENTIFIER").as(:type) } >> any_subtype |
-        spaced { uppercase_identifier.as(:type) } >> (integer_subtype | enum_spec | octetstring_subtype)
+      (spaced { str("INTEGER").as(:type) } >> (integer_subtype | enum_spec).maybe) |
+        (spaced { str("Integer32").as(:type) >> space } >> integer_subtype.maybe) |
+        (spaced { str("OCTET STRING").as(:type) } >> octetstring_subtype.maybe) |
+        (spaced { str("OBJECT IDENTIFIER").as(:type) } >> any_subtype) |
+        (spaced { uppercase_identifier.as(:type) } >> (integer_subtype | enum_spec | octetstring_subtype))
     end
 
     rule(:application_syntax) do
-      spaced { str("IpAddress").as(:type) >> space } >> any_subtype |
-        spaced { str("NetworkAddress").as(:type) >> space } >> any_subtype |
-        spaced { str("Counter32").as(:type) >> space } >> integer_subtype.maybe |
-        spaced { str("Gauge32").as(:type) >> space } >> integer_subtype.maybe |
-        spaced { str("Unsigned32").as(:type) >> space } >> integer_subtype.maybe |
-        spaced { str("TimeTicks").as(:type) >> space } >> any_subtype |
-        spaced { str("Opaque").as(:type) >> space } >> octetstring_subtype.maybe |
-        spaced { str("Counter64").as(:type) >> space } >> integer_subtype.maybe
+      (spaced { str("IpAddress").as(:type) >> space } >> any_subtype) |
+        (spaced { str("NetworkAddress").as(:type) >> space } >> any_subtype) |
+        (spaced { str("Counter32").as(:type) >> space } >> integer_subtype.maybe) |
+        (spaced { str("Gauge32").as(:type) >> space } >> integer_subtype.maybe) |
+        (spaced { str("Unsigned32").as(:type) >> space } >> integer_subtype.maybe) |
+        (spaced { str("TimeTicks").as(:type) >> space } >> any_subtype) |
+        (spaced { str("Opaque").as(:type) >> space } >> octetstring_subtype.maybe) |
+        (spaced { str("Counter64").as(:type) >> space } >> integer_subtype.maybe)
     end
 
     rule(:conceptual_table) do
@@ -613,8 +613,8 @@ module NETSNMP::MIB
     end
 
     rule(:type_tag) do
-      spaced { square_bracketed(spaced("APPLICATION") >> number.as(:application_type)) } >> spaced("IMPLICIT") |
-        spaced { square_bracketed(spaced("UNIVERSAL") >> number.as(:universal_type)) } >> spaced("IMPLICIT")
+      (spaced { square_bracketed(spaced("APPLICATION") >> number.as(:application_type)) } >> spaced("IMPLICIT")) |
+        (spaced { square_bracketed(spaced("UNIVERSAL") >> number.as(:universal_type)) } >> spaced("IMPLICIT"))
     end
 
     rule(:sequence_items) do
@@ -628,7 +628,7 @@ module NETSNMP::MIB
     rule(:sequence_syntax) do
       str("BITS") |
         sequence_object_syntax |
-        spaced { uppercase_identifier } >> any_subtype
+        (spaced { uppercase_identifier } >> any_subtype)
     end
 
     rule(:sequence_object_syntax) do
@@ -636,20 +636,20 @@ module NETSNMP::MIB
     end
 
     rule(:sequence_simple_syntax) do
-      spaced("INTEGER") >> any_subtype |
-        spaced("Integer32") >> any_subtype |
-        spaced("OCTET STRING") >> any_subtype |
-        spaced("OBJECT IDENTIFIER") >> any_subtype
+      (spaced("INTEGER") >> any_subtype) |
+        (spaced("Integer32") >> any_subtype) |
+        (spaced("OCTET STRING") >> any_subtype) |
+        (spaced("OBJECT IDENTIFIER") >> any_subtype)
     end
 
     rule(:sequence_application_syntax) do
-      spaced { str("IpAddress") >> space } >> any_subtype |
-        spaced { str("COUNTER32") } >> any_subtype |
-        spaced { str("Gauge32") >> space } >> any_subtype |
-        spaced { str("Unsigned32") >> space } >> any_subtype |
-        spaced { str("TimeTicks") >> space } >> any_subtype |
+      (spaced { str("IpAddress") >> space } >> any_subtype) |
+        (spaced { str("COUNTER32") } >> any_subtype) |
+        (spaced { str("Gauge32") >> space } >> any_subtype) |
+        (spaced { str("Unsigned32") >> space } >> any_subtype) |
+        (spaced { str("TimeTicks") >> space } >> any_subtype) |
         str("Opaque") |
-        spaced { str("Counter64") >> space } >> any_subtype
+        (spaced { str("Counter64") >> space } >> any_subtype)
     end
 
     rule(:row) { uppercase_identifier }
@@ -743,7 +743,7 @@ module NETSNMP::MIB
 
     rule(:text) do
       str('"') >> (
-        str('\\') >> any | str('"').absent? >> any
+        (str("\\") >> any) | (str('"').absent? >> any)
       ).repeat >> str('"')
     end
   end

data/lib/netsnmp/mib.rb

@@ -6,11 +6,13 @@ module NETSNMP
   module MIB
     using IsNumericExtensions
 
-    OIDREGEX = /^[\d\.]*$/
+    OIDREGEX = /^[\d.]*$/.freeze
 
     module_function
 
-    MIBDIRS = ENV.fetch("MIBDIRS", File.join("/usr", "share", "snmp", "mibs")).split(":")
+    MIBDIRS = ENV.fetch("MIBDIRS", File.join("/usr", "share", "snmp", "mibs"))
+                 .split(":")
+                 .flat_map { |dir| [dir, *Dir.glob(File.join(dir, "**", "*")).select(&File.method(:directory?))] }.uniq
     PARSER = Parser.new
     @parser_mutex = Mutex.new
     @modules_loaded = []
@@ -20,11 +22,13 @@ module NETSNMP
     def oid(identifier)
       prefix, *suffix = case identifier
                         when Array
-                          identifier
+                          identifier.map(&:to_s)
                         else
-                          identifier.split(".", 2)
+                          identifier.split(".", 2).map(&:to_s)
                         end
 
+      return unless prefix
+
       # early exit if it's an OID already
       unless prefix.integer?
         load_defaults
@@ -33,9 +37,7 @@ module NETSNMP
         if idx
           mod = prefix[0..(idx - 1)]
           type = prefix[(idx + 2)..-1]
-          unless module_loaded?(mod)
-            return unless load(mod)
-          end
+          return if mod && !module_loaded?(mod) && !load(mod)
         else
           type = prefix
         end
@@ -53,7 +55,7 @@ module NETSNMP
     def identifier(oid)
       @object_identifiers.select do |_, ids_oid|
         oid.start_with?(ids_oid)
-      end.sort_by(&:size).first
+      end.min_by(&:size)
     end
 
     #
@@ -78,9 +80,11 @@ module NETSNMP
           end
         end
         return false unless moddir
+
         mod = moddir
       end
       return true if @modules_loaded.include?(mod)
+
       do_load(mod)
       @modules_loaded << mod
       true
@@ -129,9 +133,11 @@ module NETSNMP
           @object_identifiers[cp]
         else
           STATIC_MIB_TO_OID[cp] || begin
-            imported_mod, = imports.find do |_, identifiers|
-              identifiers.include?(cp)
-            end
+            imported_mod, = if imports
+                              imports.find do |_, identifiers|
+                                identifiers.include?(cp)
+                              end
+                            end
 
             raise Error, "didn't find a module to import \"#{cp}\" from" unless imported_mod
 

data/lib/netsnmp/oid.rb

@@ -4,15 +4,18 @@ module NETSNMP
   # Abstracts the OID structure
   #
   module OID
-    using StringExtensions unless String.method_defined?(:match?)
+    using StringExtensions
 
-    OIDREGEX = /^[\d\.]*$/
+    OIDREGEX = /^[\d.]*$/.freeze
 
     module_function
 
     def build(id)
       oid = MIB.oid(id)
-      oid = oid[1..-1] if oid.start_with?(".")
+
+      raise Error, "no OID found for #{id}" unless oid
+
+      oid = oid.delete_prefix(".") if oid.start_with?(".")
       oid
     end
 

data/lib/netsnmp/pdu.rb

@@ -11,17 +11,10 @@ module NETSNMP
 
     using ASNExtensions
     class << self
-      def decode(der)
-        asn_tree = case der
-                   when String
-                     OpenSSL::ASN1.decode(der)
-                   when OpenSSL::ASN1::ASN1Data
-                     der
-                   else
-                     raise "#{der}: unexpected data"
-                   end
-
-        *headers, request = asn_tree.value
+      def decode(der, **args)
+        der = OpenSSL::ASN1.decode(der) if der.is_a?(String)
+
+        *headers, request = der.value
 
         version, community = headers.map(&:value)
 
@@ -37,11 +30,14 @@ module NETSNMP
           { oid: oid, value: val_asn }
         end
 
-        new(type: type, headers: [version, community],
-            error_status: error_status,
-            error_index: error_index,
-            request_id: request_id,
-            varbinds: varbs)
+        new(type: type,
+            version: version.to_i,
+            community: community,
+            error_status: error_status.to_i,
+            error_index: error_index.to_i,
+            request_id: request_id.to_i,
+            varbinds: varbs,
+            **args)
       end
 
       # factory method that abstracts initialization of the pdu types that the library supports.
@@ -64,19 +60,19 @@ module NETSNMP
       end
     end
 
-    attr_reader :varbinds, :type
-
-    attr_reader :version, :community, :request_id
+    attr_reader :varbinds, :type, :version, :community, :request_id
 
-    def initialize(type:, headers:,
+    def initialize(type:,
+                   version:,
+                   community:,
                    request_id: SecureRandom.random_number(MAXREQUESTID),
                    error_status: 0,
                    error_index: 0,
                    varbinds: [])
-      @version, @community = headers
-      @version = @version.to_i
+      @version = version.to_i
+      @community = community
       @error_status = error_status
-      @error_index  = error_index
+      @error_index = error_index
       @type = type
       @varbinds = []
       varbinds.each do |varbind|
@@ -131,6 +127,7 @@ module NETSNMP
     # http://www.tcpipguide.com/free/t_SNMPVersion2SNMPv2MessageFormats-5.htm#Table_219
     def check_error_status(status)
       return if status.zero?
+
       message = case status
                 when 1 then "Response-PDU too big"
                 when 2 then "No such name"

data/lib/netsnmp/scoped_pdu.rb

@@ -4,13 +4,14 @@ module NETSNMP
   class ScopedPDU < PDU
     using ASNExtensions
 
-    attr_reader :engine_id
+    attr_reader :engine_id, :security_level, :auth_param
 
-    attr_accessor :security_level, :auth_param
-
-    def initialize(type:, headers:, **options)
-      @engine_id, @context = headers
-      super(type: type, headers: [3, nil], **options)
+    def initialize(type:, auth_param: "", security_level: 3, engine_id: nil, context: nil, **options)
+      @auth_param = auth_param
+      @security_level = security_level
+      @engine_id = engine_id
+      @context = context
+      super(type: type, version: 3, community: nil, **options)
     end
 
     private