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.

feat: expose value-free effective environment provenance through app access boundary

Juan Denisd4f6b2af557e
diff --git a/backend/app/api/env_vars.py b/backend/app/api/env_vars.py
index 555f6cbe..a2fff981 100644
--- a/backend/app/api/env_vars.py
+++ b/backend/app/api/env_vars.py
@@ -26,6 +26,13 @@ def get_env_vars(app_id):
user = get_current_user()
app = require_app(app_id)
+ if request.args.get('view') == 'effective':
+ service = request.args.get('service') or None
+ if service is not None and (len(service) > 255 or not all(
+ c.isalnum() or c in '._-' for c in service)):
+ return jsonify({'error': 'Invalid service name'}), 400
+ return jsonify(EnvService.get_effective_env_view(app_id, service=service)), 200
+
# 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))
diff --git a/backend/app/services/env_service.py b/backend/app/services/env_service.py
index 2ff6e523..38069580 100644
--- a/backend/app/services/env_service.py
+++ b/backend/app/services/env_service.py
@@ -87,34 +87,78 @@ class EnvService:
if not app:
return {}
- merged = {}
+ entries, _ = EnvService._effective_entries(app)
+ return {key: entry['value'] for key, entry in entries.items()}
+
+ @staticmethod
+ def _effective_entries(app, service=None, metadata_only=False, local_vars=None):
+ """One precedence seam for deployment and the read-only provenance view.
- # 1) Shared variable groups — the base layer (lowest precedence).
+ Metadata mode never resolves local references or returns values. Shared
+ interpolation remains before local overrides, matching deployment.
+ """
+ merged = {}
+ complete = True
+ context = {
+ name: str(getattr(app, name)) if getattr(app, name) is not None else None
+ for name in ('workspace_id', 'project_id', 'environment_id')
+ }
try:
from app.services.shared_resource_service import SharedResourceService
- context = {
- # scope_id is stored as a string when groups are created, so
- # coerce the app's numeric ids to match on lookup.
- 'workspace_id': str(app.workspace_id) if app.workspace_id is not None else None,
- 'project_id': str(app.project_id) if app.project_id is not None else None,
- 'environment_id': str(app.environment_id) if app.environment_id is not None else None,
- }
resolved = SharedResourceService.resolve_hierarchical(
- 'application', application_id, context=context,
- mask_secrets=False, interpolate=True,
+ 'application', app.id, context=context, service=service,
+ mask_secrets=metadata_only, interpolate=not metadata_only,
)
for entry in resolved or []:
key = entry.get('key')
if key:
- merged[key] = entry.get('value')
- except Exception as e: # best-effort — never block a deploy on shared vars
- logger.warning('Shared variable resolution failed for app %s: %s', application_id, e)
-
- # 2) Local env vars — the override layer (highest precedence wins).
- for ev in EnvironmentVariable.query.filter_by(application_id=application_id).all():
- merged[ev.key] = EnvService._resolve_var_value(app, ev)
+ # Explicit projection: never carry resolver values or future
+ # sensitive fields into the metadata API.
+ merged[key] = {
+ field: entry.get(field) for field in (
+ 'key', 'source_scope', 'group_id', 'group_name',
+ 'target_service', 'is_secret',
+ )
+ }
+ if not metadata_only:
+ merged[key]['value'] = entry.get('value')
+ except Exception:
+ complete = False
+ logger.warning('Shared variable resolution failed for app %s', app.id)
+
+ if local_vars is None:
+ local_vars = EnvironmentVariable.query.filter_by(application_id=app.id).all()
+ for ev in local_vars:
+ if service is not None and ev.target_service not in (None, '', service):
+ continue
+ inherited = merged.get(ev.key)
+ entry = {
+ 'key': ev.key, 'source_scope': 'local',
+ 'group_id': None, 'group_name': None,
+ 'target_service': ev.target_service,
+ 'is_secret': bool(ev.is_secret),
+ 'is_reference': bool(ev.value_from),
+ 'overrides': ({field: inherited.get(field) for field in
+ ('source_scope', 'group_id', 'group_name')}
+ if inherited else None),
+ }
+ if not metadata_only:
+ entry['value'] = EnvService._resolve_var_value(app, ev)
+ merged[ev.key] = entry
+ return merged, complete
- return merged
+ @staticmethod
+ def get_effective_env_view(application_id, service=None):
+ """Managed configuration provenance, not a live container inspection."""
+ app = Application.query_active().filter_by(id=application_id).first()
+ if not app:
+ return {'env_vars': [], 'count': 0, 'complete': False}
+ entries, complete = EnvService._effective_entries(
+ app, service=service, metadata_only=True,
+ )
+ rows = [entries[key] for key in sorted(entries)]
+ return {'env_vars': rows, 'count': len(rows), 'complete': complete,
+ 'service': service, 'values_hidden': True}
@staticmethod
def _resolve_var_value(app, ev):
@@ -203,36 +247,11 @@ class EnvService:
if not app or not service_names:
return {}
- context = {
- 'workspace_id': str(app.workspace_id) if app.workspace_id is not None else None,
- 'project_id': str(app.project_id) if app.project_id is not None else None,
- 'environment_id': str(app.environment_id) if app.environment_id is not None else None,
- }
local_vars = EnvironmentVariable.query.filter_by(application_id=application_id).all()
-
result = {}
for svc in service_names:
- env = {}
- # Shared groups applicable to this service (NULL-target + this svc).
- try:
- from app.services.shared_resource_service import SharedResourceService
- resolved = SharedResourceService.resolve_hierarchical(
- 'application', application_id, context=context,
- mask_secrets=False, interpolate=True, service=svc,
- )
- for entry in resolved or []:
- key = entry.get('key')
- if key:
- env[key] = entry.get('value')
- except Exception as e: # best-effort
- logger.warning('Shared resolution failed for app %s svc %s: %s',
- application_id, svc, e)
- # Local vars override; include all-services + this-service targets.
- for ev in local_vars:
- tgt = ev.target_service
- if tgt in (None, '') or tgt == svc:
- env[ev.key] = EnvService._resolve_var_value(app, ev)
- result[svc] = env
+ entries, _ = EnvService._effective_entries(app, service=svc, local_vars=local_vars)
+ result[svc] = {key: entry['value'] for key, entry in entries.items()}
return result
@staticmethod
diff --git a/backend/tests/test_effective_env.py b/backend/tests/test_effective_env.py
index 94198dd2..18627485 100644
--- a/backend/tests/test_effective_env.py
+++ b/backend/tests/test_effective_env.py
@@ -135,3 +135,59 @@ def test_deploy_docker_injects_effective_env(app, monkeypatch):
assert env['SHARED_ONLY'] == 'from_group' # shared var reached the container
assert env['OVERRIDE_ME'] == 'local_value' # local won the collision
assert env['LOCAL_ONLY'] == 'local_only'
+
+
+def test_effective_view_matches_winners_without_values(app):
+ from app import db
+ from app.services.env_service import EnvService
+ with app.app_context():
+ a = _make_app(workspace_id=7)
+ _make_scoped_group('workspace', 7, 'SHARED', 'inherited-secret')
+ _make_scoped_group('workspace', 7, 'OVERRIDE', 'old-secret')
+ _set_local(a.id, 'OVERRIDE', 'new-secret', is_secret=True)
+ local = _set_local(a.id, 'TARGET', 'target-secret')
+ local.target_service = 'web'
+ db.session.commit()
+ for service in ('web', 'worker'):
+ view = EnvService.get_effective_env_view(a.id, service)
+ deployed = EnvService.get_effective_env_for_services(a.id, [service])[service]
+ assert view['complete'] and view['values_hidden']
+ assert {row['key'] for row in view['env_vars']} == set(deployed)
+ rows = {row['key']: row for row in view['env_vars']}
+ assert rows['SHARED']['source_scope'] == 'workspace'
+ assert rows['OVERRIDE']['source_scope'] == 'local'
+ assert rows['OVERRIDE']['overrides']['group_name'] == 'workspace-grp'
+ assert 'secret' not in str(view).replace('is_secret', '')
+ assert all('value' not in row for row in rows.values())
+
+
+def test_effective_view_reports_incomplete_shared_resolution(app, monkeypatch):
+ from app.services.env_service import EnvService
+ from app.services.shared_resource_service import SharedResourceService
+ with app.app_context():
+ a = _make_app()
+ _set_local(a.id, 'LOCAL', 'private')
+ def fail(*args, **kwargs):
+ raise RuntimeError('sensitive connection details')
+ monkeypatch.setattr(SharedResourceService, 'resolve_hierarchical', fail)
+ view = EnvService.get_effective_env_view(a.id)
+ assert view['complete'] is False
+ assert [row['key'] for row in view['env_vars']] == ['LOCAL']
+ assert 'sensitive' not in str(view)
+ assert EnvService.get_effective_env(a.id) == {'LOCAL': 'private'}
+
+
+def test_effective_view_never_resolves_local_references(app, monkeypatch):
+ from app import db
+ from app.services.env_service import EnvService
+ with app.app_context():
+ a = _make_app()
+ ev = _set_local(a.id, 'REF', '')
+ ev.set_reference({'kind': 'secret', 'secret': 'credential'})
+ db.session.commit()
+ def fail(*args):
+ raise AssertionError('metadata must not decrypt or resolve local values')
+ monkeypatch.setattr(EnvService, '_resolve_var_value', fail)
+ view = EnvService.get_effective_env_view(a.id)
+ assert view['env_vars'][0]['is_reference'] is True
+ assert 'credential' not in str(view)
diff --git a/backend/tests/test_env_vars_api.py b/backend/tests/test_env_vars_api.py
index bc16ce70..c45ea16e 100644
--- a/backend/tests/test_env_vars_api.py
+++ b/backend/tests/test_env_vars_api.py
@@ -43,3 +43,24 @@ def test_null_description_clears_but_omitted_leaves_it(app, client):
headers=headers)
assert res.status_code == 200
assert res.get_json()['env_var']['description'] is None
+
+
+def test_effective_view_is_value_free_and_app_scoped(app, client):
+ from factories import headers_for, make_user
+ with app.app_context():
+ application, owner = _seed_var(app)
+ app_id = application.id
+ owner_headers = headers_for(owner)
+ stranger = make_user(db, role='viewer')
+ stranger_headers = headers_for(stranger)
+ url = f'/api/v1/apps/{app_id}/env?view=effective'
+ response = client.get(url, headers=owner_headers)
+ assert response.status_code == 200
+ data = response.get_json()
+ assert data['values_hidden'] and data['complete']
+ assert data['env_vars'][0]['key'] == 'API_URL'
+ assert 'https://api.example.test' not in response.get_data(as_text=True)
+ assert 'value' not in data['env_vars'][0]
+ assert client.get(url, headers=stranger_headers).status_code in (403, 404)
+ assert client.get(url).status_code == 401
+ assert client.get(url + '&service=bad/name', headers=owner_headers).status_code == 400
diff --git a/frontend/src/i18n/locales/en.json b/frontend/src/i18n/locales/en.json
index 8110a503..82f855df 100644
--- a/frontend/src/i18n/locales/en.json
+++ b/frontend/src/i18n/locales/en.json
@@ -4419,6 +4419,9 @@
"rename": "Rename"
},
"previewList": {
+ "supportedProvisioners": "Preview deployment requires a supported runtime provisioner. Generic application previews are not available yet. A domain alone does not mean a preview is deployed.",
+ "noRuntime": "No provisioned runtime is recorded for this preview. Its URL is unavailable.",
+ "previewNotDeployed": "The preview was not deployed. Review its status below.",
"activePreviews": "Active previews",
"couldNotLoadPrPreviews": "Couldn't load PR previews.",
"couldNotSaveSettings": "Couldn't save the settings.",