Skip to content
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.

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

Update is_authorized_custom_view from auth manager to handle custom actions #39167

Merged
merged 1 commit into from
Apr 22, 2024
Merged
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
7 changes: 5 additions & 2 deletions airflow/auth/managers/base_auth_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ def is_authorized_view(

@abstractmethod
def is_authorized_custom_view(
self, *, method: ResourceMethod, resource_name: str, user: BaseUser | None = None
self, *, method: ResourceMethod | str, resource_name: str, user: BaseUser | None = None
):
"""
Return whether the user is authorized to perform a given action on a custom view.
Expand All @@ -246,7 +246,10 @@ def is_authorized_custom_view(
the auth manager is used as part of the environment. It can also be a view defined as part of a
plugin defined by a user.

:param method: the method to perform
:param method: the method to perform.
The method can also be a string if the action has been defined in a plugin.
In that case, the action can be anything (e.g. can_do).
See https://github.com/apache/airflow/issues/39144
:param resource_name: the name of the resource
:param user: the user to perform the action on. If not provided (or None), it uses the current user
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ def get_entity_type(resource_type: AvpEntities) -> str:
return AVP_PREFIX_ENTITIES + resource_type.value


def get_action_id(resource_type: AvpEntities, method: ResourceMethod):
def get_action_id(resource_type: AvpEntities, method: ResourceMethod | str):
"""
Return action id.

Expand Down
7 changes: 5 additions & 2 deletions airflow/providers/amazon/aws/auth_manager/avp/facade.py
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ def avp_policy_store_id(self):
def is_authorized(
self,
*,
method: ResourceMethod,
method: ResourceMethod | str,
entity_type: AvpEntities,
user: AwsAuthManagerUser | None,
entity_id: str | None = None,
Expand All @@ -86,7 +86,10 @@ def is_authorized(

Check whether the user has permissions to access given resource.

:param method: the method to perform
:param method: the method to perform.
The method can also be a string if the action has been defined in a plugin.
In that case, the action can be anything (e.g. can_do).
See https://github.com/apache/airflow/issues/39144
:param entity_type: the entity type the user accesses
:param user: the user
:param entity_id: the entity ID the user accesses. If not provided, all entities of the type will be
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ def is_authorized_view(
)

def is_authorized_custom_view(
self, *, method: ResourceMethod, resource_name: str, user: BaseUser | None = None
self, *, method: ResourceMethod | str, resource_name: str, user: BaseUser | None = None
):
return self.avp_facade.is_authorized(
method=method,
Expand Down
7 changes: 5 additions & 2 deletions airflow/providers/fab/auth_manager/fab_auth_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -268,11 +268,14 @@ def is_authorized_view(self, *, access_view: AccessView, user: BaseUser | None =
)

def is_authorized_custom_view(
self, *, method: ResourceMethod, resource_name: str, user: BaseUser | None = None
self, *, method: ResourceMethod | str, resource_name: str, user: BaseUser | None = None
):
if not user:
user = self.get_user()
fab_action_name = get_fab_action_from_method_map()[method]
if method in get_fab_action_from_method_map():
fab_action_name = get_fab_action_from_method_map()[method]
else:
fab_action_name = method
return (fab_action_name, resource_name) in self._get_user_permissions(user)

@provide_session
Expand Down
2 changes: 1 addition & 1 deletion tests/auth/managers/test_base_auth_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ def is_authorized_view(self, *, access_view: AccessView, user: BaseUser | None =
raise NotImplementedError()

def is_authorized_custom_view(
self, *, method: ResourceMethod, resource_name: str, user: BaseUser | None = None
self, *, method: ResourceMethod | str, resource_name: str, user: BaseUser | None = None
):
raise NotImplementedError()

Expand Down
13 changes: 12 additions & 1 deletion tests/providers/fab/auth_manager/test_fab_auth_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -392,10 +392,21 @@ def test_is_authorized_view(self, access_view, user_permissions, expected_result
[(ACTION_CAN_READ, "custom_resource2")],
False,
),
(
"DUMMY",
"custom_resource",
[("DUMMY", "custom_resource")],
True,
),
],
)
def test_is_authorized_custom_view(
self, method: ResourceMethod, resource_name: str, user_permissions, expected_result, auth_manager
self,
method: ResourceMethod | str,
resource_name: str,
user_permissions,
expected_result,
auth_manager,
):
user = Mock()
user.perms = user_permissions
Expand Down