fix: sanitize endpoint path params

Author: stainless-app[bot]

src/oz_agent_sdk/_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 (

src/oz_agent_sdk/_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

src/oz_agent_sdk/resources/agent/agent.py

@@ -17,7 +17,7 @@
 )
 from ...types import agent_run_params, agent_list_params
 from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
-from ..._utils import maybe_transform, async_maybe_transform
+from ..._utils import path_template, maybe_transform, async_maybe_transform
 from .sessions import (
     SessionsResource,
     AsyncSessionsResource,
@@ -178,7 +178,7 @@ def get_artifact(
         if not artifact_uid:
             raise ValueError(f"Expected a non-empty value for `artifact_uid` but received {artifact_uid!r}")
         return self._get(
-            f"/agent/artifacts/{artifact_uid}",
+            path_template("/agent/artifacts/{artifact_uid}", artifact_uid=artifact_uid),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -392,7 +392,7 @@ async def get_artifact(
         if not artifact_uid:
             raise ValueError(f"Expected a non-empty value for `artifact_uid` but received {artifact_uid!r}")
         return await self._get(
-            f"/agent/artifacts/{artifact_uid}",
+            path_template("/agent/artifacts/{artifact_uid}", artifact_uid=artifact_uid),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),

src/oz_agent_sdk/resources/agent/runs.py

@@ -9,7 +9,7 @@
 import httpx
 
 from ..._types import Body, Omit, Query, Headers, NotGiven, 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 (
@@ -77,7 +77,7 @@ def retrieve(
         if not run_id:
             raise ValueError(f"Expected a non-empty value for `run_id` but received {run_id!r}")
         return self._get(
-            f"/agent/runs/{run_id}",
+            path_template("/agent/runs/{run_id}", run_id=run_id),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -235,7 +235,7 @@ def cancel(
         if not run_id:
             raise ValueError(f"Expected a non-empty value for `run_id` but received {run_id!r}")
         return self._post(
-            f"/agent/runs/{run_id}/cancel",
+            path_template("/agent/runs/{run_id}/cancel", run_id=run_id),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -292,7 +292,7 @@ async def retrieve(
         if not run_id:
             raise ValueError(f"Expected a non-empty value for `run_id` but received {run_id!r}")
         return await self._get(
-            f"/agent/runs/{run_id}",
+            path_template("/agent/runs/{run_id}", run_id=run_id),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -450,7 +450,7 @@ async def cancel(
         if not run_id:
             raise ValueError(f"Expected a non-empty value for `run_id` but received {run_id!r}")
         return await self._post(
-            f"/agent/runs/{run_id}/cancel",
+            path_template("/agent/runs/{run_id}/cancel", run_id=run_id),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),

src/oz_agent_sdk/resources/agent/schedules.py

@@ -5,7 +5,7 @@
 import httpx
 
 from ..._types import Body, Omit, Query, Headers, NotGiven, 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 (
@@ -137,7 +137,7 @@ def retrieve(
         if not schedule_id:
             raise ValueError(f"Expected a non-empty value for `schedule_id` but received {schedule_id!r}")
         return self._get(
-            f"/agent/schedules/{schedule_id}",
+            path_template("/agent/schedules/{schedule_id}", schedule_id=schedule_id),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -188,7 +188,7 @@ def update(
         if not schedule_id:
             raise ValueError(f"Expected a non-empty value for `schedule_id` but received {schedule_id!r}")
         return self._put(
-            f"/agent/schedules/{schedule_id}",
+            path_template("/agent/schedules/{schedule_id}", schedule_id=schedule_id),
             body=maybe_transform(
                 {
                     "cron_schedule": cron_schedule,
@@ -255,7 +255,7 @@ def delete(
         if not schedule_id:
             raise ValueError(f"Expected a non-empty value for `schedule_id` but received {schedule_id!r}")
         return self._delete(
-            f"/agent/schedules/{schedule_id}",
+            path_template("/agent/schedules/{schedule_id}", schedule_id=schedule_id),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -290,7 +290,7 @@ def pause(
         if not schedule_id:
             raise ValueError(f"Expected a non-empty value for `schedule_id` but received {schedule_id!r}")
         return self._post(
-            f"/agent/schedules/{schedule_id}/pause",
+            path_template("/agent/schedules/{schedule_id}/pause", schedule_id=schedule_id),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -325,7 +325,7 @@ def resume(
         if not schedule_id:
             raise ValueError(f"Expected a non-empty value for `schedule_id` but received {schedule_id!r}")
         return self._post(
-            f"/agent/schedules/{schedule_id}/resume",
+            path_template("/agent/schedules/{schedule_id}/resume", schedule_id=schedule_id),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -446,7 +446,7 @@ async def retrieve(
         if not schedule_id:
             raise ValueError(f"Expected a non-empty value for `schedule_id` but received {schedule_id!r}")
         return await self._get(
-            f"/agent/schedules/{schedule_id}",
+            path_template("/agent/schedules/{schedule_id}", schedule_id=schedule_id),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -497,7 +497,7 @@ async def update(
         if not schedule_id:
             raise ValueError(f"Expected a non-empty value for `schedule_id` but received {schedule_id!r}")
         return await self._put(
-            f"/agent/schedules/{schedule_id}",
+            path_template("/agent/schedules/{schedule_id}", schedule_id=schedule_id),
             body=await async_maybe_transform(
                 {
                     "cron_schedule": cron_schedule,
@@ -564,7 +564,7 @@ async def delete(
         if not schedule_id:
             raise ValueError(f"Expected a non-empty value for `schedule_id` but received {schedule_id!r}")
         return await self._delete(
-            f"/agent/schedules/{schedule_id}",
+            path_template("/agent/schedules/{schedule_id}", schedule_id=schedule_id),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -599,7 +599,7 @@ async def pause(
         if not schedule_id:
             raise ValueError(f"Expected a non-empty value for `schedule_id` but received {schedule_id!r}")
         return await self._post(
-            f"/agent/schedules/{schedule_id}/pause",
+            path_template("/agent/schedules/{schedule_id}/pause", schedule_id=schedule_id),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -634,7 +634,7 @@ async def resume(
         if not schedule_id:
             raise ValueError(f"Expected a non-empty value for `schedule_id` but received {schedule_id!r}")
         return await self._post(
-            f"/agent/schedules/{schedule_id}/resume",
+            path_template("/agent/schedules/{schedule_id}/resume", schedule_id=schedule_id),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),

src/oz_agent_sdk/resources/agent/sessions.py

@@ -5,6 +5,7 @@
 import httpx
 
 from ..._types import Body, Query, Headers, NotGiven, not_given
+from ..._utils import path_template
 from ..._compat import cached_property
 from ..._resource import SyncAPIResource, AsyncAPIResource
 from ..._response import (
@@ -69,7 +70,7 @@ def check_redirect(
         if not session_uuid:
             raise ValueError(f"Expected a non-empty value for `session_uuid` but received {session_uuid!r}")
         return self._get(
-            f"/agent/sessions/{session_uuid}/redirect",
+            path_template("/agent/sessions/{session_uuid}/redirect", session_uuid=session_uuid),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -127,7 +128,7 @@ async def check_redirect(
         if not session_uuid:
             raise ValueError(f"Expected a non-empty value for `session_uuid` but received {session_uuid!r}")
         return await self._get(
-            f"/agent/sessions/{session_uuid}/redirect",
+            path_template("/agent/sessions/{session_uuid}/redirect", session_uuid=session_uuid),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),