From 3ac1e6be5a475296bdf80d7138dd6f4912fa9c82 Mon Sep 17 00:00:00 2001 From: thopkins32 Date: Fri, 6 Nov 2026 17:39:09 -0500 Subject: [PATCH] Hide secrets from logging output Assisted-by: oh-my-pi:claude-opus-5.5 --- docs/source/release-history.rst | 11 +++++++ src/bluesky_httpserver/server.py | 17 ++++++++++- src/bluesky_httpserver/tests/test_server.py | 33 +++++++++++++++++++++ 3 files changed, 60 insertions(+), 1 deletion(-) diff --git a/docs/source/release-history.rst b/docs/source/release-history.rst index c0ba214..9802fb5 100644 --- a/docs/source/release-history.rst +++ b/docs/source/release-history.rst @@ -3,6 +3,17 @@ Release History =============== +Unreleased +========== + +Fixed +----- + +- The server settings logged at startup no longer contain secrets. The token signing keys + (``secret_keys``), the single-user API key and the password in the database URI were logged + in plain text at the INFO level; deployments whose logs others can read should replace them. + + v0.0.15 (2026-11-05) ==================== diff --git a/src/bluesky_httpserver/server.py b/src/bluesky_httpserver/server.py index 2029e70..83c016a 100644 --- a/src/bluesky_httpserver/server.py +++ b/src/bluesky_httpserver/server.py @@ -5,6 +5,8 @@ import sys from pathlib import Path +from sqlalchemy.engine import make_url + import bluesky_httpserver from .app import build_app @@ -114,12 +116,25 @@ def formatter(prog): uvicorn.run(web_app, **uvicorn_kwargs) +def loggable_settings(settings): + """ + Return the settings as a dictionary that is safe to log: the token signing keys and the single-user + API key are masked, and the password is removed from the database URI. + """ + loggable = dict(settings) + loggable["secret_keys"] = ["*******"] * len(settings.secret_keys) + loggable["single_user_api_key"] = "*******" + if settings.database_uri is not None: + loggable["database_uri"] = make_url(settings.database_uri).render_as_string(hide_password=True) + return loggable + + def print_admin_api_key_if_generated(web_app, host, port): # host = host or "127.0.0.1" # port = port or 8000 settings = web_app.dependency_overrides.get(get_settings, get_settings)() - logger.info("APP settings: %s", pprint.pformat(dict(settings))) + logger.info("APP settings: %s", pprint.pformat(loggable_settings(settings))) authenticators = web_app.dependency_overrides.get(get_authenticators, get_authenticators)() if settings.allow_anonymous_access: print( diff --git a/src/bluesky_httpserver/tests/test_server.py b/src/bluesky_httpserver/tests/test_server.py index d04292b..b021e55 100644 --- a/src/bluesky_httpserver/tests/test_server.py +++ b/src/bluesky_httpserver/tests/test_server.py @@ -1,5 +1,7 @@ +import logging import os import pprint +import secrets import pytest from bluesky_queueserver import generate_zmq_keys @@ -14,6 +16,9 @@ set_qserver_zmq_public_key, ) +from bluesky_httpserver.app import build_app +from bluesky_httpserver.server import print_admin_api_key_if_generated +from bluesky_httpserver.settings import get_settings from bluesky_httpserver.tests.conftest import ( # noqa F401 SERVER_ADDRESS, SERVER_PORT, @@ -292,3 +297,31 @@ def test_http_server_custom_routers_1(tmpdir, monkeypatch, re_manager, fastapi_s assert "manager_state" in resp3, pprint.pformat(resp3) resp4 = request_to_json("post", "/some_prefix/status_duplicate_post", request_prefix="") assert resp3 == resp4 + + +def test_startup_log_hides_secrets(caplog): + """ + The settings logged at startup contain neither the token signing keys, nor the single-user API key, nor the + database password. + """ + signing_keys = [secrets.token_hex(32), secrets.token_hex(32)] + api_key, password = secrets.token_hex(32), secrets.token_hex(16) + # build_app() configures the settings object cached by get_settings(); start and leave with a fresh one. + get_settings.cache_clear() + try: + app = build_app( + authentication={"secret_keys": signing_keys, "single_user_api_key": api_key}, + server_settings={ + "server_configuration": {}, + "database": {"uri": f"postgresql://qserver:{password}@db.example/qserver"}, + }, + ) + with caplog.at_level(logging.INFO, logger="bluesky_httpserver"): + print_admin_api_key_if_generated(app, host="localhost", port=60610) + finally: + get_settings.cache_clear() + + for secret in [*signing_keys, api_key, password]: + assert secret not in caplog.text + # The rest of the settings, including where the database is, are still logged. + assert "db.example" in caplog.text