Gh App

Mar 11, 2025 by ADMIN 7 views

GitHub App の Webhook を受け取り、署名検証と API 呼び出しを行う実装

GitHub App は、GitHub の API を使用して、自社のアプリケーションに統合することができます。GitHub App の Webhook を受け取ることで、GitHub のイベントをリアルタイムで受け取ることができます。この記事では、TypeScript と Node.js を使用して、GitHub App の Webhook を受け取り、署名検証と API 呼び出しを行う実装を紹介します。

必要なパッケージをインストールする

まず、必要なパッケージをインストールする必要があります。以下のコマンドを実行してください。

npm init -y
npm install express body-parser crypto jsonwebtoken @octokit/request dotenv

express: Web サーバー
body-parser: JSON パース
crypto: HMAC 署名の検証
jsonwebtoken: JWT 生成
@octokit/request: GitHub API のリクエスト
dotenv: 環境変数管理

.env に GitHub App の情報を設定する

.env ファイルを作成し、以下のように設定してください。

GITHUB_APP_ID=your_app_id
GITHUB_PRIVATE_KEY=your_private_key # 改行を適切に処理
WEBHOOK_SECRET=your_webhook_secret

server.ts の実装

server.ts ファイルを作成し、以下のコードを記述してください。

import express from "express";
import bodyParser from "body-parser";
import crypto from "crypto";
import jwt from "jsonwebtoken";
import { request } from "@octokit/request";
import dotenv from "dotenv";

dotenv.config();

const app = express();
app.use(bodyParser.json());

const GITHUB_APP_ID = process.env.GITHUB_APP_ID!;
const GITHUB_PRIVATE_KEY = process.env.GITHUB_PRIVATE_KEY!.replace(/\\n/g, "\n");
const WEBHOOK_SECRET = process.env.WEBHOOK_SECRET!;

/**
 * Webhook の署名を検証する
 */
function verifySignature(req: any): boolean {
  const signature = req.headers["x-hub-signature-256"] as string;
  if (!signature) return false;

  const hmac = crypto.createHmac("sha256", WEBHOOK_SECRET);
  const digest = "sha256=" + hmac.update(JSON.stringify(req.body)).digest("hex");

  return crypto.timingSafeEqual(Buffer.from(signature), Buffer.from(digest));
}

/**
 * GitHub App の JWT を生成する
 */
function createJwt(): string {
  const now = Math.floor(Date.now() / 1000);
  const payload = {
    iat: now,
    exp: now + 600, // 10分有効
    iss: GITHUB_APP_ID,
  };
  return jwt.sign(payload, GITHUB_PRIVATE_KEY, { algorithm: "RS256" });
}

/**
 * Installation Access Token を取得する
 */
async function getInstallationAccessToken(installationId: number): Promise<string> {
  const jwtToken = createJwt();
  const response = await request("POST /app/installations/{installation_id}/access_tokens", {
    installation_id: installationId,
    headers: {
      Authorization: `Bearer ${jwtToken}`,
      Accept: "application/vnd.github+json",
    },
  });
  return response.data.token;
}

/**
 * Webhook 受信エンドポイント
 */
app.post("/webhook", async (req, res) => {
  if (!verifySignature(req)) {
    return res.status(401).send("Invalid signature");
  }

  const payload = req.body;
  const installationId = payload?.installation?.id;

  if (!installationId) {
    return res.status(400).send("No installation ID found");
  }

  try {
    const token = await getInstallationAccessToken(installationId);

    // 例: GitHub Issue を作成
    const response = await request("POST /repos/{owner}/{repo}/issues", {
      owner: "your_github_owner",
      repo: "your_repo",
      title: "Webhook Test",
      body: "This is a test issue.",
      headers: {
        Authorization: `token ${token}`,
        Accept: "application/vnd.github+json",
      },
    });

    res.status(201).json(response.data);
  } catch (error) {
    console.error(error);
    res.status(500).send("Error processing webhook");
  }
});

/**
 * サーバー起動
 */
const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
  console.log(`Server running on port ${PORT}`);
});

実行する

server.ts ファイルを実行してください。

node server.js

GitHub の Webhook 設定を以下のようにします。

Payload URL: http://your-server.com/webhook
Content type: application/json
Secret: .env ファイルで設定した WEBHOOK_SECRET

動作概要

以下の手順で動作します。

Webhook を受信

verifySignature(req) で署名を確認
installation.id を取得

Installation Access Token を取得

createJwt() で GitHub App の JWT を生成
getInstallationAccessToken(installationId) で installation access token を取得

GitHub API を実行

POST /repos/{owner}/{repo}/issues で Issue を作成

まとめ

この記事では、TypeScript と Node.js を使用して、GitHub App の Webhook を受け取り、署名検証と API 呼び出しを行う実装を紹介しました。GitHub App の Webhook を受け取ることで、GitHub のイベントをリアルタイムで受け取ることができます。この実装を使用して、GitHub App の Webhook を安全に受け取り、API を実行することができます。

この記事では、GitHub App の Webhook を受け取り、署名検証と API 呼び出しを行う実装の Q&A を紹介します。

Q: GitHub App の Webhook とは何ですか?

A: GitHub App の Webhook は、GitHub のイベントをリアルタイムで受け取ることができる機能です。Webhook を受け取ることで、GitHub のイベントをリアルタイムで受け取ることができます。

Q: GitHub App の Webhook を受け取るにはどうすればよいですか?

A: GitHub App の Webhook を受け取るには、GitHub の Webhook 設定を設定する必要があります。Webhook 設定を設定することで、GitHub のイベントをリアルタイムで受け取ることができます。

Q: GitHub App の Webhook の署名検証とは何ですか?

A: GitHub App の Webhook の署名検証は、Webhook の署名を検証する機能です。署名検証を実行することで、Webhook の正当性を確認することができます。

Q: GitHub App の Webhook の署名検証はどうやって実行するのですか?

A: GitHub App の Webhook の署名検証は、verifySignature(req) 関数を使用して実行することができます。この関数は、Webhook の署名を検証するために使用されます。