selenium_tor 1.5.4 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45483bd8f793aa018296ee9ae0e06c496d0dd4dde2155e5421f05f7da9d497c1
-  data.tar.gz: 8ca6956063b24ee1b30e3c8a4a7f2332fcc40fb12be62a9fd94058470e5ff657
+  metadata.gz: e0b43f3c595a9b52864114bd23e728e824349b3cd514dbc30cbf3bdaca3e1f09
+  data.tar.gz: 45a4d53c8881fa99b6530c11d28131195c57d355f1caba27e4ed51181d52b368
 SHA512:
-  metadata.gz: fa1ad5934e06fb5a69c81e267e55d919cc29cce8fbc0480297b0439d65db53c79c63e27dfc718455b90d6368f5af359bd153003f570befc88a6c96bb3bc18dc4
-  data.tar.gz: a565f2f16b886d9a70c3646775e6cb093fc586b9702e01f7707bbae481395f8207322525355a5224fe2251d119681e18285ecebec48d0b78d07b27bf775f0e4b
+  metadata.gz: a8cf7f476a0aaa8d25d79e904c4d485e147f0527bdde799f46e62f0d2b140a83ace68cf5601e5b21c2f47cb5106004cbdde1ed99ce8625444d5e906a0014a3e3
+  data.tar.gz: 81c8bef22783b315ec3e4c570f601d8dd442478b30c813c069b491b66665443f6fff05827721e7610b266f28877db38c6c85420dfa13e69e4e7e8e84b187d864

data/.rubocop.yml

@@ -1,5 +1,5 @@
 ---
-require:
+plugins:
   - rubocop-minitest
   - rubocop-performance
   - rubocop-rake
@@ -7,14 +7,12 @@ require:
 AllCops:
   TargetRubyVersion: 3.2
   NewCops: enable
+  Exclude:
+    - 'vendor/**/*'  # GitLab caching..
 
 Style/HashSyntax:
   Enabled: false  # yuk Ruby 3.1
 
-Naming/MethodName:
-  Exclude:
-    - !ruby/regexp /test_.*\.rb$/ # for test_FOO constant tests
-
 Security/Eval:
   Exclude:
     - 'test/test_readme.rb'

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 ## master (unreleased)
 
