{"id":44049602,"url":"https://github.com/mevdschee/p2pquic-go","last_synced_at":"2026-02-07T23:05:32.715Z","repository":{"id":337027518,"uuid":"1152071636","full_name":"mevdschee/p2pquic-go","owner":"mevdschee","description":null,"archived":false,"fork":false,"pushed_at":"2026-02-07T11:01:39.000Z","size":15,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-07T19:53:55.836Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mevdschee.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-02-07T10:17:45.000Z","updated_at":"2026-02-07T10:56:50.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/mevdschee/p2pquic-go","commit_stats":null,"previous_names":["mevdschee/p2pquic-go"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/mevdschee/p2pquic-go","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mevdschee%2Fp2pquic-go","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mevdschee%2Fp2pquic-go/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mevdschee%2Fp2pquic-go/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mevdschee%2Fp2pquic-go/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mevdschee","download_url":"https://codeload.github.com/mevdschee/p2pquic-go/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mevdschee%2Fp2pquic-go/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29211674,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-07T22:58:45.823Z","status":"ssl_error","status_checked_at":"2026-02-07T22:58:45.272Z","response_time":63,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-02-07T23:05:31.980Z","updated_at":"2026-02-07T23:05:32.702Z","avatar_url":"https://github.com/mevdschee.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# p2pquic-go\n\np2pquic-go is a peer-to-peer QUIC library in Go that enables direct connections between peers behind NAT using UDP hole-punching and QUIC transport. It provides both a reusable library and command-line tools for testing.\n\n## Features\n\n- **NAT Traversal**: UDP hole-punching with STUN support\n- **QUIC Transport**: Reliable, encrypted peer-to-peer connections\n- **Simple API**: Easy-to-use library for building P2P applications\n- **Signaling Server**: Coordinate peer discovery and connection setup\n- **Testing Tools**: Command-line utilities for testing peer connections\n\n## Installation\n\n```bash\ngo get github.com/mevdschee/p2pquic-go\n```\n\n## Project Structure\n\n```\np2pquic-go/\n├── pkg/\n│   ├── p2pquic/          # Core P2P QUIC library\n│   │   ├── p2pquic.go    # Main peer implementation\n│   │   ├── signaling.go  # Signaling client\n│   │   └── types.go      # Data structures\n│   └── signaling/        # Decoupled signaling server (transport-agnostic)\n│       └── server.go     # Peer registry logic\n├── cmd/\n│   ├── p2pquic-test/     # Peer testing tool\n│   └── p2pquic-signal/   # HTTP signaling server\n└── examples/\n    └── simple/           # Basic usage example\n```\n\n**Key Packages:**\n- **`pkg/p2pquic`** - Reusable library for P2P QUIC connections with NAT traversal\n- **`pkg/signaling`** - Transport-agnostic signaling server (not coupled to HTTP)\n- **`cmd/p2pquic-test`** - Command-line tool for testing peer connections\n- **`cmd/p2pquic-signal`** - HTTP wrapper around the signaling package\n\n## Library Usage\n\n### Basic Example\n\n```go\npackage main\n\nimport (\n    \"context\"\n    \"log\"\n    \n    \"github.com/mevdschee/p2pquic-go/pkg/p2pquic\"\n)\n\nfunc main() {\n    // Create a peer\n    config := p2pquic.Config{\n        PeerID:       \"my-peer\",\n        LocalPort:    9000,\n        SignalingURL: \"http://signaling-server:8080\",\n        EnableSTUN:   true,\n    }\n    \n    peer, err := p2pquic.NewPeer(config)\n    if err != nil {\n        log.Fatal(err)\n    }\n    defer peer.Close()\n    \n    // Discover NAT candidates\n    candidates, err := peer.DiscoverCandidates()\n    if err != nil {\n        log.Fatal(err)\n    }\n    \n    // Register with signaling server\n    if err := peer.Register(); err != nil {\n        log.Fatal(err)\n    }\n    \n    // Server mode: listen for connections\n    if err := peer.Listen(); err != nil {\n        log.Fatal(err)\n    }\n    \n    conn, err := peer.Accept(context.Background())\n    if err != nil {\n        log.Fatal(err)\n    }\n    \n    // Use the QUIC connection...\n}\n```\n\n### Client Mode\n\n```go\n// Connect to a remote peer (candidates fetched from signaling server)\nconn, err := peer.Connect(\"remote-peer-id\")\nif err != nil {\n    log.Fatal(err)\n}\ndefer conn.CloseWithError(0, \"done\")\n\n// Or provide candidates directly:\nconn, err := peer.Connect(\"remote-peer-id\",\n    p2pquic.WithCandidates(\n        p2pquic.Candidate{IP: \"192.168.1.100\", Port: 9000},\n        p2pquic.Candidate{IP: \"1.2.3.4\", Port: 9000},\n    ),\n)\n\n// Open a stream and communicate\nstream, err := conn.OpenStreamSync(context.Background())\nif err != nil {\n    log.Fatal(err)\n}\ndefer stream.Close()\n\n// Write and read data\nstream.Write([]byte(\"Hello!\"))\nbuf := make([]byte, 1024)\nn, _ := stream.Read(buf)\nlog.Printf(\"Received: %s\", buf[:n])\n```\n\n## Command-Line Tools\n\n### Signaling Server\n\nThe signaling server is available both as a standalone HTTP server and as a reusable package.\n\n#### As a Command-Line Tool\n\nStart the HTTP signaling server on a publicly accessible machine:\n\n```bash\n# Build\ngo build ./cmd/p2pquic-signal\n\n# Run\n./p2pquic-signal -port 8080\n```\n\n#### As a Library\n\nThe `pkg/signaling` package is **transport-agnostic** and can be used with any transport layer (HTTP, gRPC, WebSocket, etc.):\n\n```go\nimport \"github.com/mevdschee/p2pquic-go/pkg/signaling\"\n\n// Create signaling server\nserver := signaling.NewServer()\n\n// Register a peer\nserver.Register(\"peer-id\", []signaling.Candidate{\n    {IP: \"192.168.1.100\", Port: 9000},\n})\n\n// Get peer info\npeer, exists := server.GetPeer(\"peer-id\")\n\n// List all peers\npeers := server.GetAllPeers()\n```\n\nThe HTTP server in `cmd/p2pquic-signal` is just a thin wrapper around this package.\n\n### Peer Testing Tool\n\nTest peer-to-peer connections:\n\n**Server Mode:**\n```bash\n# Build\ngo build ./cmd/p2pquic-test\n\n# Run server peer (defaults to ID \"server\")\n./p2pquic-test -mode server -port 9000 -signaling http://your-server:8080\n\n# Or with custom ID\n./p2pquic-test -mode server -id myserver -port 9000 -signaling http://your-server:8080\n```\n\n**Client Mode:**\n```bash\n# Run client peer connecting to \"server\" (defaults to ID \"client\")\n./p2pquic-test -mode client -remote server -port 9001 -signaling http://your-server:8080\n\n# Or with custom ID connecting to \"myserver\"\n./p2pquic-test -mode client -id myclient -remote myserver -port 9001 -signaling http://your-server:8080\n```\n\n**Flags:**\n- `-mode`: Operation mode (`server` or `client`)\n- `-id`: Unique peer identifier\n- `-remote`: Remote peer ID to connect to (client mode only)\n- `-port`: Local UDP port to bind to\n- `-signaling`: Signaling server URL\n- `-stun`: Enable STUN for public IP discovery (default: true)\n\n\u003e **Why does the client need a port?**\n\u003e \n\u003e Both peers need a specific port for UDP hole-punching to work correctly:\n\u003e \n\u003e 1. **STUN Discovery**: The peer discovers its public IP:port mapping using this port\n\u003e 2. **UDP Hole-Punching**: Sends packets from this port to create NAT mappings\n\u003e 3. **QUIC Connection**: Receives the actual connection on this same port\n\u003e \n\u003e All three steps must use the **same port**, otherwise NAT mappings won't match and hole-punching will fail.\n\u003e \n\u003e The different ports in examples (`9000` vs `9001`) are only needed for **local testing on the same machine**. In production across different networks, both peers can use the same port number (e.g., both use `9000`).\n\n## How It Works\n\n1. **Candidate Discovery**: Each peer discovers its network candidates using STUN (public IP) and local network interfaces\n2. **Signaling**: Peers register their candidates with a central signaling server\n3. **UDP Hole-Punching**: Client sends UDP packets to all server candidates to \"punch holes\" in NATs\n4. **QUIC Connection**: After hole-punching, a QUIC connection is established directly between peers\n\n## Architecture\n\n```\n┌─────────────┐         ┌──────────────────┐         ┌─────────────┐\n│   Peer A    │         │ Signaling Server │         │   Peer B    │\n│ (Behind NAT)│         │  (Public Server) │         │ (Behind NAT)│\n└──────┬──────┘         └────────┬─────────┘         └──────┬──────┘\n       │                         │                          │\n       │  1. Register candidates │                          │\n       ├────────────────────────►│                          │\n       │                         │  2. Register candidates  │\n       │                         │◄─────────────────────────┤\n       │                         │                          │\n       │  3. Get peer B info     │                          │\n       ├────────────────────────►│                          │\n       │                         │                          │\n       │  4. UDP hole-punch packets                         │\n       ├───────────────────────────────────────────────────►│\n       │◄───────────────────────────────────────────────────┤\n       │                         │                          │\n       │  5. QUIC connection established                    │\n       ├═══════════════════════════════════════════════════►│\n```\n\n## API Reference\n\n### `Config`\n\nConfiguration for creating a peer:\n\n```go\ntype Config struct {\n    PeerID       string  // Unique peer identifier\n    LocalPort    int     // UDP port to bind to\n    SignalingURL string  // Signaling server URL\n    EnableSTUN   bool    // Enable STUN discovery\n}\n```\n\n### `Peer`\n\nMain peer interface:\n\n- `NewPeer(config Config) (*Peer, error)` - Create a new peer\n- `DiscoverCandidates() ([]Candidate, error)` - Discover NAT candidates\n- `Register() error` - Register with signaling server\n- `Listen() error` - Start listening for incoming connections\n- `Accept(ctx context.Context) (*quic.Conn, error)` - Accept incoming connection\n- `Connect(remotePeerID string, opts ...ConnectOption) (*quic.Conn, error)` - Connect to remote peer\n- `ContinuousHolePunch(ctx context.Context)` - Continuously punch holes to discovered peers\n- `Close() error` - Close peer and release resources\n\n### `ConnectOption`\n\nFunctional options for customizing connection behavior:\n\n- `WithCandidates(candidates ...Candidate)` - Provide candidates directly instead of fetching from signaling server\n\n### `signaling.Server`\n\nTransport-agnostic signaling server (in `pkg/signaling`):\n\n- `NewServer() *Server` - Create a new signaling server\n- `Register(peerID string, candidates []Candidate) error` - Register a peer\n- `GetPeer(peerID string) (*PeerInfo, bool)` - Get peer information\n- `GetAllPeers() []*PeerInfo` - List all registered peers\n- `RemovePeer(peerID string)` - Remove a peer from registry\n- `PeerCount() int` - Get number of registered peers\n\n## Testing NAT Traversal\n\nTo test actual NAT traversal:\n\n1. Deploy signaling server on a **public server** (VPS, cloud instance)\n2. Run server peer on **Machine A** (behind NAT)\n3. Run client peer on **Machine B** (behind different NAT)\n4. Observe direct P2P connection establishment\n\n## Limitations\n\n- **Symmetric NAT**: May fail if both peers have strict symmetric NAT\n- **Firewall Rules**: Some firewalls block all unsolicited UDP traffic\n- **Port Randomization**: Some NATs use cryptographic port randomization\n\n## Dependencies\n\n- `github.com/quic-go/quic-go` - QUIC implementation in Go\n\n## License\n\nSee LICENSE file for details.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmevdschee%2Fp2pquic-go","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmevdschee%2Fp2pquic-go","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmevdschee%2Fp2pquic-go/lists"}