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.

Mask secret env values for read-only app grants

Juan Denis38810ae25b54
diff --git a/backend/app/api/env_vars.py b/backend/app/api/env_vars.py
index e3bf46ba..2af9ced2 100644
--- a/backend/app/api/env_vars.py
+++ b/backend/app/api/env_vars.py
@@ -48,8 +48,9 @@ def get_env_vars(app_id):
if error:
return error, status
- # Check if secrets should be masked
- mask_secrets = request.args.get('mask', 'false').lower() == 'true'
+ # A read-only grant never sees secret values, whatever ?mask says.
+ mask_secrets = (request.args.get('mask', 'false').lower() == 'true'
+ or not ResourceGrantService.can_edit_app(user, app))
env_vars = EnvService.get_env_vars(app_id, mask_secrets=mask_secrets)
@@ -111,7 +112,8 @@ def get_env_var(app_id, key):
return jsonify({'error': 'Environment variable not found'}), 404
return jsonify({
- 'env_var': env_var.to_dict()
+ 'env_var': env_var.to_dict(
+ mask_secrets=not ResourceGrantService.can_edit_app(user, app))
}), 200
@@ -246,7 +248,8 @@ def export_env_file(app_id):
if error:
return error, status
- include_secrets = request.args.get('include_secrets', 'true').lower() == 'true'
+ include_secrets = (request.args.get('include_secrets', 'true').lower() == 'true'
+ and ResourceGrantService.can_edit_app(user, app))
content = EnvService.export_to_env_format(app_id, include_secrets=include_secrets)
diff --git a/backend/tests/test_env_secret_masking.py b/backend/tests/test_env_secret_masking.py
new file mode 100644
index 00000000..217f04fd
--- /dev/null
+++ b/backend/tests/test_env_secret_masking.py
@@ -0,0 +1,70 @@
+"""A read-only (viewer) grant on an app must never see secret env values —
+masking used to be opt-in from the client via ?mask=true."""
+import pytest
+
+SECRET = 's3cr3t-db-password'
+
+
+def _mk_user(db, username, role):
+ from app.models import User
+ from werkzeug.security import generate_password_hash
+ u = User(email=f'{username}@t.local', username=username,
+ password_hash=generate_password_hash('x'), role=role, is_active=True)
+ db.session.add(u)
+ db.session.commit()
+ return u
+
+
+def _token(user_id):
+ from flask_jwt_extended import create_access_token
+ return {'Authorization': f'Bearer {create_access_token(identity=user_id)}'}
+
+
+def shared_app(app):
+ from app import db
+ from app.models import Application
+ from app.services.env_service import EnvService
+ from app.services.resource_grant_service import ResourceGrantService
+ owner = _mk_user(db, 'esm_owner', 'developer')
+ viewer = _mk_user(db, 'esm_viewer', 'developer')
+ editor = _mk_user(db, 'esm_editor', 'developer')
+ application = Application(name='esm-app', app_type='docker', user_id=owner.id)
+ db.session.add(application)
+ db.session.commit()
+ ResourceGrantService.grant(viewer.id, 'application', application.id, role='viewer')
+ ResourceGrantService.grant(editor.id, 'application', application.id, role='editor')
+ EnvService.set_env_var(application.id, 'DB_PASSWORD', SECRET, is_secret=True)
+ EnvService.set_env_var(application.id, 'LOG_LEVEL', 'info')
+ return {'id': application.id, 'owner': owner.id, 'viewer': viewer.id, 'editor': editor.id}
+
+
+def _urls(app_id):
+ return [f'/api/v1/apps/{app_id}/env',
+ f'/api/v1/apps/{app_id}/env?mask=false',
+ f'/api/v1/apps/{app_id}/env/DB_PASSWORD',
+ f'/api/v1/apps/{app_id}/env/export?include_secrets=true']
+
+
+def test_viewer_never_sees_secret_values(client, shared_app):
+ for url in _urls(shared_app['id']):
+ resp = client.get(url, headers=_token(shared_app['viewer']))
+ assert resp.status_code == 200, url
+ assert SECRET not in resp.get_data(as_text=True), url
+
+
+def test_viewer_still_sees_plain_values(client, shared_app):
+ resp = client.get(f"/api/v1/apps/{shared_app['id']}/env",
+ headers=_token(shared_app['viewer']))
+ values = {v['key']: v['value'] for v in resp.get_json()['env_vars']}
+ assert values['LOG_LEVEL'] == 'info'
+
+
[email protected]('who', ['owner', 'editor'])
+def test_editors_can_read_secrets(client, shared_app, who):
+ resp = client.get(f"/api/v1/apps/{shared_app['id']}/env/DB_PASSWORD",
+ headers=_token(shared_app[who]))
+ assert resp.get_json()['env_var']['value'] == SECRET
+ resp = client.get(f"/api/v1/apps/{shared_app['id']}/env/export",
+ headers=_token(shared_app[who]))
+ assert SECRET in resp.get_json()['content']