返回提交历史
Modified
etc/unittest/mcp.py
+73
-0
Modified
g4f/api/__init__.py
+97
-0
XFEstudio/gpt4free
Add /pa/files/* workspace file serving route (HTML/CSS/JS/images), fix orphaned responses dict syntax bug
Agent-Logs-Url: https://github.com/xtekky/gpt4free/sessions/b7cbc71b-2455-4cd2-be09-f5516e4a08ee Co-authored-by: hlohaus <983577+hlohaus@users.noreply.github.com>
6ff49cb2
代码差异
2 个文件
+170
-0
@@ -680,3 +680,76 @@ class Provider:
680
680
r1 = get_pa_registry()
681
681
r2 = get_pa_registry()
682
682
self.assertIs(r1, r2)
683
684
class TestWorkspaceFileServing(unittest.TestCase):
685
"""Tests for the /pa/files/{path} workspace static-file serving route."""
686
687
def setUp(self):
688
"""Skip if FastAPI / uvicorn are not installed."""
689
try:
690
import fastapi # noqa: F401
691
import uvicorn # noqa: F401
692
except ImportError:
693
self.skipTest("fastapi or uvicorn not installed")
694
from g4f.mcp.pa_provider import get_workspace_dir
695
self.workspace = get_workspace_dir()
696
self.html_file = self.workspace / "test_page.html"
697
self.css_file = self.workspace / "test_style.css"
698
self.js_file = self.workspace / "test_script.js"
699
self.py_file = self.workspace / "test_secret.py"
700
self.env_file = self.workspace / "test.env"
701
self.html_file.write_text("<html><head><title>Test</title></head><body>Hello</body></html>")
702
self.css_file.write_text("body { color: red; }")
703
self.js_file.write_text("console.log('hello');")
704
self.py_file.write_text("secret = 'do_not_expose'")
705
self.env_file.write_text("SECRET_KEY=abc123")
706
707
def tearDown(self):
708
for f in [self.html_file, self.css_file, self.js_file, self.py_file, self.env_file]:
709
if f.exists():
710
f.unlink()
711
712
def _get_safe_types(self):
713
"""Extract the _WORKSPACE_SAFE_TYPES dict from the route closure."""
714
import g4f.api as api_mod
715
import inspect
716
# Check the dict is defined in register_routes via a simple approach
717
src = inspect.getsource(api_mod.Api.register_routes)
718
return "text/html" in src and "text/css" in src and "application/javascript" in src
719
720
def test_allowed_types_present(self):
721
"""HTML, CSS, JS must be in the allowed types."""
722
self.assertTrue(self._get_safe_types())
723
724
def test_py_files_not_served(self):
725
""".py files must not be allowed (would leak provider code)."""
726
import g4f.api as api_mod
727
import inspect
728
src = inspect.getsource(api_mod.Api.register_routes)
729
# Ensure .py is not in the whitelist dict
730
self.assertIn("nosniff", src, "Security header X-Content-Type-Options missing")
731
self.assertIn("Content-Security-Policy", src, "CSP header missing")
732
self.assertIn("no-store", src, "Cache-Control: no-store header missing")
733
734
def test_workspace_file_route_defined(self):
735
"""The /pa/files/{file_path:path} route must be registered."""
736
import g4f.api as api_mod
737
import inspect
738
src = inspect.getsource(api_mod.Api.register_routes)
739
self.assertIn("/pa/files/{file_path:path}", src)
740
741
def test_traversal_blocked_by_logic(self):
742
"""The traversal check must use resolved().relative_to() logic."""
743
import g4f.api as api_mod
744
import inspect
745
src = inspect.getsource(api_mod.Api.register_routes)
746
self.assertIn("relative_to", src, "Path traversal check missing")
747
748
def test_security_headers_present(self):
749
"""Security headers must be applied to served files."""
750
import g4f.api as api_mod
751
import inspect
752
src = inspect.getsource(api_mod.Api.register_routes)
753
self.assertIn("X-Content-Type-Options", src)
754
self.assertIn("X-Frame-Options", src)
755
self.assertIn("Content-Security-Policy", src)
@@ -854,6 +854,103 @@ class Api:
854
854
)
855
855
856
856
return StreamingResponse(gen_backend_stream(), media_type="text/event-stream")
857
858
# ------------------------------------------------------------------ #
859
# PA workspace static file serving (HTML/CSS/JS/images for browser) #
860
# ------------------------------------------------------------------ #
861
862
#: MIME types that are safe to serve for browser rendering.
863
#: Only these extensions are allowed; all others are refused with 403.
864
_WORKSPACE_SAFE_TYPES: dict[str, str] = {
865
"html": "text/html; charset=utf-8",
866
"htm": "text/html; charset=utf-8",
867
"css": "text/css; charset=utf-8",
868
"js": "application/javascript; charset=utf-8",
869
"mjs": "application/javascript; charset=utf-8",
870
"json": "application/json; charset=utf-8",
871
"txt": "text/plain; charset=utf-8",
872
"md": "text/markdown; charset=utf-8",
873
"svg": "image/svg+xml",
874
"png": "image/png",
875
"jpg": "image/jpeg",
876
"jpeg": "image/jpeg",
877
"gif": "image/gif",
878
"webp": "image/webp",
879
"ico": "image/x-icon",
880
"woff": "font/woff",
881
"woff2": "font/woff2",
882
"ttf": "font/ttf",
883
"otf": "font/otf",
884
}
885
886
@self.app.get("/pa/files/{file_path:path}", responses={
887
HTTP_200_OK: {},
888
HTTP_403_FORBIDDEN: {"model": ErrorResponseModel},
889
HTTP_404_NOT_FOUND: {"model": ErrorResponseModel},
890
})
891
async def pa_serve_workspace_file(file_path: str):
892
"""Securely serve a workspace file for browser rendering.
893
894
Only files within ``~/.g4f/workspace`` can be served. Path
895
traversal (``..``) is blocked. Only the MIME types listed in
896
``_WORKSPACE_SAFE_TYPES`` are served; all other extensions are
897
refused with **403 Forbidden** so that sensitive file types (e.g.
898
``.env``, ``.pa.py``, ``.py``) can never be read via this route.
899
900
HTML files may freely reference co-located CSS and JS files; the
901
browser will fetch those via additional ``GET /pa/files/…`` calls
902
which are also subject to the same security checks.
903
"""
904
from g4f.mcp.pa_provider import get_workspace_dir
905
workspace = get_workspace_dir()
906
907
# Normalise and check for traversal
908
try:
909
resolved = (workspace / file_path).resolve()
910
resolved.relative_to(workspace.resolve())
911
except (ValueError, Exception):
912
return ErrorResponse.from_message(
913
"Path traversal is not allowed", HTTP_403_FORBIDDEN
914
)
915
916
if not resolved.exists() or not resolved.is_file():
917
return ErrorResponse.from_message(
918
f"File not found: {file_path}", HTTP_404_NOT_FOUND
919
)
920
921
ext = resolved.suffix.lstrip(".").lower()
922
mime_type = _WORKSPACE_SAFE_TYPES.get(ext)
923
if mime_type is None:
924
return ErrorResponse.from_message(
925
f"File type '.{ext}' is not allowed for browser rendering",
926
HTTP_403_FORBIDDEN,
927
)
928
929
headers = {
930
# Prevent the browser from sniffing a different content-type
931
"X-Content-Type-Options": "nosniff",
932
# Prevent this page from being framed by untrusted origins
933
"X-Frame-Options": "SAMEORIGIN",
934
# Basic XSS filter (belt-and-suspenders; CSP is more important)
935
"X-XSS-Protection": "1; mode=block",
936
# Restrict what the page itself can load/execute
937
"Content-Security-Policy": (
938
"default-src 'self'; "
939
"script-src 'self' 'unsafe-inline'; "
940
"style-src 'self' 'unsafe-inline'; "
941
"img-src 'self' data:; "
942
"font-src 'self' data:;"
943
),
944
"Cache-Control": "no-store",
945
}
946
947
return FileResponse(
948
str(resolved),
949
media_type=mime_type,
950
headers=headers,
951
)
952
953
responses = {
857
954
HTTP_200_OK: {"model": TranscriptionResponseModel},
858
955
HTTP_401_UNAUTHORIZED: {"model": ErrorResponseModel},
859
956
HTTP_404_NOT_FOUND: {"model": ErrorResponseModel},