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.1.tar.gz (79.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.1-py2.py3-none-any.whl (59.7 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: sshuttle-1.0.1.tar.gz
  • Upload date:
  • Size: 79.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.7.3

File hashes

Hashes for sshuttle-1.0.1.tar.gz
Algorithm Hash digest
SHA256 84427797f75958361dd06327a33e80845abb2b0b5fec871bec1a1ba46e1ad7bc
MD5 2005b4701e70c4a510257eb0e074d08f
BLAKE2b-256 322e636c88f6e034674113b5814ca614234ac4469e11c37b633c63a66110f893

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sshuttle-1.0.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 59.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.7.3

File hashes

Hashes for sshuttle-1.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0c0472fb952e80d314e0ff480cde383ea7a981886a73aa9d9481ea561367fc41
MD5 7794bce978bfe1b8a18c4dc0402cfafb
BLAKE2b-256 68ccef87853fa96880911e671cf0036659d9395978be5393aac771979cb673ca

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