netsnmp 0.1.5 → 0.2.0

data/sig/openssl.rbs

@@ -0,0 +1,20 @@
+module OpenSSL
+  module ASN1
+    class ASN1Data
+    end
+    class ObjectId < ASN1Data
+    end
+    class Primitive < ASN1Data
+    end
+    class Integer < ASN1Data
+    end
+    class OctetString < ASN1Data
+    end
+    class Sequence < ASN1Data
+    end
+  end
+end
+
+interface _ToAsn
+  def to_asn: () -> OpenSSL::ASN1::ASN1Data
+end

data/sig/pdu.rbs

@@ -0,0 +1,48 @@
+module NETSNMP
+  type pdu_type = :get | :getnext | :set | :inform | :trap | :response
+
+  class PDU
+
+    # type pdu_options = {
+    #   headers: [snmp_version?, String?],
+    #   ?request_id: String,
+    #   ?error_status: Integer,
+    #   ?error_index: Integer,
+    #   ?varbinds: Array[varbind_options]
+    # }
+
+    attr_reader varbinds: Array[Varbind]
+    attr_reader type: pdu_type
+    attr_reader version: snmp_version
+    attr_reader community: String
+    attr_reader request_id: Integer
+
+    def self.decode: (String der) -> PDU
+                   | (OpenSSL::ASN1::ASN1Data der) -> PDU
+
+    def self.build: (pdu_type, **untyped) -> PDU
+
+
+    def to_asn: () -> OpenSSL::ASN1::ASN1Data
+
+    def to_der: () -> String
+
+    def add_varbind: (oid: oid, **varbind_options) -> void
+    alias << add_varbind
+
+    private
+
+    def initialize: (
+      type: Integer,
+      headers: [snmp_version?, String?],
+      ?request_id: Integer,
+      ?error_status: Integer,
+      ?error_index: Integer,
+      ?varbinds: Array[varbind_options]
+    ) -> untyped
+
+    def encode_headers_asn: () -> [OpenSSL::ASN1::Integer, OpenSSL::ASN1::OctetString]
+
+    def check_error_status: (Integer) -> void
+  end
+end

data/sig/scoped_pdu.rbs

@@ -0,0 +1,15 @@
+module NETSNMP
+  class ScopedPDU < PDU
+    attr_reader engine_id: String
+
+    private
+
+    def initialize: (
+      type: Integer,
+      headers: [String?, String?],
+      **untyped
+    ) -> void
+
+    def encode_headers_asn: () -> [OpenSSL::ASN1::OctetString, OpenSSL::ASN1::OctetString]
+  end
+end

data/sig/security_parameters.rbs

@@ -0,0 +1,56 @@
+module NETSNMP
+  class SecurityParameters
+    type security_level = :noauth | :auth_no_priv | :auth_priv | 0 | 1 | 3 | nil
+
+    type auth_protocol = :md5 | :sha
+    type priv_protocol = :des | :aes
+
+
+    @auth_protocol: auth_protocol?
+    @auth_password: String?
+    @priv_protocol: priv_protocol?
+    @priv_password: String?
+    @digest: _Authenticate?
+    @encryption: _Encrypt?
+
+    attr_reader security_level: security_level
+    attr_reader username: String
+    attr_reader engine_id: String
+
+    def engine_id=: (String id) -> void
+
+    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 sign: (String message) -> String?
+
+    def verify: (String stream, String salt) -> void
+
+    def must_revalidate?: () -> bool
+
+    private
+
+    def initialize: (
+      username: String,
+      ?engine_id: String,
+      ?security_level: security_level?,
+      ?auth_protocol: auth_protocol?,
+      ?auth_password: String?,
+      ?priv_protocol: priv_protocol?,
+      ?priv_password: String?,
+    ) -> untyped
+
+    def auth_key: () -> String
+
+    def priv_key: () -> String
+
+    def check_parameters: () -> void
+
+    def localize_key: (String key) -> String
+
+    def passkey: (String password) -> String
+
+    def authorizable?: () -> bool
+  end
+end

data/sig/session.rbs

