netsnmp 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48d02a452a0dee151b936f9e8ff6af2c0c305f6a235a42a23ce5426a5dcd33f2
-  data.tar.gz: 05b2efdcbac79cba8d4e749dca163446fab1214c355a609c3e855762af1018a5
+  metadata.gz: d6bb62b9abd416188660e04be1c12cf009b1df0e307030b9c239ea4b2acd73cc
+  data.tar.gz: ee88f7eb292f1a0077ab25e4677713290447e0e7755049bbe6db50f07d15d6a1
 SHA512:
-  metadata.gz: a26c9601d225cb1a3008a11890955acf1372fafba39e07ea4eed8f70969fd22ebdacd655ddafbf62681ba4dd1d95159e2b348fd627dc8063e9c6c8f5f244579a
-  data.tar.gz: 3d0a6cfac763709d76cfc83b3d3d38261be9cb84d144a58267b3135a46b98418dd1cf882b5ff0866fabd1c74b59a82f641bbaad49387cbfc3a9d49242ef323b1
+  metadata.gz: fc90cc626d4be2a04d598ec267bcfc108e87aea8e8a585a7611033fc56cb6c174a222250bb9eeeb05b2d03d058983b106c92c30ba3d91e922b171ecfbc37041a
+  data.tar.gz: '09dbbb277ae24d9b760c0de70738a02037da527d653d5e003632c1b41d808cc21c44034fb51bec63394a132fe3c30ffaac1adc846dc061ca483e13fc0719af97'

data/README.md

@@ -1,7 +1,6 @@
 # netsnmp
 
