apscanner 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b54660d1fd088dc9ce7842f06a72cae042836b9
+  data.tar.gz: f9e183125d770824637dc9b74e27ef10a679e4d1
+SHA512:
+  metadata.gz: 37b30665d129ed274792bfa9bb5c2f88efb01b26f01107b1b1d4fc058b8a9cb3098981954ea792e820fc340580b64876b813b71f15f3030fa7979d3f4ea903ff
+  data.tar.gz: 641a7a0c9c01b652347045d4cc78bc0a18b9e03e4abb074b72c8b6b1453dce141343ecd8f7bd02740aac54d113f3a46cf6aae45126be0c6b39f899daeae4ea29

data/bin/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'apscanner'
+require 'irb'
+
+IRB.start

data/lib/apscanner/entities/access_point.rb

@@ -0,0 +1,16 @@
+module Apscanner
+  class AccessPoint
+    attr_reader :name, :mac_address
+
+    def initialize(options = {})
+      @name = options[:name]
+      @mac_address = options[:mac_address]
+    end
+
+    def to_h
+      instance_variables.map do |var|
+        [var.to_s.delete('@').to_sym, instance_variable_get(var)]
+      end.to_h
+    end
+  end
+end

data/lib/apscanner/entities/sensor.rb

@@ -0,0 +1,23 @@
+module Apscanner
+  class Sensor
+    attr_reader :port, :ip_address, :community, :uuid, :access_points
+    attr_accessor :type
+
+    def initialize(options = {})
+      @port = options[:port]
+      @ip_address = options[:ip_address]
+      @community = options[:community]
+      @uuid = options[:uuid]
+      @type = options[:type]
+      @access_points = []
+    end
+
+    def scan
+      t0 = Time.now
+      @access_points = SnmpManager.new(self).run
+      Apscanner.logger.info("Scanned #{@access_points.count} APs from " \
+                            "#{@ip_address} in #{(Time.now - t0).round(2)}s.")
+      self
+    end
+  end
+end

data/lib/apscanner/entities/snmp_manager.rb

@@ -0,0 +1,90 @@
+module Apscanner
+  class SnmpManager
+    SNMP_OID = {
+      wlc: {
+        name: '1.3.6.1.4.1.9.9.513.1.1.1.1.5',
+        mac: '1.3.6.1.4.1.9.9.513.1.1.1.1.2'
+      },
+      meraki: {
+        name: '1.3.6.1.4.1.29671.1.1.4.1.1',
+        mac: '1.3.6.1.4.1.29671.1.1.4.1.2'
+      }
+    }.freeze
+
+    def initialize(sensor)
+      @sensor = sensor
+    end
+
+    def run
+      response = request_by_type
+      return [] if response.empty?
+      parse(response, SNMP_OID[@sensor.type])
+    end
+
+    private
+
+    def manager
+      SNMP4EM::Manager.new(
+        host: @sensor.ip_address,
+        community: @sensor.community || 'public',
+        version: :SNMPv2c,
+        port: @sensor.port || 161,
+        retries: 2
+      )
+    end
+
+    def discover
+      response = {}
+      SNMP_OID.each do |type, oids|
+        response = request(oids.values)
+        unless response.empty?
+          @sensor.type = type
+          break
+        end
+      end
+      response
+    end
+
+    def request_by_type
+      if SNMP_OID.keys.include?(@sensor.type)
+        request(SNMP_OID[@sensor.type].values)
+      else
+        discover
+      end
+    end
+
+    def request(oids)
+      response = {}
+      EM.run do
+        req = manager.bulkwalk(oids)
+        req.errback do |error|
+          Apscanner.logger.error(error)
+          EM.stop
+        end
+
+        req.callback do |resp|
+          Apscanner.logger.debug("#{@sensor.ip_address}: #{resp}")
+          response = resp
+          EM.stop
+        end
+      end
+      response
+    end
+
+    def parse(response, oids)
+      access_points = []
+      response[oids[:mac]].each do |oid, value|
+        ap_oid = oid.gsub("#{oids[:mac]}.", '')
+        access_points << AccessPoint.new(
+          name: response[oids[:name]][oids[:name] + '.' + ap_oid],
+          mac_address: parse_mac(value)
+        )
+      end
+      access_points
+    end
+
+    def parse_mac(mac)
+      mac.unpack('H2H2H2H2H2H2').join(':').upcase
+    end
+  end
+end

data/lib/apscanner/entities/snmp_parser.rb

@@ -0,0 +1,7 @@
+module Apscanner
+  class SnmpParser
+    def initialize(sensor)
+      @sensor = sensor
+    end
+  end
+end

data/lib/apscanner/loggable.rb

@@ -0,0 +1,17 @@
+module Apscanner
+  module Loggable
+    def logger
+      @logger ||= default_logger
+    end
+
+    def logger=(logger)
+      @logger = logger
+    end
+
+    def default_logger
+      logger = Logger.new(STDOUT)
+      logger.level = Logger::INFO
+      logger
+    end
+  end
+end

data/lib/apscanner/scanner.rb

@@ -0,0 +1,14 @@
+module Apscanner
+  class Scanner
+    def initialize(sensors_json)
+      @sensors = sensors_json.map { |s| Sensor.new(s) }
+    end
+    
+    def run
+      @sensors.each do |sensor|
+        sensor.scan
+        yield(sensor) if block_given?
+      end
+    end
+  end
+end

data/lib/apscanner/version.rb

@@ -0,0 +1,3 @@
+module Apscanner
+  VERSION = '1.0.0'.freeze
+end

data/lib/apscanner.rb

@@ -0,0 +1,13 @@
+require 'apscanner/loggable'
+require 'apscanner/scanner'
+require 'apscanner/entities/snmp_manager'
+require 'apscanner/entities/sensor'
+require 'apscanner/entities/access_point'
+
+require 'snmp4em'
+require 'json'
+require 'logger'
+
+module Apscanner
+  extend Loggable
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: apscanner
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Julio J Garcia Perez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: snmp4em
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Access Point SNMP Scanner
+email:
+- jjgarcia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/console
+- lib/apscanner.rb
+- lib/apscanner/entities/access_point.rb
+- lib/apscanner/entities/sensor.rb
+- lib/apscanner/entities/snmp_manager.rb
+- lib/apscanner/entities/snmp_parser.rb
+- lib/apscanner/loggable.rb
+- lib/apscanner/scanner.rb
+- lib/apscanner/version.rb
+homepage: https://github.com/juliojgarciaperez/apscanner
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Access Points SNMP Scanner
+test_files: []