Cyfendo を VS Code (Copilot) に接続する

ワンクリックで、Cyfendo を GitHub Copilot のエージェントモードに追加できます。

セットアップ · 約 2 分

セットアップ

  1. VS Code が Cyfendo へのログインを確認してきたら、許可します。ブラウザで Cyfendo が開くので、ログインして「Allow」をクリックします。

  2. Copilot Chat で、Agent モードに切り替えます。

  3. エージェントが初めて Cyfendo のツールを実行しようとしたときに、「Allow」のドロップダウンを開き、Cyfendo のすべてのツールを信頼します(このワークスペースのみ、または常に)。これで、チェックが承認で止まることがなくなります。あとから変更するには、「Chat: Manage Tool Approval」を使います。

  4. 以下の指示を、プロジェクトのルートにある .github/copilot-instructions.md に追加してください(クリック操作は指示と一緒に記載しています)。最初のチェックで、Cyfendo がプロジェクト固有の ID を発行し、エージェントがそれを cyfendo.json に保存します。このファイルはコードと一緒にコミットしてください。

    指示を取得

Cyfendo を初めて使う場合は、「Continue with Google」を選ぶと、同じ手順で無料アカウントを作成できます。メールアドレスで登録した場合は、先にメールアドレスを確認してから、アプリからもう一度接続を開始してください。

おすすめ

エージェントにチェックのタイミングを教える

これを .github/copilot-instructions.md に貼り付けると、VS Code (Copilot) がリスクのある変更の後に自動で Cyfendo を呼び出し、結果が出たときにお知らせします。

VS Code での追加方法

  1. 以下の指示の「Copy」をクリックします。
  2. VS Code で Explorer を開きます(Mac は ⇧⌘E、Windows と Linux は Ctrl+Shift+E)。プロジェクトに .github/copilot-instructions.md がすでにある場合は、それを開いて手順 4 に進みます。
  3. それ以外の場合は、ファイル一覧の下の空いている場所を右クリックして「New File…」を選び、.github/copilot-instructions.md と入力して Enter キーを押します。VS Code が .github フォルダも作成します。
  4. 指示をファイルの末尾に貼り付けて、保存します(Mac は ⌘S、Windows と Linux は Ctrl+S)。

ファイルを編集したくない場合は、Copilot に「この内容を、プロジェクトのルートにある .github/copilot-instructions.md に、一字一句そのまま追加してください:」というメッセージに続けて指示を送ってください。

.github/copilot-instructions.md
## Security checks (Cyfendo)
Cyfendo identifies this project by the project_id in cyfendo.json at the project root. Pass it in every Cyfendo call. If the file doesn't exist, the first check or scan creates the project: save the project_id it returns to cyfendo.json and keep the file with the code.
- At the start of each of my requests, call cyfendo_status and tell me about any earlier_results before doing anything else.
- When you finish a task that changed login, sessions, permissions, database access, payments, file uploads, API routes or secrets, call cyfendo_check_changes once with all the files the task changed (list deleted files under deleted) and a short label. Don't wait for the result.
- For a confirmed issue that is still current, fix it as its fix_steps describe, or call cyfendo_generate_fix and then cyfendo_get_fix for Cyfendo's tested patch and show me the diff before applying it. Then call cyfendo_verify_fix.
- When I say I'm getting ready to release, call cyfendo_scan_project with this repository as a git source if it is pushed to GitHub, GitLab or Bitbucket; otherwise upload the source files in parts. Tell me when it has finished.

動作を確認する

試してみる

以下のいずれかを、VS Code (Copilot) のエージェントに送ってください。

  • 接続を確認するCyfendo を使って、私のセキュリティの状況を表示してください。
  • 変更をチェックするCyfendo で、いま変更したファイルをチェックしてください。
  • 完了した結果を取得する準備ができている Cyfendo の結果を取得してください。
  • 公開する前に公開の準備をしています。Cyfendo のフルセキュリティスキャンを実行してください。

公開する前に

セキュリティに関するご質問

GitHub Copilot が書くコードは安全ですか?

多くの場合は動作しますが、動作するコードでも、悪用され得ることがあります。所有者の確認を省略するエンドポイント、ユーザー入力から組み立てられたクエリ、リクエストからそのまま取り出したファイルパスなどです。これらのバグはレビューでは普通に見えるため、そのままリリースされてしまいます。

GitHub Copilot は、すでに自分でコードをレビューしていませんか?

GitHub には、プルリクエストに対する Copilot コードレビューと、CodeQL によるコードスキャンがあります。 レビューは、コードを読んで、リスクがありそうかどうかを判断するものです。Cyfendo は、隔離されたサンドボックスで、アプリのコードに対して安全な攻撃を試し、その攻撃で実証された問題だけを、修正手順とともに報告します。 エージェントは、誤警報と議論するのではなく、本当の問題を修正できます。

GitHub Copilot は、いつ Cyfendo を呼び出しますか?

.github/copilot-instructions.md の指示に従って呼び出します。ログイン、権限、データアクセス、決済、アップロード、API ルート、シークレットに関わるタスクが終わるたびに 1 回、リリースの準備をしていると伝えたときにフルスキャンを実行します。スタイル、テキスト、テストの変更はスキップされます。

知っておくと便利なこと

  • cyfendo.json はコードと一緒にコミットしてください。そうすると、リポジトリのすべてのクローンと、そのリポジトリで作業するすべてのコーディングエージェントが、そのプロジェクトの Cyfendo の結果を共有します。コードを別のプロジェクトにコピーする場合は、コピー側の cyfendo.json を削除して、独自の ID が発行されるようにしてください。
  • フルスキャン: プロジェクトを GitHub、GitLab、Bitbucket にプッシュしている場合は、そのリポジトリを Cyfendo で接続すると(Settings → Integrations → Git)、サイズにかかわらず Cyfendo が直接読み取ります。公開リポジトリは設定不要です。それ以外の場合、エージェントはソースファイルを最大 50 ファイルずつに分けてアップロードします。
  • ログインの代わりに API キーを使うには、X-Cyfendo-Api-Key を指定した headers のエントリを追加し、キーはファイルに直接書かず、入力変数に保持してください。
  • VS Code は、リポジトリのルートにある AGENTS.md も読み込むため、指示をそこに置くこともできます。

トラブルシューティング

ログインのウィンドウが開かない

ブラウザがポップアップをブロックしました。お使いのアプリビルダーのサイトでポップアップを許可してから、認可または接続のボタンをもう一度クリックしてください。

個人のワークスペースが見つからない

Business アカウントでは、ご自身のワークスペースは Business ワークスペースになっており、組織の名前が付いています。「your workspace」と表示されているものを選んでください。

接続テストが失敗する

サーバー URL が正確に https://mcp.cyfendo.com/mcp であること(末尾に /mcp が付いていること)と、アプリが尋ねる場合は、トランスポートが SSE ではなく HTTP(Streamable HTTP)であることを確認してください。

チェックが「running」のままになる

攻撃の実証には数分かかるため、チェックはバックグラウンドで実行されます。エージェントは、あなたがメッセージを送ったときにしか結果を報告できません。チェックが完了すると Cyfendo が通知しますので、そのあとエージェントに「準備ができている Cyfendo の結果を取得してください。」と送ってください。チェックは約 15 分でテストを打ち切り、その時点までの結果を報告します。

最終更新日 · Markdown で表示