Skip to content

refactor: restrict OpenAPI $ref resolution to in-document pointers #11226

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
etairl wants to merge 2 commits into
base: main
Choose a base branch
from
+21 −2
Open

refactor: restrict OpenAPI $ref resolution to in-document pointers #11226

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e1b77b
refactor: restrict OpenAPI $ref resolution to in-document pointers
etairl Apr 30, 2026
2030739
docs: use double backticks in OpenAPI release note
etairl Apr 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions haystack/components/converters/openapi_functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,16 @@ def _parse_property_attributes(

return parsed_schema

@staticmethod
def _no_external_ref_loader(uri: str, **_: Any) -> Any:
# In-document refs (those starting with "#") are resolved by jsonref without invoking
# the loader. Anything else points outside the document (file://, http(s)://, ...) and
# is rejected to prevent local file disclosure and outbound requests during parsing.
raise RuntimeError(
f"Refusing to resolve external $ref '{uri}' while parsing OpenAPI spec. "
"Only in-document JSON-pointer references (starting with '#') are supported."
)

def _parse_openapi_spec(self, content: str) -> dict[str, Any]:
"""
Parses OpenAPI specification content, supporting both JSON and YAML formats.
Expand All @@ -243,7 +253,7 @@ def _parse_openapi_spec(self, content: str) -> dict[str, Any]:
open_api_spec_content = None
try:
open_api_spec_content = json.loads(content)
return jsonref.replace_refs(open_api_spec_content)
return jsonref.replace_refs(open_api_spec_content, loader=self._no_external_ref_loader, proxies=False)
except json.JSONDecodeError as json_error:
# heuristic to confirm that the content is likely malformed JSON
if content.strip().startswith(("{", "[")):
Expand All @@ -258,4 +268,4 @@ def _parse_openapi_spec(self, content: str) -> dict[str, Any]:
raise RuntimeError(error_message, content) from e

# Replace references in the object with their resolved values, if any
return jsonref.replace_refs(open_api_spec_content)
return jsonref.replace_refs(open_api_spec_content, loader=self._no_external_ref_loader, proxies=False)
9 changes: 9 additions & 0 deletions releasenotes/notes/openapi-converter-disallow-external-refs-9b1d3f0a7c2e54a1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
enhancements:
- |
``OpenAPIServiceToFunctions`` now resolves only in-document JSON-pointer
references (those starting with ``#``) when parsing OpenAPI specifications.
External ``$ref`` URIs (for example ``file://`` or ``http(s)://``) are no longer
fetched during parsing; specs that depend on them will raise a
``RuntimeError``. This avoids unintended filesystem access or outbound
HTTP requests when the spec content is not fully trusted.
Loading