वेबहुक स्वाक्षऱ्या सत्यापित करा

आम्ही तुमच्या सर्व्हरला पाठवणाऱ्या प्रत्येक विनंतीमध्ये — webhook वितरणे आणि टूल-एंडपॉइंट इनव्होकेशन्समध्ये — X-ThunderPhone-Signature हेडरमध्ये HMAC-SHA256 स्वाक्षरी असते. पडताळणी एकदाच योग्यरीत्या करा आणि तोच हेल्पर प्रत्येक हँडलरमध्ये वापरा.

अल्गोरिदम

1. रॉ विनंती बॉडी वाचा — आम्ही तुम्हाला POST केलेले अचूक बाइट्स.
2. hmac_sha256(secret, body).hexdigest() गणना करा.
3. X-ThunderPhone-Signature शी स्थिर वेळेत तुलना करा. (साधी स्ट्रिंग तुलना वेळेची माहिती उघड करते.)

आम्ही पाठवतो तेच अचूक बाइट्स साइन करतो, त्यामुळे रॉ बॉडीची पडताळणी नेहमी कार्य करते. ते बाइट्स पेलोडचे कॅनॉनिकल JSON सीरियलायझेशन देखील आहेत — कीज वर्णक्रमानुसार क्रमबद्ध, कॉम्पॅक्ट विभाजक (स्पेसशिवाय , आणि :), UTF-8. तुमचे फ्रेमवर्क फक्त पार्स केलेला JSON उघड करत असल्यास, हे तुम्हाला दुसरी, पूर्णपणे समतुल्य पद्धत देते: कॅनॉनिकली पुन्हा सीरियलाइझ करा आणि त्याचे HMAC करा.

# Equivalent to hashing the raw body:
import json
canonical = json.dumps(payload, separators=(",", ":"), sort_keys=True).encode("utf-8")

रॉ बॉडीला प्राधान्य द्या — तो एक टप्पा कमी आहे आणि काही भाषांमधील JSON संख्यांच्या राउंड-ट्रिपिंगमधील विचित्रतेपासून सुरक्षित आहे.

कोणता secret?

secret तुमच्या secret मॅनेजरमध्ये किंवा env var मध्ये साठवा — तो कधीही कमिट करू नका.

संदर्भ अंमलबजावण्या

सर्व चार रॉ विनंती बॉडीची पडताळणी करतात:

import hashlib
import hmac


def verify(body: bytes, signature: str, secret: str) -> bool:
    """Constant-time HMAC-SHA256 verification."""
    expected = hmac.new(
        secret.encode("utf-8"),
        body,
        hashlib.sha256,
    ).hexdigest()
    return hmac.compare_digest(expected, signature or "")

import crypto from "node:crypto";

export function verify(body, signature, secret) {
  const expected = crypto
    .createHmac("sha256", secret)
    .update(body)
    .digest("hex");
  if (!signature || expected.length !== signature.length) return false;
  return crypto.timingSafeEqual(
    Buffer.from(expected),
    Buffer.from(signature),
  );
}

package webhook

import (
    "crypto/hmac"
    "crypto/sha256"
    "encoding/hex"
)

func Verify(body []byte, signature, secret string) bool {
    mac := hmac.New(sha256.New, []byte(secret))
    mac.Write(body)
    expected := hex.EncodeToString(mac.Sum(nil))
    return hmac.Equal([]byte(expected), []byte(signature))
}

require "openssl"

def verify(body, signature, secret)
  expected = OpenSSL::HMAC.hexdigest("SHA256", secret, body)
  Rack::Utils.secure_compare(expected, signature.to_s)
end

फ्रेमवर्क-विशिष्ट एकत्रीकरण

from fastapi import FastAPI, HTTPException, Request

app = FastAPI()

@app.post("/thunderphone-webhook")
async def hook(request: Request):
    body = await request.body()           # raw bytes, NOT request.json()
    sig = request.headers.get("X-ThunderPhone-Signature", "")
    if not verify(body, sig, SECRET):
        raise HTTPException(status_code=401)

    import json
    event = json.loads(body)
    # … dispatch on event["type"] …
    return {"ok": True}

