Trail of Bits 测试手册

Trail of Bits 测试手册是一份面向开发者和安全专业人士的资源，介绍如何配置、优化和自动化我们在 Trail of Bits 使用的众多静态与动态分析工具。

预览测试手册：https://appsec.guide 🌐

为什么需要这份手册？ ✨

• 📃 现有工具在配置和优化方面的文档往往对开发者不够友好，因为它们通常是面向安全专业人士编写的。这在模糊测试工具方面尤其如此。这可能导致挫败感，并使那些本应易于配置的安全工具采用率低下。
• ⚙️ 即使工具在本地易于配置，在 CI/CD 流水线中配置它们也可能很困难。通常，安全工具是按照在线文档设置的，但其配置很少经过优化。这可能导致工具噪音过大，维护成本高于其价值。
• 🧠 我们的目标是尽可能简单地有效设置安全工具。为此，我们也希望揭开模糊测试和污点分析等静态与动态分析技术的神秘面纱。

章节

✅ 已发布

🎥 网络研讨会

🚧 正在建设中

• kAFL
• Rust
• 形式化验证与 Tamarin

如何贡献

如果您想为测试手册做出贡献，以下是一些帮助您入门的指南：

1. 添加新工具：如果您想在测试手册中涵盖一个新工具，请在 GitHub Issues 中提出主题。之后，您可以着手创建新的拉取请求。
2. 改进现有章节：如果您有改进特定章节的想法，可以提交一个 GitHub issue。
3. 领取小任务：如果您没有太多时间但仍想贡献，可以从 GitHub issues 列表中领取任何小任务。
4. 报告问题：如果您发现小的技术问题或拼写错误，请创建新的 GitHub issue 和/或在新的拉取请求中修复它。

便捷开发的快速设置

1. 在您的系统中安装 Hugo

   root@kitploit:~

   brew install hugo
   

2. 克隆仓库

   root@kitploit:~

   git clone --recurse-submodules https://github.com/trailofbits/testing-handbook.git
   

3. 创建新分支或选择您想工作的分支

   root@kitploit:~

   cd testing-handbook
   # then
   git checkout -b name-of-your-new-branch
   # or
   git checkout name-of-existing-branch
   

4. 从项目根目录运行启用草稿模式（-D）的 Hugo 服务器。每当您保存文件时，浏览器都会自动刷新更改。

   root@kitploit:~

   hugo server -D
   

5. 添加新工具作为 "doc"，并从项目根目录运行以下命令。

   root@kitploit:~

   hugo new docs/<name of tool>
   

   注意：本项目使用与 zkdocs 相同的 hugo 模板。该模板将每个 新页面称为 "doc"，而不是 post。这就是为什么您应该输入 hugo new docs/<name of tool> 而不是 post/my-new-post。

6. 编辑、添加并创建拉取请求，将您的更改合并到 main 中。

7. ❗请记住，当您将 PR 合并到 main 时，内容会在 上线。 我们目前的策略要求在合并前至少进行一次审查。

指南

• 每个 "doc" 之间的格式应保持一致。在添加新 doc（即添加新工具）时，请遵循 content/docs/template.md 中的模板。如需建议更改，请为该文件发送 PR。

• 使用您的更改创建新分支，完成后创建 PR 合并到 main 中。

• 此仓库中的 GitHub workflow 通过三项检查验证 Markdown 文件的正确性：

  1. Markdown 链接检查：此步骤从 Markdown 文件中提取链接，并验证它们是否有效且可访问。 它使用 lychee link checking action。
  2. Markdown Linter：此步骤确保 Markdown 文件遵循所需的样式和格式规则。 它使用自定义配置文件（.github/workflows/.markdownlint.jsonc）和 markdownlint-cli2-action action。 Use the markdownlint extension with Visual Studio Code for better user experience while working on the Testing Handbook.
  3. 拼写检查：此步骤检查 Markdown 文件中的拼写 （基于 retext 和 remark 构建）。 使用 tbroadley/spellchecker-cli-action action。

• 熟悉 Hugo Book 主题，因为它有一些不错的功能（按钮等）。

• 如果您有任何问题，请在 Empire Hacking Slack 的 #testing-handbook 频道中联系我们。

编辑

写作指南

• 术语 "Testing Handbook" 在网站上出现时都应大写（无论是在标题/副标题还是正文中）， 因为它是文档的标题。但如果您因为觉得大写看起来奇怪而想避免使用它，可以 用 "this handbook" 替代 "Testing Handbook"（因为手册的标题已经很清楚了）。

工作流程：从 Google Docs 导出

您可以将文档从 Google Docs 导出为 Markdown。在 Google Docs 中打开文档。点击 文件 > 下载，然后选择 Markdown (.md)。

自定义环境

{{< customFigure "Caption" >}}
{{< /customFigure >}}

{{< resourceFigure "cov1.png" >}}
{{< /resourceFigure >}}

{{< hint info >}}
{{< /hint >}}