Uwierzytelnianie

Wymagane nagłówki żądania

Każde żądanie (poza /v1/health) musi zawierać te cztery nagłówki. Jeśli któryś brakuje lub jest niepoprawny, serwer odrzuca żądanie z kodem HTTP 401.

Header	Format	Znaczenie
KH-Key	kh_live_[A-Z0-9]{32}	Publiczny identyfikator klucza. Nie jest tajny, może pojawiać się w logach.
KH-Timestamp	Sekundy uniksowe (10 cyfr)	Bieżący znacznik czasu. Okno tolerancji +-300s.
KH-Nonce	22-44 znaki base64url	Wartość jednorazowa na każde żądanie. Buforowana przez 600s, następnie może być ponownie użyta.
KH-Signature	64 hex	HMAC-SHA256(secret, signing_string), zakodowane heksadecymalnie.

Budowa ciągu podpisu

Ciąg do podpisania składa się z pięciu komponentów połączonych znakiem nowej linii (\n).

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

signature = HEX( HMAC_SHA256(secret, signing_string) )

PATH to ścieżka zaczynająca się od /v1, na przykład /v1/orders, a nie /cp/kernelhost_api/v1/orders. Jeśli żądanie zawiera query string, jest on częścią PATH (na przykład /v1/services?limit=10&offset=0). BODY to surowa treść żądania; w przypadku żądań bez treści BODY jest pustym ciągiem znaków, którego SHA256 to powszechnie znana stała e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855.

Implementacje referencyjne

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,
});

Ochrona przed powtórzeniem

Pomyślnie podpisane żądanie NIE może zostać odtworzone ponownie. Serwer zapisuje każdy nonce na 600s w bazie danych; drugie żądanie z tym samym nonce zostaje odrzucone jako replay_detected. Podobnie odrzucane jest żądanie, którego znacznik czasu odbiega o więcej niż 300s od czasu serwera.

Model zakresów uprawnień

Każdy klucz posiada jawną listę zakresów uprawnień. Endpointy sprawdzają wymagany zakres; jeśli go brak, zwracany jest HTTP 403 forbidden_scope. Zakresy zapisujące i wrażliwe muszą być jawnie włączone przy tworzeniu klucza.

• read:products, read:orders, read:services, read:billing, read:webhooks
• read:credentials (Odczyt danych dostępowych usługi (nazwa hosta, adresy IP, nazwa użytkownika, hasło). Każde wywołanie tworzy dodatkowy wpis audytu credentials.read.)
• write:orders (Składanie i opłacanie zamówień.)
• write:services (Wykonywanie akcji serwisowych (start, stop, reboot, anulowanie na koniec okresu rozliczeniowego oraz jego cofnięcie).)
• write:webhooks (Ustawianie URL webhooka.)