import express from "express";

const app = express();

app.post(
  "/thunderphone-webhook",
  // IMPORTANT: parse as raw; do NOT use express.json() here.
  express.raw({ type: "application/json" }),
  (req, res) => {
    const sig = req.header("X-ThunderPhone-Signature") || "";
    if (!verify(req.body, sig, process.env.WEBHOOK_SECRET)) {
      return res.sendStatus(401);
    }
    const event = JSON.parse(req.body.toString("utf8"));
    // … dispatch on event.type …
    res.sendStatus(204);
  },
);

import json

from django.http import JsonResponse, HttpResponseForbidden
from django.views.decorators.csrf import csrf_exempt
from django.views.decorators.http import require_POST


@csrf_exempt
@require_POST
def hook(request):
    body = request.body  # raw bytes
    sig = request.headers.get("X-ThunderPhone-Signature", "")
    if not verify(body, sig, SECRET):
        return HttpResponseForbidden("invalid signature")
    event = json.loads(body)
    # … dispatch on event["type"] …
    return JsonResponse({"ok": True})

टूल कॉलची पडताळणी

एजंट तुमच्या फंक्शन टूल्सपैकी एखादे टूल थेट कॉल करतो तेव्हा (टूलमध्ये endpoint असतो), विनंतीमध्ये तुमच्या कॉन्फिगर केलेल्या endpoint.headers सोबत दोन ThunderPhone हेडर्स असतात:

• X-ThunderPhone-Call-ID — लाइव्ह कॉलचा संख्यात्मक आयडी.
• X-ThunderPhone-Signature — अचूक रिक्वेस्ट-बॉडी बाइट्सवर, तुमच्या ऑर्ग-स्तरीय वेबहुक सीक्रेटने की केलेला HMAC-SHA256.

तोच verify() हेल्पर कोणत्याही बदलाशिवाय कार्य करतो, पण दोन बाबी लक्षात घ्या:

1. GET / DELETE टूल्सना बॉडी नसते. आर्ग्युमेंट्स क्वेरी पॅरामीटर्स म्हणून जातात आणि सिग्नेचरची गणना रिकाम्या बाइट स्ट्रिंगवर केली जाते — म्हणजे verify(b"", sig, secret) (Python) किंवा verify(Buffer.alloc(0), sig, secret) (Node). क्वेरी स्ट्रिंग हॅश करू नका.
2. लेगसी वेबहुक कॉन्फिगर नसलेल्या ऑर्ग्सकडे ऑर्ग सीक्रेट नसते. अशा वेळी टूल कॉलमध्ये फक्त X-ThunderPhone-Call-ID असतो आणि सिग्नेचर हेडर नसतो. साइनिंग सीक्रेट मिळवण्यासाठी लेगसी वेबहुक (PUT /v1/webhook) कॉन्फिगर करा किंवा endpoint.headers द्वारे तुमच्या स्वतःच्या हेडरने टूल कॉल प्रमाणीकृत करा.

@app.post("/tools/search-appointments")
async def tool(request: Request):
    body = await request.body()  # b"" for GET/DELETE tools
    sig = request.headers.get("X-ThunderPhone-Signature", "")
    call_id = request.headers.get("X-ThunderPhone-Call-ID", "")
    if not verify(body, sig, ORG_WEBHOOK_SECRET):
        raise HTTPException(status_code=401)
    args = json.loads(body)
    ...

वेबहुक-मोड टूल डिस्पॅच (endpoint नसलेली आणि तुमच्या ऑर्ग वेबहुकवर telephony.tool / web.tool म्हणून वितरित होणारी टूल्स) हा सामान्य साइन केलेला वेबहुक आहे — वरील मानक पद्धत लागू होते. दोन्ही रिक्वेस्ट स्वरूपांसाठी फंक्शन टूल्स पहा.

सामान्य अडचणी

पुढील पायऱ्या