netsnmp 0.2.0 → 0.5.0

data/sig/scoped_pdu.rbs

@@ -1,6 +1,8 @@
 module NETSNMP
   class ScopedPDU < PDU
     attr_reader engine_id: String
+    attr_reader auth_param: String?
+    attr_reader security_level: Integer?
 
     private
 

data/sig/security_parameters.rbs

@@ -1,5 +1,7 @@
 module NETSNMP
   class SecurityParameters
+    prepend Loggable
+
     type security_level = :noauth | :auth_no_priv | :auth_priv | 0 | 1 | 3 | nil
 
     type auth_protocol = :md5 | :sha
@@ -21,11 +23,11 @@ module NETSNMP
 
     def encode: (_ToAsn, salt: OpenSSL::ASN1::ASN1Data, engine_time: Integer, engine_boots: Integer) -> [OpenSSL::ASN1::ASN1Data, OpenSSL::ASN1::ASN1Data]
 
-    def decode: (OpenSSL::ASN1::ASN1Data | String der, salt: OpenSSL::ASN1::ASN1Data | String, engine_time: Integer, engine_boots: Integer) -> OpenSSL::ASN1::ASN1Data
+    def decode: (OpenSSL::ASN1::ASN1Data | String der, salt: OpenSSL::ASN1::ASN1Data | String, engine_time: Integer, engine_boots: Integer, ?security_level: Integer?) -> OpenSSL::ASN1::ASN1Data
 
     def sign: (String message) -> String?
 
-    def verify: (String stream, String salt) -> void
+    def verify: (String stream, String salt, ?security_level: Integer?) -> void
 
     def must_revalidate?: () -> bool
 

data/sig/session.rbs

@@ -1,5 +1,7 @@
 module NETSNMP
   class Session
+    prepend Loggable
+
     @transport: _Transport
     @version: 0 | 1 | 3
     @community: String?

data/spec/client_spec.rb

@@ -22,7 +22,7 @@ RSpec.describe NETSNMP::Client do
       let(:get_oid) { "1.3.6.1.2.1.1.5.0" }
       let(:next_oid) { "1.3.6.1.2.1.1.6.0" }
       let(:walk_oid) { "1.3.6.1.2.1.1" }
-      let(:set_oid) { "1.3.6.1.2.1.1.3.0" } # sysUpTimeInstance
+      let(:set_oid) { "sysUpTime.0" } # sysUpTimeInstance
       let(:get_result) { "DEVICE-192.168.1.1" }
       let(:next_result) { "The Cloud" }
       let(:walk_result) do
@@ -48,10 +48,10 @@ RSpec.describe NETSNMP::Client do
           community: "public"
         }
       end
-      let(:get_oid) { "1.3.6.1.2.1.1.5.0" }
+      let(:get_oid) { "sysName.0" }
       let(:next_oid) { "1.3.6.1.2.1.1.6.0" }
-      let(:walk_oid) { "1.3.6.1.2.1.1" }
-      let(:set_oid) { "1.3.6.1.2.1.1.3.0" }
+      let(:walk_oid) { "system" }
+      let(:set_oid) { "sysUpTime.0" }
       let(:get_result) { "DEVICE-192.168.1.1" }
       let(:next_result) { "The Cloud" }
       let(:walk_result) do
@@ -67,6 +67,24 @@ RSpec.describe NETSNMP::Client do
         WALK
       end
       let(:set_oid_result) { 43 }
+
+      context "when the returned value is a hex-string" do
+        let(:protocol_options) do
+          {
+            version: "2c",
+            community: "foreignformats/winxp1"
+          }
+        end
+        let(:hex_get_oid) { "1.3.6.1.2.1.25.3.7.1.3.10.1" }
+        let(:hex_get_result) { "\x01\x00\x00\x00" }
+        let(:hex_get_output) { "01 00 00 00" }
+        let(:value) { subject.get(oid: hex_get_oid) }
+
+        it "returns the string, which outputs the hex-representation" do
+          expect(value).to eq(hex_get_result)
+          expect(value.inspect).to include(hex_get_output)
+        end
+      end
     end
   end
 
