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.5.tar.gz (88.8 kB view details)

Uploaded Source

Built Distribution

sshuttle-1.0.5-py2.py3-none-any.whl (65.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: sshuttle-1.0.5.tar.gz
  • Upload date:
  • Size: 88.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.4.2 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.8.0 tqdm/4.51.0 CPython/3.9.1

File hashes

Hashes for sshuttle-1.0.5.tar.gz
Algorithm Hash digest
SHA256 fd8c691aac2cb80933aae7f94d9d9e271a820efc5c48e73408f1a90da426a1bd
MD5 10c9765f2cc2a3e3e080a4a218428cc4
BLAKE2b-256 e94b51d6aaa900a6a13efb380b0a084a327c41aad28a267d4c1f074cb2e41baa

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sshuttle-1.0.5-py2.py3-none-any.whl
  • Upload date:
  • Size: 65.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.4.2 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.8.0 tqdm/4.51.0 CPython/3.9.1

File hashes

Hashes for sshuttle-1.0.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 686a0e917d315eec4b00984c9921705866376a83f3440347debc9c44ab07e9ee
MD5 76e6127f3f7c566e5aa788737436ae71
BLAKE2b-256 7e6b924aeb2cb16e5030d7cb90cb10a8037f6af6030f00f36bec3b50717881f6

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