Skip to content

A simple configurable reverse proxy that uses socks,ssh,vless,... as transport layer, with builtin support for SNI and Http-Header based autorouting.

License

Notifications You must be signed in to change notification settings

fmotalleb/junction

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Junction

build release CodeQL

Junction is a lightweight reverse proxy optimized for efficient TCP and TLS traffic routing. It inspects protocol-level metadata (such as SNI in TLS) to forward encrypted connections to the appropriate backend, without decrypting the traffic. Junction supports both SOCKS5 and SSH proxy protocols (and chaining them), making it ideal for complex egress scenarios where transparent, performant routing is required.


🌟 Features

  • πŸ” Sni Passthrough
    No certificate required, reroutes tls packets using sni header.

  • 🧦 SOCKS5 Proxy Support
    Routes traffic using SOCKS5 proxies, with built-in support for VLESS proxies via Docker image.

  • πŸ”€ SSH Proxy Support
    Routes traffic using SSH connection as proxy.

  • πŸ”— Proxy Chain Support
    Chain multiple proxies together to create complex routing paths and improve privacy or bypass restrictions.

  • 🐳 Dockerized Deployment
    Includes a ready-to-use Docker setup for seamless deployment in any environment.

  • 🌐 Internal Fake DNS
    Fake DNS with ability to match only some domains, change result based on client's ip address, and forward unmatched requests to an optional forwarder DNS.


πŸ“‹ Table of Contents

  1. Getting Started
  2. Configuration
  3. Environment Variables
  4. Usage
  5. Development
  6. License

πŸš€ Getting Started

Installation

Standalone binary installation

You can grab one of builds from Release page or use the shell script (please review the scripts before executing it in your shell, or any script you find online who paste them in the shell without checking) This script requires curl, tar, jq (if version is missing), sha256sum (optional but recommended) and bash itself.

Install latest version (requires jq):

bash <<<"$(curl -fL https://raw.githubusercontent.com/fmotalleb/junction/refs/heads/main/install.sh)"
curl -fL https://raw.githubusercontent.com/fmotalleb/junction/refs/heads/main/install.sh | bash

or select a version manually:

VERSION=0.4.2 bash <<<"$(curl -fL https://raw.githubusercontent.com/fmotalleb/junction/refs/heads/main/install.sh)"

Using Go cli

Simply using

go install github.com/fmotalleb/junction@latest

in this method version variables are missing thus you cannot use --version (-v) to acquire version number

Docker based

Using:


❗️ Docker Image Details (Must Read)

Vless support

every build of this application contains singbox internally, but only start singbox if core.singbox is non-empty value.

The Docker image ghcr.io/fmotalleb/junction:latest-vless contains a simple bash script entrypoint and basic configuration for sing-box service. This script is able to parse VLESS_PROXY to outbound config or receive each field of VLESS proxy as env parameters (see .env.example).

  • Remember: this image requires those env vars to be set.

  • latest-vless

  • {{ .Version }}-vless

Basic image

contains junction itself based on distroless images by google

  • latest
  • latest-distroless
  • {{ .Version }}-distroless

Run Docker container

# Documented example of config file docker run --rm -it ghcr.io/fmotalleb/junction:latest example # Save config file to docker run --rm ghcr.io/fmotalleb/junction:latest example > config.toml docker run --rm -it \ -v "./config.toml:/config.toml" \ --network host \ # or map each port manually ghcr.io/fmotalleb/junction:latest -c /config.toml

πŸ›  Configuration

Configuration

Remember that the cli has an example sub command that will be updated more than this section, Config specifications defined here may not be complete Most parameters are loosely typed arrays can be defined as single items and it will be mapped to array internally some objects are able to parse themselves from strings

Run SubCommand

Simplest way to run the server is using run sub command

junction run --help # show help for this sub command # Simple example of run command that listens on port 8443 # thru socks5 proxy on port 7890 of localhost # transfers the request to port 443 # of the found hostname using `sni` packets junction run --listen 8443 \ --proxy socks5://127.0.0.1:7890 \ --target 443 \ --routing sni

