fish-edge-gateway-sdk 0.1.0__tar.gz

fish_edge_gateway_sdk-0.1.0/.gitignore

@@ -0,0 +1,5 @@
+.claude/
+target/
+__pycache__/
+*.pyc
+.venv/

fish_edge_gateway_sdk-0.1.0/LICENSE-APACHE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

fish_edge_gateway_sdk-0.1.0/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Fish Audio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fish_edge_gateway_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.4
+Name: fish-edge-gateway-sdk
+Version: 0.1.0
+Summary: Service-side SDK for apex-edge-gateway: declare a FastAPI service's routes for discovery, report usage in band, verify gateway-origin auth, and join the gateway's trace
+Project-URL: Homepage, https://fish.audio
+Author: Fish Audio
+License-Expression: MIT OR Apache-2.0
+License-File: LICENSE-APACHE
+License-File: LICENSE-MIT
+Keywords: edge,fastapi,fish-audio,gateway,sdk
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Internet :: WWW/HTTP
+Requires-Python: >=3.10
+Requires-Dist: fastapi>=0.100
+Requires-Dist: pydantic>=2
+Provides-Extra: dev
+Requires-Dist: httpx>=0.27; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# fish-edge-gateway-sdk (Python)
+
+接入 apex-edge-gateway 的服务侧 SDK：manifest 声明与暴露、internal auth、trace 透传。协议契约见仓库 `docs/contracts/`。
+
+## 安装（不发布 PyPI，直接 git 依赖）
+
+```
+# requirements.txt / pyproject dependency（锁 tag 或 commit，不要追 main）
+fish-edge-gateway-sdk @ git+ssh://git@github.com/fishaudio/apex-edge-gateway.git@<tag-or-sha>#subdirectory=sdk-python
+```
+
+```sh
+# 本地开发
+pip install "fish-edge-gateway-sdk @ git+ssh://git@github.com/fishaudio/apex-edge-gateway.git@main#subdirectory=sdk-python"
+
+# uv
+uv add "fish-edge-gateway-sdk @ git+ssh://git@github.com/fishaudio/apex-edge-gateway.git@main#subdirectory=sdk-python"
+
+# CI / Docker（https + token，避免挂 ssh key）
+pip install "fish-edge-gateway-sdk @ git+https://${GITHUB_TOKEN}@github.com/fishaudio/apex-edge-gateway.git@<sha>#subdirectory=sdk-python"
+```
+
+版本锁定约定：SDK 变更打 `sdk-python/vX.Y.Z` 形式的 git tag，服务锁 tag 升级；紧急验证可锁 commit sha。
+
+## 集成
+
+```python
+from fastapi import Depends, FastAPI
+from fish_edge_gateway_sdk import edge_route, mount_edge, require_gateway
+
+app = FastAPI()
+
+@app.post("/internal/asr", dependencies=[Depends(require_gateway)])
+@edge_route(auth="internal")
+async def asr(payload: dict) -> dict: ...
+
+mount_edge(app, service="omni-asr")   # 挂载 GET /.edge/manifest
+```
+
+k8s Service 侧标注（manifest 契约 §2.1）：
+
+```yaml
+metadata:
+  annotations:
+    fish.audio/edge-discovery: enable
+    # 可选：manifest 端点与业务端口分离时
+    # fish.audio/edge-discovery-port: "9090"
+    # fish.audio/edge-discovery-url: /.edge/manifest
+```
+
+gateway 侧无需额外授权：发现 namespace 的成员资格就是信任边界（manifest 契约 §11），被发现的 manifest 其 route 直接编译。
+
+## 环境变量
+
+| 变量 | 语义 |
+| -- | -- |
+| `FISH_EDGE_GATEWAY_TOKEN` | 期望的 `x-fish-gateway-token`。未设 = 观察模式（只记日志） |
+| `FISH_EDGE_REQUIRE_GATEWAY` | `1` 时强制校验（403 拒绝非 gateway 流量）。P6 gateway 下发 token 后开启 |
+
+## 开发
+
+```sh
+pip install -e "sdk-python[dev]"
+pytest sdk-python/tests -q
+```

fish_edge_gateway_sdk-0.1.0/README.md

