Skip to content

Remove permissions to read Configurations for User and Viewer roles #14067

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

Merged
merged 1 commit into from
Feb 4, 2021
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
11 changes: 11 additions & 0 deletions UPDATING.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,17 @@ https://developers.google.com/style/inclusive-documentation

-->

### Permission to view Airflow Configurations has been removed from `User` and `Viewer` role

Previously, Users with `User` or `Viewer` role were able to get/view configurations using
the REST API or in the Webserver. From Airflow 2.0.1, only users with `Admin` or `Op` role would be able
to get/view Configurations.

To allow users with other roles to view configuration, add `can read on Configurations` permissions to that role.

Note that if `[webserver] expose_config` is set to `False`, the API will throw a `403` response even if
the user has role with `can read on Configurations` permission.

### Default `[celery] worker_concurrency` is changed to `16`

The default value for `[celery] worker_concurrency` was `16` for Airflow <2.0.0.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
#
# 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.

"""Remove can_read permission on config resource for User and Viewer role

Revision ID: 82b7c48c147f
Revises: 449b4072c2da
Create Date: 2021-02-04 12:45:58.138224

"""

from airflow.security import permissions
from airflow.www.app import create_app

# revision identifiers, used by Alembic.
revision = '82b7c48c147f'
down_revision = '449b4072c2da'
branch_labels = None
depends_on = None


def upgrade():
"""Remove can_read permission on config resource for User and Viewer role"""
appbuilder = create_app(config={'FAB_UPDATE_PERMS': False}).appbuilder
roles_to_modify = [role for role in appbuilder.sm.get_all_roles() if role.name in ["User", "Viewer"]]
can_read_on_config_perm = appbuilder.sm.find_permission_view_menu(
permissions.ACTION_CAN_READ, permissions.RESOURCE_CONFIG
)

for role in roles_to_modify:
if appbuilder.sm.exist_permission_on_roles(
permissions.RESOURCE_CONFIG, permissions.ACTION_CAN_READ, [role.id]
):
appbuilder.sm.del_permission_role(role, can_read_on_config_perm)


def downgrade():
"""Add can_read permission on config resource for User and Viewer role"""
appbuilder = create_app(config={'FAB_UPDATE_PERMS': False}).appbuilder
roles_to_modify = [role for role in appbuilder.sm.get_all_roles() if role.name in ["User", "Viewer"]]
can_read_on_config_perm = appbuilder.sm.find_permission_view_menu(
permissions.ACTION_CAN_READ, permissions.RESOURCE_CONFIG
)

for role in roles_to_modify:
if not appbuilder.sm.exist_permission_on_roles(
permissions.RESOURCE_CONFIG, permissions.ACTION_CAN_READ, [role.id]
):
appbuilder.sm.add_permission_role(role, can_read_on_config_perm)
2 changes: 1 addition & 1 deletion airflow/www/security.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ class AirflowSecurityManager(SecurityManager, LoggingMixin): # pylint: disable=

# [START security_viewer_perms]
VIEWER_PERMISSIONS = [
(permissions.ACTION_CAN_READ, permissions.RESOURCE_CONFIG),
(permissions.ACTION_CAN_READ, permissions.RESOURCE_DAG),
(permissions.ACTION_CAN_READ, permissions.RESOURCE_DAG_CODE),
(permissions.ACTION_CAN_READ, permissions.RESOURCE_DAG_RUN),
Expand Down Expand Up @@ -103,6 +102,7 @@ class AirflowSecurityManager(SecurityManager, LoggingMixin): # pylint: disable=

# [START security_op_perms]
OP_PERMISSIONS = [
(permissions.ACTION_CAN_READ, permissions.RESOURCE_CONFIG),
(permissions.ACTION_CAN_ACCESS_MENU, permissions.RESOURCE_ADMIN_MENU),
(permissions.ACTION_CAN_ACCESS_MENU, permissions.RESOURCE_CONNECTION),
(permissions.ACTION_CAN_ACCESS_MENU, permissions.RESOURCE_POOL),
Expand Down
2 changes: 1 addition & 1 deletion docs/apache-airflow/security/access-control.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ Stable API Permissions
------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Endpoint Method Permissions Minimum Role
================================================================================== ====== ================================================================= ============
/config GET Configurations.can_read Viewer
/config GET Configurations.can_read Op
/connections GET Connections.can_read Op
/connections POST Connections.can_create Op
/connections/{connection_id} DELETE Connections.can_delete Op
Expand Down
17 changes: 16 additions & 1 deletion tests/www/test_security.py
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,6 @@ def test_get_user_roles(self):

def test_get_user_roles_for_anonymous_user(self):
viewer_role_perms = {
(permissions.ACTION_CAN_READ, permissions.RESOURCE_CONFIG),
(permissions.ACTION_CAN_READ, permissions.RESOURCE_DAG),
(permissions.ACTION_CAN_READ, permissions.RESOURCE_DAG_CODE),
(permissions.ACTION_CAN_READ, permissions.RESOURCE_DAG_RUN),
Expand Down Expand Up @@ -527,3 +526,19 @@ def test_override_role_vm(self):
test_security_manager = MockSecurityManager(appbuilder=self.appbuilder)
assert len(test_security_manager.VIEWER_VMS) == 1
assert test_security_manager.VIEWER_VMS == {'Airflow'}

def test_correct_roles_have_perms_to_read_config(self):
roles_to_check = self.security_manager.get_all_roles()
assert len(roles_to_check) >= 5
for role in roles_to_check:
if role.name in ["Admin", "Op"]:
assert self.security_manager.exist_permission_on_roles(
permissions.RESOURCE_CONFIG, permissions.ACTION_CAN_READ, [role.id]
)
else:
assert not self.security_manager.exist_permission_on_roles(
permissions.RESOURCE_CONFIG, permissions.ACTION_CAN_READ, [role.id]
), (
f"{role.name} should not have {permissions.ACTION_CAN_READ} "
f"on {permissions.RESOURCE_CONFIG}"
)