Skip to content
This repository

transparent redirector of any TCP connection to proxy

tag: release-0.3

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 debian Update redsocks.conf samples. January 03, 2012
Octocat-spinner-32 doc
Octocat-spinner-32 .gitignore added .depend to .gitignore November 11, 2010
Octocat-spinner-32 Makefile
Octocat-spinner-32 README
Octocat-spinner-32 README.html
Octocat-spinner-32 base.c Change license to Apache 2.0 to ensure compatibility with android stack. April 20, 2011
Octocat-spinner-32 base.h Whitespace fixes. July 13, 2008
Octocat-spinner-32 base64.c add base64 and md5 library for http auth November 14, 2010
Octocat-spinner-32 base64.h minor fixes November 14, 2010
Octocat-spinner-32 dnstc.c
Octocat-spinner-32 dnstc.h Added dnstc service that serves any UDP DNS-like request with TC flag. September 22, 2011
Octocat-spinner-32 http-auth.c Change license to Apache 2.0 to ensure compatibility with android stack. April 20, 2011
Octocat-spinner-32 http-auth.h remove time limit between consective attempts November 19, 2010
Octocat-spinner-32 http-connect.c
Octocat-spinner-32 http-relay.c
Octocat-spinner-32 list.h Whitespace fixes. July 13, 2008
Octocat-spinner-32 log.c redsocks now compiles with libevent-2.0 August 01, 2011
Octocat-spinner-32 log.h Fixed format string bug. May 21, 2009
Octocat-spinner-32 main.c Added -h, -? CLI options for help & -v for redsocks-version. November 27, 2011
Octocat-spinner-32 main.h Whitespace fixes. July 13, 2008
Octocat-spinner-32 md5.c add base64 and md5 library for http auth November 14, 2010
Octocat-spinner-32 md5.h add base64 and md5 library for http auth November 14, 2010
Octocat-spinner-32 parser.c
Octocat-spinner-32 parser.h Added ability to create many redsocks config sections to have many re… August 18, 2008
Octocat-spinner-32 reddns.c Change license to Apache 2.0 to ensure compatibility with android stack. April 20, 2011
Octocat-spinner-32 redsocks.c
Octocat-spinner-32 redsocks.conf.example
Octocat-spinner-32 redsocks.h
Octocat-spinner-32 redudp.c
Octocat-spinner-32 redudp.h
Octocat-spinner-32 socks4.c Change license to Apache 2.0 to ensure compatibility with android stack. April 20, 2011
Octocat-spinner-32 socks5.c Change license to Apache 2.0 to ensure compatibility with android stack. April 20, 2011
Octocat-spinner-32 socks5.h Cleanup: make socks5 structures reusable. December 02, 2010
Octocat-spinner-32 utils.c
Octocat-spinner-32 utils.h
Octocat-spinner-32 version.h Added -h, -? CLI options for help & -v for redsocks-version. November 27, 2011
README
This tool allows you to redirect any TCP connection to SOCKS or HTTPS
proxy using your firewall, so redirection is system-wide.

Why is that useful? I can suggest following reasons:
* you use tor[1] and don't want any TCP connection to leak.
* you use DVB ISP and this ISP provides internet connectivity with some
  special daemon that may be also called "Internet accelerator" and this
  accelerator acts as proxy. Globax[2] is example of such an accelerator.

Linux/iptables, OpenBSD/pf and FreeBSD/ipfw are supported.
Linux/iptables is well-tested, other implementations may have bugs,
your bugreports are welcome.

Transocks[3] is alike project but it has noticable performance penality.

Transsocks_ev[4] is alike project too, but it has no HTTPS-proxy support
and does not support authentication.

Several Andoird apps also use redsocks under-the-hood: ProxyDroid[5][6] and
sshtunnel[7][8]. And that's over 100'000 downloads! Wow!

[1] http://www.torproject.org
[2] http://www.globax.biz
[3] http://transocks.sourceforge.net/
[4] http://oss.tiggerswelt.net/transocks_ev/
[5] http://code.google.com/p/proxydroid/
[6] https://market.android.com/details?id=org.proxydroid
[7] http://code.google.com/p/sshtunnel/
[8] https://market.android.com/details?id=org.sshtunnel


