FastOG
トピック

HMAC署名ガイド

このHMAC署名ガイドでは、FastOG用のHMAC-SHA256署名の構築方法を説明します。これにより、サブスクリプションベースで動的なOpen Graph画像をその場で生成できます。無料アカウントとDynamic APIプラン（有料レンダリングはクリーン）が含まれます。ここでは任意の言語で署名を手動で実装するか、無料のOG画像テスターを使用してURL形式を先に確認できます。

概要

/api/v1/og へのすべてのリクエストには、正当なウェブサイトから送信されたことを証明する HMAC-SHA256 署名を含める必要があります。これにより、許可されていない第三者が API クォータを使用することを防ぎます。

2 層の認証:

  1. API キー（クエリ内: key=sk_quick_123abc）— ユーザーアカウントを識別します（レンダークォータの計算用）
  2. HMAC 署名（クエリ内: s=<signature>）— リクエストがお客様のウェブサイトから送信されたことを証明します

両方が必須です。API キーのみでは不十分です。

なぜクエリパラメータなのか? OG 画像は、カスタムヘッダーを送信しないソーシャルネットワークのクローラー（LinkedIn、Twitter、Facebook）によって取得されます。署名は URL に含める必要があります。

署名の生成

アルゴリズム

method = "GET"
path = "/api/v1/og"
canonicalQuery = for every query param EXCEPT `s` (including `key`):
  - array values are sorted too
  - each pair: rfc3986Encode(key)=rfc3986Encode(value)
  - pairs sorted lexicographically and joined with "&"

message = method + path + "\n" + canonicalQuery
signature = hex(HMAC-SHA256(message, hmac_secret))

Query parameters:
  key=<apiKey>
  s=<signature>

要件

  • 署名形式: 64文字の16進文字列（SHA256）
  • hash_equals()を使用して、定数時間での比較を行います（タイミング攻撃を防ぐため）
  • ユーザーごとのシークレット: 各APIキーには独自のhmac_secretフィールドがあります

実装例

複数のフレームワークとパターンを用いた完全なチュートリアルについては、以下を参照してください:

JavaScript (Node.js / フロントエンド)

javascript
const crypto = require("crypto");

