Authenticatie

Vereiste aanvraagheaders

Elke aanvraag (behalve /v1/health) moet deze vier headers bevatten. Ontbreekt of klopt er één, dan wijst de server af met HTTP 401.

Header	Format	Betekenis
KH-Key	kh_live_[A-Z0-9]{32}	Openbare sleutel-identifier. Geen geheime sleutel, mag in logs verschijnen.
KH-Timestamp	Unix-seconden (10 cijfers)	Huidige tijdstempel. Tolerantievenster +-300s.
KH-Nonce	22-44 base64url-tekens	Eenmalige waarde per aanvraag. 600s opgeslagen, daarna mag de waarde opnieuw worden gebruikt.
KH-Signature	64 hex	HMAC-SHA256(secret, signing_string), hex-gecodeerd.

Signing string opbouwen

De te ondertekenen string bestaat uit vijf componenten, gescheiden door een newline (\n).

signing_string = METHOD + "\n"
               + PATH    + "\n"
               + TIMESTAMP + "\n"
               + NONCE   + "\n"
               + SHA256_HEX(BODY)

signature = HEX( HMAC_SHA256(secret, signing_string) )

PATH is het pad vanaf /v1, bijvoorbeeld /v1/orders en niet /cp/kernelhost_api/v1/orders. Heeft de aanvraag een query string, dan maakt die deel uit van PATH (bijvoorbeeld /v1/services?limit=10&offset=0). BODY is de ruwe request-body; bij aanvragen zonder body is BODY een lege string waarvan de SHA256 de bekende constante waarde e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 is.

Referentie-implementaties

PHP:

$method = 'POST';
$path   = '/v1/orders';
$body   = json_encode(['product_id' => 42, 'billing_cycle' => 'monthly', 'hostname' => 'web01.example.com']);
$idem   = 'order-web01-' . date('Ymd');
$ts     = (string) time();
$nonce  = bin2hex(random_bytes(16));

$signing = "{$method}\n{$path}\n{$ts}\n{$nonce}\n" . hash('sha256', $body);
$sig = hash_hmac('sha256', $signing, getenv('KH_SECRET'));

$ch = curl_init('https://www.kernelhost.com/cp/kernelhost_api/v1/orders');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_POSTFIELDS     => $body,
    CURLOPT_HTTPHEADER     => [
        'Content-Type: application/json',
        'KH-Key: ' . getenv('KH_KEY'),
        "KH-Timestamp: {$ts}",
        "KH-Nonce: {$nonce}",
        "KH-Signature: {$sig}",
        "Idempotency-Key: {$idem}",
    ],
]);
$res = curl_exec($ch);

Node.js:

import crypto from 'node:crypto';

const method = 'POST';
const path   = '/v1/orders';
const body   = JSON.stringify({ product_id: 42, billing_cycle: 'monthly', hostname: 'web01.example.com' });
const idem   = 'order-web01-' + new Date().toISOString().slice(0, 10).replaceAll('-', '');
const ts     = Math.floor(Date.now() / 1000).toString();
const nonce  = crypto.randomBytes(16).toString('hex');

const bodyHash = crypto.createHash('sha256').update(body).digest('hex');
const signing  = `${method}\n${path}\n${ts}\n${nonce}\n${bodyHash}`;
const sig      = crypto.createHmac('sha256', process.env.KH_SECRET).update(signing).digest('hex');

const res = await fetch('https://www.kernelhost.com/cp/kernelhost_api/v1/orders', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'KH-Key': process.env.KH_KEY,
        'KH-Timestamp': ts,
        'KH-Nonce': nonce,
        'KH-Signature': sig,
        'Idempotency-Key': idem,
    },
    body,
});

Replay-bescherming

Een succesvol ondertekende aanvraag kan NIET opnieuw worden verzonden. De server slaat elke nonce 600s op in de database, een tweede aanvraag met dezelfde nonce wordt geweigerd met replay_detected. Op dezelfde manier wordt een aanvraag geweigerd waarvan het tijdstempel meer dan 300s van de servertijd afwijkt.

Machtigingsmodel

Elke sleutel heeft een expliciete lijst met machtigingen. Routes controleren de vereiste machtiging; ontbreekt zij, dan volgt HTTP 403 forbidden_scope. Schrijvende en gevoelige machtigingen moeten bij het aanmaken van de sleutel uitdrukkelijk worden ingeschakeld.

• read:products, read:orders, read:services, read:billing, read:webhooks
• read:credentials (Service-toegangsgegevens lezen (hostnaam, IP-adressen, gebruikersnaam, wachtwoord). Genereert per aanroep een extra auditvermelding credentials.read.)
• write:orders (Bestellingen plaatsen en betalen.)
• write:services (Service-acties uitvoeren (start, stop, reboot, opzegging per einde van de factureringsperiode en het intrekken daarvan).)
• write:webhooks (Webhook-URL instellen.)