Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
26 changes: 26 additions & 0 deletions src/openai/_base_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -809,13 +809,29 @@ def _idempotency_key(self) -> str:
return f"stainless-python-retry-{uuid.uuid4()}"


def _strip_api_key_on_cross_origin_redirect(original: httpx.Request, redirect: httpx.Request) -> httpx.Request:
def origin(url: URL) -> tuple[str, str, int | None]:
default_port = 443 if url.scheme == "https" else 80 if url.scheme == "http" else None
port = url.port if url.port is not None else default_port
return url.scheme, url.host, port

if origin(original.url) != origin(redirect.url):
redirect.headers.pop("api-key", None)
return redirect


class _DefaultHttpxClient(httpx.Client):
def __init__(self, **kwargs: Any) -> None:
kwargs.setdefault("timeout", DEFAULT_TIMEOUT)
kwargs.setdefault("limits", DEFAULT_CONNECTION_LIMITS)
kwargs.setdefault("follow_redirects", True)
super().__init__(**kwargs)

@override
def _build_redirect_request(self, request: httpx.Request, response: httpx.Response) -> httpx.Request:
redirect = super()._build_redirect_request(request, response)
return _strip_api_key_on_cross_origin_redirect(request, redirect)


if TYPE_CHECKING:
DefaultHttpxClient = httpx.Client
Expand Down Expand Up @@ -1390,6 +1406,11 @@ def __init__(self, **kwargs: Any) -> None:
kwargs.setdefault("follow_redirects", True)
super().__init__(**kwargs)

@override
def _build_redirect_request(self, request: httpx.Request, response: httpx.Response) -> httpx.Request:
redirect = super()._build_redirect_request(request, response)
return _strip_api_key_on_cross_origin_redirect(request, redirect)


try:
import httpx_aiohttp
Expand All @@ -1408,6 +1429,11 @@ def __init__(self, **kwargs: Any) -> None:

super().__init__(**kwargs)

@override
def _build_redirect_request(self, request: httpx.Request, response: httpx.Response) -> httpx.Request:
redirect = super()._build_redirect_request(request, response)
return _strip_api_key_on_cross_origin_redirect(request, redirect)


if TYPE_CHECKING:
DefaultAsyncHttpxClient = httpx.AsyncClient
Expand Down
12 changes: 12 additions & 0 deletions tests/test_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -1067,6 +1067,18 @@ def test_follow_redirects(self, respx_mock: MockRouter, client: OpenAI) -> None:
assert response.status_code == 200
assert response.json() == {"status": "ok"}

@pytest.mark.parametrize("client_cls", [DefaultHttpxClient, DefaultAsyncHttpxClient])
def test_cross_origin_redirect_strips_api_key(
self, client_cls: type[httpx.Client] | type[httpx.AsyncClient]
) -> None:
client = client_cls()
request = httpx.Request("GET", "https://azure.example/v1/models", headers={"api-key": "secret"})
response = httpx.Response(302, headers={"Location": "https://other.example/target"}, request=request)

redirect = client._build_redirect_request(request, response)

assert "api-key" not in redirect.headers

@pytest.mark.respx(base_url=base_url)
def test_follow_redirects_disabled(self, respx_mock: MockRouter, client: OpenAI) -> None:
# Test that follow_redirects=False prevents following redirects
Expand Down