simple_whatweb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b26c444e4ee7222cbb6eaa591cf2d42a5d660b925b3b2d799748dd35df772415
+  data.tar.gz: 2820aeabc58670b9366ec682418d526f9c55b4612a926e0462869da8e5057d3b
+SHA512:
+  metadata.gz: cceb40628b9e2523303ec38d96ca21306e19dfdddc94a8ae8f64650c4fca7a3e2826e2c7255ad3c1a4e02611dcbbc25f8064d404bc91ef4c1f0ca3c419668337
+  data.tar.gz: 8801947ff6d7582629b1db2d049b8c1a75d350e5e7c3419bed534fb7a5caf565469c6f936d27dbd82a8991b85e1edaf858f3a945094ff6c0c8be5bb3553f5d10

data/.gitignore

@@ -0,0 +1,55 @@
+*.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
+
+## 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
+
+# rspec failure tracking
+.rspec_status
+
+.idea/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4
+  - 2.5
+before_install: gem install bundler -v 1.16.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in SimpleWhatWeb.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 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,126 @@
+# SimpleWhatWeb
+
+[![Build Status](https://travis-ci.org/ninoseki/SimpleWhatWeb.svg?branch=master)](https://travis-ci.org/ninoseki/SimpleWhatWeb)
+[![Maintainability](https://api.codeclimate.com/v1/badges/26ff02f43736a31695d1/maintainability)](https://codeclimate.com/github/ninoseki/SimpleWhatWeb/maintainability)
+[![Coverage Status](https://coveralls.io/repos/github/ninoseki/SimpleWhatWeb/badge.svg?branch=master)](https://coveralls.io/github/ninoseki/SimpleWhatWeb?branch=master)
+
+It's a simplified & gemified version of [WhatWeb](https://github.com/urbanadventurer/WhatWeb).
+
+## Motivations
+
+WhatWeb is a great tool, but there are some points could be improved IMHO.
+
+- (A little bit) messy codebase.
+- Lack of some testing.
+- Not gemified.
+
+So I created this.
+
+## Installation
+
+```ruby
+gem 'simple_whatweb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_whatweb
+
+## Usage
+
+### As a CLI
+
+```
+Usage:
+  whatweb scan URL
+
+Options:
+  [--aggressive], [--no-aggressive]
+  [--default], [--no-default]
+
+Scan against a given URL
+```
+
+**Example**
+
+```bash
+whatweb scan http://localhost:8000 | jq .
+```
+
+```json
+{
+  "HTTPServer": [
+    {
+      "name": "server string",
+      "string": "WEBrick/1.4.2 (Ruby/2.5.1/2018-03-29)",
+      "certainty": 100
+    }
+  ],
+  "Ruby": [
+    {
+      "regexp": [
+        "Ruby"
+      ],
+      "search": "headers[server]",
+      "certainty": 100
+    },
+    {
+      "regexp": [
+        "WEBrick"
+      ],
+      "search": "headers[server]",
+      "certainty": 100
+    }
+  ],
+  "Title": [
+    {
+      "name": "page title",
+      "string": "Index of /",
+      "certainty": 100
+    }
+  ]
+}
+```
+
+### As a library
+
+```ruby
+require "whatweb"
+require "pp"
+
+# create a scan target
+target = WhatWeb::Target.new("http://localhost:8000")
+# loads plugins
+plugins = WhatWeb::PluginManager.load_plugins
+
+results = {}
+plugins.each do |name, plugin|
+  # execute a plugin against the target
+  result = plugin.execute(target)
+  results[name] = result unless result.empty?
+end
+
+pp results
+# {"HTTPServer"=>
+#   [{:name=>"server string",
+#     :string=>"WEBrick/1.4.2 (Ruby/2.5.1/2018-03-29)",
+#     :certainty=>100}],
+#  "Ruby"=>
+#   [{:regexp=>["Ruby"], :search=>"headers[server]", :certainty=>100},
+#    {:regexp=>["WEBrick"], :search=>"headers[server]", :certainty=>100}],
+#  "Title"=>[{:name=>"page title", :string=>"Index of /", :certainty=>100}]}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/SimpleWhatWeb.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "whatweb/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_whatweb"
+  spec.version       = WhatWeb::VERSION
+  spec.authors       = ["Manabu Niseki"]
+  spec.email         = ["manabu.niseki@gmail.com"]
+
+  spec.summary       = 'Simplified ver. of WhatWeb.'
+  spec.description   = 'Simplified ver. of WhatWeb.'
+  spec.homepage      = "https://github.com/ninoseki/SimpleWhatWeb"
+  spec.license       = "MIT"
+
+  # 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", "~> 1.16"
+  spec.add_development_dependency "coveralls", "~> 0.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "vcr", "~> 4.0"
+  spec.add_development_dependency "webmock", "~> 3.4"
+
+  spec.add_dependency "http", "~> 3.3"
+  spec.add_dependency "require_all", "~> 2.0"
+  spec.add_dependency "sanitize", "~> 4.6"
+  spec.add_dependency "thor", "~> 0.19"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "whatweb"
+
+# 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/whatweb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "whatweb"
+
+WhatWeb::CLI.start

data/lib/whatweb.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "http"
+
+require "whatweb/version"
+require "whatweb/errors"
+
+require "whatweb/helper"
+using WhatWeb::Helper
+
+require "whatweb/target"
+require "whatweb/matcher"
+require "whatweb/plugin"
+require "whatweb/cli"
+
+module WhatWeb; end

data/lib/whatweb/cli.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "json"
+require "thor"
+
+module WhatWeb
+  class CLI < Thor
+    desc "scan URL", "Scan against a given URL"
+    method_options aggressive: :boolean, default: false
+    def scan(url)
+      is_aggressive = options[:aggressive]
+      with_error_handling do
+        hash = execute_plugins(url, is_aggressive)
+        puts hash.to_json
+      end
+    end
+
+    no_commands do
+      def execute_plugins(url, is_aggressive = false)
+        plugins = PluginManager.instance.load_plugins
+        target = Target.new(url)
+
+        results = {}
+        plugins.each do |name, plugin|
+          result = plugin.execute(target, is_aggressive)
+          results[name] = result unless result.empty?
+        end
+        results
+      end
+
+      def with_error_handling
+        yield
+      rescue StandardError => e
+        puts "Warning: #{e}"
+      end
+    end
+  end
+end

data/lib/whatweb/errors.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module WhatWeb
+  class NoHeaderError < StandardError; end
+end

data/lib/whatweb/helper.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+require "digest/md5"
+require "sanitize"
+
+module WhatWeb
+  module Helper
+    refine HTTP::Response do
+      def md5sum
+        Digest::MD5.hexdigest(body.to_s)
+      end
+
+      def sanitized_body
+        Sanitize.document(body.to_s, elements: ["html"])
+      end
+
+      def tag_pattern
+        # remove stuff between script and /script
+        # don't bother with  !--, --> or noscript and /noscript
+        inscript = false;
+
+        body.to_s.scan(/<([^\s>]*)/).flatten.map do |x|
+          x.downcase!
+          r = nil
+          r = x if inscript == false
+          inscript = true if x == "script"
+          (inscript = false; r = x) if x == "/script"
+          r
+        end.compact.join(",")
+      end
+    end
+  end
+end

data/lib/whatweb/matcher.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "matcher/base"
+
+require_relative "matcher/common"
+require_relative "matcher/ghdb"
+require_relative "matcher/md5"
+require_relative "matcher/status"
+require_relative "matcher/tag_pattern"
+require_relative "matcher/text"
+require_relative "matcher/url"
+require_relative "matcher/version"
+

data/lib/whatweb/matcher/base.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module WhatWeb
+  module Matcher
+    class Base
+      attr_reader :target, :match
+      def initialize(target, match)
+        @target = target
+        @match = match
+      end
+
+      def match?
+        compiled_regexp.match? search_context
+      rescue NoHeaderError => _
+        false
+      end
+
+      def search_context
+        search = match[:search]
+        context = target.body
+        case search
+        when "all"
+          context = target.raw_response
+        when "header"
+          context = target.raw_headers
+        when /headers\[(.*)\]/
+          k = $1.downcase
+          header = target.headers[k]
+          raise NoHeaderError, "There is no #{k} header in the response" unless header
+          context = header
+        end
+        context.to_s
+      end
+
+      def compiled_regexp
+        raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+      end
+
+      def self.match?(target, match)
+        new(target, match).match?
+      end
+    end
+  end
+end