tr002196 / TorSharp

Use Tor for your C# HTTP clients. Tor + Privoxy = :heart:

TorSharp

Use Tor for your C# HTTP clients. Tor + Privoxy = ❤️

All you need is client code that can use a simple HTTP proxy.

CI	OS	Status
AppVeyor	Windows
Travis CI	Linux

Notice

This product is produced independently from the Tor® anonymity software and carries no guarantee from The Tor Project about quality, suitability or anything else.

Details

• Supports:
  • .NET Core (.NET Standard 2.0 and later)
  • .NET Framework (.NET Framework 4.5 and later)
  • Windows
    • ✔️ Windows 10 version 1903
    • Older Windows should work too
  • Linux
    • ✔️ Ubuntu 18.04
    • ✔️ Ubuntu 16.04
    • ✔️ Debian 10
    • ✔️ Debian 9 (confirmed by user)
    • ⚠️ CentOS 7 supported via ExecutablePathOverride (see below)
  • ❌ Mac OS X support is not planned.
• Uses Privoxy to redirect HTTP proxy traffic to Tor.
• Uses virtual desktops to manage Tor and Privoxy processes.
• Optionally downloads the latest version of Tor and Privoxy.

Install

Install-Package Knapcode.TorSharp

Example

// configure
var settings = new TorSharpSettings
{
    ZippedToolsDirectory = Path.Combine(Path.GetTempPath(), "TorZipped"),
    ExtractedToolsDirectory = Path.Combine(Path.GetTempPath(), "TorExtracted"),
    PrivoxyPort = 1337,
    TorSocksPort = 1338,
    TorControlPort = 1339,
    TorControlPassword = "foobar"
};

// download tools
await new TorSharpToolFetcher(settings, new HttpClient()).FetchAsync();

// execute
var proxy = new TorSharpProxy(settings);
var handler = new HttpClientHandler
{
    Proxy = new WebProxy(new Uri("http://localhost:" + settings.PrivoxyPort))
};
var httpClient = new HttpClient(handler);
await proxy.ConfigureAndStartAsync();
Console.WriteLine(await httpClient.GetStringAsync("http://api.ipify.org"));
await proxy.GetNewIdentityAsync();
Console.WriteLine(await httpClient.GetStringAsync("http://api.ipify.org"));
proxy.Stop();

FAQ

The tool fetcher is throwing an exception. What do I do?

This most likely is happening because the URLs where we fetch Tor or Privoxy from are down or have changed. I would recommend:

1. Open an issue so I can look into it.

2. Work around the issue by setting up the tools manually and not using TorSharpToolFetcher. See below.

3. Investigate the issue yourself. The TorSharp.Sandbox project is helpful for this. Pull requests accepted 🏆.

How do I set up the tools manually?

If you don't want to use the TorSharpToolFetcher to download the latest version of the tools for you or if you want to use a specific version of Tor and Privoxy, follow these steps.

1. Make a directory that will hold the zipped Tor and Privoxy binaries.
2. Put a Tor Win32 ZIP in that folder with the file name like: tor-win32-{version}.zip
   • {version} must be parsable as a System.Version meaning it is major.minor[.build[.revision]].
   • Example: tor-win32-0.3.5.8.zip
   • The ZIP is expected to have Tor\tor.exe.
3. Put a Privoxy Win32 ZIP in that folder with a file name like: privoxy-win32-{version}.zip
   • Again, {version} must be parsable as a System.Version.
   • Example: privoxy-win32-3.0.26.zip
   • The ZIP is expected to have privoxy.exe.
4. Initialize a TorSharpSettings instance where ZippedToolsDirectory is the directory created above.
5. Pass this settings instance to the TorSharpProxy constructor.

Privoxy fetched by TorSharp fails to start? Try ExecutablePathOverride.

On Linux, the Privoxy binaries fetched seem to be built for Debian and Ubuntu distributions. I can confirm that some other distributions don't work. For example, on CentOS 7 the following error appears:

/tmp/TorExtracted/privoxy-linux64-3.0.28/usr/sbin/privoxy: error while loading shared libraries: libpcre.so.3: cannot open shared object file: No such file or directory

I'm no Linux expert but my guess is that the version of PCRE on CentOS 7 vs. Ubuntu is different so at runtime the library can't be found on CentOS. The easiest workaround is to install Privoxy to your system and set the TorSharpSettings.PrivoxySetting.ExecutablePathOverride configuration setting to "privoxy" (i.e. use Privoxy from PATH).

Note that you may encounter warning or error messages in the output due to new configuration being used with an older executable. I haven't ran into any problems with this myself but it's possible things could get weird.

CentOS 7

Install Privoxy. It is available on epel-release.

[joel@centos]$ sudo yum install epel-release -y
...
[joel@centos]$ sudo yum install privoxy -y

Ensure Privoxy is available in PATH.

[joel@centos]$ which privoxy
/usr/sbin/privoxy

Set the Privoxy ExecutablePathOverride to "privoxy".

var settings = new TorSharpSettings();
settings.PrivoxySettings.ExecutablePathOverride = "privoxy";