@@ -0,0 +1,36 @@
+module NETSNMP
+  class Session
+    @transport: _Transport
+    @version: 0 | 1 | 3
+    @community: String?
+
+    def close: () -> void
+
+    def build_pdu: (pdu_type, *untyped) -> PDU
+
+    def send: (PDU) -> PDU
+
+    private
+
+    def initialize: (?version: snmp_version, ?community: String, **untyped) -> untyped
+   
+    def validate: (?host: String?, ?port: Integer, ?proxy: _Transport, ?timeout: Integer, **untyped) -> void
+
+    class Transport
+      def initialize: (String host, Integer port, timeout: Integer) -> untyped
+      def close: () -> void
+      def send: (String payload) -> String
+      def write: (String) -> void
+      def recv: () -> void
+
+      private
+
+      def wait: (:wait_readable | :wait_writable) -> void
+    end
+  end
+
+  interface _Transport
+    def close: () -> void
+    def send: (String payload) -> String
+  end
+end

data/sig/timeticks.rbs

@@ -0,0 +1,7 @@
+module NETSNMP
+  class Timetick < Numeric
+    @ticks: Integer
+
+    def to_asn: () -> OpenSSL::ASN1::ASN1Data
+  end
+end

data/sig/v3_session.rbs

@@ -0,0 +1,21 @@
+module NETSNMP
+  class V3Session < Session
+
+    def build_pdu: (pdu_type, *untyped) -> ScopedPDU
+
+    def send: (ScopedPDU pdu) -> ScopedPDU
+    		| (ScopedPDU pdu) -> [PDU, String, Integer, Integer]
+
+    private
+
+    def encode: (ScopedPDU) -> String
+
+    def initialize: (?context: String, **untyped) -> untyped
+
+    def security_parameters: () -> SecurityParameters
+
+    def probe_for_engine: () -> String
+
+    def decode: (String, ?security_parameters: SecurityParameters) -> [PDU, String, Integer, Integer]
+  end
+end

data/sig/varbind.rbs

@@ -0,0 +1,30 @@
+module NETSNMP
+  type varbind_options = untyped
+
+  class Varbind
+
+    type varbind_value = OpenSSL::ASN1::OctetString | OpenSSL::ASN1::Primitive | OpenSSL::ASN1::ASN1Data | oid_value
+
+    attr_reader oid: String
+    attr_reader value: oid_value
+
+    def to_asn: () -> OpenSSL::ASN1::Sequence
+
+    def to_der: () -> String
+
+    def convert_val: (varbind_value) -> oid_value
+
+
+    def convert_to_asn: (oid_type, oid_value) -> OpenSSL::ASN1::ASN1Data
+
+    def convert_application_asn: (OpenSSL::ASN1::ASN1Data asn) -> oid_value
+
+    private
+
+    def initialize: (oid, ?value: varbind_value, ?type: oid_type) -> untyped
+
+    def unpack_32bit_integer: (String) -> Integer
+
+    def unpack_64bit_integer: (String) -> Integer
+  end
+end

data/spec/client_spec.rb

@@ -3,11 +3,11 @@
 require_relative "support/request_examples"
 
 RSpec.describe NETSNMP::Client do
-  let(:host) { "localhost" }
+  let(:host) { SNMPHOST }
 
   let(:device_options) do
     {
-      peername: "localhost",
+      peername: SNMPHOST,
       port: SNMPPORT
     }
   end

data/spec/handlers/celluloid_spec.rb

@@ -31,14 +31,15 @@ RSpec.describe "with cellulloid", type: :celluloid do
     WALK
   end
 
+  before(:all) { Celluloid.boot }
   around(:each) do |example|
     within_io_actor { example.run }
   end
-  let(:proxy) { CelluloidHelpers::Proxy.new("localhost", SNMPPORT) }
+  let(:proxy) { CelluloidHelpers::Proxy.new(SNMPHOST, SNMPPORT) }
   after(:each) { proxy.close }
 
   it_behaves_like "an snmp client" do
-    subject { NETSNMP::Client.new(options) }
+    subject { NETSNMP::Client.new(**options) }
     let(:device_options) { { proxy: proxy } }
     let(:protocol_options) { user_options }
     let(:extra_options) { { version: 3, context: "a172334d7d97871b72241397f713fa12" } }

data/spec/session_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 RSpec.describe NETSNMP::Session do
-  let(:host) { "localhost" }
+  let(:host) { SNMPHOST }
   let(:options) do
     {
       version: "2c",
@@ -9,6 +9,6 @@ RSpec.describe NETSNMP::Session do
       port: SNMPPORT
     }
   end
-  subject { described_class.new(host, options) }
+  subject { described_class.new(host: host, **options) }
   after { subject.close }
 end

