selenium_tor 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 484a1e6197b2ab0ad98ed6ccff6591db30094e87a3b51fb517c15f2531b9c76f
-  data.tar.gz: 180f09296eaf38cfe25b435f9126c9ae84e7fa123421bf9ec649d4d82d128e41
+  metadata.gz: 387e1f6800b7d9b1f7eb269a0e6d53f699123b59f3daa1b4ae66536037fdc3ff
+  data.tar.gz: a59fa065eef2328abb0832ead2ada221172b5d4d55c34fe0285c02f6075e8d93
 SHA512:
-  metadata.gz: d88198513d5606df47bc7a5917c2384320f9a855877498994d72a0e6c2a71118c226340df00cd8c8892bd1bad63010ab59cb71856e757c98a306dd1414bf164f
-  data.tar.gz: '01954638cb9ffc19275acd528cd19326d77604f2570cecd1ce2eb1afd41a130812246d57c9db8cb05ffa960c94e96d1213545d70565528f24260b92548e26677'
+  metadata.gz: 6a5d2aa8ecf3527edadcec9aab17480dfdd0055525322b7c97f0c8f4e6588e392d0e5b10d4eca05c5a1766e22f87b6793109da8965a45ac6bc26216888be50de
+  data.tar.gz: b145dab8c18821750a8be414af2cf44a8046a0393e69907c52dc14cc8dd4f376e626d10d77fe473655604d27810d93ea5539f5a316f78659a6a8abaaf6780f8c

data/.yamllint

@@ -0,0 +1,7 @@
+---
+extends: default
+
+rules:
+  line-length:
+    max: 120
+    level: warning

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## master (unreleased)
 
+## [0.1.3] - 2023-12-08
+
+### Bug fixes
+
+* added selenium-webdriver as runtime dependency
+* [#2](https://gitlab.com/matzfan/selenium_tor/-/issues/2) fixed, fingerprintjs VisitorId now same as TB's
+
+### New features
+
+* Fix circular require issue
+* Expand fingerprint tests
+
 ## [0.1.2] - 2023-11-20
 
 * Breaking change: change constant names in Tor namespace - see README

data/README.md

@@ -8,6 +8,12 @@ A Selenium extension for Tor Browser.
 driver = Selenium::WebDriver.for :tor
 ```
 
+# \_why?
+
+I can use Firefox with Selenium and set a SOCKS proxy to use the Tor network, so why the need?
+
+The above approach will hide your IP, but there is a good chance your browser's unique or near-unique fingerprint may be logged by site owners. Subsequent visits could identify you. A primary aim of this project is to enable Selenium to leverage Tor Browser's unique anonymity characteristics - in particular its resitance to browser fingerprinting. The aim is to ensure Selenium Tor site visits leave an identical fingerprint to the thousands of regular Tor Browser users.
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -29,8 +35,8 @@ 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.
+puts driver.title # => Congratulations. This browser is configured to use Tor.
+driver.quit
 ```
 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.
 
@@ -45,8 +51,7 @@ Tor::TBB_BROWSER_DIR # path to the 'Browser' directory in the above
 Tor::TBB_BINARY_PATH # path to the binary
 Tor::TBB_PROFILE_DIR # path to the default profile directory
 Tor::TBB_EXTENSIONS_DIR # path to the 'extensions' directory in the above
-Tor::TBB_VERSION # 
-the version installed, e.g. "13.0.1", note: driver.capabilities.browser_version returns the Firefox version Tor Browser is based on 
+Tor::TBB_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

data/lib/tor/driver.rb

@@ -2,15 +2,12 @@
 
 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 Driver < DelegateClass(DriverNotYetConnectedToTorNetwork)
         class TorNetworkError < StandardError; end
 
         CONNECTION_STATUS_ID = 'torPreferences-status-tor-connect'
@@ -19,7 +16,7 @@ module Selenium
 
         def initialize(...)
           @instance = DriverNotYetConnectedToTorNetwork.new(...)
-          super @instance
+          super(@instance)
           wait_for_tor_connection
           install_addons
         end
@@ -28,7 +25,7 @@ module Selenium
 
         def wait_for_tor_connection
           @instance.get 'about:preferences#connection'
-          wait(10).until { @instance.find_element(:id, CONNECTION_STATUS_ID).text == CONNECTED }
+          Wait.new(timeout: 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}"

data/lib/tor/driver_not_yet_connected_to_tor_network.rb

@@ -2,6 +2,7 @@
 
 require_relative '../service'
 require_relative '../options'
+require_relative '../tor/profile'
 
 module Selenium
   module WebDriver

data/lib/tor/options.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'prefs'
+require_relative 'tor_prefs'
 require 'selenium-webdriver'
 
 module Selenium
@@ -17,23 +17,24 @@ module Selenium
         Tor::TBB_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))
