-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
[Local-users-passwords-reset] Add new feature including config, yang and tests #18874
Open
azmy98
wants to merge
3
commits into
sonic-net:master
Choose a base branch
from
azmy98:dev-reset-local-users-password
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
62 changes: 62 additions & 0 deletions
62
files/image_config/local-users-passwords-reset/local-users-passwords-reset.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| #!/usr/bin/env python | ||
|
|
||
| import syslog | ||
| from swsscommon.swsscommon import ConfigDBConnector, DBConnector | ||
| from swsscommon import swsscommon | ||
|
|
||
|
|
||
| STATE_DB = "STATE_DB" | ||
|
|
||
|
|
||
| def get_platform_local_users_passwords_reset(): | ||
| try: | ||
| from sonic_platform.local_users_passwords_reset import LocalUsersConfigurationReset | ||
| local_users_password_reset_class = LocalUsersConfigurationReset() | ||
| except ImportError: | ||
| syslog.syslog(syslog.LOG_WARNING, "LocalUsersConfigurationReset: sonic_platform package not installed. Unable to find platform local users passwords reset implementation") | ||
| raise Exception('Local users passwords reset implementation is not defined') | ||
|
|
||
| return local_users_password_reset_class | ||
|
|
||
|
|
||
| class LocalUsersConfigurationResetService: | ||
| def __init__(self): | ||
| state_db_conn = DBConnector(STATE_DB, 0) | ||
| # Wait if the Warm/Fast boot is in progress | ||
| if swsscommon.RestartWaiter.isAdvancedBootInProgress(state_db_conn): | ||
| swsscommon.RestartWaiter.waitAdvancedBootDone() | ||
|
|
||
| self.config_db = ConfigDBConnector() | ||
| self.config_db.connect(wait_for_init=True, retry_on=True) | ||
| syslog.syslog(syslog.LOG_INFO, 'ConfigDB connect success') | ||
|
|
||
| def get_feature_state(self): | ||
| ''' | ||
| Check if the feature is enabled by reading the redis table | ||
| ''' | ||
| table = self.config_db.get_table(swsscommon.CFG_LOCAL_USERS_PASSWORDS_RESET) | ||
| if table: | ||
| state = table.get('global', {}).get('state') | ||
| return True if state == 'enabled' else False | ||
|
|
||
| return False | ||
|
|
||
| def start(self): | ||
| ''' | ||
| If the feature is enabled then reset the password's using the platform | ||
| specific implementation | ||
| ''' | ||
| local_users_password_reset = get_platform_local_users_passwords_reset() | ||
| feature_enabled = self.get_feature_state() | ||
| syslog.syslog(syslog.LOG_INFO, 'Feature is {}'.format('enabled' if feature_enabled else 'disabled')) | ||
| should_trigger = local_users_password_reset.should_trigger() | ||
| if should_trigger and feature_enabled: | ||
| local_users_password_reset.start() | ||
|
|
||
|
|
||
| def main(): | ||
| LocalUsersConfigurationResetService().start() | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| main() |
14 changes: 14 additions & 0 deletions
14
files/image_config/local-users-passwords-reset/local-users-passwords-reset.service
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| [Unit] | ||
| Description=Update Local users' passwords config based on configdb | ||
| Requires=config-setup.service | ||
| After=config-setup.service | ||
| Before=systemd-logind.service sshd.service getty.target [email protected] | ||
| [Service] | ||
| Type=oneshot | ||
| RemainAfterExit=no | ||
| ExecStart=/usr/bin/local-users-passwords-reset.py | ||
| [Install] | ||
| WantedBy=sonic.target |
51 changes: 51 additions & 0 deletions
51
platform/mellanox/mlnx-platform-api/sonic_platform/local_users_passwords_reset.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # | ||
| # Copyright (c) 2019-2024 NVIDIA CORPORATION & AFFILIATES. | ||
| # Apache-2.0 | ||
| # | ||
| # Licensed 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. | ||
| # | ||
| ############################################################################# | ||
| # Mellanox | ||
| # | ||
| # Module contains an implementation of SONiC Platform Base API and | ||
| # provides the local users' passwords reset functionality implementation. | ||
| # | ||
| ############################################################################# | ||
|
|
||
| try: | ||
| from sonic_platform_base.local_users_passwords_reset_base import LocalUsersConfigurationResetBase | ||
| from sonic_py_common.logger import Logger | ||
| from . import utils | ||
| except ImportError as e: | ||
| raise ImportError (str(e) + "- required module not found") | ||
|
|
||
|
|
||
| # Global logger class instance | ||
| logger = Logger() | ||
|
|
||
|
|
||
| LONG_REBOOT_PRESS_FILEPATH = '/var/run/hw-management/system/reset_long_pb' | ||
|
|
||
|
|
||
| class LocalUsersConfigurationReset(LocalUsersConfigurationResetBase): | ||
| def should_trigger(self): | ||
| ''' | ||
| The condition for triggering passwords reset is by checking if the | ||
| reboot cause was a long reboot press. | ||
| ''' | ||
| try: | ||
| status = utils.read_int_from_file(LONG_REBOOT_PRESS_FILEPATH, raise_exception=True) | ||
| return True if status == 1 else False | ||
| except (ValueError, IOError) as e: | ||
| logger.log_error(f"Failed to read long reboot press from {LONG_REBOOT_PRESS_FILEPATH} - {e}") | ||
| return False |
44 changes: 44 additions & 0 deletions
44
platform/mellanox/mlnx-platform-api/tests/test_local_users_passwords_reset.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| # | ||
| # Copyright (c) 2020-2024 NVIDIA CORPORATION & AFFILIATES. | ||
| # Apache-2.0 | ||
| # | ||
| # Licensed 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. | ||
| # | ||
| import os | ||
| import pytest | ||
| import sys | ||
| from mock import patch, mock_open | ||
|
|
||
| test_path = os.path.dirname(os.path.abspath(__file__)) | ||
| modules_path = os.path.dirname(test_path) | ||
| sys.path.insert(0, modules_path) | ||
|
|
||
| from sonic_platform.local_users_passwords_reset import LocalUsersConfigurationReset | ||
|
|
||
|
|
||
| class TestLocalUsersConfigurationReset: | ||
| @patch('sonic_platform.utils.read_int_from_file') | ||
| def test_should_trigger_method(self, mock_read_int): | ||
| ''' | ||
| Validate should_trigger() method | ||
| ''' | ||
| local_users_reset_class = LocalUsersConfigurationReset() | ||
|
|
||
| mock_read_int.return_value = int(1) | ||
| assert local_users_reset_class.should_trigger() == True | ||
| mock_read_int.return_value = int(0) | ||
| assert local_users_reset_class.should_trigger() == False | ||
| mock_read_int.return_value = int(2) | ||
| assert local_users_reset_class.should_trigger() == False | ||
| mock_read_int.side_effect = ValueError() | ||
| assert local_users_reset_class.should_trigger() == False |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do you need check sonic_asic_platform == "mellanox" as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, why? it is not related to Mellanox or ASIC.. it is a general feature
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok I see, but I only saw local_users_passwords_reset.py for mellanox.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The implementation is for Mellanox, each vendor should add their implementation in case they want to use it same as we did in mellanox