BastilleBSD_bastille/usr/local/share/bastille/convert.sh

#!/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

usage() {
    error_notify "Usage: bastille convert [option(s)] TARGET"
    error_notify "                                    TARGET RELEASE"
    cat << EOF

    Options:

    -a | --auto      Auto mode. Start/stop jail(s) if required.
    -y | --yes       Do not prompt. Assume always yes.
    -x | --debug     Enable debug mode.

EOF
    exit 1
}

# Handle options.
AUTO=0
AUTO_YES=0
while [ "$#" -gt 0 ]; do
    case "${1}" in
        -h|--help|help)
            usage
            ;;
        -a|--auto)
            AUTO=1
            shift
            ;;
        -y|--yes)
            AUTO_YES=1
            shift
            ;;
        -x|--debug)
            enable_debug
            shift
            ;;
        -*)
            for _opt in $(echo ${1} | sed 's/-//g' | fold -w1); do
                case ${_opt} in
                    a) AUTO=1 ;;
                    y) AUTO_YES=1 ;;
                    x) enable_debug ;;
                    *) error_exit "[ERROR]: Unknown Option: \"${1}\"" ;;
                esac
            done
            shift
            ;;
        *)
            break
            ;;
    esac
done

if [ "$#" -lt 1 ] || [ "$#" -gt 2 ]; then
    usage
fi

TARGET="${1}"
CONVERT_RELEASE="${2}"

bastille_root_check
set_target_single "${TARGET}"

# Validate jail state
check_target_is_stopped "${TARGET}" || if [ "${AUTO}" -eq 1 ]; then
    bastille stop "${TARGET}"
else
    info "\n[${TARGET}]:"
    error_notify "Jail is running."
    error_exit "Use [-a|--auto] to auto-stop the jail."
fi

validate_release_name() {

    local _name=${1}
    local _sanity="$(echo "${_name}" | tr -c -d 'a-zA-Z0-9-_')"

    if [ -n "$(echo "${_sanity}" | awk "/^[-_].*$/" )" ]; then
        error_exit "[ERROR]: Release names may not begin with (-|_) characters!"
    elif [ "${_name}" != "${_sanity}" ]; then
        error_exit "[ERROR]: Release names may not contain special characters!"
    fi

}

convert_jail_to_release() {

    _jailname="${1}"
    _release="${2}"

    info "\nAttempting to create '${_release}' from '${_jailname}'..."

    if checkyesno bastille_zfs_enable; then
        if [ -n "${bastille_zfs_zpool}" ]; then
            ## sane bastille zfs options
            ZFS_OPTIONS=$(echo ${bastille_zfs_options} | sed 's/-o//g')
            ## send without -R if encryption is enabled
            if [ "$(zfs get -H -o value encryption "${bastille_zfs_zpool}/${bastille_zfs_prefix}")" = "off" ]; then
	        OPT_SEND="-R"
            else
                OPT_SEND=""
            fi
            ## take a temp snapshot of the jail
            SNAP_NAME="bastille-$(date +%Y-%m-%d-%H%M%S)"
	    # shellcheck disable=SC2140
            zfs snapshot "${bastille_zfs_zpool}/${bastille_zfs_prefix}/jails/${_jailname}/root"@"${SNAP_NAME}"
            ## replicate the release base to the new thickjail and set the default mountpoint
            # shellcheck disable=SC2140
            zfs send ${OPT_SEND} "${bastille_zfs_zpool}/${bastille_zfs_prefix}/jails/${_jailname}/root"@"${SNAP_NAME}" | \
            zfs receive "${bastille_zfs_zpool}/${bastille_zfs_prefix}/releases/${_release}"
            zfs set ${ZFS_OPTIONS} mountpoint=none "${bastille_zfs_zpool}/${bastille_zfs_prefix}/releases/${_release}"
            zfs inherit mountpoint "${bastille_zfs_zpool}/${bastille_zfs_prefix}/releases/${_release}"
            ## cleanup temp snapshots initially
            # shellcheck disable=SC2140
            zfs destroy "${bastille_zfs_zpool}/${bastille_zfs_prefix}/jails/${_jailname}/root"@"${SNAP_NAME}"
            # shellcheck disable=SC2140
            zfs destroy "${bastille_zfs_zpool}/${bastille_zfs_prefix}/releases/${_release}"@"${SNAP_NAME}"
        fi
        if [ "$?" -ne 0 ]; then
            ## notify and clean stale files/directories
            zfs destroy "${bastille_zfs_zpool}/${bastille_zfs_prefix}/releases/${_release}"
            error_exit "Failed to create release. Please retry!"
        else
            info "\nCreated '${_release}' from '${_jailname}'\n"
        fi
    else
        ## copy all files for thick jails
        cp -a "${bastille_jailsdir}/${_jailname}/root" "${bastille_releasesdir}/${_release}"
        if [ "$?" -ne 0 ]; then
            ## notify and clean stale files/directories
            bastille destroy -af "${NAME}"
            error_exit "[ERROR]: Failed to create release. Please retry!"
        else
            info "\nCreated '${_release}' from '${_jailname}'\n"
        fi
    fi
}

