bugraoz93 commented on code in PR #51657: URL: https://github.com/apache/airflow/pull/51657#discussion_r2175529014
########## providers/keycloak/src/airflow/providers/keycloak/auth_manager/middleware.py: ########## @@ -0,0 +1,72 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +from __future__ import annotations + +from typing import TYPE_CHECKING, Any +from urllib.parse import urlencode + +from jwt import ExpiredSignatureError, InvalidTokenError +from starlette.middleware.base import BaseHTTPMiddleware + +from airflow.api_fastapi.auth.managers.base_auth_manager import COOKIE_NAME_JWT_TOKEN +from airflow.configuration import conf + +if TYPE_CHECKING: + from fastapi import Request + + +class KeycloakRefreshTokenMiddleware(BaseHTTPMiddleware): + """Middleware that automatically refreshes the Keycloak token if it is expired.""" + + def __init__(self, app: Any, auth_manager: Any) -> None: + """ + Initialize the middleware with app and auth manager. + + :param app: The FastAPI application + :param auth_manager: The KeycloakAuthManager instance + """ + super().__init__(app) + self.auth_manager = auth_manager + + async def dispatch(self, request: Request, call_next): + """Refresh the token if it is expired.""" + try: + return await call_next(request) + except (InvalidTokenError, ExpiredSignatureError): + code = None + if "code" in request.query_params: Review Comment: All clear, thanks for the discussion and comments! * Expose an API endpoint * UI calls the endpoint when the token has expired error is obtained * Remove middleware * Call refresh token from exposed endpoint * Return token to UI, which updates local storage I will follow up with this soon Bonus could be an additional endpoint to check if the token is valid because this will always be on the auth manager side and will not be directly available to the API without calling an additional endpoint, such as in this case, the Keycloak introspect method. This can tell UI to understand if the token has expired on the backend (not internal JWT). Since this will be available in the auth manager, it is easier to expose to the UI. It would also help automations to understand that their token needs a refresh. Since this will be publicly available, I thought it could be a good addition. What do you think? ########## providers/keycloak/src/airflow/providers/keycloak/auth_manager/middleware.py: ########## @@ -0,0 +1,72 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +from __future__ import annotations + +from typing import TYPE_CHECKING, Any +from urllib.parse import urlencode + +from jwt import ExpiredSignatureError, InvalidTokenError +from starlette.middleware.base import BaseHTTPMiddleware + +from airflow.api_fastapi.auth.managers.base_auth_manager import COOKIE_NAME_JWT_TOKEN +from airflow.configuration import conf + +if TYPE_CHECKING: + from fastapi import Request + + +class KeycloakRefreshTokenMiddleware(BaseHTTPMiddleware): + """Middleware that automatically refreshes the Keycloak token if it is expired.""" + + def __init__(self, app: Any, auth_manager: Any) -> None: + """ + Initialize the middleware with app and auth manager. + + :param app: The FastAPI application + :param auth_manager: The KeycloakAuthManager instance + """ + super().__init__(app) + self.auth_manager = auth_manager + + async def dispatch(self, request: Request, call_next): + """Refresh the token if it is expired.""" + try: + return await call_next(request) + except (InvalidTokenError, ExpiredSignatureError): + code = None + if "code" in request.query_params: Review Comment: All clear, thanks for the discussion and comments! I will follow up with this soon * Expose an API endpoint * UI calls the endpoint when the token has expired error is obtained * Remove middleware * Call refresh token from exposed endpoint * Return token to UI, which updates local storage Bonus could be an additional endpoint to check if the token is valid because this will always be on the auth manager side and will not be directly available to the API without calling an additional endpoint, such as in this case, the Keycloak introspect method. This can tell UI to understand if the token has expired on the backend (not internal JWT). Since this will be available in the auth manager, it is easier to expose to the UI. It would also help automations to understand that their token needs a refresh. Since this will be publicly available, I thought it could be a good addition. What do you think? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
