Skip to main content

Transparent proxy server that works as a poor man's VPN. Forwards over ssh. Doesn't require admin. Works with Linux and MacOS. Supports DNS tunneling.

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 py39-sshuttle
  • OpenBSD:

    pkg_add 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.2.tar.gz (59.5 kB view details)

Uploaded Source

Built Distribution

sshuttle-1.1.2-py3-none-any.whl (68.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sshuttle-1.1.2.tar.gz
  • Upload date:
  • Size: 59.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.6

File hashes

Hashes for sshuttle-1.1.2.tar.gz
Algorithm Hash digest
SHA256 f1f82bc59c45745df7543f38b0fa0f1a6a34d8a9e17dd8d9e5e259f069c763d6
MD5 1c7bf12ae8ed576b16d1e2b144835863
BLAKE2b-256 946ef9a1fb50cd034cac1ee4efd017a9873301f75103271205a8f1c411a9fb1e

See more details on using hashes here.

File details

Details for the file sshuttle-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: sshuttle-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 68.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.6

File hashes

Hashes for sshuttle-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c258cdbee134b14e50a14504ca9657acc58c9fa033abdaee2d836c80768552c7
MD5 05a2e644d49dc9b600ab2c2705165a86
BLAKE2b-256 61b9c540dd460d8da3bdea1d8b865d7c9d896a1b0761ffc01378ca7a3fa0abf2

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