预览

在线预览：https://neko-quiz.shuttleapp.rs/

[!WARNING]

本项目仍处于开发阶段，可能存在未知的安全隐患和功能缺陷，仅作为实验和学习用途，不建议直接应用于生产环境。

特性

• 🛠 灵活配置：使用 TOML 文件轻松配置问题、答案和提示
• 🔄 配置热重载：支持配置文件热重载，无需重启即可更新问题
• 🔒 多种 Flag 获取方式：支持环境变量、文件读取和静态字符串
• 🐳 Docker 支持：提供 Docker 镜像和 docker-compose 配置
• 🌐 跨平台：提供预构建的多平台二进制文件
• 💬 自定义消息：支持 HTML 格式的错误和成功消息

安装

预构建二进制文件

你可以在 Releases 页面找到自动构建的二进制文件。

Docker 镜像

docker pull ghcr.io/13m0n4de/neko-quiz

详细的 Docker 镜像使用说明请参考部署章节。

从源代码构建

1. 确保已安装 Rust 工具链
2. 安装 Trunk：

   cargo install trunk  # 从源码安装
   cargo binstall trunk  # 或使用 cargo-binstall 安装二进制文件

3. 克隆仓库：

   git clone https://github.com/13m0n4de/neko-quiz/

4. 构建项目

   ./scripts/build.sh

构建完成后，前端文件将输出在 dist/ 目录，后端可执行文件位于 target/release/server。

[!NOTE]

注意：从源代码构建需要安装额外的依赖，如 wasm32-unknown-unknown 目标。

配置

项目根目录有一份配置示例：config.toml

[[questions]]
text = "想要在苏州图书馆借阅 <i>Engineering a Compiler</i>，需要到哪个分馆的哪个馆藏地点？"
points = 20
hint = "格式：所在分馆-所在馆藏地点，例如 中心馆-西文书库。（如有多个，任意一个即可）"
answers = [ "苏图-北馆书库", "苏图-设计图书馆",]

[[questions]]
text = "「你们这些搞计算机的，就是喜欢卖弄学问，数个数还得从零开始」。其实编号从零开始是有道理的，一位计算机科学家还专门写过一篇简短的<b>手写稿</b>来解释，请问这个手写稿的编写日期是？"
points = 20
hint = "格式：YYYY-MM-DD ，如 2024-02-05"
answers = [ "1982-08-11",]

[[questions]]
text = "CVE-2023-45853 的修复补丁中，文件名长度被限制为多少位 (bit)？"
points = 20
hint = "格式：整数，如 32"
answers = [ "16",]

[[questions]]
text = "Hare 编程语言的官方风格指南中，行宽被限制为多少列？"
points = 20
hint = "格式：整数，如 120"
answers = [ "80",]

[[questions]]
text = "在某次在线学术会议上，展示了一种通过声学侧信道推断 VoIP 呼叫来源的攻击手段，请问这个会议的名称是？"
points = 20
hint = "格式：会议名称 + 年份，以空格分割，如 ECOOP 2024"
answers = [ "ACM WiSec 2021", "WiSec 2021",]

[general]
title = "猫咪问答"
return_score = true

[flag]
env = "FLAG"
file = "/flag"
static_str = "flag{neko_quiz_static_flag}"

[message]
incorrect = "没有全部答对，不能给你 FLAG 哦。"
correct = "🎉🎉🎉 $FLAG 🎉🎉🎉"

[!TIP]

注意事项：

1. questions 为列表，可包含多个问题，每个问题都包含 text、points、hint 和 answers 字段
2. flag 配置项按优先级顺序尝试：环境变量 > 文件 > 静态字符串
3. 消息配置支持 HTML 标签，可用于自定义样式

部署

NekoQuiz 支持多种部署方式，默认端口为 3000。请根据您的需求选择合适的部署方法。

预构建二进制文件

如果从是 Releases 下载的压缩包，解压所有文件到同一目录并运行 neko-quiz 即可。

1. 解压下载的压缩包：

   tar xvf x86_64-unknown-linux-musl.tar.gz

2. 运行可执行文件：

   ./neko-quiz

   或指定地址和端口：

   ./neko-quiz -a 0.0.0.0:3000

[!NOTE]

提示：使用 -h 或 --help 参数查看更多选项，或参考帮助章节。

Docker 镜像

确保挂载的配置文件 config.toml 路径正确。

• 使用环境变量作为 Flag：

  docker run -d --rm -p 3000:3000 \
      -v ./config.toml:/config.toml \
      -e GZCTF_FLAG='flag{example}' \
      --name neko-quiz ghcr.io/13m0n4de/neko-quiz

• 使用文件提供 Flag：

  docker run -d --rm -p 3000:3000 \
      -v ./config.toml:/config.toml \
      -v ./flag:/flag \
      --name neko-quiz ghcr.io/13m0n4de/neko-quiz

• 使用 docker-compose，编辑 docker-compose.yml 文件配置环境变量和文件挂载，然后运行：

  docker-compose up -d

本地开发部署

• 编译并启动 Dev 版本（代码修改自动重新编译）：

  ./scripts/dev.sh

• 编译并启动 Release 版本：

  ./scripts/prod.sh

• 或构建本地 Docker 镜像：

  docker build . -t neko-quiz
  docker run -d -p 3000:3000 -v ./config.toml:/config.toml neko-quiz

帮助

命令行参数

运行 neko-quiz --help 可以查看完整的命令行选项。以下是主要参数的概览：

使用案例

• SVUCTF/SVUCTF-SPRING-2024 猫咪问答
• SVUCTF/SVUCTF-WINTER-2023 猫娘问答

许可证

该项目采用 MIT 许可证 - 查看 LICENSE 文件了解更多细节。

相关项目

• USTC-Hackergame 猫咪小测
• rksm/axum-yew-setup