Foundation for extending the Bearer API beyond create-only:
- api_keys gains a scope column (read | read_write); baseline schema updated
and the column applied to the live DB. Existing keys default to
read_write so the hwmon create key keeps working.
- ApiKeyModel: createKey() takes a validated scope; validateKey() always
surfaces scope (defaults read_write); getAllKeys() is paginated
({keys,total,page,perPage}, key_hash stripped).
- ApiKeyAuth: expose getKeyContext() (scope/key_name/created_by/api_key_id)
and requireScope() (403 on insufficient scope); existing return values
unchanged.
- create_ticket_api.php: require read_write scope (a read key can't create).
- Admin /admin/api-keys: scope selector on the create form, a scope column,
and pagination (revoked keys were stacking up).
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
150 lines
4.5 KiB
PHP
150 lines
4.5 KiB
PHP
<?php
|
|
|
|
// API endpoint for generating API keys (Admin only)
|
|
error_reporting(E_ALL);
|
|
ini_set('display_errors', 0);
|
|
|
|
// Apply rate limiting
|
|
require_once dirname(__DIR__) . '/middleware/RateLimitMiddleware.php';
|
|
RateLimitMiddleware::apply('api');
|
|
|
|
ob_start();
|
|
|
|
try {
|
|
// Load config
|
|
require_once dirname(__DIR__) . '/config/config.php';
|
|
require_once dirname(__DIR__) . '/helpers/Database.php';
|
|
|
|
// Load models
|
|
require_once dirname(__DIR__) . '/models/ApiKeyModel.php';
|
|
require_once dirname(__DIR__) . '/models/AuditLogModel.php';
|
|
|
|
// Check authentication via session
|
|
if (session_status() === PHP_SESSION_NONE) {
|
|
session_start();
|
|
}
|
|
if (!isset($_SESSION['user']) || !isset($_SESSION['user']['user_id'])) {
|
|
http_response_code(401);
|
|
throw new Exception("Authentication required");
|
|
}
|
|
|
|
// Check admin privileges
|
|
if (!isset($_SESSION['user']['is_admin']) || !$_SESSION['user']['is_admin']) {
|
|
http_response_code(403);
|
|
throw new Exception("Admin privileges required");
|
|
}
|
|
|
|
// CSRF Protection
|
|
require_once dirname(__DIR__) . '/middleware/CsrfMiddleware.php';
|
|
if ($_SERVER['REQUEST_METHOD'] === 'POST') {
|
|
$csrfToken = $_SERVER['HTTP_X_CSRF_TOKEN'] ?? '';
|
|
if (!CsrfMiddleware::validateToken($csrfToken)) {
|
|
http_response_code(403);
|
|
throw new Exception("Invalid CSRF token");
|
|
}
|
|
}
|
|
|
|
// Only allow POST
|
|
if ($_SERVER['REQUEST_METHOD'] !== 'POST') {
|
|
http_response_code(405);
|
|
throw new Exception("Method not allowed");
|
|
}
|
|
|
|
// Get request data
|
|
$input = json_decode(file_get_contents('php://input'), true);
|
|
if (!$input) {
|
|
http_response_code(400);
|
|
throw new Exception("Invalid request data");
|
|
}
|
|
|
|
$keyName = trim($input['key_name'] ?? '');
|
|
$expiresInDays = $input['expires_in_days'] ?? null;
|
|
$scope = $input['scope'] ?? 'read_write';
|
|
|
|
if (empty($keyName)) {
|
|
http_response_code(400);
|
|
throw new Exception("Key name is required");
|
|
}
|
|
|
|
// Validate scope — only the two known values are allowed
|
|
if (!in_array($scope, ['read', 'read_write'], true)) {
|
|
http_response_code(400);
|
|
throw new Exception("Invalid scope: must be 'read' or 'read_write'");
|
|
}
|
|
|
|
if (strlen($keyName) > 100) {
|
|
http_response_code(400);
|
|
throw new Exception("Key name must be 100 characters or less");
|
|
}
|
|
|
|
// Validate expires_in_days if provided
|
|
if ($expiresInDays !== null && $expiresInDays !== '') {
|
|
$expiresInDays = (int)$expiresInDays;
|
|
if ($expiresInDays < 1 || $expiresInDays > 3650) {
|
|
http_response_code(400);
|
|
throw new Exception("Expiration must be between 1 and 3650 days");
|
|
}
|
|
} else {
|
|
$expiresInDays = null;
|
|
}
|
|
|
|
// Use centralized database connection
|
|
$conn = Database::getConnection();
|
|
|
|
// Generate API key
|
|
$apiKeyModel = new ApiKeyModel($conn);
|
|
$result = $apiKeyModel->createKey($keyName, $_SESSION['user']['user_id'], $expiresInDays, $scope);
|
|
|
|
if (!$result['success']) {
|
|
throw new Exception($result['error'] ?? "Failed to generate API key");
|
|
}
|
|
|
|
// Log the action
|
|
$auditLog = new AuditLogModel($conn);
|
|
$auditLog->log(
|
|
$_SESSION['user']['user_id'],
|
|
'create',
|
|
'api_key',
|
|
$result['key_id'],
|
|
['key_name' => $keyName, 'expires_in_days' => $expiresInDays, 'scope' => $scope]
|
|
);
|
|
|
|
// Clear output buffer
|
|
ob_end_clean();
|
|
|
|
// Return success with the plaintext key (shown only once)
|
|
header('Content-Type: application/json');
|
|
echo json_encode([
|
|
'success' => true,
|
|
'api_key' => $result['api_key'],
|
|
'key_prefix' => $result['key_prefix'],
|
|
'key_id' => $result['key_id'],
|
|
'scope' => $result['scope'],
|
|
'expires_at' => $result['expires_at']
|
|
]);
|
|
} catch (Exception $e) {
|
|
ob_end_clean();
|
|
header('Content-Type: application/json');
|
|
|
|
// Preserve any specific status set before the throw (401/403/400/...);
|
|
// only fall back to 500 when nothing more specific was set.
|
|
$code = http_response_code();
|
|
if (!is_int($code) || $code < 400) {
|
|
$code = 500;
|
|
}
|
|
http_response_code($code);
|
|
|
|
if ($code >= 500) {
|
|
error_log("Generate API key error: " . $e->getMessage());
|
|
echo json_encode([
|
|
'success' => false,
|
|
'error' => 'An internal error occurred'
|
|
]);
|
|
} else {
|
|
echo json_encode([
|
|
'success' => false,
|
|
'error' => $e->getMessage()
|
|
]);
|
|
}
|
|
}
|