@karinjs/adapter-qqbot 1.2.9 → 1.2.10

package/lib/core/internal/sign.js

@@ -0,0 +1,40 @@
+import nacl from 'tweetnacl';
+/**
+ * 从提供的种子生成密钥对
+ * @param seed 用于生成密钥的种子
+ */
+export const generateKeyPair = (seed) => {
+    let finalSeed = seed;
+    while (finalSeed.length < 32) {
+        finalSeed = finalSeed.repeat(2); // 确保种子长度至少为32字节
+    }
+    finalSeed = finalSeed.slice(0, 32); // 截断为32字节
+    const seedBuffer = Buffer.from(finalSeed, 'utf-8');
+    const keyPair = nacl.sign.keyPair.fromSeed(seedBuffer);
+    return keyPair;
+};
+/**
+ * 使用提供的私钥、事件时间戳和明文令牌对消息进行签名
+ * @param privateKey 用于签名的私钥
+ * @param eventTs 计算签名使用时间戳
+ * @param plainToken 需要计算签名的字符串
+ * @returns 生成的十六进制格式的签名
+ */
+export const signMessage = (privateKey, eventTs, plainToken) => {
+    const message = eventTs + plainToken;
+    const messageBytes = Buffer.from(message, 'utf-8');
+    const signature = nacl.sign.detached(messageBytes, privateKey);
+    return Buffer.from(signature).toString('hex');
+};
+/**
+ * 签名
+ * @param secret 机器人密钥
+ * @param eventTs 计算签名使用时间戳
+ * @param plainToken 需要计算签名的字符串
+ * @returns 生成的十六进制格式的签名
+ */
+export const sign = (secret, eventTs, plainToken) => {
+    const { secretKey } = generateKeyPair(secret);
+    const signature = signMessage(secretKey, eventTs, plainToken);
+    return signature;
+};

package/lib/core/webhook/c2c.d.ts

@@ -0,0 +1,2 @@
+/** 创建端到端webhook路由 */
+export declare const createC2CWebhook: () => void;

package/lib/core/webhook/c2c.js

@@ -0,0 +1,14 @@
+import { webhook } from '.';
+import { app } from 'node-karin';
+import { expressAfterInit } from '@/utils/common';
+/** 创建端到端webhook路由 */
+export const createC2CWebhook = () => {
+    const c2cRouting = '/webhook/c2c';
+    /**
+   * api 端到端
+   * tx -> bot/webhook
+   */
+    app.post(c2cRouting, (req, res) => webhook(req, res, () => true));
+    /** 调整中间件顺序 不使用json中间件 */
+    expressAfterInit(app._router.stack, c2cRouting, 'post');
+};

package/lib/core/webhook/http.d.ts

@@ -0,0 +1,2 @@
+/** 创建http中转webhook路由 */
+export declare const createHttpWebhook: () => void;

package/lib/core/webhook/http.js

@@ -0,0 +1,35 @@
+import { webhook } from '.';
+import { app, } from 'node-karin';
+import { config } from '@/utils/config';
+import { expressAfterInit, fakeEvent } from '@/utils/common';
+/** 创建http中转webhook路由 */
+export const createHttpWebhook = () => {
+    const httpRouting = '/webhook/http';
+    /**
+   * api 中转
+   * tx -> webhook ->bot/http
+   */
+    app.post(httpRouting, (req, res) => webhook(req, res, (req, appid) => {
+        const auth = req.headers['authorization'];
+        if (!auth) {
+            fakeEvent(`${appid} 未在头部中找到 Authorization: ${req.socket.remoteAddress}`);
+            return false;
+        }
+        const cfg = config()[appid];
+        if (!cfg) {
+            fakeEvent(`[配置错误][${appid}] 配置文件中未找到对应的appid，请检查配置文件`);
+            return false;
+        }
+        if (cfg.event.type !== 2) {
+            fakeEvent(`${appid} http中转服务未启用，请检查配置文件: ${req.socket.remoteAddress}`);
+            return false;
+        }
+        if (auth !== cfg.event.httpToken) {
+            fakeEvent(`${appid} Authorization 验证失败: ${req.socket.remoteAddress}`);
+            return false;
+        }
+        return true;
+    }));
+    /** 调整中间件顺序 不使用json中间件 */
+    expressAfterInit(app._router.stack, httpRouting, 'post');
+};

