Knapcode.TorSharp 2.8.1

Install-Package Knapcode.TorSharp -Version 2.8.1
dotnet add package Knapcode.TorSharp --version 2.8.1
<PackageReference Include="Knapcode.TorSharp" Version="2.8.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Knapcode.TorSharp --version 2.8.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Knapcode.TorSharp, 2.8.1"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Knapcode.TorSharp as a Cake Addin
#addin nuget:?package=Knapcode.TorSharp&version=2.8.1

// Install Knapcode.TorSharp as a Cake Tool
#tool nuget:?package=Knapcode.TorSharp&version=2.8.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

TorSharp

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

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

NuGet downloads Build

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
    • ❌ Mac OS X support is not planned. I don't have a Mac 😕
  • 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"),
   PrivoxySettings = { Port = 1337 },
   TorSettings =
   {
      SocksPort = 1338,
      ControlPort = 1339,
      ControlPassword = "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.PrivoxySettings.Port))
};
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 installing missing dependencies.

It's possible some expected shared libraries aren't there. Try to look at the error message and judge which library needs to be installed from your distro's package repository.

Debian 10

This includes Microsoft's .NET Core 3.1 runtime image mcr.microsoft.com/dotnet/core/runtime:3.1 and Microsoft's .NET 5.0 runtime image mcr.microsoft.com/dotnet/runtime:5.0.

Problem: On Debian 10 the following errors may appear:

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

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

Solution: install two missing dependencies. Thanks for the heads up, @cod3rshotout!

[joel@debian10]$ sudo apt-get install -y libbrotli1 libmbedtls-dev

Privoxy fetched by TorSharp fails to start? Try ExecutablePathOverride.

On Linux, the Privoxy binaries fetched seem to be built for the latest Debian and Ubuntu distributions. I can confirm that some other distributions don't work.

I'm no Linux expert but my guess is that there are missing shared libraries that are different on the running platform than the Debian platform that Privoxy was compiled for. 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).

After you install it, make sure privoxy is in the PATH.

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

After this is done, just configure TorSharp to use the system Privoxy with the ExecutablePathOverride setting:

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

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

Problem: 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

Solution: install Privoxy. It is available on epel-release.

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

This includes Microsoft's .NET Core 2.1 runtime image: mcr.microsoft.com/dotnet/core/runtime:2.1.

Problem: the following errors may appear:

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

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

Solution: install Privoxy. It is available in the default source lists.

[joel@debian9]$ sudo apt-get install privoxy -y

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.8.1 1,599 6/17/2021
2.8.0 456 5/26/2021
2.7.0 515 5/20/2021
2.6.0 1,178 3/7/2021
2.5.0 2,439 12/16/2020
2.4.0 596 11/28/2020
2.3.0 307 11/20/2020
2.2.0 3,925 11/24/2019
2.1.0 374 11/11/2019
2.0.1 418 10/5/2019
2.0.0 407 9/10/2019
2.0.0-beta1 311 9/7/2019
1.9.1 404 8/31/2019
1.9.0 435 7/22/2019
1.8.6 409 7/6/2019
1.8.5 972 1/23/2019
1.8.4 818 10/13/2018
1.8.3 1,099 3/28/2018
1.8.2 745 3/4/2018
1.8.1 669 3/3/2018
1.8.0 775 2/11/2018
1.7.0 859 12/31/2017
1.6.2 970 11/20/2017
1.6.1 968 7/29/2017
1.6.0 1,125 12/3/2016
1.5.3 1,161 7/17/2016
1.5.2 815 4/23/2016
1.5.1 723 4/20/2016
1.5.0 2,528 2/14/2016
1.4.0 766 2/9/2016
1.3.1 1,016 12/4/2015
1.3.0 886 8/24/2015
1.2.0 772 8/23/2015
1.1.0 769 8/22/2015
1.0.0 1,017 8/4/2015

* 2.8.1 Fix potential deadlock in UI apps due to unnecessary Task.Yield.
* 2.8.0 Add HttpTunnelPort Tor setting, use tor-win64, add .NET Framework 4.7.2 target.
* 2.7.0 Separate proxy Configure and Start steps, support old behavior with extension method.
* 2.6.0 Make SendCommandAsync public and add AdditionalSocksPorts.
* 2.5.0 Don't try to use virtual desktops on Windows 7 or earlier.
* 2.4.0 Add support for custom Tor bridges, allow configurable max Privoxy connections.
* 2.3.0 Add support for Tor bridges (e.g. obfs4).
* 2.2.0 Add Tor control methods to get traffic read and written, fix config bug.
* 2.1.0 Allow override of executable paths (enables using tools from PATH).
* 2.0.1 Fix bug in Windows Privoxy zipped tool prefix (was "win32", should be "win32-").
* 2.0.0 Add support .NET Core on Linux.
* 2.0.0-beta1 Add support for .NET Core on Windows.
* 1.9.1 Fix null reference exception in TorControlClient.Dispose().
* 1.9.0 Add UseExistingTools and CheckForUpdatesAsync so that TorSharpToolFetcher can not download so much.
* 1.8.6 Improve error experience when one of the tool ZIP files is invalid.
* 1.8.5 Add ListenAddress to TorSharpPrivoxySettings to allow external connections.
* 1.8.4 Improve missing tool message and don't fail due to a SecurityProtocolType not being supported.
* 1.8.3 Ignore version directories that don't just have digits.
* 1.8.2 Enable three different ways of downloading Privoxy. Fastest one wins.
* 1.8.1 Use Privoxy RSS feed for fetching tools instead of SourceForge.
* 1.8.0 Add support for HTTPS proxy in Tor and organize TorSettings.
* 1.7.0 Default Tor DataDirectory to a path relative to the Tor executable.
* 1.6.2 Fix a bug where ToolRunnerType.VirtualDesktop was breaking on Windows 10 (version 1709).
* 1.6.1 Fix a bug in the Tor fetcher caused by Tor versions with no Windows build.
* 1.6.0 Add configuration API for tor exit nodes.
* 1.5.3 Fix P/Invoke stubs to work on x64 so ToolRunnerType.VirtualDesktop works.
* 1.5.2 Paths now fully work when they have spaces in them.
* 1.5.1 Fix bug where usernames with spaces in them are not supported.
* 1.5.0 Hash Tor passwords in process (by duplicating the hash algorithm).
* 1.4.0 Add tool runner without jobs, configure Tor data directory, fix file system race condition.
* 1.3.1 Fix dispose issue in TorControlClient.
* 1.3.0 Extract interfaces and rename ToolFetcher to TorSharpToolFetcher.
* 1.2.0 Add tool to download the latest Tor and Privoxy.
* 1.1.0 Target .NET 4.5 instead of .NET 4.5.2.
* 1.0.0 Initial release.