data/spec/spec_helper.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
-require "simplecov" if ENV["COVERAGE"]
-require "coveralls"
-Coveralls.wear!
+if ENV.key?("CI")
+  require "simplecov"
+  SimpleCov.command_name "#{RUBY_ENGINE}-#{RUBY_VERSION}"
+  SimpleCov.coverage_dir "coverage/#{RUBY_ENGINE}-#{RUBY_VERSION}"
+end
 
 if defined?(SimpleCov)
   SimpleCov.start do
@@ -17,7 +19,8 @@ Bundler.require(:default, :test)
 
 require "netsnmp"
 
-SNMPPORT = (ENV["SNMP_PORT"] || 1161).to_i
+SNMPPORT = ENV.fetch("SNMP_PORT", 1161).to_i
+SNMPHOST = ENV.fetch("SNMP_HOST", "localhost")
 
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.

data/spec/support/request_examples.rb

@@ -3,7 +3,7 @@
 RSpec.shared_examples "an snmp client" do
   let(:device_options) do
     {
-      host: "localhost",
+      host: SNMPHOST,
       port: SNMPPORT
     }
   end
@@ -11,7 +11,7 @@ RSpec.shared_examples "an snmp client" do
   let(:extra_options) { {} }
   let(:options) { protocol_options.merge(device_options).merge(extra_options) }
 
-  subject { described_class.new(options) }
+  subject { described_class.new(**options) }
 
   describe "#get" do
     let(:value) { subject.get(oid: get_oid) }

data/spec/v3_session_spec.rb

@@ -7,19 +7,19 @@ RSpec.describe NETSNMP::V3Session do
       priv_protocol: :des, security_level: :auth_priv }
   end
   it "generates the security parameters handler" do
-    sess = described_class.new(security_options.merge(host: "localhost", port: SNMPPORT))
+    sess = described_class.new(**security_options.merge(host: SNMPHOST, port: SNMPPORT))
     # not generated yet
     expect(sess.instance_variable_get(:@security_parameters)).to be_a(NETSNMP::SecurityParameters)
   end
 
   it "allows to pass a custom one" do
-    sec_params = NETSNMP::SecurityParameters.new(security_options)
-    sess = described_class.new(host: "localhost", port: SNMPPORT, security_parameters: sec_params)
+    sec_params = NETSNMP::SecurityParameters.new(**security_options)
+    sess = described_class.new(host: SNMPHOST, port: SNMPPORT, security_parameters: sec_params)
     # not generated yet
     expect(sess.instance_variable_get(:@security_parameters)).to be(sec_params)
   end
 
   it "fails if the pass object doesn't follow the expected api" do
-    expect { described_class.new(host: "localhost", port: SNMPPORT, security_parameters: double) }.to raise_error(NETSNMP::Error)
+    expect { described_class.new(host: SNMPHOST, port: SNMPPORT, security_parameters: double) }.to raise_error(NETSNMP::Error)
   end
 end

data/spec/varbind_spec.rb

@@ -9,27 +9,124 @@ RSpec.describe NETSNMP::Varbind do
         ipaddr = IPAddr.new("10.11.104.2")
         varbind = described_class.new(".1.3.6.1.4.1.2011.6.3.1.1.0", value: ipaddr)
         expect(varbind.to_der).to end_with("@\x04\n\vh\x02".b)
+        asn = varbind.to_asn.value.last
+        expect(varbind.convert_application_asn(asn)).to eq(ipaddr)
       end
       it "converts custom timeticks" do
         timetick = NETSNMP::Timetick.new(1) # yes, one timetick
         varbind = described_class.new(".1.3.6.1.2.1.1.3.0", value: timetick)
         expect(varbind.to_der).to end_with("\x04\x00\x00\x00\x01".b) # ends with an octet string rep of 1 timetick
+        asn = varbind.to_asn.value.last
+        expect(varbind.convert_application_asn(asn)).to eq(timetick)
       end
+
       context "when passed a type" do
