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

#!/bin/sh
# 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 etcupdate [option(s)] [bootstrap|TARGET] [diff|resolve|update RELEASE]"
    cat << EOF

    Options:

    -d | --dry-run          Show output, but do not apply.
    -f | --force            Force a re-bootstrap of a RELEASE.
    -x | --debug            Enable debug mode.

EOF
    exit 1
}

bootstrap_etc_release_pkgbase() {

    local release="${1}"
    local release_dir="${bastille_releasesdir}/${release}"
    local abi="FreeBSD:${MAJOR_VERSION}:${HW_MACHINE_ARCH}"
    local fingerprints="${release_dir}/usr/share/keys/pkg"
    if [ "${FREEBSD_BRANCH}" = "release" ]; then
        local repo_name="FreeBSD-base-release-${MINOR_VERSION}"
    elif [ "${FREEBSD_BRANCH}" = "current" ]; then
        local repo_name="FreeBSD-base-latest"
    fi
    local repo_dir="${bastille_sharedir}/pkgbase"

    if [ -d "${release_dir}" ]; then
        # Update repo (pkgbase)
        if ! pkg --rootdir "${release_dir}" \
                 --repo-conf-dir "${repo_dir}" \
                  -o IGNORE_OSVERSION="yes" \
                  -o ABI="${abi}" \
                  -o ASSUME_ALWAYS_YES="yes" \
                  -o FINGERPRINTS="${fingerprints}" \
                  update -r "${repo_name}"; then
            error_exit "[ERROR]: Failed to update pkg repo: ${repo_name}"
        fi
        # Install FreeBSD-set-src
        if ! pkg --rootdir "${release_dir}" \
                 --repo-conf-dir "${repo_dir}" \
                  -o IGNORE_OSVERSION="yes" \
                  -o ABI="${abi}" \
                  -o ASSUME_ALWAYS_YES="yes" \
                  -o FINGERPRINTS="${fingerprints}" \
                  install -r "${repo_name}" \
                  freebsd-set-src; then
            error_exit "[ERROR]: Failed to install package set: FreeBSD-set-src"
        fi
    else
        error_exit "[ERROR]: Release not found: ${release}"
    fi
}

bootstrap_etc_release() {

    local release="${1}"
    local current="$(sysrc -f /usr/local/etc/bastille/bastille.conf bastille_bootstrap_archives | awk -F': ' '{print $2}')"

    if [ ! -f "${bastille_cachedir}/${release}/src.txz" ]; then
        sysrc -f /usr/local/etc/bastille/bastille.conf bastille_bootstrap_archives="src"
        if ! bastille bootstrap "${release}" > /dev/null; then
            sysrc -f /usr/local/etc/bastille/bastille.conf bastille_bootstrap_archives="${current}"
            error_exit "[ERROR]: Failed to bootstrap etcupdate: ${release}"
        else
            sysrc -f /usr/local/etc/bastille/bastille.conf bastille_bootstrap_archives="${current}"
        fi
    fi
}

bootstrap_etc_tarball() {

    local release="${1}"

    if [ ! -f ${bastille_cachedir}/${release}.tbz2 ]; then
        info "\nBuilding tarball, please wait..."
        if ! etcupdate build -d /tmp/etcupdate -s ${bastille_releasesdir}/${release}/usr/src ${bastille_cachedir}/${release}.tbz2; then
            error_exit "[ERROR]: Failed to build etcupdate tarball \"${release}.tbz2\""
        else
            info "\nEtcupdate bootstrap complete: ${release}"
        fi
    elif [ -f ${bastille_cachedir}/${release}.tbz2 ] && [ "${FORCE}" -eq 1 ]; then
        rm -f "${bastille_cachedir}/${release}.tbz2"
        info "\nBuilding tarball, please wait..."
        if ! etcupdate build -d /tmp/etcupdate -s ${bastille_releasesdir}/${release}/usr/src ${bastille_cachedir}/${release}.tbz2; then
            error_exit "[ERROR]: Failed to build etcupdate tarball: ${release}.tbz2"
        else
            info "\nEtcupdate bootstrap complete: ${release}"
        fi
    else
        info "\nEtcupdate release has already been prepared for application: ${release}"
    fi
}

