sshuttle

mirror of https://github.com/sshuttle/sshuttle.git synced 2024-11-25 09:23:48 +01: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

Nathan Aclander ad31ac4e18 Link Directly to TCP Over TCP Explanation See Below was confusing because it linked to the entire documentation section. This provides a direct link to the section explaining why TCP over TCP is a bad idea.		2019-12-13 15:56:57 +11:00
bin	Auto sudoers file (#269 )	2019-12-13 08:15:31 +11:00
docs	Auto sudoers file (#269 )	2019-12-13 08:15:31 +11:00
sshuttle	Auto sudoers file (#269 )	2019-12-13 08:15:31 +11:00
tests	Add tproxy udp port mark filter that was missed in #144 , fixes #367 .	2019-10-13 11:45:04 +11:00
.gitignore	Add entries to .gitignore	2018-03-16 18:10:09 +11:00
.prospector.yml	Fixes some style issues and minor bugs	2017-11-13 11:58:43 +11:00
.travis.yml	Fix/pep8 (#277 )	2019-02-11 09:59:13 +11:00
bandit.yml	updated bandit config	2018-10-17 20:52:04 +11:00
CHANGES.rst	Release 0.78.5	2019-01-28 16:28:57 +13: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	Link Directly to TCP Over TCP Explanation	2019-12-13 15:56:57 +11:00
requirements-tests.txt	Lock version of attrs	2019-10-03 11:08:39 +10:00
requirements.txt	Pin version in requirements.txt	2017-07-09 09:08:48 +10:00
run	Auto sudoers file (#269 )	2019-12-13 08:15:31 +11:00
setup.cfg	Fix/pep8 (#277 )	2019-02-11 09:59:13 +11:00
setup.py	Auto sudoers file (#269 )	2019-12-13 08:15:31 +11:00
tox.ini	Fix/pep8 (#277 )	2019-02-11 09:59:13 +11: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`_.
  
.. _terrible performance: https://sshuttle.readthedocs.io/en/stable/how-it-works.html

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

- Debian stretch or later::

      apt-get install sshuttle
      
- Arch Linux::

      pacman -S sshuttle

- Fedora::

      dnf install sshuttle

- NixOS::

      nix-env -iA nixos.sshuttle

- From PyPI::

      sudo pip install sshuttle

- Clone::

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

- FreeBSD::

      # ports
      cd /usr/ports/net/py-sshuttle && make install clean
      # pkg
      pkg install py36-sshuttle

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

- Nix::

      nix-env -iA nixpkgs.sshuttle


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

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