convert_symlinks() {

    # Work with the symlinks, revert on first cp error
    if [ -d "${bastille_releasesdir}/${RELEASE}" ]; then
        # Retrieve old symlinks temporarily
        for _link in ${SYMLINKS}; do
            if [ -L "${_link}" ]; then
                mv "${_link}" "${_link}.old"
            fi
        done

        # Copy new files to destination jail
        info "\nCopying required base files to container..."
        for _link in ${SYMLINKS}; do
            if [ ! -d "${_link}" ]; then
                if [ -d "${bastille_releasesdir}/${RELEASE}/${_link}" ]; then
                    cp -a "${bastille_releasesdir}/${RELEASE}/${_link}" "${bastille_jailsdir}/${TARGET}/root/${_link}"
                fi
                if [ "$?" -ne 0 ]; then
                    revert_convert
                fi
            fi
        done

        # Remove the old symlinks on success
        for _link in ${SYMLINKS}; do
            if [ -L "${_link}.old" ]; then
                rm -r "${_link}.old"
            fi
        done
    else
        error_exit "[ERROR]: Release must be bootstrapped first. See 'bastille bootstrap'."
    fi
}

revert_convert() {
    # Revert the conversion on first cp error
    error_notify "[ERROR]: A problem has occurred while copying the files. Reverting changes..."
    for _link in ${SYMLINKS}; do
        if [ -d "${_link}" ]; then
            chflags -R noschg "${bastille_jailsdir}/${TARGET}/root/${_link}"
            rm -rf "${bastille_jailsdir}/${TARGET}/root/${_link}"
        fi
    done

    # Restore previous symlinks
    for _link in ${SYMLINKS}; do
        if [ -L "${_link}.old" ]; then
            mv "${_link}.old" "${_link}"
        fi
    done
    error_exit "Changes for '${TARGET}' has been reverted."
}

start_convert() {

    # Attempt container conversion and handle some errors
    DATE=$(date)

    if [ -d "${bastille_jailsdir}/${TARGET}" ]; then

        info "\nConverting '${TARGET}' into a thickjail. This may take a while..."

        # Set some variables
        RELEASE=$(grep -w "${bastille_releasesdir}/.* ${bastille_jailsdir}/${TARGET}/root/.bastille" ${bastille_jailsdir}/${TARGET}/fstab | sed "s|${bastille_releasesdir}/||;s| .*||")
        FSTABMOD=$(grep -w "${bastille_releasesdir}/${RELEASE} ${bastille_jailsdir}/${TARGET}/root/.bastille" "${bastille_jailsdir}/${TARGET}/fstab")
        SYMLINKS="bin boot lib libexec rescue sbin usr/bin usr/include usr/lib usr/lib32 usr/libdata usr/libexec usr/ports usr/sbin usr/share usr/src"
        HASPORTS=$(grep -w ${bastille_releasesdir}/${RELEASE}/usr/ports ${bastille_jailsdir}/${TARGET}/fstab)

        if [ -n "${RELEASE}" ]; then
            cd "${bastille_jailsdir}/${TARGET}/root" || error_exit "Failed to change directory to ${bastille_jailsdir}/${TARGET}/root"

            # Work with the symlinks
            convert_symlinks

            # Comment the line containing .bastille and rename mountpoint
            sed -i '' -E "s|${FSTABMOD}|# Converted from thin to thick container on ${DATE}|g" "${bastille_jailsdir}/${TARGET}/fstab"
            if [ -n "${HASPORTS}" ]; then
                sed -i '' -E "s|${HASPORTS}|# Ports copied from base to container on ${DATE}|g" "${bastille_jailsdir}/${TARGET}/fstab"
                info "\nCopying ports to container..."
                cp -a "${bastille_releasesdir}/${RELEASE}/usr/ports" "${bastille_jailsdir}/${TARGET}/root/usr"
            fi
            mv "${bastille_jailsdir}/${TARGET}/root/.bastille" "${bastille_jailsdir}/${TARGET}/root/.bastille.old"

            info "\nConversion of '${TARGET}' completed successfully!\n"
            exit 0
        else
            error_exit "[ERROR]: Can't determine release version. See 'bastille bootstrap'."
        fi
    else
        error_exit "[ERROR]: ${TARGET} not found. See 'bastille create'."
    fi
}

# Convert thin jail to thick jail if only one arg
# Convert jail to release if two args
if [ "$#" -eq 1 ]; then

    # Check if jail is a thin jail
    if [ ! -d "${bastille_jailsdir}/${TARGET}/root/.bastille" ]; then
        error_exit "[ERROR]: ${TARGET} is not a thin container."
    elif ! grep -qw ".bastille" "${bastille_jailsdir}/${TARGET}/fstab"; then
        error_exit "[ERROR]: ${TARGET} is not a thin container."
    fi

    # Ask if user is sure they want to convert the jail
    # but only if AUTO_YES=0
    if [ "${AUTO_YES}" -ne 1 ]; then
        warn "\n[WARNING]: Jail conversion from thin to thick can't be undone!\n"
        # shellcheck disable=SC3045
        read -p "Are you sure you want to continue? [y|n]:" _answer
        case "${_answer}" in
            [Yy]|[Yy][Ee][Ss])
                start_convert
                ;;
            [Nn]|[Nn][Oo])
                error_exit "[ERROR]: Cancelled by user."
                ;;
            *)
                error_exit "[ERROR]: Invalid input. Please answer 'y' or 'n'."
                ;;
        esac
    elif [ "${AUTO_YES}" -eq 1 ]; then
        start_convert
    fi

elif  [ "$#" -eq 2 ]; then

    # Check if jail is a thick jail
    if [ -d "${bastille_jailsdir}/${TARGET}/root/.bastille" ]; then
        error_exit "[ERROR]: ${TARGET} is not a thick jail."
    elif grep -qw ".bastille" "${bastille_jailsdir}/${TARGET}/fstab"; then
        error_exit "[ERROR]: ${TARGET} is not a thick jail."
    fi

    validate_release_name "${CONVERT_RELEASE}"
    convert_jail_to_release "${TARGET}" "${CONVERT_RELEASE}"
else
    usage
fi