Compare commits
15
Commits
ed3d7c6b61
..
v0.2.1
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0d3517eb5c | ||
|
|
cdc9a7c94b | ||
|
|
c00c46e7a1 | ||
|
|
3b3aa3b708 | ||
|
|
695b3ecf25 | ||
|
|
7343d5aa5c | ||
|
|
171503d775 | ||
|
|
91b0c8acee | ||
|
|
a238e5c2a4 | ||
|
|
272565f736 | ||
|
|
d1e7f9a4dd | ||
|
|
4a8c563b32 | ||
|
|
cd70157aea | ||
|
|
ac614be190 | ||
|
|
880c199ce4 |
@@ -51,6 +51,17 @@ BYTEDANCE_TTS_SAMPLE_RATE=24000
|
||||
# OpenAI兼容接口的API密钥(可选,多个用逗号分隔)
|
||||
OPENAI_TTS_API_KEY=your_openai_compatible_key_here
|
||||
|
||||
# 反代拓扑配置(0-10)。控制 X-Forwarded-For 解析方式,影响 IP 限流的 key。
|
||||
# 不设置 / 0:启发式模式(默认)—— 从 XFF 链尾扫描,跳过私有 IP,返回第一个公网 IP
|
||||
# 适合 90% 部署(单跳/多跳/直出),无需了解精确跳数
|
||||
# N (N>0) :精确模式 —— 精准到真实 client IP,需要正确配置跳数
|
||||
# N=1:单跳反代(client → nginx → 本服务)
|
||||
# N=2:双跳反代(client → CDN → nginx → 本服务,如 Cloudflare + nginx)
|
||||
# N=3:三跳,以此类推
|
||||
# 直出部署(无反代):无需配置,XFF 分支不会执行
|
||||
# 详见 README "反代拓扑与 X-Forwarded-For 解析"章节
|
||||
# TRUSTED_PROXY_HOPS=
|
||||
|
||||
# CORS 跨域白名单(逗号分隔;开发环境可设 *;空则拒绝所有跨域)
|
||||
# ALLOWED_ORIGINS=https://example.com,https://app.example.com
|
||||
|
||||
|
||||
@@ -0,0 +1,65 @@
|
||||
name: Docker Publish
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- 'v*'
|
||||
workflow_dispatch: # 允许手动触发测试
|
||||
|
||||
env:
|
||||
REGISTRY: ghcr.io
|
||||
|
||||
jobs:
|
||||
build-and-push:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0 # 拉完整历史,git describe 能取到 tag
|
||||
|
||||
- name: Set up QEMU
|
||||
uses: docker/setup-qemu-action@v3
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Login to GHCR
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
registry: ${{ env.REGISTRY }}
|
||||
username: ${{ github.actor }}
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Extract version from git
|
||||
id: version
|
||||
run: |
|
||||
echo "version=$(git describe --tags --always --dirty)" >> "$GITHUB_OUTPUT"
|
||||
echo "commit=$(git rev-parse --short HEAD)" >> "$GITHUB_OUTPUT"
|
||||
|
||||
- name: Extract Docker metadata
|
||||
id: meta
|
||||
uses: docker/metadata-action@v5
|
||||
with:
|
||||
images: ${{ env.REGISTRY }}/${{ github.repository }}
|
||||
tags: |
|
||||
type=semver,pattern={{version}}
|
||||
type=sha,format=short
|
||||
labels: |
|
||||
org.opencontainers.image.version=${{ steps.version.outputs.version }}
|
||||
org.opencontainers.image.revision=${{ steps.version.outputs.commit }}
|
||||
|
||||
- name: Build and push
|
||||
uses: docker/build-push-action@v5
|
||||
with:
|
||||
context: .
|
||||
platforms: linux/amd64,linux/arm64
|
||||
push: true
|
||||
tags: ${{ steps.meta.outputs.tags }}
|
||||
labels: ${{ steps.meta.outputs.labels }}
|
||||
build-args: |
|
||||
VERSION=${{ steps.version.outputs.version }}
|
||||
COMMIT=${{ steps.version.outputs.commit }}
|
||||
@@ -17,3 +17,6 @@ Thumbs.db
|
||||
.env
|
||||
.env.*
|
||||
!.env.example
|
||||
|
||||
# Local-only working notes (use task board for shared tracking)
|
||||
TODO.md
|
||||
+9
-1
@@ -7,7 +7,15 @@ RUN go mod download
|
||||
|
||||
COPY . .
|
||||
|
||||
RUN CGO_ENABLED=0 GOOS=linux go build -o tts-api .
|
||||
# VERSION 由 CI/CD 传入,通常为 `git describe --tags --always --dirty` 的输出
|
||||
# COMMIT 为 `git rev-parse --short HEAD`
|
||||
# 本地默认 dev
|
||||
ARG VERSION=dev
|
||||
ARG COMMIT=dev
|
||||
RUN CGO_ENABLED=0 GOOS=linux go build \
|
||||
-ldflags "-X github.com/volcano-tts/tts-api/version.Version=${VERSION} \
|
||||
-X github.com/volcano-tts/tts-api/version.Commit=${COMMIT}" \
|
||||
-o tts-api .
|
||||
|
||||
FROM alpine:3.21
|
||||
|
||||
|
||||
@@ -63,7 +63,7 @@ tts-api.exe
|
||||
|--------|------|--------|
|
||||
| `BYTEDANCE_TTS_TIMEOUT` | 单次合成超时 | `30s` |
|
||||
| `BYTEDANCE_TTS_FORMAT` | 上游实际请求的音频格式(mp3 / pcm / ogg_opus);客户端要求 wav 时内部自动转 pcm + 本地拼 WAV 头 | `mp3` |
|
||||
| `BYTEDANCE_TTS_SAMPLE_RATE` | 上游采样率(8000 / 16000 / 22050 / 24000 / 32000 / 44100 / 48000) | `24000` |
|
||||
| `BYTEDANCE_TTS_SAMPLE_RATE` | 上游采样率(8000 / 16000 / 22050 / 24000 / 32000 / 44100 / 48000);**此值直接写入 WAV 头,需与上游实际 PCM 采样率一致,否则音频变速变调** | `24000` |
|
||||
| `BYTEDANCE_TTS_BIT_RATE` | MP3 比特率,仅 mp3 生效 | 无 |
|
||||
|
||||
### 复刻 2.0 扩展参数
|
||||
@@ -79,10 +79,87 @@ tts-api.exe
|
||||
|
||||
| 变量名 | 说明 | 默认值 |
|
||||
|--------|------|--------|
|
||||
| `OPENAI_TTS_API_KEY` | OpenAI 兼容接口的 API Key(逗号分隔支持多个) | 无(不鉴权) |
|
||||
| `OPENAI_TTS_API_KEY` | 🔴 **公网必设** OpenAI 兼容接口的 API Key(逗号分隔支持多个);**未设置时鉴权完全关闭** | 无(不鉴权) |
|
||||
| `TRUSTED_PROXY_HOPS` | X-Forwarded-For 解析模式(0=启发式/默认,>0=精确 N 跳) | `0`(启发式) |
|
||||
| `PORT` | 服务监听端口 | `8080` |
|
||||
| `ALLOWED_ORIGINS` | CORS 跨域白名单(逗号分隔,调试可设 `*`;空则拒绝所有跨域) | 无 |
|
||||
|
||||
### 反代拓扑与 X-Forwarded-For 解析
|
||||
|
||||
当服务部署在反代(nginx / caddy / CDN)后面时,反代会通过 `X-Forwarded-For`(XFF)头传递真实客户端 IP。本服务通过 `TRUSTED_PROXY_HOPS` 环境变量控制 XFF 解析方式,支持两种模式。
|
||||
|
||||
#### 何时需要关心这个配置
|
||||
|
||||
| 部署方式 | 是否需要配置 |
|
||||
|---|---|
|
||||
| 服务直接暴露公网 IP(无反代)| ❌ 不适用,跳过本节 |
|
||||
| 服务前有 1 个反代(nginx / caddy)| ❌ 不必配置,启发式模式自动处理 |
|
||||
| 服务前有 2 跳以上反代(CDN + 自建反代)| ⚠️ 启发式模式"够用",需要精准按真实 client 限流时再设 |
|
||||
|
||||
> **直出部署(无反代)的用户**:本节不适用,跳过阅读。`TRUSTED_PROXY_HOPS` 在你的部署下不会被读取。
|
||||
|
||||
#### 启发式模式(默认 / `TRUSTED_PROXY_HOPS=0`)
|
||||
|
||||
从 XFF 链尾向前扫描,**跳过私有 IP,返回第一个公网 IP**。
|
||||
|
||||
适用场景:单跳反代(最常见)、多跳含公网代理(CDN + nginx)。
|
||||
|
||||
**行为示例**:
|
||||
|
||||
| XFF 链 | 启发式返回 | 备注 |
|
||||
|---|---|---|
|
||||
| `1.2.3.4` | `1.2.3.4` | 单跳,真实 client |
|
||||
| `fake, 1.2.3.4` | `1.2.3.4` | 攻击者伪造首值,跳过 fake |
|
||||
| `1.2.3.4, 5.6.7.8, 10.0.0.1` | `5.6.7.8` | 多跳,返回最末公网 IP(CDN 边缘) |
|
||||
| `1.2.3.4, 192.168.1.1` | `1.2.3.4` | 链尾是私有 IP,跳过 |
|
||||
|
||||
**优点**:零配置,大多数部署自动正确。
|
||||
|
||||
**限制**:多跳 CDN 场景下,限流粒度为"按 CDN 边缘 IP"而非"按真实 client"。攻击者填满某 CDN 边缘配额可能影响该 CDN 下的其他用户——但无法伪造身份、无法越权。
|
||||
|
||||
#### 精确模式(`TRUSTED_PROXY_HOPS=N`,N > 0)
|
||||
|
||||
从 XFF 链尾倒数第 N+1 个位置取值,即"信任最近 N 跳反代,取该信任链之前那一跳的 IP"。
|
||||
|
||||
适用场景:多跳 CDN + 反代,且需要精准按真实 client 限流。
|
||||
|
||||
**N 的确定方法**:统计客户端到本服务之间的反代跳数。
|
||||
|
||||
| 拓扑 | 跳数 | 配置 |
|
||||
|---|---|---|
|
||||
| `client → nginx → 本服务` | 1 | `TRUSTED_PROXY_HOPS=1` |
|
||||
| `client → Cloudflare → nginx → 本服务` | 2 | `TRUSTED_PROXY_HOPS=2` |
|
||||
| `client → CDN → WAF → nginx → 本服务` | 3 | `TRUSTED_PROXY_HOPS=3` |
|
||||
|
||||
**行为对比**(以 `client(1.2.3.4) → CDN(203.0.113.5) → nginx(10.0.0.1) → 本服务` 为例,XFF 链 = `1.2.3.4, 203.0.113.5`):
|
||||
|
||||
| `TRUSTED_PROXY_HOPS` | 返回 | 评价 |
|
||||
|---|---|---|
|
||||
| 0(默认启发式)| `203.0.113.5` | CDN 边缘 IP,限流粒度粗 |
|
||||
| 1(数到 nginx,未穿透)| `203.0.113.5` | 配置不当,与默认相同 |
|
||||
| 2(穿透到真实 client)| `1.2.3.4` | 精准到真实 client ✓ |
|
||||
| 3(超出实际跳数)| `directIP`(链长不足保护)| 配置错误,需修正 |
|
||||
|
||||
#### 为什么两种模式都从链尾扫描
|
||||
|
||||
XFF 链的第一个值是**客户端可控**的:攻击者可以发送任意 `X-Forwarded-For: 1.2.3.4`,若反代用追加模式(如 nginx 默认的 `$proxy_add_x_forwarded_for`),链尾才会追加真实 IP。
|
||||
|
||||
若代码取首值,攻击者每次换伪造 IP 即可绕过 IP 限流,也可伪装成受害 IP 把其配额耗尽(间接 DoS)。两种模式都从链尾扫描,天然免疫这种攻击。
|
||||
|
||||
#### 验证当前模式
|
||||
|
||||
启动期日志会显示当前模式:
|
||||
|
||||
```
|
||||
TRUSTED_PROXY_HOPS 未设置,使用默认启发式模式(XFF 链尾第一个公网 IP)
|
||||
# 或
|
||||
已配置 TRUSTED_PROXY_HOPS=0(启发式模式,等同默认)
|
||||
# 或
|
||||
已配置 TRUSTED_PROXY_HOPS=2(精确模式,信任 2 跳反代)
|
||||
```
|
||||
|
||||
也可在 `GetClientIP` 临时加 `log.Printf` 打印解析结果,或写一个 Go 测试用例(参见 DEBT-1 单元测试任务)来覆盖不同 XFF 链场景。生产环境不要保留 debug 日志。
|
||||
|
||||
### Resource ID 说明
|
||||
|
||||
| Resource ID | 模型说明 |
|
||||
@@ -166,6 +243,8 @@ CORS拦截: 来源="https://..." 路径=/v1/audio/speech 方法=POST 客户端=.
|
||||
|
||||
## API 使用说明
|
||||
|
||||
> ⚠️ **公网部署前必读**:如果你的服务暴露在公网,**必须**设置 `OPENAI_TTS_API_KEY` 或由前置反代(nginx / caddy)承担鉴权。未设置时 `Authorization` 头完全跳过校验,任何能访问 `:8080` 的人都能调用 TTS 合成,消耗你的火山额度。详见[部署 → 公网安全清单](#公网部署安全清单)。
|
||||
|
||||
### OpenAI 兼容接口
|
||||
|
||||
**端点:** `POST /v1/audio/speech`
|
||||
@@ -191,7 +270,7 @@ CORS拦截: 来源="https://..." 路径=/v1/audio/speech 方法=POST 客户端=.
|
||||
- `input` — 要合成的文本
|
||||
- `voice` — 发音人(OpenAI 兼容,实际用 `BYTEDANCE_TTS_SPEAKER`)
|
||||
- `response_format` — 输出格式:`mp3`(默认)/ `opus`(映射 ogg_opus)/ `wav` / `pcm` / `aac` / `flac`(降级到 mp3)
|
||||
- `speed` — 语速,0.25 ~ 4.0(火山侧转换为 speech_rate [-50, 100])
|
||||
- `speed` — 语速倍率,客户端接受范围 0.25 ~ 4.0;**火山实际生效范围 0.5 ~ 2.0**(speech_rate [-50, 100]),超出范围会被静默截断,客户端无感反馈
|
||||
|
||||
**格式映射:**
|
||||
|
||||
@@ -281,6 +360,40 @@ scrape_configs:
|
||||
|
||||
`/dashboard` 展示服务状态 + 内存 + 配置信息,并内嵌 `/metrics` 预览;Grafana 等工具可直接基于上面指标做面板。
|
||||
|
||||
### ⚠️ 公网部署:监控端点无鉴权
|
||||
|
||||
`/metrics`、`/health`、`/dashboard` **均不鉴权**,这是对齐 Prometheus 抓取场景的设计权衡:
|
||||
|
||||
| 端点 | 暴露内容 | 风险 |
|
||||
|---|---|---|
|
||||
| `/metrics` | 业务标签(speaker/model/format)、运行指标、错误计数 | 侦察面:可推断使用量、技术栈、错误模式 |
|
||||
| `/health` | 服务状态、版本号、运行时长、内存 | 侦察面:版本号可用于匹配已知 CVE |
|
||||
| `/dashboard` | 配置检查结果(含 `TTSConfigErr` 状态) | 信息泄露:可确认配置是否就绪 |
|
||||
|
||||
**部署建议**:
|
||||
|
||||
- **内网 / 反代后**:无影响,符合预期
|
||||
- **公网直接暴露**:在前置反代(nginx / caddy)上保护这些端点,示例 nginx 配置:
|
||||
|
||||
```nginx
|
||||
location /metrics {
|
||||
auth_basic "metrics";
|
||||
auth_basic_user_file /etc/nginx/.htpasswd;
|
||||
allow 10.0.0.0/8; # 仅允许 Prometheus 服务器网段
|
||||
deny all;
|
||||
}
|
||||
location /dashboard {
|
||||
auth_basic "admin";
|
||||
auth_basic_user_file /etc/nginx/.htpasswd;
|
||||
}
|
||||
location /health {
|
||||
allow 10.0.0.0/8; # 或保留给监控系统访问
|
||||
deny all;
|
||||
}
|
||||
```
|
||||
|
||||
- **最简方案**:反代层直接限制 `/metrics` 只能从 Prometheus 服务器 IP 访问,无需 basic auth
|
||||
|
||||
## 架构
|
||||
|
||||
| 包 | 职责 |
|
||||
@@ -333,6 +446,34 @@ docker compose up -d
|
||||
|
||||
环境变量通过 `.env` 或 `docker-compose.yml` 传入。
|
||||
|
||||
### 公网部署安全清单
|
||||
|
||||
公网直接暴露(`:8080` 可被互联网任意访问)时,**至少满足以下两条之一**,否则视为不安全的部署:
|
||||
|
||||
1. **设置 `OPENAI_TTS_API_KEY`**(推荐,最简单)
|
||||
```bash
|
||||
# .env
|
||||
OPENAI_TTS_API_KEY=<32+ 位随机字符串>
|
||||
```
|
||||
客户端请求时带 `Authorization: Bearer <那个字符串>`。
|
||||
|
||||
2. **前置反代承担鉴权**(nginx / caddy / Cloudflare Access)
|
||||
- 反代层做 basic auth、mTLS、Cloudflare Access 等任一方案
|
||||
- 反代**仅**把鉴权后的请求转发到 `:8080`,Go 服务本身保持"无鉴权"
|
||||
- 此时 `OPENAI_TTS_API_KEY` 可不设
|
||||
|
||||
**两个端点还需要单独保护**(无论上面哪种方案):
|
||||
|
||||
- `/metrics`:暴露业务标签与运行指标,详见[观测 / Metrics → 公网部署](#公网部署监控端点无鉴权)
|
||||
- `/dashboard`:暴露配置检查结果,同上
|
||||
|
||||
**未做保护的典型风险**:
|
||||
- 任意人 curl `POST /v1/audio/speech` → 消耗你火山账号的字符额度
|
||||
- 任意人 `GET /metrics` → 推断你的使用量、技术栈、错误模式
|
||||
- 任意人 `GET /dashboard` → 确认你 TTS 配置就绪状态
|
||||
|
||||
**内网部署 / 私网反代后**:这些警示不适用,直接用就行。
|
||||
|
||||
## 常见问题
|
||||
|
||||
### 1. `code=55000000, message=resource ID is mismatched with speaker related resource`
|
||||
|
||||
@@ -6,6 +6,7 @@ import (
|
||||
"encoding/hex"
|
||||
"fmt"
|
||||
"log"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/volcano-tts/tts-api/common"
|
||||
@@ -94,10 +95,13 @@ func Synthesis(
|
||||
|
||||
if resp.StatusCode != 200 {
|
||||
rawBody := ReadErrorBody(resp.Body)
|
||||
// rawBody 来自上游响应体,可能是攻击者控制的恶意内容(例如包含
|
||||
// \n 伪造日志行)。转义后再嵌入错误消息。
|
||||
safeBody := strings.NewReplacer("\n", "\\n", "\r", "\\r").Replace(rawBody)
|
||||
mtr.UpstreamFinished(opts.Speaker, opts.Model, opts.Format, fmt.Sprintf("http_%d", resp.StatusCode), time.Since(started), 0, 0, 0, resp.StatusCode)
|
||||
return nil, &UpstreamError{
|
||||
Code: resp.StatusCode,
|
||||
Message: fmt.Sprintf("upstream http %d: %s", resp.StatusCode, rawBody),
|
||||
Message: fmt.Sprintf("upstream http %d: %s", resp.StatusCode, safeBody),
|
||||
Stage: "http",
|
||||
}
|
||||
}
|
||||
|
||||
@@ -15,8 +15,6 @@ const (
|
||||
MaxRequestBodySize = 1024 * 1024
|
||||
RateLimitRequests = 100
|
||||
RateLimitWindow = time.Minute
|
||||
MaxResponseTimes = 100
|
||||
MaxErrors = 10
|
||||
MaxConcurrentRequests = 10
|
||||
CleanupInterval = time.Hour
|
||||
MaxModelNameLength = 64
|
||||
|
||||
+3
-4
@@ -18,6 +18,7 @@ import (
|
||||
"github.com/volcano-tts/tts-api/middleware"
|
||||
"github.com/volcano-tts/tts-api/setting"
|
||||
"github.com/volcano-tts/tts-api/telemetry"
|
||||
"github.com/volcano-tts/tts-api/version"
|
||||
)
|
||||
|
||||
var (
|
||||
@@ -46,9 +47,6 @@ func resolveClientFormat(reqFmt string) string {
|
||||
}
|
||||
return strings.ToLower(reqFmt)
|
||||
}
|
||||
if reqFmt == "" {
|
||||
return setting.TTSOptions.Format
|
||||
}
|
||||
return setting.TTSOptions.Format
|
||||
}
|
||||
|
||||
@@ -232,7 +230,8 @@ func HealthHandler(w http.ResponseWriter, r *http.Request) {
|
||||
resp := dto.HealthResponse{
|
||||
Status: status,
|
||||
Service: "ByteDance TTS to OpenAI API Adapter",
|
||||
Version: "2.0.0 (v3 API)",
|
||||
Version: version.Version,
|
||||
Commit: version.Commit,
|
||||
Uptime: fmt.Sprintf("%.0f seconds", time.Since(startTime).Seconds()),
|
||||
StartTime: startTime.Format(time.RFC3339),
|
||||
Memory: collectMemorySnapshot(),
|
||||
|
||||
@@ -7,6 +7,7 @@ type HealthResponse struct {
|
||||
Status string `json:"status"`
|
||||
Service string `json:"service"`
|
||||
Version string `json:"version"`
|
||||
Commit string `json:"commit"`
|
||||
Uptime string `json:"uptime"`
|
||||
StartTime string `json:"start_time"`
|
||||
Memory map[string]interface{} `json:"memory"`
|
||||
|
||||
@@ -58,15 +58,6 @@ type V3Usage struct {
|
||||
TextWords int `json:"text_words"`
|
||||
}
|
||||
|
||||
// ByteDanceTTSConfig 是 setting 包的全局 TTS 配置,目前只承载鉴权 / URL / 超时;
|
||||
// 完整的合成参数见 adapter/volcano.Options。
|
||||
type ByteDanceTTSConfig struct {
|
||||
ApiKey string
|
||||
ResourceId string
|
||||
URL string
|
||||
Timeout time.Duration
|
||||
}
|
||||
|
||||
// SynthesisResult 是火山适配器向 controller 返回的最终结果。
|
||||
// Format 与 AudioData 的实际编码一致;controller 据此设置响应 Content-Type。
|
||||
type SynthesisResult struct {
|
||||
|
||||
+4
-1
@@ -131,7 +131,10 @@ func (AdapterRecorder) UpstreamFinished(speaker, model, format, status string, d
|
||||
if audioBytes > 0 {
|
||||
UpstreamBytes.Add(float64(audioBytes), telemetry.Labels{"format": format})
|
||||
}
|
||||
if errCode != 0 {
|
||||
// 上游调用只要 status != "ok" 即视为错误。原版 if errCode != 0 会漏掉
|
||||
// errCode=0 的 request_error / transport_error / wrap_error / stream_error
|
||||
// (code=0 的流错误) 等场景,导致 transport 类错误在 /metrics 上完全不可见。
|
||||
if status != "ok" {
|
||||
UpstreamErrors.Inc(telemetry.Labels{"code": codeLabel(errCode)})
|
||||
}
|
||||
}
|
||||
|
||||
@@ -9,13 +9,6 @@ import (
|
||||
"github.com/volcano-tts/tts-api/setting"
|
||||
)
|
||||
|
||||
// InitAPIKeys 已在 setting.InitAuthConfig 中完成,这里保留为 no-op 以维持现有调用顺序。
|
||||
// 实际鉴权逻辑直接读 setting.Auth.APIKeys。
|
||||
func InitAPIKeys() {
|
||||
// 配置由 setting 包统一加载,日志也由 setting.LogStartupSummary 输出。
|
||||
_ = setting.Auth
|
||||
}
|
||||
|
||||
func ValidateAPIKey(r *http.Request) bool {
|
||||
if len(setting.Auth.APIKeys) == 0 {
|
||||
return true
|
||||
|
||||
@@ -13,13 +13,6 @@ var (
|
||||
corsMaxAgeHeader = "86400"
|
||||
)
|
||||
|
||||
// InitCORSConfig 已在 setting.InitCORSConfig 中完成,这里保留为 no-op 以维持现有调用顺序。
|
||||
// 实际 CORS 匹配逻辑直接读 setting.CORS.Origins / setting.CORS.AllowAll。
|
||||
func InitCORSConfig() {
|
||||
// 配置由 setting 包统一加载,日志也由 setting.LogStartupSummary 输出。
|
||||
_ = setting.CORS
|
||||
}
|
||||
|
||||
func isValidOrigin(origin string) bool {
|
||||
if origin == "" || origin == "null" || origin == "nil" {
|
||||
return false
|
||||
|
||||
@@ -3,6 +3,7 @@ package middleware
|
||||
import (
|
||||
"log"
|
||||
"net/http"
|
||||
"strings"
|
||||
"time"
|
||||
)
|
||||
|
||||
@@ -23,6 +24,9 @@ func Logger(next http.Handler) http.Handler {
|
||||
next.ServeHTTP(rec, r)
|
||||
duration := time.Since(start)
|
||||
|
||||
log.Printf("%s %s %s %d %v", r.Method, r.RequestURI, r.RemoteAddr, rec.statusCode, duration)
|
||||
// r.RequestURI 是未经解析的原始请求行,攻击者可在 URL 中注入
|
||||
// \n / \r 伪造日志行。转义为可见字符后再记录。
|
||||
uri := strings.NewReplacer("\n", "\\n", "\r", "\\r").Replace(r.RequestURI)
|
||||
log.Printf("%s %s %s %d %v", r.Method, uri, r.RemoteAddr, rec.statusCode, duration)
|
||||
})
|
||||
}
|
||||
|
||||
+75
-3
@@ -4,12 +4,15 @@ import (
|
||||
"log"
|
||||
"net"
|
||||
"net/http"
|
||||
"os"
|
||||
"strconv"
|
||||
"strings"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"github.com/volcano-tts/tts-api/common"
|
||||
"github.com/volcano-tts/tts-api/metrics"
|
||||
"github.com/volcano-tts/tts-api/setting"
|
||||
)
|
||||
|
||||
type RateLimiter struct {
|
||||
@@ -23,15 +26,57 @@ type RateLimiter struct {
|
||||
var (
|
||||
GlobalRateLimiter *RateLimiter
|
||||
ConcurrencySem chan struct{}
|
||||
// trustedProxyHops controls how X-Forwarded-For (XFF) is parsed when the
|
||||
// direct connection comes from a private IP (i.e., we're behind a reverse
|
||||
// proxy). Two modes are supported, switched by this single value:
|
||||
//
|
||||
// HEURISTIC MODE (trustedProxyHops == 0, the default):
|
||||
// Walk XFF from the end, return the first PUBLIC IP. Skips private
|
||||
// and loopback hops automatically. Works for ~90% of deployments
|
||||
// without the operator needing to know the exact number of proxy
|
||||
// hops. Trade-off in multi-hop: rate limiting is per-CDN-edge rather
|
||||
// than per-real-client, which is "good enough" for abuse protection
|
||||
// but not for fine-grained per-user quotas.
|
||||
//
|
||||
// PRECISE MODE (trustedProxyHops > 0):
|
||||
// Count back N hops from the end of XFF and return that value. Gives
|
||||
// precise per-real-client rate limiting even in multi-hop setups
|
||||
// (e.g., Cloudflare + nginx). Operator MUST set this to the number
|
||||
// of trusted reverse proxies between this service and the client.
|
||||
//
|
||||
// Both modes walk from the END of the XFF chain. The first value is
|
||||
// client-controllable; trusting it would let attackers bypass IP rate
|
||||
// limiting by sending a forged X-Forwarded-For header.
|
||||
trustedProxyHops = 0
|
||||
)
|
||||
|
||||
func InitRateLimiter() {
|
||||
switch v := os.Getenv("TRUSTED_PROXY_HOPS"); {
|
||||
case v == "":
|
||||
log.Printf("TRUSTED_PROXY_HOPS 未设置,使用默认启发式模式(XFF 链尾第一个公网 IP)")
|
||||
default:
|
||||
n, err := strconv.Atoi(v)
|
||||
switch {
|
||||
case err != nil || n < 0 || n > 10:
|
||||
log.Printf("警告: TRUSTED_PROXY_HOPS=%q 无效(需 0-10 的整数),回退到默认启发式模式", v)
|
||||
case n == 0:
|
||||
// "0" 或 "00" 等被 Atoi 解析为 0 的形式都归到启发式模式,
|
||||
// 避免日志出现"精确模式, 信任 0 跳"这种自相矛盾的输出。
|
||||
log.Printf("已配置 TRUSTED_PROXY_HOPS=%d(启发式模式,等同默认)", n)
|
||||
default:
|
||||
trustedProxyHops = n
|
||||
log.Printf("已配置 TRUSTED_PROXY_HOPS=%d(精确模式,信任 %d 跳反代)", n, n)
|
||||
}
|
||||
}
|
||||
GlobalRateLimiter = &RateLimiter{
|
||||
requests: make(map[string][]time.Time),
|
||||
limit: common.RateLimitRequests,
|
||||
window: common.RateLimitWindow,
|
||||
}
|
||||
ConcurrencySem = make(chan struct{}, common.MaxConcurrentRequests)
|
||||
|
||||
// 同步到 setting 包,供 LogStartupSummary 展示
|
||||
setting.TrustedProxyHops = trustedProxyHops
|
||||
}
|
||||
|
||||
func (rl *RateLimiter) Allow(key string) bool {
|
||||
@@ -133,10 +178,37 @@ func GetClientIP(r *http.Request) string {
|
||||
}
|
||||
|
||||
if isPrivateIP(directIP) {
|
||||
// Parse X-Forwarded-For when there's a reverse proxy in front (direct
|
||||
// connection is from a private IP). Both modes walk from the END of
|
||||
// the chain so that the client-controllable first value cannot be
|
||||
// used to spoof a different client IP for rate limit bypass.
|
||||
if xff := r.Header.Get("X-Forwarded-For"); xff != "" {
|
||||
ip := strings.TrimSpace(strings.Split(xff, ",")[0])
|
||||
if net.ParseIP(ip) != nil {
|
||||
return ip
|
||||
parts := strings.Split(xff, ",")
|
||||
if trustedProxyHops > 0 {
|
||||
// PRECISE MODE: count back N hops from end. Real client IP
|
||||
// sits at index (len(parts) - N). Walk backwards to skip
|
||||
// any malformed values; if chain is shorter than expected,
|
||||
// fall through to the first valid IP in the chain.
|
||||
target := len(parts) - trustedProxyHops
|
||||
if target < 0 {
|
||||
target = 0
|
||||
}
|
||||
for i := target; i >= 0; i-- {
|
||||
ip := strings.TrimSpace(parts[i])
|
||||
if net.ParseIP(ip) != nil {
|
||||
return ip
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// HEURISTIC MODE (default): walk from end, return first
|
||||
// PUBLIC IP. Skips private/loopback hops that come from
|
||||
// internal proxies between the public-facing proxy and us.
|
||||
for i := len(parts) - 1; i >= 0; i-- {
|
||||
ip := strings.TrimSpace(parts[i])
|
||||
if parsed := net.ParseIP(ip); parsed != nil && !isPrivateIP(ip) {
|
||||
return ip
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
if xri := strings.TrimSpace(r.Header.Get("X-Real-IP")); xri != "" {
|
||||
|
||||
@@ -1,10 +1,9 @@
|
||||
package middleware
|
||||
|
||||
// 本文件提供带 metrics 埋点的限流 / 并发中间件版本;
|
||||
// 由于原 ratelimit_middleware.go 在本仓库的云盘同步下被永久占用,
|
||||
// 这里用独立实现覆盖路由使用入口,旧实现保留为未引用代码。
|
||||
//
|
||||
// 行为与原 ratelimit_middleware.go 完全一致,只是多了 metrics 调用。
|
||||
// 本文件提供带 metrics 埋点的限流 / 并发中间件版本。
|
||||
// 相比 router 实际使用的实现,本版本额外做了:
|
||||
// - 加 metrics 埋点(限流拒绝 / 并发拒绝计数)
|
||||
// - 仅对 /v1/ 下的业务请求生效,监控路径(/health /metrics /dashboard)不消耗配额
|
||||
|
||||
import (
|
||||
"log"
|
||||
@@ -14,7 +13,7 @@ import (
|
||||
"github.com/volcano-tts/tts-api/metrics"
|
||||
)
|
||||
|
||||
// RateLimitWithMetrics 是 middleware.RateLimit 的可埋点版本。
|
||||
// RateLimitWithMetrics 是限流中间件,带埋点 + 路径过滤。
|
||||
func RateLimitWithMetrics(next http.Handler) http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
// 仅对 /v1/ 下的业务请求限流,/health /metrics /dashboard 等监控路径不限流
|
||||
@@ -32,7 +31,7 @@ func RateLimitWithMetrics(next http.Handler) http.Handler {
|
||||
})
|
||||
}
|
||||
|
||||
// ConcurrencyLimitWithMetrics 是 middleware.ConcurrencyLimit 的可埋点版本。
|
||||
// ConcurrencyLimitWithMetrics 是并发控制中间件,带埋点 + 路径过滤。
|
||||
func ConcurrencyLimitWithMetrics(next http.Handler) http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
// 仅对 /v1/ 下的业务请求统计并发和加锁,监控路径不占用并发槽位
|
||||
|
||||
@@ -1,32 +0,0 @@
|
||||
package middleware
|
||||
|
||||
import (
|
||||
"log"
|
||||
"net/http"
|
||||
)
|
||||
|
||||
func RateLimit(next http.Handler) http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
clientIP := GetClientIP(r)
|
||||
if !GlobalRateLimiter.Allow(clientIP) {
|
||||
log.Printf("警告: 已超过IP速率限制,拒绝请求 - 客户端IP: %s", clientIP)
|
||||
SendJSONError(w, http.StatusTooManyRequests, "Rate limit exceeded. Please try again later.", "rate_limit_error", "rate_limit_exceeded")
|
||||
return
|
||||
}
|
||||
next.ServeHTTP(w, r)
|
||||
})
|
||||
}
|
||||
|
||||
func ConcurrencyLimit(next http.Handler) http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
select {
|
||||
case ConcurrencySem <- struct{}{}:
|
||||
defer func() { <-ConcurrencySem }()
|
||||
next.ServeHTTP(w, r)
|
||||
default:
|
||||
log.Printf("警告: 已达到最大并发请求数限制,拒绝请求 - 客户端IP: %s", GetClientIP(r))
|
||||
SendJSONError(w, http.StatusServiceUnavailable, "Server is busy, maximum concurrent requests reached. Please try again later.", "concurrency_limit_error", "max_concurrent_requests")
|
||||
return
|
||||
}
|
||||
})
|
||||
}
|
||||
@@ -0,0 +1,229 @@
|
||||
package middleware
|
||||
|
||||
import (
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// TestGetClientIP 覆盖 XFF 解析在两种模式下的关键场景。
|
||||
// 表驱动测试,每个 case 独立设置 trustedProxyHops,验证 GetClientIP 输出。
|
||||
func TestGetClientIP(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
mode int // 0=启发式, N>0=精确 N 跳
|
||||
remoteAddr string // 直连 IP:port
|
||||
xff string // X-Forwarded-For 头(空则不设)
|
||||
xri string // X-Real-IP 头(空则不设)
|
||||
want string
|
||||
}{
|
||||
// === 直出部署(directIP 是公网,XFF 分支不进)===
|
||||
{
|
||||
name: "直出_无XFF",
|
||||
mode: 0,
|
||||
remoteAddr: "1.2.3.4:5678",
|
||||
want: "1.2.3.4",
|
||||
},
|
||||
{
|
||||
name: "直出_XFF被忽略",
|
||||
mode: 0,
|
||||
remoteAddr: "1.2.3.4:5678",
|
||||
xff: "fake",
|
||||
want: "1.2.3.4", // 公网直连不走 XFF 分支
|
||||
},
|
||||
{
|
||||
name: "直出_精确模式也不走XFF",
|
||||
mode: 2,
|
||||
remoteAddr: "1.2.3.4:5678",
|
||||
xff: "fake, 5.6.7.8",
|
||||
want: "1.2.3.4",
|
||||
},
|
||||
|
||||
// === 单跳反代 ===
|
||||
{
|
||||
name: "单跳_启发式",
|
||||
mode: 0,
|
||||
remoteAddr: "10.0.0.1:5678",
|
||||
xff: "1.2.3.4",
|
||||
want: "1.2.3.4",
|
||||
},
|
||||
{
|
||||
name: "单跳_精确N1",
|
||||
mode: 1,
|
||||
remoteAddr: "10.0.0.1:5678",
|
||||
xff: "1.2.3.4",
|
||||
want: "1.2.3.4",
|
||||
},
|
||||
|
||||
// === 攻击者伪造首值 ===
|
||||
{
|
||||
name: "伪造_启发式跳过fake",
|
||||
mode: 0,
|
||||
remoteAddr: "10.0.0.1:5678",
|
||||
xff: "fake, 1.2.3.4",
|
||||
want: "1.2.3.4",
|
||||
},
|
||||
{
|
||||
name: "伪造_精确N1也跳过fake",
|
||||
mode: 1,
|
||||
remoteAddr: "10.0.0.1:5678",
|
||||
xff: "fake, 1.2.3.4",
|
||||
want: "1.2.3.4", // target=1, 跳过 fake 取 real
|
||||
},
|
||||
{
|
||||
name: "伪造_多个假值前缀",
|
||||
mode: 0,
|
||||
remoteAddr: "10.0.0.1:5678",
|
||||
xff: "fake1, fake2, 1.2.3.4",
|
||||
want: "1.2.3.4", // 从尾扫,只看最后一个
|
||||
},
|
||||
|
||||
// === 多跳 CDN+nginx ===
|
||||
{
|
||||
name: "多跳_启发式返回CDN边缘",
|
||||
mode: 0,
|
||||
remoteAddr: "10.0.0.1:5678",
|
||||
xff: "1.2.3.4, 203.0.113.5",
|
||||
want: "203.0.113.5", // 链尾公网=CDN 边缘
|
||||
},
|
||||
{
|
||||
name: "多跳_精确N2返回真实client",
|
||||
mode: 2,
|
||||
remoteAddr: "10.0.0.1:5678",
|
||||
xff: "1.2.3.4, 203.0.113.5",
|
||||
want: "1.2.3.4", // 倒数第2=真实 client
|
||||
},
|
||||
{
|
||||
name: "多跳_精确N1不够穿透",
|
||||
mode: 1,
|
||||
remoteAddr: "10.0.0.1:5678",
|
||||
xff: "1.2.3.4, 203.0.113.5",
|
||||
want: "203.0.113.5", // 数到 nginx,没穿透到 client
|
||||
},
|
||||
|
||||
// === 链尾私有 IP ===
|
||||
{
|
||||
name: "链尾私有_启发式跳过",
|
||||
mode: 0,
|
||||
remoteAddr: "10.0.0.1:5678",
|
||||
xff: "1.2.3.4, 10.0.0.1",
|
||||
want: "1.2.3.4", // 跳过私有取公网
|
||||
},
|
||||
{
|
||||
name: "链尾私有_精确N1取末值",
|
||||
mode: 1,
|
||||
remoteAddr: "10.0.0.1:5678",
|
||||
xff: "1.2.3.4, 10.0.0.1",
|
||||
want: "10.0.0.1", // 精确模式不跳私有
|
||||
},
|
||||
|
||||
// === X-Real-IP 兜底 ===
|
||||
{
|
||||
name: "无XFF_走XRI",
|
||||
mode: 0,
|
||||
remoteAddr: "10.0.0.1:5678",
|
||||
xri: "1.2.3.4",
|
||||
want: "1.2.3.4",
|
||||
},
|
||||
{
|
||||
name: "XFF全非法_走XRI",
|
||||
mode: 0,
|
||||
remoteAddr: "10.0.0.1:5678",
|
||||
xff: "not_ip, also_not",
|
||||
xri: "1.2.3.4",
|
||||
want: "1.2.3.4",
|
||||
},
|
||||
{
|
||||
name: "XRI被XFF优先_但XFF全非法",
|
||||
mode: 0,
|
||||
remoteAddr: "10.0.0.1:5678",
|
||||
xff: "not_an_ip",
|
||||
xri: "1.2.3.4",
|
||||
want: "1.2.3.4",
|
||||
},
|
||||
|
||||
// === 全部私有 IP(启发式无解)===
|
||||
{
|
||||
name: "全私有_启发式回退directIP",
|
||||
mode: 0,
|
||||
remoteAddr: "10.0.0.1:5678",
|
||||
xff: "192.168.1.1, 172.16.0.1",
|
||||
want: "10.0.0.1", // 全跳私有,走 directIP
|
||||
},
|
||||
|
||||
// === 畸形/空 XFF ===
|
||||
{
|
||||
name: "畸形XFF_启发式跳过畸形",
|
||||
mode: 0,
|
||||
remoteAddr: "10.0.0.1:5678",
|
||||
xff: "not_an_ip, 1.2.3.4",
|
||||
want: "1.2.3.4",
|
||||
},
|
||||
{
|
||||
name: "全空XFF_回退directIP",
|
||||
mode: 0,
|
||||
remoteAddr: "10.0.0.1:5678",
|
||||
xff: " , , ",
|
||||
want: "10.0.0.1",
|
||||
},
|
||||
{
|
||||
name: "XFF带前后空格",
|
||||
mode: 0,
|
||||
remoteAddr: "10.0.0.1:5678",
|
||||
xff: " 1.2.3.4 , 5.6.7.8 ",
|
||||
want: "5.6.7.8", // TrimSpace 处理
|
||||
},
|
||||
|
||||
// === 精确模式 N 超出链长 ===
|
||||
{
|
||||
name: "精确N超出链长_回退到首值",
|
||||
mode: 5,
|
||||
remoteAddr: "10.0.0.1:5678",
|
||||
xff: "1.2.3.4",
|
||||
want: "1.2.3.4", // target<0 保护,取首个合法
|
||||
},
|
||||
{
|
||||
name: "精确N等于链长_取首值",
|
||||
mode: 1,
|
||||
remoteAddr: "10.0.0.1:5678",
|
||||
xff: "1.2.3.4",
|
||||
want: "1.2.3.4", // target=0
|
||||
},
|
||||
{
|
||||
name: "精确N大于链长_取首值",
|
||||
mode: 2,
|
||||
remoteAddr: "10.0.0.1:5678",
|
||||
xff: "1.2.3.4",
|
||||
want: "1.2.3.4", // target<0,fall back
|
||||
},
|
||||
|
||||
// === 精确模式链中含畸形 ===
|
||||
{
|
||||
name: "精确N1_链中畸形回退到首值",
|
||||
mode: 1,
|
||||
remoteAddr: "10.0.0.1:5678",
|
||||
xff: "1.2.3.4, not_ip",
|
||||
want: "1.2.3.4", // target=1(not_ip 失败)→ i=0(1.2.3.4 成功)
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
trustedProxyHops = tt.mode
|
||||
r := httptest.NewRequest("GET", "/", nil)
|
||||
r.RemoteAddr = tt.remoteAddr
|
||||
if tt.xff != "" {
|
||||
r.Header.Set("X-Forwarded-For", tt.xff)
|
||||
}
|
||||
if tt.xri != "" {
|
||||
r.Header.Set("X-Real-IP", tt.xri)
|
||||
}
|
||||
got := GetClientIP(r)
|
||||
if got != tt.want {
|
||||
t.Errorf("GetClientIP() = %q, want %q", got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
// 重置为默认,避免影响其他测试或运行时行为
|
||||
trustedProxyHops = 0
|
||||
}
|
||||
+12
-5
@@ -10,7 +10,6 @@ import (
|
||||
|
||||
"github.com/volcano-tts/tts-api/adapter/volcano"
|
||||
"github.com/volcano-tts/tts-api/common"
|
||||
"github.com/volcano-tts/tts-api/dto"
|
||||
)
|
||||
|
||||
// 全部环境变量读取的单一入口:其它包不允许直接 os.Getenv,只读这里的全局 Config。
|
||||
@@ -46,6 +45,12 @@ type ServerConfig struct {
|
||||
|
||||
var Server ServerConfig
|
||||
|
||||
// TrustedProxyHops 由 middleware.InitRateLimiter 在启动期写入,
|
||||
// 表示当前 XFF 解析模式:0=启发式,N>0=精确 N 跳。
|
||||
// setting.LogStartupSummary 读这个字段以展示运行期配置,
|
||||
// 不直接调用 middleware(避免循环 import)。
|
||||
var TrustedProxyHops int
|
||||
|
||||
// InitAllConfigs 集中初始化所有配置,启动期调用一次。
|
||||
func InitAllConfigs() {
|
||||
InitServerConfig()
|
||||
@@ -257,6 +262,12 @@ func LogStartupSummary() {
|
||||
log.Printf("ALLOWED_ORIGINS: 已配置 %d 个允许的跨域来源白名单", len(CORS.Origins))
|
||||
}
|
||||
|
||||
if h := TrustedProxyHops; h == 0 {
|
||||
log.Printf("TRUSTED_PROXY_HOPS: 启发式模式(默认,XFF 链尾第一个公网 IP)")
|
||||
} else {
|
||||
log.Printf("TRUSTED_PROXY_HOPS: 精确模式,信任 %d 跳反代", h)
|
||||
}
|
||||
|
||||
log.Printf("火山 TTS 必填项状态:")
|
||||
type ttsCheck struct {
|
||||
name string
|
||||
@@ -305,7 +316,3 @@ func CheckStaticFiles() {
|
||||
log.Println("警告: health.html 不存在,/dashboard 路由将返回 404")
|
||||
}
|
||||
}
|
||||
|
||||
// 保留 dto.ByteDanceTTSConfig 引用避免 import 警告;
|
||||
// 新代码不应再使用这个类型,设置已在 TTSOptions 中。
|
||||
var _ = dto.ByteDanceTTSConfig{}
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
// Package version 提供构建时注入的版本信息。
|
||||
//
|
||||
// Version 和 Commit 在编译时通过 -ldflags 注入:
|
||||
//
|
||||
// go build -ldflags "-X github.com/volcano-tts/tts-api/version.Version=$VERSION \
|
||||
// -X github.com/volcano-tts/tts-api/version.Commit=$COMMIT"
|
||||
//
|
||||
// 开发时默认 "dev",CI/CD 时通常由 git describe 自动算出:
|
||||
// VERSION=$(git describe --tags --always --dirty)
|
||||
// COMMIT=$(git rev-parse --short HEAD)
|
||||
//
|
||||
// /health 端点会暴露这两个值,方便运维确认"跑的到底是哪个 commit"。
|
||||
package version
|
||||
|
||||
var (
|
||||
Version = "dev"
|
||||
Commit = "dev"
|
||||
)
|
||||
Reference in New Issue
Block a user