proxy

package module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 31, 2026 License: Apache-2.0 Imports: 0 Imported by: 0

README

proxy

Netmaker proxy libraries (one Go module, feature packages).

Packages

Import Role
github.com/gravitl/proxy/uplink Phase 1: TCP/TLS framed WireGuard uplink (C ↔ relay/gateway B)
github.com/gravitl/proxy/l7 L7: HTTP CONNECT forward proxy for app-domain egress

There is no root package API — import the subpackage you need.

  • Client: TCP + TLS + framed MsgData carrying WireGuard packet bytes to the relay.
  • Server (relay / gateway, also a WireGuard peer): terminates TLS, authenticates ClientHello, registers sessions, and supports SendToPeer for reverse traffic.

See uplink/example_test.go and docs/PROXY_PHASE1_ARCHITECTURE.md.

L7

Name-based egress via HTTP CONNECT over the mesh (underlay remains WireGuard). See docs/PROXY_L7_EGRESS.md.

Develop

go test ./... -race

Release

From GitHub Actions → ReleaseRun workflow: enter a semver (v0.1.0 or 0.1.0). The workflow runs tests, pushes an annotated tag, and creates a GitHub Release (notes auto-generated). Consumers can then:

go get github.com/gravitl/proxy/l7@v0.1.0

Documentation

Overview

Module github.com/gravitl/proxy hosts Netmaker proxy libraries as subpackages.

Import paths:

github.com/gravitl/proxy/uplink  — TCP/TLS framed WireGuard uplink transport
github.com/gravitl/proxy/l7      — HTTP CONNECT app-domain egress proxy

The module root has no public API; use the packages above.

Directories

Path Synopsis
Package l7 provides an HTTP CONNECT forward proxy for name-based egress.
Package l7 provides an HTTP CONNECT forward proxy for name-based egress.
Package uplink provides a WebSocket Secure (WSS) framed transport for carrying WireGuard packet payloads between a relay-attached peer and its relay/gateway.
Package uplink provides a WebSocket Secure (WSS) framed transport for carrying WireGuard packet payloads between a relay-attached peer and its relay/gateway.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL