moby.rb 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a52161eceecdfce20494ae2ff6b8e8fa8aefceb1d6911db3c2fd3bac475896f
-  data.tar.gz: 6242e8451d3d66b70b9452dc305329c121e97a8e1d868cb6744228208d2e8da6
+  metadata.gz: 6f4bd8e1d75dd3b141595bf678fb267890c5554a26999b147485bda0eaac40f7
+  data.tar.gz: c49e5c7240d47a06656b91c1108dacdd1016248d86d1b5eb4843beecb092fa33
 SHA512:
-  metadata.gz: 40ccfc56a276bb2c2ef6ad12e903dd2791f5be79f857ad4f6718c846b848ddee3ee62974f0a60e7a56e2cd8560f6761ccd53a5aecad3919fb6b4e9bc0274d752
-  data.tar.gz: dd7eba42a50b08e714407079b8191348f8f18d0ee389881dfce367af78d185c6b0a16570fa484d57362df8a23ec1278986ebb970c3815db897432e11b51b3f7f
+  metadata.gz: '029f6229354cdc1746db60befce2a266092c647dbd861c72871ad04b0abda2f46aa7568465a21b5c75543442456d03fd9979cce96a433fbc2a6ffe3898444fe7'
+  data.tar.gz: 8329d384ab5ff2ce15563cd07ddcda4ddecc97458558ecac9a3199607cb7dfdc240e56646cbaf479ee6bba9dda049da15abf0fbb24bd0adb7088da33fc8425a9

data/CHANGELOG

@@ -1,5 +1,26 @@
 # CHANGELOG
 
+## 20260811
+
+2.0.0: Move the Mechanize engine into a pluggable backend and add a Selenium backend alongside it.
+
+1. ~ lib/Moby.rb: the monolithic Moby was the whole Mechanize engine; it becomes a thin facade that builds a Configuration, a RandomInputGenerator and the chosen backend, and delegates #counter_phish to it. The submission loop, the page, form and field finding, and the random credential generation all move out into the classes below.
+2. + lib/Moby/Backends/MechanizeBackend.rb: the Mechanize functionality, moved out of Moby and behind a backend interface, driven by Configuration and RandomInputGenerator.
+3. + lib/Moby/Backends/SeleniumBackend.rb: a second backend driving a real headless browser (Chrome or Firefox), for forms that filter non-browser clients so the Mechanize submissions never land.
+4. + lib/Moby/Backends.rb: Moby::Backends.for, which chooses the backend from the configuration: :mechanize (the default) or :selenium.
+5. + lib/Moby/Configuration.rb: Moby::Configuration, a settings object for a run (url, backend, browser, form and field identification, username generation, iterations, delay, word list).
+6. + lib/Moby/RandomInputGenerator.rb: Moby::RandomInputGenerator, the fake-credential generation (random username and password, optionally email-shaped), moved out of Moby.
+7. + lib/Selenium/ and lib/Thoran/Selenium/: Selenium::WebDriver::Driver#attempt (retry a block) and #element_present?, used by the Selenium backend.
+8. ~ bin/moby: builds a Configuration and runs the selected backend through the facade; + --backend, + --browser, + --iterations (moby runs until interrupted when it is omitted), + --delay; and the previously inert --username-prefilled is wired through, so only the password is submitted when the username is already on the form.
+9. - lib/File/self.collect.rb, - lib/Thoran/File/SelfCollect/self.collect.rb: File.collect was used only by the old Moby; RandomInputGenerator reads the word list with File.readlines.
+10. ~ test/moby_test.rb: it exercised the removed Moby monolith; rewritten to test the Moby facade (backend selection). + test/Moby/Configuration_test.rb, RandomInputGenerator_test.rb, Backends_test.rb, Backends/MechanizeBackend_test.rb and Backends/SeleniumBackend_test.rb.
+11. ~ moby.rb.gemspec: + selenium-webdriver (~> 4).
+12. ~ moby.rb.gemspec: required_ruby_version: /2.5.0/3.3.0/, which selenium-webdriver 4 requires.
+13. ~ Gemfile: + ostruct, which switches.rb requires and which is no longer a default gem as of Ruby 4.0.
+14. ~ lib/Moby/VERSION.rb: VERSION: /1.0.1/2.0.0/
+15. ~ test/Moby/VERSION_test.rb: /1.0.1/2.0.0/
+
+
 ## 20260807
 
 1.0.1: Add a CHANGELOG in the form changelogger writes, and retire CHANGES.txt.
