fix: sanitize endpoint path params

Author: stainless-app[bot]

src/orb/_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/orb/_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/orb/resources/alerts.py

@@ -19,7 +19,7 @@
     alert_create_for_external_customer_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 to_streamed_response_wrapper, async_to_streamed_response_wrapper
@@ -84,7 +84,7 @@ def retrieve(
         if not alert_id:
             raise ValueError(f"Expected a non-empty value for `alert_id` but received {alert_id!r}")
         return self._get(
-            f"/alerts/{alert_id}",
+            path_template("/alerts/{alert_id}", alert_id=alert_id),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -125,7 +125,7 @@ def update(
                 f"Expected a non-empty value for `alert_configuration_id` but received {alert_configuration_id!r}"
             )
         return self._put(
-            f"/alerts/{alert_configuration_id}",
+            path_template("/alerts/{alert_configuration_id}", alert_configuration_id=alert_configuration_id),
             body=maybe_transform({"thresholds": thresholds}, alert_update_params.AlertUpdateParams),
             options=make_request_options(
                 extra_headers=extra_headers,
@@ -261,7 +261,7 @@ def create_for_customer(
         if not customer_id:
             raise ValueError(f"Expected a non-empty value for `customer_id` but received {customer_id!r}")
         return self._post(
-            f"/alerts/customer_id/{customer_id}",
+            path_template("/alerts/customer_id/{customer_id}", customer_id=customer_id),
             body=maybe_transform(
                 {
                     "currency": currency,
@@ -328,7 +328,9 @@ def create_for_external_customer(
                 f"Expected a non-empty value for `external_customer_id` but received {external_customer_id!r}"
             )
         return self._post(
-            f"/alerts/external_customer_id/{external_customer_id}",
+            path_template(
+                "/alerts/external_customer_id/{external_customer_id}", external_customer_id=external_customer_id
+            ),
             body=maybe_transform(
                 {
                     "currency": currency,
@@ -403,7 +405,7 @@ def create_for_subscription(
         if not subscription_id:
             raise ValueError(f"Expected a non-empty value for `subscription_id` but received {subscription_id!r}")
         return self._post(
-            f"/alerts/subscription_id/{subscription_id}",
+            path_template("/alerts/subscription_id/{subscription_id}", subscription_id=subscription_id),
             body=maybe_transform(
                 {
                     "thresholds": thresholds,
@@ -461,7 +463,7 @@ def disable(
                 f"Expected a non-empty value for `alert_configuration_id` but received {alert_configuration_id!r}"
             )
         return self._post(
-            f"/alerts/{alert_configuration_id}/disable",
+            path_template("/alerts/{alert_configuration_id}/disable", alert_configuration_id=alert_configuration_id),
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
@@ -510,7 +512,7 @@ def enable(
                 f"Expected a non-empty value for `alert_configuration_id` but received {alert_configuration_id!r}"
             )
         return self._post(
-            f"/alerts/{alert_configuration_id}/enable",
+            path_template("/alerts/{alert_configuration_id}/enable", alert_configuration_id=alert_configuration_id),
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
@@ -576,7 +578,7 @@ async def retrieve(
         if not alert_id:
             raise ValueError(f"Expected a non-empty value for `alert_id` but received {alert_id!r}")
         return await self._get(
-            f"/alerts/{alert_id}",
+            path_template("/alerts/{alert_id}", alert_id=alert_id),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -617,7 +619,7 @@ async def update(
                 f"Expected a non-empty value for `alert_configuration_id` but received {alert_configuration_id!r}"
             )
         return await self._put(
-            f"/alerts/{alert_configuration_id}",
+            path_template("/alerts/{alert_configuration_id}", alert_configuration_id=alert_configuration_id),
             body=await async_maybe_transform({"thresholds": thresholds}, alert_update_params.AlertUpdateParams),
             options=make_request_options(
                 extra_headers=extra_headers,
@@ -753,7 +755,7 @@ async def create_for_customer(
         if not customer_id:
             raise ValueError(f"Expected a non-empty value for `customer_id` but received {customer_id!r}")
         return await self._post(
-            f"/alerts/customer_id/{customer_id}",
+            path_template("/alerts/customer_id/{customer_id}", customer_id=customer_id),
             body=await async_maybe_transform(
                 {
                     "currency": currency,
@@ -820,7 +822,9 @@ async def create_for_external_customer(
                 f"Expected a non-empty value for `external_customer_id` but received {external_customer_id!r}"
             )
         return await self._post(
-            f"/alerts/external_customer_id/{external_customer_id}",
+            path_template(
+                "/alerts/external_customer_id/{external_customer_id}", external_customer_id=external_customer_id
+            ),
             body=await async_maybe_transform(
                 {
                     "currency": currency,
@@ -895,7 +899,7 @@ async def create_for_subscription(
         if not subscription_id:
             raise ValueError(f"Expected a non-empty value for `subscription_id` but received {subscription_id!r}")
         return await self._post(
-            f"/alerts/subscription_id/{subscription_id}",
+            path_template("/alerts/subscription_id/{subscription_id}", subscription_id=subscription_id),
             body=await async_maybe_transform(
                 {
                     "thresholds": thresholds,
@@ -953,7 +957,7 @@ async def disable(
                 f"Expected a non-empty value for `alert_configuration_id` but received {alert_configuration_id!r}"
             )
         return await self._post(
-            f"/alerts/{alert_configuration_id}/disable",
+            path_template("/alerts/{alert_configuration_id}/disable", alert_configuration_id=alert_configuration_id),
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
@@ -1004,7 +1008,7 @@ async def enable(
                 f"Expected a non-empty value for `alert_configuration_id` but received {alert_configuration_id!r}"
             )
         return await self._post(
-            f"/alerts/{alert_configuration_id}/enable",
+            path_template("/alerts/{alert_configuration_id}/enable", alert_configuration_id=alert_configuration_id),
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,

src/orb/resources/beta/beta.py

@@ -9,7 +9,7 @@
 from ... import _legacy_response
 from ...types import beta_create_plan_version_params, beta_set_default_plan_version_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 ..._compat import cached_property
 from ..._resource import SyncAPIResource, AsyncAPIResource
 from ..._response import to_streamed_response_wrapper, async_to_streamed_response_wrapper
@@ -116,7 +116,7 @@ def create_plan_version(
         if not plan_id:
             raise ValueError(f"Expected a non-empty value for `plan_id` but received {plan_id!r}")
         return self._post(
-            f"/plans/{plan_id}/versions",
+            path_template("/plans/{plan_id}/versions", plan_id=plan_id),
             body=maybe_transform(
                 {
                     "version": version,
@@ -171,7 +171,7 @@ def fetch_plan_version(
         if not version:
             raise ValueError(f"Expected a non-empty value for `version` but received {version!r}")
         return self._get(
-            f"/plans/{plan_id}/versions/{version}",
+            path_template("/plans/{plan_id}/versions/{version}", plan_id=plan_id, version=version),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -210,7 +210,7 @@ def set_default_plan_version(
         if not plan_id:
             raise ValueError(f"Expected a non-empty value for `plan_id` but received {plan_id!r}")
         return self._post(
-            f"/plans/{plan_id}/set_default_version",
+            path_template("/plans/{plan_id}/set_default_version", plan_id=plan_id),
             body=maybe_transform(
                 {"version": version}, beta_set_default_plan_version_params.BetaSetDefaultPlanVersionParams
             ),
@@ -313,7 +313,7 @@ async def create_plan_version(
         if not plan_id:
             raise ValueError(f"Expected a non-empty value for `plan_id` but received {plan_id!r}")
         return await self._post(
-            f"/plans/{plan_id}/versions",
+            path_template("/plans/{plan_id}/versions", plan_id=plan_id),
             body=await async_maybe_transform(
                 {
                     "version": version,
@@ -368,7 +368,7 @@ async def fetch_plan_version(
         if not version:
             raise ValueError(f"Expected a non-empty value for `version` but received {version!r}")
         return await self._get(
-            f"/plans/{plan_id}/versions/{version}",
+            path_template("/plans/{plan_id}/versions/{version}", plan_id=plan_id, version=version),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -407,7 +407,7 @@ async def set_default_plan_version(
         if not plan_id:
             raise ValueError(f"Expected a non-empty value for `plan_id` but received {plan_id!r}")
         return await self._post(
-            f"/plans/{plan_id}/set_default_version",
+            path_template("/plans/{plan_id}/set_default_version", plan_id=plan_id),
             body=await async_maybe_transform(
                 {"version": version}, beta_set_default_plan_version_params.BetaSetDefaultPlanVersionParams
             ),