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

  • 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.3.tar.gz (79.2 kB view details)

Uploaded Source

Built Distribution

sshuttle-1.0.3-py2.py3-none-any.whl (59.6 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: sshuttle-1.0.3.tar.gz
  • Upload date:
  • Size: 79.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.4.2 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for sshuttle-1.0.3.tar.gz
Algorithm Hash digest
SHA256 0fff1c88669a20bb6a4e7331960673a3a02a2e04ff163e4c9299496646edcf61
MD5 14dde813e34608c25c6e4176a6f37e9f
BLAKE2b-256 f7aedc2da4e21e142db350ba6050d88afc0b1001c5c236620a7420eda0ef3351

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sshuttle-1.0.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 59.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.4.2 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for sshuttle-1.0.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0165d576b8d2f8c0c07f857314396f0b8159b0be97e19ef41ed11493de78f112
MD5 47e2c9011674ae249db25cdd5653a50c
BLAKE2b-256 96684043605aa0f0784b9433824d33b4cd54357a7e3b7996bacc0d6d4133ba77

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