@@ -9,6 +30,7 @@
 3. ~ lib/Moby/VERSION.rb: VERSION: /1.0.0/1.0.1/
 4. ~ test/Moby/VERSION_test.rb: /1.0.0/1.0.1/
 
+
 ## 20260108
 
 1.0.0: Ensure that tests are in place and that version handling is working properly.
@@ -23,6 +45,7 @@
 8. ~ CHANGES.txt: Reorganised in descending order and added dates.
 9. ~ LICENSE.txt: Updated the years to include the year this was started: /2026/2006-2026/
 
+
 ## 20260105
 
 0.9.1: Fix syntax errors in README.md.
@@ -30,10 +53,12 @@
 1. ~ README.md: Fix syntax errors.
 2. ~ lib/Moby.rb: VERSION_STRING: /0.9.0/0.9.1/
 
+
 ## 20240605
 
 0.9.0: Merge of 2019's 0.8.0 and 2023's 0.8.1.
 
+
 ## 20231206
 
 0.8.1: Fix when username or password field number is specified or nothing is specified.
@@ -41,6 +66,7 @@
 1. ~ lib/Whale: ~ set_username_field(): Fix when username field number is specified or nothing is specified.
 2. ~ lib/Whale: ~ set_password_field(): Fix when password field number is specified or nothing is specified.
 
+
 ## 20231119
 
 0.8.0: An accidental fork of 0.7.0 in 2023.
@@ -54,18 +80,21 @@
 7. ~ lib/Whale.rb: general tidying
 8. + lib/File/self.collect.rb
 
+
 ## 20190820
 
 0.7.4: Rescue Net::OpenTimeout in the submission loop.
 
 1. ~ counter_phish(): + rescue Net::OpenTimeout.
 
+
 ## 20190819
 
 0.7.3: Rescue Net::HTTP::Persistent::Error in place of EOFError.
 
 1. ~ counter_phish(): rescue Net::HTTP::Persistent::Error in place of EOFError.
 
+
 ## 20190819
 
 0.7.2: Set field values on the field objects rather than through the setter methods.
@@ -75,6 +104,7 @@
 3. ~ user_agent: attr_writer in place of attr_accessor.
 4. ~ counter_phish(): verbose reports username_field.value:password_field.value.
 
+
 ## 20190819
 
 0.7.1: Assign to the field's value rather than replacing the field object.
@@ -82,6 +112,7 @@
 1. ~ set_username_field()/set_password_field(): set the field's value in place of replacing the field object at form.fields[n].
 2. ~ counter_phish(): + rescue EOFError; + pp page in debug.
 
+
 ## 20190815
 
 0.7.0: The earliest recoverable version.

data/Gemfile

@@ -1,3 +1,7 @@
 source 'https://rubygems.org'
 
 gemspec
+
+# switches.rb (the CLI option parser) requires ostruct, which is no longer a
+# default gem as of Ruby 4.0, so it must be provided explicitly under bundler.
+gem 'ostruct'

data/bin/moby

@@ -11,12 +11,16 @@ require 'switches.rb'
 
 def switches
   Switches.new do |s|
-    s.banner = 'Usage: whale <url> and any of the following options...'
+    s.banner = 'Usage: moby <url> and any of the following options...'
     s.set(:a, :user_agent){'What webclient I should pretend to be.'}
+    s.set(:b, :backend){'Which backend to use: mechanize (default) or selenium.'}
+    s.set(:browser){'Which browser the selenium backend should drive: chrome (default) or firefox.'}
     s.set(:debug?){'Show debugging information.'}
