netsnmp 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: faea873fa6ca9eaf4c453c77dc2f897af13b523521344f8e39e72006f1493d23
-  data.tar.gz: 6e671ad1fb6ecb01ddbad7647ce2c01f532537845cd74fcd3db188a8af543010
+  metadata.gz: 48d02a452a0dee151b936f9e8ff6af2c0c305f6a235a42a23ce5426a5dcd33f2
+  data.tar.gz: 05b2efdcbac79cba8d4e749dca163446fab1214c355a609c3e855762af1018a5
 SHA512:
-  metadata.gz: 2a49e950ce387bf6c0e41d928b7a2617540990b399814cc5811969cedd4a65483454af203b990e4dcc041aa95cac7cdb19aa2c2fba3c7b16cfb24c424eef5b43
-  data.tar.gz: 007eb164271090585dbcab085a0a4bdef899c8acbb8b79ac43cba99c7b859326b7c2b89c08af03716f24d2980110196ac8f1795b527377fedb178b53ca013055
+  metadata.gz: a26c9601d225cb1a3008a11890955acf1372fafba39e07ea4eed8f70969fd22ebdacd655ddafbf62681ba4dd1d95159e2b348fd627dc8063e9c6c8f5f244579a
+  data.tar.gz: 3d0a6cfac763709d76cfc83b3d3d38261be9cb84d144a58267b3135a46b98418dd1cf882b5ff0866fabd1c74b59a82f641bbaad49387cbfc3a9d49242ef323b1

data/.travis.yml

@@ -12,7 +12,7 @@ install:
   - bundle install --path .bundle
 
 script:
-  - spec/support/specs.sh
+  - spec/support/specs.sh run
 
 language: ruby
 rvm:
@@ -22,7 +22,6 @@ rvm:
   - 2.4
   - 2.5
   - ruby-head
-  - jruby-9.1.15.0
   - jruby-head
   - rbx-2
 matrix:
@@ -30,5 +29,4 @@ matrix:
   - rvm: ruby-head
   - rvm: jruby-head
     # to figure out later
-  - rvm: jruby-9.1.15.0
   - rvm: rbx-2

data/Gemfile

@@ -16,8 +16,7 @@ gem "nio4r", "~> 1.2" if RUBY_VERSION < "2.2"
 platforms :mri do
   gem "pry-byebug", require: false
   gem "stackprof", require: false
+  gem "xorcist", require: false
 end
 
-gem "xorcist"
-
-gem "rubocop", require: false
+gem "rubocop", "0.52.1", require: false

data/README.md

@@ -219,26 +219,52 @@ All encoding/decoding/encryption/decryption/digests are done using `openssl`, wh
 
 ## Tests
 
-This library uses RSpec. The client specs are "integration" tests, in that we communicate with an snmp agent simulator.
+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).
 
-To start the simulator locally, you'll need docker 1.9 or higher (Why 1.9? ```--build-arg``` parameter support was needed for our builds in the CI. You could use a lower version by providing the proxy environment variables in the Dockerfile directly, provided you don't merge these changes to master, thereby exposing your proxy).
+### RSpec
+
+You can run all tests by typing:
 
 ```
-> spec/support/start_docker.sh
+> bundle exec rake spec
+# or
+> bundle exec rspec
+...
 ```
 
-this builds and starts the docker image in deamonized mode. You can afterwards run your specs:
+### 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
+
+The preferred way to use the snmp simulator is by using docker.
+
+In order to start the simulator container, run:
 
 ```
-> bundle exec rspec
+> spec/support/spec.sh start
 ```
 
-To stop the image, you can just:
+after, you just need to set the `SNMP_PORT` variable to the port found typing:
 
 ```
-> spec/supoprt/stop_docker.sh
+> docker port test-snmp 1161/udp
 ```
 
+and run the tests. 
+
+#### CI
+
+If you want to replicate what the CI is doing, just do:
+
+```
+> spec/support/spec.sh run
+```
+
+Which should: build and run the simulator container, run the tests, run rubocop, and remove all artifacts.
+
+
 ## Contributing
 
 * Fork this repository

data/Rakefile

@@ -3,6 +3,7 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "coveralls/rake/task"
+require "rubocop/rake_task"
 
 desc "runs the tests and sends to coveralls server"
 Coveralls::RakeTask.new
@@ -10,6 +11,11 @@ Coveralls::RakeTask.new
 desc "runs the tests"
 RSpec::Core::RakeTask.new
 
