Files
mtusi2026lab7/tests/telemetry_redaction.py
T
2026-11-04 19:22:35 +03:00

117 lines
4.3 KiB
Python

#!/usr/bin/env python3
"""Verify synthetic credentials and message bodies are absent from Loki logs and Tempo spans."""
import base64
import json
from pathlib import Path
import re
import subprocess
import time
import uuid
from client import Client, arguments, check, run
ROOT = Path(__file__).resolve().parents[1]
TELEMETRY_PROBE = r"""
import json, ssl, sys, time, urllib.parse, urllib.request
probe = json.load(sys.stdin)
context = ssl.create_default_context(cafile="/run/secrets/ca_crt")
def request(url):
with urllib.request.urlopen(url, context=context, timeout=8) as response:
return json.load(response)
log_query = '{service_name="messenger-api"}'
deadline = time.monotonic() + 30
trace_ids = []
log_entries = []
while time.monotonic() < deadline:
params = urllib.parse.urlencode({"query": log_query, "start": probe["start_ns"], "end": str(time.time_ns()), "limit": "1000"})
logs = request("https://loki:3100/loki/api/v1/query_range?" + params)
log_entries = [
{"labels": stream.get("stream", {}), "line": line}
for stream in logs.get("data", {}).get("result", [])
for _, line in stream.get("values", [])
]
search = urllib.parse.urlencode({"limit": "1000", "start": probe["start"], "end": str(int(time.time())), "tags": "service.name=messenger-api"})
found = request("https://tempo:3200/api/search?" + search)
trace_ids = [item["traceID"] for item in found.get("traces", []) if item.get("rootTraceName") == "POST /api/v1/chats/{chat_id}/messages"]
if trace_ids and log_entries:
break
time.sleep(1)
if not trace_ids:
raise RuntimeError("no API message trace appeared in Tempo within the deadline")
payloads = [json.dumps(log_entries, ensure_ascii=False)]
for trace_id in trace_ids:
payloads.append(json.dumps(request("https://tempo:3200/api/traces/" + trace_id), ensure_ascii=False))
leaked = [value for value in probe["values"] if any(value in payload for payload in payloads)]
print(json.dumps({"trace_count": len(trace_ids), "log_entries": len(log_entries), "leak_count": len(leaked)}))
"""
def main() -> None:
args = arguments("Verify request secrets and message bodies are excluded from telemetry")
client = Client(args.base_url, args.ca_file)
alice, bob, _, chat = client.bootstrap()
canary = "telemetry-canary-" + uuid.uuid4().hex
username = "u_probe_" + uuid.uuid4().hex[:12]
password = "Password-" + uuid.uuid4().hex
start_time = time.time()
user = client.call(
"POST",
"/api/v1/users",
201,
body={"username": username, "display_name": canary, "password": password},
schema="User",
)["json"]
auth_value = base64.b64encode(f"{username}:{password}".encode()).decode("ascii")
session = client.call(
"POST",
"/api/v1/auth/sessions",
201,
headers={"Authorization": "Basic " + auth_value},
schema="Session",
)["json"]
check(session["user"]["id"] == user["id"], "telemetry probe user session did not authenticate")
client.call(
"GET",
"/api/v1/users/me",
401,
headers={"Authorization": "Bearer " + canary},
)
client.message(alice, chat, canary)
values = [canary, username, password, auth_value, session["token"], alice["token"]]
probe = {
"values": values,
"start": str(max(0, int(start_time) - 5)),
"start_ns": str(max(0, int(start_time - 5) * 1_000_000_000)),
}
result = subprocess.run(
[
"docker", "compose", "exec", "-T", "api",
"python3", "-c", TELEMETRY_PROBE,
],
cwd=ROOT,
input=json.dumps(probe),
text=True,
capture_output=True,
check=True,
)
telemetry = json.loads(result.stdout)
check(telemetry["trace_count"] > 0, "no API traces were scanned")
check(telemetry["leak_count"] == 0, "synthetic credentials or message content appeared in telemetry")
print(
json.dumps(
{
"result": "PASS",
"synthetic_values_checked": len(values),
"api_traces_scanned": telemetry["trace_count"],
"log_entries_scanned": telemetry["log_entries"],
"leaks": 0,
},
sort_keys=True,
)
)
if __name__ == "__main__":
run(main)