diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 1f11f5b..13d4dcb 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "3.30.0" + ".": "3.30.1" } \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index ed41806..f4ba949 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## 3.30.1 (2026-03-20) + +Full Changelog: [v3.30.0...v3.30.1](https://github.com/supermemoryai/python-sdk/compare/v3.30.0...v3.30.1) + +### Bug Fixes + +* sanitize endpoint path params ([4e459b3](https://github.com/supermemoryai/python-sdk/commit/4e459b34f220bc55bc73ec8bb653fb01457c027e)) + ## 3.30.0 (2026-03-18) Full Changelog: [v3.29.1...v3.30.0](https://github.com/supermemoryai/python-sdk/compare/v3.29.1...v3.30.0) diff --git a/pyproject.toml b/pyproject.toml index dfa2bf6..83f0bea 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "supermemory" -version = "3.30.0" +version = "3.30.1" description = "The official Python library for the supermemory API" dynamic = ["readme"] license = "Apache-2.0" diff --git a/src/supermemory/_utils/__init__.py b/src/supermemory/_utils/__init__.py index dc64e29..10cb66d 100644 --- a/src/supermemory/_utils/__init__.py +++ b/src/supermemory/_utils/__init__.py @@ -1,3 +1,4 @@ +from ._path import path_template as path_template from ._sync import asyncify as asyncify from ._proxy import LazyProxy as LazyProxy from ._utils import ( diff --git a/src/supermemory/_utils/_path.py b/src/supermemory/_utils/_path.py new file mode 100644 index 0000000..4d6e1e4 --- /dev/null +++ b/src/supermemory/_utils/_path.py @@ -0,0 +1,127 @@ +from __future__ import annotations + +import re +from typing import ( + Any, + Mapping, + Callable, +) +from urllib.parse import quote + +# Matches '.' or '..' where each dot is either literal or percent-encoded (%2e / %2E). +_DOT_SEGMENT_RE = re.compile(r"^(?:\.|%2[eE]){1,2}$") + +_PLACEHOLDER_RE = re.compile(r"\{(\w+)\}") + + +def _quote_path_segment_part(value: str) -> str: + """Percent-encode `value` for use in a URI path segment. + + Considers characters not in `pchar` set from RFC 3986 §3.3 to be unsafe. + https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 + """ + # quote() already treats unreserved characters (letters, digits, and -._~) + # as safe, so we only need to add sub-delims, ':', and '@'. + # Notably, unlike the default `safe` for quote(), / is unsafe and must be quoted. + return quote(value, safe="!$&'()*+,;=:@") + + +def _quote_query_part(value: str) -> str: + """Percent-encode `value` for use in a URI query string. + + Considers &, = and characters not in `query` set from RFC 3986 §3.4 to be unsafe. + https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 + """ + return quote(value, safe="!$'()*+,;:@/?") + + +def _quote_fragment_part(value: str) -> str: + """Percent-encode `value` for use in a URI fragment. + + Considers characters not in `fragment` set from RFC 3986 §3.5 to be unsafe. + https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 + """ + return quote(value, safe="!$&'()*+,;=:@/?") + + +def _interpolate( + template: str, + values: Mapping[str, Any], + quoter: Callable[[str], str], +) -> str: + """Replace {name} placeholders in `template`, quoting each value with `quoter`. + + Placeholder names are looked up in `values`. + + Raises: + KeyError: If a placeholder is not found in `values`. + """ + # re.split with a capturing group returns alternating + # [text, name, text, name, ..., text] elements. + parts = _PLACEHOLDER_RE.split(template) + + for i in range(1, len(parts), 2): + name = parts[i] + if name not in values: + raise KeyError(f"a value for placeholder {{{name}}} was not provided") + val = values[name] + if val is None: + parts[i] = "null" + elif isinstance(val, bool): + parts[i] = "true" if val else "false" + else: + parts[i] = quoter(str(values[name])) + + return "".join(parts) + + +def path_template(template: str, /, **kwargs: Any) -> str: + """Interpolate {name} placeholders in `template` from keyword arguments. + + Args: + template: The template string containing {name} placeholders. + **kwargs: Keyword arguments to interpolate into the template. + + Returns: + The template with placeholders interpolated and percent-encoded. + + Safe characters for percent-encoding are dependent on the URI component. + Placeholders in path and fragment portions are percent-encoded where the `segment` + and `fragment` sets from RFC 3986 respectively are considered safe. + Placeholders in the query portion are percent-encoded where the `query` set from + RFC 3986 §3.3 is considered safe except for = and & characters. + + Raises: + KeyError: If a placeholder is not found in `kwargs`. + ValueError: If resulting path contains /./ or /../ segments (including percent-encoded dot-segments). + """ + # Split the template into path, query, and fragment portions. + fragment_template: str | None = None + query_template: str | None = None + + rest = template + if "#" in rest: + rest, fragment_template = rest.split("#", 1) + if "?" in rest: + rest, query_template = rest.split("?", 1) + path_template = rest + + # Interpolate each portion with the appropriate quoting rules. + path_result = _interpolate(path_template, kwargs, _quote_path_segment_part) + + # Reject dot-segments (. and ..) in the final assembled path. The check + # runs after interpolation so that adjacent placeholders or a mix of static + # text and placeholders that together form a dot-segment are caught. + # Also reject percent-encoded dot-segments to protect against incorrectly + # implemented normalization in servers/proxies. + for segment in path_result.split("/"): + if _DOT_SEGMENT_RE.match(segment): + raise ValueError(f"Constructed path {path_result!r} contains dot-segment {segment!r} which is not allowed") + + result = path_result + if query_template is not None: + result += "?" + _interpolate(query_template, kwargs, _quote_query_part) + if fragment_template is not None: + result += "#" + _interpolate(fragment_template, kwargs, _quote_fragment_part) + + return result diff --git a/src/supermemory/_version.py b/src/supermemory/_version.py index 4ebab2f..472d35f 100644 --- a/src/supermemory/_version.py +++ b/src/supermemory/_version.py @@ -1,4 +1,4 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. __title__ = "supermemory" -__version__ = "3.30.0" # x-release-please-version +__version__ = "3.30.1" # x-release-please-version diff --git a/src/supermemory/resources/connections.py b/src/supermemory/resources/connections.py index 2c19235..221b888 100644 --- a/src/supermemory/resources/connections.py +++ b/src/supermemory/resources/connections.py @@ -19,7 +19,7 @@ connection_delete_by_provider_params, ) from .._types import Body, Omit, Query, Headers, NotGiven, SequenceNotStr, omit, not_given -from .._utils import maybe_transform, async_maybe_transform +from .._utils import path_template, maybe_transform, async_maybe_transform from .._compat import cached_property from .._resource import SyncAPIResource, AsyncAPIResource from .._response import ( @@ -93,7 +93,7 @@ def create( if not provider: raise ValueError(f"Expected a non-empty value for `provider` but received {provider!r}") return self._post( - f"/v3/connections/{provider}", + path_template("/v3/connections/{provider}", provider=provider), body=maybe_transform( { "container_tag": container_tag, @@ -171,7 +171,7 @@ def configure( if not connection_id: raise ValueError(f"Expected a non-empty value for `connection_id` but received {connection_id!r}") return self._post( - f"/v3/connections/{connection_id}/configure", + path_template("/v3/connections/{connection_id}/configure", connection_id=connection_id), body=maybe_transform({"resources": resources}, connection_configure_params.ConnectionConfigureParams), options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout @@ -208,7 +208,7 @@ def delete_by_id( if not connection_id: raise ValueError(f"Expected a non-empty value for `connection_id` but received {connection_id!r}") return self._delete( - f"/v3/connections/{connection_id}", + path_template("/v3/connections/{connection_id}", connection_id=connection_id), options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, @@ -250,7 +250,7 @@ def delete_by_provider( if not provider: raise ValueError(f"Expected a non-empty value for `provider` but received {provider!r}") return self._delete( - f"/v3/connections/{provider}", + path_template("/v3/connections/{provider}", provider=provider), body=maybe_transform( {"container_tags": container_tags}, connection_delete_by_provider_params.ConnectionDeleteByProviderParams, @@ -287,7 +287,7 @@ def get_by_id( if not connection_id: raise ValueError(f"Expected a non-empty value for `connection_id` but received {connection_id!r}") return self._get( - f"/v3/connections/{connection_id}", + path_template("/v3/connections/{connection_id}", connection_id=connection_id), options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout ), @@ -323,7 +323,7 @@ def get_by_tag( if not provider: raise ValueError(f"Expected a non-empty value for `provider` but received {provider!r}") return self._post( - f"/v3/connections/{provider}/connection", + path_template("/v3/connections/{provider}/connection", provider=provider), body=maybe_transform( {"container_tags": container_tags}, connection_get_by_tag_params.ConnectionGetByTagParams ), @@ -363,7 +363,7 @@ def import_( raise ValueError(f"Expected a non-empty value for `provider` but received {provider!r}") extra_headers = {"Accept": "text/plain", **(extra_headers or {})} return self._post( - f"/v3/connections/{provider}/import", + path_template("/v3/connections/{provider}/import", provider=provider), body=maybe_transform({"container_tags": container_tags}, connection_import_params.ConnectionImportParams), options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout @@ -400,7 +400,7 @@ def list_documents( if not provider: raise ValueError(f"Expected a non-empty value for `provider` but received {provider!r}") return self._post( - f"/v3/connections/{provider}/documents", + path_template("/v3/connections/{provider}/documents", provider=provider), body=maybe_transform( {"container_tags": container_tags}, connection_list_documents_params.ConnectionListDocumentsParams ), @@ -438,7 +438,7 @@ def resources( if not connection_id: raise ValueError(f"Expected a non-empty value for `connection_id` but received {connection_id!r}") return self._get( - f"/v3/connections/{connection_id}/resources", + path_template("/v3/connections/{connection_id}/resources", connection_id=connection_id), options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, @@ -507,7 +507,7 @@ async def create( if not provider: raise ValueError(f"Expected a non-empty value for `provider` but received {provider!r}") return await self._post( - f"/v3/connections/{provider}", + path_template("/v3/connections/{provider}", provider=provider), body=await async_maybe_transform( { "container_tag": container_tag, @@ -587,7 +587,7 @@ async def configure( if not connection_id: raise ValueError(f"Expected a non-empty value for `connection_id` but received {connection_id!r}") return await self._post( - f"/v3/connections/{connection_id}/configure", + path_template("/v3/connections/{connection_id}/configure", connection_id=connection_id), body=await async_maybe_transform( {"resources": resources}, connection_configure_params.ConnectionConfigureParams ), @@ -626,7 +626,7 @@ async def delete_by_id( if not connection_id: raise ValueError(f"Expected a non-empty value for `connection_id` but received {connection_id!r}") return await self._delete( - f"/v3/connections/{connection_id}", + path_template("/v3/connections/{connection_id}", connection_id=connection_id), options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, @@ -668,7 +668,7 @@ async def delete_by_provider( if not provider: raise ValueError(f"Expected a non-empty value for `provider` but received {provider!r}") return await self._delete( - f"/v3/connections/{provider}", + path_template("/v3/connections/{provider}", provider=provider), body=await async_maybe_transform( {"container_tags": container_tags}, connection_delete_by_provider_params.ConnectionDeleteByProviderParams, @@ -705,7 +705,7 @@ async def get_by_id( if not connection_id: raise ValueError(f"Expected a non-empty value for `connection_id` but received {connection_id!r}") return await self._get( - f"/v3/connections/{connection_id}", + path_template("/v3/connections/{connection_id}", connection_id=connection_id), options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout ), @@ -741,7 +741,7 @@ async def get_by_tag( if not provider: raise ValueError(f"Expected a non-empty value for `provider` but received {provider!r}") return await self._post( - f"/v3/connections/{provider}/connection", + path_template("/v3/connections/{provider}/connection", provider=provider), body=await async_maybe_transform( {"container_tags": container_tags}, connection_get_by_tag_params.ConnectionGetByTagParams ), @@ -781,7 +781,7 @@ async def import_( raise ValueError(f"Expected a non-empty value for `provider` but received {provider!r}") extra_headers = {"Accept": "text/plain", **(extra_headers or {})} return await self._post( - f"/v3/connections/{provider}/import", + path_template("/v3/connections/{provider}/import", provider=provider), body=await async_maybe_transform( {"container_tags": container_tags}, connection_import_params.ConnectionImportParams ), @@ -820,7 +820,7 @@ async def list_documents( if not provider: raise ValueError(f"Expected a non-empty value for `provider` but received {provider!r}") return await self._post( - f"/v3/connections/{provider}/documents", + path_template("/v3/connections/{provider}/documents", provider=provider), body=await async_maybe_transform( {"container_tags": container_tags}, connection_list_documents_params.ConnectionListDocumentsParams ), @@ -858,7 +858,7 @@ async def resources( if not connection_id: raise ValueError(f"Expected a non-empty value for `connection_id` but received {connection_id!r}") return await self._get( - f"/v3/connections/{connection_id}/resources", + path_template("/v3/connections/{connection_id}/resources", connection_id=connection_id), options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, diff --git a/src/supermemory/resources/documents.py b/src/supermemory/resources/documents.py index 4fb46e7..2f026ee 100644 --- a/src/supermemory/resources/documents.py +++ b/src/supermemory/resources/documents.py @@ -16,7 +16,7 @@ document_upload_file_params, ) from .._types import Body, Omit, Query, Headers, NoneType, NotGiven, FileTypes, SequenceNotStr, omit, not_given -from .._utils import extract_files, maybe_transform, deepcopy_minimal, async_maybe_transform +from .._utils import extract_files, path_template, maybe_transform, deepcopy_minimal, async_maybe_transform from .._compat import cached_property from .._resource import SyncAPIResource, AsyncAPIResource from .._response import ( @@ -115,7 +115,7 @@ def update( if not id: raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") return self._patch( - f"/v3/documents/{id}", + path_template("/v3/documents/{id}", id=id), body=maybe_transform( { "container_tag": container_tag, @@ -225,7 +225,7 @@ def delete( raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") extra_headers = {"Accept": "*/*", **(extra_headers or {})} return self._delete( - f"/v3/documents/{id}", + path_template("/v3/documents/{id}", id=id), options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout ), @@ -423,7 +423,7 @@ def get( if not id: raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") return self._get( - f"/v3/documents/{id}", + path_template("/v3/documents/{id}", id=id), options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout ), @@ -602,7 +602,7 @@ async def update( if not id: raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") return await self._patch( - f"/v3/documents/{id}", + path_template("/v3/documents/{id}", id=id), body=await async_maybe_transform( { "container_tag": container_tag, @@ -712,7 +712,7 @@ async def delete( raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") extra_headers = {"Accept": "*/*", **(extra_headers or {})} return await self._delete( - f"/v3/documents/{id}", + path_template("/v3/documents/{id}", id=id), options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout ), @@ -910,7 +910,7 @@ async def get( if not id: raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") return await self._get( - f"/v3/documents/{id}", + path_template("/v3/documents/{id}", id=id), options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout ), diff --git a/tests/test_utils/test_path.py b/tests/test_utils/test_path.py new file mode 100644 index 0000000..c6dc03c --- /dev/null +++ b/tests/test_utils/test_path.py @@ -0,0 +1,89 @@ +from __future__ import annotations + +from typing import Any + +import pytest + +from supermemory._utils._path import path_template + + +@pytest.mark.parametrize( + "template, kwargs, expected", + [ + ("/v1/{id}", dict(id="abc"), "/v1/abc"), + ("/v1/{a}/{b}", dict(a="x", b="y"), "/v1/x/y"), + ("/v1/{a}{b}/path/{c}?val={d}#{e}", dict(a="x", b="y", c="z", d="u", e="v"), "/v1/xy/path/z?val=u#v"), + ("/{w}/{w}", dict(w="echo"), "/echo/echo"), + ("/v1/static", {}, "/v1/static"), + ("", {}, ""), + ("/v1/?q={n}&count=10", dict(n=42), "/v1/?q=42&count=10"), + ("/v1/{v}", dict(v=None), "/v1/null"), + ("/v1/{v}", dict(v=True), "/v1/true"), + ("/v1/{v}", dict(v=False), "/v1/false"), + ("/v1/{v}", dict(v=".hidden"), "/v1/.hidden"), # dot prefix ok + ("/v1/{v}", dict(v="file.txt"), "/v1/file.txt"), # dot in middle ok + ("/v1/{v}", dict(v="..."), "/v1/..."), # triple dot ok + ("/v1/{a}{b}", dict(a=".", b="txt"), "/v1/.txt"), # dot var combining with adjacent to be ok + ("/items?q={v}#{f}", dict(v=".", f=".."), "/items?q=.#.."), # dots in query/fragment are fine + ( + "/v1/{a}?query={b}", + dict(a="../../other/endpoint", b="a&bad=true"), + "/v1/..%2F..%2Fother%2Fendpoint?query=a%26bad%3Dtrue", + ), + ("/v1/{val}", dict(val="a/b/c"), "/v1/a%2Fb%2Fc"), + ("/v1/{val}", dict(val="a/b/c?query=value"), "/v1/a%2Fb%2Fc%3Fquery=value"), + ("/v1/{val}", dict(val="a/b/c?query=value&bad=true"), "/v1/a%2Fb%2Fc%3Fquery=value&bad=true"), + ("/v1/{val}", dict(val="%20"), "/v1/%2520"), # escapes escape sequences in input + # Query: slash and ? are safe, # is not + ("/items?q={v}", dict(v="a/b"), "/items?q=a/b"), + ("/items?q={v}", dict(v="a?b"), "/items?q=a?b"), + ("/items?q={v}", dict(v="a#b"), "/items?q=a%23b"), + ("/items?q={v}", dict(v="a b"), "/items?q=a%20b"), + # Fragment: slash and ? are safe + ("/docs#{v}", dict(v="a/b"), "/docs#a/b"), + ("/docs#{v}", dict(v="a?b"), "/docs#a?b"), + # Path: slash, ? and # are all encoded + ("/v1/{v}", dict(v="a/b"), "/v1/a%2Fb"), + ("/v1/{v}", dict(v="a?b"), "/v1/a%3Fb"), + ("/v1/{v}", dict(v="a#b"), "/v1/a%23b"), + # same var encoded differently by component + ( + "/v1/{v}?q={v}#{v}", + dict(v="a/b?c#d"), + "/v1/a%2Fb%3Fc%23d?q=a/b?c%23d#a/b?c%23d", + ), + ("/v1/{val}", dict(val="x?admin=true"), "/v1/x%3Fadmin=true"), # query injection + ("/v1/{val}", dict(val="x#admin"), "/v1/x%23admin"), # fragment injection + ], +) +def test_interpolation(template: str, kwargs: dict[str, Any], expected: str) -> None: + assert path_template(template, **kwargs) == expected + + +def test_missing_kwarg_raises_key_error() -> None: + with pytest.raises(KeyError, match="org_id"): + path_template("/v1/{org_id}") + + +@pytest.mark.parametrize( + "template, kwargs", + [ + ("{a}/path", dict(a=".")), + ("{a}/path", dict(a="..")), + ("/v1/{a}", dict(a=".")), + ("/v1/{a}", dict(a="..")), + ("/v1/{a}/path", dict(a=".")), + ("/v1/{a}/path", dict(a="..")), + ("/v1/{a}{b}", dict(a=".", b=".")), # adjacent vars → ".." + ("/v1/{a}.", dict(a=".")), # var + static → ".." + ("/v1/{a}{b}", dict(a="", b=".")), # empty + dot → "." + ("/v1/%2e/{x}", dict(x="ok")), # encoded dot in static text + ("/v1/%2e./{x}", dict(x="ok")), # mixed encoded ".." in static + ("/v1/.%2E/{x}", dict(x="ok")), # mixed encoded ".." in static + ("/v1/{v}?q=1", dict(v="..")), + ("/v1/{v}#frag", dict(v="..")), + ], +) +def test_dot_segment_rejected(template: str, kwargs: dict[str, Any]) -> None: + with pytest.raises(ValueError, match="dot-segment"): + path_template(template, **kwargs)