portfinder 0.0.1 → 0.0.2

data/lib/portfinder/scanner.rb

@@ -1,3 +1,212 @@
-class Portfinder::Scanner
-end
+module Portfinder
+  # Portfinder Scanner base class
+  class Scanner
+    # Provides access to raw scan result
+    attr_reader :result
+    # Readonly port randomization flag
+    attr_reader :randomize
+    # Scan monitor accessor for in-scan monitoring and logging (readonly)
+    attr_reader :monitor
+
+    # Scanner initializer
+    def initialize target, port, config = {
+      randomize: true, threaded: true, threads: 10, thread_for: :port
+    }
+      @hosts = host_range target
+      @randomize = config[:randomize]
+      @ports = port_range port
+      @threaded = config[:threaded]
+      @thread_for = config[:thread_for]
+      @result = {}
+      @monitor = Monitor.new
+      @pool =
+        Pool.new(
+          threads_to_open(
+            @thread_for, config[:threads], @hosts, @ports
+          )
+        )
+    end
+
+    # Scans host(s) according to provided specification
+    def scan synchronus = true, &callback
+      @monitor.start
+      if @threaded
+        case @thread_for
+        when :ip
+          scan_threaded_ip
+        when :port
+          scan_threaded_port
+        end
+
+        if synchronus
+          @pool.shutdown
+          @monitor.stop
+        elsif callback
+          @pool.shutdown(false) do
+            callback.call
+            @monitor
+          end
+        end
+      else
+        synchronus_scan
+      end
+    end
+
+    # Defines a logger (accepts logger as a block)
+    def log &logger
+      Thread.new { logger.call @monitor }
+    end
+
+    # Generates scan result in the specified format
+    def generate_result pretty = false
+      @result = @pool.complete_result if @threaded
+      pretty ? pretty_print(@result) : @result
+    end
+
+    # Generates a report in the specified format from the scan result
+    def report_as format
+      case format
+      when :json
+        JSON.pretty_generate @result
+      when :yml
+        YAML.dump @result
+      else
+        raise ArgumentError, "Unknown format: #{format}"
+      end
+    end
+
+    # Generates a JSON report
+    def json_report
+      report_as :json
+    end
+
+    # Generates a YAML report
+    def yml_report
+      report_as :yml
+    end
+
+    private
+
+    def pretty_print result
+      formatted = "Scan complete!\n\n"
+      result.keys.each do |ip|
+        ports = result[ip].to_s.gsub(/[\[\]]/, "")
+        formatted << "IP: #{ip}\n\tOpen ports: #{ports}\n\n"
+      end
+
+      formatted
+    end
+
+    def scannable_pairs hosts, ports
+      Enumerator.new(hosts.size * ports.size) do |pair|
+        hosts.each do |host|
+          ports.each do |port|
+            pair << [host, port]
+          end
+        end
+      end
+    end
 
+    def threads_to_open thread_for, max, hosts, ports
+      case thread_for
+      when :ip
+        host_count = hosts.size
+        host_count > max ? max : host_count
+      when :port
+        tasks = scannable_pairs(hosts, ports).size
+        tasks > max ? max : tasks
+      end
+    end
+
+    def host_range target
+      type = target.class
+      if [Array, Enumerator].include? type
+        target
+      elsif type == String
+        [target]
+      else
+        []
+      end
+    end
+
+    # :reek:FeatureEnvy
+    def port_range port
+      port = port.dup
+      port = [port] if port.class == Integer
+      @randomize ? port.to_a.shuffle : port
+    end
+
+    def scan_threaded_ip
+      @monitor.threads = @pool.size
+      @pool.result_format do |result, args, value|
+        result = result.dup
+        if value.any?
+          host = args[0]
+          result[host] = value
+        end
+        result
+      end
+
+      @hosts.each do |host|
+        @pool.schedule host do
+          open_ports = []
+          @ports.each do |port|
+            @monitor.update host, port
+            open_ports << port if port_open? host, port
+          end
+          open_ports.sort
+        end
+      end
+    end
+
+    def scan_threaded_port
+      @monitor.threads = @pool.size
+      @pool.result_format do |result, args, value|
+        result = result.dup
+        if value
+          host = args[0][0]
+          ports = result[host]
+          result[host] = ports ? ports.push(value).sort : [value]
+        end
+        result
+      end
+
+      scannable_pairs(@hosts, @ports).each do |pair|
+        @pool.schedule(pair) do
+          @monitor.update(*pair)
+          port_open?(*pair)
+        end
+      end
+    end
+
+    def scan_synchronized_port
+      scannable_pairs(@hosts, @ports).each do |pair|
+        host, port = pair
+        @monitor.update(*pair)
+
+        if port_open?(*pair)
+          ports = @result[host]
+          @result[host] = ports ? ports.push(port).sort : [port]
+        end
+      end
+    end
+
+    def synchronus_scan
+      scan_synchronized_port
+      @monitor.stop
+    end
+
+    def port_open? host, port
+      socket = Socket.new :INET, :STREAM, 0
+      address = Socket.pack_sockaddr_in(port, host)
+
+      begin
+        socket.connect address
+        socket.close
+        port
+      rescue StandardError
+        nil
+      end
+    end
+  end
+end

