rangescan 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a7560ddf707ab1d55befca7e8cdffd4274618845256d4da74575d99d613c4ab9
+  data.tar.gz: 296098c05eac8e1c7e6294a503aa6b591b2617d2fcdc3f6f4093299e9a174a53
+SHA512:
+  metadata.gz: c8a7d6badbbaa041657f86015462f3049cce8e852073a268caadfcfc76fbfd555b31c69b1380ee4846bc92279ce98cb4758d33612d7a4656bad6ca5e2a1d06f0
+  data.tar.gz: 51537dc5b498beb430a225486b6b2ce259172e485d5bde54ed5400b191f2d909a7cb01bcf4372f1a6af72d8b1dd33e06da605449c53270d69bc60077b8e1748d

data/.gitignore

@@ -0,0 +1,59 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+# RSpec
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7
+before_install: gem install bundler -v 2.1

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in RangeScan.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,94 @@
+PATH
+  remote: .
+  specs:
+    rangescan (0.1.0)
+      http (~> 4.4)
+      ipaddress (~> 0.8)
+      parallel (~> 1.19)
+      thor (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.13.1)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    glint (0.1.0)
+    hashdiff (1.0.1)
+    http (4.4.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    http-parser (1.2.1)
+      ffi-compiler (>= 1.0, < 2.0)
+    ipaddress (0.8.3)
+    json (2.3.0)
+    parallel (1.19.1)
+    public_suffix (4.0.5)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    safe_yaml (1.0.5)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.0.1)
+    tins (1.25.0)
+      sync
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1)
+  coveralls (~> 0.8)
+  glint (~> 0.1)
+  rake (~> 13.0)
+  rangescan!
+  rspec (~> 3.9)
+  webmock (~> 3.8)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Manabu Niseki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# rangescan
+
+[![Build Status](https://travis-ci.com/ninoseki/rangescan.svg?branch=master)](https://travis-ci.com/ninoseki/rangescan)
+[![Coverage Status](https://coveralls.io/repos/github/ninoseki/rangescan/badge.svg?branch=master)](https://coveralls.io/github/ninoseki/rangescan?branch=master)
+[![CodeFactor](https://www.codefactor.io/repository/github/ninoseki/rangescan/badge)](https://www.codefactor.io/repository/github/ninoseki/rangescan)
+
+A CLI tool to scan websites on a specific IP range and filter the results by a regexp.
+
+## Installation
+
+```bash
+gem install rangescan
+```
+
+## Usage
+
+```bash
+$ rangescan
+Commands:
+  rangescan help [COMMAND]                      # Describe available commands or one specific command
+  rangescan scan [IP_WITH_SUBNET_MASK, REGEXP]  # Scan an IP range & filter by a regexp
+
+$ rangescan help scan
+Usage:
+  rangescan scan [IP_WITH_SUBNET_MASK, REGEXP]
+
+Options:
+  [--host=HOST]                      # Host header
+  [--port=N]                         # Port to check (80 or 443)
+  [--scheme=SCHEME]                  # Scheme to use (http or https)
+  [--timeout=N]                      # Timeout in seconds
+  [--user-agent=USER_AGENT]          # User Agent header
+  [--veryfy-ssl], [--no-veryfy-ssl]  # Verify SSL or not
+
+Scan an IP range & filter by a regexp
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "RangeScan"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/rangescan

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require "rangescan"
+
+RangeScan::CLI.start

data/lib/rangescan.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "rangescan/version"
+
+require "rangescan/range"
+require "rangescan/scanner"
+require "rangescan/matcher"
+
+require "rangescan/cli"
+
+module RangeScan
+  class Error < StandardError; end
+end

data/lib/rangescan/cli.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "thor"
+require "json"
+
+module RangeScan
+  class CLI < Thor
+    desc "scan [IP_WITH_SUBNET_MASK, REGEXP]", "Scan an IP range & filter by a regexp"
+    method_option :host, type: :string, desc: "Host header"
+    method_option :port, type: :numeric, desc: "Port"
+    method_option :scheme, type: :string, desc: "Scheme (http or https)"
+    method_option :timeout, type: :numeric, desc: "Timeout in seconds"
+    method_option :user_agent, type: :string, desc: "User Agent"
+    method_option :verify_ssl, type: :boolean, desc: "Whether to verify SSL or not"
+    def scan(ip_with_subnet_mask, regexp)
+      symbolized_options = symbolize_hash_keys(options)
+      range = Range.new(ip_with_subnet_mask)
+
+      scanner = Scanner.new(**symbolized_options)
+      results = scanner.scan(range.to_a)
+
+      matcher = Matcher.new(regexp)
+      filtered = matcher.filter(results)
+
+      puts JSON.pretty_generate(filtered)
+    end
+
+    no_commands do
+      def symbolize_hash_keys(hash)
+        hash.map { |k, v| [k.to_sym, v] }.to_h
+      end
+    end
+  end
+end

data/lib/rangescan/matcher.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RangeScan
+  class Matcher
+    attr_reader :regexp
+
+    def initialize(regexp)
+      @regexp = Regexp.new(regexp)
+    end
+
+    def filter(results)
+      results.select do |result|
+        body = result.dig(:body) || ""
+        body =~ regexp
+      end
+    end
+  end
+end

data/lib/rangescan/range.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "ipaddress"
+
+module RangeScan
+  class Range
+    attr_reader :ip_with_subnet_mask
+
+    def initialize(ip_with_subnet_mask)
+      @ip_with_subnet_mask = IPAddress::IPv4.new(ip_with_subnet_mask)
+    end
+
+    def to_a
+      ip_with_subnet_mask.to_a.map(&:to_s)
+    end
+  end
+end

data/lib/rangescan/scanner.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "http"
+require "parallel"
+
+module RangeScan
+  class Scanner
+    attr_reader :context
+    attr_reader :host
+    attr_reader :port
+    attr_reader :scheme
+    attr_reader :ssl_context
+    attr_reader :timeout
+    attr_reader :user_agent
+
+    def initialize(host: nil, port: nil, scheme: "http", verify_ssl: true, timeout: 5, user_agent: nil)
+      @host = host
+      @port = port || (scheme == "http" ? 80 : 443)
+      @timeout = timeout
+      @scheme = scheme
+      @user_agent = user_agent
+
+      @ssl_context = OpenSSL::SSL::SSLContext.new
+      @ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE unless verify_ssl
+    end
+
+    def scan(ipv4s)
+      Parallel.map(ipv4s) do |ipv4|
+        get ipv4
+      end.compact
+    end
+
+    private
+
+    def default_headers
+      { host: host, user_agent: user_agent }.compact
+    end
+
+    def ssl_options
+      scheme == "http" ? {} : { ssl_context: ssl_context }
+    end
+
+    def get(ipv4)
+      url = "#{scheme}://#{ipv4}:#{port}"
+
+      begin
+        res = HTTP.timeout(timeout).headers(default_headers).get(url, ssl_options)
+        { ipv4: ipv4, code: res.code, body: res.body.to_s }
+      rescue StandardError
+        nil
+      end
+    end
+  end
+end

data/lib/rangescan/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RangeScan
+  VERSION = "0.1.0"
+end

data/rangescan.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/rangescan/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rangescan"
+  spec.version       = RangeScan::VERSION
+  spec.authors       = ["Manabu Niseki"]
+  spec.email         = ["manabu.niseki@gmail.com"]
+
+  spec.summary       = "Scan websites on a specific IP range"
+  spec.description   = "A CLI tool to scan websites on a specific IP range"
+  spec.homepage      = "https://github.com/ninoseki/rangescan"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "coveralls", "~> 0.8"
+  spec.add_development_dependency "glint", "~> 0.1"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.9"
+  spec.add_development_dependency "webmock", "~> 3.8"
+
+  spec.add_dependency "http", "~> 4.4"
+  spec.add_dependency "ipaddress", "~> 0.8"
+  spec.add_dependency "parallel", "~> 1.19"
+  spec.add_dependency "thor", "~> 1.0"
+end

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: rangescan
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Manabu Niseki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: glint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: http
+  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: ipaddress
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.19'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A CLI tool to scan websites on a specific IP range
+email:
+- manabu.niseki@gmail.com
+executables:
+- rangescan
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/rangescan
+- lib/rangescan.rb
+- lib/rangescan/cli.rb
+- lib/rangescan/matcher.rb
+- lib/rangescan/range.rb
+- lib/rangescan/scanner.rb
+- lib/rangescan/version.rb
+- rangescan.gemspec
+homepage: https://github.com/ninoseki/rangescan
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ninoseki/rangescan
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Scan websites on a specific IP range
+test_files: []