安全与 HMAC 签名

Savebase 发送的每个 Webhook 请求都使用 HMAC-SHA256 签名，让你确认它确实来自 Savebase，且传输途中未被篡改。处理 Webhook 事件前，请始终验证该签名。

签名如何工作

Savebase 使用 Webhook 的以下信息，对原始请求体执行 HMAC-SHA256 来计算签名 签名密钥 作为密钥。结果在以下字段中发送 X-Savebase-Signature 请求头，形式为 sha256=<hex-digest>.

使用原始请求体

始终对以下内容计算 HMAC： 原始且未经修改的请求体字节 — 而非重新序列化的 JSON 对象。解析并重新序列化 JSON 可能改变空白和键顺序，导致签名验证失败。

请求头	值格式
`X-Savebase-Signature`	`sha256=abcdef0123...`
`X-Savebase-Event`	`post.saved`
`User-Agent`	`Savebase-Webhook/1.0`

Node.js / Express

bash

const crypto = require('crypto');

function verifySignature(rawBody, signatureHeader, secret) {
  const expected = 'sha256=' + crypto
    .createHmac('sha256', secret)
    .update(rawBody)
    .digest('hex');
  return crypto.timingSafeEqual(
    Buffer.from(expected, 'utf8'),
    Buffer.from(signatureHeader, 'utf8')
  );
}

app.post(
  '/savebase-webhook',
  express.raw({ type: 'application/json' }),
  (req, res) => {
    const sig = req.headers['x-savebase-signature'];
    if (!sig || !verifySignature(req.body, sig, process.env.SAVEBASE_WEBHOOK_SECRET)) {
      return res.status(401).send('Invalid signature');
    }
    const event = JSON.parse(req.body);
    console.log('Event:', event.event, event.data.id);
    res.sendStatus(200);
  }
);

Python / Flask

bash

import hmac, hashlib, os
from flask import Flask, request, abort

app = Flask(__name__)
WEBHOOK_SECRET = os.environ['SAVEBASE_WEBHOOK_SECRET']

@app.route('/savebase-webhook', methods=['POST'])
def handle_webhook():
    sig_header = request.headers.get('X-Savebase-Signature', '')
    raw_body = request.get_data()

    expected = 'sha256=' + hmac.new(
        WEBHOOK_SECRET.encode('utf-8'),
        raw_body,
        hashlib.sha256
    ).hexdigest()

    if not hmac.compare_digest(expected, sig_header):
        abort(401)

    payload = request.get_json()
    print('Received event:', payload['event'])
    return '', 200

PHP

bash

<?php
$secret  = getenv('SAVEBASE_WEBHOOK_SECRET');
$rawBody = file_get_contents('php://input');
$sigHeader = $_SERVER['HTTP_X_SAVEBASE_SIGNATURE'] ?? '';
$expected  = 'sha256=' . hash_hmac('sha256', $rawBody, $secret);

if (!hash_equals($expected, $sigHeader)) {
    http_response_code(401);
    exit('Invalid signature');
}

$event = json_decode($rawBody, true);
error_log('Received: ' . $event['event']);
http_response_code(200);

安全最佳实践

迅速响应。 返回一个 200 OK 须在 10 秒内完成。Savebase 在 10 秒后超时并将投递标记为失败。耗时工作请交由后台任务处理。
切勿将签名密钥写入日志。 像密码一样保护它，并在以下位置轮换 Settings → Webhooks 如果认为它已泄露。
仅使用 HTTPS。 Savebase 拒绝纯 HTTP 端点。
使用恒定时间比较。 始终使用 crypto.timingSafeEqual （Node）、 hmac.compare_digest （Python），或 hash_equals （PHP），绝不能使用明文 ===.
自行处理失败情况。 Savebase 记录投递结果，但当前实现不会自动重试或重放失败请求。

上一步

概览与设置

下一步

投递日志与测试