diff_review() {

    local jail="${1}"

    if [ "${DRY_RUN}" -eq 1 ]; then
        error_exit "[ERROR]: diff mode does not support [-d|--dryrun]"
    fi

    echo "Running: etcupdate --diff mode"
    etcupdate diff -D "${bastille_jailsdir}/${jail}/root"
}

resolve_conflicts() {

    local jail="${1}"

    if [ "${DRY_RUN}" -eq 1 ]; then
        error_exit "[ERROR]: resolve mode does not support [-d|--dryrun]"
    fi

    echo "Running: etcupdate resolve"
    etcupdate resolve -D "${bastille_jailsdir}/${jail}/root"
}

update_jail_etc() {

    local jail="${1}"
    local release="${2}"

    if [ ! -f ${bastille_cachedir}/${release}.tbz2 ]; then
        error_exit "[ERROR]: Please run 'bastille etcupdate bootstrap RELEASE' first."
    fi
    if [ "${DRY_RUN}" -eq 1 ]; then
        echo "Running: etcupdate update --dry-run"
        etcupdate -n -D "${bastille_jailsdir}/${jail}/root" -t ${bastille_cachedir}/${release}.tbz2
    else
        echo "Running: etcupdate update"
        etcupdate -D "${bastille_jailsdir}/${jail}/root" -t ${bastille_cachedir}/${release}.tbz2
    fi
}

# Handle options.
DRY_RUN=0
FORCE=0
while [ "$#" -gt 0 ]; do
    case "${1}" in
        -h|--help|help)
            usage
            ;;
        -d|--dry-run)
            DRY_RUN=1
            shift
            ;;
        -f|--force)
            FORCE=1
            shift
            ;;
        -x|--debug)
            enable_debug
            shift
            ;;
        -*)
            for _opt in $(echo ${1} | sed 's/-//g' | fold -w1); do
                case ${_opt} in
                    d) DRY_RUN=1 ;;
                    f) FORCE=1 ;;
                    x) enable_debug ;;
                    *) error_exit "Unknown Option: \"${1}\"" ;;
                esac
            done
            shift
            ;;
        *)
            break
            ;;
    esac
done

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

# Main commands
while [ "$#" -gt 0 ]; do
    case "${1}" in
        bootstrap)
            if [ -z "${2}" ]; then
                usage
            else
                RELEASE="${2}"
                # Validate PKGBASE or non-PKGBASE
                HW_MACHINE_ARCH=$(sysctl hw.machine_arch | awk '{ print $2 }')
                MINOR_VERSION=$(echo ${RELEASE} | sed -E 's/^[0-9]+\.([0-9]+)-.*$/\1/')
                MAJOR_VERSION=$(echo ${RELEASE} | grep -Eo '^[0-9]+')
                if echo "${NEW_RELEASE}" | grep -oq "\-CURRENT"; then
                    FREEBSD_BRANCH="current"
                else
                    FREEBSD_BRANCH="release"
                fi
                info "\nAttempting to bootstrap etcupdate release: ${RELEASE}..."
                if [ "${MAJOR_VERSION}" -ge 16 ] || pkg -r "${bastille_releasesdir}/${RELEASE}" -N 2>/dev/null; then
                    PKGBASE=1
                else
                    PKGBASE=0
                fi
                if [ "${PKGBASE}" -eq 1 ]; then
                    bootstrap_etc_release_pkgbase "${RELEASE}"
                    bootstrap_etc_tarball "${RELEASE}"
                else
                    bootstrap_etc_release "${RELEASE}"
                    bootstrap_etc_tarball "${RELEASE}"
                fi
                shift "$#"
            fi
            ;;
        *)
            TARGET="${1}"
            ACTION="${2}"
            RELEASE="${3}"

            set_target_single "${TARGET}"

            info "\n[${TARGET}]:"

            case "${ACTION}" in
                diff)
                    diff_review "${TARGET}"
                    shift "$#"
                    ;;
                resolve)
                    resolve_conflicts "${TARGET}"
                    shift "$#"
                    ;;
                update)
                    if [ -z "${RELEASE}" ]; then
                        usage
                    else
                        update_jail_etc "${TARGET}" "${RELEASE}"
                        shift "$#"
                    fi
                    ;;
                *)
                    error_exit "[ERROR]: Unknown action: \"${ACTION}\""
                    ;;
            esac
            ;;
    esac
done