moby.rb 1.0.1 → 2.0.0

data/lib/Moby/Configuration.rb

@@ -0,0 +1,119 @@
+# lib/Moby/Configuration.rb
+# Moby::Configuration
+
+require 'mechanize'
+
+class Moby
+  class Configuration
+    AVAILABLE_USER_AGENTS = (Mechanize::AGENT_ALIASES.keys - ['Mechanize']).freeze
+
+    attr_accessor(
+      :url,
+      :backend,
+      :browser,
+      :debug,
+      :verbose,
+      :form_name,
+      :form_number,
+      :username_field_name,
+      :username_field_number,
+      :password_field_name,
+      :password_field_number,
+      :username_hostname,
+      :username_is_email_address,
+      :username_prefilled,
+      :iterations,
+      :delay,
+      :word_list_path
+    )
+
+    attr_writer(
+      :user_agent,
+    )
+
+    def user_agent
+      @user_agent || random_user_agent
+    end
+
+    def using_form_name?
+      !@form_name.nil?
+    end
+
+    def using_username_field_name?
+      !@username_field_name.nil?
+    end
+
+    def using_password_field_name?
+      !@password_field_name.nil?
+    end
+
+    def mechanize?
+      @backend == :mechanize
+    end
+
+    def selenium?
+      @backend == :selenium
+    end
+
+    def username_is_email_address?
+      @username_is_email_address || @username_hostname || @username_field_name == 'email'
+    end
+
+    def username_prefilled?
+      @username_prefilled
+    end
+
+    def debug?
+      @debug
+    end
+
+    def verbose?
+      @verbose
+    end
+
+    def fixed_number_of_submissions?
+      !!@iterations
+    end
+
+    private
+
+    # @param url [String] The target URL
+    # @param backend [Symbol] :mechanize or :selenium (default: :mechanize)
+    # @param browser [Symbol] :chrome or :firefox (default: :chrome)
+
+    def initialize(url:, backend: :mechanize, browser: :chrome, **args)
+      @url = url
+      @backend = (backend || :mechanize).to_sym
+
+      # Browser configuration (for Selenium)
+      @browser = (browser || :chrome).to_sym
+      @user_agent = args[:user_agent]
+
+      # Form identification
+      @form_name = args[:form_name]
+      @form_number = (args[:form_number] || 0).to_i
+
+      # Field identification
+      @username_field_name = args[:username_field_name] || 'username'
+      @username_field_number = (args[:username_field_number] || 0).to_i
+      @password_field_name = args[:password_field_name] || 'password'
+      @password_field_number = (args[:password_field_number] || 1).to_i
+
+      # Username configuration
+      @username_hostname = args[:username_hostname]
+      @username_is_email_address = args[:username_is_email_address] || false
+      @username_prefilled = args[:username_prefilled] || false
+
+      # Runtime configuration
+      @debug = args[:debug] || false
+      @verbose = args[:verbose] || false
+      @iterations = args[:iterations] && args[:iterations].to_i
+      @delay = (args[:delay] || 0).to_i
+      @word_list_path = args[:word_list_path] || '/usr/share/dict/words'
+    end
+
+    def random_user_agent
+      AVAILABLE_USER_AGENTS.sample
+    end
+  end
+end

data/lib/Moby/RandomInputGenerator.rb

@@ -0,0 +1,49 @@
+# lib/Moby/RandomInputGenerator.rb
+# Moby::RandomInputGenerator
+
+class Moby
+  class RandomInputGenerator
+    TLD = %w{com net org edu int mil gov arpa biz aero name coop info pro museum}
+
+    def random_username
+      if username_is_email_address?
+        if @username_hostname
+          "#{random_word}@#{@username_hostname}"
+        else
+          "#{random_word}@#{random_word}.#{random_TLD}"
+        end
+      else
+        random_word
+      end
+    end
+
+    def random_password
+      random_word
+    end
+
+    private
+
+    def initialize(word_list_path:, username_hostname: nil, username_is_email_address: false)
+      @word_list_path = word_list_path
+      @username_hostname = username_hostname
+      @username_is_email_address = username_is_email_address
+    end
+
+    def random_word
+      words.sample
+    end
+
+    def words
+      @words ||= File.readlines(@word_list_path).map(&:chomp).reject(&:empty?)
+    end
+    alias_method :load_words, :words
+
+    def random_TLD
+      TLD.sample
+    end
+
+    def username_is_email_address?
+      @username_is_email_address
+    end
+  end
+end

