This is an automated email from the ASF dual-hosted git repository.
vincbeck pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new fff91b39504 Redirect to the requested page after Keycloak login
(#76362)
fff91b39504 is described below
commit fff91b395042cc4ee49e494b13dae6a30fa8f78b
Author: Imad Rezgui <[email protected]>
AuthorDate: Mon Nov 16 20:33:56 2026 +0100
Redirect to the requested page after Keycloak login (#76362)
The Keycloak auth manager dropped the `next` URL that core passes to
`/auth/login`, so after signing in users always landed on the home page
instead of the Dag or log they had opened.
Keep a safe `next` URL in a short-lived httponly cookie during the OAuth
round trip and redirect to it from the login callback, falling back to
`[api] base_url`. Also make `get_url_login()` honour `next_url`, as the
Simple and FAB auth managers do.
---
.../providers/keycloak/auth_manager/constants.py | 1 +
.../keycloak/auth_manager/keycloak_auth_manager.py | 7 +-
.../keycloak/auth_manager/routes/login.py | 22 ++++-
.../keycloak/auth_manager/routes/test_login.py | 103 +++++++++++++++++++++
.../auth_manager/test_keycloak_auth_manager.py | 4 +
5 files changed, 134 insertions(+), 3 deletions(-)
diff --git
a/providers/keycloak/src/airflow/providers/keycloak/auth_manager/constants.py
b/providers/keycloak/src/airflow/providers/keycloak/auth_manager/constants.py
index 262166de5b6..74d76861890 100644
---
a/providers/keycloak/src/airflow/providers/keycloak/auth_manager/constants.py
+++
b/providers/keycloak/src/airflow/providers/keycloak/auth_manager/constants.py
@@ -34,5 +34,6 @@ CONF_JWT_FEDERATED_CLIENT_IDS_KEY = "jwt_federated_client_ids"
# Extra Cookie names
COOKIE_NAME_ACCESS_TOKEN = "_access_token"
COOKIE_NAME_ID_TOKEN = "_id_token"
+COOKIE_NAME_LOGIN_NEXT_URL = "_login_next_url"
COOKIE_NAME_OAUTH_STATE = "_oauth_state"
COOKIE_NAME_REFRESH_TOKEN = "_refresh_token"
diff --git
a/providers/keycloak/src/airflow/providers/keycloak/auth_manager/keycloak_auth_manager.py
b/providers/keycloak/src/airflow/providers/keycloak/auth_manager/keycloak_auth_manager.py
index 9d809f3973a..d7dbef4398f 100644
---
a/providers/keycloak/src/airflow/providers/keycloak/auth_manager/keycloak_auth_manager.py
+++
b/providers/keycloak/src/airflow/providers/keycloak/auth_manager/keycloak_auth_manager.py
@@ -25,7 +25,7 @@ from base64 import urlsafe_b64decode
from collections.abc import Sequence
from concurrent.futures import ThreadPoolExecutor
from typing import TYPE_CHECKING, Any, cast
-from urllib.parse import urljoin
+from urllib.parse import urlencode, urljoin
import requests
from fastapi import FastAPI
@@ -229,7 +229,10 @@ class
KeycloakAuthManager(BaseAuthManager[KeycloakAuthManagerUser]):
def get_url_login(self, **kwargs) -> str:
base_url = conf.get("api", "base_url", fallback="/")
- return urljoin(base_url, f"{AUTH_MANAGER_FASTAPI_APP_PREFIX}/login")
+ login_url = urljoin(base_url,
f"{AUTH_MANAGER_FASTAPI_APP_PREFIX}/login")
+ if next_url := kwargs.get("next_url"):
+ return f"{login_url}?{urlencode({'next': next_url})}"
+ return login_url
def get_url_logout(self) -> str | None:
base_url = conf.get("api", "base_url", fallback="/")
diff --git
a/providers/keycloak/src/airflow/providers/keycloak/auth_manager/routes/login.py
b/providers/keycloak/src/airflow/providers/keycloak/auth_manager/routes/login.py
index 3040bb16c5d..4408a12304a 100644
---
a/providers/keycloak/src/airflow/providers/keycloak/auth_manager/routes/login.py
+++
b/providers/keycloak/src/airflow/providers/keycloak/auth_manager/routes/login.py
@@ -50,10 +50,12 @@ except ImportError:
from airflow.api_fastapi.common.router import AirflowRouter
+from airflow.api_fastapi.core_api.security import is_safe_url
from airflow.providers.common.compat.sdk import conf
from airflow.providers.keycloak.auth_manager.constants import (
COOKIE_NAME_ACCESS_TOKEN,
COOKIE_NAME_ID_TOKEN,
+ COOKIE_NAME_LOGIN_NEXT_URL,
COOKIE_NAME_OAUTH_STATE,
COOKIE_NAME_REFRESH_TOKEN,
)
@@ -93,6 +95,20 @@ def login(request: Request) -> RedirectResponse:
response.set_cookie(
COOKIE_NAME_OAUTH_STATE, state, max_age=300, path=cookie_path,
httponly=True, secure=secure
)
+ # Remember where the user was going so the callback can send them back
there
+ next_url = request.query_params.get("next")
+ if next_url and is_safe_url(next_url, request=request):
+ response.set_cookie(
+ COOKIE_NAME_LOGIN_NEXT_URL,
+ next_url,
+ max_age=300,
+ path=cookie_path,
+ httponly=True,
+ secure=secure,
+ )
+ else:
+ # Do not let a target left over from an earlier, unfinished login be
used
+ response.delete_cookie(COOKIE_NAME_LOGIN_NEXT_URL, path=cookie_path,
httponly=True, secure=secure)
return response
@@ -128,7 +144,10 @@ def login_callback(request: Request):
token = get_auth_manager().generate_jwt(user)
request.state.jwt_token_issued = True
- response = RedirectResponse(url=conf.get("api", "base_url", fallback="/"),
status_code=303)
+ fallback_url = conf.get("api", "base_url", fallback="/")
+ next_url = request.cookies.get(COOKIE_NAME_LOGIN_NEXT_URL)
+ redirect_url = next_url if next_url and is_safe_url(next_url,
request=request) else fallback_url
+ response = RedirectResponse(url=redirect_url, status_code=303)
secure = request.base_url.scheme == "https" or bool(conf.get("api",
"ssl_cert", fallback=""))
# In Airflow 3.1.1 authentication changes, front-end no longer handle the
token
# See https://github.com/apache/airflow/pull/55506
@@ -158,6 +177,7 @@ def login_callback(request: Request):
httponly=True,
)
+ response.delete_cookie(COOKIE_NAME_LOGIN_NEXT_URL, path=cookie_path,
secure=secure, httponly=True)
return response
diff --git
a/providers/keycloak/tests/unit/keycloak/auth_manager/routes/test_login.py
b/providers/keycloak/tests/unit/keycloak/auth_manager/routes/test_login.py
index bfe9b852b8c..b579e5f0cd3 100644
--- a/providers/keycloak/tests/unit/keycloak/auth_manager/routes/test_login.py
+++ b/providers/keycloak/tests/unit/keycloak/auth_manager/routes/test_login.py
@@ -16,6 +16,7 @@
# under the License.
from __future__ import annotations
+from http.cookies import SimpleCookie
from unittest.mock import ANY, Mock, patch
import pytest
@@ -211,6 +212,108 @@ class TestLoginRouter:
== "https://airflow.example.com" + AUTH_MANAGER_FASTAPI_APP_PREFIX
+ "/login_callback"
)
+ @pytest.mark.parametrize(
+ "next_url",
+ [
+ "/dags/my_dag",
+
"/dags/my_dag/runs/scheduled__2026-11-03T06:30:00+00:00/tasks/my_task?try_number=2",
+ "http://testserver/dags/my_dag",
+ ],
+ )
+
@patch("airflow.providers.keycloak.auth_manager.routes.login.KeycloakAuthManager.get_keycloak_client")
+ def test_login_stores_safe_next_url(self, mock_get_keycloak_client,
next_url, client):
+ mock_keycloak_client = Mock()
+ mock_keycloak_client.auth_url.return_value = "redirect_url"
+ mock_get_keycloak_client.return_value = mock_keycloak_client
+ response = client.get(
+ AUTH_MANAGER_FASTAPI_APP_PREFIX + "/login",
+ params={"next": next_url},
+ follow_redirects=False,
+ )
+ assert response.status_code == 307
+ set_cookies = [c for c in response.headers.get_list("set-cookie") if
c.startswith("_login_next_url=")]
+ assert len(set_cookies) == 1
+ cookie = SimpleCookie(set_cookies[0])["_login_next_url"]
+ assert cookie.value == next_url
+ assert cookie["httponly"]
+ assert cookie["max-age"] == "300"
+
+ @pytest.mark.parametrize(
+ "next_url",
+ [
+ "https://attacker.example.net/dags",
+ "//attacker.example.net/dags",
+ "javascript:alert(1)",
+ ],
+ )
+
@patch("airflow.providers.keycloak.auth_manager.routes.login.KeycloakAuthManager.get_keycloak_client")
+ def test_login_does_not_store_unsafe_next_url(self,
mock_get_keycloak_client, next_url, client):
+ mock_keycloak_client = Mock()
+ mock_keycloak_client.auth_url.return_value = "redirect_url"
+ mock_get_keycloak_client.return_value = mock_keycloak_client
+ response = client.get(
+ AUTH_MANAGER_FASTAPI_APP_PREFIX + "/login",
+ params={"next": next_url},
+ follow_redirects=False,
+ )
+ assert response.status_code == 307
+ assert "_login_next_url" not in response.cookies
+
+
@patch("airflow.providers.keycloak.auth_manager.routes.login.KeycloakAuthManager.get_keycloak_client")
+ def test_login_without_next_url_clears_previous_next_url(self,
mock_get_keycloak_client, client):
+ mock_keycloak_client = Mock()
+ mock_keycloak_client.auth_url.return_value = "redirect_url"
+ mock_get_keycloak_client.return_value = mock_keycloak_client
+ response = client.get(
+ AUTH_MANAGER_FASTAPI_APP_PREFIX + "/login",
+ cookies={"_login_next_url": "/dags/stale_dag"},
+ follow_redirects=False,
+ )
+ set_cookies = response.headers.get_list("set-cookie")
+ assert any(c.startswith('_login_next_url=""') and "Max-Age=0" in c for
c in set_cookies)
+
+ @pytest.mark.parametrize(
+ ("next_url_cookie", "expected_location"),
+ [
+ ("/dags/my_dag/runs/run_id/tasks/my_task",
"/dags/my_dag/runs/run_id/tasks/my_task"),
+ (None, "/"),
+ ("https://attacker.example.net/dags", "/"),
+ ],
+ )
+
@patch("airflow.providers.keycloak.auth_manager.routes.login.get_auth_manager")
+
@patch("airflow.providers.keycloak.auth_manager.routes.login.KeycloakAuthManager.get_keycloak_client")
+ def test_login_callback_redirects_to_next_url(
+ self, mock_get_keycloak_client, mock_get_auth_manager,
next_url_cookie, expected_location, client
+ ):
+ state = "state"
+ mock_keycloak_client = Mock()
+ mock_keycloak_client.token.return_value = {
+ "access_token": "access_token",
+ "refresh_token": "refresh_token",
+ "id_token": "id_token",
+ }
+ mock_keycloak_client.userinfo.return_value = {
+ "sub": "sub",
+ "preferred_username": "preferred_username",
+ }
+ mock_get_keycloak_client.return_value = mock_keycloak_client
+ mock_auth_manager = Mock()
+ mock_get_auth_manager.return_value = mock_auth_manager
+ mock_auth_manager.generate_jwt.return_value = "token"
+ cookies = {"_oauth_state": state}
+ if next_url_cookie:
+ cookies["_login_next_url"] = next_url_cookie
+ response = client.get(
+ AUTH_MANAGER_FASTAPI_APP_PREFIX +
f"/login_callback?code=code&state={state}",
+ follow_redirects=False,
+ cookies=cookies,
+ )
+ assert response.status_code == 303
+ assert response.headers["location"] == expected_location
+ assert response.cookies["_token"] == "token"
+ set_cookies = response.headers.get_list("set-cookie")
+ assert any(c.startswith('_login_next_url=""') and "Max-Age=0" in c for
c in set_cookies)
+
def test_login_callback_without_code(self, client):
response = client.get(AUTH_MANAGER_FASTAPI_APP_PREFIX +
"/login_callback")
assert response.status_code == 400
diff --git
a/providers/keycloak/tests/unit/keycloak/auth_manager/test_keycloak_auth_manager.py
b/providers/keycloak/tests/unit/keycloak/auth_manager/test_keycloak_auth_manager.py
index ece785dea1b..c994c6071c5 100644
---
a/providers/keycloak/tests/unit/keycloak/auth_manager/test_keycloak_auth_manager.py
+++
b/providers/keycloak/tests/unit/keycloak/auth_manager/test_keycloak_auth_manager.py
@@ -372,6 +372,10 @@ class TestKeycloakAuthManager:
result = auth_manager.get_url_login()
assert result == f"{AUTH_MANAGER_FASTAPI_APP_PREFIX}/login"
+ def test_get_url_login_with_next_url(self, auth_manager):
+ result = auth_manager.get_url_login(next_url="/dags/my_dag?tab=grid")
+ assert result ==
f"{AUTH_MANAGER_FASTAPI_APP_PREFIX}/login?next=%2Fdags%2Fmy_dag%3Ftab%3Dgrid"
+
def test_get_url_logout(self, auth_manager):
result = auth_manager.get_url_logout()
assert result == f"{AUTH_MANAGER_FASTAPI_APP_PREFIX}/logout"