package/lib/core/webhook/index.d.ts

@@ -0,0 +1,17 @@
+import { Request, Response } from 'express';
+/**
+ * webhook
+ * @param req 请求
+ * @param res 响应
+ */
+export declare const webhook: (req: Request, res: Response, fnc: Function) => Promise<void>;
+/**
+ * 判断请求是否合规并返回appid
+ * @param req 请求
+ * @param res 响应
+ */
+export declare const checkAppid: (req: Request, res: Response) => Promise<{
+    appid: string;
+    rawBody: string;
+    body: Record<string, any>;
+} | undefined>;

package/lib/core/webhook/index.js

@@ -0,0 +1,87 @@
+import { sign } from '../api/sign';
+import { logger } from 'node-karin';
+import { config } from '@/utils/config';
+import { event, fakeEvent } from '@/utils/common';
+/**
+ * webhook
+ * @param req 请求
+ * @param res 响应
+ */
+export const webhook = async (req, res, fnc) => {
+    const data = await checkAppid(req, res);
+    if (!data)
+        return;
+    if (!fnc(req))
+        return;
+    const api = config()[data.appid];
+    if (!api) {
+        logger.error(`[配置错误][${data.appid}] 配置文件中未找到对应的appid，请检查配置文件`);
+        return;
+    }
+    if (api.event.type !== 1) {
+        logger.error(`[配置错误][${data.appid}] webhook未启用，请检查配置文件`);
+        return;
+    }
+    /** 接口初始化 鉴权回调 */
+    if (data.body.op === 13) {
+        const eventTs = data.body?.d?.event_ts;
+        const plainToken = data.body?.d?.plain_token;
+        if (!eventTs || !plainToken) {
+            logger.error(`[请求数据错误][${data.appid}] 未找到 event_ts 或 plain_token: ${data.rawBody}`);
+            return;
+        }
+        const signature = sign(api.secret, eventTs, plainToken);
+        logger.mark(`[signature][${data.appid}] ${signature}`);
+        res.setHeader('Content-Type', 'application/json');
+        res.status(200).end(JSON.stringify({ plain_token: plainToken, signature }));
+        return;
+    }
+    /** 非回调事件 进行鉴权验证 */
+    const ed25519 = req.headers['x-signature-ed25519'];
+    const signature = sign(api.secret, req.headers['x-signature-timestamp'], data.rawBody);
+    if (ed25519 !== signature) {
+        fakeEvent(`签名验证失败:\nappid: ${data.appid}\ned25519: ${ed25519}\n实际签名: ${signature}\nbody: ${data.rawBody}`);
+        return;
+    }
+    event.emit(data.appid, data.body);
+};
+/**
+ * 判断请求是否合规并返回appid
+ * @param req 请求
+ * @param res 响应
+ */
+export const checkAppid = async (req, res) => {
+    let response = true;
+    try {
+        const ip = req.socket.remoteAddress;
+        const appid = req.headers['x-bot-appid'];
+        const rawBody = await new Promise((resolve) => {
+            const raw = [];
+            req.on('data', (chunk) => raw.push(chunk));
+            req.on('end', () => resolve(raw.join('')));
+        });
+        if (!appid) {
+            fakeEvent(`未找到 x-bot-appid: ${ip} body: ${rawBody}`);
+            return;
+        }
+        const userAgent = req.headers['user-agent'];
+        if (userAgent !== 'QQBot-Callback') {
+            fakeEvent(`未找到 User-Agent: ${ip} body: ${rawBody}`);
+            return;
+        }
+        const body = JSON.parse(rawBody) || {};
+        if (typeof body.op !== 'number') {
+            fakeEvent(`非法请求体，未找到 op: ${ip} body: ${rawBody}`);
+            return;
+        }
+        else if (body.op === 13) {
+            /** op13是计算sign返回  不可以直接返回状态码 */
+            response = false;
+        }
+        return { appid, rawBody, body };
+    }
+    finally {
+        /** 根据文档 返回200或者204都可以 必须在3秒内完成 */
+        response && res.status(200).end();
+    }
+};

