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

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

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

Header	Format	Значение
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 указывается путь, начинающийся с /v1, например /v1/orders, а не /cp/kernelhost_api/v1/orders. Строка запроса (query string), если она есть, тоже входит в PATH (например, /v1/services?limit=10&offset=0). BODY содержит необработанное тело запроса; для запросов без тела BODY является пустой строкой, SHA256 которой равен общеизвестной константе e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855.

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

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

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

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

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

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

• read:products, read:orders, read:services, read:billing, read:webhooks
• read:credentials (Чтение учётных данных услуг (имя хоста, IP-адреса, имя пользователя, пароль). Каждый вызов создаёт дополнительную запись credentials.read в журнале аудита.)
• write:orders (Размещение и оплата заказов.)
• write:services (Выполнение действий с услугами (запуск, остановка, перезагрузка, отмена по окончании расчётного периода и её отзыв).)
• write:webhooks (Установка URL вебхука.)