koishi-plugin-yyds-verifier 0.0.3

package/lib/index.d.ts

@@ -0,0 +1,30 @@
+import { Context, Schema } from "koishi";
+declare module "koishi" {
+    interface Context {
+        canvas: {
+            createCanvas(width: number, height: number): any;
+        };
+    }
+}
+export declare const name = "yyds-verifier";
+export declare const inject: string[];
+export declare const usage = "\n## \u4F7F\u7528\u8BF4\u660E\n\n\u672C\u63D2\u4EF6\u9700\u8981\u914D\u5408 `koishi-plugin-skia-canvas` \u4F7F\u7528\uFF0C\u8BF7\u786E\u4FDD\u5DF2\u5B89\u88C5\u5E76\u542F\u7528\u8BE5\u63D2\u4EF6\u3002\n\n### \u9A8C\u8BC1\u65B9\u5F0F\n- **code**: \u6570\u5B57\u9A8C\u8BC1\u7801\uFF0C\u7528\u6237\u9700\u8981\u8F93\u5165\u663E\u793A\u7684\u6570\u5B57\n- **math**: \u7B97\u6570\u9A8C\u8BC1\uFF0C\u7528\u6237\u9700\u8981\u8BA1\u7B97\u7B80\u5355\u7684\u52A0\u6CD5\u6216\u4E58\u6CD5\n- **image**: \u56FE\u50CF\u9A8C\u8BC1\u7801\uFF0C\u7528\u6237\u9700\u8981\u8BC6\u522B\u56FE\u7247\u4E2D\u7684\u5B57\u7B26\n- **random**: \u968F\u673A\u9009\u62E9\u4EE5\u4E0A\u4E09\u79CD\u65B9\u5F0F\u4E4B\u4E00\n";
+type VerifyMode = "code" | "math" | "image" | "random";
+export interface Config {
+    mode: VerifyMode;
+    timeout: number;
+    maxAttempts: number;
+    permanent: boolean;
+    codeLength: number;
+    whitelist: string[];
+    messages: {
+        prompt: string;
+        success: string;
+        failure: string;
+        timeout: string;
+        kicked: string;
+    };
+}
+export declare const Config: Schema<Config>;
+export declare function apply(ctx: Context, config: Config): void;
+export {};

package/lib/index.js

