selenium_tor 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99d3e4260b0873513c67db620d3057d61078b4c1cbae7b5c8c7b3e4cfdbbfbec
-  data.tar.gz: bb02cb9d07024a4798723185f4103246dac9b4c008e3f20abec5f710426a26a6
+  metadata.gz: 6aeb8724ddcdf0d7260330ca616651d54b94ce33c6a635c71ef5c5f3577de220
+  data.tar.gz: 12b5d264f6a774dab990148feb15179d0b7873e42eb5b1c4bb99e8383f5e5577
 SHA512:
-  metadata.gz: 654db110ca016a71d04b6def25d4befb86efc27cd2c0cce1ed7874834921d309262bc537b6b23bf8b77603b4d29960c88a10d83c8508ce6398b1d44a13577df1
-  data.tar.gz: 7d7369f8055ca42c229079d8732ab49d8d1467af49d35c547528dd792f1208101abcd123a6f05873b9fee4b704863a364708fc9148850f798635b9f3f6b3b8da
+  metadata.gz: deafbf4cbbc646e2fef5dc1800bc009edceb72906d65dc071942d0c742a49dd6aa17ac4fe2f88fc8d36f909445b31378996073f7d44b8cff473db2e9e3f5d403
+  data.tar.gz: 71c615ce16eb80f696aaa4dc26d73459df4ce8c4b7d994998580be1d93405baa5dc9ee94f321e7494f1567f3bed1f48481e53149829c2e1671268a6069d9d91f

data/.rubocop.yml

@@ -10,8 +10,9 @@ AllCops:
 Style/HashSyntax:
   Enabled: false  # yuk Ruby 3.1
 
-Layout/LineLength:
-  Max: 120
+Naming/MethodName:
+  Exclude:
+    - !ruby/regexp /test_.*\.rb$/ # for test_FOO constant tests
 
 Security/Eval:
   Exclude:
@@ -28,6 +29,9 @@ Style/RegexpLiteral:
 Minitest/TestMethodName:
   Enabled: true
 
+Minitest/AssertTruthy:
+  Enabled: false
+
 Minitest/TestFileName:
   Exclude:
     - test/features/fingerprinting/vglrun_test_fingerprintjs.rb

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## master (unreleased)
 
