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
  • openSUSE:

    zypper in sshuttle
  • Gentoo:

    emerge -av net-proxy/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
  • macOS, via MacPorts:

    sudo port selfupdate
    sudo port install 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.1.0.tar.gz (94.0 kB view details)

Uploaded Source

Built Distribution

sshuttle-1.1.0-py2.py3-none-any.whl (70.6 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: sshuttle-1.1.0.tar.gz
  • Upload date:
  • Size: 94.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.2

File hashes

Hashes for sshuttle-1.1.0.tar.gz
Algorithm Hash digest
SHA256 21fb91bdf392b50e78db6b8d75e95b73ac9dafd361e2657e784e674561219315
MD5 86d3002a843691f4f0418afd7ffcac8a
BLAKE2b-256 c5a16691395e9b3ad453947fea7192744f316ba3d020d295370db55ba0b48573

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sshuttle-1.1.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 70.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.2

File hashes

Hashes for sshuttle-1.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 44671daf6012ecc9b4ebcd5ac9784c32ec5a0f4a38bbad8df60d5171f3cf9413
MD5 acbc70412a5a0ec29be70a5ed5400a23
BLAKE2b-256 d29566aae871aade1f08e2da3a98e5706bfff612723f7ad402e213e9d679b79b

See more details on using hashes here.

Supported by

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