selenium_tor 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2e1fe6540f9a3fdb5709dd88c4594a453052aec00f00423e39f69664ec8d27e1
+  data.tar.gz: a0a8a23354f5c0bad149baf6d0b043e72f64845b142921492c72d6565e8120da
+SHA512:
+  metadata.gz: c74beaf4a2c71a66fb4cbee34f9896c483308b684b99ebcb12e653c983d7be6e4486d6ea8c177096d01243d2eb5f275044d308ef9f602bf56c760be2ffcb6022
+  data.tar.gz: 633ca399c16169d4f9d0a48b12fb4781a1c68fa4e49e121454db26d14bea1bef0770ef1d82e1cb700ffe1124d353ed7070e8830290a9e4796b3458d74a62492c

data/.rubocop.yml

@@ -0,0 +1,15 @@
+---
+require:
+  - rubocop-minitest
+  - rubocop-performance
+  - rubocop-rake
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
+
+Style/HashSyntax:
+  Enabled: false  # yuk Ruby 3.1
+
+Layout/LineLength:
+  Max: 120

data/.ruby-version

@@ -0,0 +1 @@
+3.3.0-preview3

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+## master (unreleased)
+
+## [0.1.1] - 2023-11-19
+
+* Rename gem from selenium-tor, yanked previous versions
+
+## [0.0.1] - 2023-11-19
+
+### Bug fixes
+
+* Fix inability to add options to Tor::Options
+* [#1](https://gitlab.com/matzfan/selenium_tor/-/issues/1): Fix fonts leak at browserleaks
+
+### New features
+
+* Set constants in Selenium::WebDriver::Tor namespace
+* Set env vars to reflect those set in TBB's start-tor-browser script
+
+## [0.0.0] - 2023-11-17
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at matzfan@mailinator.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Guardfile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :minitest do
+  watch(%r{^test/(.*)/?test_(.*)\.rb$})
+  watch(%r{^features/(.*)/?test_(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 MatzFan
+
+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,87 @@
+[![Gem Version](https://badge.fury.io/rb/selenium_tor.svg)](https://badge.fury.io/rb/selenium_tor)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
+
+# Selenium Tor
+
+A Selenium extension for Tor Browser.
+```ruby
+driver = Selenium::WebDriver.for :tor
+```
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add selenium_tor
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install selenium_tor
+
+## Usage
+
+Tor Browser is based on Firefox, so for usage please read the Selenium [docs](https://www.selenium.dev/documentation/webdriver/browsers/firefox/) for Firefox browser.
+
+A driver is instantiated like this:
+```ruby
+options = Selenium::WebDriver::Tor::Options.new
+options.add_argument '--headless' # whatever you need
+driver = Selenium::WebDriver.for :tor, options: options
+
+driver.get 'https://check.torproject.org'
+puts driver.title
+# => Congratulations. This browser is configured to use Tor.
+```
+The driver will not be instantiated until a connection to the Tor network is made. If the network is inaccessible for any reason a `TorNetworkError` will result.
+
+The `Selenium::WebDriver::Tor` namespace is used by `Driver` and `Options`. Otherwise Selenium's `Selenium::WebDriver::Firefox` namespace is used.
+
+Remote functionality is not tested, but will be if Selenium provide a Tor Browser Docker container for Selenium Grid.
+
+A number of constants are set during driver initialization based upon values found in the Tor Browser Bundle (TBB) root directory (see below). These include:
+```ruby
+Tor::TBB_DIR # path to the TBB root directory
+Tor::TBB_BROWSER_DIR # path to the 'Browser' directory in the above
+Tor::TOR_BROWSER_BINARY_PATH # path to the binary
+Tor::TOR_BROWSER_VERSION # the version installed, e.g. "13.0.1", note: driver.capabilities.browser_version returns the Firefox version Tor Browser is based on 
+```
+
+## Dependencies and configuration
+
+As with Firefox browser, Geckodriver needs to be installed and in your PATH.
+
+The gem needs to know the location of the Tor Browser Bundle (TBB). This can be installed from the Tor Project [downloads page](https://www.torproject.org/download/). The download package archive must be extracted and the root TBB directory (called `tor-browser`) placed somewhere on your system. By default it is assumed to be in the current user's HOME directory. An alternative location can be set via the env var `TOR_BROWSER_ROOT_DIR` - e.g. `export TOR_BROWSER_ROOT_DIR=/home/<user>/Downloads`. The Tor Browser binary location is *automatically set* by reference to this directory, so there is no need to do this:
+```ruby
+options.binary = '/some/path/to/tor_firefox_binary' # UNNECESSARY
+```
+Tor Selenium is tested on **Linux only** right now.
+
+## Testing
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
+
+Tests are run in headless mode by default. If you want to see what the browser is doing you can do this:
+
+    $ export RUN_HEADED_TESTS=1 && rake
+
+If you find tests are failing with `TorNetworkError` and a timeout message, check you have no other Tor Browser processes running. The process to look for is called `firefox.real`. You may also want to check the Tor network is actually up, it isn't always..
+
+## Development
+
+You can 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitLab at https://gitlab.com/matzfan/selenium_tor. For a pull request please checkout a suitably named feature branch before making and submitting changes.
+
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://gitlab.com/matzfan/selenium_tor/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Selenium Tor project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://gitlab.com/matzfan/selenium_tor/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/driver.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal:true
+
+require_relative 'tor/driver'
+
+# extend class
+module Selenium
+  module WebDriver
+    # patched class
+    class Driver
+      class << self
+        alias old_for for
+
+        def for(browser, opts = {})
+          browser == :tor ? Tor::Driver.new(**opts) : old_for(browser, opts)
+        end
+      end
+    end
+  end
+end

data/lib/mixin.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# helper methods
+module Selenium
+  module WebDriver
+    # helper methods
+    module Mixin
+      def wait(seconds)
+        Wait.new(timeout: seconds)
+      end
+    end
+  end
+end

data/lib/options.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal:true
+
+require_relative 'tor/options'
+
+# extend class
+module Selenium
+  module WebDriver
+    # patched class
+    class Options
+      def self.tor(...)
+        Tor::Options.new(...)
+      end
+    end
+  end
+end

data/lib/selenium_tor.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'selenium-webdriver'
+require_relative 'driver'

data/lib/service.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal:true
+
+module Selenium
+  module WebDriver
+    # patched class
+    class Service
+      def self.tor(...)
+        Firefox::Service.new(...) # regular Firefox::Service
+      end
+    end
+  end
+end

data/lib/tor/driver.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'open-uri'
+require_relative 'driver_not_yet_connected_to_tor_network'
+require_relative '../mixin'
+
+module Selenium
+  module WebDriver
+    module Tor
+      # tor driver
+      class Driver < DelegateClass(Tor::DriverNotYetConnectedToTorNetwork)
+        include Mixin
+
+        class TorNetworkError < StandardError; end
+
+        CONNECTION_STATUS_ID = 'torPreferences-status-tor-connect'
+        CONNECTED = "Tor Network:\nConnected"
+        NO_SCRIPT_XPI_URL = 'https://addons.mozilla.org/firefox/downloads/file/4178438/noscript-11.4.28.xpi'
+
+        def initialize(...)
+          @instance = DriverNotYetConnectedToTorNetwork.new(...)
+          super @instance
+          wait_for_tor_connection
+          install_addons
+        end
+
+        private
+
+        def wait_for_tor_connection
+          @instance.get 'about:preferences#connection'
+          wait(10).until { @instance.find_element(:id, CONNECTION_STATUS_ID).text == CONNECTED }
+        rescue Selenium::WebDriver::Error::TimeoutError => e
+          @instance.quit # abort initialization
+          raise TorNetworkError, "Cannot connect to Tor network: #{e.message}"
+        end
+
+        def install_addons
+          @instance.install_addon URI.parse(NO_SCRIPT_XPI_URL).open
+        end
+      end
+    end
+  end
+end

data/lib/tor/driver_not_yet_connected_to_tor_network.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative '../service'
+require_relative '../options'
+
+module Selenium
+  module WebDriver
+    module Tor
+      # subclass - doesn't wait to be connected to tor network
+      class DriverNotYetConnectedToTorNetwork < Firefox::Driver
+        def browser
+          :tor # overides :firefox
+        end
+      end
+    end
+  end
+end

data/lib/tor/options.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'prefs'
+require 'selenium-webdriver'
+
+module Selenium
+  module WebDriver
+    module Tor
+      # tor options
+      class Options < Firefox::Options
+        DEFAULT_TBB_DIR = File.join Dir.home, 'tor-browser'
+        Tor::TBB_DIR = ENV.fetch('TOR_BROWSER_ROOT_DIR', nil) || DEFAULT_TBB_DIR
+        Tor::TBB_BROWSER_DIR = File.join Tor::TBB_DIR, 'Browser'
+        Tor::TOR_BROWSER_BINARY_PATH = File.join Tor::TBB_BROWSER_DIR, 'firefox'
+        Tor::TOR_BROWSER_VERSION = JSON.parse(File.read(File.join(Tor::TBB_BROWSER_DIR, 'tbb_version.json')))['version']
+
+        def initialize(log_level: nil, **opts)
+          super(log_level: log_level, **tor_options.merge(opts))
+          do_start_tor_browser_script_stuff # stuff the start-tor-browser script in TBB does
+        end
+
+        private
+
+        def tor_options
+          { binary: TOR_BROWSER_BINARY_PATH, prefs: PREFS }
+        end
+
+        def do_start_tor_browser_script_stuff
+          ENV['XAUTHORITY'] = File.join(Dir.home, '.Xauthority') unless ENV.fetch('XAUTHORITY', nil)
+          ENV['HOME'] = TBB_BROWSER_DIR # do we really want to do this?
+          ENV['FONTCONFIG_PATH'] = "#{TBB_BROWSER_DIR}/fontconfig" # these two stop font leaks [#1]
+          ENV['FONTCONFIG_FILE'] = 'fonts.conf'
+          ENV['GSETTINGS_BACKEND'] = 'memory'
+          FileUtils.rm_rf File.join TBB_DIR, *%w[TorBrowser Data fontconfig]
+        end
+      end
+    end
+  end
+end

data/lib/tor/prefs.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Selenium
+  module WebDriver
+    module Tor
+      PREFS = { 'extensions.torlauncher.prompt_at_startup' => false,
+                'intl.language_notification.shown' => true,
+                'torbrowser.settings.bridges.builtin_type' => '',
+                'torbrowser.settings.bridges.enabled' => false,
+                'torbrowser.settings.bridges.source' => -1,
+                'torbrowser.settings.enabled' => true,
+                'torbrowser.settings.firewall.enabled' => false,
+                'torbrowser.settings.proxy.enabled' => false,
+                'torbrowser.settings.quickstart.enabled' => true }.freeze
+    end
+  end
+end

data/lib/tor/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Selenium
+  module WebDriver
+    module Tor
+      VERSION = '0.1.1'
+    end
+  end
+end

data/selenium_tor.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/tor/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'selenium_tor'
+  spec.version = Selenium::WebDriver::Tor::VERSION
+  spec.authors = ['MatzFan']
+  spec.email = ['matzfan@mailinator.com']
+
+  spec.summary = 'Selenium extension for Tor Browser'
+  spec.description = 'Selenium extension for Tor Browser'
+  spec.homepage = 'https://gitlab.com/matzfan/selenium_tor'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  # spec.metadata['allowed_push_host'] =
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://gitlab.com/matzfan/selenium_tor'
+  spec.metadata['changelog_uri'] = 'https://gitlab.com/matzfan/selenium_tor/CHANGELOG.md'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/sig/tor.rbs

@@ -0,0 +1,6 @@
+module Selenium
+  module Tor
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: selenium_tor
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- MatzFan
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-11-19 00:00:00.000000000 Z
+dependencies: []
+description: Selenium extension for Tor Browser
+email:
+- matzfan@mailinator.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/driver.rb
+- lib/mixin.rb
+- lib/options.rb
+- lib/selenium_tor.rb
+- lib/service.rb
+- lib/tor/driver.rb
+- lib/tor/driver_not_yet_connected_to_tor_network.rb
+- lib/tor/options.rb
+- lib/tor/prefs.rb
+- lib/tor/version.rb
+- selenium_tor.gemspec
+- sig/tor.rbs
+homepage: https://gitlab.com/matzfan/selenium_tor
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/matzfan/selenium_tor
+  source_code_uri: https://gitlab.com/matzfan/selenium_tor
+  changelog_uri: https://gitlab.com/matzfan/selenium_tor/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.0.dev
+signing_key:
+specification_version: 4
+summary: Selenium extension for Tor Browser
+test_files: []