diff --git a/CHANGELOG.md b/CHANGELOG.md index 8f6dcc5..cf27b05 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,14 @@ trace, study, receipt, API and database schema versions. ### Added +- An audit log of access and deletion actions. Migration 6 adds an + `audit_events` table recording API keys created and revoked, traces deleted + and retention purges, with the project, target, counts and acting identity + (admin API, project key prefix, CLI, dashboard or retention schedule), written + in the same transaction as the action. Admins read it with + `GET /v1/audit-events`, `AgentLoopClient.list_audit_events`, + `agentloop audit-log` or `agentloop remote-audit-log`. Key values are never + recorded. - Trace labels are visible and searchable. Paginated trace listings include each trace's `metadata.labels`, and `GET /v1/traces?label=KEY=VALUE`, `AgentLoopClient.list_traces(label=...)`, `agentloop list-stored-traces --label` diff --git a/agentloop/cli.py b/agentloop/cli.py index 362f638..fefbbeb 100644 --- a/agentloop/cli.py +++ b/agentloop/cli.py @@ -986,7 +986,7 @@ def init_store() -> None: @app.command("create-api-key") def create_api_key(project_id: str = "default", name: str = "default") -> None: db = get_store() - key = db.create_api_key(project_id=project_id, name=name) + key = db.create_api_key(project_id=project_id, name=name, actor="cli") console.print("Created API key. Save it now; it will not be shown again.") console.print(key["api_key"]) @@ -1006,7 +1006,7 @@ def revoke_api_key( ) -> None: """Revoke a project's API key; it stops working immediately.""" try: - revoked = get_store().revoke_api_key(project_id, prefix) + revoked = get_store().revoke_api_key(project_id, prefix, actor="cli") except ValueError as exc: raise typer.BadParameter(str(exc)) from exc if not revoked: @@ -1023,7 +1023,7 @@ def delete_trace( project_id: str = "default", ) -> None: """Delete a stored trace with its findings, usage and interventions.""" - deleted = get_store().delete_trace(run_id, project_id) + deleted = get_store().delete_trace(run_id, project_id, actor="cli") if deleted is None: console.print(f"No trace {run_id} in project {project_id}.", markup=False) raise typer.Exit(1) @@ -1041,6 +1041,7 @@ def purge_traces( project_id: str | None = typer.Option(None, help="Only purge this project."), ) -> None: """Apply a retention period: delete traces stored longer ago than allowed.""" + actor = "cli" if older_than_days is not None else "retention:AGENTLOOP_RETENTION_DAYS" if older_than_days is None: configured = os.getenv("AGENTLOOP_RETENTION_DAYS", "").strip() if not configured: @@ -1057,7 +1058,7 @@ def purge_traces( param_hint="AGENTLOOP_RETENTION_DAYS", ) from None try: - deleted = get_store().purge_traces(older_than_days, project_id=project_id) + deleted = get_store().purge_traces(older_than_days, project_id=project_id, actor=actor) except ValueError as exc: raise typer.BadParameter(str(exc)) from exc scope = f"project {project_id}" if project_id else "all projects" @@ -1070,6 +1071,20 @@ def purge_traces( ) +@app.command("audit-log") +def audit_log( + project_id: str | None = typer.Option(None, help="Only this project's events."), + limit: int = typer.Option(50, min=1, max=1000, help="Newest events to show."), +) -> None: + """Show recent key, deletion and retention events from the store's audit log.""" + console.print_json( + data={ + "project_id": project_id, + "events": get_store().list_audit_events(project_id, limit=limit), + } + ) + + @app.command("store-trace") def store_trace( path: Path = Path("runs/research_agent_baseline.json"), @@ -1515,6 +1530,20 @@ def remote_list_api_keys( console.print_json(data=client.list_api_keys(project_id)) +@app.command("remote-audit-log") +def remote_audit_log( + project_id: str | None = typer.Option(None, help="Only this project's events."), + limit: int = typer.Option(50, min=1, max=1000, help="Newest events to show."), + api_url: str = typer.Option("http://127.0.0.1:8000", help="AgentLoop API base URL."), + admin_api_key: str | None = typer.Option( + None, help="Admin API key. Defaults to AGENTLOOP_ADMIN_API_KEY." + ), +) -> None: + """Show a remote server's audit log (admin key required).""" + client = _remote_admin_client(api_url, admin_api_key) + console.print_json(data=client.list_audit_events(project_id=project_id, limit=limit)) + + @app.command("remote-revoke-api-key") def remote_revoke_api_key( prefix: str = typer.Option(..., help="First 10 characters of the key, as listed."), diff --git a/agentloop/client.py b/agentloop/client.py index 5c2098b..3664c99 100644 --- a/agentloop/client.py +++ b/agentloop/client.py @@ -59,6 +59,15 @@ def create_api_key(self, project_id: str = "default", name: str = "default") -> credential_scope="admin", ) + def list_audit_events(self, project_id: str | None = None, limit: int = 100) -> dict[str, Any]: + """Newest audit events first, optionally for one project (admin key required).""" + params: dict[str, Any] = {"limit": limit} + if project_id: + params["project_id"] = project_id + return self._request( + "GET", "/audit-events?" + urllib.parse.urlencode(params), credential_scope="admin" + ) + def list_api_keys(self, project_id: str) -> dict[str, Any]: """List a project's key prefixes, names and usage times (admin key required).""" return self._request( diff --git a/agentloop/migrations.py b/agentloop/migrations.py index 89ad8f1..2f8c22b 100644 --- a/agentloop/migrations.py +++ b/agentloop/migrations.py @@ -219,6 +219,25 @@ class Migration: "PRIMARY KEY(project_id, intervention_id))", ), ), + Migration( + version=6, + name="audit_log", + sqlite_statements=( + "CREATE TABLE IF NOT EXISTS audit_events (" + "id INTEGER PRIMARY KEY AUTOINCREMENT, " + "occurred_at TEXT DEFAULT CURRENT_TIMESTAMP, project_id TEXT, " + "action TEXT NOT NULL, actor TEXT NOT NULL, target TEXT, " + "details_json TEXT NOT NULL DEFAULT '{}')", + "CREATE INDEX IF NOT EXISTS audit_events_project_id ON audit_events(project_id, id)", + ), + postgres_statements=( + "CREATE TABLE IF NOT EXISTS audit_events (" + "id BIGSERIAL PRIMARY KEY, occurred_at TIMESTAMPTZ DEFAULT now(), project_id TEXT, " + "action TEXT NOT NULL, actor TEXT NOT NULL, target TEXT, " + "details_json TEXT NOT NULL DEFAULT '{}')", + "CREATE INDEX IF NOT EXISTS audit_events_project_id ON audit_events(project_id, id)", + ), + ), ) diff --git a/agentloop/server.py b/agentloop/server.py index 9fa5caa..2d85582 100644 --- a/agentloop/server.py +++ b/agentloop/server.py @@ -176,7 +176,18 @@ def create_api_key( _: None = Depends(resolve_admin), db: TraceStore = Depends(store), ) -> dict[str, Any]: - return db.create_api_key(project_id=payload.project_id, name=payload.name) + return db.create_api_key(project_id=payload.project_id, name=payload.name, actor="admin-api") + + +@versioned.get("/audit-events") +def list_audit_events( + project_id: str | None = Query(default=None, min_length=1), + limit: int = Query(default=100, ge=1, le=MAX_PAGE_SIZE), + _: None = Depends(resolve_admin), + db: TraceStore = Depends(store), +) -> dict[str, Any]: + """Newest audit events first: key creation and revocation, deletions and purges.""" + return {"project_id": project_id, "events": db.list_audit_events(project_id, limit=limit)} @versioned.get("/api-keys") @@ -198,7 +209,7 @@ def revoke_api_key( ) -> dict[str, Any]: """Revoke a project's key by its prefix; it stops working immediately.""" try: - revoked = db.revoke_api_key(project_id, prefix) + revoked = db.revoke_api_key(project_id, prefix, actor="admin-api") except ValueError as exc: raise HTTPException(status_code=422, detail=str(exc)) from exc if not revoked: @@ -302,9 +313,11 @@ def delete_trace( run_id: str, project_id: str = Depends(resolve_project), db: TraceStore = Depends(store), + x_agentloop_key: str | None = Header(default=None), ) -> dict[str, Any]: """Delete a trace of the caller's project with its findings, usage and interventions.""" - deleted = db.delete_trace(run_id, project_id) + actor = f"api-key:{x_agentloop_key[:10]}" if x_agentloop_key else "api" + deleted = db.delete_trace(run_id, project_id, actor=actor) if deleted is None: raise HTTPException(status_code=404, detail="trace not found") return {"run_id": run_id, "project_id": project_id, "deleted": deleted} diff --git a/agentloop/store.py b/agentloop/store.py index 0682d2f..5434809 100644 --- a/agentloop/store.py +++ b/agentloop/store.py @@ -103,13 +103,19 @@ def get_intervention( self, intervention_id: str, project_id: str = "default" ) -> dict[str, Any] | None: ... - def create_api_key(self, project_id: str, name: str) -> dict[str, Any]: ... + def create_api_key( + self, project_id: str, name: str, actor: str = "local" + ) -> dict[str, Any]: ... def verify_api_key(self, api_key: str) -> dict[str, Any] | None: ... def list_api_keys(self, project_id: str) -> list[dict[str, Any]]: ... - def revoke_api_key(self, project_id: str, prefix: str) -> int: ... + def revoke_api_key(self, project_id: str, prefix: str, actor: str = "local") -> int: ... + + def list_audit_events( + self, project_id: str | None = None, limit: int = 100 + ) -> list[dict[str, Any]]: ... def save_trace(self, trace: AgentTrace, project_id: str = "default") -> None: ... @@ -125,10 +131,12 @@ def list_traces_page( def get_trace(self, run_id: str, project_id: str | None = None) -> AgentTrace | None: ... - def delete_trace(self, run_id: str, project_id: str) -> dict[str, int] | None: ... + def delete_trace( + self, run_id: str, project_id: str, actor: str = "local" + ) -> dict[str, int] | None: ... def purge_traces( - self, older_than_days: float, project_id: str | None = None + self, older_than_days: float, project_id: str | None = None, actor: str = "local" ) -> dict[str, int]: ... def save_diagnosis(self, diagnosis: dict[str, Any], project_id: str = "default") -> None: ... @@ -301,6 +309,40 @@ def _with_labels(item: dict[str, Any]) -> dict[str, Any]: return item +def _record_audit( + conn, mark: str, action: str, project_id: str | None, actor: str, target: str | None, details +) -> None: + """Append an audit event in the caller's transaction.""" + conn.execute( + "INSERT INTO audit_events(project_id, action, actor, target, details_json) " # nosec B608 + f"VALUES ({mark}, {mark}, {mark}, {mark}, {mark})", + ( + project_id, + action, + str(actor or "unknown")[:200], + target, + json.dumps(details or {}, sort_keys=True), + ), + ) + + +def _audit_row(row: tuple[Any, ...]) -> dict[str, Any]: + event_id, occurred_at, project_id, action, actor, target, details_json = row + try: + details = json.loads(details_json) if details_json else {} + except ValueError: + details = {} + return { + "id": int(event_id), + "occurred_at": _timestamp_text(occurred_at), + "project_id": project_id, + "action": action, + "actor": actor, + "target": target, + "details": details, + } + + def _timestamp_text(value: Any) -> str | None: if value is None: return None @@ -565,7 +607,7 @@ def init(self) -> None: with self._connect() as conn: apply_sqlite_migrations(conn) - def create_api_key(self, project_id: str, name: str) -> dict[str, Any]: + def create_api_key(self, project_id: str, name: str, actor: str = "local") -> dict[str, Any]: self.init() api_key = new_api_key() prefix = api_key[:_API_KEY_PREFIX_LENGTH] @@ -575,6 +617,7 @@ def create_api_key(self, project_id: str, name: str) -> dict[str, Any]: "INSERT INTO api_keys(key_hash, project_id, name, prefix) VALUES (?, ?, ?, ?)", (hash_api_key(api_key), project_id, name, prefix), ) + _record_audit(conn, "?", "api_key.created", project_id, actor, prefix, {"name": name}) return {"api_key": api_key, "project_id": project_id, "name": name, "prefix": prefix} def verify_api_key(self, api_key: str) -> dict[str, Any] | None: @@ -621,7 +664,22 @@ def list_api_keys(self, project_id: str) -> list[dict[str, Any]]: for row in rows ] - def revoke_api_key(self, project_id: str, prefix: str) -> int: + def list_audit_events( + self, project_id: str | None = None, limit: int = 100 + ) -> list[dict[str, Any]]: + """Newest audit events first, optionally for one project.""" + limit = _validate_page_limit(limit) + self.init() + with self._connect() as conn: + rows = conn.execute( + "SELECT id, occurred_at, project_id, action, actor, target, details_json " + "FROM audit_events WHERE (? IS NULL OR project_id = ?) " + "ORDER BY id DESC LIMIT ?", + (project_id, project_id, limit), + ).fetchall() + return [_audit_row(tuple(row)) for row in rows] + + def revoke_api_key(self, project_id: str, prefix: str, actor: str = "local") -> int: """Delete a project's keys with this prefix; returns how many were revoked.""" _require_key_prefix(prefix) self.init() @@ -630,9 +688,16 @@ def revoke_api_key(self, project_id: str, prefix: str) -> int: "DELETE FROM api_keys WHERE project_id = ? AND prefix = ?", (project_id, prefix), ) - return int(cursor.rowcount or 0) - - def delete_trace(self, run_id: str, project_id: str) -> dict[str, int] | None: + revoked = int(cursor.rowcount or 0) + if revoked: + _record_audit( + conn, "?", "api_key.revoked", project_id, actor, prefix, {"revoked": revoked} + ) + return revoked + + def delete_trace( + self, run_id: str, project_id: str, actor: str = "local" + ) -> dict[str, int] | None: """Delete one trace of a project and its findings, usage and interventions.""" self.init() with self._connect() as conn: @@ -641,9 +706,13 @@ def delete_trace(self, run_id: str, project_id: str) -> dict[str, int] | None: ).fetchone() if exists is None: return None - return _delete_runs(conn, "?", project_id, [run_id]) + deleted = _delete_runs(conn, "?", project_id, [run_id]) + _record_audit(conn, "?", "trace.deleted", project_id, actor, run_id, deleted) + return deleted - def purge_traces(self, older_than_days: float, project_id: str | None = None) -> dict[str, int]: + def purge_traces( + self, older_than_days: float, project_id: str | None = None, actor: str = "local" + ) -> dict[str, int]: """Delete traces stored more than ``older_than_days`` ago, optionally in one project.""" cutoff = _retention_cutoff(older_than_days).strftime("%Y-%m-%d %H:%M:%S") self.init() @@ -658,8 +727,18 @@ def purge_traces(self, older_than_days: float, project_id: str | None = None) -> for row in conn.execute(query, params).fetchall(): by_project.setdefault(row["project_id"], []).append(row["run_id"]) for project, run_ids in by_project.items(): - for name, count in _delete_runs(conn, "?", project, run_ids).items(): + deleted = _delete_runs(conn, "?", project, run_ids) + for name, count in deleted.items(): totals[name] += count + _record_audit( + conn, + "?", + "traces.purged", + project, + actor, + None, + {**deleted, "older_than_days": float(older_than_days)}, + ) return totals def _upsert_trace( @@ -1105,7 +1184,7 @@ def init(self) -> None: with self._connect() as conn: apply_postgres_migrations(conn) - def create_api_key(self, project_id: str, name: str) -> dict[str, Any]: + def create_api_key(self, project_id: str, name: str, actor: str = "local") -> dict[str, Any]: self.init() api_key = new_api_key() prefix = api_key[:_API_KEY_PREFIX_LENGTH] @@ -1117,6 +1196,7 @@ def create_api_key(self, project_id: str, name: str) -> dict[str, Any]: "INSERT INTO api_keys(key_hash, project_id, name, prefix) VALUES (%s, %s, %s, %s)", (hash_api_key(api_key), project_id, name, prefix), ) + _record_audit(conn, "%s", "api_key.created", project_id, actor, prefix, {"name": name}) return {"api_key": api_key, "project_id": project_id, "name": name, "prefix": prefix} def verify_api_key(self, api_key: str) -> dict[str, Any] | None: @@ -1159,7 +1239,22 @@ def list_api_keys(self, project_id: str) -> list[dict[str, Any]]: for row in rows ] - def revoke_api_key(self, project_id: str, prefix: str) -> int: + def list_audit_events( + self, project_id: str | None = None, limit: int = 100 + ) -> list[dict[str, Any]]: + """Newest audit events first, optionally for one project.""" + limit = _validate_page_limit(limit) + self.init() + with self._connect() as conn: + rows = conn.execute( + "SELECT id, occurred_at, project_id, action, actor, target, details_json " + "FROM audit_events WHERE (%s::text IS NULL OR project_id = %s) " + "ORDER BY id DESC LIMIT %s", + (project_id, project_id, limit), + ).fetchall() + return [_audit_row(tuple(row)) for row in rows] + + def revoke_api_key(self, project_id: str, prefix: str, actor: str = "local") -> int: """Delete a project's keys with this prefix; returns how many were revoked.""" _require_key_prefix(prefix) self.init() @@ -1168,9 +1263,16 @@ def revoke_api_key(self, project_id: str, prefix: str) -> int: "DELETE FROM api_keys WHERE project_id = %s AND prefix = %s", (project_id, prefix), ) - return int(cursor.rowcount or 0) - - def delete_trace(self, run_id: str, project_id: str) -> dict[str, int] | None: + revoked = int(cursor.rowcount or 0) + if revoked: + _record_audit( + conn, "%s", "api_key.revoked", project_id, actor, prefix, {"revoked": revoked} + ) + return revoked + + def delete_trace( + self, run_id: str, project_id: str, actor: str = "local" + ) -> dict[str, int] | None: """Delete one trace of a project and its findings, usage and interventions.""" self.init() with self._connect() as conn: @@ -1179,9 +1281,13 @@ def delete_trace(self, run_id: str, project_id: str) -> dict[str, int] | None: ).fetchone() if exists is None: return None - return _delete_runs(conn, "%s", project_id, [run_id]) + deleted = _delete_runs(conn, "%s", project_id, [run_id]) + _record_audit(conn, "%s", "trace.deleted", project_id, actor, run_id, deleted) + return deleted - def purge_traces(self, older_than_days: float, project_id: str | None = None) -> dict[str, int]: + def purge_traces( + self, older_than_days: float, project_id: str | None = None, actor: str = "local" + ) -> dict[str, int]: """Delete traces stored more than ``older_than_days`` ago, optionally in one project.""" cutoff = _retention_cutoff(older_than_days) self.init() @@ -1196,8 +1302,18 @@ def purge_traces(self, older_than_days: float, project_id: str | None = None) -> for row in conn.execute(query, params).fetchall(): by_project.setdefault(row[0], []).append(row[1]) for project, run_ids in by_project.items(): - for name, count in _delete_runs(conn, "%s", project, run_ids).items(): + deleted = _delete_runs(conn, "%s", project, run_ids) + for name, count in deleted.items(): totals[name] += count + _record_audit( + conn, + "%s", + "traces.purged", + project, + actor, + None, + {**deleted, "older_than_days": float(older_than_days)}, + ) return totals def _upsert_trace(self, conn, trace: AgentTrace, project_id: str) -> dict[str, Any]: diff --git a/dashboard/app.py b/dashboard/app.py index 91754ca..4c3ff3f 100644 --- a/dashboard/app.py +++ b/dashboard/app.py @@ -172,6 +172,13 @@ def render_gate_table(results: list[dict]) -> None: ) st.session_state["project_id"] = project_id +# Recorded in the store's audit log for keys created and traces deleted here. +dashboard_actor = ( + f"dashboard:api-key:{st.session_state.get('signed_in_key_prefix', '')}" + if project_mode + else "dashboard" +) + page = st.sidebar.radio( "Navigate", visible_pages( @@ -372,7 +379,7 @@ def render_gate_table(results: list[dict]) -> None: f"I want to delete {trace.run_id}", key=f"confirm_delete::{trace.run_id}" ) if st.button("Delete trace", disabled=not confirmed, type="primary"): - deleted = store.delete_trace(trace.run_id, project_id) + deleted = store.delete_trace(trace.run_id, project_id, actor=dashboard_actor) st.session_state[cursor_key] = [None] st.session_state["trace_deleted_notice"] = ( f"Deleted {trace.run_id} and {deleted['findings']} findings, " @@ -930,7 +937,7 @@ def render_gate_table(results: list[dict]) -> None: st.warning("API keys are only shown once. Copy the generated key before leaving this page.") key_name = st.text_input("Key name", value="local-dev") if st.button("Create API key"): - created = store.create_api_key(project_id=project_id, name=key_name) + created = store.create_api_key(project_id=project_id, name=key_name, actor=dashboard_actor) st.success(f"Created key for project `{project_id}`") st.code(created["api_key"]) diff --git a/docs/API_VERSIONING.md b/docs/API_VERSIONING.md index 3e4447c..d7b8740 100644 --- a/docs/API_VERSIONING.md +++ b/docs/API_VERSIONING.md @@ -33,6 +33,7 @@ for larger reports. `timeout_s` controls the underlying socket timeout. | `POST /v1/api-keys` | `POST /api-keys` | | `GET /v1/api-keys?project_id=...` | None (0.2.7 and newer) | | `DELETE /v1/api-keys/{prefix}?project_id=...` | None (0.2.7 and newer) | +| `GET /v1/audit-events?project_id=...&limit=...` | None (0.2.8 and newer) | | `GET/POST /v1/traces` (`?label=KEY=VALUE` from 0.2.8) | `GET/POST /traces` | | `DELETE /v1/traces/{run_id}` | None (0.2.7 and newer) | | `GET /v1/traces/{run_id}/report` | `GET /traces/{run_id}/report` | diff --git a/docs/CLOUD_DEPLOY.md b/docs/CLOUD_DEPLOY.md index b511b22..c3d7ec4 100644 --- a/docs/CLOUD_DEPLOY.md +++ b/docs/CLOUD_DEPLOY.md @@ -116,6 +116,15 @@ To send traces from CI automatically, see Sign in to the dashboard with the same key to see that project's traces. Each team can only see its own project; there is no project switcher. +### Review the audit log + +The server records key creation and revocation, trace deletions and retention +purges, with who acted. Review it with the admin key: + +```bash +agentloop remote-audit-log --api-url https://agentloop-api.example.com +``` + ### Revoke a key If a key leaks or a pipeline is retired, list the project's keys and revoke the diff --git a/docs/PRODUCTION.md b/docs/PRODUCTION.md index 8d0be47..97bf85d 100644 --- a/docs/PRODUCTION.md +++ b/docs/PRODUCTION.md @@ -268,6 +268,33 @@ configured. From 0.2.7 it also publishes the container image to before ingesting production or customer data, and enforce it with the deletion and retention tools below. +## Audit log + +From 0.2.8 the store keeps an append-only audit log of actions that change who +can access data or remove it: API keys created and revoked, traces deleted, and +retention purges that removed traces. Each event records when it happened, the +project, the action, what it acted on (a key prefix or run ID), counts, and who +acted: + +| Actor | Meaning | +| --- | --- | +| `admin-api` | The admin key, through `/v1/api-keys` | +| `api-key:` | A project key, for example deleting a trace through the API | +| `cli` | A command run directly against the store | +| `retention:AGENTLOOP_RETENTION_DAYS` | A scheduled purge, such as the cloud stack's retention service | +| `dashboard`, `dashboard:api-key:` | The dashboard, locally or signed in with a project key | + +Key values are never recorded. Read the newest events with the admin key: + +```bash +uv run agentloop remote-audit-log --project-id acme --api-url https://agentloop-api.example.com +``` + +`GET /v1/audit-events?project_id=...&limit=...` and +`AgentLoopClient.list_audit_events` return the same events; with direct database +access, use `agentloop audit-log`. Events are kept until removed from the +database by hand. + ## Deleting traces and retention From 0.2.7, a stored trace can be deleted together with its findings, usage diff --git a/tests/test_cli_store_commands.py b/tests/test_cli_store_commands.py index 5dc7e03..fe69f61 100644 --- a/tests/test_cli_store_commands.py +++ b/tests/test_cli_store_commands.py @@ -174,3 +174,13 @@ def test_list_stored_traces_filters_by_label(tmp_path, monkeypatch) -> None: assert "commit=abc" in result.output bad = runner.invoke(app, ["list-stored-traces", "--label", "no-equals"]) assert bad.exit_code == 2 + + +def test_audit_log_command_shows_cli_actions(tmp_path, monkeypatch) -> None: + db_path = tmp_path / "audit.db" + monkeypatch.setenv("AGENTLOOP_STORE_BACKEND", "sqlite") + monkeypatch.setenv("AGENTLOOP_SQLITE_PATH", str(db_path)) + assert runner.invoke(app, ["create-api-key", "--project-id", "acme"]).exit_code == 0 + result = runner.invoke(app, ["audit-log", "--project-id", "acme"]) + assert result.exit_code == 0, result.output + assert '"api_key.created"' in result.output and '"cli"' in result.output diff --git a/tests/test_client.py b/tests/test_client.py index ca46bbf..1cf5f3c 100644 --- a/tests/test_client.py +++ b/tests/test_client.py @@ -297,3 +297,29 @@ def fake_urlopen(request, timeout): # type: ignore[no-untyped-def] assert (method, url) == ("DELETE", "https://agentloop.example/v1/traces/run%2F1") assert headers["x-agentloop-key"] == "project" assert "x-agentloop-admin-key" not in headers + + +def test_client_reads_the_audit_log_with_only_the_admin_key(monkeypatch) -> None: + captured: list[tuple[str, dict[str, str]]] = [] + + class Response: + def __enter__(self): + return self + + def __exit__(self, *args): # type: ignore[no-untyped-def] + return None + + def read(self, size=-1) -> bytes: + return b"{}" + + def fake_urlopen(request, timeout): # type: ignore[no-untyped-def] + headers = {name.lower(): value for name, value in request.header_items()} + captured.append((request.full_url, headers)) + return Response() + + monkeypatch.setattr("agentloop.client._open_request", fake_urlopen) + client = AgentLoopClient(base_url="https://a.example", api_key="project", admin_api_key="admin") + client.list_audit_events(project_id="team a", limit=5) + url, headers = captured[0] + assert url == "https://a.example/v1/audit-events?limit=5&project_id=team+a" + assert headers["x-agentloop-admin-key"] == "admin" and "x-agentloop-key" not in headers diff --git a/tests/test_finding_identity.py b/tests/test_finding_identity.py index aa5e88d..b389484 100644 --- a/tests/test_finding_identity.py +++ b/tests/test_finding_identity.py @@ -93,7 +93,8 @@ def _postgres_store() -> PostgresTraceStore | None: store.init() with store._connect() as conn: conn.execute( - "TRUNCATE trace_findings, usage_events, traces, api_keys, projects RESTART IDENTITY CASCADE" + "TRUNCATE audit_events, trace_findings, usage_events, traces, api_keys, projects " + "RESTART IDENTITY CASCADE" ) conn.execute("INSERT INTO projects(project_id) VALUES ('default')") return store diff --git a/tests/test_migrations.py b/tests/test_migrations.py index 9cb4513..09f0348 100644 --- a/tests/test_migrations.py +++ b/tests/test_migrations.py @@ -62,7 +62,7 @@ def test_sqlite_fresh_install_and_upgraded_database_reach_equivalent_schema(tmp_ "SELECT cost_status, priced_model_call_count, unavailable_model_call_count " "FROM usage_events WHERE run_id = 'legacy'" ).fetchone() - assert versions == {1, 2, 3, 4, 5} + assert versions == {1, 2, 3, 4, 5, 6} assert trace_cost == ("complete", 2, 0) assert usage_cost == ("complete", 2, 0) @@ -162,7 +162,7 @@ def _signature(schema: str) -> tuple[set[str], set[str], set[tuple[str, str]]]: "SELECT cost_status, priced_model_call_count, unavailable_model_call_count " "FROM usage_events WHERE run_id = 'legacy'" ).fetchone() - assert versions == {1, 2, 3, 4, 5} + assert versions == {1, 2, 3, 4, 5, 6} assert trace_cost == ("complete", 2, 0) assert usage_cost == ("complete", 2, 0) finally: diff --git a/tests/test_server.py b/tests/test_server.py index ac6f022..1fb4373 100644 --- a/tests/test_server.py +++ b/tests/test_server.py @@ -672,3 +672,28 @@ def test_traces_can_be_filtered_by_label(monkeypatch, tmp_path) -> None: assert filtered["traces"][0]["labels"] == {"commit": "abc"} assert client.get("/v1/traces", params={"label": "commit"}).status_code == 422 assert len(client.get("/v1/traces").json()["traces"]) == 2 + + +def test_admin_reads_the_audit_log_and_project_keys_cannot(monkeypatch, tmp_path) -> None: + monkeypatch.setenv("AGENTLOOP_STORE_BACKEND", "sqlite") + monkeypatch.setenv("AGENTLOOP_SQLITE_PATH", str(tmp_path / "audit.db")) + monkeypatch.setenv("AGENTLOOP_REQUIRE_API_KEY", "true") + monkeypatch.setenv("AGENTLOOP_ADMIN_API_KEY", "admin-secret") + client = TestClient(app) + admin = {"X-AgentLoop-Admin-Key": "admin-secret"} + key = client.post( + "/v1/api-keys", json={"project_id": "acme", "name": "ci"}, headers=admin + ).json() + project = {"X-AgentLoop-Key": key["api_key"]} + trace = {"name": "t", "run_id": "run-audit", "metadata": {}, "events": []} + client.post("/v1/traces", json=trace, headers=project) + client.delete("/v1/traces/run-audit", headers=project) + + assert client.get("/v1/audit-events", headers=project).status_code == 401 + events = client.get("/v1/audit-events", params={"project_id": "acme"}, headers=admin).json() + actions = [(event["action"], event["actor"]) for event in events["events"]] + assert actions == [ + ("trace.deleted", f"api-key:{key['api_key'][:10]}"), + ("api_key.created", "admin-api"), + ] + assert key["api_key"] not in str(events) diff --git a/tests/test_store_contract.py b/tests/test_store_contract.py index 7a2e346..7ada5e8 100644 --- a/tests/test_store_contract.py +++ b/tests/test_store_contract.py @@ -48,7 +48,8 @@ def _reset_postgres_tables(store: PostgresTraceStore) -> None: store.init() with store._connect() as conn: conn.execute( - "TRUNCATE trace_findings, usage_events, traces, api_keys, projects RESTART IDENTITY CASCADE" + "TRUNCATE audit_events, trace_findings, usage_events, traces, api_keys, projects " + "RESTART IDENTITY CASCADE" ) conn.execute("INSERT INTO projects(project_id) VALUES ('default')") @@ -1044,3 +1045,39 @@ def labelled(name, **labels): parse_label_filter(bad) with pytest.raises(ValueError, match="KEY=VALUE"): store.list_traces_page(label=("bad key", "x")) + + +def test_audit_log_records_key_and_deletion_actions_without_secrets(store): + key = store.create_api_key(project_id="proj_a", name="ci", actor="admin-api") + store.create_api_key(project_id="proj_b", name="other", actor="cli") + trace = _sample_trace("audited") + store.save_trace(trace, project_id="proj_a") + store.delete_trace(trace.run_id, "proj_a", actor="api-key:al_abc1234") + old = _sample_trace("old") + store.save_trace(old, project_id="proj_a") + _age(store, old.run_id, 40) + store.purge_traces(30, actor="retention:AGENTLOOP_RETENTION_DAYS") + store.purge_traces(30, actor="retention:AGENTLOOP_RETENTION_DAYS") # nothing left: no event + store.revoke_api_key("proj_a", key["prefix"], actor="admin-api") + store.revoke_api_key("proj_a", key["prefix"], actor="admin-api") # nothing revoked: no event + + events = store.list_audit_events("proj_a") + assert [event["action"] for event in events] == [ + "api_key.revoked", + "traces.purged", + "trace.deleted", + "api_key.created", + ] + revoked, purged, deleted, created = events + assert created["target"] == key["prefix"] and created["details"] == {"name": "ci"} + assert created["actor"] == "admin-api" + assert deleted["target"] == trace.run_id and deleted["details"]["traces"] == 1 + assert deleted["actor"] == "api-key:al_abc1234" + assert purged["details"]["traces"] == 1 and purged["details"]["older_than_days"] == 30.0 + assert revoked["details"] == {"revoked": 1} + assert all(event["occurred_at"] for event in events) + assert key["api_key"] not in str(store.list_audit_events()) + + assert [event["project_id"] for event in store.list_audit_events("proj_b")] == ["proj_b"] + assert len(store.list_audit_events()) == 5 + assert len(store.list_audit_events(limit=2)) == 2