@@ -0,0 +1,65 @@
+# fish-edge-gateway-sdk (Python)
+
+接入 apex-edge-gateway 的服务侧 SDK：manifest 声明与暴露、internal auth、trace 透传。协议契约见仓库 `docs/contracts/`。
+
+## 安装（不发布 PyPI，直接 git 依赖）
+
+```
+# requirements.txt / pyproject dependency（锁 tag 或 commit，不要追 main）
+fish-edge-gateway-sdk @ git+ssh://git@github.com/fishaudio/apex-edge-gateway.git@<tag-or-sha>#subdirectory=sdk-python
+```
+
+```sh
+# 本地开发
+pip install "fish-edge-gateway-sdk @ git+ssh://git@github.com/fishaudio/apex-edge-gateway.git@main#subdirectory=sdk-python"
+
+# uv
+uv add "fish-edge-gateway-sdk @ git+ssh://git@github.com/fishaudio/apex-edge-gateway.git@main#subdirectory=sdk-python"
+
+# CI / Docker（https + token，避免挂 ssh key）
+pip install "fish-edge-gateway-sdk @ git+https://${GITHUB_TOKEN}@github.com/fishaudio/apex-edge-gateway.git@<sha>#subdirectory=sdk-python"
+```
+
+版本锁定约定：SDK 变更打 `sdk-python/vX.Y.Z` 形式的 git tag，服务锁 tag 升级；紧急验证可锁 commit sha。
+
+## 集成
+
+```python
+from fastapi import Depends, FastAPI
+from fish_edge_gateway_sdk import edge_route, mount_edge, require_gateway
+
+app = FastAPI()
+
+@app.post("/internal/asr", dependencies=[Depends(require_gateway)])
+@edge_route(auth="internal")
+async def asr(payload: dict) -> dict: ...
+
+mount_edge(app, service="omni-asr")   # 挂载 GET /.edge/manifest
+```
+
+k8s Service 侧标注（manifest 契约 §2.1）：
+
+```yaml
+metadata:
+  annotations:
+    fish.audio/edge-discovery: enable
+    # 可选：manifest 端点与业务端口分离时
+    # fish.audio/edge-discovery-port: "9090"
+    # fish.audio/edge-discovery-url: /.edge/manifest
+```
+
+gateway 侧无需额外授权：发现 namespace 的成员资格就是信任边界（manifest 契约 §11），被发现的 manifest 其 route 直接编译。
+
+## 环境变量
+
+| 变量 | 语义 |
+| -- | -- |
+| `FISH_EDGE_GATEWAY_TOKEN` | 期望的 `x-fish-gateway-token`。未设 = 观察模式（只记日志） |
+| `FISH_EDGE_REQUIRE_GATEWAY` | `1` 时强制校验（403 拒绝非 gateway 流量）。P6 gateway 下发 token 后开启 |
+
+## 开发
+
+```sh
+pip install -e "sdk-python[dev]"
+pytest sdk-python/tests -q
+```

fish_edge_gateway_sdk-0.1.0/examples/omni_asr_demo.py

@@ -0,0 +1,26 @@
+"""Minimal edge-integrated service, used both as documentation and to produce
+the cross-language conformance fixture (docs/contracts/fixtures/manifest/).
+
+Run:  uvicorn omni_asr_demo:app --port 9000
+"""
+
+from fastapi import Depends, FastAPI
+
+from fish_edge_gateway_sdk import edge_route, mount_edge, require_gateway, trace_id
+
+app = FastAPI()
+
+
+@app.post("/internal/asr", dependencies=[Depends(require_gateway)])
+@edge_route(auth="internal", protocol="json")
+async def asr(payload: dict) -> dict:
+    return {"ok": True, "len": len(str(payload))}
+
+
+@app.get("/internal/asr/health")
+@edge_route(auth="internal", protocol="json", concurrency="none")
+async def health() -> dict:
+    return {"status": "up"}
+
+
+mount_edge(app, service="omni-asr")

fish_edge_gateway_sdk-0.1.0/pyproject.toml

