Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ trace, study, receipt, API and database schema versions.

### Added

- Project API keys can be listed and revoked. Admin routes
`GET /v1/api-keys?project_id=` and `DELETE /v1/api-keys/{prefix}?project_id=`,
`AgentLoopClient.list_api_keys` / `revoke_api_key`, and the CLI commands
`list-api-keys`, `revoke-api-key`, `remote-list-api-keys` and
`remote-revoke-api-key` show prefixes and usage times, never key values. A
revoked key is rejected immediately, and project-mode dashboard sessions
re-check their key every minute. Shared dashboards no longer offer the demo
generators that write files on the host.
- Shared dashboards can sign users in by project. With
`AGENTLOOP_DASHBOARD_REQUIRE_KEY=true`, the dashboard asks for a project API
key, verifies it like the HTTP API, and shows only that project; the project
Expand Down
57 changes: 57 additions & 0 deletions agentloop/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -988,6 +988,32 @@ def create_api_key(project_id: str = "default", name: str = "default") -> None:
console.print(key["api_key"])


@app.command("list-api-keys")
def list_api_keys(project_id: str = "default") -> None:
"""List a project's API key prefixes and last use; key values are never shown."""
console.print_json(
data={"project_id": project_id, "api_keys": get_store().list_api_keys(project_id)}
)


@app.command("revoke-api-key")
def revoke_api_key(
prefix: str = typer.Option(..., help="First 10 characters of the key, as listed."),
project_id: str = "default",
) -> None:
"""Revoke a project's API key; it stops working immediately."""
try:
revoked = get_store().revoke_api_key(project_id, prefix)
except ValueError as exc:
raise typer.BadParameter(str(exc)) from exc
if not revoked:
console.print(f"No API key with prefix {prefix} in project {project_id}.", markup=False)
raise typer.Exit(1)
console.print(
f"Revoked {revoked} API key(s) with prefix {prefix} in project {project_id}.", markup=False
)


