パーサードキュメントテンプレート (Open Source)
このテンプレートは、新規または既存のパーサーをドキュメント化するために作成されています。同僚のセキュリティ専門家の助けになりそうな追加情報があれば、自由に改善してください。
- この.mdファイルをコピーし、GitHubリポジトリの
/docs/content/supported_tools/fileに追加します。 - タイトルを、新規または既存のパーサーの名前に合わせて更新します。
- 以下に記載されているすべてのセクションを記入します。各セクション内の説明文や例は削除してください。
ファイル形式
パーサーが受け付けるすべてのファイル形式を指定してください(例: CSV、JSON、XML)。 関連するセキュリティツールから、対応するファイル形式を作成またはエクスポートする方法の手順を含めてください。
[File Format]内の合計フィールド数
合計データフィールド数: セキュリティツールのエクスポートファイルに含まれるフィールドの総数。 パースされた合計データフィールド数: DefectDojoの検出事項にパースされたフィールドの総数。 パースされなかった合計データフィールド数: DefectDojoの検出事項にパースされなかったフィールドの総数。
以下の形式を使用して、各フィールドの簡単な説明と、それがDefectDojoのデータモデルにどのようにマッピングされるかを記載してください。 セキュリティツールのエクスポートファイルに含まれるすべてのフィールドを、出現順に記載し、パースされないフィールドがあれば明記してください。
出現順のフィールド:
- Field 1 - このフィールドがどのようにマッピングされるかの説明(例: 検出事項のタイトル、エンドポイントのホストにマッピングされる)。
- Field 2 - このフィールドがどのようにマッピングされる/されないかの説明。
- Field 3 - このフィールドがどのようにマッピングされる/されないかの説明。
- Field 4 - このフィールドがどのようにマッピングされる/されないかの説明。 (ファイル内のすべてのフィールドについて続けてください。)
フィールドマッピングの詳細
作成される各検出事項について、パーサーが特定のデータをどのようにパースするかの詳細を記載してください。例:
- エンドポイントがどのように作成されるか(例: IP、Domain、Port、Protocolの各フィールドを組み合わせる)。
- 発生回数がどのように扱われるか(例: デフォルトの
nb_occurencesは1に設定され、重複ごとに増加する)。 - 重複排除がどのように扱われるか(例: severity + title + descriptionのハッシュを使用する)。
- マッピングが一致しない場合のデフォルトの深刻度を記載します。
サンプルスキャンデータまたはユニットテスト
GitHubリポジトリ内のユニットテストまたはサンプルスキャンデータフォルダへのリンクを追加してください。例:
ツールへのリンク
スキャナーまたはツール自体へのリンクを記載してください(例: GitHubリポジトリ、ベンダーのWebサイト、またはドキュメント)。例: