HMAC-allekirjoitusopas

Tämä HMAC-allekirjoitusopas opastaa sinua rakentamaan HMAC-SHA256-allekirjoituksia FastOG:lle, jotta voit luoda dynaamisia Open Graph -kuvia lennossa — tilauspohjaisesti, ilmaisella tilillä ja Dynamic API -suunnitelmalla (maksetut renderöinnit ovat puhtaita). Voit toteuttaa allekirjoituksen käsin millä tahansa kielellä tässä, tai käyttää ilmaista OG-kuvatestaajaa nähdäksesi URL-muodon toiminnassa ensin.

Yleiskatsaus

Kaikkiin /api/v1/og-osoitteisiin tehtäviin pyyntöihin on sisällytettävä HMAC-SHA256-allekirjoitus, joka todistaa, että ne ovat peräisin lailliselta verkkosivustolta. Tämä estää ulkopuolisia käyttämästä API-kiintiötäsi.

Kaksi todennuskerrosta:

API-avain (kyselyssä: key=sk_quick_123abc) — tunnistaa käyttäjätilin (renderöintikiintiön laskentaa varten)
HMAC-allekirjoitus (kyselyssä: s=<signature>) — todistaa, että pyyntö on peräisin verkkosivustoltasi

Molempien on täytyttävä. Pelkkä API-avain EI riitä.

Miksi kyselyparametrit? OG-kuvat haetaan sosiaalisen median indeksointirobottien (LinkedIn, Twitter, Facebook) toimesta, jotka eivät lähetä mukautettuja otsakkeita. Allekirjoituksen ON oltava URL-osoitteessa.

Allekirjoituksen luominen

Algoritmi

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>

Vaatimukset

Allekirjoituksen muoto: 64 merkin pituinen heksadesimaalimerkkijono (SHA256)
Käytä hash_equals() vakioaikaiseen vertailuun (estää ajoitus hyökkäykset)
Käyttäjäkohtaiset salaisuudet: Jokaisella API-avaimella on oma hmac_secret-kenttä

Esimerkkitoteutukset

Täydelliset opetusohjelmat useilla kehyksillä ja malleilla löydät täältä:

JavaScript/Node.js-opetusohjelma - Next.js, Express, vanilla Node.js
Next.js App Router
Next.js Pages Router
React
SvelteKit
Vue/Nuxt
Astro
Express
Vanilla Node.js
PHP/Laravel
Python
Ruby/Rails

JavaScript (Node.js / Frontend)

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 }}" />

Täydellinen esimerkki: Laravel Blade -malli

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>

Turvallisuuden parhaat käytännöt

Säilytä salaisuudet turvallisesti – Käytä ympäristömuuttujia tai salaisuuksien hallintatyökalua
Älä koskaan paljasta salaisuuksia asiakaspuolen koodissa – Allekirjoita URL-osoitteet vain palvelimella
Käytä HTTPS:ää – Estää MITM-hyökkäykset
Vaihda salaisuudet säännöllisesti – Erityisesti jos ne ovat vaarantuneet
Seuraa epäonnistuneita allekirjoituksia – Toistuvat epäonnistumiset voivat viitata hyökkäyksiin
Käyttäjäkohtainen eristys – Jokaisella API-avaimella on oma HMAC-salaisuutensa

Virhevastaukset

Puuttuva allekirjoitus

json

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

Virheellinen allekirjoitus

json

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

Testaus

Luo testi-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>"

Odotetut vastaukset:

✅ Kelvollinen allekirjoitus → Palauttaa OG-kuvan (tai vahvistusvirheen, jos malliparametrit puuttuvat)
❌ Virheellinen allekirjoitus → {"error": "...", "code": "invalid_signature"}
❌ Puuttuvat parametrit → {"error": "...", "code": "missing_signature"}

Vianmääritys

Allekirjoitus ei täsmää

Varmista, että käytät oikeaa HMAC-salaista avainta (tarkista API-avain hallintapaneelista)
Tarkista kanoninen kysely: kaikki kyselyparametrit paitsi s (mukaan lukien key), arvot RFC3986-koodattuina, avaimet lajiteltu leksikografisesti
Varmista, että allekirjoitus on pienaakkosina heksadesimaalimuodossa (64 merkkiä)

HMAC-salaisuuden hankkiminen

Siirry kohtaan Dashboard → API-avaimet
Luo uusi API-avain (tai käytä olemassa olevaa)
Kopioi API-avaimen yhteydessä näkyvä HMAC-salaisuus (näytetään vain kerran!)
Tallenna se turvallisesti ympäristömuuttujiin

bash

# Add to .env
OG_RENDER_HMAC_SECRET=<your-64-char-hex-secret>

Testaaminen curlilla

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}"

Odotettu tulos: 200 OK kuvadatan kanssa (tai 422, jos malliparametrit ovat virheellisiä).

HMAC-allekirjoitusopas

Yleiskatsaus

Allekirjoituksen luominen

Algoritmi

Vaatimukset

Esimerkkitoteutukset

JavaScript (Node.js / Frontend)

PHP (Laravel)

Python

Täydellinen esimerkki: Laravel Blade -malli

Turvallisuuden parhaat käytännöt

Virhevastaukset

Puuttuva allekirjoitus

Virheellinen allekirjoitus

Testaus

Vianmääritys

Allekirjoitus ei täsmää

HMAC-salaisuuden hankkiminen

Testaaminen curlilla

Täydellinen API-viite

Aiheeseen liittyvää