Skip to content

ServerKit is a lightweight, modern server control panel for managing web applications, databases, and services on your VPS or dedicated server. Built with Python/Flask backend and React frontend.

Reject non-object JSON bodies with a 400

Juan Denis3e1a264ee464
diff --git a/backend/app/api/_request.py b/backend/app/api/_request.py
new file mode 100644
index 00000000..138b82c3
--- /dev/null
+++ b/backend/app/api/_request.py
@@ -0,0 +1,18 @@
+"""Request-body parsing for routes."""
+from flask import request
+
+from app.exceptions import ValidationError
+
+
+def json_object():
+ """The request body as a dict, or a 400.
+
+ ``request.get_json()`` hands back whatever JSON was sent, so a body of
+ ``null`` or ``[]`` reached ``data.get(...)`` and crashed the route into a
+ 500. Empty and non-JSON bodies are already rejected by Flask.
+ """
+ data = request.get_json()
+ if not isinstance(data, dict):
+ raise ValidationError('Request body must be a JSON object',
+ code='validation.body_not_object')
+ return data
diff --git a/backend/app/api/admin.py b/backend/app/api/admin.py
index 751ee95c..26193299 100644
--- a/backend/app/api/admin.py
+++ b/backend/app/api/admin.py
@@ -14,6 +14,7 @@ from app.services.settings_service import SettingsService
from app.services.permission_service import PermissionService
from app.utils.domain import detect_request_domain, canonical_origin, is_valid_canonical_domain
from app.exceptions import not_found
+from app.api._request import json_object
admin_bp = Blueprint('admin', __name__)
@@ -346,7 +347,7 @@ def get_setting(key):
@admin_required
def update_setting(key):
"""Update a specific setting."""
- data = request.get_json()
+ data = json_object()
current_user_id = get_jwt_identity()
if 'value' not in data:
diff --git a/backend/app/api/cron.py b/backend/app/api/cron.py
index 358fadb9..ae45c5a0 100644
--- a/backend/app/api/cron.py
+++ b/backend/app/api/cron.py
@@ -10,6 +10,7 @@ from flask import Blueprint, request, jsonify
from app.middleware.rbac import admin_required, viewer_required, require_app_member
from app.services.cron_service import CronService
+from app.api._request import json_object
cron_bp = Blueprint('cron', __name__)
@@ -97,7 +98,7 @@ def list_jobs():
@admin_required
def create_job():
"""Create a new cron job."""
- data = request.get_json()
+ data = json_object()
schedule = data.get('schedule')
command = data.get('command')
@@ -131,7 +132,7 @@ def create_job():
@admin_required
def update_job(job_id):
"""Update a cron job."""
- data = request.get_json()
+ data = json_object()
set_application = 'application_id' in data
application_id = None
@@ -170,7 +171,7 @@ def delete_job(job_id):
@admin_required
def toggle_job(job_id):
"""Enable or disable a cron job."""
- data = request.get_json()
+ data = json_object()
enabled = data.get('enabled', True)
result = CronService.toggle_job(job_id, enabled)
diff --git a/backend/app/api/domains.py b/backend/app/api/domains.py
index 8abf2d0c..e22bc2f5 100644
--- a/backend/app/api/domains.py
+++ b/backend/app/api/domains.py
@@ -11,6 +11,7 @@ from app.services.nginx_service import NginxService
from app.services.ssl_service import SSLService, get_acme_contact, remember_acme_contact
from app.services.resource_grant_service import ResourceGrantService
from app.exceptions import already_exists, not_found, permission_denied
+from app.api._request import json_object
domains_bp = Blueprint('domains', __name__)
@@ -307,7 +308,7 @@ def update_domain(domain_id):
if not ResourceGrantService.can_edit_app(user, app):
raise permission_denied()
- data = request.get_json()
+ data = json_object()
if 'is_primary' in data and data['is_primary']:
# Unset any existing primary domain for this app
diff --git a/backend/app/api/servers.py b/backend/app/api/servers.py
index 9522ee3c..757069a4 100644
--- a/backend/app/api/servers.py
+++ b/backend/app/api/servers.py
@@ -17,6 +17,7 @@ from sqlalchemy.orm import joinedload
from app import db, limiter
from app.services.server_metrics_service import latest_metrics_by_server
from app.api._query import apply_query, QueryParseError
+from app.api._request import json_object
from app.models import User
from app.models.server import Server, ServerGroup, ServerMetrics, ServerCommand, AgentSession, AgentVersion, AgentRollout
from app.services.agent_registry import agent_registry
@@ -233,7 +234,7 @@ def update_group(group_id):
if not group:
return jsonify({'error': 'Group not found'}), 404
- data = request.get_json()
+ data = json_object()
if 'name' in data:
group.name = data['name']
@@ -579,7 +580,7 @@ def update_server(server_id):
if not server:
raise not_found('server')
- data = request.get_json()
+ data = json_object()
if 'name' in data:
server.name = data['name']
@@ -733,7 +734,7 @@ def register_agent():
"agent_version": "1.0.0"
}
"""
- data = request.get_json()
+ data = json_object()
token = data.get('token')
if not token:
@@ -1050,7 +1051,7 @@ def update_allowed_ips(server_id):
if not server:
raise not_found('server')
- data = request.get_json()
+ data = json_object()
allowed_ips = data.get('allowed_ips', [])
# Validate each IP pattern
@@ -2406,7 +2407,7 @@ def add_agent_version():
@admin_required
def upgrade_fleet():
"""Trigger upgrade for selected servers or entire fleet"""
- data = request.get_json()
+ data = json_object()
server_ids = data.get('server_ids', [])
version_id = data.get('version_id')
user_id = get_jwt_identity()
@@ -2427,7 +2428,7 @@ def upgrade_fleet():
@admin_required
def start_staged_rollout():
"""Start a staged rollout"""
- data = request.get_json()
+ data = json_object()
group_id = data.get('group_id')
version_id = data.get('version_id')
batch_size = data.get('batch_size', 5)
diff --git a/backend/tests/test_json_object_body.py b/backend/tests/test_json_object_body.py
new file mode 100644
index 00000000..90db1a42
--- /dev/null
+++ b/backend/tests/test_json_object_body.py
@@ -0,0 +1,48 @@
+"""A JSON body that is not an object is a 400, not a crash.
+
+These routes read ``request.get_json()`` and went straight to
+``data.get(...)``; a body of ``null`` or ``[]`` raised AttributeError /
+TypeError and answered 500.
+"""
+import json
+
+import pytest
+
+from factories import headers_for, make_server, make_user
+
+
+def admin_headers(app):
+ from app import db
+ return headers_for(make_user(db, 'jo_admin', 'admin'))
+
+
+def server_id(app):
+ from app import db
+ return make_server(db, name='jo-box').id
+
+
+ROUTES = [
+ ('post', '/api/v1/cron/jobs'),
+ ('post', '/api/v1/cron/jobs/job_x/toggle'),
+ ('put', '/api/v1/servers/{sid}'),
+ ('put', '/api/v1/servers/{sid}/allowed-ips'),
+ ('post', '/api/v1/servers/fleet/upgrade'),
+ ('post', '/api/v1/servers/fleet/rollout'),
+]
+
+
[email protected]('body', ['null', '[]', '"text"'])
[email protected]('method,url', ROUTES)
+def test_non_object_body_is_rejected(client, admin_headers, server_id, method, url, body):
+ resp = getattr(client, method)(url.format(sid=server_id), data=body,
+ headers={**admin_headers, 'Content-Type': 'application/json'})
+ assert resp.status_code == 400, (url, resp.status_code, resp.get_data(as_text=True)[:200])
+ assert resp.get_json()['code'] == 'validation.body_not_object'
+
+
+def test_an_object_body_still_reaches_the_route(client, admin_headers):
+ resp = client.post('/api/v1/cron/jobs/job_x/toggle', data=json.dumps({'enabled': False}),
+ headers={**admin_headers, 'Content-Type': 'application/json'})
+ assert resp.status_code != 400 or resp.get_json().get('code') != 'validation.body_not_object'