+          super(log_level: log_level, **tor_options(opts.delete(:prefs)).merge(opts))
           do_start_tor_browser_script_stuff # stuff the start-tor-browser script in TBB does
         end
 
         private
 
-        def tor_options
-          { binary: TBB_BINARY_PATH, prefs: PREFS }
+        def tor_options(prefs)
+          { binary: TBB_BINARY_PATH, prefs: (prefs || {}).merge(TOR_PREFS) }
         end
 
         def do_start_tor_browser_script_stuff
+          ENV['SESSION_MANAGER'] = nil
           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_PATH'] = File.join Tor::TBB_BROWSER_DIR, 'fontconfig' # supposed to stop font leaks..
           ENV['FONTCONFIG_FILE'] = 'fonts.conf'
+          FileUtils.rm_rf File.join(Tor::TBB_BROWSER_DIR, *%w[TorBrowser Data fontconfig])
           ENV['GSETTINGS_BACKEND'] = 'memory'
-          FileUtils.rm_rf File.join TBB_DIR, *%w[TorBrowser Data fontconfig]
+          FileUtils.cd Tor::TBB_BROWSER_DIR # crucial - fixes [#2](https://gitlab.com/matzfan/selenium-tor/-/issues/2)
         end
       end
     end

data/lib/tor/tor_prefs.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Selenium
+  module WebDriver
+    module Tor
+      FIRST_CONNECTION_PREFS = {
+        'extensions.torlauncher.prompt_at_startup' => false,
+        'privacy.purge_trackers.date_in_cookie_database' => '0',
+        '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
+
+      OTHER_PREFS = {
+        'intl.language_notification.shown' => true # affects font fingerprint (viewport size)
+      }.freeze
+
+      TOR_PREFS = FIRST_CONNECTION_PREFS.merge OTHER_PREFS
+    end
+  end
+end

data/lib/tor/version.rb

@@ -3,7 +3,7 @@
 module Selenium
   module WebDriver
     module Tor
-      VERSION = '0.1.2'
+      VERSION = '0.1.3'
     end
   end
 end

data/selenium_tor.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email = ['matzfan@mailinator.com']
 
   spec.summary = 'Selenium extension for Tor Browser'
-  spec.description = 'Selenium extension for Tor Browser'
+  spec.description = 'An extension for Selenium::WebDriver that automates Tor Browser'
   spec.homepage = 'https://gitlab.com/matzfan/selenium_tor'
   spec.license = 'MIT'
   spec.required_ruby_version = '>= 2.7.0'
@@ -32,4 +32,6 @@ Gem::Specification.new do |spec|
   spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'selenium-webdriver', '4.16.0'
 end

metadata

@@ -1,16 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: selenium_tor
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - MatzFan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-20 00:00:00.000000000 Z
-dependencies: []
-description: Selenium extension for Tor Browser
+date: 2023-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.16.0
+description: An extension for Selenium::WebDriver that automates Tor Browser
 email:
 - matzfan@mailinator.com
 executables: []
@@ -19,6 +33,7 @@ extra_rdoc_files: []
 files:
 - ".rubocop.yml"
 - ".ruby-version"
+- ".yamllint"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Guardfile
@@ -27,15 +42,14 @@ files:
 - Rakefile
 - lib/driver.rb
 - lib/firefox_driver_lock_file_patch.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/profile.rb
+- lib/tor/tor_prefs.rb
 - lib/tor/version.rb
 - selenium_tor.gemspec
 - sig/tor.rbs

data/lib/mixin.rb

@@ -1,13 +0,0 @@
-# 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/tor/prefs.rb

@@ -1,17 +0,0 @@
-# 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