package/lib/core/webhook/ws.d.ts

@@ -0,0 +1,2 @@
+/** 创建ws中转路由 */
+export declare const createWebSocketWebhook: () => void;

package/lib/core/webhook/ws.js

@@ -0,0 +1,79 @@
+import WebSocket from 'node-karin/ws';
+import { config } from '@/utils/config';
+import { logger } from 'node-karin';
+import { sign } from '../api/sign';
+import { event, fakeEvent } from '@/utils/common';
+/** 创建ws中转路由 */
+export const createWebSocketWebhook = () => {
+    const cfg = config();
+    for (const appid of Object.keys(cfg)) {
+        const api = cfg[appid];
+        if (appid === 'default')
+            continue;
+        if (api?.event?.type !== 3)
+            continue;
+        const url = api.event.wsUrl;
+        const headers = { 'x-bot-appid': appid, authorization: api.event.wsToken };
+        createWebSocket(api, url, headers);
+    }
+};
+const createWebSocket = (cfg, url, headers) => {
+    const socket = new WebSocket(url, { headers });
+    const appid = headers['x-bot-appid'];
+    const close = (isClose = true) => {
+        /** 停止监听 */
+        socket.removeAllListeners();
+        isClose && socket?.close();
+        logger.error(`[QQBot][${appid}] WebSocket连接已断开，将在5秒后重连: ${url}`);
+        setTimeout(() => createWebSocket(cfg, url, headers), 5000);
+    };
+    socket.on('close', () => close(false));
+    socket.on('error', (error) => { logger.error(error); close(); });
+    socket.on('open', () => logger.info(`[QQBot][${appid}] WebSocket连接已打开: ${url}`));
+    socket.on('message', (data) => {
+        const raw = data.toString();
+        const parse = JSON.parse(raw);
+        if (parse?.type === 'event') {
+            return eventHandler(appid, cfg.secret, raw, parse);
+        }
+        if (parse?.type === 'sign') {
+            signHandler(appid, cfg.secret, raw, parse, socket);
+        }
+        logger.error(`[QQBot][${appid}] 未知的消息类型: ${raw}`);
+    });
+};
+/**
+ * 事件处理
+ * @param appid 机器人id
+ * @param secret 机器人密钥
+ * @param raw 原始数据
+ * @param parse 解析后的数据
+ */
+const eventHandler = (appid, secret, raw, parse) => {
+    if (!parse?.data?.headers || !parse?.data?.headers['x-signature-ed25519'] || !parse?.data?.headers['x-signature-timestamp']) {
+        fakeEvent(`未找到签名字段: ${raw}`);
+        return;
+    }
+    const signature = sign(secret, parse.data.headers['x-signature-timestamp'], parse.data.event);
+    if (signature !== parse.data.headers['x-signature-ed25519']) {
+        logger.error(`[QQBot][${appid}] 签名验证失败: ${raw}`);
+        return;
+    }
+    event.emit(appid, JSON.parse(parse.data.event));
+};
+/**
+ * 签名处理
+ * @param appid 机器人id
+ * @param secret 机器人密钥
+ * @param raw 原始数据
+ * @param parse 解析后的数据
+ * @param socket websocket实例
+ */
+const signHandler = (appid, secret, raw, parse, socket) => {
+    if (!parse?.data?.eventTs || !parse?.data?.plainToken) {
+        logger.error(`[QQBot][${appid}] 未找到 eventTs 或 plainToken: ${raw}`);
+        return;
+    }
+    const signature = sign(secret, parse.data.eventTs, parse.data.plainToken);
+    socket.send(JSON.stringify({ echo: parse.echo, data: { signature } }));
+};