+    s.set(:delay){'Seconds to wait between submissions.'}
     s.set(:e?, :username_is_email_address?){'Automatically generate a username which is in the form of an email address.'}
     s.set(:f, :form, :form_name){'If left empty, the first form on the page will be used.'}
-    s.set(:help){'Usage: whale <url> and any of the following options...'}
+    s.set(:help){'Usage: moby <url> and any of the following options...'}
+    s.set(:iterations){'How many submissions to make.  If left empty, moby runs until interrupted.'}
     s.set(:n, :form_number){'This will set the number of the form in order of appearance on the page.  Use zero-based indexing.'}
     s.set(:pass_field, :password_field, :pass_field_name, :password_field_name){'The name of the password field.'}
     s.set(:pass_field_number, :password_field_number){'The position of the password field in relation to the form it is attached to.  Use zero-based indexing.'}
@@ -24,7 +28,7 @@ def switches
     s.set(:user_field, :username_field, :user_field_name, :username_field_name){'The name of the username field.'}
     s.set(:user_field_number, :username_field_number){'The position of the username field in relation to the form it is attached to.  Use zero-based indexing.'}
     s.set(:username_hostname){'The hostname to be used when the username is an email address.'}
-    s.set(:username_prefilled){'No need to supply an email address in the form.'}
+    s.set(:username_prefilled?){'The username is already filled in on the form, so only submit the password.'}
     s.set(:v?, :verbose?){'Outputs each submission as it goes.'}
     s.perform(:version) do
      puts "moby #{Moby::VERSION}"
@@ -35,31 +39,24 @@ end
 
 def main
   args = switches.to_h
-  debug = args[:debug?]
-  form_name = args[:form_name]
-  form_number = args[:form_number]
-  password_field_name = args[:password_field_name]
-  password_field_number = args[:password_field_number]
-  url = args[:url]
-  user_agent = args[:user_agent]
-  username_field_name = args[:username_field_name]
-  username_field_number = args[:username_field_number]
-  username_hostname = args[:username_hostname]
-  username_is_email_address = args[:username_is_email_address?]
-  verbose = args[:verbose?]
   moby = Moby.new(
-    debug: debug,
-    form_name: form_name,
-    form_number: form_number,
-    password_field_name: password_field_name,
-    password_field_number: password_field_number,
-    url: url,
-    user_agent: user_agent,
-    username_field_name: username_field_name,
-    username_field_number: username_field_number,
-    username_hostname: username_hostname,
-    username_is_email_address: username_is_email_address,
-    verbose: verbose
+    backend: args[:backend],
+    browser: args[:browser],
+    debug: args[:debug?],
+    delay: args[:delay],
+    form_name: args[:form_name],
+    form_number: args[:form_number],
+    iterations: args[:iterations],
+    password_field_name: args[:password_field_name],
+    password_field_number: args[:password_field_number],
+    url: args[:url],
+    user_agent: args[:user_agent],
+    username_field_name: args[:username_field_name],
+    username_field_number: args[:username_field_number],
+    username_hostname: args[:username_hostname],
+    username_is_email_address: args[:username_is_email_address?],
+    username_prefilled: args[:username_prefilled?],
+    verbose: args[:verbose?]
   )
   moby.counter_phish
 end

data/lib/Moby/Backends/MechanizeBackend.rb