Fields

  • Include You can include multiple config files (even from a remote http source): Please note that this list is not loosely typed so you have to declare an array of strings Order of included files are not guaranteed, do not mix ordered sensitive items in multiple files

    • Support Glob pattern matching
    • Support HTTP and HTTPS with basic authentication
    include = [ "./*.toml", "http://remote-server.com/config.toml", ]
  • Core Some specific global configurations are stored here

    • fake_dns: object or string of fake DNS config: In order to create a simple dns server to manipulate requests into this server (needs manual IP configuration) Limitations:
      • A Record support (for now since i don't use AAAA records)
      • UDP listener
      • UDP forwarder Config:
        • listen: UDP listen address, requires a UDP ip:port

        • answer: IPv4 Answer, requires a single IPv4 address alternatively this field is able to receive array(or just an object) as value

          • answer: Single IPv4 to answer
          • from: CIDR address of remote user that queries DNS Order is important on masking networks
          [[core.fake_dns.answer]] answer = "127.0.0.1" from = "127.0.0.1/24" [[core.fake_dns.answer]] answer = "192.168.1.1" from = [ "192.168.2.0/24", "128.1.1.0/24" ]
        • forwarder: Upstream DNS server for unresolvable/not-allowed queries, (e.g. 8.8.8.8:53), if omitted will return empty response

        • allowed: Allowed list matcher

          • Supports wildcards (e.g., "*.example.com")
          • Supports Regular Expression (e.g. "regexp:allowed", "grep:.+google.com^")
    • singbox: object of singbox config singbox is a successor to xray Its config is complex you can see an example of how to provide a simple config in example directory
  • Entrypoints: Top-level array defining routing configurations. Each entry includes:

    • listen (required): Bind address for incoming connections. Accepts:

      • Full address: "IP:port" (e.g., "0.0.0.0:8443")
      • Port only: ":port" (binds to 127.0.0.1:port)
      • Integer: port (binds to 127.0.0.1:port)
    • routing (required): Target hostname resolution method:

      • sni: Uses SNI for hostname detection. Default port: 443
      • http-header: Uses HTTP Host header. Default port: 80
      • tcp-raw: Raw TCP forwarding. Requires complete ip:port in to field
      • udp-raw: Raw UDP forwarding. Requires complete ip:port in to field. Note: Proxy not supported
    • tag (optional): The tag attribute groups multiple entrypoints so they share a single listening socket while applying different domain-matching rules. A tag represents a routing group evaluated on the same port. This causes all entrypoints with the same tag to have a fallback behavior Order is not guaranteed, thus modify allow list and block list on all entrypoints manually All entrypoints in a tag group must: - use the same listen address - use the same routing mode (sni or http-header) - specify the same tag identifier

    • proxy (optional): Upstream proxy configuration. Accepts:

      • String: Comma-separated proxy chain
      • Array: Ordered list of proxy URIs

      Supported proxy protocols:

      • SOCKS5: socks5://[user:pass@]hostname:port
      • SSH: ssh://user[:pass]@hostname:port[/path/to/private/key]
        • Use either password OR key authentication, not both

      Default: direct (no proxy)

      Example proxy chains (equivalent):

      • "socks5://user:pass@10.0.0.1:1080,socks5://10.0.0.2:1080,ssh://user@10.0.0.3:22/tmp/key"
      • ["socks5://user:pass@10.0.0.1:1080", "socks5://10.0.0.2:1080", "ssh://user@10.0.0.3:22/tmp/key"]
      graph LR Client --> Proxy1["socks5://user:pass@10.0.0.1:1080"] Proxy1 --> Proxy2["socks5://10.0.0.2:1080"] Proxy2 --> Proxy3["ssh://user@10.0.0.3:22"] Proxy3 --> Target["example.com:80"] 
      Loading
    • to (required): Target destination:

      • For sni/http-header: Port number (string)
      • For tcp-raw/udp-raw: Complete "ip:port" address
    • timeout (optional): Connection timeout duration:

      • Default: 24h (or TIMEOUT environment variable)
      • Format: Go duration syntax (e.g., "50s", "5h3m15s")
    • block_list (optional) [only when using sni,http-header]: List of hostnames/patterns to block.

      • Supports wildcards (e.g., "*.example.com", "glob:*.example.com")
      • Supports Regular Expression (contain check) (e.g. "regexp:badword", "grep:bad.+word")
    • allow_list (optional) [only when using sni,http-header]: List of hostnames/patterns to allow. If specified, only listed hosts are allowed.

      • Supports wildcards (e.g., "*.example.com")
      • Supports Regular Expression (e.g. "regexp:allowed", "grep:.+google.com^")
      • Block rules are applied before allow rules

Important Notes:

  • Proxy chains execute in order; incorrect ordering breaks the chain
  • tcp-raw and udp-raw require explicit ip:port targets
  • udp-raw routing doesn't support proxy protocols
  • When using allow_list, unlisted hosts are implicitly blocked
  • Wildcard patterns (e.g., *.example.com) match subdomains only, not the base domain

Example: TOML Configuration

[[entrypoints]] listen = "0.0.0.0:8443" # Listen IP:Port address to = "443" # Reroutes connections to this port (defaults to 443) routing = "sni" # Routing method proxy = "socks5://127.0.0.1:7890" # socks5 proxy address [[entrypoints]] listen = ":8080" # Listen on 127.0.0.1:8080 routing = "http-header" to = "80" # Defaults from `Host` proxy = "socks5://127.0.0.1:7890" [[entrypoints]] listen = 8090 # Listen on 127.0.0.1:8090 routing = "http-header" to = "80" proxy = "direct" # Do not handle using proxy just reverse proxy it directly [[entrypoints]] listen = 8099 to = "18.19.20.21:22" # Required for tcp-raw routing = "tcp-raw" # TCP raw is old behavior where the target address must be specified (used for non-tls non-http requests that do not have any indications for server name nor address) proxy = "direct" # Do not handle using proxy just reverse proxy it directly

Example: YAML Configuration

entrypoints: - routing: "sni" # Routing method listen: 8443 # Listen ip addr (default ip is 127.0.0.1 if omitted) to: "443" # Reroutes connections to this port (defaults to 443) proxy: socks5://127.0.0.1:7890 # socks5 proxy address - routing: http-header listen: 8080 to: "80" # Defaults to 80 proxy: socks5://127.0.0.1:7890

You can specify config file path using --config (-c) flag (detects config file) Default behavior is to read config from stdin using toml format


πŸ’‘ Docker Environment Variables

Use environment variables for dynamic runtime configuration. Below is an example .env file:

VLESS_PROXY= HTTP_PORT=80 SNI_PORT=443 UDP_BUFFER=65507 # don't change unless you faced buffer size issue

These variables help configure VLESS proxies and expose specific endpoints for HTTP/HTTPS traffic.


▢️ Usage

Running Locally

  1. Build the Go application:

    go build -o junction
  2. Run the application:

    ./junction --config=config.toml

Running with Docker

To build and launch the Docker container:

docker-compose up --build

Once running, the application will be accessible on the configured ports.


πŸ›  Development

Debugging with VS Code

A pre-configured .vscode/launch.json is included for debugging purposes. To debug:

  1. Open the project in Visual Studio Code.
  2. Use the "Launch Package" configuration to start debugging.

Directory Structure

Junction's project structure is organized as follows:

. β”œβ”€β”€ cmd/ # CLI entry point β”œβ”€β”€ config/ # Configuration parsing and helpers β”œβ”€β”€ docker/ # Docker-related files β”œβ”€β”€ router/ # Routers (sni,http,...) logic β”œβ”€β”€ server/ # Core server logic β”œβ”€β”€ main.go # Main entry point └── docker-compose.yml # Docker Compose configuration 

πŸ“œ License

This project is licensed under the GNU General Public License v2.0. Refer to the LICENSE file for more details.

About

A simple configurable reverse proxy that uses socks,ssh,vless,... as transport layer, with builtin support for SNI and Http-Header based autorouting.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors 3

  •  
  •  
  •