【うぇぶふっくしょめいけんしょう】

Webhook署名検証 とは?

公開:
💡 Webhookの通知に付いた署名を確かめ、正しい送信元が作った改ざんされていない通知かを検証する処理
📌 このページのポイント
通知の本文と署名を、先に照合 通知の本文未加工のまま署名を照合署名ヘッダー専用の秘密一致を確認してから処理する正しい署名 ≠ 未処理のイベント
Stripeの検証を例にした図。署名の方式は送信元ごとに異なり、検証の成功と重複処理の防止は別の確認です。
ひよこ ひよこ
通知に「支払い成功」とあれば信じていい?
ペンギン先生 ペンギン先生
だれでも送れる入口なら、内容を自称できてしまうね。Webhook署名検証で、送信元が定めた方法の署名を確かめてから処理するんだ。
ひよこ ひよこ
署名は何を使って確かめるの?
ペンギン先生 ペンギン先生
例えばStripeのSDKでは、元の本文と署名ヘッダー、エンドポイントの秘密を渡すよ。APIキーとは別の秘密なので、取り違えないようにするんだ。
ひよこ ひよこ
JSONに変換してから確かめてもいい?
ペンギン先生 ペンギン先生
元のバイト列が必要な方式では、空白などを変えると一致しなくなるよ。提供元のSDKと、本文をそのまま受け取る設定を確認しよう。
ひよこ ひよこ
署名が正しい通知なら、何回処理してもいい?
ペンギン先生 ペンギン先生
同じイベントが再送される場合があるので、処理済みのIDを確認するなどの重複対策も必要だよ。署名方式による時刻の確認も行い、古い通知の使い回しにも備えるんだ。
ペンギン
まとめ:ざっくりこれだけ覚えればOK!
「Webhook署名検証」って出てきたら「通知の差出人と改ざんの有無を確かめること」と思えばだいたいOK!

参考資料

← 用語集にもどる