@@ -0,0 +1,157 @@
+# lib/moby/backends/mechanize_backend.rb
+# Moby::Backends::MechanizeBackend
+
+require 'mechanize'
+require 'pp'
+
+class Moby
+  module Backends
+    class MechanizeBackend
+      def counter_phish
+        set_up_agent
+        load_page
+        repeatedly_fill_and_submit_login_form
+      end
+
+      private
+
+      def initialize(config:, random_input_generator:)
+        @config = config
+        @random_input_generator = random_input_generator
+      end
+
+      def agent
+        @agent ||= (
+          puts "Setting up Mechanize agent..." if @config.verbose?
+          agent = Mechanize.new
+          puts "Agent setup complete." if @config.verbose?
+          agent
+        )
+      end
+      alias_method :set_up_agent, :agent
+
+      def page
+        @page ||= (
+          puts "Navigating to #{@config.url}..." if @config.verbose?
+          page = agent.get(@config.url)
+          puts "Page loaded successfully." if @config.verbose?
+          page
+        )
+      end
+      alias_method :load_page, :page
+
+      def form
+        @form ||= (
+          if @config.using_form_name?
+            find_form_by_name
+          else
+            find_form_by_number
+          end
+        )
+      end
+
+      def repeatedly_fill_and_submit_login_form
+        start_time = Time.now
+        puts "moby session begun #{start_time}."
+        submission_count = 0
+        begin
+          if @config.fixed_number_of_submissions?
+            @config.iterations.times do |iteration|
+              fill_and_submit_login_form
+              submission_count += 1
+              puts "Iteration #{submission_count} of #{@config.iterations}." if @config.verbose?
+            end
+            puts "Successfully completed #{@config.iterations} submissions." if @config.verbose?
+          else
+            loop do
+              fill_and_submit_login_form
+              submission_count += 1
+              puts "#{submission_count} #{username}:#{password}" if @config.verbose?
+            end
+          end
+        ensure
+          finish_time = Time.now
+          time_delta_in_minutes = (finish_time - start_time) / 60
+          submissions_per_minute = submission_count / time_delta_in_minutes
+          puts "moby session terminated #{finish_time} with #{submission_count} counter-phishes served in #{time_delta_in_minutes} minutes for an average of #{submissions_per_minute} submissions per minute."
+        end
+      end
+
+      def fill_and_submit_login_form
+        puts "Filling with: #{username}:#{password}" if @config.verbose?
+        agent.user_agent_alias = @config.user_agent
+        username_field.value = username unless @config.username_prefilled?
+        password_field.value = password
+        pp page if @config.debug?
+        result = agent.submit(form)
+        pp result if @config.debug?
+        sleep @config.delay if @config.delay > 0
+      rescue Net::HTTP::Persistent::Error
+        puts "\n\nNet::HTTP::Persistent::Error rescued.\n\n" if @config.verbose?
+      rescue Net::OpenTimeout
+        puts "\n\nNet::OpenTimeout rescued.\n\n" if @config.verbose?
+      end
+
+      def find_form_by_name
+        page.form_with(name: @config.form_name) ||
+          page.form_with(id: @config.form_name) ||
+          raise("Could not find a form with the name or id of #{@config.form_name}.")
+      end
+
+      def find_form_by_number
+        page.forms[@config.form_number] ||
+          raise("Could not find a form at index #{@config.form_number}.")
+      end
+
+      def username
+        @random_input_generator.random_username
+      end
+
+      def password
+        @random_input_generator.random_password
+      end
+
+      def username_field
+        @username_field ||=(
+          if @config.using_username_field_name?
+            find_username_field_by_name
+          else
+            find_username_field_by_number
+          end
+        )
+      end
+
+      def password_field
+        @password_field ||= (
+          if @config.using_password_field_name?
+            find_password_field_by_name
+          else
+            find_password_field_by_number
+          end
+        )
+      end
+
+      def find_username_field_by_name
+        form.field_with(name: @config.username_field_name) ||
+          form.field_with(id: @config.username_field_name) ||
+          raise("Could not find username field: #{@config.username_field_name}")
+      end
+
+      def find_username_field_by_number
+        form.fields[@config.username_field_number] ||
+          raise("Could not find username field at index #{@config.username_field_number}")
+      end
+
+      def find_password_field_by_name
+        form.field_with(name: @config.password_field_name) ||
+          form.field_with(id: @config.password_field_name) ||
+          raise("Could not find password field: #{@config.password_field_name}.")
+      end
+
+      def find_password_field_by_number
+        form.fields[@config.password_field_number] ||
+          raise("Could not find password field at index: #{@config.password_field_number}.")
+      end
+    end
+  end
+end

