Skip to content

fix: Use alternative logout url for oauth2 #1182

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

Merged
ZohebShaikh merged 5 commits into from
Sep 5, 2025
Merged

fix: Use alternative logout url for oauth2 #1182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1dde951
fix: Use alternative logout url for oauth2
ZohebShaikh Aug 28, 2025
ae6207c
Tweak the redirect url
ZohebShaikh Aug 29, 2025
2eb5b0c
Merge branch 'main' into logout-url-change
ZohebShaikh Aug 29, 2025
164c609
Merge branch 'main' into logout-url-change
ZohebShaikh Sep 5, 2025
5bca1ec
Merge branch 'main' into logout-url-change
ZohebShaikh Sep 5, 2025
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
6 changes: 4 additions & 2 deletions src/blueapi/service/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import logging
import urllib.parse
from collections.abc import Awaitable, Callable
from contextlib import asynccontextmanager
from enum import Enum
Expand Down Expand Up @@ -541,10 +542,11 @@ def logout(runner: Annotated[WorkerDispatcher, Depends(_runner)]) -> Response:
config = runner.run(interface.get_oidc_config)
if config is None or not config.logout_redirect_endpoint:
raise HTTPException(status_code=status.HTTP_205_RESET_CONTENT)

encoded_url = urllib.parse.quote_plus(config.end_session_endpoint)
return RedirectResponse(
status_code=status.HTTP_308_PERMANENT_REDIRECT,
url=config.logout_redirect_endpoint,
headers={"X-Auth-Request-Redirect": config.end_session_endpoint},
url=config.logout_redirect_endpoint.rstrip("/") + "?rd=" + encoded_url,
)


Expand Down
7 changes: 3 additions & 4 deletions tests/unit_tests/service/test_rest_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -734,16 +734,15 @@ def test_logout(
oidc_config: OIDCConfig,
client_with_auth: TestClient,
):
oidc_config.logout_redirect_endpoint = "/oauth2/logout"
oidc_config.logout_redirect_endpoint = "/oauth2/sign_out/"
mock_runner.run.return_value = oidc_config
client_with_auth.follow_redirects = False
response = client_with_auth.get("/logout")
assert response.status_code == status.HTTP_308_PERMANENT_REDIRECT
assert (
response.headers.get("X-Auth-Request-Redirect")
== oidc_config.end_session_endpoint
response.headers.get("location")
== "/oauth2/sign_out?rd=https%3A%2F%2Fexample.com%2Fend_session"
)
assert response.headers.get("location") == oidc_config.logout_redirect_endpoint


@pytest.mark.parametrize("has_oidc_config", [True, False])
Expand Down