Another related issue is DNS over TCP. Redsocks includes `dnstc' that is fake
and really dumb DNS server that returns "truncated answer" to every query via
UDP. RFC-compliant resolver should repeat same query via TCP in this case - so
the request can be redirected using usual redsocks facilities.

Known compliant resolvers are:
 * bind9 (server)
 * dig, nslookup (tools based on bind9 code)
Known non-compliant resolvers are:
 * eglibc resolver fails without any attempt to send request via TCP
 * powerdns-recursor can't properly startup without UDP connectivity as it
   can't load root hints

On the other hand, DNS via TCP using bind9 may be painfully slow. If your bind9
setup is really slow, you have at least two options: pdnsd[9] caching server
can run in TCP-only mode, ttdnsd[10][11] has no cache but can be useful for same
purpose.

[9] http://www.phys.uu.nl/~rombouts/pdnsd.html
[10] http://www.mulliner.org/collin/ttdnsd.php
[11] https://gitweb.torproject.org/ioerror/ttdnsd.git


Features
========

Redirect any TCP connection to SOCKS4, SOCKS5 or HTTPS (HTTP/CONNECT)
proxy server.

Login/password authentication is supported for SOCKS5/HTTPS connections.
SOCKS4 supports only username, password is ignored. for HTTPS, currently
only Basic and Digest scheme is supported.

Redirect UDP packets via SOCKS5 proxy server. NB: UDP still goes via UDP, so
you can't relay UDP via OpenSSH.

Sends "truncated reply" as an answer to UDP DNS queries.

Redirect any HTTP connection to proxy that does not support transparent
proxying (e.g. old SQUID had broken `acl myport' for such connections).


License
=======

All source code is licensed under Apache 2.0 license.
You can get a copy at http://www.apache.org/licenses/LICENSE-2.0.html


Compilation
===========

libevent[5] is required.

gcc and clang are supported right now, other compilers can be used
but may require some code changes.

Compilation is as easy as running `make', there is no `./configure' magic.

GNU Make works, other implementations of make were not tested.

[5] http://libevent.org/ || http://www.monkey.org/~provos/libevent/


Running
=======

Program has following command-line options:
 -c   sets proper path to config file ("./redsocks.conf" is default one)
 -t   tests config file syntax
 -p   set a file to write the getpid() into

Following signals are understood:
SIGUSR1 dumps list of connected clients to log
SIGTERM and SIGINT terminates daemon, all active connections are closed

You can see configuration file example in redsocks.conf.example


iptables example
================

You have to build iptables with connection tracking and REDIRECT target.

# Create new chain
iptables -t nat -N REDSOCKS

# Ignore LANs and some other reserved addresses.
iptables -t nat -A REDSOCKS -d 0.0.0.0/8 -j RETURN
iptables -t nat -A REDSOCKS -d 10.0.0.0/8 -j RETURN
iptables -t nat -A REDSOCKS -d 127.0.0.0/8 -j RETURN
iptables -t nat -A REDSOCKS -d 169.254.0.0/16 -j RETURN
iptables -t nat -A REDSOCKS -d 172.16.0.0/12 -j RETURN
iptables -t nat -A REDSOCKS -d 192.168.0.0/16 -j RETURN
iptables -t nat -A REDSOCKS -d 224.0.0.0/4 -j RETURN
iptables -t nat -A REDSOCKS -d 240.0.0.0/4 -j RETURN

# Anything else should be redirected to port 12345
iptables -t nat -A REDSOCKS -p tcp -j REDIRECT --to-ports 12345

# Any tcp connection made by `darkk' should be redirected.
iptables -t nat -A OUTPUT -p tcp -m owner --uid-owner darkk -j REDSOCKS


Homepage
========

http://darkk.net.ru/redsocks/

Mailing list: redsocks@librelist.com

Mailing list also has archives[1].

[1] http://librelist.com/browser/redsocks/


TODO
====

Test OpenBSD (pf) and FreeBSD (ipfw) and write setup examples for those
firewall types.


Author
======
This program was written by Leonid Evdokimov <leon@darkk.net.ru>
Something went wrong with that request. Please try again.