Karpov Gateway

Alles-in-één API Gateway + Console. Go backend (Gin + gRPC) + Next.js frontend (App Router + shadcn/ui), met inbegrip van credential pool, e-mailverificatie, Linux.do OAuth2 SSO, quotabeheer & facturering, TOTP tweestapsverificatie.

✨ Functies

• Uniforme REST Gateway — Single-process of multi-service modus, gateway → auth/music/pool/quota/billing/worker gRPC backend kan onafhankelijk worden ingezet
• Credential Pool (encrypted) — KEK + DEK envelopversleuteling, AES-256-GCM met AAD, POOL_KEK_HEX hoofdkey-afleiding
• E-mailregistratie + activatie — SMTP code verzending / activatielink, dubbele beveiliging (verificatiecode + e-maillink), bij geen SMTP-configuratie automatisch demote naar LogSender
• OAuth2 externe login — Linux.do SSO (PKCE S256 + HMAC gesigneerde state cookie), login / koppelen / ontkoppelen drie statusbeslissingen, token encryptie en opslag
• Quota / Billing — PlanQuotaMiddleware vangt af op gateway-niveau, business service intern dubbele controle op plan + scope
• TOTP tweestaps — pquerna/otp + Redis replay bescherming
• Auditlog — Gestructureerde JSON, per type gescheiden bestanden, dagelijks roterend
• CSRF + Session — sid httpOnly cookie + X-CSRF-Token header dubbele verificatie
• shadcn/ui Console — Next.js 16 App Router + Radix + Tailwind v4

🏗 Repositorystructuur

karpov-gateway/
├── gateway/             # Go 后端 (Gin + gRPC)
│   ├── cmd/             # 各 service 入口 (gateway/auth/music/pool/...)
│   ├── internal/        # 业务实现 (private)
│   ├── api/             # protobuf 定义
│   ├── migrations/      # PostgreSQL schema
│   ├── go.mod           # Go 模块 (go 1.24+)
│   └── Dockerfile
├── web/                 # Next.js 16 前端控制台
│   ├── src/             # App Router pages + components
│   ├── middleware.ts    # CSRF / session / CSP nonce
│   ├── package.json     # pnpm workspace
│   └── Dockerfile
├── deploy/
│   ├── compose/         # 本地开发 (PG + Redis + pgAdmin)
│   └── compose-prod/    # 生产单机 (gateway + web + PG + Redis 全栈)
└── .github/workflows/   # GitHub Actions CI (lint / test / build / govulncheck / gosec)

🚀 Snelstart

1. Vereisten

| Hulpmiddel | Versie | | ---------- | ------- | | Go | 1.24+ | | Node.js | 20.11+ | | pnpm | 9+ | | Docker | 24+ | | PostgreSQL | 14+ | | Redis | 7+ |

2. Start afhankelijkheden (Postgres + Redis + pgAdmin)

cd deploy/compose
cp .env.example .env       # 改强密码！
docker compose up -d

3. Start de Gateway backend

cd gateway
cp .env.example .env       # 与 deploy/compose/.env 的 PG/Redis 密码保持一致
go mod download
go run ./cmd/qqmusic-gateway
默认 :8080 (HTTP) + :9000 (gRPC)
首次启动会在 stderr 打印一个 superadmin 账号 + 临时密码

4. Start de webconsole

cd web
cp .env.example .env.local
pnpm install
pnpm dev
http://localhost:3000

🐳 Productie-implementatie (Docker Compose standalone)

cd deploy/compose-prod
cp .env.example .env
编辑 .env：填入真域名 / 强密码 / SMTP 凭据 / OAuth client
nano .env
生成 KEK
openssl rand -hex 32     # → 写到 POOL_KEK_HEX=
docker compose up -d --build
docker compose logs -f gateway

Let op:

• Als NEXT_PUBLIC_APP_URL wordt gewijzigd, moet je docker compose build --no-cache web uitvoeren, omdat het inline in de client bundle wordt opgenomen.
• Na een reverse proxy (Nginx/Caddy) moet TRUST_PROXY=true worden ingeschakeld, anders werkt X-Forwarded-Proto niet.
• Zodra KEK is gewijzigd, zijn oude credential pools / oude OAuth tokens volledig onleesbaar.

🔐 OAuth2 (Linux.do) integratie

• Ga naar https://connect.linux.do om een applicatie aan te vragen.
• Vul als callback-adres in: https://your-domain/v1/auth/oauth/linuxdo/callback
• Zet de verkregen client_id / client_secret in .env:

   OAUTH_LINUXDO_ENABLED=true
   OAUTH_LINUXDO_CLIENT_ID=...
   OAUTH_LINUXDO_CLIENT_SECRET=...
   OAUTH_LINUXDO_MIN_TRUST_LEVEL=1
   OAUTH_PUBLIC_BASE=https://your-domain
   OAUTH_FRONTEND_BASE=https://your-domain
   ``
Herstart de gateway, de loginpagina / registratiepagina toont automatisch "Linux.do One-click login"
🧪 Testen / Lint

• golangci-lint run + gofmt -l . alles groen
• go test -race ./... alles groen
• Bij webwijzigingen voer pnpm lint && pnpm typecheck uit
• Dien geen .env / data/.kek` of bestanden met echte wachtwoorden in

🔒 Beveiliging

Neem bij beveiligingsproblemen direct contact op met de maintainer, open geen publieke issue.

Gebouwd met ❤️ door MiChongs

--- Tranlated By Open Ai Tx | Last indexed: 2026-06-08 ---