data/lib/portfinder/version.rb

@@ -0,0 +1,5 @@
+# Portfinder base module
+module Portfinder
+  # Portfinder version specifier
+  VERSION = "0.0.2".freeze
+end

data/portfinder.gemspec

@@ -0,0 +1,46 @@
+# coding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "portfinder/version"
+
+Gem::Specification.new do |s|
+  s.name	= "portfinder"
+  s.version	= Portfinder::VERSION
+  s.authors	= ["Tahmid Shakil"]
+  s.email	= ["at.shakil.92@gmail.com"]
+
+  s.summary	= "A port scanner implementation in pure ruby"
+  s.description = "Portfinder is a ruby based port scanner with features like \
+network/CIDR scanning, port randomization, hostname discovery and banner \
+grabbing."
+  s.homepage = "https://github.com/at-shakil/portfinder"
+  s.license = "MIT"
+
+  s.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  s.require_paths = ["lib"]
+
+  s.bindir = "bin"
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+
+  s.required_ruby_version = [">= 2.2.0"]
+
+  s.extra_rdoc_files = ["README.md"]
+  s.rdoc_options =
+    %w[-t Portfinder -m README.md -N --markup markdown]
+
+  s.add_dependency "slop", "~> 4.4"
+
+  s.add_development_dependency "bundler", "~> 1.15"
+  s.add_development_dependency "rake", "~> 12.0"
+  s.add_development_dependency "minitest", "~> 5.0"
+  s.add_development_dependency "simplecov", "~> 0.13"
+  s.add_development_dependency "appraisal", "~> 2.2"
+
+  if ENV["TRAVIS"]
+    s.add_development_dependency "codeclimate-test-reporter", "~> 1.0.8"
+  end
+end

metadata

@@ -1,37 +1,168 @@
 --- !ruby/object:Gem::Specification
 name: portfinder
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Tahmid Shakil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-02 00:00:00.000000000 Z
-dependencies: []
+date: 2017-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.8
 description: Portfinder is a ruby based port scanner with features like network/CIDR
   scanning, port randomization, hostname discovery and banner grabbing.
-email: at.shakil.92@gmail.com
-executables: []
+email:
+- at.shakil.92@gmail.com
+executables:
+- pf
+- portfinder
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".reek"
+- ".rubocop.yml"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/pf
+- bin/portfinder
+- gemfiles/slop_4.4.0.gemfile
+- gemfiles/slop_4.5.0.gemfile
 - lib/portfinder.rb
+- lib/portfinder/constants.rb
+- lib/portfinder/error.rb
+- lib/portfinder/monitor.rb
+- lib/portfinder/option.rb
+- lib/portfinder/parser.rb
+- lib/portfinder/pool.rb
 - lib/portfinder/scanner.rb
-homepage: https://github.com/atshakil/portfinder
+- lib/portfinder/version.rb
+- portfinder.gemspec
+homepage: https://github.com/at-shakil/portfinder
 licenses:
-- CC-BY-SA-4.0
+- MIT
 metadata: {}
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- "-t"
+- Portfinder
+- "-m"
+- README.md
+- "-N"
+- "--markup"
+- markdown
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -39,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A port scanner implementation in pure ruby