[PR #77] feat: websocket relay #197

New Issue

GiteaMirror · 2026-04-21T22:47:32-05:00

GiteaMirror commented

2026-04-21 22:47:32 -05:00

📋 Pull Request Information

Original PR: https://github.com/fosrl/gerbil/pull/77
Author: @nicholasliverett
Created: 4/11/2026
Status: 🔄 Open

Base: dev ← Head: feature-websocket-relay

📝 Commits (5)

6f73a0d Add TCP relay server and main integration
30e7b45 Add var for b limit
3662ba9 Enhance metrics tracking in SNIProxy connection handling
1f72ae2 Add TCP relay server and main integration
24a5ac6 resolved conflict

📊 Changes

4 files changed (+880 additions, -0 deletions)

View changed files

📝 main.go (+13 -0)
📝 proxy/proxy.go (+1 -0)
➕ relay/tcp_relay.go (+433 -0)
➕ relay/wss_relay.go (+433 -0)

📄 Description

Community Contribution License Agreement

By creating this pull request, I grant the project maintainers an unlimited,
perpetual license to use, modify, and redistribute these contributions under any terms they
choose, including both the AGPLv3 and the Fossorial Commercial license terms. I
represent that I have the right to grant this license for all contributed content.

What does this PR do?

You can read about the discussion related to this topic here: Transport flexiblity
As discussed, in more restrictive networks UDP connections may be completely blocked and clients are unable to connect to resources. To get around this we use a commonly allowed protocol: HTTPS, or more specifically websockets.

Description

OLM will try its normal direct UDP/hole punch and UDP relay. If OLM receives a relayEndpointWss (sent with relay info) it starts an 8s timer. Once that timer is up it switches from the shared UDP bind to a websocket bind. Traffic then flows OLM-(wss)->Pangolin-(tcp relay port)->Gerbil->Newt. Now since we are using a websocket the RTT is more than just raw wireguard, and it might be something to look into.

Note: the only thing changed is olm's connection to the gerbil relay, to newt nothing changes.

How to test?

Setup Pangolin, Gerbil, and Olm from companion PRs mentioned below and regular newt. Have to spin up pangolin, gerbil, newt, and olm to test this. Ideally checking, regular connections, restricted networks, and the force relay flag

Companion PRs

Pangolin: fosrl/pangolin#2831
Olm: fosrl/olm#112

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/fosrl/gerbil/pull/77 **Author:** [@nicholasliverett](https://github.com/nicholasliverett) **Created:** 4/11/2026 **Status:** 🔄 Open **Base:** `dev` ← **Head:** `feature-websocket-relay` --- ### 📝 Commits (5) - [`6f73a0d`](https://github.com/fosrl/gerbil/commit/6f73a0d005652a837bbf68352d94cd00e0e73009) Add TCP relay server and main integration - [`30e7b45`](https://github.com/fosrl/gerbil/commit/30e7b45a7e9ad9e22b78a0fb225fba5f81d107e6) Add var for b limit - [`3662ba9`](https://github.com/fosrl/gerbil/commit/3662ba92c3997320079979f0ab39a817380dacce) Enhance metrics tracking in SNIProxy connection handling - [`1f72ae2`](https://github.com/fosrl/gerbil/commit/1f72ae2ef530ca3f186a47e8662329a655bba878) Add TCP relay server and main integration - [`24a5ac6`](https://github.com/fosrl/gerbil/commit/24a5ac64adaa40b0d103e744e3351446cd1c2862) resolved conflict ### 📊 Changes **4 files changed** (+880 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `main.go` (+13 -0) 📝 `proxy/proxy.go` (+1 -0) ➕ `relay/tcp_relay.go` (+433 -0) ➕ `relay/wss_relay.go` (+433 -0) </details> ### 📄 Description ## Community Contribution License Agreement By creating this pull request, I grant the project maintainers an unlimited, perpetual license to use, modify, and redistribute these contributions under any terms they choose, including both the AGPLv3 and the Fossorial Commercial license terms. I represent that I have the right to grant this license for all contributed content. ## What does this PR do? You can read about the discussion related to this topic here: [Transport flexiblity](https://github.com/orgs/fosrl/discussions/2076) As discussed, in more restrictive networks UDP connections may be completely blocked and clients are unable to connect to resources. To get around this we use a commonly allowed protocol: HTTPS, or more specifically websockets. ## Description OLM will try its normal direct UDP/hole punch and UDP relay. If OLM receives a relayEndpointWss (sent with relay info) it starts an 8s timer. Once that timer is up it switches from the shared UDP bind to a websocket bind. Traffic then flows OLM-(wss)->Pangolin-(tcp relay port)->Gerbil->Newt. Now since we are using a websocket the RTT is more than just raw wireguard, and it might be something to look into. Note: the only thing changed is olm's connection to the gerbil relay, to newt nothing changes. ## How to test? Setup Pangolin, Gerbil, and Olm from companion PRs mentioned below and regular newt. Have to spin up pangolin, gerbil, newt, and olm to test this. Ideally checking, regular connections, restricted networks, and the force relay flag ## Companion PRs **Pangolin**: [fosrl/pangolin#2831](https://github.com/fosrl/pangolin/pull/2831) **Olm**: [fosrl/olm#112](https://github.com/fosrl/olm/pull/112) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

GiteaMirror added the pull-request label 2026-04-21 22:47:32 -05:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/gerbil#197