mirror of
https://github.com/hackacad/bastille.git
synced 2025-12-18 08:12:53 +01:00
8b0411c111
Added SPDX-License-Identifier to all scripts for better license clarity and compliance. Updated the copyright years from 2024 to 2025 in various files to reflect the current maintenance period.
403 lines
13 KiB
Bash
403 lines
13 KiB
Bash
#!/bin/sh
|
|
#
|
|
# SPDX-License-Identifier: BSD-3-Clause
|
|
#
|
|
# Copyright (c) 2018-2025, Christer Edwards <christer.edwards@gmail.com>
|
|
# All rights reserved.
|
|
#
|
|
# Redistribution and use in source and binary forms, with or without
|
|
# modification, are permitted provided that the following conditions are met:
|
|
#
|
|
# * Redistributions of source code must retain the above copyright notice, this
|
|
# list of conditions and the following disclaimer.
|
|
#
|
|
# * Redistributions in binary form must reproduce the above copyright notice,
|
|
# this list of conditions and the following disclaimer in the documentation
|
|
# and/or other materials provided with the distribution.
|
|
#
|
|
# * Neither the name of the copyright holder nor the names of its
|
|
# contributors may be used to endorse or promote products derived from
|
|
# this software without specific prior written permission.
|
|
#
|
|
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
. /usr/local/share/bastille/common.sh
|
|
. /usr/local/etc/bastille/bastille.conf
|
|
|
|
usage() {
|
|
# Build an independent usage for the export command
|
|
# Valid compress/options for ZFS systems are raw, .gz, .tgz, .txz and .xz
|
|
# Valid compress/options for non ZFS configured systems are .tgz and .txz
|
|
# If no compression option specified, user must redirect standard output
|
|
error_notify "Usage: bastille export | option(s) | TARGET | PATH"
|
|
|
|
cat << EOF
|
|
Options:
|
|
|
|
--gz -- Export a ZFS jail using GZIP(.gz) compressed image.
|
|
-r | --raw -- Export a ZFS jail to an uncompressed RAW image.
|
|
-s | --safe -- Safely stop and start a ZFS jail before the exporting process.
|
|
--tgz -- Export a jail using simple .tgz compressed archive instead.
|
|
--txz -- Export a jail using simple .txz compressed archive instead.
|
|
-v | --verbose -- Be more verbose during the ZFS send operation.
|
|
--xz -- Export a ZFS jail using XZ(.xz) compressed image.
|
|
|
|
Note: If no export option specified, the container should be redirected to standard output.
|
|
|
|
EOF
|
|
exit 1
|
|
}
|
|
|
|
# Handle special-case commands first
|
|
case "$1" in
|
|
help|-h|--help)
|
|
usage
|
|
;;
|
|
esac
|
|
|
|
# Check for unsupported actions
|
|
if [ "${TARGET}" = "ALL" ]; then
|
|
error_exit "Batch export is unsupported."
|
|
fi
|
|
|
|
if [ $# -gt 5 ] || [ $# -lt 1 ]; then
|
|
usage
|
|
fi
|
|
|
|
bastille_root_check
|
|
|
|
zfs_enable_check() {
|
|
# Temporarily disable ZFS so we can create a standard backup archive
|
|
if checkyesno bastille_zfs_enable; then
|
|
# shellcheck disable=SC2034
|
|
bastille_zfs_enable="NO"
|
|
fi
|
|
}
|
|
|
|
TARGET="${1}"
|
|
GZIP_EXPORT=
|
|
XZ_EXPORT=
|
|
SAFE_EXPORT=
|
|
USER_EXPORT=
|
|
RAW_EXPORT=
|
|
DIR_EXPORT=
|
|
TXZ_EXPORT=
|
|
TGZ_EXPORT=
|
|
OPT_ZSEND="-R"
|
|
COMP_OPTION="0"
|
|
|
|
opt_count() {
|
|
COMP_OPTION=$(expr ${COMP_OPTION} + 1)
|
|
}
|
|
|
|
if [ -n "${bastille_export_options}" ]; then
|
|
# Overrides the case options by the user defined option(s) automatically.
|
|
# Add bastille_export_options="--optionA --optionB" to bastille.conf, or simply `export bastille_export_options="--optionA --optionB"` environment variable.
|
|
# To restore the standard case options, empty bastille_export_options="" in bastille.conf, or `unset bastille_export_options` environment variable.
|
|
# Reference "/bastille/issues/443"
|
|
|
|
DEFAULT_EXPORT_OPTS="${bastille_export_options}"
|
|
info "Default export option(s): '${DEFAULT_EXPORT_OPTS}'"
|
|
|
|
for opt in ${DEFAULT_EXPORT_OPTS}; do
|
|
case "${opt}" in
|
|
--gz)
|
|
GZIP_EXPORT="1"
|
|
opt_count
|
|
shift;;
|
|
--xz)
|
|
XZ_EXPORT="1"
|
|
opt_count
|
|
shift;;
|
|
--tgz)
|
|
TGZ_EXPORT="1"
|
|
opt_count
|
|
zfs_enable_check
|
|
shift;;
|
|
--txz)
|
|
TXZ_EXPORT="1"
|
|
opt_count
|
|
zfs_enable_check
|
|
shift;;
|
|
--safe)
|
|
SAFE_EXPORT="1"
|
|
shift;;
|
|
--raw)
|
|
RAW_EXPORT="1"
|
|
opt_count
|
|
shift ;;
|
|
--verbose)
|
|
OPT_ZSEND="-Rv"
|
|
shift;;
|
|
--*|-*) error_notify "Unknown Option."
|
|
usage;;
|
|
esac
|
|
done
|
|
else
|
|
# Handle and parse option args
|
|
while [ $# -gt 0 ]; do
|
|
case "${1}" in
|
|
--gz)
|
|
GZIP_EXPORT="1"
|
|
TARGET="${2}"
|
|
opt_count
|
|
shift
|
|
;;
|
|
--xz)
|
|
XZ_EXPORT="1"
|
|
TARGET="${2}"
|
|
opt_count
|
|
shift
|
|
;;
|
|
--tgz)
|
|
TGZ_EXPORT="1"
|
|
TARGET="${2}"
|
|
opt_count
|
|
zfs_enable_check
|
|
shift
|
|
;;
|
|
--txz)
|
|
TXZ_EXPORT="1"
|
|
TARGET="${2}"
|
|
opt_count
|
|
zfs_enable_check
|
|
shift
|
|
;;
|
|
-s|--safe)
|
|
SAFE_EXPORT="1"
|
|
TARGET="${2}"
|
|
shift
|
|
;;
|
|
-r|--raw)
|
|
RAW_EXPORT="1"
|
|
TARGET="${2}"
|
|
opt_count
|
|
shift
|
|
;;
|
|
-v|--verbose)
|
|
OPT_ZSEND="-Rv"
|
|
TARGET="${2}"
|
|
shift
|
|
;;
|
|
--*|-*)
|
|
error_notify "Unknown Option."
|
|
usage
|
|
;;
|
|
*)
|
|
if echo "${1}" | grep -q "\/"; then
|
|
DIR_EXPORT="${1}"
|
|
else
|
|
if [ $# -gt 2 ] || [ $# -lt 1 ]; then
|
|
usage
|
|
fi
|
|
fi
|
|
shift
|
|
;;
|
|
esac
|
|
done
|
|
fi
|
|
|
|
# Validate for combined options
|
|
if [ "${COMP_OPTION}" -gt "1" ]; then
|
|
error_exit "Error: Only one compression format can be used during export."
|
|
fi
|
|
|
|
if { [ -n "${TXZ_EXPORT}" ] || [ -n "${TGZ_EXPORT}" ]; } && [ -n "${SAFE_EXPORT}" ]; then
|
|
error_exit "Error: Simple archive modes with safe ZFS export can't be used together."
|
|
fi
|
|
|
|
if ! checkyesno bastille_zfs_enable; then
|
|
if [ -n "${XZ_EXPORT}" ] ||
|
|
[ -n "${GZIP_EXPORT}" ] ||
|
|
[ -n "${RAW_EXPORT}" ] ||
|
|
[ -n "${SAFE_EXPORT}" ] ||
|
|
[ "${OPT_ZSEND}" = "-Rv" ]; then
|
|
error_exit "Options --xz, --gz, --raw, --safe, --verbose are valid for ZFS configured systems only."
|
|
fi
|
|
fi
|
|
|
|
if [ -n "${SAFE_EXPORT}" ]; then
|
|
# Check if container is running, otherwise just ignore
|
|
if [ -z "$(/usr/sbin/jls name | awk "/^${TARGET}$/")" ]; then
|
|
SAFE_EXPORT=
|
|
fi
|
|
fi
|
|
|
|
# Export directory check
|
|
if [ -n "${DIR_EXPORT}" ]; then
|
|
if [ -d "${DIR_EXPORT}" ]; then
|
|
# Set the user defined export directory
|
|
bastille_backupsdir="${DIR_EXPORT}"
|
|
else
|
|
error_exit "Error: Path not found."
|
|
fi
|
|
fi
|
|
|
|
# Fallback to default if missing config parameters
|
|
if [ -z "${bastille_compress_xz_options}" ]; then
|
|
bastille_compress_xz_options="-0 -v"
|
|
fi
|
|
if [ -z "${bastille_compress_gz_options}" ]; then
|
|
bastille_compress_gz_options="-1 -v"
|
|
fi
|
|
|
|
create_zfs_snap() {
|
|
# Take a recursive temporary snapshot
|
|
if [ -z "${USER_EXPORT}" ]; then
|
|
info "Creating temporary ZFS snapshot for export..."
|
|
fi
|
|
zfs snapshot -r "${bastille_zfs_zpool}/${bastille_zfs_prefix}/jails/${TARGET}@bastille_${TARGET}_${DATE}"
|
|
}
|
|
|
|
clean_zfs_snap() {
|
|
# Cleanup the recursive temporary snapshot
|
|
zfs destroy "${bastille_zfs_zpool}/${bastille_zfs_prefix}/jails/${TARGET}/root@bastille_${TARGET}_${DATE}"
|
|
zfs destroy "${bastille_zfs_zpool}/${bastille_zfs_prefix}/jails/${TARGET}@bastille_${TARGET}_${DATE}"
|
|
}
|
|
|
|
export_check() {
|
|
# Inform the user about the exporting method
|
|
if [ -z "${USER_EXPORT}" ]; then
|
|
if [ -n "$(/usr/sbin/jls name | awk "/^${TARGET}$/")" ]; then
|
|
if [ -n "${SAFE_EXPORT}" ]; then
|
|
EXPORT_AS="Safely exporting"
|
|
else
|
|
EXPORT_AS="Hot exporting"
|
|
fi
|
|
else
|
|
EXPORT_AS="Exporting"
|
|
fi
|
|
|
|
if [ "${FILE_EXT}" = ".xz" ] || [ "${FILE_EXT}" = ".gz" ] || [ "${FILE_EXT}" = "" ]; then
|
|
EXPORT_TYPE="image"
|
|
else
|
|
EXPORT_TYPE="archive"
|
|
fi
|
|
|
|
if [ -n "${RAW_EXPORT}" ]; then
|
|
EXPORT_INFO="to a raw ${EXPORT_TYPE}"
|
|
else
|
|
EXPORT_INFO="to a compressed ${FILE_EXT} ${EXPORT_TYPE}"
|
|
fi
|
|
|
|
info "${EXPORT_AS} '${TARGET}' ${EXPORT_INFO}..."
|
|
fi
|
|
|
|
# Safely stop and snapshot the jail
|
|
if [ -n "${SAFE_EXPORT}" ]; then
|
|
bastille stop ${TARGET}
|
|
create_zfs_snap
|
|
bastille start ${TARGET}
|
|
else
|
|
create_zfs_snap
|
|
fi
|
|
|
|
if checkyesno bastille_zfs_enable; then
|
|
if [ -z "${USER_EXPORT}" ]; then
|
|
info "Sending ZFS data stream..."
|
|
fi
|
|
fi
|
|
}
|
|
|
|
jail_export() {
|
|
# Attempt to export the container
|
|
DATE=$(date +%F-%H%M%S)
|
|
if checkyesno bastille_zfs_enable; then
|
|
if [ -n "${bastille_zfs_zpool}" ]; then
|
|
if [ -n "${RAW_EXPORT}" ]; then
|
|
FILE_EXT=""
|
|
export_check
|
|
|
|
# Export the raw container recursively and cleanup temporary snapshots
|
|
zfs send ${OPT_ZSEND} "${bastille_zfs_zpool}/${bastille_zfs_prefix}/jails/${TARGET}@bastille_${TARGET}_${DATE}" \
|
|
> "${bastille_backupsdir}/${TARGET}_${DATE}"
|
|
clean_zfs_snap
|
|
elif [ -n "${GZIP_EXPORT}" ]; then
|
|
FILE_EXT=".gz"
|
|
export_check
|
|
|
|
# Export the raw container recursively and cleanup temporary snapshots
|
|
zfs send ${OPT_ZSEND} "${bastille_zfs_zpool}/${bastille_zfs_prefix}/jails/${TARGET}@bastille_${TARGET}_${DATE}" | \
|
|
gzip ${bastille_compress_gz_options} > "${bastille_backupsdir}/${TARGET}_${DATE}${FILE_EXT}"
|
|
clean_zfs_snap
|
|
elif [ -n "${XZ_EXPORT}" ]; then
|
|
FILE_EXT=".xz"
|
|
export_check
|
|
|
|
# Export the container recursively and cleanup temporary snapshots
|
|
zfs send ${OPT_ZSEND} "${bastille_zfs_zpool}/${bastille_zfs_prefix}/jails/${TARGET}@bastille_${TARGET}_${DATE}" | \
|
|
xz ${bastille_compress_xz_options} > "${bastille_backupsdir}/${TARGET}_${DATE}${FILE_EXT}"
|
|
clean_zfs_snap
|
|
else
|
|
FILE_EXT=""
|
|
USER_EXPORT="1"
|
|
export_check
|
|
|
|
# Quietly export the container recursively, user must redirect standard output
|
|
if ! zfs send ${OPT_ZSEND} "${bastille_zfs_zpool}/${bastille_zfs_prefix}/jails/${TARGET}@bastille_${TARGET}_${DATE}"; then
|
|
clean_zfs_snap
|
|
error_notify "\nError: An export option is required, see 'bastille export, otherwise the user must redirect to standard output."
|
|
fi
|
|
fi
|
|
fi
|
|
else
|
|
if [ -n "${TGZ_EXPORT}" ]; then
|
|
FILE_EXT=".tgz"
|
|
|
|
# Create standard tgz backup archive
|
|
info "Exporting '${TARGET}' to a compressed ${FILE_EXT} archive..."
|
|
cd "${bastille_jailsdir}" && tar -cf - "${TARGET}" | gzip ${bastille_compress_gz_options} > "${bastille_backupsdir}/${TARGET}_${DATE}${FILE_EXT}"
|
|
elif [ -n "${TXZ_EXPORT}" ]; then
|
|
FILE_EXT=".txz"
|
|
|
|
# Create standard txz backup archive
|
|
info "Exporting '${TARGET}' to a compressed ${FILE_EXT} archive..."
|
|
cd "${bastille_jailsdir}" && tar -cf - "${TARGET}" | xz ${bastille_compress_xz_options} > "${bastille_backupsdir}/${TARGET}_${DATE}${FILE_EXT}"
|
|
else
|
|
error_exit "Error: export option required"
|
|
fi
|
|
fi
|
|
|
|
# shellcheck disable=SC2181
|
|
if [ "$?" -ne 0 ]; then
|
|
error_exit "Failed to export '${TARGET}' container."
|
|
else
|
|
if [ -z "${USER_EXPORT}" ]; then
|
|
# Generate container checksum file
|
|
cd "${bastille_backupsdir}" || error_exit "Failed to change directory."
|
|
sha256 -q "${TARGET}_${DATE}${FILE_EXT}" > "${TARGET}_${DATE}.sha256"
|
|
info "Exported '${bastille_backupsdir}/${TARGET}_${DATE}${FILE_EXT}' successfully."
|
|
fi
|
|
exit 0
|
|
fi
|
|
}
|
|
|
|
# Check if backups directory/dataset exist
|
|
if [ ! -d "${bastille_backupsdir}" ]; then
|
|
error_exit "Backups directory/dataset does not exist. See 'bastille bootstrap'."
|
|
fi
|
|
|
|
if [ -n "${TARGET}" ]; then
|
|
if [ ! -d "${bastille_jailsdir}/${TARGET}" ]; then
|
|
error_exit "[${TARGET}]: Not found."
|
|
fi
|
|
|
|
# Check if is a ZFS system
|
|
if ! checkyesno bastille_zfs_enable; then
|
|
# Check if container is running and ask for stop in non ZFS systems
|
|
if [ -n "$(/usr/sbin/jls name | awk "/^${TARGET}$/")" ]; then
|
|
error_exit "${TARGET} is running. See 'bastille stop'."
|
|
fi
|
|
fi
|
|
jail_export
|
|
fi
|