Files
SysAdminAutomation/zimbra_restore.sh
jcoffey-dev 5d417f3c4c Change the copyright holder to Coffey Labs
The scripts were attributed to LINUXexpert.org, which is being retired as a
site and is no longer where this work lives. Coffey Labs is the organisation
these projects belong to.

One line per script, fifteen of them, and nothing else. LICENSE is deliberately
untouched: its "Copyright (C) <year> <name of author>" lines are GPL boilerplate
showing you how to write your own notice, and the Free Software Foundation's
own copyright on the licence text is not ours to edit.

Both git contributors are the same person, so there is no third-party copyright
here that could not be restated.
2026-08-30 01:26:45 -07:00

91 lines
3.3 KiB
Bash

#!/bin/bash
#
# Copyright (C) 2025 Coffey Labs
#
# This program is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the
# Free Software Foundation, version 3 of the License.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
# for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program. If not, see <https://www.gnu.org/licenses/>.
set -euo pipefail
# Ensure script is run as root or with sudo
if [ "$EUID" -ne 0 ]; then
echo "❌ This script must be run as root or with sudo."
exit 1
fi
# Prompt for email and backup directory
read -p "Enter Zimbra username to restore to (email address): " EMAIL
read -p "Enter backup directory (absolute path) [/opt/zimbra/backups]: " BACKUP_DIR
# Use default if none provided
BACKUP_DIR=${BACKUP_DIR:-/opt/zimbra/backups}
# Check if directory exists
if [ ! -d "$BACKUP_DIR" ]; then
echo "❌ Backup directory does not exist: $BACKUP_DIR"
exit 1
fi
# List available backups for that user
echo "📁 Available backups for $EMAIL:"
# -F: match the address literally. Unquoted it was a regex, so "." in
# any address matched any character.
find "$BACKUP_DIR" -maxdepth 1 -type f -name '*.tgz' -printf '%f\n' | grep -F "$EMAIL" || true
echo
# Prompt for filename
read -p "Enter the exact filename of the backup to restore (e.g., [email protected]_2024-06-11_10-20-30.tgz): " FILENAME
# A bare filename only. Without this, "../../etc/shadow" would resolve
# outside $BACKUP_DIR and be handed to the restore command.
if [[ "$FILENAME" != "${FILENAME##*/}" || -z "$FILENAME" ]]; then
echo "❌ Enter a filename only, not a path: $FILENAME"
exit 1
fi
FULL_PATH="${BACKUP_DIR}/${FILENAME}"
# Validate file exists
if [ ! -f "$FULL_PATH" ]; then
echo "❌ Backup file not found: $FULL_PATH"
exit 1
fi
# Confirm before restoring
echo "⚠️ You are about to restore $FULL_PATH into $EMAIL's mailbox."
read -p "Proceed? (y/n): " CONFIRM
if [[ ! "$CONFIRM" =~ ^[Yy]$ ]]; then
echo "❌ Restore cancelled."
exit 0
fi
# Run the restore command as zimbra user
echo "🔄 Restoring backup..."
# Single-quoted body: nothing is interpolated. $EMAIL and $FULL_PATH
# arrive as positional arguments. Interpolating them (as this line
# previously did) let shell metacharacters in either value run commands
# as the zimbra user.
# Refuse a backup that is not a readable gzip stream before handing it to
# zmmailbox -- a truncated or error-page "backup" should fail here, with
# a clear reason, rather than part way through a restore.
if ! gzip -t -- "$FULL_PATH" 2>/dev/null; then
echo "❌ $FILENAME is not a valid gzip archive -- refusing to restore from it."
exit 1
fi
# Tested inline rather than via `$?`: under set -e a failure would exit
# before the check, making the error branch below unreachable.
if sudo -u zimbra bash -c '/opt/zimbra/bin/zmmailbox -z -m "$1" postRestURL "/?fmt=tgz&resolve=skip" --file "$2"' _ "$EMAIL" "$FULL_PATH"; then
echo "✅ Restore completed successfully for $EMAIL"
else
echo "❌ Restore failed. Please verify mailbox exists and backup file integrity."
exit 1
fi