Files
mc-proxy/PROGRESS.md
Kyle Isom 1ad9a1a43b Add PROXY protocol v1/v2 support for multi-hop deployments
New internal/proxyproto package implements PROXY protocol parsing and
writing without buffering past the header boundary (reads exact byte
counts so the connection is correctly positioned for SNI extraction).

Parser: auto-detects v1 (text) and v2 (binary) by first byte. Parses
TCP4/TCP6 for both versions plus v2 LOCAL command. Enforces max header
sizes and read deadlines.

Writer: generates v2 binary headers for IPv4 and IPv6 with PROXY
command.

Server integration:
- Receive: when listener.ProxyProtocol is true, parses PROXY header
  before firewall check. Real client IP from header is used for
  firewall evaluation and logging. Malformed headers cause RST.
- Send: when route.SendProxyProtocol is true, writes PROXY v2 header
  to backend before forwarding the ClientHello bytes.

Tests cover v1/v2 parsing, malformed rejection, timeout, round-trip
write+parse, and five server integration tests: receive with valid
header, receive with garbage, send verification, send-disabled
verification, and firewall evaluation using the real client IP.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-25 13:28:49 -07:00

67 lines
2.9 KiB
Markdown

# PROGRESS.md
Tracks implementation status against PROJECT_PLAN.md. Updated as work
proceeds. Each item is marked:
- `[ ]` not started
- `[~]` in progress
- `[x]` complete
- `[—]` skipped (with reason)
---
## Phase 1: Database & Config Foundation
- [x] 1.1 Config struct updates (`Listener.ProxyProtocol`, `Route.Mode/TLSCert/TLSKey/BackendTLS/SendProxyProtocol`)
- [x] 1.2 Config validation updates (L7 requires cert/key, mode enum, cert/key pair loading)
- [x] 1.3 Database migration v2 (new columns on `listeners` and `routes`)
- [x] 1.4 DB struct and CRUD updates (new fields in `Listener`, `Route`, all queries)
- [x] 1.5 Server data loading (`RouteInfo` struct replaces bare backend string in route lookup)
- [x] 1.6 Tests (config, DB migration, CRUD, server unchanged)
## Phase 2: PROXY Protocol
- [x] 2.1 `internal/proxyproto/` package (v1/v2 parser, v2 writer)
- [x] 2.2 Server integration — receive (parse PROXY header before firewall on enabled listeners)
- [x] 2.3 Server integration — send on L4 (write PROXY v2 header before ClientHello on enabled routes)
- [x] 2.4 Tests (receive, send, firewall uses real IP, malformed header rejection)
## Phase 3: L7 Proxying
- [ ] 3.1 `internal/l7/` package (`PrefixConn`, HTTP/2 reverse proxy with h2c, `Serve` entry point)
- [ ] 3.2 Server integration (dispatch to L4 or L7 based on `route.Mode` in `handleConn`)
- [ ] 3.3 PROXY protocol sending in L7 path
- [ ] 3.4 Tests (TLS termination, h2c backend, re-encrypt, mixed L4/L7 listener, gRPC through L7)
## Phase 4: gRPC API & CLI Updates
- [ ] 4.1 Proto updates (new fields on `Route`, `AddRouteRequest`, `ListenerStatus`)
- [ ] 4.2 gRPC server updates (accept/validate/persist new route fields)
- [ ] 4.3 Client package updates (new fields on `Route`, `ListenerStatus`)
- [ ] 4.4 mcproxyctl updates (flags for `routes add`, display in `routes list`)
- [ ] 4.5 Tests (gRPC round-trip with new fields, backward compatibility)
## Phase 5: Integration & Polish
- [ ] 5.1 Dev config update (`srv/mc-proxy.toml` with L7 routes, test certs)
- [ ] 5.2 Multi-hop integration test (edge→origin via PROXY protocol)
- [ ] 5.3 gRPC-through-L7 validation (unary, streaming, trailers, deadlines)
- [ ] 5.4 Web UI through L7 validation (HTTP/1.1, HTTP/2, static assets)
- [ ] 5.5 Documentation (verify ARCHITECTURE.md, CLAUDE.md, Makefile)
---
## Current State
The codebase is L4-only. All existing functionality is working and tested:
- SNI extraction and raw TCP relay
- Global firewall (IP, CIDR, GeoIP country blocking, per-IP rate limiting)
- SQLite persistence with write-through pattern
- gRPC admin API (Unix socket) for route and firewall CRUD
- CLI tools (`mc-proxy server/status/snapshot`, `mcproxyctl`)
- `make all` passes (vet, lint, test, build)
ARCHITECTURE.md and CLAUDE.md have been updated to describe the target state.
PROJECT_PLAN.md describes the implementation path. This file tracks progress.