org-knowledge-layer 0.3.0__tar.gz → 0.3.1__tar.gz

{org_knowledge_layer-0.3.0 → org_knowledge_layer-0.3.1}/.claude/settings.local.json

@@ -155,7 +155,22 @@
       "Bash(pkill -f uvicorn)",
       "Bash(pg_ctl -D /tmp/oklpg/data stop -m immediate)",
       "Bash(tmutil listlocalsnapshots *)",
-      "Bash(python3 -c \"import json,sys; print\\(', '.join\\(sorted\\(json.load\\(sys.stdin\\)['releases']\\)\\)\\)\")"
+      "Bash(python3 -c \"import json,sys; print\\(', '.join\\(sorted\\(json.load\\(sys.stdin\\)['releases']\\)\\)\\)\")",
+      "Bash(awk 'NR==1 || $2 ~ /Gi|Ti/')",
+      "Bash(rm -rf /tmp/vt2)",
+      "Bash(python3 -m venv /tmp/vt2)",
+      "Bash(/tmp/vt2/bin/pip install *)",
+      "Bash(/tmp/vt2/bin/python -c ' *)",
+      "Bash(python3 -m pytest -q --collect-only)",
+      "Bash(curl -s https://pypi.org/simple/org-knowledge-layer/)",
+      "Bash(rm -rf /tmp/pv)",
+      "Bash(python3 -m venv /tmp/pv)",
+      "Bash(/tmp/pv/bin/pip install *)",
+      "Bash(/tmp/pv/bin/python -c \"import importlib.metadata as m; print\\(m.version\\('org-knowledge-layer'\\)\\)\")",
+      "Bash(OKL_DATABASE_URL=sqlite:///:memory: OKL_TOKEN=t /tmp/pv/bin/python -c ' *)",
+      "Bash(OKL_DATABASE_URL=sqlite:///:memory: /tmp/pv/bin/python -c ' *)",
+      "Bash(OKL_DATABASE_URL=sqlite:///:memory: OKL_TOKEN=t python3 -c ' *)",
+      "Bash(python3 -m pytest -q -k \"openapi_spec_and_docs\")"
     ],
     "additionalDirectories": [
       "/Users/joshuadell/Dev/okl/e2e/scratch-briefed/.okl",

{org_knowledge_layer-0.3.0 → org_knowledge_layer-0.3.1}/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 0.3.1
+
+### Security
+
+- **Setting `OKL_TOKEN` now also removes `/openapi.json`, `/docs` and `/redoc`.** They
+  were left serving 200 to anonymous callers by the 0.3.0 work that closed every data
+  route, because FastAPI mounts them itself — they are not handlers, so the per-handler
+  auth sweep could not reach them. They leak no records, but they publish the endpoint
+  list, every schema, and which routes want a credential. With no token set the
+  interactive docs remain available, since that case is a developer's laptop.
+
 ## 0.3.0
 
 Everything here came from running three things that had been written but never

{org_knowledge_layer-0.3.0 → org_knowledge_layer-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: org-knowledge-layer
-Version: 0.3.0
+Version: 0.3.1
 Summary: Org Knowledge Layer — an installable sixth surface that carries encoded engineering lessons across repos.
 Author: Joshua Dell
 License: MIT

{org_knowledge_layer-0.3.0 → org_knowledge_layer-0.3.1}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 # Distribution name only. The CLI command, the import package, and the repo are all `okl`;
 # PyPI rejects `okl` as too similar to the existing `oki` (l/i are treated as confusable).
 name = "org-knowledge-layer"
-version = "0.3.0"
+version = "0.3.1"
 description = "Org Knowledge Layer — an installable sixth surface that carries encoded engineering lessons across repos."
 readme = "README.md"
 requires-python = ">=3.10"

{org_knowledge_layer-0.3.0 → org_knowledge_layer-0.3.1}/src/okl/service.py

@@ -66,8 +66,6 @@ class VerifyReq(BaseModel):
 
 
 def create_app(store: Store | None = None) -> FastAPI:
-    app = FastAPI(title="OKL — the sixth surface", version="0.1.0")
-    _store = store or Store(os.environ.get("OKL_DATABASE_URL"))
     # Optional shared-secret gate. If OKL_TOKEN is set it covers READS as well as
     # writes. Reads used to be open while writes were gated, which meant a deployed
     # service handed anyone who found the URL a `GET /nodes` dump of the org's entire
@@ -75,6 +73,15 @@ def create_app(store: Store | None = None) -> FastAPI:
     # decisions. That is a catalogue of where the org is weak, and it is exactly the
     # material the layer exists to collect. If you set a token, you want it private.
     token = os.environ.get("OKL_TOKEN")
+    # The same reasoning reaches the spec routes, and they were missed when the data
+    # routes were closed: FastAPI serves /openapi.json, /docs and /redoc to anyone by
+    # default, and no `_auth` call can protect them because the framework mounts them
+    # itself. They leak the endpoint list, every schema and where the credential is
+    # required — the map you would draw before attacking the routes. Setting the token
+    # is the signal that this instance is not a laptop, so the spec comes down with it.
+    docs = {} if token is None else {"openapi_url": None, "docs_url": None, "redoc_url": None}
+    app = FastAPI(title="OKL — the sixth surface", version="0.1.0", **docs)
+    _store = store or Store(os.environ.get("OKL_DATABASE_URL"))
 
     def _auth(authorization: str | None) -> None:
         if token and authorization != f"Bearer {token}":

{org_knowledge_layer-0.3.0 → org_knowledge_layer-0.3.1}/tests/test_okl.py

@@ -355,6 +355,44 @@ def test_asgi_entrypoint_resolves_to_a_real_app_without_importing_the_database(m
         getattr(svc, "nonexistent_attribute")  # noqa: B009 — the lookup IS the assertion
 
 
+def test_token_also_takes_down_the_openapi_spec_and_docs_ui(monkeypatch):
+    """Setting OKL_TOKEN removes /openapi.json, /docs and /redoc; without it they stay.
+
+    These were missed when the data routes were closed, because they are the one part of
+    the surface `_auth` cannot reach — FastAPI mounts them itself, so adding a dependency
+    to every handler leaves them open. They do not leak records, but they publish the
+    endpoint list, every schema and exactly which routes want a credential: the map you
+    would draw before attacking the rest. Found by reading the store's own rule that
+    OpenAPI specs are dev-only, then testing whether this service obeyed it.
+    """
+    pytest.importorskip("fastapi")
+    pytest.importorskip("httpx")
+    from fastapi.testclient import TestClient
+
+    from okl.service import create_app
+
+    s = Store("sqlite:///:memory:")
+
+    # ASSERT (1) — with a token, the spec routes are gone entirely (404, not 401: the
+    # route does not exist, so there is nothing to probe or brute-force)
+    monkeypatch.setenv("OKL_TOKEN", "s3cret")
+    closed = TestClient(create_app(store=s))
+    for path in ("/openapi.json", "/docs", "/redoc"):
+        assert closed.get(path).status_code == 404, f"{path} still served with a token set"
+
+    # ASSERT (2) — the data routes still work with the credential, so removing the spec
+    # did not remove the API
+    assert closed.post("/check", json={"repo": "x", "task": "t"},
+                       headers={"Authorization": "Bearer s3cret"}).status_code == 200
+
+    # ASSERT (3) — with no token this is someone's laptop, and the interactive docs are
+    # useful there. Taking them away unconditionally would be a worse tool for no gain.
+    monkeypatch.delenv("OKL_TOKEN", raising=False)
+    open_app = TestClient(create_app(store=s))
+    assert open_app.get("/openapi.json").status_code == 200
+    assert open_app.get("/docs").status_code == 200
+
+
 def test_cli_check_fails_closed_when_the_service_refuses_it(tmp_path, monkeypatch, capsys):
     """A 401 is a REFUSED check, not a clean one: exit 2, no reassuring output.