package/lib/index.d.ts

@@ -1,3 +1 @@
-import './core/index.js';
-import Jimp from 'jimp';
-export default Jimp;
+import '@/core/event/index';

package/lib/index.js

@@ -1,7 +1,5 @@
-import './core/index.js';
-import Jimp from 'jimp';
-import { logger, common } from 'node-karin';
-import { basename, dirPath } from './utils/dir.js';
-const pkg = common.readJson(dirPath + '/package.json');
-logger.info(`${logger.violet(`[插件:${pkg.version}]`)} ${logger.green(basename)} 初始化完成~`);
-export default Jimp;
+import '@/core/event/index';
+import { logger } from 'node-karin';
+import { basename, config } from '@/utils';
+/** 请不要在这编写插件 不会有任何效果~ */
+logger.info(`${logger.violet(`[插件:${config.pkg().version}]`)} ${logger.green(basename)} 初始化完成~`);

package/lib/root.d.ts

@@ -0,0 +1,5 @@
+/** 插件包绝对路径 */
+declare const dirPath: string;
+/** 插件包的名称 */
+declare const basename: string;
+export { dirPath, basename };

package/lib/root.js

@@ -0,0 +1,9 @@
+import path from 'path';
+import { fileURLToPath } from 'url';
+/** 当前文件的绝对路径 */
+const filePath = fileURLToPath(import.meta.url);
+/** 插件包绝对路径 */
+const dirPath = path.resolve(filePath, '../..');
+/** 插件包的名称 */
+const basename = path.basename(dirPath);
+export { dirPath, basename };

package/lib/types/config.d.ts

@@ -0,0 +1,53 @@
+/** markdown */
+type Markdown = {
+    /** markdown模式 */
+    mode: 0 | 1 | 3 | 4 | 5;
+    /** 模板ID */
+    id: string;
+    /** 模板键配置 */
+    kv: string[];
+};
+/** `config.yaml` 文件的类型定义 */
+export type Config = Record<string, {
+    /** 机器人ID */
+    appId: string;
+    /** 机器人密钥 */
+    secret: string;
+    /** 正式环境Api */
+    prodApi: string;
+    /** 测试环境Api */
+    sandboxApi: string;
+    /** 调用凭证的Api */
+    tokenApi: string;
+    /** 开启沙盒环境 */
+    sandbox: boolean;
+    /** 开启QQ场景能力 */
+    qqEnable: boolean;
+    /** 开启频道场景能力 */
+    guildEnable: boolean;
+    /** 频道场景模式 0-公域 1-私域 */
+    guildMode: 0 | 1;
+    /** 文本中的url转二维码白名单 配置后将不转换这些url为二维码 */
+    exclude: string[];
+    /** Markdown */
+    markdown: Markdown;
+    /** 接受到消息后对文本进行表达式处理 */
+    regex: {
+        /** 表达式 */
+        reg: string | RegExp;
+        /** 替换 */
+        rep: string;
+    }[];
+    /** 事件接收配置 */
+    event: {
+        /** 接收方式 0-关闭 1-webhook 2-http 3-ws */
+        type: 0 | 1 | 2 | 3;
+        /** ws服务器地址 */
+        wsUrl: string;
+        /** ws服务器鉴权token */
+        wsToken: string;
+        /** http鉴权token */
+        httpToken: string;
+    };
+}>;
+export {};

package/lib/utils/common.d.ts

@@ -1,66 +1,80 @@
+import EventEmitter from 'node:events';
 import { ButtonElement } from 'node-karin';
 /**
- * 二维码返回参数
+ * 事件总线
  */
