sshuttle

mirror of https://github.com/sshuttle/sshuttle.git synced 2025-05-05 16:44:40 +02:00

Transparent proxy server that works as a poor man's VPN. Forwards over ssh. Doesn't require admin. Works with Linux and MacOS. Supports DNS tunneling.

Go to file

Quentin Santos 93b969a049 Fix compatibility with the sudoers file Starting sshuttle without having to type in one's password requires to put the sudo-ed command in the `/etc/sudoers` file. However, sshuttle sets an environment variable, which cannot be done as-is in the sudoers file. This fix prepend the /usr/bin/env command, which allows one to pass fixed environment variables to a sudo-ed command. In practice, the sub-command: ``` sudo PYTHONPATH=/usr/lib/python3/dist-packages -- \ /usr/bin/python3 /usr/bin/sshuttle --method auto --firewall ``` becomes ``` sudo /usr/bin/env PYTHONPATH=/usr/lib/python3/dist-packages \ /usr/bin/python3 /usr/bin/sshuttle --method auto --firewall ```		2018-02-16 08:07:02 +11:00
docs	Adds 'cd sshuttle' after 'git' to README and docs	2018-02-15 07:37:15 +11:00
sshuttle	Fix compatibility with the sudoers file	2018-02-16 08:07:02 +11:00
.gitignore	Fix error in requirements.rst	2017-07-09 09:08:48 +10:00
.prospector.yml	Fixes some style issues and minor bugs	2017-11-13 11:58:43 +11:00
.travis.yml	Backward compatibility with Python 2.4 (server)	2016-04-03 13:14:02 +10:00
bandit.yml	Use more standard filename and format for bandit conifguration	2017-11-13 11:58:43 +11:00
CHANGES.rst	Add changelog entry about fixed license	2017-11-16 19:57:33 +11:00
conftest.py	Backward compatibility with Python 2.4 (server)	2016-04-03 13:14:02 +10:00
LICENSE	Fix LGPL2 license.	2016-03-07 10:03:22 +11:00
MANIFEST.in	Fix error in requirements.rst	2017-07-09 09:08:48 +10:00
README.rst	Adds 'cd sshuttle' after 'git' to README and docs	2018-02-15 07:37:15 +11:00
requirements.txt	Pin version in requirements.txt	2017-07-09 09:08:48 +10:00
run	turn off debugging	2017-10-23 06:58:21 +11:00
setup.cfg	Update setup.cfg	2017-07-09 09:08:48 +10:00
setup.py	Remove trailing whitespace	2017-11-16 18:06:33 +11:00
tox.ini	Backward compatibility with Python 2.4 (server)	2016-04-03 13:14:02 +10:00

README.rst

sshuttle: where transparent proxy meets VPN meets ssh
=====================================================

As far as I know, sshuttle is the only program that solves the following
common case:

- Your client machine (or router) is Linux, FreeBSD, or MacOS.

- You have access to a remote network via ssh.

- You don't necessarily have admin access on the remote network.

- The remote network has no VPN, or only stupid/complex VPN
  protocols (IPsec, PPTP, etc). Or maybe you *are* the
  admin and you just got frustrated with the awful state of
  VPN tools.

- You don't want to create an ssh port forward for every
  single host/port on the remote network.

- You hate openssh's port forwarding because it's randomly
  slow and/or stupid.

- You can't use openssh's PermitTunnel feature because
  it's disabled by default on openssh servers; plus it does
  TCP-over-TCP, which has terrible performance (see below).


Obtaining sshuttle
------------------

- Debian stretch or later::

      apt-get install sshuttle

- From PyPI::

      sudo pip install sshuttle

- Clone::

      git clone https://github.com/sshuttle/sshuttle.git
      cd sshuttle
      sudo ./setup.py install

It is also possible to install into a virtualenv as a non-root user.

- From PyPI::

      virtualenv -p python3 /tmp/sshuttle
      . /tmp/sshuttle/bin/activate
      pip install sshuttle

- Clone::

      virtualenv -p python3 /tmp/sshuttle
      . /tmp/sshuttle/bin/activate
      git clone https://github.com/sshuttle/sshuttle.git
      cd sshuttle
      ./setup.py install

- Homebrew::

      brew install sshuttle


Documentation
-------------
The documentation for the stable version is available at:
http://sshuttle.readthedocs.org/

The documentation for the latest development version is available at:
http://sshuttle.readthedocs.org/en/latest/