@@ -0,0 +1,265 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __export = (target, all) => {
+  for (var name2 in all)
+    __defProp(target, name2, { get: all[name2], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  Config: () => Config,
+  apply: () => apply,
+  inject: () => inject,
+  name: () => name,
+  usage: () => usage
+});
+module.exports = __toCommonJS(src_exports);
+var import_koishi = require("koishi");
+var name = "yyds-verifier";
+var inject = ["canvas"];
+var usage = `
+## 使用说明
+
+本插件需要配合 \`koishi-plugin-skia-canvas\` 使用，请确保已安装并启用该插件。
+
+### 验证方式
+- **code**: 数字验证码，用户需要输入显示的数字
+- **math**: 算数验证，用户需要计算简单的加法或乘法
+- **image**: 图像验证码，用户需要识别图片中的字符
+- **random**: 随机选择以上三种方式之一
+`;
+var logger = new import_koishi.Logger("yyds-verifier");
+var Config = import_koishi.Schema.object({
+  mode: import_koishi.Schema.union(["code", "math", "image", "random"]).default("code").description(
+    "验证方式：code=数字验证码, math=算数验证, image=图像验证码, random=随机"
+  ),
+  timeout: import_koishi.Schema.number().default(300).min(10).description("验证超时时间（秒）"),
+  maxAttempts: import_koishi.Schema.number().default(3).min(1).max(10).description("最大尝试次数"),
+  permanent: import_koishi.Schema.boolean().default(false).description("是否永久踢出（加入群黑名单，禁止再次加入）"),
+  codeLength: import_koishi.Schema.number().default(4).min(4).max(8).description("验证码长度（仅对 code 和 image 模式有效）"),
+  whitelist: import_koishi.Schema.array(String).default([]).description("白名单用户 ID 列表，这些用户入群时不需要验证"),
+  messages: import_koishi.Schema.object({
+    prompt: import_koishi.Schema.string().default(
+      "欢迎加入！请在 {timeout} 内完成验证。{question} 当前第 {attempt}/{maxAttempts} 次机会。"
+    ).description(
+      "验证提示消息。可用变量：{timeout} 超时时间, {question} 验证问题, {attempt} 当前次数, {maxAttempts} 最大次数"
+    ),
+    success: import_koishi.Schema.string().default("验证成功！欢迎加入本群。").description("验证成功消息"),
+    failure: import_koishi.Schema.string().default("验证失败，请重新输入。剩余 {remaining} 次机会。").description("验证失败消息。可用变量：{remaining} 剩余次数"),
+    timeout: import_koishi.Schema.string().default("验证超时，进入下一轮验证。剩余 {remaining} 次机会。").description("超时提示消息。可用变量：{remaining} 剩余次数"),
+    kicked: import_koishi.Schema.string().default("验证失败次数过多，已被移出群聊。").description("踢出消息")
+  }).description("自定义消息模板")
+});
+function apply(ctx, config) {
+  const verifyingUsers = /* @__PURE__ */ new Set();
+  const timeoutMs = config.timeout * 1e3;
+  function randomColor() {
+    const r = Math.floor(Math.random() * 200);
+    const g = Math.floor(Math.random() * 200);
+    const b = Math.floor(Math.random() * 200);
+    return `rgb(${r},${g},${b})`;
+  }
+  __name(randomColor, "randomColor");
+  function generateRandomCode(length) {
+    let code = "";
+    for (let i = 0; i < length; i++) {
+      code += Math.floor(Math.random() * 10);
+    }
+    return code;
+  }
+  __name(generateRandomCode, "generateRandomCode");
+  function generateCodeChallenge() {
+    const code = generateRandomCode(config.codeLength);
+    return {
+      prompt: `请发送验证码 ${code}`,
+      answer: code
+    };
+  }
+  __name(generateCodeChallenge, "generateCodeChallenge");
+  function generateMathChallenge() {
+    const a = Math.floor(Math.random() * 9) + 1;
+    const b = Math.floor(Math.random() * 9) + 1;
+    const ops = ["+", "×"];
+    const op = ops[Math.floor(Math.random() * 2)];
+    const answer = op === "+" ? a + b : a * b;
+    return {
+      prompt: `请计算 ${a} ${op} ${b} = ?`,
+      answer: String(answer)
+    };
+  }
+  __name(generateMathChallenge, "generateMathChallenge");
+  async function generateImageChallenge() {
+    const code = generateRandomCode(config.codeLength);
+    const width = 30 * config.codeLength + 20;
+    const height = 50;
+    const canvas = ctx.canvas.createCanvas(width, height);
+    const c = canvas.getContext("2d");
+    c.fillStyle = "#f0f0f0";
+    c.fillRect(0, 0, width, height);
+    for (let i = 0; i < 5; i++) {
+      c.strokeStyle = randomColor();
+      c.lineWidth = 1;
+      c.beginPath();
+      c.moveTo(Math.random() * width, Math.random() * height);
+      c.lineTo(Math.random() * width, Math.random() * height);
+      c.stroke();
+    }
+    for (let i = 0; i < 50; i++) {
+      c.fillStyle = randomColor();
+      c.beginPath();
+      c.arc(Math.random() * width, Math.random() * height, 1, 0, 2 * Math.PI);
+      c.fill();
+    }
+    c.font = "bold 32px Arial";
+    c.textBaseline = "middle";
+    for (let i = 0; i < code.length; i++) {
+      c.fillStyle = randomColor();
+      const x = 10 + i * 30 + Math.random() * 5;
+      const y = height / 2 + Math.random() * 10 - 5;
+      c.fillText(code[i], x, y);
+    }
+    const buffer = canvas.toBuffer("image/png");
+    return {
+      prompt: import_koishi.h.image(buffer, "image/png"),
+      answer: code
+    };
+  }
+  __name(generateImageChallenge, "generateImageChallenge");
+  async function generateChallenge(mode) {
+    const actualMode = mode === "random" ? ["code", "math", "image"][Math.floor(Math.random() * 3)] : mode;
+    switch (actualMode) {
+      case "code":
+        return generateCodeChallenge();
+      case "math":
+        return generateMathChallenge();
+      case "image":
+        return generateImageChallenge();
+    }
+  }
+  __name(generateChallenge, "generateChallenge");
+  function formatMessage(template, params) {
+    return template.replace(
+      /\{(\w+)\}/g,
+      (_, key) => params[key] !== void 0 ? String(params[key]) : `{${key}}`
+    );
+  }
+  __name(formatMessage, "formatMessage");
+  function formatTimeout(seconds) {
+    if (seconds >= 60) {
+      const minutes = Math.floor(seconds / 60);
+      return `${minutes} 分钟`;
+    }
+    return `${seconds} 秒`;
+  }
+  __name(formatTimeout, "formatTimeout");
+  function extractAnswer(content) {
+    return content.replace(/<at[^>]*\/>/g, "").trim();
+  }
+  __name(extractAnswer, "extractAnswer");
+  ctx.on("guild-member-added", async (session) => {
+    const { userId, guildId, selfId, bot } = session;
+    if (userId === selfId) return;
+    if (config.whitelist.includes(userId)) {
+      logger.info(`User ${userId} is in whitelist, skipping verification`);
+      return;
+    }
+    const userKey = `${guildId}:${userId}`;
+    if (verifyingUsers.has(userKey)) return;
+    verifyingUsers.add(userKey);
+    logger.info(
+      `New member ${userId} joined guild ${guildId}, starting verification`
+    );
+    try {
+      for (let attempt = 1; attempt <= config.maxAttempts; attempt++) {
+        const challenge = await generateChallenge(config.mode);
+        const timeoutDisplay = formatTimeout(config.timeout);
+        const remaining = config.maxAttempts - attempt;
+        const promptText = formatMessage(config.messages.prompt, {
+          timeout: timeoutDisplay,
+          question: typeof challenge.prompt === "string" ? challenge.prompt : "请识别图片中的验证码",
+          attempt,
+          maxAttempts: config.maxAttempts
+        });
+        const messageElements = [
+          (0, import_koishi.h)("at", { id: userId }),
+          " ",
+          promptText
+        ];
+        if (typeof challenge.prompt !== "string") {
+          messageElements.push("\n", challenge.prompt);
+        }
+        await session.send(messageElements);
+        logger.debug(
+          `Verification for ${userKey}, attempt ${attempt}, answer: ${challenge.answer}`
+        );
+        const input = await session.prompt(timeoutMs);
+        if (!input) {
+          if (remaining > 0) {
+            await session.send([
+              (0, import_koishi.h)("at", { id: userId }),
+              " ",
+              formatMessage(config.messages.timeout, { remaining })
+            ]);
+            continue;
+          } else {
+            break;
+          }
+        }
+        const userAnswer = extractAnswer(input);
+        if (userAnswer === challenge.answer) {
+          await session.send([
+            (0, import_koishi.h)("at", { id: userId }),
+            " ",
+            config.messages.success
+          ]);
+          logger.info(`User ${userId} passed verification in guild ${guildId}`);
+          return;
+        } else {
+          if (remaining > 0) {
+            await session.send([
+              (0, import_koishi.h)("at", { id: userId }),
+              " ",
+              formatMessage(config.messages.failure, { remaining })
+            ]);
+            continue;
+          } else {
+            break;
+          }
+        }
+      }
+      await session.send([
+        (0, import_koishi.h)("at", { id: userId }),
+        " ",
+        config.messages.kicked
+      ]);
+      await bot.kickGuildMember(guildId, userId, config.permanent);
+      logger.info(`Kicked user ${userId} from guild ${guildId}`);
+    } catch (error) {
+      logger.error(`Verification error for ${userId}:`, error);
+    } finally {
+      verifyingUsers.delete(userKey);
+    }
+  });
+}
+__name(apply, "apply");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Config,
+  apply,
+  inject,
+  name,
+  usage
+});

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "koishi-plugin-yyds-verifier",
+  "description": "入群验证插件，支持数字验证码、算数验证、图像验证码等多种验证方式",
+  "version": "0.0.3",
+  "main": "lib/index.js",
+  "typings": "lib/index.d.ts",
+  "files": [
+    "lib",
+    "dist"
+  ],
+  "license": "MIT",
+  "keywords": [
+    "chatbot",
+    "koishi",
+    "plugin",
+    "verification",
+    "captcha"
+  ],
+  "peerDependencies": {
+    "koishi": "^4.18.10",
+    "koishi-plugin-skia-canvas": "^0.4.8"
+  }
+}

