వెబ్‌హుక్ సంతకాలను ధృవీకరించండి

మీ సర్వర్‌కు మేము పంపే ప్రతి అభ్యర్థన — వెబ్‌హుక్ డెలివరీలు మరియు టూల్-ఎండ్‌పాయింట్ ఇన్వొకేషన్‌లు — 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 నంబర్ రౌండ్-ట్రిప్పింగ్ లోపాల ప్రభావానికి లోనుకాదు.

ఏ సీక్రెట్?

సీక్రెట్‌ను మీ సీక్రెట్ మేనేజర్ లేదా ఎన్విరాన్‌మెంట్ వేరియబుల్‌లో నిల్వ చేయండి — దానిని ఎప్పుడూ కమిట్ చేయవద్దు.

రిఫరెన్స్ అమలులు

ఈ నాలుగూ రా అభ్యర్థన బాడీని వెరిఫై చేస్తాయి:

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గా పంపబడతాయి) సాధారణ సైన్డ్ వెబ్‌హుక్ — పైన ఉన్న ప్రామాణిక విధానాన్ని వర్తింపజేయండి. రెండు రిక్వెస్ట్ ఆకారాల కోసం ఫంక్షన్ టూల్స్ చూడండి.

సాధారణ సమస్యలు

తదుపరి దశలు