Enrol over http only to loopback; serve the API docs to this machine
The enrolment exemption covered any *.local host, which mDNS answers with whoever claims it; it is now localhost, 127.0.0.0/8 and ::1. /docs, /redoc and openapi.json stay closed in production and otherwise answer only a loopback caller unless API_DOCS_ENABLED is set, which the dev compose does, so `fluksio serve --host 0.0.0.0` no longer hands the schema to the network. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_013GAeg4Jo6xjZzjwy9QDWMQ
This commit is contained in:
+45
-8
@@ -2,6 +2,7 @@ import asyncio
|
||||
import contextlib
|
||||
import hashlib
|
||||
import inspect
|
||||
import ipaddress
|
||||
import logging
|
||||
import sys
|
||||
import tempfile
|
||||
@@ -16,6 +17,7 @@ from fastapi.responses import JSONResponse
|
||||
from fastapi.routing import APIRoute
|
||||
from fluksio_worker.worker_main import ARTIFACT_DIR_ENV, ARTIFACT_VOLATILE_DIR_ENV
|
||||
from starlette.middleware.cors import CORSMiddleware
|
||||
from starlette.types import ASGIApp, Receive, Scope, Send
|
||||
from uvicorn.middleware.proxy_headers import ProxyHeadersMiddleware
|
||||
|
||||
from fluksio import __version__
|
||||
@@ -409,10 +411,43 @@ async def lifespan(app: FastAPI) -> AsyncIterator[None]:
|
||||
|
||||
# The schema enumerates every endpoint this instance serves, including the
|
||||
# paths trigger nodes mount at runtime. That is exactly what a developer wants
|
||||
# and exactly what an internet-facing deployment should not hand out, so it
|
||||
# follows the environment — the same rule the portal's backend uses. The
|
||||
# generated client is built from a local run, not from the deployed host.
|
||||
# and exactly what a reachable engine should not hand out: never in
|
||||
# production, and otherwise only to a caller on this machine unless
|
||||
# API_DOCS_ENABLED says so (the dev stack does). `fluksio serve --host 0.0.0.0`
|
||||
# keeps the default ENVIRONMENT, which is why loopback is the line rather than
|
||||
# the environment alone. The generated client is built from `app.openapi()`
|
||||
# and needs none of these routes.
|
||||
_docs_enabled = settings.ENVIRONMENT != "production"
|
||||
_DOCS_PATHS = frozenset(
|
||||
{"/docs", "/docs/oauth2-redirect", "/redoc", f"{settings.API_V1_STR}/openapi.json"}
|
||||
)
|
||||
|
||||
|
||||
class DocsForThisMachine:
|
||||
"""Answer the schema routes with a 404 for a caller off this machine."""
|
||||
|
||||
def __init__(self, app: ASGIApp) -> None:
|
||||
self.app = app
|
||||
|
||||
async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
|
||||
if (
|
||||
scope["type"] == "http"
|
||||
and scope["path"] in _DOCS_PATHS
|
||||
and not settings.API_DOCS_ENABLED
|
||||
and not _is_loopback((scope.get("client") or ("",))[0])
|
||||
):
|
||||
response = JSONResponse({"detail": "Not Found"}, status_code=404)
|
||||
await response(scope, receive, send)
|
||||
return
|
||||
await self.app(scope, receive, send)
|
||||
|
||||
|
||||
def _is_loopback(host: str) -> bool:
|
||||
try:
|
||||
return ipaddress.ip_address(host).is_loopback
|
||||
except ValueError:
|
||||
return False
|
||||
|
||||
|
||||
app = FastAPI(
|
||||
title=settings.PROJECT_NAME,
|
||||
@@ -434,11 +469,13 @@ if settings.all_cors_origins:
|
||||
allow_headers=["*"],
|
||||
)
|
||||
|
||||
# The caller's address, for every per-address limit: the rightmost
|
||||
# X-Forwarded-For hop that is not a trusted proxy. uvicorn does this for what
|
||||
# it serves, but a call the portal tunnel replays arrives over an in-process
|
||||
# transport as 127.0.0.1 and never passes through it. Doing it again here
|
||||
# covers that, with uvicorn's own semantics, and is a no-op on a request
|
||||
app.add_middleware(DocsForThisMachine)
|
||||
|
||||
# The caller's address, for every per-address limit and the docs check above:
|
||||
# the rightmost X-Forwarded-For hop that is not a trusted proxy. uvicorn does
|
||||
# this for what it serves, but a call the portal tunnel replays arrives over an
|
||||
# in-process transport as 127.0.0.1 and never passes through it. Doing it again
|
||||
# here covers that, with uvicorn's own semantics, and is a no-op on a request
|
||||
# uvicorn already resolved. Added last, so it is the outermost layer.
|
||||
app.add_middleware(ProxyHeadersMiddleware, trusted_hosts=settings.FORWARDED_ALLOW_IPS)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user