// rfc3986-encode: everything except A-Za-z0-9-._~
const enc = (s) =>
    encodeURIComponent(s).replace(
        /[!'()*]/g,
        (c) => "%" + c.charCodeAt(0).toString(16).toUpperCase(),
    );

function generateOgImageUrl(baseUrl, params, apiKey, hmacSecret) {
    // every query param except `s`; key included; arrays expand to one pair each
    const all = { ...params, key: apiKey };
    const pairs = [];
    for (const [k, v] of Object.entries(all)) {
        for (const vv of Array.isArray(v) ? [...v].sort() : [v]) {
            pairs.push(`${enc(k)}=${enc(vv)}`);
        }
    }
    pairs.sort();
    const canonical = pairs.join("&");

    const signature = crypto
        .createHmac("sha256", hmacSecret)
        .update(`GET/api/v1/og\n${canonical}`)
        .digest("hex");

    const url = new URL(baseUrl);
    for (const [k, v] of Object.entries(all)) {
        const isArray = Array.isArray(v);
        for (const vv of isArray ? v : [v]) {
            url.searchParams.append(isArray ? `${k}[]` : k, vv);
        }
    }
    url.searchParams.set("s", signature);
    return url.toString();
}

// Usage in meta tag:
const ogUrl = generateOgImageUrl(
    "https://fastog.com/api/v1/og",
    { title: "Como criar um SaaS", template: "default" },
    "sk_quick_123abc",
    process.env.HMAC_SECRET,
);

// <meta property="og:image" content="{ogUrl}" />

PHP (Laravel)

php
function generateOgImageUrl(string $baseUrl, array $params, string $apiKey, string $hmacSecret): string
{
    // every query param except `s`; key included; array values sorted too
    $all = array_merge($params, ['key' => $apiKey]);

    $pairs = [];
    foreach ($all as $k => $v) {
        $values = is_array($v) ? $v : [$v];
        sort($values, SORT_STRING);
        foreach ($values as $vv) {
            $pairs[] = rawurlencode((string)$k) . '=' . rawurlencode((string)$vv);
        }
    }
    sort($pairs, SORT_STRING);
    $canonical = implode('&', $pairs);

    $signature = hash_hmac('sha256', 'GET/api/v1/og' . "\n" . $canonical, $hmacSecret);

    // URL uses bracket keys for arrays (features[]=a&features[]=b); canonical signs plain keys
    $urlPairs = [];
    foreach ($all as $k => $v) {
        $isArray = is_array($v);
        $values = $isArray ? $v : [$v];
        $urlKey = $isArray ? $k . '[]' : $k;
        foreach ($values as $vv) {
            $urlPairs[] = rawurlencode($urlKey) . '=' . rawurlencode((string)$vv);
        }
    }

    return $baseUrl . '?' . implode('&', $urlPairs) . '&s=' . $signature;
}

// Usage in Blade template:
$ogUrl = generateOgImageUrl(
    'https://fastog.com/api/v1/og',
    ['title' => 'Como criar um SaaS'],
    'sk_quick_123abc',
    env('HMAC_SECRET')
);

// <meta property="og:image" content="{{ $ogUrl }}" />

Python

python
import hmac
import hashlib
from urllib.parse import quote

def _enc(s):
    return quote(str(s), safe='-._~')

def generate_og_image_url(base_url, params, api_key, hmac_secret):
    # every query param except `s`; key included; array values sorted too
    all_params = {**params, 'key': api_key}

    pairs = []
    for k, v in all_params.items():
        for vv in sorted(v if isinstance(v, list) else [v]):
            pairs.append(f"{_enc(k)}={_enc(vv)}")
    canonical = '&'.join(sorted(pairs))

    signature = hmac.new(
        hmac_secret.encode(),
        f"GET/api/v1/og\n{canonical}".encode(),
        hashlib.sha256
    ).hexdigest()

    # URL uses bracket keys for arrays (features[]=a&features[]=b); canonical signs plain keys
    url_pairs = []
    for k, v in all_params.items():
        if isinstance(v, list):
            for vv in v:
                url_pairs.append(f"{_enc(f'{k}[]')}={_enc(vv)}")
        else:
            url_pairs.append(f"{_enc(k)}={_enc(v)}")

    return f"{base_url}?{'&'.join(url_pairs)}&s={signature}"

# Usage:
og_url = generate_og_image_url(
    'https://fastog.com/api/v1/og',
    {'title': 'Como criar um SaaS', 'template': 'default'},
    'sk_quick_123abc',
    os.environ['HMAC_SECRET']
)

# <meta property="og:image" content="{{ og_url }}" />

完全な例：Laravel Bladeテンプレート

blade
{{-- In your blog post view --}}
@php
    $apiKey = 'sk_quick_123abc'; // Your full API key
    $hmacSecret = env('OG_RENDER_HMAC_SECRET');

    $params = [
        'template' => 'blog',
        'title' => $post->title,
        'subtitle' => $post->excerpt,
        'key' => $apiKey,
    ];

    // canonical query: sorted "k=v" pairs, rfc3986-encoded, every param except `s`
    $pairs = [];
    foreach ($params as $k => $v) {
        $pairs[] = rawurlencode((string)$k) . '=' . rawurlencode((string)$v);
    }
    sort($pairs, SORT_STRING);
    $canonical = implode('&', $pairs);
    $signature = hash_hmac('sha256', 'GET/api/v1/og' . "\n" . $canonical, $hmacSecret);

    $ogImageUrl = 'https://fastog.com/api/v1/og?' . $canonical . '&s=' . $signature;
@endphp

<head>
    <meta property="og:image" content="{{ $ogImageUrl }}" />
    <meta property="og:title" content="{{ $post->title }}" />
    <meta property="og:description" content="{{ $post->excerpt }}" />
</head>

セキュリティのベストプラクティス

  1. シークレットを安全に保管する - 環境変数またはシークレットマネージャーを使用します
  2. クライアント側コードでシークレットを公開しない - URLの署名はサーバー側でのみ行います
  3. HTTPSを使用する - MITM攻撃を防ぎます
  4. シークレットを定期的にローテーションする - 特に漏えいした場合は必須です
  5. 署名の失敗を監視する - 繰り返しの失敗は攻撃を示している可能性があります
  6. ユーザーごとの分離 - 各APIキーには独自のHMACシークレットがあります

エラーレスポンス

署名の欠落

json
{
    "error": "Missing signature parameters",
    "code": "missing_signature",
    "required_params": ["s", "key"],
    "example": "/api/v1/og?title=Hello&key=sk_quick_123abc&s=<signature>"
}

署名の無効

json
{
    "error": "Invalid signature",
    "code": "invalid_signature"
}

テスト

テスト用URLを生成します：

bash
# Node.js
node -e "
const crypto = require('crypto');
const enc = (s) => encodeURIComponent(s).replace(/[!'()*]/g, (c) => '%' + c.charCodeAt(0).toString(16).toUpperCase());
const all = { title: 'Test', key: 'sk_quick_123abc' };
const pairs = [];
for (const [k, v] of Object.entries(all)) for (const vv of Array.isArray(v) ? v : [v]) pairs.push(enc(k) + '=' + enc(vv));
pairs.sort();
const canonical = pairs.join('&');
const sig = crypto.createHmac('sha256', 'YOUR_HMAC_SECRET').update('GET/api/v1/og\n' + canonical).digest('hex');
console.log('https://fastog.com/api/v1/og?title=Test&key=sk_quick_123abc&s=' + sig);
"

# Test with curl
curl "https://fastog.com/api/v1/og?title=Test&key=sk_quick_123abc&s=<signature>"

期待されるレスポンス：

  • ✅ 有効な署名 → OG画像を返します（テンプレートパラメータが不足している場合は検証エラーを返します）
  • ❌ 無効な署名 → {"error": "...", "code": "invalid_signature"}
  • ❌ パラメータ不足 → {"error": "...", "code": "missing_signature"}

トラブルシューティング

署名が一致しない

  1. 正しいHMACシークレットを使用していることを確認してください（ダッシュボードでAPIキーを確認）
  2. 正規クエリを確認してください：sを除くすべてのクエリパラメータ（keyを含む）、値はrfc3986でエンコードされ、キーは辞書順にソートされている必要があります
  3. 署名が小文字の16進数（64文字）であることを確認してください

HMACシークレットの取得方法

  1. ダッシュボード → APIキー に移動します
  2. 新しいAPIキーを作成するか、既存のものを使用します
  3. APIキーと一緒に表示されるHMACシークレットをコピーします（一度しか表示されません）
  4. 環境変数に安全に保存します
bash
# Add to .env
OG_RENDER_HMAC_SECRET=<your-64-char-hex-secret>

curl でのテスト

bash
# Bash script to generate signed URL
SECRET="your-hmac-secret-here"
API_KEY="sk_quick_123abc"  # Your full API key

# canonical query: sorted "k=v" pairs, every param except `s` (key included)
CANONICAL="key=${API_KEY}&template=default&title=Test"
MESSAGE=$(printf 'GET/api/v1/og\n%s' "$CANONICAL")
SIGNATURE=$(printf '%s' "$MESSAGE" | openssl dgst -sha256 -hmac "$SECRET" | cut -d' ' -f2)

curl "http://localhost:8000/api/v1/og?template=default&title=Test&key=${API_KEY}&s=${SIGNATURE}"

期待される結果: 画像データを含む 200 OK（テンプレートパラメータが無効な場合は 422）。

完全なAPIリファレンス

無料で試す — サインアップ不要

動的OG画像を数秒でプレビューおよびテスト。

無料のOG画像テスターを開く
LocaFile AI AI localization for games, apps, subtitles & sites SubtoVTT Convert & clean subtitle files BeCaSimulations Indie game studio

A BeCaSimulations site