data/lib/Moby/VERSION.rb

@@ -2,5 +2,5 @@
 # Moby::VERSION
 
 class Moby
-  VERSION = '1.0.1'
+  VERSION = '2.0.0'
 end

data/lib/Moby.rb

@@ -1,179 +1,34 @@
 # Moby.rb
 # Moby
 
-require 'mechanize'
-require 'pp'
-
-require_relative './File/self.collect'
 require_relative './Moby/VERSION'
+require_relative './Moby/Configuration'
+require_relative './Moby/RandomInputGenerator'
+require_relative './Moby/Backends'
 
 class Moby
-  TLD = %w{com net org edu int mil gov arpa biz aero name coop info pro museum}
-
-  attr_accessor\
-    :debug,
-    :form_name,
-    :form_number,
-    :password_field_name,
-    :password_field_number,
-    :url,
-    :username_field_name,
-    :username_field_number,
-    :username_hostname,
-    :username_is_email_address,
-    :verbose
-
-  attr_writer\
-    :user_agent
-
-  def initialize(
-    debug: false,
-    form_name: nil,
-    form_number: 0,
-    password_field_name: 'password',
-    password_field_number: 1,
-    url: nil,
-    user_agent: nil,
-    username_field_name: 'username',
-    username_field_number: 0,
-    username_hostname: nil,
-    username_is_email_address: false,
-    verbose: false
-  )
-    @debug = debug
-    @form_name = form_name
-    @form_number = form_number.to_i
-    @password_field_name = password_field_name
-    @password_field_number = password_field_number.to_i
-    @url = url
-    @user_agent = user_agent
-    @username_field_name = username_field_name
-    @username_field_number = username_field_number.to_i
-    @username_hostname = username_hostname
-    @username_is_email_address = username_is_email_address
-    @verbose = verbose
-  end
-
   def counter_phish
-    start_time = Time.now
-    puts "Moby session begun #{start_time}."
-    submission_count = 0
-    begin
-      loop do
-        mechanize.user_agent_alias = user_agent
-        username_field.value = username
-        password_field.value = password
-        pp page if @debug
-        result = mechanize.submit(form)
-        pp result if @debug
-        submission_count += 1
-        puts "#{submission_count} #{username}:#{password}" if @verbose
-      rescue Net::HTTP::Persistent::Error
-        puts "\n\nNet::HTTP::Persistent::Error rescued.\n\n" if @verbose
-      rescue Net::OpenTimeout
-        puts "\n\nNet::OpenTimeout rescued.\n\n" if @verbose
-      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
+    backend.counter_phish
   end
 
   private
 
-  def mechanize
-    @mechanize ||= Mechanize.new
-  end
-
-  def words(filename = '/usr/share/dict/words')
-    @words ||= File.collect(filename){|line| line.chomp}
-  end
-
-  def random_word
-    words[rand(words.size)]
-  end
-
-  def random_TLD
-    TLD[rand(TLD.size)]
-  end
-
-  def random_user_agent
-    agent_aliases = Mechanize::AGENT_ALIASES
-    agent_aliases.delete('Mechanize')
-    agent_aliases_keys = agent_aliases.keys
-    agent_aliases_keys[rand(agent_aliases.size)]
+  def initialize(**args)
+    @configuration = Configuration.new(**args)
   end
 