-[![Build Status](https://travis-ci.org/swisscom/ruby-netsnmp.svg?branch=master)](https://travis-ci.org/swisscom/ruby-netsnmp)
-[![Coverage Status](https://coveralls.io/repos/github/swisscom/ruby-netsnmp/badge.svg?branch=master)](https://coveralls.io/github/swisscom/ruby-netsnmp?branch=master)
+![Tests](https://github.com/swisscom/ruby-netsnmp/workflows/Tests/badge.svg)
 [![Code Climate](https://codeclimate.com/github/swisscom/ruby-netsnmp/badges/gpa.svg)](https://codeclimate.com/github/swisscom/ruby-netsnmp)
 [![Docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://www.rubydoc.info/github/swisscom/ruby-netsnmp/master)
 
@@ -123,6 +122,8 @@ If you create an `IPAddr` object (ruby standard library `ipaddr`) and pass it to
 The `NETSNMP::Timeticks` type is internal to this library, but it is a ruby `Numeric` type. You are safe to use it "as a numeric", that is, perform calculations.
 
 
+Counter32 and Counter64 types will map to plain integers.
+
 You can find usage examples [here](https://github.com/swisscom/ruby-netsnmp/blob/master/spec/varbind_spec.rb). If you need support to a missing type, you have the following options:
 
 * Use the `:type` parameter in `#set` calls:
@@ -221,6 +222,7 @@ All encoding/decoding/encryption/decryption/digests are done using `openssl`, wh
 
 This library uses RSpec. The client specs are "integration" tests, in that we communicate with an [snmpsim-built snmp agent simulator](https://github.com/etingof/snmpsim).
 
+
 ### RSpec
 
 You can run all tests by typing:
@@ -232,37 +234,31 @@ You can run all tests by typing:
 ...
 ```
 
-### SNMP Simulator
 
-You can install the package yourself (ex: `pip install snmpsim`) and run the server locally, and then set the `SNMP_PORT` environment variable, where the snmp simulator is running.
+### Docker
 
-#### Docker
-
-The preferred way to use the snmp simulator is by using docker.
-
-In order to start the simulator container, run:
+The most straightforward way of running the tests is by using the `docker-compose` setup (which is also what's used in the CI). Run it against the ruby version you're targeting:
 
 ```
-> spec/support/spec.sh start
+> docker-compose -f docker-compose.yml -f docker-compose-ruby-${RUBY_MAJOR_VERSION}.${RUBY_MAJOR_VERSION}.yml run netsnmp
 ```
 
-after, you just need to set the `SNMP_PORT` variable to the port found typing:
+The CI runs the tests against all supported ruby versions. If changes break a specific version of ruby, make sure you commit appropriate changes addressing the edge case, or let me know in the issues board, so I can help.
 
-```
-> docker port test-snmp 1161/udp
-```
+### SNMP Simulator
 
-and run the tests. 
+The SNMP simulator runs in its own container in the `docker` setup.
 
-#### CI
+You can install the package yourself (ex: `pip install snmpsim`) and run the server locally, and then set the `SNMP_PORT` environment variable, where the snmp simulator is running.
 
-If you want to replicate what the CI is doing, just do:
+#### CI
 
-```
-> spec/support/spec.sh run
-```
+The job of the CI is:
 
-Which should: build and run the simulator container, run the tests, run rubocop, and remove all artifacts.
+* Run all the tests;
+* Make sure the tests cover an appropriate surface of the code;
+* Lint the code;
+* (for ruby 3.0) type check the code;
 
 
 ## Contributing

data/lib/netsnmp.rb

@@ -34,6 +34,18 @@ rescue LoadError
 end
 
 module NETSNMP
+  module StringExtensions
+    # If you wonder why this is there: the oauth feature uses a refinement to enhance the
+    # Regexp class locally with #match? , but this is never tested, because ActiveSupport
+    # monkey-patches the same method... Please ActiveSupport, stop being so intrusive!
+    # :nocov:
+    refine(String) do
+      def match?(*args)
+        !match(*args).nil?
+      end
+    end
+  end
+
   def self.debug=(io)
     @debug_output = io
   end

data/lib/netsnmp/client.rb

@@ -23,8 +23,7 @@ module NETSNMP
     #      puts client.get(oid: "1.3.6.1.2.1.1.5.0")
     #    end
     #
-    def initialize(**options)
-      version = options[:version]
+    def initialize(version: nil, **options)
       version = case version
                 when Integer then version # assume the use know what he's doing
                 when /v?1/ then 0
@@ -33,7 +32,7 @@ module NETSNMP
                 end
 
       @retries = options.fetch(:retries, RETRIES)
-      @session ||= version == 3 ? V3Session.new(options) : Session.new(options)
+      @session ||= version == 3 ? V3Session.new(**options) : Session.new(version: version, **options)
       return unless block_given?
       begin
         yield self

data/lib/netsnmp/oid.rb

@@ -4,13 +4,14 @@ module NETSNMP
   # Abstracts the OID structure
   #
   module OID
+    using StringExtensions unless String.method_defined?(:match?)
+
     OIDREGEX = /^[\d\.]*$/
 
     module_function
 
     def build(o)
       case o
-      when OID then o
       when Array
         o.join(".")
       when OIDREGEX
@@ -29,7 +30,7 @@ module NETSNMP
     # @return [true, false] whether the given OID belongs to the sub-tree
     #
     def parent?(parent_oid, child_oid)
-      child_oid.match(/\A#{parent_oid}\./)
+      child_oid.match?(/\A#{parent_oid}\./)
     end
   end
 end

data/lib/netsnmp/pdu.rb

@@ -55,7 +55,7 @@ module NETSNMP
               when :response  then 2
               else raise Error, "#{type} is not supported as type"
               end
-        new(args.merge(type: typ))
+        new(type: typ, **args)
       end
     end
 
@@ -64,7 +64,7 @@ module NETSNMP
     attr_reader :version, :community, :request_id
 
     def initialize(type:, headers:,
-                   request_id: nil,
+                   request_id: SecureRandom.random_number(MAXREQUESTID),
                    error_status: 0,
                    error_index: 0,
                    varbinds: [])
@@ -75,9 +75,9 @@ module NETSNMP
       @type = type
       @varbinds = []
       varbinds.each do |varbind|
-        add_varbind(varbind)
+        add_varbind(**varbind)
       end
-      @request_id = request_id || SecureRandom.random_number(MAXREQUESTID)
+      @request_id = request_id
       check_error_status(@error_status)
     end
 

data/lib/netsnmp/scoped_pdu.rb

@@ -9,6 +9,8 @@ module NETSNMP
       super(type: type, headers: [3, nil], **options)
     end
 
+    private
+
     def encode_headers_asn
       [OpenSSL::ASN1::OctetString.new(@engine_id || ""),
        OpenSSL::ASN1::OctetString.new(@context || "")]

data/lib/netsnmp/security_parameters.rb

@@ -24,7 +24,7 @@ module NETSNMP
 
     # @param [String] username the snmp v3 username
     # @param [String] engine_id the device engine id (initialized to '' for report)
-    # @param [Symbol, integer] security_level allowed snmp v3 security level (:auth_priv, :auh_no_priv, etc)
+    # @param [Symbol, integer] security_level allowed snmp v3 security level (:auth_priv, :auth_no_priv, etc)
     # @param [Symbol, nil] auth_protocol a supported authentication protocol (currently supported: :md5, :sha)
     # @param [Symbol, nil] priv_protocol a supported privacy protocol (currently supported: :des, :aes)
     # @param [String, nil] auth_password the authentication password
@@ -99,7 +99,7 @@ module NETSNMP
     # @note this method is used in the process of authenticating a message
     def sign(message)
       # don't sign unless you have to
-      return nil unless @auth_protocol
+      return unless @auth_protocol
 
       key = auth_key.dup
 
@@ -211,7 +211,7 @@ module NETSNMP
     end
 
     def authorizable?
-      @auth_protocol && @auth_protocol != :none
+      @auth_protocol != :none
     end
   end
 end

data/lib/netsnmp/session.rb

@@ -10,7 +10,7 @@ module NETSNMP
     def initialize(version: 1, community: "public", **options)
       @version   = version
       @community = community
-      validate(options)
+      validate(**options)
     end
 
     # Closes the session
@@ -36,23 +36,20 @@ module NETSNMP
     # @return [NETSNMP::PDU] the response pdu
     #
     def send(pdu)
-      encoded_request = encode(pdu)
+      encoded_request = pdu.to_der
       encoded_response = @transport.send(encoded_request)
-      decode(encoded_response)
+      PDU.decode(encoded_response)
     end
 
     private
 
-    def validate(**options)
-      proxy = options[:proxy]
+    def validate(host: nil, port: 161, proxy: nil, timeout: TIMEOUT, **)
       if proxy
         @proxy = true
         @transport = proxy
       else
-        host, port = options.values_at(:host, :port)
         raise "you must provide an hostname/ip under :host" unless host
-        port ||= 161 # default snmp port
-        @transport = Transport.new(host, port.to_i, timeout: options.fetch(:timeout, TIMEOUT))
+        @transport = Transport.new(host, port.to_i, timeout: timeout)
       end
       @version = case @version
                  when Integer then @version # assume the use know what he's doing
@@ -64,14 +61,6 @@ module NETSNMP
                  end
     end
 
-    def encode(pdu)
-      pdu.to_der
-    end
-
-    def decode(stream)
-      PDU.decode(stream)
-    end
-
     class Transport
       MAXPDUSIZE = 0xffff + 1
 

data/lib/netsnmp/v3_session.rb

@@ -4,7 +4,7 @@ module NETSNMP
   # Abstraction for the v3 semantics.
   class V3Session < Session
     # @param [String, Integer] version SNMP version (always 3)
-    def initialize(version: 3, context: "", **opts)
+    def initialize(context: "", **opts)
       @context = context
       @security_parameters = opts.delete(:security_parameters)
       super
@@ -19,8 +19,10 @@ module NETSNMP
     end
 
     # @see {NETSNMP::Session#send}
-    def send(*)
-      pdu, = super
+    def send(pdu)
+      encoded_request = encode(pdu)
+      encoded_response = @transport.send(encoded_request)
+      pdu, = decode(encoded_response)
       pdu
     end
 

data/lib/netsnmp/varbind.rb

@@ -6,7 +6,7 @@ module NETSNMP
   class Varbind
     attr_reader :oid, :value
 
-    def initialize(oid, value: nil, type: nil, **_opts)
+    def initialize(oid, value: nil, type: nil)
       @oid = OID.build(oid)
       @type = type
       @value = convert_val(value) if value
@@ -81,17 +81,25 @@ module NETSNMP
                    when :ipaddress then 0
                    when :counter32
                      asn_val = [value].pack("N*")
-                     asn_val = asn_val[1..-1] while asn_val.start_with?("\x00")
+                     asn_val = asn_val[1..-1] while asn_val[0] == "\x00".b && asn_val[1].unpack("B").first != "1"
                      1
                    when :gauge
                      asn_val = [value].pack("N*")
-                     asn_val = asn_val[1..-1] while asn_val.start_with?("\x00")
+                     asn_val = asn_val[1..-1] while asn_val[0] == "\x00".b && asn_val[1].unpack("B").first != "1"
                      2
                    when :timetick
                      return Timetick.new(value).to_asn
                    when :opaque then 4
                    when :nsap then 5
-                   when :counter64 then 6
+                   when :counter64
+                     asn_val = [
+                       (value >> 96) & 0xFFFFFFFF,
+                       (value >> 64) & 0xFFFFFFFF,
+                       (value >> 32) & 0xFFFFFFFF,
+                       value & 0xFFFFFFFF
+                     ].pack("NNNN")
+                     asn_val = asn_val[1..-1] while asn_val.start_with?("\x00")
+                     6
                    when :uinteger then 7
                    else
                      raise Error, "#{typ}: unsupported application type"
@@ -106,16 +114,27 @@ module NETSNMP
         IPAddr.new_ntoh(asn.value)
       when 1, # ASN counter 32
            2 # gauge
-        val = asn.value
-        val.prepend("\x00") while val.bytesize < 4
-        asn.value.unpack("N*")[0] || 0
+        unpack_32bit_integer(asn.value)
       when 3 # timeticks
-        Timetick.new(asn.value.unpack("N*")[0] || 0)
+        Timetick.new(unpack_32bit_integer(asn.value))
         # when 4 # opaque
         # when 5 # NSAP
-        # when 6 # ASN Counter 64
+      when 6 # ASN Counter 64
+        unpack_64bit_integer(asn.value)
         # when 7 # ASN UInteger
       end
     end
+
+    private
+
+    def unpack_32bit_integer(payload)
+      payload.prepend("\x00") until (payload.bytesize % 4).zero?
+      payload.unpack("N*")[-1] || 0
+    end
+
+    def unpack_64bit_integer(payload)
+      payload.prepend("\x00") until (payload.bytesize % 16).zero?
+      payload.unpack("NNNN").reduce(0) { |sum, elem| (sum << 32) + elem }
+    end
   end
 end

data/lib/netsnmp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NETSNMP
-  VERSION = "0.1.5"
+  VERSION = "0.2.0"
 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/message.rbs

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

data/sig/netsnmp.rbs

@@ -0,0 +1,23 @@
+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
+
+  def self.debug=: (_Logger) -> void
+
+  def self.debug: { () -> string } -> void
+end

data/sig/oid.rbs

@@ -0,0 +1,18 @@
+module NETSNMP
+  type oid = String | Array[Integer]
+
+  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