@@ -78,9 +96,9 @@ RSpec.describe NETSNMP::Client do
         context: "a172334d7d97871b72241397f713fa12"
       }
     end
-    let(:get_oid) { "1.3.6.1.2.1.1.5.0" }
+    let(:get_oid) { "sysName.0" }
     let(:next_oid) { "1.3.6.1.2.1.1.6.0" }
-    let(:set_oid) { "1.3.6.1.2.1.1.3.0" } # sysUpTimeInstance
+    let(:set_oid) { "sysUpTime.0" } # sysUpTimeInstance
     let(:walk_oid) { "1.3.6.1.2.1.1.9.1.3" }
     let(:get_result) { "tt" }
     let(:next_result) { "KK12" }
@@ -159,6 +177,18 @@ RSpec.describe NETSNMP::Client do
         end
         it_behaves_like "an snmp client" do
           let(:protocol_options) { version_options.merge(user_options).merge(extra_options) }
+
+          context "with wrong auth password and wrong encrypting password" do
+            let(:user_options) do
+              { username: "authprivmd5des", auth_password: "wrongpassword",
+                auth_protocol: :md5, priv_password: "maplesyrup",
+                priv_protocol: :des }
+            end
+            let(:protocol_options) { version_options.merge(user_options).merge(extra_options) }
+            it "raises authentication error" do
+              expect { subject.get(oid: get_oid) }.to raise_error(NETSNMP::Error, "Authentication failure (incorrect password, community or key)")
+            end
+          end
         end
       end
 

data/spec/mib_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+RSpec.describe NETSNMP::MIB do
+  describe ".oid" do
+    it { expect(described_class.oid("1.2.3.4")).to eq("1.2.3.4") }
+    it { expect(described_class.oid("ifTable")).to eq("1.3.6.1.2.1.2.2") }
+    it { expect(described_class.oid("sysDescr.0")).to eq("1.3.6.1.2.1.1.1.0") }
+    it { expect(described_class.oid("ifTable.1.23")).to eq("1.3.6.1.2.1.2.2.1.23") }
+    it { expect(described_class.oid("IF-MIB::ifTable.1.23")).to eq("1.3.6.1.2.1.2.2.1.23") }
+    it { expect(described_class.oid("IFMIB::ifTable.1.23")).to be_nil }
+    it { expect(described_class.oid("IF-MIB::")).to be_nil }
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+GC.auto_compact = true if GC.respond_to?(:auto_compact=)
+
 if ENV.key?("CI")
   require "simplecov"
   SimpleCov.command_name "#{RUBY_ENGINE}-#{RUBY_VERSION}"
@@ -8,7 +10,6 @@ end
 
 if defined?(SimpleCov)
   SimpleCov.start do
-    minimum_coverage 85
     add_filter ".bundle"
     add_filter "/spec/"
   end

data/spec/support/celluloid.rb

@@ -26,7 +26,7 @@ module CelluloidHelpers
     end
   end
 
-  class Proxy < NETSNMP::Session::Transport
+  class Proxy
     MAXPDUSIZE = 0xffff + 1
 
     def initialize(host, port)
@@ -35,18 +35,22 @@ module CelluloidHelpers
       @timeout = 2
     end
 
-    def close
-      @socket.close
+    def send(payload)
+      @socket.send(payload, 0)
+      recv
     end
 
-    private
-
-    def wait(mode)
+    def recv(bytesize = MAXPDUSIZE)
       Celluloid.timeout(@timeout) do
-        @socket.__send__(mode)
+        datagram, = @socket.recvfrom(bytesize)
+        datagram
       end
     rescue Celluloid::TaskTimeout
       raise Timeout::Error, "Timeout after #{@timeout} seconds"
     end
+
+    def close
+      @socket.close
+    end
   end
 end

