Skip to main content

Full-featured" VPN over an SSH tunnel

Project description

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.

Obtaining sshuttle

  • Ubuntu 16.04 or later:

    apt-get install 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/

Running as a service

Sshuttle can also be run as a service and configured using a config management system: https://medium.com/@mike.reider/using-sshuttle-as-a-service-bec2684a65fe

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sshuttle-1.0.4.tar.gz (82.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sshuttle-1.0.4-py2.py3-none-any.whl (59.8 kB view details)

Uploaded Python 2Python 3

File details

Details for the file sshuttle-1.0.4.tar.gz.

File metadata

  • Download URL: sshuttle-1.0.4.tar.gz
  • Upload date:
  • Size: 82.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.4.2 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.8.0 tqdm/4.48.1 CPython/3.8.5

File hashes

Hashes for sshuttle-1.0.4.tar.gz
Algorithm Hash digest
SHA256 21a11f3f0f710de92241d8ffca58bebb969f689f650d59e97ba366d7407e16e5
MD5 282b2d24521f9e44865025f51098a41a
BLAKE2b-256 ee5d8eb1de9ed90732309cc8c64256d2e35de3f269713d707e1074a37d794665

See more details on using hashes here.

File details

Details for the file sshuttle-1.0.4-py2.py3-none-any.whl.

File metadata

  • Download URL: sshuttle-1.0.4-py2.py3-none-any.whl
  • Upload date:
  • Size: 59.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.4.2 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.8.0 tqdm/4.48.1 CPython/3.8.5

File hashes

Hashes for sshuttle-1.0.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b53e8f7422eb06d80f9dea4708ca2bf1f0fabab4f7e7655a720223b194f695e3
MD5 662f51ad956eb74b19f802207b560b36
BLAKE2b-256 bb1958ec3a22de4ac872b0fa2890131c1119d42549b4fcd9e96889210399e0e8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page