Karpov Gateway

Zintegrowana brama API + konsola. Backend w Go (Gin + gRPC) + frontend Next.js (App Router + shadcn/ui), wbudowany pul kredencyjny, weryfikacja mailowa, Linux.do OAuth2 SSO, rozliczanie limitów, dwuskładnikowe uwierzytelnianie TOTP.

✨ Funkcje

• Ujednolicony REST Gateway — Tryb pojedynczego procesu lub wielu serwisów, gateway → auth/music/pool/quota/billing/worker gRPC backendy mogą być wdrażane niezależnie
• Pula poświadczeń (zaszyfrowana) — Szyfrowanie kopertowe KEK + DEK, AES-256-GCM z AAD, główny klucz POOL_KEK_HEX pochodny
• Rejestracja e-mail + aktywacja — SMTP wysyłanie kodów / linków aktywacyjnych, podwójne zabezpieczenie (kod weryfikacyjny + link mailowy), brak konfiguracji SMTP automatycznie przełącza do LogSender
• Logowanie OAuth2 przez osoby trzecie — Linux.do SSO (PKCE S256 + podpis HMAC dla state cookie), trzy tryby (logowanie / powiązanie / odłączenie), tokeny szyfrowane i zapisywane
• Limity / rozliczenia — PlanQuotaMiddleware jako ochrona na poziomie gateway, wewnątrz usług biznesowych dodatkowa weryfikacja planu + zakresu
• TOTP dwuskładnikowe — pquerna/otp + ochrona przed powtórzeniami w Redis
• Dzienniki audytu — Strukturalny JSON, pliki według typu, rotacja dzienna
• CSRF + Sesja — Podwójna weryfikacja: httpOnly cookie sid + nagłówek X-CSRF-Token
• Konsola shadcn/ui — Next.js 16 App Router + Radix + Tailwind v4

🏗 Struktura repozytorium

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)

🚀 Szybki start

1. Wymagania wstępne

| Narzędzie | Wersja | | ---------- | ------- | | Go | 1.24+ | | Node.js | 20.11+ | | pnpm | 9+ | | Docker | 24+ | | PostgreSQL | 14+ | | Redis | 7+ |

2. Uruchomienie zależności (Postgres + Redis + pgAdmin)

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

3. Uruchomienie backendu Gateway

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. Uruchomienie konsoli Web

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

🐳 Wdrożenie produkcyjne (Docker Compose - pojedyncza maszyna)

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

Uwagi:

• Po zmianie NEXT_PUBLIC_APP_URL koniecznie wykonać docker compose build --no-cache web, ponieważ zostanie ona osadzona bezpośrednio w paczce klienta
• Po zastosowaniu odwrotnego proxy (Nginx/Caddy) należy ustawić TRUST_PROXY=true, w przeciwnym razie X-Forwarded-Proto nie zadziała
• Po zmianie KEK wszystkie stare pule poświadczeń / stare tokeny OAuth będą całkowicie nieczytelne

🔐 Integracja OAuth2 (Linux.do)

• Przejdź na https://connect.linux.do, aby zarejestrować aplikację
• Jako adres zwrotny wpisz: https://your-domain/v1/auth/oauth/linuxdo/callback
• Uzyskane wartości client_id / client_secret wpisz do pliku .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
   ``
Uruchom ponownie gateway, na stronie logowania / rejestracji automatycznie pojawi się "Linux.do Jedno kliknięcie logowania"
🧪 Test / Lint

• golangci-lint run + gofmt -l . wszystko na zielono
• go test -race ./... wszystko na zielono
• Zmiany w Web uruchom pnpm lint && pnpm typecheck
• Nie przesyłaj plików .env / data/.kek` ani żadnych zawierających prawdziwe hasła

🔒 Bezpieczeństwo

W przypadku wykrycia problemów bezpieczeństwa skontaktuj się bezpośrednio z maintainerem, nie zakładaj publicznego issue.

Stworzone z ❤️ przez MiChongs

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