cmsscan 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d3a9f304d468835a4cbb3596bdb4b74eb3b48601bec16a93dec4bdf876c89498
+  data.tar.gz: 6964ca5c7b1c5f954a0f01a3bd8535e0df405ac4c32aef2522b687738d6bbd6f
+SHA512:
+  metadata.gz: e8273ca85b3d286803ec94e3e284091eccaecb529c8ac7800ce268663e24302b566b9c0ffb561a9b55a945e788931e10a551812f02f1d889bfb7eab6845d03a2
+  data.tar.gz: 0a2477a65bfb14e58ab61e4e12de2efb8451aa105b01c3a63a5194df2cd22da69480a8ed9f91dae791cde4474fcc3bcc5facaf8a1d0d11054691e2c440507780

data/app/app.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'controllers/example'

data/app/controllers/example.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module CMSScan
+  module Controller
+    # Example Controller
+    class Example < CMSScanner::Controller::Core
+      # @return [ Array<OptParseValidator::Opt> ]
+      def cli_options
+        [
+          OptString.new(['--dummy VALUE', 'Dummy CLI Option'])
+        ]
+      end
+
+      def before_scan
+        # Anything to do before ?
+      end
+
+      def run
+        # Let's check and display whether or not the word 'scan' is present in the homepage of the target
+
+        is_present = target.homepage_res.body =~ /scan/ ? true : false
+
+        output('scan_word', is_present: is_present)
+      end
+
+      # Alternative way of doing it
+      def run2
+        @is_present = Browser.get(target.homepage_url).body =~ /scan/ ? true : false
+
+        output('scan_word')
+      end
+
+      def after_scan
+        # Anything after ?
+      end
+    end
+  end
+end

data/app/views/cli/core/banner.erb

@@ -0,0 +1,3 @@
+
+CMS Scanner Example <%= CMSScan::VERSION %>
+

data/app/views/cli/example/scan_word.erb

@@ -0,0 +1,5 @@
+<% if @is_present -%>
+<%= warning_icon %> The word 'scan' is present in the homepage
+<% else -%>
+<%= notice_icon %> The word 'scan' was not detected in the homepage
+<% end %>

data/app/views/json/core/banner.erb

@@ -0,0 +1,3 @@
+"banner": {
+  "version": <%= CMSScan::VERSION.to_json %>
+},

data/app/views/json/example/scan_word.erb

@@ -0,0 +1 @@
+"scan_word_present": <%= @is_present.to_json %>,

data/bin/cmsscan

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'cmsscan'
+
+CMSScan::Scan.new do |s|
+  s.controllers << CMSScan::Controller::Example.new
+
+  s.run
+end

data/lib/cmsscan/controller.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CMSScan
+  # Needed to load at least the Core controller
+  # Otherwise, the following error will be raised:
+  # `initialize': uninitialized constant CMSScan::Controller::Core (NameError)
+  module Controller
+    include CMSScanner::Controller
+  end
+end

data/lib/cmsscan/target.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CMSScan
+  # Custom Target Class
+  class Target < CMSScanner::Target
+    # Put your own methods there
+
+    # Method which should be defined.
+    # Used to set a specific exit code if the scan found issues
+    # See the CMSScanner/lib/cms_scanner/exit_code.rb
+    def vulnerable?
+      false
+    end
+  end
+end

data/lib/cmsscan/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CMSScan
+  VERSION = '1.0'
+end

data/lib/cmsscan.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Gems
+require 'cms_scanner'
+require 'yajl/json_gem'
+require 'addressable/uri'
+require 'active_support/all'
+# Standard Lib
+require 'uri'
+require 'time'
+require 'readline'
+require 'securerandom'
+# Custom Libs
+require 'cmsscan/target'
+require 'cmsscan/version'
+require 'cmsscan/controller'
+
+Encoding.default_external = Encoding::UTF_8
+
+# CMSScan
+module CMSScan
+  include CMSScanner
+
+  APP_DIR = Pathname.new(__FILE__).dirname.join('..', 'app').expand_path
+  # Not needed in this example
+  # DB_DIR  = File.join(Dir.home, '.cmsscan', 'db')
+
+  # Override, otherwise it would be returned as 'cms_scan'
+  # doesn't really matter in this example.
+  #
+  # @return [ String ]
+  def self.app_name
+    'cmsscan'
+  end
+end
+
+require "#{CMSScan::APP_DIR}/app"

metadata

@@ -0,0 +1,223 @@
+--- !ruby/object:Gem::Specification
+name: cmsscan
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- WPScanTeam
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cms_scanner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: memory_profiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !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.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: stackprof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.12
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.13.0
+description: CMSScanner Implementation Example
+email:
+- team@wpscan.org
+executables:
+- cmsscan
+extensions: []
+extra_rdoc_files: []
+files:
+- app/app.rb
+- app/controllers/example.rb
+- app/views/cli/core/banner.erb
+- app/views/cli/example/scan_word.erb
+- app/views/json/core/banner.erb
+- app/views/json/example/scan_word.erb
+- bin/cmsscan
+- lib/cmsscan.rb
+- lib/cmsscan/controller.rb
+- lib/cmsscan/target.rb
+- lib/cmsscan/version.rb
+homepage: https://github.com/wpscanteam/CMSScanner
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.22
+signing_key:
+specification_version: 4
+summary: CMSScan Gem Example
+test_files: []