Skip to main content

SNI-based TLS reverse proxy with termination and passthrough modes

Project description

tls-switch

A TLS reverse proxy that routes incoming TLS connections to backend servers based on the requested hostname using SNI (Server Name Indication). Supports both TLS termination and TLS passthrough on a per-host basis.

tls-switch sits in front of your services on port 443 and inspects the TLS ClientHello to determine which hostname the client is requesting. SNI is a TLS extension that allows the client to indicate which hostname it is trying to connect to before the TLS handshake completes — this is how tls-switch knows where to route the connection without needing a separate IP address per service. It then routes the connection to the appropriate backend, either terminating TLS and forwarding plaintext, or passing the encrypted stream through unmodified.

Features

  • SNI-based routing — route TLS connections to different backends based on hostname
  • TLS termination — terminate TLS with your certificates and forward plaintext to backends
  • TLS passthrough — forward the raw TLS stream to a backend that handles its own TLS
  • Hot reload — config and certificate changes take effect on new connections without interrupting existing ones
  • Zero buffering — data is forwarded immediately with no processing, filtering, or modification
  • Efficient — Go networking engine with zero-copy forwarding, Python CLI for configuration and management
  • Zero runtime dependencies — Python 3.12+ stdlib only, Go binary is statically linked

Use Cases

  • Run multiple HTTPS services on a single IP address, each with its own certificate
  • Put a TLS-terminating proxy in front of plain HTTP services
  • Route some domains through to their own TLS servers while terminating others locally
  • Consolidate port 443 across multiple services without a full reverse proxy

Requirements

  • Python 3.12+
  • Root/administrator privileges (if binding to port 443)

Installation

pip install tls-switch

Or run directly with uv:

uvx tls-switch

Quick Start

Create a config file (config.json):

{
  "listen": ":443",
  "hosts": {
    "app.example.com": {
      "mode": "terminate",
      "cert": "/etc/tls-switch/app.example.com.crt",
      "key": "/etc/tls-switch/app.example.com.key",
      "backend": "127.0.0.1:8080"
    },
    "legacy.example.com": {
      "mode": "passthrough",
      "backend": "10.0.0.5:443"
    }
  }
}

Run the server:

tls-switch -c config.json

In this example:

  • Connections to app.example.com have TLS terminated by tls-switch, and plaintext HTTP is forwarded to 127.0.0.1:8080
  • Connections to legacy.example.com are forwarded as raw TLS to 10.0.0.5:443, which handles its own certificates

How It Works

  1. A client connects to port 443 and begins a TLS handshake
  2. tls-switch reads the TLS ClientHello message and extracts the SNI (Server Name Indication) hostname
  3. The hostname is looked up in the configuration
  4. Depending on the mode:
    • terminate: tls-switch completes the TLS handshake using the configured certificate and key, then opens a plaintext TCP connection to the backend and copies data bidirectionally with no buffering or processing
    • passthrough: tls-switch opens a TCP connection to the backend, replays the original ClientHello, and then copies data bidirectionally — the backend server handles the TLS handshake itself
  5. If the hostname is not found in the configuration, tls-switch completes a TLS handshake using any available configured certificate and returns an HTTP 421 Misdirected Request error page — browsers display a clear error rather than a cryptic "can't connect" message

Configuration

Config File

The config file is JSON with the following structure:

{
  "listen": ":443",
  "hosts": {
    "hostname": {
      "mode": "terminate|passthrough",
      "cert": "/path/to/cert.pem",
      "key": "/path/to/key.pem",
      "backend": "host:port"
    }
  }
}
Field Description
listen Address to listen on (e.g. :443, 0.0.0.0:8443)
hosts Map of hostname to route configuration
mode terminate (TLS termination) or passthrough (forward raw TLS)
cert Path to PEM certificate file (terminate mode only)
key Path to PEM private key file (terminate mode only)
backend Backend address as host:port

Hot Reload

tls-switch watches the config file and certificate files for changes. When a change is detected:

  • The new config is validated
  • If valid, new connections use the updated config
  • Existing connections continue with their original config until they close naturally
  • If invalid, the change is rejected and the current config remains active

Development

# Set up development environment
make dev

# Cross-compile Go binaries
make go-build

# Run linting and type checking
make check

