net-snmp 0.2.2 → 0.2.3

data/README.rdoc

@@ -78,6 +78,25 @@ An asynchronous SNMP-GET
     Net::SNMP::Dispatcher.select(false)  #Setting timeout to false causes dispatcher to block until data is ready
     session.close
 
+An SNMPv3 synchronous AuthPriv (encrypted) SNMP-GET
+
+  Net::SNMP::Session.open(:peername => "test.net-snmp.org",
+													:community => "demopublic",
+													:version => "3",
+													:security_level => Net::SNMP::Constants::SNMP_SEC_LEVEL_AUTHPRIV,
+													:auth_protocol => :sha1,
+													:priv_protocol => :des,
+													:username => "myuser",
+													:password => "mypassword"
+													) {|session|
+  	begin
+    	pdu = session.get("sysDescr.0")
+    	puts pdu.varbinds.first.value
+  	rescue Net::SNMP::Error => e
+    	puts e.message
+  	end
+	end
+
 Running the dispatcher from eventmachine
     EM.run do
       Net::SNMP::Dispatcher.em_loop

data/lib/net/snmp/session.rb

@@ -31,6 +31,12 @@ module Net
         # * +version+ - snmp version.  Possible values include 1, '2c', and 3. Default is 1.
         # * +timeout+ - snmp timeout in seconds
         # * +retries+ - snmp retries.  default = 5
+        # * +security_level+ - SNMPv3 only. default = Net::SNMP::Constants::SNMP_SEC_LEVEL_NOAUTH
+        # * +auth_protocol+ - SNMPv3 only. default is nil (usmNoAuthProtocol). Possible values include :md5, :sha1, and nil
+        # * +priv_protocol+ - SNMPv3 only. default is nil (usmNoPrivProtocol). Possible values include :des, :aes, and nil
+        # * +context+ - SNMPv3 only.
+        # * +username+ - SNMPv3 only.
+        # * +password+ - SNMPv3 only.
         # Returns:
         # Net::SNMP::Session
         def open(options = {})
@@ -92,25 +98,64 @@ module Net
               when nil
                 OID.new("1.3.6.1.6.3.10.1.1.1").pointer
           end
+          @sess.securityPrivProto = case options[:priv_protocol]
+              when :aes
+                OID.new("1.3.6.1.6.3.10.1.2.4").pointer
+              when :des
+                OID.new("1.3.6.1.6.3.10.1.2.2").pointer
+              when nil
+                OID.new("1.3.6.1.6.3.10.1.2.1").pointer
+          end
           
           @sess.securityAuthProtoLen = 10
           @sess.securityAuthKeyLen = Constants::USM_AUTH_KU_LEN
 
+          @sess.securityPrivProtoLen = 10
+          @sess.securityPrivKeyLen = Constants::USM_PRIV_KU_LEN
+
           if options[:context]
             @sess.contextName = FFI::MemoryPointer.from_string(options[:context])
             @sess.contextNameLen = options[:context].length
           end
 
-          if options[:username]
-            @sess.securityName = FFI::MemoryPointer.from_string(options[:username])
-            @sess.securityNameLen = options[:username].length
-          end
-          auth_len_ptr = FFI::MemoryPointer.new(:size_t)
-          auth_len_ptr.write_int(Constants::USM_AUTH_KU_LEN)
-          key_result = Wrapper.generate_Ku(@sess.securityAuthProto, @sess.securityAuthProtoLen, options[:password], options[:password].length, @sess.securityAuthKey, auth_len_ptr)
-          @sess.securityAuthKeyLen = auth_len_ptr.read_int
-          unless key_result == Constants::SNMPERR_SUCCESS
-            Wrapper.snmp_perror("netsnmp")
+          # Do not generate_Ku, unless we're Auth or AuthPriv
+          unless @sess.securityLevel == Constants::SNMP_SEC_LEVEL_NOAUTH
+            if options[:username].nil? or options[:password].nil?
+              raise Net::SNMP::Error.new "SecurityLevel requires username and password"
+            end
+            if options[:username]
+              @sess.securityName = FFI::MemoryPointer.from_string(options[:username])
+              @sess.securityNameLen = options[:username].length
+            end
+
+            auth_len_ptr = FFI::MemoryPointer.new(:size_t)
+            auth_len_ptr.write_int(Constants::USM_AUTH_KU_LEN)
+            auth_key_result = Wrapper.generate_Ku(@sess.securityAuthProto,
+                                             @sess.securityAuthProtoLen,
+                                             options[:password],
+                                             options[:password].length,
+                                             @sess.securityAuthKey,
+                                             auth_len_ptr)
+            @sess.securityAuthKeyLen = auth_len_ptr.read_int
+
+            if @sess.securityLevel == Constants::SNMP_SEC_LEVEL_AUTHPRIV
+              priv_len_ptr = FFI::MemoryPointer.new(:size_t)
+              priv_len_ptr.write_int(Constants::USM_PRIV_KU_LEN)
+
+              # NOTE I know this is handing off the AuthProto, but generates a proper
+              # key for encryption, and using PrivProto does not.
+              priv_key_result = Wrapper.generate_Ku(@sess.securityAuthProto,
+                                               @sess.securityAuthProtoLen,
+                                               options[:password],
+                                               options[:password].length,
+                                               @sess.securityPrivKey,
+                                               auth_len_ptr)
+              @sess.securityPrivKeyLen = priv_len_ptr.read_int
+            end
+
+            unless auth_key_result == Constants::SNMPERR_SUCCESS and priv_key_result == Constants::SNMPERR_SUCCESS
+              Wrapper.snmp_perror("netsnmp")
+            end
           end
         end
         # General callback just takes the pdu, calls the session callback if any, then the request specific callback.

data/lib/net/snmp/version.rb

@@ -1,5 +1,5 @@
 module Net
   module SNMP
-    VERSION = "0.2.2"
+    VERSION = "0.2.3"
   end
 end

data/net-snmp.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Ron McClain"]
   s.email       = ["mixtli@github.com"]
-  s.homepage    = ""
+  s.homepage    = "https://github.com/mixtli/net-snmp"
   s.summary     = %q{Object oriented wrapper around C net-snmp libraries}
   s.description = %q{Uses ffi to create an object oriented wrapper around C net-snmp libraries}
 
@@ -19,6 +19,12 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+
+  # Documentation options
+  s.has_rdoc = true
+  s.extra_rdoc_files = %w{ README.rdoc }
+  s.rdoc_options = ["--main=README.rdoc", "--line-numbers", "--inline-source", "--title=#{s.name}-#{s.version} Documentation"]
+
   s.add_dependency 'ffi-inliner'
   s.add_dependency 'nice-ffi'
   s.add_development_dependency "rspec"

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: net-snmp
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 2
-  - 2
-  version: 0.2.2
+  prerelease: 
+  version: 0.2.3
 platform: ruby
 authors: 
 - Ron McClain
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-04 00:00:00 -05:00
+date: 2011-08-02 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,8 +21,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
@@ -38,8 +32,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id002
@@ -51,8 +43,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id003
@@ -64,8 +54,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id004
@@ -77,8 +65,8 @@ executables:
 - stress_test.rb
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.rdoc
 files: 
 - .document
 - .gitignore
@@ -124,12 +112,15 @@ files:
 - spec/utility_spec.rb
 - spec/wrapper_spec.rb
 has_rdoc: true
-homepage: ""
+homepage: https://github.com/mixtli/net-snmp
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --main=README.rdoc
+- --line-numbers
+- --inline-source
+- --title=net-snmp-0.2.3 Documentation
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -137,21 +128,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: net-snmp
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Object oriented wrapper around C net-snmp libraries