Trail of Bits テストハンドブック

Trail of Bits テストハンドブックは、Trail of Bits が使用する多くの静的解析・動的解析ツールの設定、最適化、自動化に関する、開発者とセキュリティ専門家のためのリソースです。

テストハンドブックのプレビュー: https://appsec.guide 🌐

なぜこれが必要なのか？ ✨

• 📃 既存ツールの設定と最適化に関するドキュメントは、セキュリティ専門家向けに書かれていることが多く、開発者にとって必ずしも使いやすいとは言えません。これは特にファジングユーティリティに当てはまります。その結果、設定が簡単なはずのセキュリティツールが、不満を招き、採用が進まないことがあります。
• ⚙️ ツールがローカルで簡単に設定できる場合でも、CI/CD パイプラインでの設定は困難なことがあります。多くの場合、セキュリティツールはオンラインドキュメントに従ってセットアップされますが、その設定が最適化されることはほとんどありません。その結果、ノイズが多く、維持する価値よりも手間がかかるツールになりかねません。
• 🧠 私たちは、セキュリティツールを効果的にセットアップすることを可能な限り簡単にすることを目指しています。その過程で、ファジングや汚染解析（taint analysis）などの静的解析・動的解析の手法についても、その謎を解き明かしたいと考えています。

章

✅ 公開済み

🎥 ウェビナー

🚧 作成中

• 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 テンプレートを使用しています。このテンプレートでは、各新規ページを投稿（post）ではなく「doc」と呼びます。そのため、hugo new docs/<name of tool> と入力し、post/my-new-post とはしないでください。

6. 編集・追加を行い、変更を main にマージするためのプルリクエストを作成します。

ガイドライン

• 各「doc」間でフォーマットは一貫している必要があります。新しい doc（つまり新しいツール）を追加するときは、content/docs/template.md のテンプレートに従ってください。必要に応じて、このファイルへの変更提案を含む PR を送ってください。

• 変更内容を含む新しいブランチを作成し、完了したら main にマージするための PR を作成してください。

• このリポジトリの GitHub ワークフローは、3 つのチェックを通じて Markdown ファイルの正確性を検証します。

  1. Markdown リンクチェック: このステップは、Markdown ファイルからリンクを抽出し、それらが有効でアクセス可能かどうかを検証します。lychee link checking action を使用します。
  2. Markdown Linter: このステップは、Markdown ファイルが望ましいスタイルとフォーマット規則に準拠していることを保証します。カスタム設定ファイル（.github/workflows/.markdownlint.jsonc）と markdownlint-cli2-action アクションを使用します。Visual Studio Code で markdownlint 拡張機能を使用すると、Testing Handbook での作業中により良いユーザーエクスペリエンスが得られます。
  3. スペルチェック: このステップは、Markdown ファイルのスペルをチェックします（retext と remark 上に構築されています）。tbroadley/spellchecker-cli-action アクションを使用します。

• Hugo Book テーマ に慣れておいてください。ボタンなど、いくつかの便利な機能があります。

• 質問がある場合は、#testing-handbook Empire Hacking Slack で連絡してください。

編集

執筆ガイドライン

• 「Testing Handbook」という用語は、ウェブサイト上で（見出し/小見出しまたは本文中を問わず）出現するたびに大文字で表記する必要があります。これは文書のタイトルだからです。ただし、大文字表記が不自然に見える場合は、「Testing Handbook」を「このハンドブック」に置き換えても構いません（ハンドブックのタイトルが何であるかは十分に明らかだからです）。

ワークフロー: Google Docs から

Google Docs から文書を Markdown としてエクスポートできます。Google Docs で文書を開き、File > Download をクリックして、Markdown (.md) を選択します。

カスタム環境

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

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

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