netsnmp 0.1.8 → 0.4.1

data/lib/netsnmp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NETSNMP
-  VERSION = "0.1.8"
+  VERSION = "0.4.1"
 end

data/sig/client.rbs

@@ -0,0 +1,24 @@
+module NETSNMP
+  class Client
+
+    def get: (*untyped) -> untyped
+           | (*untyped) { (PDU) -> void } -> untyped
+
+    def get_next: (*untyped) -> untyped
+                | (*untyped) { (PDU) -> void } -> untyped
+
+    def set: (*untyped) -> untyped
+           | (*untyped) { (PDU) -> void } -> untyped
+
+    def inform: (*untyped) -> untyped
+              | (*untyped) { (PDU) -> void } -> untyped
+
+    def walk: (oid: oid) -> _Each[oid_type, oid_value]
+
+    def close: () -> void
+
+    private
+
+    def initialize: (?version?: snmp_version, **untyped) -> untyped
+  end
+end

data/sig/loggable.rbs

@@ -0,0 +1,16 @@
+module NETSNMP
+  module Loggable
+    interface _Debugger
+      def <<: (string) -> void
+    end
+
+    DEBUG_LEVEL: Integer
+    DEBUG: _Debugger
+
+    private
+
+    def initialize: (?debug: _DEBUGGER, ?debug_level: Integer, **untyped) -> void
+
+    def log: (?level: Integer) { () -> String } -> void
+  end
+end

data/sig/message.rbs

@@ -0,0 +1,9 @@
+module NETSNMP
+  class Message
+    prepend Loggable
+
+    def decode: (String stream, security_parameters: SecurityParameters) -> [ScopedPDU, String, Integer, Integer]
+
+    def encode: (ScopedPDU pdu, security_parameters: SecurityParameters, ?engine_boots: Integer, ?engine_time: Integer) -> String
+  end
+end

data/sig/mib.rbs

@@ -0,0 +1,21 @@
+module NETSNMP
+  module MIB
+    type import = {ids: Array[{name: string}], name: string} | {ids: {name: string}, name: string}
+
+
+    MIBDIRS: Array[String]
+    PARSER: Parser
+
+    @parser_mutex: Mutex
+    @modules_loaded: Array[String]
+    @object_identifiers: Hash[String, String]
+
+    def self?.oid: (String identifier) -> String?
+                 | (Array[_ToS] identifier) -> String?
+
+    def self?.load: (String mod) -> void
+
+    def self?.load_imports: ((Array[import] | import)? data) -> Hash[String, Array[String]]?
+    def self?.load_defaults: () -> void
+  end
+end

data/sig/mib/parser.rbs

@@ -0,0 +1,7 @@
+module NETSNMP
+  module MIB
+    class Parser
+
+    end
+  end
+end

data/sig/netsnmp.rbs

@@ -0,0 +1,19 @@
+module NETSNMP
+  interface _Logger
+    def <<: (string) -> void
+  end
+
+  interface _Authenticate
+    def reset: () -> void
+    def <<: (string) -> void
+    def digest: () -> String
+  end
+
+  interface _Encrypt
+    def encrypt: (String payload, engine_boots: Integer, engine_time: Integer) -> String
+
+    def decrypt: (String payload, salt: String, engine_boots: Integer, engine_time: Integer) -> String
+  end
+
+  type snmp_version = 0 | 1 | 3 | :v1 | :v2c | :v3 | nil
+end

data/sig/oid.rbs

@@ -0,0 +1,18 @@
+module NETSNMP
+  type oid = String | Array[_ToS]
+
+  type oid_type = Integer | :ipaddress | :counter32 | :gauge | :timetick | :opaque | :nsap | :counter64 | :uinteger
+
+  type oid_value = String | Integer | Timetick | true | false | nil | IPAddr
+
+  # type oid_options = {}
+
+  module OID
+
+    def self?.build: (oid) -> String
+
+    def self?.to_asn: (String oid) -> OpenSSL::ASN1::ObjectId
+
+    def self?.parent?: (String oid, String oid) -> bool
+  end
+end

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: Integer
+    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,58 @@
+module NETSNMP
+  class SecurityParameters
+    prepend Loggable
+
+    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, ?security_level: Integer?) -> OpenSSL::ASN1::ASN1Data
+
+    def sign: (String message) -> String?
+
+    def verify: (String stream, String salt, ?security_level: Integer?) -> 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,38 @@
+module NETSNMP
+  class Session
+    prepend Loggable
+
+    @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
@@ -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" }