+        it "converts gauge32 without a leading byte" 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
+
+          # Class: Primitive Application
+          expect(header[0..1]).to eq("01")
+          expect(header[2]).to eq("0")
+          # Type: Integer
+          expect(header[3..-1].to_i(2)).to eq(2)
+          # Length & Value
+          expect(varbind.to_der).to end_with("\x01\x7F".b) # 2 Bytes
+
+          # Original Value
+          asn = varbind.to_asn.value.last
+          expect(varbind.convert_application_asn(asn)).to eq(gauge)
+        end
+        it "converts gauge32 with a leading byte" 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
+
+          # Class: Primitive Application
+          expect(header[0..1]).to eq("01")
+          expect(header[2]).to eq("0")
+          # Type: Integer
+          expect(header[3..-1].to_i(2)).to eq(2)
+          # Length & Value
+          expect(varbind.to_der).to end_with("\x02\x00\x80".b) # 4 Bytes, all FF
+
+          # Original Value
+          asn = varbind.to_asn.value.last
+          expect(varbind.convert_application_asn(asn)).to eq(gauge)
+        end
         it "converts gauge32" do
           gauge = 805
           varbind = described_class.new(".1.3.6.1.2.1.1.3.0", type: :gauge, value: gauge)
-          expect(varbind.to_der).to end_with("B\x02\x03%".b)
+          value_str = varbind.to_der[12..-1]
+          header = value_str[0].unpack("B8").first
+
+          # Class: Primitive Application
+          expect(header[0..1]).to eq("01")
+          expect(header[2]).to eq("0")
+          # Type: Integer
+          expect(header[3..-1].to_i(2)).to eq(2)
+          # Length & Value
+          expect(varbind.to_der).to end_with("\x02\x03%".b)
+
+          # Original Value
+          asn = varbind.to_asn.value.last
+          expect(varbind.convert_application_asn(asn)).to eq(gauge)
+        end
+        it "converts counter32 without a leading byte" do
+          counter = 127
+          varbind = described_class.new(".1.3.6.1.2.1.1.3.0", type: :counter32, value: counter)
+          expect(varbind.to_der).to end_with("\x01\x7F".b)
+          asn = varbind.to_asn.value.last
+          expect(varbind.convert_application_asn(asn)).to eq(counter)
+        end
+        it "converts counter32 with a leading byte" do
+          counter = 128
+          varbind = described_class.new(".1.3.6.1.2.1.1.3.0", type: :counter32, value: counter)
+          expect(varbind.to_der).to end_with("\x02\x00\x80".b)
+          asn = varbind.to_asn.value.last
+          expect(varbind.convert_application_asn(asn)).to eq(counter)
         end
         it "converts counter32" do
-          gauge = 998932
-          varbind = described_class.new(".1.3.6.1.2.1.1.3.0", type: :counter32, value: gauge)
+          counter = 998932
+          varbind = described_class.new(".1.3.6.1.2.1.1.3.0", type: :counter32, value: counter)
           expect(varbind.to_der).to end_with("\x0F>\x14".b)
+          asn = varbind.to_asn.value.last
+          expect(varbind.convert_application_asn(asn)).to eq(counter)
+        end
+        it "converts counter64" do
+          counter = 998932
+          varbind = described_class.new(".1.3.6.1.2.1.1.3.0", type: :counter64, value: counter)
+          expect(varbind.to_der).to end_with("\x0F>\x14".b)
+          asn = varbind.to_asn.value.last
+          expect(varbind.convert_application_asn(asn)).to eq(counter)
+
+          counter = 4294967296
+          varbind = described_class.new(".1.3.6.1.2.1.1.3.0", type: :counter64, value: counter)
+          expect(varbind.to_der).to end_with("\x01\x00\x00\x00\x00".b)
+          asn = varbind.to_asn.value.last
+          expect(varbind.convert_application_asn(asn)).to eq(counter)
+
+          counter = 309084502
+          varbind = described_class.new(".1.3.6.1.2.1.1.3.0", type: :counter64, value: counter)
+          expect(varbind.to_der).to include("F\x04".b)
+          asn = varbind.to_asn.value.last
+          expect(varbind.convert_application_asn(asn)).to eq(counter)
+
+          counter = 2_613_579_752_238
+          varbind = described_class.new(".1.3.6.1.2.1.1.3.0", type: :counter64, value: counter)
+          expect(varbind.to_der).to include("F\x06".b)
+          asn = varbind.to_asn.value.last
+          expect(varbind.convert_application_asn(asn)).to eq(counter)
         end
         it "converts integer ticks" do
           timetick = 1
           varbind = described_class.new(".1.3.6.1.2.1.1.3.0", type: :timetick, value: timetick)
           expect(varbind.to_der).to end_with("\x04\x00\x00\x00\x01".b)
+          asn = varbind.to_asn.value.last
+          expect(varbind.convert_application_asn(asn)).to eq(timetick)
         end
       end
     end