+## [1.7.0] - 2025-05-21
+
+### New features
+
+* Reuse cached data files in TorProcess to speed up connection times
+* drop support for TB < 14.5 stable
+* add VirtualGL test to Rake tests
+
+### Bug fixes
+
+* [#20](https://gitlab.com/matzfan/selenium-tor/-/issues/20)
+
+## [1.6.0] - 2024-12-04
+
+* drop support for TB < 14.0 stable
+* Remove vglrun test from CI
+
 ## [1.5.4] - 2024-10-10
 
 * Add Bsdiff gem dependency

data/README.md

@@ -27,7 +27,7 @@ Once you have a driver instance:
 
 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 resistance to browser fingerprinting. The aim is to ensure Selenium Tor site visits leave an identical fingerprint to the thousands of regular Tor Browser users.
+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 resistance to browser fingerprinting. The primary aim is to ensure Selenium Tor site visits leave an identical fingerprint to the thousands of regular Tor Browser users.
 
 ## Installation
 
@@ -41,7 +41,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Dependencies and configuration
 
-[Tor Browser](https://www.torproject.org/download).
+[Tor Browser](https://www.torproject.org/download). Tests are conducted with the latest stable ('release') and alpha versions of Tor Browser. Support for older versions is periodically dropped - see the CHANGELOG.
 
 As with Firefox browser, `geckodriver` needs to be installed and in your PATH.
 
@@ -58,7 +58,7 @@ Tor Selenium is tested on **Linux only** right now.
 
 ### Patching libxul.so
 
-A configuration option to patch the libxul.so packaged with Tor Browser is provided. This has the effect of preventing websites from fingerprinting Selenium-driven Tor Browser via a JS call to `navigator.webdriver`:
+A configuration option to patch the `libxul.so` packaged with Tor Browser is provided. This has the effect of preventing websites from fingerprinting Selenium-driven Tor Browser via a JS call to `navigator.webdriver`:
 ```ruby
 @driver_class = Selenium::WebDriver::Tor::Driver
 @driver_class.libxul_patched? # is Tor Browser's libxul.so patched?
@@ -69,7 +69,7 @@ A configuration option to patch the libxul.so packaged with Tor Browser is provi
 @driver_class.unpatch_libxul # revert the patch and restore the libxul.so packaged with Tor Browser
 # => 0
 ```
-The patcher uses the [Bsdiff](https://gitlab.com/matzfan/bsdiff) gem, which in turn requires the bzip2 library (`libbz2-dev`).
+The patcher uses the [Bsdiff](https://gitlab.com/matzfan/bsdiff) gem.
 
 ## Usage
 ```ruby
@@ -111,6 +111,8 @@ end
 @drivers.each(&:quit)
 # => truthy
 ```
+Each Driver instance uses a separate data directory for `torrc` and other files. Starting from version 1.7 cached files created upon first connection to the tor network are copied into subsequent data dirs. This substantially reduces the time subsequent Drivers take to connect to the tor network.
+
 ### Tor Browser specific functionality
 
 You can get and set the security level (shield icon in TB) as follows. 4 is 'Standard', 2 is 'Safer', 1 is 'Safest'.
@@ -160,13 +162,13 @@ Known issues are recorded [here](https://gitlab.com/matzfan/selenium-tor/-/issue
 
 ### 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).
+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 take a look at the `test_fingerprintjs_with_virtualgl.rb` test. VirtualGL can be installed from a [package repo](https://virtualgl.org/Downloads/YUM).
 
 ## Testing
 
 ~~After checking out the repo, run `bin/setup` to install dependencies.~~
 
-Tests dependencies are `[bsdiff](https://www.daemonology.net/bsdiff)`, `VirtualGL` (see Fingerprinting above) and `Xvfb` if you want to run headless tests.
+Tests dependencies are `Xvfb` if you want to run headless tests and `VirtualGL` (see Fingerprinting above). The latter can be skipped by setting ENV var `CI` to `true`.
 
 Tests are run in the display set by the `DISPLAY` env var, usually :0 by default. To run headless tests, set it to another value:
 
@@ -174,10 +176,6 @@ Tests are run in the display set by the `DISPLAY` env var, usually :0 by default
 
 If you find driver instantiation failing with port bind failure error messages ( these include "Address already in use. Is Tor already running?") check you have no other tor processes running with conflicting ports. With timeout errors, you may also want to check the Tor network is actually up, it isn't always..
 
-If you wish run the `vglrun` WebGL fingerprint test install VirtualGL (see above, assumes you have the relevent drivers installed) and run the following command:
-
-    $ DISPLAY=:99 vglrun bundle exec ruby test/features/fingerprinting/vglrun_test_fingerprintjs.rb
-
 ## Development
 
 You can run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -2,6 +2,7 @@
 
 require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'rubocop/rake_task'
 
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
@@ -10,8 +11,6 @@ Rake::TestTask.new(:test) do |t|
   # t.warning = false
 end
 
-require 'rubocop/rake_task'
-
 RuboCop::RakeTask.new
 
 task default: %i[test rubocop]

data/fonts/000_README.txt

@@ -2,6 +2,5 @@ DO NOT MODIFY THE CONTENTS OF THIS DIRECTORY
 
 Any adjustment to bundled fonts will result in an altered fingerprint. Font
 fingerprinting is more than just detecting what fonts you have, it also includes
-font fallbacks and characters (unicode code points) and any change in those can
+font fallbacks and characters (Unicode code points) and any change in those can
 be measured.
-