@app.command("store-trace")
def store_trace(
path: Path = Path("runs/research_agent_baseline.json"),
Expand Down Expand Up @@ -1333,6 +1359,37 @@ def remote_create_api_key(
console.print(key["api_key"])


@app.command("remote-list-api-keys")
def remote_list_api_keys(
project_id: str = "default",
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:
"""List a project's API key prefixes on a remote server."""
client = _remote_admin_client(api_url, admin_api_key)
console.print_json(data=client.list_api_keys(project_id))


@app.command("remote-revoke-api-key")
def remote_revoke_api_key(
prefix: str = typer.Option(..., help="First 10 characters of the key, as listed."),
project_id: str = "default",
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:
"""Revoke a project's API key on a remote server."""
client = _remote_admin_client(api_url, admin_api_key)
result = client.revoke_api_key(project_id, prefix)
console.print(
f"Revoked {result['revoked']} API key(s) with prefix {prefix} in project {project_id}.",
markup=False,
)


@app.command()
def demo(
kind: str = typer.Option("baseline", help="baseline, optimized, langgraph, or proof"),
Expand Down
19 changes: 19 additions & 0 deletions agentloop/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,25 @@ def create_api_key(self, project_id: str = "default", name: str = "default") ->
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(
"GET",
"/api-keys?" + urllib.parse.urlencode({"project_id": project_id}),
credential_scope="admin",
)

def revoke_api_key(self, project_id: str, prefix: str) -> dict[str, Any]:
"""Revoke a project's key by its prefix (admin key required)."""
return self._request(
"DELETE",
"/api-keys/"
+ urllib.parse.quote(prefix, safe="")
+ "?"
+ urllib.parse.urlencode({"project_id": project_id}),
credential_scope="admin",
)

def upload_trace(self, trace: AgentTrace | str | Path | dict[str, Any]) -> dict[str, Any]:
if isinstance(trace, AgentTrace):
payload = trace.to_dict()
Expand Down
27 changes: 27 additions & 0 deletions agentloop/server.py
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,33 @@ def create_api_key(
return db.create_api_key(project_id=payload.project_id, name=payload.name)


@versioned.get("/api-keys")
def list_api_keys(
project_id: str = Query(min_length=1),
_: None = Depends(resolve_admin),
db: TraceStore = Depends(store),
) -> dict[str, Any]:
"""List a project's key prefixes and usage times; never the keys themselves."""
return {"project_id": project_id, "api_keys": db.list_api_keys(project_id)}


@versioned.delete("/api-keys/{prefix}")
def revoke_api_key(
prefix: str,
project_id: str = Query(min_length=1),
_: None = Depends(resolve_admin),
db: TraceStore = Depends(store),
) -> dict[str, Any]:
"""Revoke a project's key by its prefix; it stops working immediately."""
try:
revoked = db.revoke_api_key(project_id, prefix)
except ValueError as exc:
raise HTTPException(status_code=422, detail=str(exc)) from exc
if not revoked:
raise HTTPException(status_code=404, detail="no API key with that prefix in this project")
return {"project_id": project_id, "prefix": prefix, "revoked": revoked}


@versioned.post("/traces")
@legacy.post("/traces")
def ingest_trace(
Expand Down
79 changes: 79 additions & 0 deletions agentloop/store.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,10 @@ def create_api_key(self, project_id: str, name: str) -> 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 save_trace(self, trace: AgentTrace, project_id: str = "default") -> None: ...

def list_traces(self, project_id: str | None = None) -> list[dict[str, Any]]: ...
Expand Down Expand Up @@ -192,6 +196,19 @@ def _decode_hash_bytes(value: str) -> bytes:
return base64.b64decode(padded.encode("ascii"), altchars=b"-_", validate=True)


def _timestamp_text(value: Any) -> str | None:
if value is None:
return None
return value.isoformat() if hasattr(value, "isoformat") else str(value)


def _require_key_prefix(prefix: Any) -> None:
if not isinstance(prefix, str) or len(prefix) != _API_KEY_PREFIX_LENGTH:
raise ValueError(
f"API key prefix must be the first {_API_KEY_PREFIX_LENGTH} characters of the key"
)


def new_api_key() -> str:
return "al_" + secrets.token_urlsafe(32)

Expand Down Expand Up @@ -479,6 +496,37 @@ def verify_api_key(self, api_key: str) -> dict[str, Any] | None:
)
return {key: row[key] for key in ("project_id", "name", "prefix")}

def list_api_keys(self, project_id: str) -> list[dict[str, Any]]:
"""Key metadata for one project; key values and hashes are never returned."""
self.init()
with self._connect() as conn:
rows = conn.execute(
"SELECT prefix, name, created_at, last_used_at FROM api_keys "
"WHERE project_id = ? ORDER BY created_at, prefix",
(project_id,),
).fetchall()
return [
{
"project_id": project_id,
"prefix": row["prefix"],
"name": row["name"],
"created_at": _timestamp_text(row["created_at"]),
"last_used_at": _timestamp_text(row["last_used_at"]),
}
for row in rows
]

def revoke_api_key(self, project_id: str, prefix: str) -> int:
"""Delete a project's keys with this prefix; returns how many were revoked."""
_require_key_prefix(prefix)
self.init()
with self._connect() as conn:
cursor = conn.execute(
"DELETE FROM api_keys WHERE project_id = ? AND prefix = ?",
(project_id, prefix),
)
return int(cursor.rowcount or 0)

def _upsert_trace(
self, conn: sqlite3.Connection, trace: AgentTrace, project_id: str
) -> dict[str, Any]:
Expand Down Expand Up @@ -942,6 +990,37 @@ def verify_api_key(self, api_key: str) -> dict[str, Any] | None:
)
return {"project_id": row[1], "name": row[2], "prefix": row[3]}

def list_api_keys(self, project_id: str) -> list[dict[str, Any]]:
"""Key metadata for one project; key values and hashes are never returned."""
self.init()
with self._connect() as conn:
rows = conn.execute(
"SELECT prefix, name, created_at, last_used_at FROM api_keys "
"WHERE project_id = %s ORDER BY created_at, prefix",
(project_id,),
).fetchall()
return [
{
"project_id": project_id,
"prefix": row[0],
"name": row[1],
"created_at": _timestamp_text(row[2]),
"last_used_at": _timestamp_text(row[3]),
}
for row in rows
]

def revoke_api_key(self, project_id: str, prefix: str) -> int:
"""Delete a project's keys with this prefix; returns how many were revoked."""
_require_key_prefix(prefix)
self.init()
with self._connect() as conn:
cursor = conn.execute(
"DELETE FROM api_keys WHERE project_id = %s AND prefix = %s",
(project_id, prefix),
)
return int(cursor.rowcount or 0)

def _upsert_trace(self, conn, trace: AgentTrace, project_id: str) -> dict[str, Any]:
report = trace.report()
cost_status, priced_calls, unavailable_calls = _report_cost_completeness(report)
Expand Down
34 changes: 33 additions & 1 deletion dashboard/access.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
PROJECT_HIDDEN_PAGES = frozenset({"API Keys", "Patch Plan"})
MAX_FAILURES = 5
LOCKOUT_SECONDS = 60.0
# A revoked key stops working in open dashboard sessions within this time.
RECHECK_SECONDS = 60.0


def require_project_key() -> bool:
Expand Down Expand Up @@ -63,9 +65,39 @@ def sign_in(store, api_key: str, state, now: float | None = None) -> str | None:
state["signin_failures"] = 0
state["signed_in_project"] = str(record["project_id"])
state["signed_in_key_prefix"] = str(record.get("prefix") or "")
# Held only in this server-side session so the key can be re-verified.
state["signed_in_key"] = key
state["signed_in_checked_at"] = now
return state["signed_in_project"]


def session_valid(store, state, now: float | None = None) -> bool:
"""Re-verify a signed-in session's key at most every ``RECHECK_SECONDS``.

A key that was revoked, or that now belongs to another project, signs the
session out.
"""
now = time.monotonic() if now is None else now
project = state.get("signed_in_project")
key = state.get("signed_in_key")
if not project or not key:
sign_out(state)
return False
if now - float(state.get("signed_in_checked_at", float("-inf"))) < RECHECK_SECONDS:
return True
record = store.verify_api_key(key)
if record is None or str(record["project_id"]) != project:
sign_out(state)
return False
state["signed_in_checked_at"] = now
return True


def sign_out(state) -> None:
for name in ("signed_in_project", "signed_in_key_prefix"):
for name in (
"signed_in_project",
"signed_in_key_prefix",
"signed_in_key",
"signed_in_checked_at",
):
state.pop(name, None)
33 changes: 25 additions & 8 deletions dashboard/app.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,22 @@
from dashboard.access import (
lockout_remaining,
require_project_key,
session_valid,
sign_in,
sign_out,
visible_pages,
)
from dashboard.trace_upload import TraceUploadError, parse_uploaded_trace
from dashboard.value_view import assumption_inputs, percentage, render_value_report
except ModuleNotFoundError:
from access import lockout_remaining, require_project_key, sign_in, sign_out, visible_pages
from access import (
lockout_remaining,
require_project_key,
session_valid,
sign_in,
sign_out,
visible_pages,
)
from trace_upload import TraceUploadError, parse_uploaded_trace
from value_view import assumption_inputs, percentage, render_value_report

Expand Down Expand Up @@ -127,8 +135,14 @@ def render_gate_table(results: list[dict]) -> None:

if project_mode:
# A shared dashboard shows exactly one project: the one the API key belongs to.
if "signed_in_project" in st.session_state and not session_valid(store, st.session_state):
st.session_state["signin_notice"] = (
"Your project API key was revoked or is no longer valid. Sign in again."
)
if "signed_in_project" not in st.session_state:
st.title("AgentLoop Dashboard")
if notice := st.session_state.pop("signin_notice", None):
st.warning(notice)
st.subheader("Sign in to your project")
st.caption(
"Enter a project API key. The dashboard shows only the traces and findings "
Expand Down Expand Up @@ -880,16 +894,19 @@ def render_gate_table(results: list[dict]) -> None:
)

elif page == "Ingest":
st.subheader("Generate or upload traces")
col_a, col_b, col_c, col_d = st.columns(4)
# Demo generators write files into the dashboard host's shared runs directory,
# so a shared dashboard offers only uploads into the signed-in project.
st.subheader("Upload traces" if project_mode else "Generate or upload traces")
generated_path: Path | None = None
if col_a.button("Generate baseline"):
if not project_mode:
col_a, col_b, col_c, col_d = st.columns(4)
if not project_mode and col_a.button("Generate baseline"):
generated_path = run_baseline(runs_dir)
if col_b.button("Generate optimized"):
if not project_mode and col_b.button("Generate optimized"):
generated_path = run_optimized(runs_dir)
if col_c.button("Generate LangGraph-style"):
if not project_mode and col_c.button("Generate LangGraph-style"):
generated_path = run_langgraph_style(runs_dir)
if col_d.button("Generate all"):
if not project_mode and col_d.button("Generate all"):
proof_baseline, proof_candidate = run_proof_pair(runs_dir)
for path in [
run_baseline(runs_dir),
Expand All @@ -901,7 +918,7 @@ def render_gate_table(results: list[dict]) -> None:
store.save_trace(AgentTrace.from_json(path), project_id=project_id)
st.success(f"Generated and stored all demo traces under project `{project_id}`")

if st.button("Generate proof demo pair"):
if not project_mode and st.button("Generate proof demo pair"):
proof_baseline, proof_candidate = run_proof_pair(runs_dir)
for path in [proof_baseline, proof_candidate]:
store.save_trace(AgentTrace.from_json(path), project_id=project_id)
Expand Down
2 changes: 2 additions & 0 deletions docs/API_VERSIONING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ for larger reports. `timeout_s` controls the underlying socket timeout.
| Versioned route | Deprecated compatibility route |
| --- | --- |
| `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/POST /v1/traces` | `GET/POST /traces` |
| `GET /v1/traces/{run_id}/report` | `GET /traces/{run_id}/report` |
| `GET /v1/traces/{run_id}/optimization` | `GET /traces/{run_id}/optimize` |
Expand Down
Loading
Loading