Bundle GraphiQL with the server #829
Draft
+41
−26
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| @app.get("/graphiql/{path:path}", include_in_schema=False) | ||
| def explorer(path: str) -> FileResponse: | ||
| logger.debug(f"Serving GraphiQL interface: {path}") | ||
| return FileResponse(pathlib.Path("static/graphiql/") / path) |
Check failure
Code scanning / CodeQL
Uncontrolled data used in path expression High
Show autofix suggestion
Hide autofix suggestion
Copilot Autofix
AI 9 days ago
To fix this problem, user-supplied path elements must be validated before accessing the file system, so that users cannot traverse outside of static/graphiql/. The recommended best-practice is:
- Construct the candidate file path by joining the user input onto the static root.
- Normalize the resulting path using
.resolve()oros.path.normpath(or.absolute()if symlinks shouldn’t be resolved). - Ensure that the resolved path is still within the intended static root directory (e.g., by comparing string prefixes or using the
Path.is_relative_tomethod in Python 3.9+). - Only serve the file if it passes the check. Otherwise, return a 404 or similar error.
Apply these changes within the explorer route (lines 194–196) in ayon_server/api/server.py. Additional imports or error handling (e.g., HTTPException) may be needed if not already present.
Suggested changeset
1
ayon_server/api/server.py
| @@ -193,9 +193,13 @@ | ||
| @app.get("/graphiql/{path:path}", include_in_schema=False) | ||
| def explorer(path: str) -> FileResponse: | ||
| logger.debug(f"Serving GraphiQL interface: {path}") | ||
| return FileResponse(pathlib.Path("static/graphiql/") / path) | ||
| base_dir = pathlib.Path("static/graphiql").resolve() | ||
| full_path = (base_dir / path).resolve() | ||
| if not str(full_path).startswith(str(base_dir)): | ||
| from fastapi import HTTPException | ||
| raise HTTPException(status_code=404, detail="File not found") | ||
| return FileResponse(full_path) | ||
|
|
||
|
|
||
| # | ||
| # Websocket | ||
| # |
Copilot is powered by AI and may make mistakes. Always verify output.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.