Аутентификация

Обязательные заголовки запроса

Каждый запрос (кроме /v1/health) должен содержать эти четыре заголовка. Если хотя бы один отсутствует или некорректен, сервер отклоняет запрос с HTTP 401.

Header	Format	Description
KH-Key	kh_live_[A-Z0-9]{32}	Публичный идентификатор ключа. Не является секретом, может встречаться в логах.
KH-Timestamp	Unix-секунды (10 цифр)	Текущая временная метка. Окно допуска +-300с.
KH-Nonce	22-44 символа base64url	Одноразовое значение на каждый запрос. Кэшируется 600с, после чего может быть использовано повторно.
KH-Signature	64 hex	HMAC-SHA256(secret, signing_string), в hex-кодировке.

Построение строки подписи

Подписываемая строка состоит из пяти компонентов, соединённых переводом строки (\n).

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

signature = HEX( HMAC_SHA256(secret, signing_string) )

PATH содержит полный путь запроса вместе с query string, но без хоста и фрагмента. BODY — это сырые байты тела; для GET/DELETE без тела BODY является пустой строкой, чей SHA256 равен известной константе e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855.

Эталонные реализации

PHP:

$method = 'POST';
$path   = '/v1/orders';
$body   = json_encode(['product_id' => 42, 'billing_cycle' => 'monthly']);
$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, $KH_SECRET);

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

Node.js:

import crypto from 'crypto';

const method = 'POST';
const path   = '/v1/orders';
const body   = JSON.stringify({ product_id: 42, billing_cycle: 'monthly' });
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', KH_SECRET).update(signing).digest('hex');

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

Защита от повторов

Успешно подписанный запрос НЕ может быть отправлен повторно. Сервер хранит каждый nonce 600с в базе данных; второй запрос с тем же nonce отклоняется с replay_detected. Аналогично запрос, чья временная метка отличается от серверного времени более чем на 300с, отклоняется.

Модель разрешений

У каждого ключа есть явный список разрешений. Маршруты проверяют требуемое разрешение; если его нет, возвращается HTTP 403 forbidden_scope. Разрешения на запись и чувствительные разрешения должны быть включены явно при создании ключа.

• read:products, read:orders, read:services, read:billing, read:webhooks
• read:credentials (Чтение учётных данных услуг (пароли root, FTP, VNC). Создаёт дополнительную запись в журнале аудита credentials.read на каждый вызов.)
• write:orders (Размещение и оплата заказов.)
• write:services (Выполнение действий с услугами (start/stop/reboot/reinstall/terminate).)
• write:webhooks (Установка URL вебхука.)