メインコンテンツまでスキップ

クイックスタート

このページでは、Takumi の診断を下図の順に一通り体験します。

Takumi の診断でできること​

  • セキュリティの専門知識がなくても、ソースコードや URL を渡すだけで Takumi が網羅的な検査を実施します
  • Takumi はアプリケーションの機能を洗い出し、インジェクションや認可制御の不備といった観点ごとに、リスクの高い組み合わせから順に診断します
  • 1 回の実行で使うクレジットに上限を設けられるので、結果を見ながら段階的にクレジットを追加できます
  • 診断結果から、脆弱性の修正、修正の検証、より高度な検査であるペネトレーションテストへと連携することができます

始める前に​

基本サブスクリプションを契約した組織と、その組織でのオーナー・Takumi管理者・Takumi利用者のいずれかのロールが必要です。そのほかに必要なものは、診断の対象によって次のように変わります。

診断の対象必要なもの
ソースコードGitHub 連携、または .zip・.tar.gz 形式のソースコード
稼働中のアプリケーション組織認証または所有権証明、ログインが必要な場合は診断用のアカウント

診断手法を選ぶ​

次の 3 つの手法から選びます。ソースコードと稼働中のアプリケーションの両方を用意できる場合は、グレーボックス診断を選択してください

手法用意するものTakumi が行うこと
グレーボックス (推奨)ソースコードと稼働中のアプリケーションコードから脆弱性の候補を探し、アプリケーション上で再現できたものだけを報告する
ホワイトボックスソースコードコードを解析して脆弱性を探す
ブラックボックス稼働中のアプリケーションアプリケーションを攻撃して脆弱性を探す

組織で最初の診断を作成するまでは、作成画面に手法の選び方のガイドが表示されます。詳しくは診断手法の選び方をご覧ください。

診断手法の選び方のガイド

最初の診断を実行する​

サイドバーの 診断 を開き、診断を作成 から 新しく診断を作成 を選びます。診断名とレポート言語を入力して手法を選び、診断タイプで 全体を診断 を選んでから、クレジット上限を設定してください。

診断の共通設定

続いて、選んだ手法に応じて下記のとおり対象を指定し、診断を開始 を押します。

リポジトリを追加するかアーカイブをアップロードし、そのコードが稼働しているアプリケーションの URL を入力します。ログインが必要な場合は、アプリケーション内の認証 に認証情報を追加してください。

グレーボックス診断のソースコード設定とアプリケーション設定

診断の進行を見守る​

診断は通常、数時間から 1 日ほどで止まります。画面を閉じても診断は続くので、止まったときに知らせを受け取れるよう、Slack・メール・Webhook の通知を設定しておきましょう。

実行中の診断画面にある通知の設定ボタン

診断を続ける・完了する​

クレジット上限に達するか、すべての組み合わせを診断し終えると、診断は 診断再開待ち の状態で止まります。

診断再開待ちの診断を開くと、機能と観点の組み合わせごとに診断済みかどうかを確認できます。この画面で選べる操作は次の 3 つです。

  • レポートをプレビュー を押すと、ここまでの診断で得られた結果をまとめた診断レポートを閲覧できます
  • 診断を開始 を押すと、指定されたクレジットに基づいて、未診断の組み合わせに対する診断を再開できます
  • 診断を完了する を押すと、現時点の結果を持って診断結果を確定させることができます

診断再開待ちの画面

診断結果を確認する​

レポートには、検出された脆弱性が緊急度の高い順に並びます。グレーボックス診断のレポートでは、アプリケーションで再現できた脆弱性と、再現できなかったものが分けて載ります。ダウンロードできる形式は Markdown と PDF です。

レポートと次のアクション

結果を基に次のアクションを取る​

レポート右側の 次のアクション から、次の操作に進めます。

脆弱性を修正する​

脆弱性を修正 を使うと、選んだ脆弱性ごとに、Takumi が修正のプルリクエストを作成します。対象リポジトリへの書き込み権限を持つ GitHub App が必要です。詳しくは自動修正をご覧ください。

修正する脆弱性を選ぶダイアログ

修正を検証する​

修正をデプロイしたら、脆弱性を検証 で、その脆弱性がまだ再現するかを確かめましょう。検証は通常、数分で終わります。詳しくは脆弱性検証をご覧ください。

検証する脆弱性を選ぶダイアログ

ペネトレーションテストへ引き継ぐ​

グレーボックス診断とブラックボックス診断のレポートでは、ペネトレーションテスト から、診断の設定と結果を引き継いだペネトレーションテストを始められます。診断で見つからなかった脆弱性を探し、見つかった脆弱性を組み合わせてより深刻な被害に至るかを確かめます。詳しくは結果の引き継ぎをご覧ください。

ペ�ネトレーションテストを始めるダイアログ

再診断する​

再診断を実行 を使うと、同じ設定でアプリケーションをもう一度診断できます。複数の脆弱性を修正したあとの確認に使いましょう。

次のステップ​

  • 定期診断で、リポジトリで変更されたファイルを毎週または毎月診断する
  • Dependabot PR 自動トリアージで、依存関係を更新するプルリクエストを Takumi に選別させる
  • Takumi APIで、CI/CD や独自のワークフローから Takumi を呼び出す