-  def page
-    @page ||= (
-      page = mechanize.get(@url)
-      md = page.body.match(/meta.*?Refresh.*?url=(.*?)"/i)
-      if md
-        puts 'meta_refresh_url found' if @debug
-        page = mechanize.get(md[1])
-      end
-      pp page if @debug
-      page
+  def backend
+    @backend ||= Backends.for(
+      config: @configuration,
+      random_input_generator: random_input_generator
     )
   end
 
-  def form
-    @form ||= (
-      if @form_name
-        page.form(@form_name)
-      elsif @form_number
-        page.forms[@form_number]
-      else
-        page.forms[0]
-      end
+  def random_input_generator
+    @random_input_generator ||= RandomInputGenerator.new(
+      word_list_path: @configuration.word_list_path,
+      username_hostname: @configuration.username_hostname,
+      username_is_email_address: @configuration.username_is_email_address?
     )
   end
-
-  def username
-    if username_is_email_address?
-      if username_hostname
-        "#{random_word}@#{@username_hostname}"
-      else
-        "#{random_word}@#{random_word}.#{random_TLD}"
-      end
-    else
-      random_word
-    end
-  end
-
-  def password
-    random_word
-  end
-
-  def user_agent
-    @user_agent || random_user_agent
-  end
-
-  def username_field
-    if @username_field_name
-      form.field(@username_field_name)
-    elsif @username_field_number
-      form.fields[@username_field_number]
-    else
-      form.fields[0]
-    end
-  end
-
-  def password_field
-    if @password_field_name
-      form.field(@password_field_name)
-    elsif @password_field_number
-      form.fields[@password_field_number]
-    else
-      form.fields[1]
-    end
-  end
-
-  # predicate methods
-
-  def username_is_email_address?
-    @username_is_email_address || @username_hostname || username_field.name == 'email'
-  end
 end

data/lib/Selenium/WebDriver/Driver/Attempt/attempt.rb

@@ -0,0 +1,18 @@
+# Selenium/WebDriver/Driver/Attempt/attempt.rb
+# Selenium::WebDriver::Driver::Attempt.attempt
+
+# 20200418
+# 0.3.0
+
+# Examples:
+# 1. driver.attempt do |driver|
+#     driver.get('https://example.com/users/sign_in')
+#     enter_username
+#     enter_password
+#     sign_in
+#   end
+
+# Changes:
+# 1. Moved all the logic into the Thoran namespace.
+
+require 'Thoran/Selenium/WebDriver/Driver/Attempt/attempt'

data/lib/Selenium/WebDriver/SearchContext/ElementPresentQ/element_presentQ.rb

@@ -0,0 +1,13 @@
+# Selenium/WebDriver/SearchContext/ElementPresentQ/element_presentQ.rb
+# Selenium::WebDriver::SearchContext::ElementPresentQ.element_present?
+
+# 20200418
+# 0.3.0
+
+# Examples:
+# 1. driver.element_present?(:xpath, '//a[@id="submit"]')
+
+# Changes:
+# 1. Moved all the logic into the Thoran namespace.
+
+require 'Thoran/Selenium/WebDriver/SearchContext/ElementPresentQ/element_presentQ'

data/lib/Thoran/Selenium/WebDriver/Driver/Attempt/attempt.rb

@@ -0,0 +1,53 @@
+# Thoran/Selenium/WebDriver/Attempt/attempt.rb
+# Thoran::Selenium::WebDriver::Attempt.attempt
+
+# 20200419
+# 0.0.1
+
+# Examples:
+# 1. driver.attempt do |driver|
+#   driver.get('https://example.com/users/sign_in')
+#   enter_username
+#   enter_password
+#   sign_in
+# end
+
+# Changes:
+# 1. + Thoran namespace.
+
+module Thoran
+  module Selenium
+    module WebDriver
+      module Driver
+        module Attempt
+
+          def attempt(max_attempts = 3, &block)
+            attempts = 0
+            loop do
+              begin
+                yield
+                break
+              rescue Timeout::Error, ::Selenium::WebDriver::Error::UnknownError, ::Selenium::WebDriver::Error::NoSuchElementError => e
+                attempts += 1
+                if attempts >= max_attempts
+                  @driver.quit
+                  puts "Giving up after #{max_attempts} attempts to #{__method__} because #{e}."
+                  exit
+                end
+              end
+            end
+          end
+
+        end
+      end
+    end
+  end
+end
+
+module Selenium
+  module WebDriver
+    class Driver
+      include Thoran::Selenium::WebDriver::Driver::Attempt
+    end
+  end
+end

data/lib/Thoran/Selenium/WebDriver/SearchContext/ElementPresentQ/element_presentQ.rb

@@ -0,0 +1,39 @@
+# Thoran/Selenium/WebDriver/SearchContext/ElementPresentQ/element_presentQ.rb
+# Thoran::Selenium::WebDriver::SearchContext::ElementPresentQ.element_present?
+
+# 20200418
+# 0.0.0
+
+# Examples:
+# 1. driver.element_present?(:xpath, '//a[@id="submit"]')
+# 2. driver.element_present?(:id, @logout_button_id)
+
+# Changes:
+# 1. + Thoran namespace.
+
+module Thoran
+  module Selenium
+    module WebDriver
+      module SearchContext
+        module ElementPresentQ
+
+          def element_present?(selector_type, selector)
+            bridge.find_element_by(selector_type, selector)
+            true
+          rescue ::Selenium::WebDriver::Error::NoSuchElementError
+            false
+          end
+
+        end
+      end
+    end
+  end
+end
+
+module Selenium
+  module WebDriver
+    class Driver
+      include Thoran::Selenium::WebDriver::SearchContext::ElementPresentQ
+    end
+  end
+end

data/moby.rb.gemspec

@@ -16,9 +16,10 @@ Gem::Specification.new do |spec|
   spec.homepage = 'https://github.com/thoran/moby'
   spec.license = 'MIT'
 
-  spec.required_ruby_version = ">= 2.5.0"
+  spec.required_ruby_version = ">= 3.3.0"
 
   spec.add_dependency('mechanize', '~> 2')
+  spec.add_dependency('selenium-webdriver', '~> 4')
   spec.add_dependency('switches.rb', '~> 0')
 
   spec.add_development_dependency('minitest')

data/test/Moby/Backends/MechanizeBackend_test.rb

@@ -0,0 +1,83 @@
+# test/Moby/Backends/MechanizeBackend_test.rb
+
+require_relative '../../test_helper'
+
+describe Moby::Backends::MechanizeBackend do
+  let(:url){'https://phishing.example.com/login'}
+  let(:generator){Moby::RandomInputGenerator.new(word_list_path: TestFixtures::WORD_LIST_PATH)}
+
+  def backend(**config_args)
+    config = Moby::Configuration.new(url: url, **config_args)
+    Moby::Backends::MechanizeBackend.new(config: config, random_input_generator: generator)
+  end
+
+  before do
+    WebMock.disable_net_connect!
+    stub_request(:get, url)
+      .to_return(status: 200, body: TestFixtures::SIMPLE_LOGIN_FORM, headers: {'Content-Type' => 'text/html'})
+    stub_request(:post, url).to_return(status: 200, body: 'Success')
+  end
+
+  after do
+    WebMock.reset!
+    WebMock.allow_net_connect!
+  end
+
+  describe "page loading" do
+    it "loads the target url once and memoises the page" do
+      b = backend
+      page1 = b.send(:page)
+      page2 = b.send(:page)
+
+      _(page1).must_be_instance_of(Mechanize::Page)
+      _(page1).must_be_same_as(page2)
+      assert_requested(:get, url, times: 1)
+    end
+  end
+
+  describe "form finding" do
+    it "finds the form by name" do
+      form = backend(form_name: 'login').send(:form)
+
+      _(form).must_be_instance_of(Mechanize::Form)
+      _(form.name).must_equal('login')
+    end
+
+    it "finds the form by number" do
+      multi_url = 'https://multi.example.com/page'
+      stub_request(:get, multi_url)
+        .to_return(status: 200, body: TestFixtures::MULTIPLE_FORMS, headers: {'Content-Type' => 'text/html'})
+      config = Moby::Configuration.new(url: multi_url, form_number: 1)
+      b = Moby::Backends::MechanizeBackend.new(config: config, random_input_generator: generator)
+
+      _(b.send(:form).node['id']).must_equal('login_form')
+    end
+  end
+
+  describe "field finding" do
+    it "finds the username and password fields by name" do
+      b = backend(form_name: 'login', username_field_name: 'username', password_field_name: 'password')
+
+      _(b.send(:username_field).name).must_equal('username')
+      _(b.send(:password_field).name).must_equal('password')
+    end
+  end
+
+  describe "submitting" do
+    it "fills both fields and submits" do
+      backend.send(:fill_and_submit_login_form)
+
+      assert_requested(:post, url) do |request|
+        request.body.match?(/username=[^&]+/) && request.body.match?(/password=[^&]+/)
+      end
+    end
+
+    it "submits only the password when the username is prefilled" do
+      backend(username_prefilled: true).send(:fill_and_submit_login_form)
+
+      assert_requested(:post, url) do |request|
+        request.body.match?(/username=(&|\z)/) && request.body.match?(/password=[^&]+/)
+      end
+    end
+  end
+end

data/test/Moby/Backends/SeleniumBackend_test.rb

@@ -0,0 +1,44 @@
+# test/Moby/Backends/SeleniumBackend_test.rb
+
+require_relative '../../test_helper'
+
+describe Moby::Backends::SeleniumBackend do
+  let(:url){'https://phishing.example.com/login'}
+  let(:generator){Moby::RandomInputGenerator.new(word_list_path: TestFixtures::WORD_LIST_PATH)}
+
+  def backend(**config_args)
+    config = Moby::Configuration.new(url: url, backend: :selenium, **config_args)
+    Moby::Backends::SeleniumBackend.new(config: config, random_input_generator: generator)
+  end
+
+  # Stub the real browser launch so no Chrome/Firefox process is started.
+  def with_stubbed_driver
+    built = 0
+    fake_driver = Object.new
+    original = Selenium::WebDriver.method(:for)
+    Selenium::WebDriver.define_singleton_method(:for) do |*_args, **_kwargs|
+      built += 1
+      fake_driver
+    end
+    begin
+      yield(fake_driver, ->{built})
+    ensure
+      Selenium::WebDriver.define_singleton_method(:for, original)
+    end
+  end
+
+  describe "#driver" do
+    it "builds the driver once and memoises it (returning a non-nil driver)" do
+      with_stubbed_driver do |fake_driver, build_count|
+        b = backend
+        first = b.send(:driver)
+        second = b.send(:driver)
+
+        _(first).wont_be_nil
+        _(first).must_be_same_as(fake_driver)
+        _(first).must_be_same_as(second)
+        _(build_count.call).must_equal(1)
+      end
+    end
+  end
+end

data/test/Moby/Backends_test.rb

@@ -0,0 +1,27 @@
+# test/Moby/Backends_test.rb
+
+require_relative '../test_helper'
+
+describe Moby::Backends do
+  let(:url){'https://phishing.example.com/login'}
+  let(:generator){Moby::RandomInputGenerator.new(word_list_path: TestFixtures::WORD_LIST_PATH)}
+
+  def backend_for(**config_args)
+    config = Moby::Configuration.new(url: url, **config_args)
+    Moby::Backends.for(config: config, random_input_generator: generator)
+  end
+
+  describe ".for" do
+    it "returns a MechanizeBackend for the mechanize configuration" do
+      _(backend_for).must_be_instance_of(Moby::Backends::MechanizeBackend)
+    end
+
+    it "returns a SeleniumBackend for the selenium configuration" do
+      _(backend_for(backend: :selenium)).must_be_instance_of(Moby::Backends::SeleniumBackend)
+    end
+
+    it "raises for an unknown backend" do
+      _(proc{backend_for(backend: :ftp)}).must_raise(RuntimeError)
+    end
+  end
+end