Skip to content

factory-reset: clear hostname and ssh keys, and reset motd banner #24522

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.

Sign up for GitHub

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

Open
anamehra wants to merge 3 commits into
base: master
Choose a base branch
from
Open

factory-reset: clear hostname and ssh keys, and reset motd banner #24522

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bd6539d
factory-reset: clear hostname and ssh keys, and reset motd banner
anamehra Nov 13, 2025
6d628d3
Merge branch 'sonic-net:master' into anamehra/factory-reboot
anamehra Nov 19, 2025
d7dd870
Merge branch 'master' into anamehra/factory-reboot
anamehra Dec 3, 2025
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
2 changes: 2 additions & 0 deletions files/build_templates/sonic_debian_extension.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,8 @@ sudo LANG=C DEBIAN_FRONTEND=noninteractive chroot $FILESYSTEM_ROOT apt-get -y in
sudo cp $IMAGE_CONFIGS/environment/environment $FILESYSTEM_ROOT/etc/
sudo cp $IMAGE_CONFIGS/environment/motd $FILESYSTEM_ROOT/etc/
sudo cp $IMAGE_CONFIGS/environment/logout_message $FILESYSTEM_ROOT/etc/
# Create a default copy of motd for factory reset
sudo cp $IMAGE_CONFIGS/environment/motd $FILESYSTEM_ROOT/etc/motd_factory_default

# Create all needed directories
sudo mkdir -p $FILESYSTEM_ROOT/etc/sonic/
Expand Down
28 changes: 28 additions & 0 deletions files/image_config/reset-factory/reset-factory
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,19 @@ clear_sonic_dir()
mount -o remount /
}

# Remove SSH keys from all users
reset_ssh_keys()
{
echo "Remove SSH authorized keys from all users"
# Remove authorized_keys from all user home directories
find /home /root \( -path "*/.ssh/authorized_keys*" -o -path "*/.ssh/known_hosts*" \) \
-type f -print -delete 2>/dev/null | tee -a "$PERMLOG"

echo "Remove SSH host keys from /etc/ssh"
# Remove existing host keys (will be regenerated on boot)
rm -f /etc/ssh/ssh_host_*
}

# Get list of defaults users names and passwords from DEFAULT_USERS_FILE
# Delete non-default users and restore default password of default users
reset_users()
Expand Down Expand Up @@ -143,6 +156,18 @@ TEMP_CFG="/tmp/temp_config_db.$$"
cp ${CONFIG_DB_JSON} ${TEMP_CFG}
if [ "$FACTORY_TYPE" != "keep-basic" ] && [ "$FACTORY_TYPE" != "keep-all-config" ]; then
rm -f ${CONFIG_DB_JSON}

echo "Reset banner/motd file"
DEFAULT_MOTD_FILE='/etc/motd_factory_default'
if [ -f ${DEFAULT_MOTD_FILE} ]; then
cp ${DEFAULT_MOTD_FILE} /etc/motd
echo "MOTD restored from factory default" | tee -a "$PERMLOG"
else
echo "WARNING: Factory default motd file not found at ${DEFAULT_MOTD_FILE}" | tee -a "$PERMLOG"
fi

echo "Removing hostname (will be set on boot)"
rm -f /etc/hostname
fi

echo "Call config-setup factory"
Expand All @@ -159,6 +184,9 @@ if [ "$FACTORY_TYPE" != "only-config" ]; then
# Delete non-default users and restore default users passwords
reset_users

# Remove SSH keys from all users and host keys
reset_ssh_keys

echo "Delete bash, python and vim history files"
find /home /root -type f -name ".bash_history" -o -name ".python_history" -o -name ".viminfo" | xargs rm -rf

Expand Down
Loading