# Auto-format code
make format

# Build wheel and docs
make build

Architecture

tls-switch is a Python+Go hybrid:

  • Go handles all networking — TCP listener, TLS handshakes, SNI extraction, and bidirectional data forwarding. It runs as a persistent subprocess communicating with Python via JSON Lines over stdin/stdout.
  • Python handles everything user-facing — CLI, config file parsing and validation, certificate validation, file watching, and error reporting.

Licence

Released under the Unlicense — public domain.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

tls_switch-1.0.0b4-py3-none-win_arm64.whl (24.7 kB view details)

Uploaded Python 3Windows ARM64

tls_switch-1.0.0b4-py3-none-win_amd64.whl (24.7 kB view details)

Uploaded Python 3Windows x86-64

tls_switch-1.0.0b4-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (2.3 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

tls_switch-1.0.0b4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (24.8 kB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

tls_switch-1.0.0b4-py3-none-macosx_11_0_arm64.whl (24.7 kB view details)

Uploaded Python 3macOS 11.0+ ARM64

tls_switch-1.0.0b4-py3-none-macosx_10_12_x86_64.whl (24.7 kB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

Details for the file tls_switch-1.0.0b4-py3-none-win_arm64.whl.

File metadata

  • Download URL: tls_switch-1.0.0b4-py3-none-win_arm64.whl
  • Upload date:
  • Size: 24.7 kB
  • Tags: Python 3, Windows ARM64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for tls_switch-1.0.0b4-py3-none-win_arm64.whl
Algorithm Hash digest
SHA256 ec15d915b21e62ea0276ffc174028c0aa962221a1b6562f527cceb76c5d18821
MD5 2b937f59129bdf39a8d2aee788dfc90b
BLAKE2b-256 1604ead88b59f634e2740acc3268d44bae600d34fa15d6f62e177b0702416239

See more details on using hashes here.

File details

Details for the file tls_switch-1.0.0b4-py3-none-win_amd64.whl.

File metadata

  • Download URL: tls_switch-1.0.0b4-py3-none-win_amd64.whl
  • Upload date:
  • Size: 24.7 kB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for tls_switch-1.0.0b4-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 41c198c3c9d5915decfd0a293dceaedc8f2f56ac42e84e72a42e58c25d160866
MD5 e3f40e6dc56c598960b8bdef0c55a4f8
BLAKE2b-256 087a3cb50eed3afaa5197cf3eb91e9afb8ef996b9fb22f71e64d618679cc1b16

See more details on using hashes here.

File details

Details for the file tls_switch-1.0.0b4-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for tls_switch-1.0.0b4-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 7ec3ebb7b70c76b40adc39c1d6e283ec3023c7456d5593f3f4ecf7d973c1b204
MD5 cfe26702d6a7dad6e34fcc1e0b66f76e
BLAKE2b-256 5057a0238ef842b0cef3485a59d8bade3b183dfd9384be7f5bf49144c05c4dd2

See more details on using hashes here.

File details

Details for the file tls_switch-1.0.0b4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for tls_switch-1.0.0b4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 e71a46e2e9717331ee031e9f5d946bdee5f320a4836eda6f5578417682ee4939
MD5 6aaef7038338b5ca74186809702c4156
BLAKE2b-256 558b85ad16802efe0c3c92c21be22ac35825dbe4f16e7fadd375cb1090354c88

See more details on using hashes here.

File details

Details for the file tls_switch-1.0.0b4-py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for tls_switch-1.0.0b4-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 2538cd13e3b72bfae29027a878b2b035c3701a98b41ba501006fdf95c42bdd69
MD5 629ccc05967eb002699a23d38bbfcd48
BLAKE2b-256 e26e84de0556d66d7b2bf39d716c177748d096c62bf427dc9e86d1f12fe33189

See more details on using hashes here.

File details

Details for the file tls_switch-1.0.0b4-py3-none-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for tls_switch-1.0.0b4-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 1bda55f180c02c2212f292d9a334159ab0f3fa061d5c142153b54b4c80be17d9
MD5 5427a249866209ee1f25394df3acb081
BLAKE2b-256 ba3c52f4421c4b2dd04636666da691a66e3ca731d9da26d0c48c020c154deeb0

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