+desc "Run rubocop"
+task :rubocop do
+  RuboCop::RakeTask.new
+end
+
 task default: [:spec]
 
 namespace :spec do
@@ -20,5 +26,5 @@ namespace :spec do
   end
 
   desc "runs tests, check coverage, pushes to coverage server"
-  task ci: ["spec:coverage", "coveralls:push"]
+  task ci: ["spec:coverage", "coveralls:push", "rubocop"]
 end

data/lib/netsnmp/client.rb

@@ -135,6 +135,18 @@ module NETSNMP
       values.size > 1 ? values : values.first
     end
 
+    # Perform a SNMP INFORM Request
+    #
+    # @see {NETSNMP::Varbind#new}
+    #
+    def inform(*oid_opts)
+      request = @session.build_pdu(:inform, *oid_opts)
+      response = handle_retries { @session.send(request) }
+      yield response if block_given?
+      values = response.varbinds.map(&:value)
+      values.size > 1 ? values : values.first
+    end
+
     private
 
     # Handles timeout errors by reissuing the same pdu until it runs out or retries.

data/lib/netsnmp/encryption/aes.rb

@@ -15,7 +15,7 @@ module NETSNMP
 
         cipher.encrypt
         cipher.iv = iv
-        cipher.key = des_key
+        cipher.key = aes_key
 
         if (diff = decrypted_data.length % 8) != 0
           decrypted_data << ("\x00" * (8 - diff))
@@ -29,7 +29,6 @@ module NETSNMP
 
       def decrypt(encrypted_data, salt:, engine_boots:, engine_time:)
         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::AES128.new(:CFB)
         cipher.padding = 0
@@ -37,7 +36,7 @@ module NETSNMP
         iv = generate_decryption_key(engine_boots, engine_time, salt)
 
         cipher.decrypt
-        cipher.key = des_key
+        cipher.key = aes_key
         cipher.iv = iv
         decrypted_data = cipher.update(encrypted_data) + cipher.final
         NETSNMP.debug { "decrypted:\n#{Hexdump.dump(decrypted_data)}" }
@@ -76,7 +75,7 @@ module NETSNMP
          0xff &  time].pack("c*") + salt
       end
 
-      def des_key
+      def aes_key
         @priv_key[0, 16]
       end
     end

data/lib/netsnmp/pdu.rb

@@ -50,6 +50,8 @@ module NETSNMP
               when :getnext   then 1
               #          when :getbulk   then 5
               when :set       then 3
+              when :inform    then 6
+              when :trap      then 7
               when :response  then 2
               else raise Error, "#{type} is not supported as type"
               end

data/lib/netsnmp/varbind.rb

@@ -80,10 +80,12 @@ module NETSNMP
         asn_type = case typ
                    when :ipaddress then 0
                    when :counter32
-                     asn_val = [value].pack("n*")
+                     asn_val = [value].pack("N*")
+                     asn_val = asn_val[1..-1] while asn_val.start_with?("\x00")
                      1
                    when :gauge
-                     asn_val = [value].pack("n*")
+                     asn_val = [value].pack("N*")
+                     asn_val = asn_val[1..-1] while asn_val.start_with?("\x00")
                      2
                    when :timetick
                      return Timetick.new(value).to_asn
@@ -102,10 +104,11 @@ module NETSNMP
       case asn.tag
       when 0 # IP Address
         IPAddr.new_ntoh(asn.value)
-      when 1 # ASN counter 32
-        asn.value.unpack("n*")[0] || 0
-      when 2 # gauge
-        asn.value.unpack("n*")[0] || 0
+      when 1, # ASN counter 32
+           2 # gauge
+        val = asn.value
+        val.prepend("\x00") while val.bytesize < 4
+        asn.value.unpack("N*")[0] || 0
       when 3 # timeticks
         Timetick.new(asn.value.unpack("N*")[0] || 0)
         # when 4 # opaque

data/lib/netsnmp/version.rb

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

data/spec/support/specs.sh