data/spec/varbind_spec.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 RSpec.describe NETSNMP::Varbind do
+  using NETSNMP::StringExtensions
+
   describe "#to_der" do
     it { expect(described_class.new(".1.3.6.1.2.1.1.1.0").to_der).to eq("0\f\006\b+\006\001\002\001\001\001\000\005\000".b) }
 
@@ -25,7 +27,7 @@ RSpec.describe NETSNMP::Varbind do
           gauge = 127
           varbind = described_class.new(".1.3.6.1.2.1.1.3.0", type: :gauge, value: gauge)
           value_str = varbind.to_der[12..-1]
-          header = value_str[0].unpack("B8").first
+          header = value_str[0].unpack1("B8")
 
           # Class: Primitive Application
           expect(header[0..1]).to eq("01")
@@ -43,7 +45,7 @@ RSpec.describe NETSNMP::Varbind do
           gauge = 128
           varbind = described_class.new(".1.3.6.1.2.1.1.3.0", type: :gauge, value: gauge)
           value_str = varbind.to_der[12..-1]
-          header = value_str[0].unpack("B8").first
+          header = value_str[0].unpack1("B8")
 
           # Class: Primitive Application
           expect(header[0..1]).to eq("01")
@@ -61,7 +63,7 @@ RSpec.describe NETSNMP::Varbind do
           gauge = 805
           varbind = described_class.new(".1.3.6.1.2.1.1.3.0", type: :gauge, value: gauge)
           value_str = varbind.to_der[12..-1]
-          header = value_str[0].unpack("B8").first
+          header = value_str[0].unpack1("B8")
 
           # Class: Primitive Application
           expect(header[0..1]).to eq("01")

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: netsnmp
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Tiago Cardoso
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-18 00:00:00.000000000 Z
-dependencies: []
+date: 2021-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |2
       Wraps the net-snmp core usage into idiomatic ruby.
       It is designed to support as many environments and concurrency frameworks as possible.
@@ -27,7 +41,11 @@ files:
 - lib/netsnmp/encryption/des.rb
 - lib/netsnmp/encryption/none.rb
 - lib/netsnmp/errors.rb
+- lib/netsnmp/extensions.rb
+- lib/netsnmp/loggable.rb
 - lib/netsnmp/message.rb
+- lib/netsnmp/mib.rb
+- lib/netsnmp/mib/parser.rb
 - lib/netsnmp/oid.rb
 - lib/netsnmp/pdu.rb
 - lib/netsnmp/scoped_pdu.rb
@@ -38,7 +56,10 @@ files:
 - lib/netsnmp/varbind.rb
 - lib/netsnmp/version.rb
 - sig/client.rbs
+- sig/loggable.rbs
 - sig/message.rbs
+- sig/mib.rbs
+- sig/mib/parser.rbs
 - sig/netsnmp.rbs
 - sig/oid.rbs
 - sig/openssl.rbs
@@ -51,6 +72,7 @@ files:
 - sig/varbind.rbs
 - spec/client_spec.rb
 - spec/handlers/celluloid_spec.rb
+- spec/mib_spec.rb
 - spec/oid_spec.rb
 - spec/pdu_spec.rb
 - spec/security_parameters_spec.rb
@@ -82,20 +104,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - net-snmp
-rubygems_version: 3.1.4
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: SNMP Client library
 test_files:
-- spec/timeticks_spec.rb
-- spec/spec_helper.rb
-- spec/session_spec.rb
 - spec/client_spec.rb
+- spec/handlers/celluloid_spec.rb
+- spec/mib_spec.rb
 - spec/oid_spec.rb
-- spec/varbind_spec.rb
-- spec/support/request_examples.rb
-- spec/support/celluloid.rb
 - spec/pdu_spec.rb
 - spec/security_parameters_spec.rb
+- spec/session_spec.rb
+- spec/spec_helper.rb
+- spec/support/celluloid.rb
+- spec/support/request_examples.rb
+- spec/timeticks_spec.rb
 - spec/v3_session_spec.rb
-- spec/handlers/celluloid_spec.rb
+- spec/varbind_spec.rb