-export interface QRRes {
-    /** 二维码base64 */
-    base64: string;
-    /** 宽度 */
+export declare const event: EventEmitter<[never]>;
+/**
+ * 睡眠函数
+ * @param ms - 毫秒
+ */
+export declare const sleep: (ms: number) => Promise<unknown>;
+/**
+ * 生成随机数
+ * @param min - 最小值
+ * @param max - 最大值
+ */
+export declare const random: (min: number, max: number) => number;
+/**
+ * 调整express中间件和路由的顺序，将路由提升到中间件前面
+ * @param stack - express实例的stack
+ * @param path - 路由名称
+ * @param method - 请求方法
+ * @param middlewareName - 中间件名称
+ */
+export declare const expressStack: (stack: any[], path: string, method: "use" | "get" | "post" | "put" | "delete", middlewareName: string) => void;
+/**
+ * 调整express路由的顺序 使其在`expressInit`之后
+ * @param stack - express实例的stack
+ * @param path - 路由名称
+ * @param method - 请求方法
+ */
+export declare const expressAfterInit: (stack: any[], path: string, method: "use" | "get" | "post" | "put" | "delete") => void;
+/**
+ * 虚假事件
+ * @param log 日志
+ */
+export declare const fakeEvent: (log: string) => void;
+/**
+ * 处理url
+ * @param text - 文本
+ * @param exclude - 排除的URL
+ * @returns url列表
+ */
+export declare const handleUrl: (text: string, exclude?: string[]) => string[];
+/**
+ * 生成二维码
+ * @param urls - url列表
+ * @returns 返回带`base64://`前缀的二维码列表
+ */
+export declare const qrs: (urls: string[]) => Promise<string[]>;
+/**
+ * 语音文件转silk
+ * @param file 文件路径 base64 buffer
+ * @returns silk文件buffer
+ */
+export declare const silkEncode: (file: string | Buffer) => Promise<Buffer>;
+/**
+ * 处理文本 提取其中的url转为按钮
+ * @param text - 文本
+ * @param isC2C - 是否为C2C消息
+ */
+export declare const textToButton: (text: string, isC2C?: boolean) => {
+    text: string;
+    buttons: ButtonElement[];
+};
+/**
+ * 传入一个图片链接，获取图片的宽高
+ * @param url - 图片链接
+ * @returns 图片的宽高
+ */
+export declare const getImageSize: (url: string) => Promise<{
     width: number;
-    /** 高度 */
     height: number;
-}
-declare class Common {
-    /** ffmpeg */
-    ffmpeg: string;
-    constructor();
-    random(min: number, max: number): number;
-    /**
-       * 语音转silk
-       * @param voice - 语音文件
-       * @returns silk buffer
-       */
-    voiceToSilk(voice: string): Promise<string>;
-    /**
-       * 初始化ffmpeg
-       */
-    initFfmpeg(): Promise<void>;
-    /**
-       * 处理URL
-       * @param url - URL
-       * @param exclude - 排除的URL
-       */
-    getUrls(url: string, exclude?: never[]): string[];
-    /**
-       * 传入URL数组，转为二维码base64
-       * @param urls - URL数组
-       */
-    getQrCode(urls: string[]): Promise<QRRes>;
-    /**
-       * 传入文本 返回处理后的文本、图片
-       * @param text - 文本
-       */
-    getQQBotText(text: string): Promise<{
-        /** 处理后的文本 */
-        text: string;
-        /** 二维码数据 */
-        data?: QRRes;
-    }>;
-    /**
-     * 传入文本 处理文本 返回的按钮为多行按钮
-     * @param text - 文本
-     */
-    getQQBotButton(text: string): {
-        text: string;
-        data: ButtonElement[];
-    };
-    /**
-     * 传入文本 将文本一些特殊字符转义去除 用于处理markdown
-     * @param text - 文本
-     * @param isC2C - 是否是C2C
-     * @returns 处理后的文本
-     */
-    formatText(text: string, isC2C?: boolean): string;
-}
-export declare const common: Common;
-export {};
+}>;
+/**
+ * 处理模板文本，对不能直接发送的 Markdown 语法进行转义
+ * @param text - 文本
+ * @returns 转义后的文本
+ */
+export declare const escapeMarkdown: (text: string) => string;