data/lib/Moby/Backends/SeleniumBackend.rb

@@ -0,0 +1,242 @@
+# lib/Moby/Backends/SeleniumBackend.rb
+# Moby::Backends::SeleniumBackend
+
+require 'selenium-webdriver'
+
+require_relative '../../Selenium/WebDriver/Driver/Attempt/attempt'
+require_relative '../../Selenium/WebDriver/SearchContext/ElementPresentQ/element_presentQ'
+
+class Moby
+  module Backends
+    class SeleniumBackend
+      def counter_phish
+        set_up_driver
+        navigate_to_target
+        repeatedly_fill_and_submit_login_form
+      ensure
+        cleanup_driver unless @config.debug?
+      end
+
+      private
+
+      def initialize(config:, random_input_generator:)
+        @config = config
+        @random_input_generator = random_input_generator
+        @driver = nil
+      end
+
+      def driver
+        @driver ||= (
+          puts "Setting up #{@config.browser} driver..." if @config.verbose
+          driver =
+            case @config.browser.to_sym
+            when :chrome
+              options = Selenium::WebDriver::Chrome::Options.new
+              options.add_argument('--headless') unless @config.debug
+              options.add_argument('--disable-gpu')
+              options.add_argument('--no-sandbox')
+              options.add_argument("user-agent=#{@config.user_agent}") if @config.user_agent
+              Selenium::WebDriver.for(:chrome, options: options)
+            when :firefox
+              options = Selenium::WebDriver::Firefox::Options.new
+              options.add_argument('--headless') unless @config.debug
+              options.add_preference('general.useragent.override', @config.user_agent) if @config.user_agent
+              Selenium::WebDriver.for(:firefox, options: options)
+            else
+              Selenium::WebDriver.for(@config.browser)
+            end
+          puts "Driver setup complete." if @config.verbose?
+          driver
+        )
+      end
+      alias_method :set_up_driver, :driver
+
+      def navigate_to_target
+        puts "Navigating to #{@config.url}..." if @config.verbose?
+        @driver.attempt do
+          @driver.get(@config.url)
+          wait_for_page_load
+        end
+        puts "Page loaded successfully." if @config.verbose?
+      end
+
+      def wait_for_page_load
+        wait = Selenium::WebDriver::Wait.new(timeout: 10)
+        wait.until do
+          @driver.execute_script('return document.readyState') == 'complete'
+        end
+      end
+
+      def form
+        @form ||= (
+          if @config.using_form_name?
+            find_form_by_name
+          else
+            find_form_by_number
+          end
+        )
+      end
+
+      def repeatedly_fill_and_submit_login_form
+        start_time = Time.now
+        puts "moby session begun #{start_time}."
+        submission_count = 0
+        begin
+          if @config.fixed_number_of_submissions?
+            @config.iterations.times do |iteration|
+              fill_and_submit_login_form
+              submission_count += 1
+              puts "Submission #{submission_count} of #{@config.iterations}." if @config.verbose?
+            end
+            puts "Successfully completed #{@config.iterations} submissions." if @config.verbose?
+          else
+            loop do
+              fill_and_submit_login_form
+              submission_count += 1
+              puts "#{submission_count} #{username}:#{password}" if @config.verbose?
+            end
+          end
+        ensure
+          finish_time = Time.now
+          time_delta_in_minutes = (finish_time - start_time) / 60
+          submissions_per_minute = submission_count / time_delta_in_minutes
+          puts "moby session terminated #{finish_time} with #{submission_count} counter-phishes served in #{time_delta_in_minutes} minutes for an average of #{submissions_per_minute} submissions per minute."
+        end
+      end
+
+      def fill_and_submit_login_form
+        puts "Filling with: #{username}:#{password}" if @config.verbose?
+        driver.navigate.to(@config.url)
+        wait_for_page_load
+        driver.attempt do
+          unless @config.username_prefilled?
+            username_field.clear
+            username_field.send_keys(username)
+          end
+          password_field.clear
+          password_field.send_keys(password)
+          submit_form(form)
+        end
+        sleep @config.delay if @config.delay > 0
+      end
+
+      def find_form_by_name
+        name = @config.form_name
+        selectors = [
+          [:name, name],
+          [:id, name],
+          [:css, "form[name='#{name}']"],
+          [:css, "form##{name}"]
+        ]
+        selectors.each do |type, selector|
+          if @driver.element_present?(type, selector)
+            return @driver.find_element(type, selector)
+          end
+        end
+        raise("Could not find a form with the name or id of #{@config.form_name}.")
+      end
+
+      def find_form_by_number
+        index = @config.form_number
+        forms = @driver.find_elements(:tag_name, 'form')
+        return forms[index] if forms[index]
+        raise("Could not find a form at index #{@config.form_number}.")
+      end
+
+      def username
+        @random_input_generator.random_username
+      end
+
+      def password
+        @random_input_generator.random_password
+      end
+
+      def username_field
+        @username_field ||= (
+          if @config.using_username_field_name?
+            find_username_field_by_name
+          else
+            find_username_field_by_number
+          end
+        )
+      end
+
+      def password_field
+        @password_field ||= (
+          if @config.using_password_field_name?
+            find_password_field_by_name
+          else
+            find_password_field_by_number
+          end
+        )
+      end
+
+      def find_username_field_by_name
+        name = @config.username_field_name
+        selectors = [
+          [:name, name],
+          [:id, name],
+          [:css, "input[name='#{name}']"],
+          [:css, "input##{name}"]
+        ]
+        selectors.each do |type, selector|
+          begin
+            element = form.find_element(type, selector)
+            return element if element
+          rescue Selenium::WebDriver::Error::NoSuchElementError
+            next
+          end
+        end
+        raise("Could not find username field: #{@config.username_field_name}")
+      end
+
+      def find_username_field_by_number
+        index = @config.username_field_number
+        inputs = form.find_elements(:tag_name, 'input')
+        inputs[index] ||
+          raise("Could not find username field at index #{index}")
+      end
+
+      def find_password_field_by_name
+        name = @config.password_field_name
+        selectors = [
+          [:name, name],
+          [:id, name],
+          [:css, "input[name='#{name}']"],
+          [:css, "input##{name}"]
+        ]
+        selectors.each do |type, selector|
+          begin
+            element = form.find_element(type, selector)
+            return element if element
+          rescue Selenium::WebDriver::Error::NoSuchElementError
+            next
+          end
+        end
+        raise("Could not find password field: #{@config.password_field_name}")
+      end
+
+      def find_password_field_by_number
+        index = @config.password_field_number
+        inputs = form.find_elements(:tag_name, 'input')
+        inputs[index] ||
+          raise("Could not find password field at index #{index}")
+      end
+
+      def submit_form(form)
+        begin
+          submit_button = form.find_element(:css, "input[type='submit'], button[type='submit'], button")
+          submit_button.click
+        rescue
+          form.submit
+        end
+        sleep 0.5
+      end
+
+      def cleanup_driver
+        @driver.quit if @driver
+        puts "Driver closed." if @config.verbose?
+      end
+    end
+  end
+end

data/lib/Moby/Backends.rb

@@ -0,0 +1,20 @@
+# lib/Moby/Backends.rb
+# Moby::Backends
+
+require_relative './Backends/MechanizeBackend'
+require_relative './Backends/SeleniumBackend'
+
+class Moby
+  module Backends
+    def self.for(config:, random_input_generator:)
+      case config.backend
+      when :mechanize
+        MechanizeBackend.new(config: config, random_input_generator: random_input_generator)
+      when :selenium
+        SeleniumBackend.new(config: config, random_input_generator: random_input_generator)
+      else
+        raise "Unknown backend: #{config.backend.inspect}."
+      end
+    end
+  end
+end