You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "vincbeck (via GitHub)" <gi...@apache.org> on 2025/12/09 16:57:55 UTC
[PR] Create `create_token` method in FAB auth manager [airflow]
vincbeck opened a new pull request, #59245:
URL: https://github.com/apache/airflow/pull/59245
Resolves #51362.
As mentioned in #51362, some users are frustrated because the way to generate a JWT token to call Airflow public API is not customizable like it used to be in Airflow 2. Some deployment managers want to allow users to use oauth to generate a token whereas the current implementation force them to use basic authentication.
Auth backends no longer exist in Airflow 3 but we need to find an alternative so that deployment managers can set their own logic in regards to JWT token generation to call Airflow API.
The solution is to create a new method in FAB auth manager `create_token`. This method is called to generate a token from the create token API payload. Therefore, if a deployment manager wants to customize the way users are able to authenticate in order to generate a JWT token, they only need to override this new method.
<!--
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.
-->
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
<!-- Please keep an empty line above the dashes. -->
---
**^ Add meaningful description above**
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)** for more information.
In case of fundamental code changes, an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in a newsfragment file, named `{pr_number}.significant.rst` or `{issue_number}.significant.rst`, in [airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Create `create_token` method in FAB auth manager [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk merged PR #59245:
URL: https://github.com/apache/airflow/pull/59245
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Create `create_token` method in FAB auth manager [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on PR #59245:
URL: https://github.com/apache/airflow/pull/59245#issuecomment-3638379089
He he ... and report in https://github.com/apache/airflow/issues/59259 :)
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Create `create_token` method in FAB auth manager [airflow]
Posted by "vincbeck (via GitHub)" <gi...@apache.org>.
vincbeck commented on PR #59245:
URL: https://github.com/apache/airflow/pull/59245#issuecomment-3633920440
Nice! This will be usable right away then!
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Create `create_token` method in FAB auth manager [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on PR #59245:
URL: https://github.com/apache/airflow/pull/59245#issuecomment-3633907025
I will include it in the current provider's wave :)
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Create `create_token` method in FAB auth manager [airflow]
Posted by "vincbeck (via GitHub)" <gi...@apache.org>.
vincbeck commented on PR #59245:
URL: https://github.com/apache/airflow/pull/59245#issuecomment-3637316193
> Oh just discovered this problem today in the process in making Airflow 3 in our environment running, @wolfdn just discovered this... thanks @vincbeck for re-adding, if not already fixed this would have been a blocker.
For sure, please let me know if you run into issues while doing the migration
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Create `create_token` method in FAB auth manager [airflow]
Posted by "jscheffl (via GitHub)" <gi...@apache.org>.
jscheffl commented on code in PR #59245:
URL: https://github.com/apache/airflow/pull/59245#discussion_r2714245315
##########
providers/fab/src/airflow/providers/fab/auth_manager/fab_auth_manager.py:
##########
@@ -299,6 +300,32 @@ def is_logged_in(self) -> bool:
or (not user.is_anonymous and user.is_active)
)
+ def create_token(self, headers: dict[str, str], body: dict[str, Any]) -> User:
+ """
+ Create a new token from a payload.
+
+ By default, it uses basic authentication (username and password).
+ Override this method to use a different authentication method (e.g. oauth).
+
+ :param headers: request headers
+ :param body: request body
+ """
+ if not body.get("username") or not body.get("password"):
+ raise ValueError("Username and password must be provided")
+
+ user: User | None = None
+
+ if self.security_manager.auth_type == AUTH_LDAP:
+ user = self.security_manager.auth_user_ldap(
+ body["username"], body["password"], rotate_session_id=False
+ )
+ if user is None:
+ user = self.security_manager.auth_user_db(
+ body["username"], body["password"], rotate_session_id=False
+ )
+
+ return user
Review Comment:
@vincbeck I was stumbling aver this today, I assume the type definition is not correct in the signature? I would assume the function returns `User | None` if user is not found as it then does not raise an exception?
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Create `create_token` method in FAB auth manager [airflow]
Posted by "jscheffl (via GitHub)" <gi...@apache.org>.
jscheffl commented on PR #59245:
URL: https://github.com/apache/airflow/pull/59245#issuecomment-3636957982
Oh just discovered this problem today in the process in making Airflow 3 in our environment running, @wolfdn just discovered this... thanks @vincbeck for re-adding, if not already fixed this would have been a blocker.
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Create `create_token` method in FAB auth manager [airflow]
Posted by "vincbeck (via GitHub)" <gi...@apache.org>.
vincbeck commented on code in PR #59245:
URL: https://github.com/apache/airflow/pull/59245#discussion_r2714352597
##########
providers/fab/src/airflow/providers/fab/auth_manager/fab_auth_manager.py:
##########
@@ -299,6 +300,32 @@ def is_logged_in(self) -> bool:
or (not user.is_anonymous and user.is_active)
)
+ def create_token(self, headers: dict[str, str], body: dict[str, Any]) -> User:
+ """
+ Create a new token from a payload.
+
+ By default, it uses basic authentication (username and password).
+ Override this method to use a different authentication method (e.g. oauth).
+
+ :param headers: request headers
+ :param body: request body
+ """
+ if not body.get("username") or not body.get("password"):
+ raise ValueError("Username and password must be provided")
+
+ user: User | None = None
+
+ if self.security_manager.auth_type == AUTH_LDAP:
+ user = self.security_manager.auth_user_ldap(
+ body["username"], body["password"], rotate_session_id=False
+ )
+ if user is None:
+ user = self.security_manager.auth_user_db(
+ body["username"], body["password"], rotate_session_id=False
+ )
+
+ return user
Review Comment:
You are correct :)
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org