@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+
 function start {
   docker pull honeyryderchuck/snmp-server-emulator:latest
   docker run -d -p :1161/udp --name test-snmp -v $(pwd)/spec/support/snmpsim:/home/snmp_server/.snmpsim honeyryderchuck/snmp-server-emulator \
@@ -19,6 +20,14 @@ function start {
 
 }
 
+function run {
+  sleep 20 # give some time for the simulator to boot
+  
+  port="$(docker port test-snmp 1161/udp)"
+  export SNMP_PORT=$(echo $port | cut -d':' -f2)
+  
+  bundle exec rake spec:ci
+}
 
 function finish {
   docker stop test-snmp
@@ -27,13 +36,16 @@ function finish {
 
 trap finish EXIT
 
-start
-sleep 20 # give some time for the simulator to boot
-
-port="$(docker port test-snmp 1161/udp)"
-export SNMP_PORT=$(echo $port | cut -d':' -f2)
-
-bundle exec rake spec:ci
-bundle exec rubocop
-
-
+case "$1" in
+  start)
+    start
+    docker logs -f test-snmp
+    ;;
+  run)
+    start
+    run
+    ;;
+  *)
+    echo $"Usage: $0 {start|run}"
+    exit 1
+esac

data/spec/varbind_spec.rb

@@ -16,7 +16,6 @@ RSpec.describe NETSNMP::Varbind do
         expect(varbind.to_der).to end_with("\x04\x00\x00\x00\x01".b) # ends with an octet string rep of 1 timetick
       end
       context "when passed a type" do
-        # TODO: tidy this for IP Addresses
         it "converts gauge32" do
           gauge = 805
           varbind = described_class.new(".1.3.6.1.2.1.1.3.0", type: :gauge, value: gauge)
@@ -25,7 +24,7 @@ RSpec.describe NETSNMP::Varbind do
         it "converts counter32" do
           gauge = 998932
           varbind = described_class.new(".1.3.6.1.2.1.1.3.0", type: :counter32, value: gauge)
-          expect(varbind.to_der).to end_with("A\x02>\x14".b)
+          expect(varbind.to_der).to end_with("\x0F>\x14".b)
         end
         it "converts integer ticks" do
           timetick = 1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: netsnmp
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Tiago Cardoso
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-16 00:00:00.000000000 Z
+date: 2018-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -117,7 +117,6 @@ files:
 - spec/support/celluloid.rb
 - spec/support/request_examples.rb
 - spec/support/specs.sh
-- spec/support/start-docker.sh
 - spec/support/stop_docker.sh
 - spec/timeticks_spec.rb
 - spec/v3_session_spec.rb
@@ -144,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - net-snmp
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: SNMP Client library
@@ -160,7 +159,6 @@ test_files:
 - spec/support/celluloid.rb
 - spec/support/request_examples.rb
 - spec/support/specs.sh
-- spec/support/start-docker.sh
 - spec/support/stop_docker.sh
 - spec/timeticks_spec.rb
 - spec/v3_session_spec.rb

data/spec/support/start-docker.sh

@@ -1,19 +0,0 @@
-docker build -t snmp-server -f spec/support/Dockerfile .
-docker run -p :1161/udp --name test-snmp-emulator -v $(pwd)/spec/support/snmpsim:/home/snmp_server/.snmpsim snmp-server \
-  --v3-engine-id=000000000000000000000002 \
-  --agent-udpv4-endpoint=0.0.0.0:1161 --agent-udpv6-endpoint='[::0]:1161' \
-  --v3-user=simulator --v3-auth-key=auctoritas --v3-priv-key=privatus \
-  --v3-user=authmd5 --v3-auth-key=maplesyrup --v3-auth-proto=MD5 --v3-priv-proto=NONE \
-  --v3-user=authsha --v3-auth-key=maplesyrup --v3-auth-proto=SHA --v3-priv-proto=NONE \
-  --v3-user=authprivshaaes --v3-auth-key=maplesyrup --v3-auth-proto=SHA \
-                           --v3-priv-key=maplesyrup --v3-priv-proto=AES \
-  --v3-user=authprivmd5aes --v3-auth-key=maplesyrup --v3-auth-proto=MD5 \
-                           --v3-priv-key=maplesyrup --v3-priv-proto=AES \
-  --v3-user=authprivshades --v3-auth-key=maplesyrup --v3-auth-proto=SHA \
-                           --v3-priv-key=maplesyrup --v3-priv-proto=DES \
-  --v3-user=authprivmd5des --v3-auth-key=maplesyrup --v3-auth-proto=MD5 \
-                           --v3-priv-key=maplesyrup --v3-priv-proto=DES \
-  --v3-user=unsafe --v3-auth-proto=NONE --v3-priv-proto=NONE
-#sleep 20 # give some time for the simulator to boot
-export SNMP_PORT=`echo $(docker port test-snmp-emulator 1161/udp) | cut -d':' -f2`
-