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.0b7-py3-none-win_arm64.whl (2.0 MB view details)

Uploaded Python 3Windows ARM64

tls_switch-1.0.0b7-py3-none-win_amd64.whl (2.3 MB view details)

Uploaded Python 3Windows x86-64

tls_switch-1.0.0b7-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (2.2 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

tls_switch-1.0.0b7-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (2.0 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

tls_switch-1.0.0b7-py3-none-macosx_11_0_arm64.whl (2.1 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

tls_switch-1.0.0b7-py3-none-macosx_10_12_x86_64.whl (2.3 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: tls_switch-1.0.0b7-py3-none-win_arm64.whl
  • Upload date:
  • Size: 2.0 MB
  • 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.0b7-py3-none-win_arm64.whl
Algorithm Hash digest
SHA256 c0dd74780f1630b4fc3258116ef2f1c29be839e2063b2b8f59d0a53634b16389
MD5 18e6087868e57724136c423c196f8995
BLAKE2b-256 265b1c1934207df9e65f3b59c82bc3cb9498ff2880d79ef08e948ad6f3d412f0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tls_switch-1.0.0b7-py3-none-win_amd64.whl
  • Upload date:
  • Size: 2.3 MB
  • 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.0b7-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 67a2adb2536d67ea7d73a219d71053bea8321da57406f84386ee6228574cccca
MD5 36ca31c693a179ca130be5eb51ffa398
BLAKE2b-256 51f8621fc72aaa7ae1202f03dd51a9da22f3bc9487cf46657cb3b69cec06ac0a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tls_switch-1.0.0b7-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 c1f92ec1f20e7c88b0c8e5a49069969857fd5459b6e47efe8d819c3487aa3610
MD5 528eb7a6594c767e83c1a3171cacdf9d
BLAKE2b-256 4b55ff6a6c0f6265729b53e9a8364c14b5b67fecd05224486e9259e2ac2e559f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tls_switch-1.0.0b7-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 1963ff967d391e7a26f01d147cb7ed926977f22c67ecbbfccf87e3896ab926ab
MD5 39e85d6c876d90c7bde9bc84f49a98c9
BLAKE2b-256 1736343f9ce9b46aa492347747e6d78615163b8a92d8d42e3478d7817d4162c7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tls_switch-1.0.0b7-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 c5da17791d50b23e841b1d14d00e1649faa97bcf71c1ddef4511a5cc1d8b6de2
MD5 ea84d136ffce577d3e45d0cf47e98b87
BLAKE2b-256 e461444e265efb08e8b72567ca207f7b91967b5e6788e7f0cd2257d92efcbfb5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tls_switch-1.0.0b7-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 9fa117f99fac9b47df107c40cf793b0ce3a596583398aaa9d395986b62f737ad
MD5 c3a086e46f5d57a553b6f78b3b6c79ec
BLAKE2b-256 a679da0b5d1acda5142b955385e127aacaf39e08f05b84983f4556593bd75081

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