You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Clarify security model of Airflow
There are some assumptions that security researchers and our users
might have about security model of Airflow that do not hold true,
but were not clearly spelled out in the model.
This PR updates the security model with more clarity for those.
* Apply suggestions from code review
Co-authored-by: Amogh Desai <amoghrajesh1999@gmail.com>
---------
Co-authored-by: Amogh Desai <amoghrajesh1999@gmail.com>
Copy file name to clipboardExpand all lines: airflow-core/docs/security/security_model.rst
+44-7Lines changed: 44 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -78,7 +78,10 @@ Non-authenticated UI users
78
78
..........................
79
79
80
80
Airflow doesn't support unauthenticated users by default. If allowed, potential vulnerabilities
81
-
must be assessed and addressed by the Deployment Manager. However, there are exceptions to this. The ``/health`` endpoint responsible to get health check updates should be publicly accessible. This is because other systems would want to retrieve that information. Another exception is the ``/login`` endpoint, as the users are expected to be unauthenticated to use it.
81
+
must be assessed and addressed by the Deployment Manager. However, there are exceptions to this.
82
+
The ``/health`` endpoint responsible to get health check updates should be publicly accessible.
83
+
This is because other systems would want to retrieve that information. Another exception is the
84
+
``/login`` endpoint, as the users are expected to be unauthenticated to use it.
82
85
83
86
Capabilities of authenticated UI users
84
87
--------------------------------------
@@ -109,7 +112,8 @@ Operations users
109
112
................
110
113
111
114
The primary difference between an operator and admin is the ability to manage and grant permissions
112
-
to other users, and access audit logs - only admins are able to do this. Otherwise assume they have the same access as an admin.
115
+
to other users, and access audit logs - only admins are able to do this. Otherwise assume they have
116
+
the same access as an admin.
113
117
114
118
Connection configuration users
115
119
..............................
@@ -137,9 +141,12 @@ Those users should be highly trusted not to misuse this capability.
137
141
About Sensitive information
138
142
...........................
139
143
140
-
Sensitive information consists of connection details, variables, and configuration. In Airflow 3 and later versions, sensitive information will not be exposed to users via API, UI, ``airflowctl``.
141
-
However, ``task-sdk`` still provides access to sensitive information (e.g., Use SDK API Client to get Variables with task-specific ``JWT`` token). Local CLI will only return keys except when using ``--show_values``.
142
-
Sensitive information has been masked in logs, UI, and API outputs. In case of Dag author expose sensitive information in other way (e.g., via environment variables), those values will not be masked.
144
+
Sensitive information consists of connection details, variables, and configuration. In versions later than Airflow 3.0
145
+
sensitive information will not be exposed to users via API, UI, and ``airflowctl``.
146
+
However, ``task-sdk`` still provides access to sensitive information (e.g., Use SDK API Client to get
147
+
Variables with task-specific ``JWT`` token). Local CLI will only return keys except when using ``--show_values``.
148
+
Sensitive information has been masked in logs, UI, and API outputs. In case of Dag author expose sensitive
149
+
information in other way (e.g., via environment variables), those values will not be masked.
143
150
144
151
Audit log users
145
152
...............
@@ -160,7 +167,8 @@ This role is suitable for users who require read-only access without the ability
160
167
161
168
Viewers also do not have permission to access audit logs.
162
169
163
-
For more information on the capabilities of authenticated UI users, see :doc:`apache-airflow-providers-fab:auth-manager/access-control`.
170
+
For more information on the capabilities of authenticated UI users, see
0 commit comments