Merge branch 'dev'

Author: idootop

.env.example

@@ -1,4 +1,6 @@
-TTS_DEFAULT_SPEAKER=默认音色名称，比如：东北老铁（可选）
+# 基础配置
+# SECRET_PATH=你的接口访问秘密路径，比如：are-you-ok（可选）
+# TTS_DEFAULT_SPEAKER=默认音色名称，比如：东北老铁（可选）
 
 # 火山引擎，官方文档：https://www.volcengine.com/docs/6561/79817
 VOLCANO_TTS_APP_ID=火山引擎语音合成 APP ID

README.md

@@ -58,6 +58,16 @@ async function main() {
 main();
 ```
 
+## 🔊 音色列表
+
+当前支持的完整音色列表和音色名称，可在以下列表中查询：
+
+- [火山引擎](https://github.com/idootop/mi-gpt-tts/blob/main/src/tts/volcano.ts)
+- [微软必应](https://github.com/idootop/mi-gpt-tts/blob/main/src/tts/edge.ts)
+- [OpenAI](https://github.com/idootop/mi-gpt-tts/blob/main/src/tts/openai.ts)
+
+> 注意：列表中不存在的音色，无法直接使用。请提 PR 或自行修改代码添加额外的音色。
+
 ## 📖 使用文档
 
 以下为更详细的使用教程，大多数问题都可在 [💬 常见问题](https://github.com/idootop/mi-gpt-tts/blob/main/docs/faq.md) 中找到答案。

docs/changelog.md

@@ -1,3 +1,18 @@
+# v3.0.0
+
+## 🚨 风险预警
+
+根据用户反馈，有人正在根据  `MiGPT-TTS` 默认 `4321` 端口 + API 路径特征，搜集公网上的相关服务资产。
+
+出于安全考虑，`MiGPT-TTS` 从 v3.0.0 版本开始，访问语音合成接口需要带上 `SECRET_PATH` 防止他人盗刷接口。
+
+如果你正在公网使用旧版 `MiGPT-TTS`，建议立即更新到 v3.0.0 版本，防止接口被盗刷。
+
+## ✨ 更新内容
+
+- ✅ 新增 `SECRET_PATH` 接口访问凭证，防止接口被盗刷
+- ✅ 优化接口访问提示文案
+
 # v2.0.0
 
 新增对 [edge-tts](https://github.com/rany2/edge-tts) 和 [OpenAI TTS](https://platform.openai.com/docs/guides/text-to-speech) 的支持，相关配置参数请[在此查看](https://github.com/idootop/mi-gpt-tts/blob/main/docs/settings.md)。

docs/mi-gpt.md

@@ -25,25 +25,39 @@
 
 然后，将里面的环境变量修改成你自己的，参数含义如下：
 
-| 环境变量名称               | 描述                                                                                                | 示例              |
-| -------------------------- | --------------------------------------------------------------------------------------------------- | ----------------- |
-| `VOLCANO_TTS_APP_ID`       | 火山引擎语音合成 APP ID                                                                             | `123456`          |
-| `VOLCANO_TTS_ACCESS_TOKEN` | 火山引擎语音合成 Access Token                                                                       | `xxxxxx`          |
-| `TTS_DEFAULT_SPEAKER`      | 默认音色名称或 ID（可选，查看完整[音色列表](https://www.volcengine.com/docs/6561/97465)和费用详情） | `BV700_streaming` |
+| 环境变量名称               | 描述                                                                                                | 示例                            |
+| -------------------------- | --------------------------------------------------------------------------------------------------- | ------------------------------- |
+| `VOLCANO_TTS_APP_ID`       | 火山引擎语音合成 APP ID                                                                             | `123456`                        |
+| `VOLCANO_TTS_ACCESS_TOKEN` | 火山引擎语音合成 Access Token                                                                       | `xxxxxx`                        |
+| `SECRET_PATH`              | 访问秘密路径，相当于访问密码。推荐长度大于 6，由字母、数字、- 和 \_ 组成，为空时每次启动随机生成    | `Are-You-OK` (不要直接用这个！) |
+| `TTS_DEFAULT_SPEAKER`      | 默认音色名称或 ID（可选，查看完整[音色列表](https://www.volcengine.com/docs/6561/97465)和费用详情） | `BV700_streaming`               |
 
-### 3. 部署 MiGPT-TTS 服务
+> 注意：出于安全考虑，从 v3.0.0 版本开始，访问语音合成接口需要带上 `SECRET_PATH` 防止他人盗刷接口。
+> 如果 `SECRET_PATH` 环境变量为空，每次启动服务则会生成随机访问密码。
 
-考虑到国内网络访问 [Vercel](https://vercel.com) 并不友好，此处仅提供 Docker 部署方式。
+### 3. 部署 MiGPT-TTS 服务
 
 [![Docker Image Version](https://img.shields.io/docker/v/idootop/mi-gpt-tts?color=%23086DCD&label=docker%20image)](https://hub.docker.com/r/idootop/mi-gpt-tts)
 
+环境变量配置完成后，请在对应目录运行以下命令，启动服务：
+
 ```shell
 docker run -d --env-file $(pwd)/.env -p 4321:3000 idootop/mi-gpt-tts:latest
 ```
 
-启动成功后，访问 `http://[你的公网/局域网地址]:4321/api/tts.mp3` 即可查看语音合成效果。
+启动成功后，可在控制台的日志输出中查看接口地址，比如：
+
+```shell
+MiGPT-TTS: v3.0.0  by: del.wang
+
+接口地址：http://localhost:3000/7a0e9f21/api
+
+✅ 服务已启动...
+```
+
+访问 `http://[IP]:[PORT]/[SECRET_PATH]/api/tts.mp3` 即可查看语音合成效果。
 
-> 注意：如果你是通过 Node.js 本地启动本项目，则默认服务端口为 `3000`。
+> 注意：这里的端口（PORT）是你为 Docker 分配的实际端口，不推荐使用默认的 4321 端口。如果你是通过 Node.js 本地启动本项目，则默认端口为 `3000`。
 
 ### 4. 修改 MiGPT 默认 TTS 引擎
 
@@ -54,7 +68,7 @@ docker run -d --env-file $(pwd)/.env -p 4321:3000 idootop/mi-gpt-tts:latest
 
 ```js
 // mi-gpt/.env
-TTS_BASE_URL=http://[你的公网/局域网地址]:[端口号]/api
+TTS_BASE_URL=http://[IP]:[PORT]/[SECRET_PATH]/api
 
 // mi-gpt/.migpt.js
 export default {
@@ -76,8 +90,8 @@ export default {
 
 ```shell
 # mi-gpt/.env
-AUDIO_SILENT=http://[你的公网/局域网地址]:[端口号]/slient.wav
-AUDIO_BEEP=http://[你的公网/局域网地址]:[端口号]/beep.wav
-AUDIO_ACTIVE=http://[你的公网/局域网地址]:[端口号]/active.wav
-AUDIO_ERROR=http://[你的公网/局域网地址]:[端口号]/error.wav
+AUDIO_SILENT=http://[IP]:[PORT]/[SECRET_PATH]/slient.wav
+AUDIO_BEEP=http://[IP]:[PORT]/[SECRET_PATH]/beep.wav
+AUDIO_ACTIVE=http://[IP]:[PORT]/[SECRET_PATH]/active.wav
+AUDIO_ERROR=http://[IP]:[PORT]/[SECRET_PATH]/error.wav
 ```

server.js

@@ -1,18 +1,32 @@
 import http from "http";
 import apiSpeakers from "./api/speakers.js";
 import apiTTS from "./api/tts.mp3.js";
-import { createReadStream, statSync } from "fs";
+import { createReadStream, readFileSync, statSync } from "fs";
+import { randomUUID } from "crypto";
 
-const exists = (path) => {
-  try {
-    return statSync(path).isFile();
-  } catch (e) {
-    return false;
-  }
-};
+const kPort = process.env.PORT || 3000;
+const kVersion = JSON.parse(readFileSync("package.json")).version;
+const kSecretPath = process.env.SECRET_PATH || randomUUID().substring(0, 8);
 
 const server = http.createServer((req, res) => {
-  req.url = req.url.replace("+text=", "&text="); // 修正请求 URL
+  // 返回提示字符串
+  const response = (msg) => {
+    res.writeHead(404, { "Content-Type": "text/plain; charset=utf-8" });
+    res.end(Buffer.from(msg, "utf8"));
+  };
+
+  // 修正请求 URL 中的转义字符
+  req.url = req.url.replace("+text=", "&text=");
+
+  // 校验 secret path
+  const secretPath = req.url.split("/")[1];
+  if (secretPath !== kSecretPath) {
+    console.log("❌ 非法请求" + decodeURI(req.url));
+    return response("❌ 非法请求");
+  }
+
+  // 解析原始请求 URL
+  req.url = req.url.split(kSecretPath)[1];
   const { pathname } = new URL("http://127.0.0.1" + req.url);
   const filePath = `public${pathname}`;
 
@@ -30,14 +44,24 @@ const server = http.createServer((req, res) => {
     const readStream = createReadStream(filePath);
     readStream.pipe(res);
   } else {
-    res.writeHead(404, { "Content-Type": "text/plain" });
-    res.end("404");
+    response("✅ 服务已启动");
   }
 });
 
-const PORT = process.env.PORT || 3000;
-server.listen(PORT, () => {
-  console.log(`MiGPT-TTS is running on port ${PORT}\n`);
-  console.log("version: v2.0.0  by: del.wang\n");
-  console.log("✅ 服务已启动...\n");
+server.listen(kPort, () => {
+  console.log(
+    [
+      `MiGPT-TTS: v${kVersion}  by: del.wang`,
+      `接口地址: http://localhost:${kPort}/${kSecretPath}/api`,
+      "✅ 服务已启动...\n",
+    ].join("\n\n")
+  );
 });
+
+function exists(path) {
+  try {
+    return statSync(path).isFile();
+  } catch (e) {
+    return false;
+  }
+}

src/common/stream.ts

@@ -27,7 +27,7 @@ export const createStreamHandler = (responseStream: Readable) => {
 
   const error = (err: any, msg = "Something went wrong") => {
     console.log(requestId, "❌ " + msg, err);
-    responseStream.push("404");
+    responseStream.push("error");
     responseStream.push(null);
     reject();
   };