@@ -0,0 +1,47 @@
+[project]
+name = "fish-edge-gateway-sdk"
+version = "0.1.0"
+description = "Service-side SDK for apex-edge-gateway: declare a FastAPI service's routes for discovery, report usage in band, verify gateway-origin auth, and join the gateway's trace"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT OR Apache-2.0"
+license-files = ["LICENSE-MIT", "LICENSE-APACHE"]
+authors = [{ name = "Fish Audio" }]
+keywords = ["fish-audio", "gateway", "fastapi", "sdk", "edge"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Framework :: FastAPI",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Topic :: Internet :: WWW/HTTP",
+]
+dependencies = [
+    "fastapi>=0.100",
+    "pydantic>=2",
+]
+
+# No public repository: the gateway is private and a link to it would 404.
+# The README ships in the sdist and wheel, so it is the documentation.
+[project.urls]
+Homepage = "https://fish.audio"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8",
+    "httpx>=0.27",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/fish_edge_gateway_sdk"]
+# Bytecode from local runs would otherwise ride along in the wheel.
+exclude = ["**/__pycache__", "**/*.pyc"]
+
+[tool.hatch.build.targets.sdist]
+exclude = ["**/__pycache__", "**/*.pyc", ".venv"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

fish_edge_gateway_sdk-0.1.0/src/fish_edge_gateway_sdk/__init__.py

@@ -0,0 +1,85 @@
+"""fish-edge-sdk: manifest discovery, internal auth, and trace propagation for
+services behind apex-edge-gateway (contracts: docs/contracts/ in the
+apex-edge-proxy repository).
+
+Minimal integration:
+
+    from fastapi import Depends, FastAPI
+    from fish_edge_gateway_sdk import edge_route, mount_edge, require_gateway
+
+    app = FastAPI()
+
+    @app.post("/internal/asr", dependencies=[Depends(require_gateway)])
+    @edge_route(auth="internal")
+    async def asr(...): ...
+
+    mount_edge(app, service="omni-asr")
+
+Usage reporting helpers (usage contract) arrive together with the gateway's
+P5 billing engine.
+"""
+
+from .auth import GATEWAY_TOKEN_HEADER, require_gateway
+from .discovery import MANIFEST_PATH, build_manifest, edge_route, mount_edge
+from .manifest import (
+    SCHEMA_VERSION,
+    Billing,
+    Concurrency,
+    Claim,
+    Manifest,
+    Match,
+    PathMatch,
+    RouteDecl,
+    ClaimsTarget,
+    StaticTarget,
+)
+from .trace import TRACEPARENT_HEADER, propagation_headers, trace_id
+from .usage import (
+    EVENT_CONCURRENCY,
+    USAGE_TOKENS_HEADER,
+    usage_header,
+    usage_json_field,
+    EVENT_CONCURRENCY_REJECTED,
+    EVENT_USAGE,
+    EVENT_USAGE_FINAL,
+    concurrency_event,
+    is_protocol_event,
+    sse_data,
+    usage_event,
+    usage_final_event,
+)
+
+__all__ = [
+    "SCHEMA_VERSION",
+    "MANIFEST_PATH",
+    "GATEWAY_TOKEN_HEADER",
+    "TRACEPARENT_HEADER",
+    "Manifest",
+    "RouteDecl",
+    "Match",
+    "PathMatch",
+    "StaticTarget",
+    "ClaimsTarget",
+    "Claim",
+    "model_header_is",
+    "Billing",
+    "Concurrency",
+    "edge_route",
+    "mount_edge",
+    "build_manifest",
+    "require_gateway",
+    "trace_id",
+    "propagation_headers",
+    "EVENT_USAGE",
+    "EVENT_USAGE_FINAL",
+    "EVENT_CONCURRENCY",
+    "EVENT_CONCURRENCY_REJECTED",
+    "usage_event",
+    "usage_final_event",
+    "USAGE_TOKENS_HEADER",
+    "usage_header",
+    "usage_json_field",
+    "concurrency_event",
+    "is_protocol_event",
+    "sse_data",
+]

fish_edge_gateway_sdk-0.1.0/src/fish_edge_gateway_sdk/auth.py

@@ -0,0 +1,64 @@
+"""Internal-auth dependency: verify traffic arrived through the gateway.
+
+gateway-adaptor contract §2/§4: the gateway attaches `x-fish-gateway-token`
+(P5+) to forwards; a service that should only ever be reached through the
+gateway verifies it. Before the token rollout (and for services also taking
+direct traffic) the check runs in observe mode: it records but does not
+reject.
+
+Configuration (env):
+
+* `FISH_EDGE_GATEWAY_TOKEN`   — the expected token. Unset = observe mode.
+* `FISH_EDGE_REQUIRE_GATEWAY` — "1" to enforce (403 on mismatch). Default
+  observe: log-only, so the dependency is safe to adopt before the gateway
+  sends tokens.
+"""
+
+from __future__ import annotations
+
+import hmac
+import logging
+import os
+
+from fastapi import HTTPException, Request
+
+GATEWAY_TOKEN_HEADER = "x-fish-gateway-token"
+
+logger = logging.getLogger("fish_edge_gateway_sdk.auth")
+
+
+def _expected_token() -> str | None:
+    return os.environ.get("FISH_EDGE_GATEWAY_TOKEN") or None
+
+
+def _enforced() -> bool:
+    return os.environ.get("FISH_EDGE_REQUIRE_GATEWAY") == "1"
+
+
+async def require_gateway(request: Request) -> None:
+    """FastAPI dependency: `Depends(require_gateway)` on internal routes."""
+    expected = _expected_token()
+    presented = request.headers.get(GATEWAY_TOKEN_HEADER)
+
+    if expected is None:
+        # Token not rolled out yet: observe only.
+        if _enforced():
+            logger.error(
+                "FISH_EDGE_REQUIRE_GATEWAY=1 but FISH_EDGE_GATEWAY_TOKEN is unset; "
+                "refusing request (misconfiguration must fail loudly)"
+            )
+            raise HTTPException(status_code=503, detail="gateway auth misconfigured")
+        return
+
+    ok = presented is not None and hmac.compare_digest(presented, expected)
+    if ok:
+        return
+    if _enforced():
+        raise HTTPException(status_code=403, detail="request did not arrive via the edge gateway")
+    logger.warning(
+        "request without a valid %s (observe mode; set FISH_EDGE_REQUIRE_GATEWAY=1 to enforce)",
+        GATEWAY_TOKEN_HEADER,
+    )
+
+
+__all__ = ["require_gateway", "GATEWAY_TOKEN_HEADER"]