package/readme.md

@@ -0,0 +1,139 @@
+# koishi-plugin-yyds-verifier
+
+[![npm](https://img.shields.io/npm/v/koishi-plugin-yyds-verifier?style=flat-square)](https://www.npmjs.com/package/koishi-plugin-yyds-verifier)
+
+入群验证插件，支持多种验证方式，有效防止机器人和恶意用户入群。
+
+## 功能特性
+
+- **多种验证方式**
+  - 数字验证码：用户需要输入显示的数字
+  - 算数验证：用户需要计算简单的加法或乘法（如 3+5=? 或 4×7=?）
+  - 图像验证码：用户需要识别图片中的字符
+  - 随机模式：随机选择以上三种方式之一
+
+- **白名单功能**：指定用户入群时无需验证
+
+- **可配置参数**
+  - 验证超时时间
+  - 最大尝试次数
+  - 验证码长度
+  - 自定义消息模板
+
+- **安全特性**
+  - 验证失败自动踢出
+  - 可选永久踢出（加入群黑名单）
+
+## 安装
+
+### 前置依赖
+
+本插件需要 `koishi-plugin-skia-canvas` 作为依赖，请先安装：
+
+```bash
+npm install koishi-plugin-skia-canvas
+```
+
+### 安装插件
+
+```bash
+npm install koishi-plugin-yyds-verifier
+```
+
+## 配置项
+
+| 配置项 | 类型 | 默认值 | 说明 |
+|--------|------|--------|------|
+| mode | string | `'code'` | 验证方式：`code`=数字验证码, `math`=算数验证, `image`=图像验证码, `random`=随机 |
+| timeout | number | `300` | 验证超时时间（秒） |
+| maxAttempts | number | `3` | 最大尝试次数 |
+| permanent | boolean | `false` | 是否永久踢出（加入群黑名单） |
+| codeLength | number | `4` | 验证码长度（仅对 code 和 image 模式有效） |
+| whitelist | string[] | `[]` | 白名单用户 ID 列表 |
+| messages | object | - | 自定义消息模板 |
+
+### 消息模板
+
+| 配置项 | 默认值 | 可用变量 |
+|--------|--------|----------|
+| messages.prompt | `'欢迎加入！请在 {timeout} 内完成验证。{question} 当前第 {attempt}/{maxAttempts} 次机会。'` | `{timeout}` `{question}` `{attempt}` `{maxAttempts}` |
+| messages.success | `'验证成功！欢迎加入本群。'` | - |
+| messages.failure | `'验证失败，请重新输入。剩余 {remaining} 次机会。'` | `{remaining}` |
+| messages.timeout | `'验证超时，进入下一轮验证。剩余 {remaining} 次机会。'` | `{remaining}` |
+| messages.kicked | `'验证失败次数过多，已被移出群聊。'` | - |
+
+## 使用示例
+
+### 基础配置
+
+```yaml
+plugins:
+  yyds-verifier:
+    mode: code
+    timeout: 300
+    maxAttempts: 3
+```
+
+### 使用算数验证
+
+```yaml
+plugins:
+  yyds-verifier:
+    mode: math
+    timeout: 120
+    maxAttempts: 3
+```
+
+### 使用图像验证码
+
+```yaml
+plugins:
+  yyds-verifier:
+    mode: image
+    timeout: 180
+    codeLength: 4
+```
+
+### 配置白名单
+
+```yaml
+plugins:
+  yyds-verifier:
+    mode: random
+    whitelist:
+      - '123456789'
+      - '987654321'
+```
+
+## 验证流程
+
+```
+用户入群
+    ↓
+检查白名单 → 在白名单中 → 跳过验证
+    ↓ 不在白名单
+生成验证挑战
+    ↓
+发送验证提示
+    ↓
+等待用户输入 → 超时 → 还有机会? → 是 → 下一轮
+    ↓                              ↓ 否
+验证答案                          踢出用户
+    ↓
+正确 → 验证成功
+    ↓ 错误
+还有机会? → 是 → 提示错误，继续等待
+    ↓ 否
+踢出用户
+```
+
+## 注意事项
+
+1. 机器人需要有踢人权限才能正常工作
+2. 建议将验证超时时间设置在 60-300 秒之间
+3. 图像验证码模式需要 `koishi-plugin-skia-canvas` 支持
+4. 白名单中的用户 ID 需要是字符串格式
+
+## 许可证
+
+MIT