+## [1.2.0] - 2024-07-31
+
+### Bug fixes
+
+* [#11](https://gitlab.com/matzfan/selenium-tor/-/issues/11)
+
+### New features
+
+* add ability to change security level
+* add ability to get new circuit for page ([#10](https://gitlab.com/matzfan/selenium-tor/-/issues/10))
+
 ## [1.1.0] - 2024-07-28
 
 ### Bug fixes

data/README.md

@@ -17,6 +17,10 @@ The above approach will hide your IP, but there is a good chance your browser's
 
 ## Known issues
 
+Known issues are recorded [here](https://gitlab.com/matzfan/selenium-tor/-/issues).
+
+### Fingerprinting
+
 The gem uses Xvfb to allow Tor Browser to be manipulated headlessly. Xvfb in turn uses `llvmpipe` software acceleration which may lead to issues with WebGL fingerprinting - see [issue #7](https://gitlab.com/matzfan/selenium-tor/-/issues/7). If this is a problem we recommend using [VirtualGL](https://www.virtualgl.org) to force Xvfb to use your hardware driver instead. This is done by prepending your executable code with the command `vglrun`. For an example see the section below on testing. VirtualGL can be installed from a [package repo](https://virtualgl.org/Downloads/YUM). 
 
 ## Installation
@@ -74,6 +78,27 @@ end
 driver1&.quit
 driver2&.quit
 ```
+### Tor Browser specific functionality
+
+You can get and set the secuirty level (shield icon in TB) as follows. 4 is 'Standard', 2 is 'Safer', 1 is 'Safest'.
+```ruby
+@driver = Selenium::WebDriver.for :tor
+@driver.security_level
+# => 4 - the default value
+@driver.security_level = 1
+@driver.security_level
+# => 1
+@driver.quit
+```
+You can get a new circuit for the current page ('New Tor circuit for this site' on TB's application menu):
+```ruby
+@driver = Selenium::WebDriver.for :tor
+@driver.get 'https://example.com'
+@driver.new_circuit_for_page # new circuit for the current page only
+@driver.quit
+```
+### Miscellaneous
+
 The `Selenium::WebDriver::Tor` namespace is used for `Driver`, `Options`, `Profile` and all tor-specific classes. Otherwise Selenium's `Selenium::WebDriver::Firefox` namespace is used.
 
 Remote functionality is not tested, but may be if a suitable Tor Browser Docker container becomes available.

data/lib/tor/driver.rb

@@ -9,20 +9,23 @@ require_relative 'tor_process'
 module Selenium
   module WebDriver
     module Tor
-      # delegate class so extensions can be added & connection to tor made
-      class DriverNotYetConnectedToTorNetwork < Firefox::Driver; end
+      # delegate class
+      class DriverDelegate < Firefox::Driver; end
 
       # tor driver
-      class Driver < DelegateClass(DriverNotYetConnectedToTorNetwork)
+      class Driver < DelegateClass(DriverDelegate)
         class TorNetworkError < StandardError; end
 
+        TB_SECURITY_LEVELS = [4, 2, 1].freeze
+
         def initialize(options: nil, **)
           @data_dir = Dir.mktmpdir
-          add_torrc_path_to_options options
-          @instance = DriverNotYetConnectedToTorNetwork.new(options: options, **)
+          @options = options || Options.new # fix for issue #11, 'tis a puzzlement
+          add_torrc_path_to_options
+          @instance = DriverDelegate.new(options: @options, **)
+          install_extensions @instance
+          create_tor_process_and_start_tor @options.tor_opts
           super(@instance)
-          install_extensions(@instance)
-          create_tor_process_and_start_tor options&.tor_opts
         end
 
         def browser
@@ -35,12 +38,37 @@ module Selenium
           super
         end
 
-        private
+        def security_level
+          old_context = context
+          self.context = 'chrome'
+          execute_script("return Services.prefs.getIntPref('browser.security_level.security_slider')")
+        ensure
+          self.context = old_context
+        end
 
-        def add_torrc_path_to_options(options)
-          return unless options
+        def security_level=(int)
+          old_context = context
+          self.context = 'chrome'
+          raise(ArgumentError, 'Security level can be set to 4, 2 or 1') unless TB_SECURITY_LEVELS.include?(int)
+
+          execute_script("return Services.prefs.setIntPref('browser.security_level.security_slider', #{int})")
+        ensure
+          self.context = old_context if old_context
+        end
+
+        def new_circuit_for_page
+          old_context = context
+          self.context = 'chrome'
+          execute_script "ChromeUtils.importESModule('resource://gre/modules/TorDomainIsolator.sys.mjs');
+                          TorDomainIsolator.newCircuitForDomain('#{current_url}')"
+        ensure
+          self.context = old_context
+        end
+
+        private
 
-          options.prefs['extensions.torlauncher.torrc_path'] = File.join(@data_dir, 'torrc')
+        def add_torrc_path_to_options
+          @options.prefs['extensions.torlauncher.torrc_path'] = File.join(@data_dir, 'torrc')
         end
 
         def install_extensions(instance)

data/lib/tor/options.rb

@@ -26,9 +26,9 @@ module Selenium
         def initialize(log_level: nil, **opts)
           opts[:tor_opts] = opts.delete(:system_tor).opts if opts[:system_tor] # DEPRECATED 2.0
           @tor_opts = opts[:tor_opts] ? opts.delete(:tor_opts) : {} # must be deleted before call to super
-          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
-          copy_fonts # so we don't have to change dir before executing TB binary #2 and #9
+          copy_fonts # so we don't have to change dir before executing TB binary - issues #2 and #9
+          super(log_level: log_level, **tor_options(opts.delete(:prefs)).merge(opts))
         end
 
         private

data/lib/tor/version.rb

@@ -3,7 +3,7 @@
 module Selenium
   module WebDriver
     module Tor
-      VERSION = '1.1.0'
+      VERSION = '1.2.0'
     end
   end
 end

data/selenium_tor.gemspec

@@ -30,5 +30,5 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'selenium-webdriver', '~> 4.22'
+  spec.add_dependency 'selenium-webdriver', '>= 4.23'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: selenium_tor
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - MatzFan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-28 00:00:00.000000000 Z
+date: 2024-07-31 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.22'
+        version: '4.23'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.22'
+        version: '4.23'
 description: An extension for Selenium::WebDriver that automates Tor Browser
 email:
 executables: []