Skip to content

Latest commit

 

History

History
56 lines (42 loc) · 3.26 KB

README.md

File metadata and controls

56 lines (42 loc) · 3.26 KB

TorRelayScannerCS

C# implementation of Tor-relay-scanner by ValdikSS

Attempts to download information about all tor relays, from official site and through mirrors embedded in the code Attempts to ping them and find reachable ones to be used as bridges to access Tor network even in banned regions

Supported platforms

Currently tested only on Windows 10 x64.

Basic functionality should be available on Linux, tor location autodetection probably doesnt work

If anyone can test it on Linux, would be much appreciated

How to use

Description:
  Automatically retrieves information about tor relays and scans them for reachability

Usage:
  TorRelayScannerCS [options]

Options:
  -n <n>                                 The number of concurrent relays tested [default: 50]
  -g <g>                                 Test until at least this number of working relays are found [default: 3]
  -c <c>                                 Include only following countries for testing, exclude by adding '-'. Example: nl,de (only netherlands and germany) Example exclude: -nl (not netherlands) []
  --timeout <timeout>                    Socket connection timeout in milliseconds [default: 500]
  -o <o>                                 Output reachable relays to file []
  --torrc                                Output reachable relays in torrc format (with "Bridge" prefix) [default: False]
  --proxy <proxy>                        Set proxy for onionoo information download. Format: http://user:pass@host:port; socks5h://user:pass@host:port []
  --url <url>                            Preferred alternative URL for onionoo relay list. Could be used multiple times. []
  -p <p>                                 Scan for relays running on specified port number. Could be used multiple times. []
  --browser-location <browser-location>  Tor browser executable location []
  --not-install-bridges                  Not install bridges into Tor browser [default: False]
  --not-start-browser                    Not launch browser after scanning [default: False]
  --use-outdated                         Use already existing outdated relay info [default: False]
  --version                              Show version information
  -?, -h, --help                         Show help and usage information

Note: browser-location is exptected to contain an executable inside, by default on windows is usually: C:\Users\user\Desktop\Tor Browser\Browser (e.g Tor Browser\Browser in Desktop)

Behaviour difference compared to original program

Downloaded relay info is saved into the file in the same directory as the program (relay-info.json file). Program tries to use this already downloaded information first. If information in the file is >=1 days older, program tries to download fresh copy. If you wish to use already existing outdated file, add --use-outdated flag.

Different logging format.

Browser location is not required, program tries to auto-detect it by enumerating special paths and (only on windows) searching for tor browser launcher key in registry.

install-bridges and start-browser turned to not-install-bridges and not-start-browser.

behaviour by default install bridges and start the browser.

-c argument doesnt support preffered countries, only include or exclude.