[GitHub] XD-DENG commented on a change in pull request #4595: [AIRFLOW-XXX] Add a doc about fab security

[GitBox <gi...@apache.org>]

XD-DENG commented on a change in pull request #4595: [AIRFLOW-XXX] Add a doc about fab security
URL: https://github.com/apache/airflow/pull/4595#discussion_r251223958
 
 

 ##########
 File path: docs/fab_security.rst
 ##########
 @@ -0,0 +1,63 @@
+..  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.
+
+Airflow UI Security
+===================
+
+Security of Airflow Webserver UI is handled by Flask AppBuilder (FAB).
+Please read its related `security document <http://flask-appbuilder.readthedocs.io/en/latest/security.html>`_
+regarding its security model.
+
+Default Roles
+-------------
+Airflow ships with a set of roles by default: Admin, User, Op, Viewer, and Public.
+Only ``Admin`` users could configure/alter the permissions for other roles. But it is not recommended
+that ``Admin`` users alter these default roles in any way by removing
+or adding permissions to them as these roles will be re-synchronized to their original values.
+
+Admin
+"""""
+``Admin`` users have all possible rights, including granting or revoking rights from
+other users and altering other people's slices and dashboards.
+
+Public
+""""""
+``Public`` users(anonymous) don't have any rights.
+
+Viewer
+""""""
+``Viewer`` users have limited `viewer permissions <https://github.com/apache/airflow/blob/v1-10-stable/airflow/www_rbac/security.py#L77-L100>`_
+on limited `web views <https://github.com/apache/airflow/blob/v1-10-stable/airflow/www_rbac/security.py#L35-L53>`_.
+
+User
+""""
+``User`` users have ``Viewer`` permission plus additional `user permissions <https://github.com/apache/airflow/blob/v1-10-stable/airflow/www_rbac/security.py#L104-L118>`_
+on limited `user web views <https://github.com/apache/airflow/blob/v1-10-stable/airflow/www_rbac/security.py#L35-L53>`_.
+
+Op
+""
+``Op`` users have ``User`` permission plus additional `op permissions <https://github.com/apache/airflow/blob/v1-10-stable/airflow/www_rbac/security.py#L122-L123>`_
+on ``User``'s web views plus these additional `op web views <https://github.com/apache/airflow/blob/v1-10-stable/airflow/www_rbac/security.py#L59-L69>`_.
+
+Custom Roles
+------------
+
+DAG Level Role
+""""""""""""""
+``Admin`` can create a set of roles which are only allowed to view a certain set of dags. This is called DAG level access. Each dag defined in the dag model table
+is treated as a ``View`` which has two permissions associated with it(``can_dag_read`` and ``can_dag_edit``). There is a special view called ``all_dags`` which
 
 Review comment:
   There should be one space before the `(`?

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services