rusackas commented on code in PR #40669: URL: https://github.com/apache/superset/pull/40669#discussion_r3400613808
########## tests/unit_tests/security/test_password_change.py: ########## @@ -0,0 +1,214 @@ +# 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. + +from unittest.mock import MagicMock, patch + +import pytest + +from superset.security.password_change import ( + _get_user_attribute, + _is_exempt_endpoint, + password_change_required, +) + + [email protected]( + "endpoint,expected", + [ + (None, True), # static file serving etc. + ("ResetMyPasswordView.this_form_get", True), + ("AuthDBView.login", True), + ("AuthDBView.logout", True), + ("appbuilder.static", True), + ("UserInfoEditView.this_form_post", True), + ("AuthOAuthView.login", True), + ("SomeBlueprint.static", True), + ("health", True), + ("SupersetIndexView.index", False), + ("Superset.dashboard", False), + # Substring over-matching must NOT exempt these (they merely share a + # substring with an exempt token). + ("AuthorView.list", False), + ("HealthDashboardView.show", False), + ("StaticAssetReportView.list", False), + ("UserInfoFancyView.show", False), + ], +) +def test_is_exempt_endpoint(endpoint, expected) -> None: + # The password-reset / auth / static endpoints must stay reachable to avoid + # a redirect loop while a change is pending. + assert _is_exempt_endpoint(endpoint) is expected + + +def test_password_change_required() -> None: + user = MagicMock() + user.id = 5 + + with patch( + "superset.security.password_change._get_user_attribute" + ) as mock_get_attr: + mock_get_attr.return_value = MagicMock(password_must_change=True) + assert password_change_required(user) is True + + mock_get_attr.return_value = MagicMock(password_must_change=False) + assert password_change_required(user) is False + + mock_get_attr.return_value = None + assert password_change_required(user) is False + + +def test_password_change_required_no_user_id() -> None: + user = MagicMock() + user.id = None + assert password_change_required(user) is False + + +def test_get_user_attribute_deterministic_with_duplicates() -> None: + # The ``user_attribute`` table does not enforce uniqueness on ``user_id``, + # so duplicate rows are possible. The query must not raise (which + # ``.one_or_none()`` would have done via ``MultipleResultsFound``); it must + # fetch a single row deterministically via ``order_by(id).first()``. + query = MagicMock() + db = MagicMock() + db.session.query.return_value = query + query.filter.return_value = query + query.order_by.return_value = query + sentinel = MagicMock(name="first_row") + query.first.return_value = sentinel + + with ( + patch("superset.extensions.db", db), + patch("superset.models.user_attributes.UserAttribute") as user_attribute, + ): + result = _get_user_attribute(5) + + # Deterministic ordering on the primary key, then ``.first()`` — never + # ``.one_or_none()``, which could 500 on duplicate rows. + query.order_by.assert_called_once_with(user_attribute.id) + query.first.assert_called_once_with() + assert not query.one_or_none.called + assert result is sentinel + + [email protected] Review Comment: Annotated it as `Flask`. ########## tests/unit_tests/security/test_password_change.py: ########## @@ -0,0 +1,214 @@ +# 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. + +from unittest.mock import MagicMock, patch + +import pytest + +from superset.security.password_change import ( + _get_user_attribute, + _is_exempt_endpoint, + password_change_required, +) + + [email protected]( + "endpoint,expected", + [ + (None, True), # static file serving etc. + ("ResetMyPasswordView.this_form_get", True), + ("AuthDBView.login", True), + ("AuthDBView.logout", True), + ("appbuilder.static", True), + ("UserInfoEditView.this_form_post", True), + ("AuthOAuthView.login", True), + ("SomeBlueprint.static", True), + ("health", True), + ("SupersetIndexView.index", False), + ("Superset.dashboard", False), + # Substring over-matching must NOT exempt these (they merely share a + # substring with an exempt token). + ("AuthorView.list", False), + ("HealthDashboardView.show", False), + ("StaticAssetReportView.list", False), + ("UserInfoFancyView.show", False), + ], +) +def test_is_exempt_endpoint(endpoint, expected) -> None: + # The password-reset / auth / static endpoints must stay reachable to avoid + # a redirect loop while a change is pending. + assert _is_exempt_endpoint(endpoint) is expected + + +def test_password_change_required() -> None: + user = MagicMock() + user.id = 5 + + with patch( + "superset.security.password_change._get_user_attribute" + ) as mock_get_attr: + mock_get_attr.return_value = MagicMock(password_must_change=True) + assert password_change_required(user) is True + + mock_get_attr.return_value = MagicMock(password_must_change=False) + assert password_change_required(user) is False + + mock_get_attr.return_value = None + assert password_change_required(user) is False + + +def test_password_change_required_no_user_id() -> None: + user = MagicMock() + user.id = None + assert password_change_required(user) is False + + +def test_get_user_attribute_deterministic_with_duplicates() -> None: + # The ``user_attribute`` table does not enforce uniqueness on ``user_id``, + # so duplicate rows are possible. The query must not raise (which + # ``.one_or_none()`` would have done via ``MultipleResultsFound``); it must + # fetch a single row deterministically via ``order_by(id).first()``. + query = MagicMock() + db = MagicMock() + db.session.query.return_value = query + query.filter.return_value = query + query.order_by.return_value = query + sentinel = MagicMock(name="first_row") + query.first.return_value = sentinel + + with ( + patch("superset.extensions.db", db), + patch("superset.models.user_attributes.UserAttribute") as user_attribute, + ): + result = _get_user_attribute(5) + + # Deterministic ordering on the primary key, then ``.first()`` — never + # ``.one_or_none()``, which could 500 on duplicate rows. + query.order_by.assert_called_once_with(user_attribute.id) + query.first.assert_called_once_with() + assert not query.one_or_none.called + assert result is sentinel + + [email protected] +def enforcement_app(): + """A minimal Flask app with the enforcement hook registered and a flagged + user, used to exercise the before-request redirect behavior end to end.""" + from flask import Flask, g + + from superset.security.password_change import ( + register_password_change_enforcement, + ) + + app = Flask(__name__) + app.config["ENABLE_FORCE_PASSWORD_CHANGE"] = True + app.secret_key = "test" # noqa: S105 + + user = MagicMock() + user.id = 5 + user.is_anonymous = False + + @app.before_request + def _set_user() -> None: # pylint: disable=unused-variable + g.user = user + + # A non-exempt route that, if redirected to, would re-trigger enforcement. + @app.route("/") + def index() -> str: # pylint: disable=unused-variable + return "index" + + register_password_change_enforcement(app) + return app + + [email protected](autouse=True) Review Comment: Annotated as `Iterator[None]`. ########## tests/unit_tests/security/test_password_change.py: ########## @@ -0,0 +1,214 @@ +# 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. + +from unittest.mock import MagicMock, patch + +import pytest + +from superset.security.password_change import ( + _get_user_attribute, + _is_exempt_endpoint, + password_change_required, +) + + [email protected]( + "endpoint,expected", + [ + (None, True), # static file serving etc. + ("ResetMyPasswordView.this_form_get", True), + ("AuthDBView.login", True), + ("AuthDBView.logout", True), + ("appbuilder.static", True), + ("UserInfoEditView.this_form_post", True), + ("AuthOAuthView.login", True), + ("SomeBlueprint.static", True), + ("health", True), + ("SupersetIndexView.index", False), + ("Superset.dashboard", False), + # Substring over-matching must NOT exempt these (they merely share a + # substring with an exempt token). + ("AuthorView.list", False), + ("HealthDashboardView.show", False), + ("StaticAssetReportView.list", False), + ("UserInfoFancyView.show", False), + ], +) +def test_is_exempt_endpoint(endpoint, expected) -> None: + # The password-reset / auth / static endpoints must stay reachable to avoid + # a redirect loop while a change is pending. + assert _is_exempt_endpoint(endpoint) is expected + + +def test_password_change_required() -> None: + user = MagicMock() + user.id = 5 + + with patch( + "superset.security.password_change._get_user_attribute" + ) as mock_get_attr: + mock_get_attr.return_value = MagicMock(password_must_change=True) + assert password_change_required(user) is True + + mock_get_attr.return_value = MagicMock(password_must_change=False) + assert password_change_required(user) is False + + mock_get_attr.return_value = None + assert password_change_required(user) is False + + +def test_password_change_required_no_user_id() -> None: + user = MagicMock() + user.id = None + assert password_change_required(user) is False + + +def test_get_user_attribute_deterministic_with_duplicates() -> None: + # The ``user_attribute`` table does not enforce uniqueness on ``user_id``, + # so duplicate rows are possible. The query must not raise (which + # ``.one_or_none()`` would have done via ``MultipleResultsFound``); it must + # fetch a single row deterministically via ``order_by(id).first()``. + query = MagicMock() + db = MagicMock() + db.session.query.return_value = query + query.filter.return_value = query + query.order_by.return_value = query + sentinel = MagicMock(name="first_row") + query.first.return_value = sentinel + + with ( + patch("superset.extensions.db", db), + patch("superset.models.user_attributes.UserAttribute") as user_attribute, + ): + result = _get_user_attribute(5) + + # Deterministic ordering on the primary key, then ``.first()`` — never + # ``.one_or_none()``, which could 500 on duplicate rows. + query.order_by.assert_called_once_with(user_attribute.id) + query.first.assert_called_once_with() + assert not query.one_or_none.called + assert result is sentinel + + [email protected] +def enforcement_app(): + """A minimal Flask app with the enforcement hook registered and a flagged + user, used to exercise the before-request redirect behavior end to end.""" + from flask import Flask, g + + from superset.security.password_change import ( + register_password_change_enforcement, + ) + + app = Flask(__name__) + app.config["ENABLE_FORCE_PASSWORD_CHANGE"] = True + app.secret_key = "test" # noqa: S105 + + user = MagicMock() + user.id = 5 + user.is_anonymous = False + + @app.before_request + def _set_user() -> None: # pylint: disable=unused-variable + g.user = user + + # A non-exempt route that, if redirected to, would re-trigger enforcement. + @app.route("/") + def index() -> str: # pylint: disable=unused-variable + return "index" + + register_password_change_enforcement(app) + return app + + [email protected](autouse=True) +def _no_babel_flash(): + """The minimal test app has no babel/flash messaging set up; stub them so + the enforcement hook's translation + flash calls don't blow up. These are + incidental to the redirect-target logic under test.""" + with ( + patch("superset.security.password_change.flash"), + patch("superset.security.password_change.__", side_effect=lambda s: s), + ): + yield + + +def test_enforcement_redirects_to_reset_view(enforcement_app) -> None: Review Comment: Typed as `Flask` here and in the other two tests using the fixture. ########## superset/security/password_change.py: ########## @@ -0,0 +1,173 @@ +# 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. +"""Force-password-change-on-first-use enforcement. + +A per-user ``password_must_change`` flag (on ``UserAttribute``) marks accounts — +typically created by an administrator — that must set a new password before +they can use the rest of the application. When ``ENABLE_FORCE_PASSWORD_CHANGE`` +is enabled, a ``before_request`` hook redirects such users to the password-reset +page until they change it; the flag is cleared automatically on a successful +*self-service* password reset (see ``SupersetSecurityManager.reset_password``). +An admin-initiated reset deliberately preserves the flag so the target user is +still forced to change the temporary password at next login. +""" + +from __future__ import annotations + +import logging +from typing import Any, Optional + +from flask import current_app, flash, g, redirect, request, url_for +from flask_babel import gettext as __ + +from superset.utils.decorators import transaction + +logger = logging.getLogger(__name__) + +# Flask endpoints take the form ``<ViewClass>.<method>`` (or a bare name for +# function views). The following must remain reachable while a password change +# is pending, otherwise the redirect would loop: the auth views (login/logout +# for every auth backend), the password-reset and user-info-edit views, static +# assets, and the health check. We match the *view-class* component (the part +# before the dot) exactly against the allow-list below rather than doing a +# substring search, so unrelated endpoints that merely share a substring (e.g. +# an "Author"-named view, or any name containing "health"/"static") are not +# accidentally exempted from enforcement. +_EXEMPT_VIEW_CLASSES = frozenset( + { + "AuthDBView", + "AuthLDAPView", + "AuthOAuthView", + "AuthOIDView", + "AuthRemoteUserView", + "ResetMyPasswordView", + "ResetPasswordView", + "UserInfoEditView", + } +) + +# Exact endpoint names (function views / Flask built-ins) that are always exempt. +_EXEMPT_ENDPOINTS = frozenset({"static", "appbuilder.static", "health", "healthcheck"}) + + +def _get_user_attribute(user_id: int) -> Optional[Any]: + # Imported lazily to avoid import cycles at app-init time. + from superset.extensions import db + from superset.models.user_attributes import UserAttribute + + # The ``user_attribute`` table does not enforce uniqueness on ``user_id``, + # so a user could have more than one row. ``.one_or_none()`` would raise + # ``MultipleResultsFound`` (a 500) in that case; fetch deterministically by + # ordering on the primary key and taking the first row instead. + return ( + db.session.query(UserAttribute) + .filter(UserAttribute.user_id == user_id) + .order_by(UserAttribute.id) + .first() + ) + + +def password_change_required(user: Any) -> bool: + """Return True if ``user`` has a pending forced password change.""" + user_id = getattr(user, "id", None) + if not user_id: + return False + attr = _get_user_attribute(user_id) + return bool(attr and attr.password_must_change) + + +@transaction() +def set_password_must_change(user_id: int, value: bool = True) -> None: + """Set (or clear) the forced-password-change flag for a user. + + Intended to be called by administrative flows when provisioning an account + that should require a password change on first use. + """ + from superset.extensions import db + from superset.models.user_attributes import UserAttribute + + attr = _get_user_attribute(user_id) + if attr is None: + attr = UserAttribute(user_id=user_id) + db.session.add(attr) + attr.password_must_change = value Review Comment: Good catch... switched to the same nested-transaction upsert the session-invalidation code uses, so the loser of the race updates the winner's row instead of 500ing. ########## superset/security/password_change.py: ########## @@ -0,0 +1,173 @@ +# 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. +"""Force-password-change-on-first-use enforcement. + +A per-user ``password_must_change`` flag (on ``UserAttribute``) marks accounts — +typically created by an administrator — that must set a new password before +they can use the rest of the application. When ``ENABLE_FORCE_PASSWORD_CHANGE`` +is enabled, a ``before_request`` hook redirects such users to the password-reset +page until they change it; the flag is cleared automatically on a successful +*self-service* password reset (see ``SupersetSecurityManager.reset_password``). +An admin-initiated reset deliberately preserves the flag so the target user is +still forced to change the temporary password at next login. +""" + +from __future__ import annotations + +import logging +from typing import Any, Optional + +from flask import current_app, flash, g, redirect, request, url_for +from flask_babel import gettext as __ + +from superset.utils.decorators import transaction + +logger = logging.getLogger(__name__) + +# Flask endpoints take the form ``<ViewClass>.<method>`` (or a bare name for +# function views). The following must remain reachable while a password change +# is pending, otherwise the redirect would loop: the auth views (login/logout +# for every auth backend), the password-reset and user-info-edit views, static +# assets, and the health check. We match the *view-class* component (the part +# before the dot) exactly against the allow-list below rather than doing a +# substring search, so unrelated endpoints that merely share a substring (e.g. +# an "Author"-named view, or any name containing "health"/"static") are not +# accidentally exempted from enforcement. +_EXEMPT_VIEW_CLASSES = frozenset( + { + "AuthDBView", + "AuthLDAPView", + "AuthOAuthView", + "AuthOIDView", + "AuthRemoteUserView", + "ResetMyPasswordView", + "ResetPasswordView", + "UserInfoEditView", + } +) + +# Exact endpoint names (function views / Flask built-ins) that are always exempt. +_EXEMPT_ENDPOINTS = frozenset({"static", "appbuilder.static", "health", "healthcheck"}) + + +def _get_user_attribute(user_id: int) -> Optional[Any]: + # Imported lazily to avoid import cycles at app-init time. + from superset.extensions import db + from superset.models.user_attributes import UserAttribute + + # The ``user_attribute`` table does not enforce uniqueness on ``user_id``, + # so a user could have more than one row. ``.one_or_none()`` would raise + # ``MultipleResultsFound`` (a 500) in that case; fetch deterministically by + # ordering on the primary key and taking the first row instead. + return ( + db.session.query(UserAttribute) + .filter(UserAttribute.user_id == user_id) + .order_by(UserAttribute.id) + .first() + ) + + +def password_change_required(user: Any) -> bool: + """Return True if ``user`` has a pending forced password change.""" + user_id = getattr(user, "id", None) + if not user_id: + return False + attr = _get_user_attribute(user_id) + return bool(attr and attr.password_must_change) + + +@transaction() +def set_password_must_change(user_id: int, value: bool = True) -> None: + """Set (or clear) the forced-password-change flag for a user. + + Intended to be called by administrative flows when provisioning an account + that should require a password change on first use. + """ + from superset.extensions import db + from superset.models.user_attributes import UserAttribute + + attr = _get_user_attribute(user_id) + if attr is None: + attr = UserAttribute(user_id=user_id) + db.session.add(attr) + attr.password_must_change = value + + +@transaction() +def clear_password_must_change(user_id: int) -> None: + """Clear the forced-password-change flag for a user, if set.""" + attr = _get_user_attribute(user_id) + if attr and attr.password_must_change: + attr.password_must_change = False + + +def _is_exempt_endpoint(endpoint: Optional[str]) -> bool: + # A missing endpoint (e.g. an unmatched URL) is left to normal 404 handling. + if not endpoint: + return True + if endpoint in _EXEMPT_ENDPOINTS: + return True + # Any blueprint's static route, e.g. "<blueprint>.static". + if endpoint.endswith(".static"): + return True + # Match the view-class component exactly, so e.g. "AuthDBView.login" is + # exempt but an unrelated "AuthorView.list" is not. + view_class = endpoint.split(".", 1)[0] + return view_class in _EXEMPT_VIEW_CLASSES + + +def register_password_change_enforcement(app: Any) -> None: + """Register the before-request hook that enforces pending password changes. + + No-op unless ``ENABLE_FORCE_PASSWORD_CHANGE`` is enabled, so there is zero + per-request overhead in the default configuration. + """ + + @app.before_request + def _enforce_password_change() -> Any: # pylint: disable=unused-variable + if not current_app.config.get("ENABLE_FORCE_PASSWORD_CHANGE"): + return None + + user = getattr(g, "user", None) + if not user or getattr(user, "is_anonymous", True): + return None + + if _is_exempt_endpoint(request.endpoint): + return None + + if not password_change_required(user): + return None + + flash(__("You must change your password before continuing."), "warning") + # Resolve the password-reset page. If that endpoint can't be resolved + # (e.g. a custom security manager without ``ResetMyPasswordView``), fall + # back to logout, which is always exempt from this enforcement. We must + # NOT fall back to "/" or any other non-exempt route: the index re-runs + # this same hook and would trap the user in an infinite 302 loop. If no + # exempt target can be resolved at all, return an error response rather + # than redirect, so a flagged user can never get stuck looping. + for endpoint in ("ResetMyPasswordView.this_form_get", "AuthDBView.logout"): + try: + return redirect(url_for(endpoint)) + except Exception: # noqa: BLE001, S112 # pylint: disable=broad-except + # Try the next exempt fallback; a failed url_for resolution here + # is expected/benign and not worth logging per attempt. + continue Review Comment: Fair point. The logout fallback is derived from the registered auth view (when it's one of the exempt classes), so LDAP/OAuth/remote-user deployments get a working fallback instead of a 503. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
