2020-11-01 08:39:36 +01:00
#!/usr/bin/env bash
2020-05-30 00:01:28 +02:00
#
# SPDX-License-Identifier: GPL-3.0-or-later
2008-09-07 03:39:35 +02:00
2011-06-18 23:38:58 +02:00
set -e -u
2020-08-01 13:51:11 +02:00
# Control the environment
umask 0022
export LANG="C"
export SOURCE_DATE_EPOCH="${SOURCE_DATE_EPOCH:-"$(date +%s)"}"
2012-03-17 17:47:09 +01:00
2020-12-05 13:13:56 +01:00
# Set application name from the script's file name
2020-08-01 13:51:11 +02:00
app_name="${0##*/}"
2020-12-05 13:13:56 +01:00
# Define global variables. All of them will be overwritten later
2020-06-25 23:01:54 +02:00
pkg_list=()
2020-12-05 13:13:56 +01:00
quiet=""
work_dir=""
out_dir=""
img_name=""
2020-08-01 13:51:11 +02:00
gpg_key=""
2020-12-05 13:13:56 +01:00
iso_name=""
iso_label=""
iso_publisher=""
iso_application=""
2020-08-14 06:52:59 +02:00
iso_version=""
2020-12-05 13:13:56 +01:00
install_dir=""
arch=""
pacman_conf=""
packages=""
2020-08-14 06:52:59 +02:00
bootmodes=()
2020-12-05 13:13:56 +01:00
airootfs_image_type=""
airootfs_image_tool_options=()
2020-11-14 10:43:13 +01:00
declare -A file_permissions=()
2020-08-14 06:52:59 +02:00
2011-06-18 23:38:58 +02:00
# Show an INFO message
# $1: message string
_msg_info() {
local _msg="${1}"
2020-08-01 13:51:11 +02:00
[[ "${quiet}" == "y" ]] || printf '[%s] INFO: %s\n' "${app_name}" "${_msg}"
2011-06-18 23:38:58 +02:00
}
2020-08-14 06:52:59 +02:00
# Show a WARNING message
# $1: message string
_msg_warning() {
local _msg="${1}"
2020-08-20 16:00:06 +02:00
printf '[%s] WARNING: %s\n' "${app_name}" "${_msg}" >&2
2020-08-14 06:52:59 +02:00
}
2011-06-18 23:38:58 +02:00
# Show an ERROR message then exit with status
# $1: message string
# $2: exit code number (with 0 does not exit)
_msg_error() {
local _msg="${1}"
local _error=${2}
2020-08-20 16:00:06 +02:00
printf '[%s] ERROR: %s\n' "${app_name}" "${_msg}" >&2
2020-08-01 13:51:11 +02:00
if (( _error > 0 )); then
2020-06-25 23:01:54 +02:00
exit "${_error}"
2011-06-18 23:38:58 +02:00
fi
}
2014-06-28 05:35:50 +02:00
_mount_airootfs() {
trap "_umount_airootfs" EXIT HUP INT TERM
2020-08-20 16:00:06 +02:00
install -d -m 0755 -- "${work_dir}/mnt/airootfs"
_msg_info "Mounting '${airootfs_dir}.img' on '${work_dir}/mnt/airootfs'..."
2020-08-14 06:52:59 +02:00
mount -- "${airootfs_dir}.img" "${work_dir}/mnt/airootfs"
2014-06-28 05:35:50 +02:00
_msg_info "Done!"
2011-06-18 23:38:58 +02:00
}
2014-06-28 05:35:50 +02:00
_umount_airootfs() {
2020-08-20 16:00:06 +02:00
_msg_info "Unmounting '${work_dir}/mnt/airootfs'..."
2020-08-01 13:51:11 +02:00
umount -d -- "${work_dir}/mnt/airootfs"
2014-06-28 05:35:50 +02:00
_msg_info "Done!"
2020-08-01 13:51:11 +02:00
rmdir -- "${work_dir}/mnt/airootfs"
2011-06-18 23:38:58 +02:00
trap - EXIT HUP INT TERM
}
# Show help usage, with an exit status.
# $1: exit status number.
2020-08-20 16:00:06 +02:00
_usage() {
2020-08-01 13:51:11 +02:00
IFS='' read -r -d '' usagetext <<ENDUSAGETEXT || true
2020-10-24 22:59:52 +02:00
usage: ${app_name} [options] <profile_dir>
Pass profile directory as parameter to mkarchiso
**archiso/mkarchiso**:
Change all override option parameters (i.e. `-A`, `-C`, `-D`, `-L`, `-P` and `-g`) to not directly override the global
variable they are tied to, but instead using an `override_` prefixed variable.
Add `_set_overrides()` to use `override_` prefixed variables (if set) to override those without a prefix.
Remove `-B` (a profile directory) from the list of parameters. The profile directory is now provided as separate
non-option parameter.
Add a call to `_read_profile()`, `_set_overrides()` and `command_build_profile()` to the fallthrough option of the
switch-case checking `command_name` - a non-option parameter to mkarchiso. This effectively provides the possibility to
set the profile directory using a non-option parameter, while still maintaining compatibility to legacy named arguments
used in the configs' `build.sh` scripts.
Extend the warning in regards to legacy `build.sh` based commands to mkarchiso by providing an EOL with archiso v49.
Change the help output to reflect the changes and further elaborate on the legacy commands used by `build.sh` scripts.
Change help output to be ordered alphabetically.
Add help output for `-r` and `-g` options.
Call `_set_overrides()` for legacy commands that accept one or more of the overriden options (i.e. `command_init`,
`command_install`, `command_prepare` and `command_iso`).
Various style fixes.
**configs/{baseline,releng}/build.sh**:
Change call to mkarchiso to use the profile's directory as a named argument instead of an option-argument.
**README.rst**:
Fix documentation on how to call mkarchiso with a profile directory.
Fix wording and ordering of option arguments for run_archiso documentation.
Fixes #52
2020-08-24 17:53:10 +02:00
options:
-A <application> Set an application name for the ISO
Default: '${iso_application}'
-C <file> pacman configuration file.
Default: '${pacman_conf}'
-D <install_dir> Set an install_dir. All files will by located here.
Default: '${install_dir}'
NOTE: Max 8 characters, use only [a-z0-9]
-L <label> Set the ISO volume label
Default: '${iso_label}'
-P <publisher> Set the ISO publisher
Default: '${iso_publisher}'
-g <gpg_key> Set the GPG key to be used for signing the sqashfs image
-h This message
-o <out_dir> Set the output directory
Default: '${out_dir}'
2020-12-05 13:13:56 +01:00
-p PACKAGE(S) Package(s) to install.
Multiple packages are provided as quoted, space delimited list.
Pass profile directory as parameter to mkarchiso
**archiso/mkarchiso**:
Change all override option parameters (i.e. `-A`, `-C`, `-D`, `-L`, `-P` and `-g`) to not directly override the global
variable they are tied to, but instead using an `override_` prefixed variable.
Add `_set_overrides()` to use `override_` prefixed variables (if set) to override those without a prefix.
Remove `-B` (a profile directory) from the list of parameters. The profile directory is now provided as separate
non-option parameter.
Add a call to `_read_profile()`, `_set_overrides()` and `command_build_profile()` to the fallthrough option of the
switch-case checking `command_name` - a non-option parameter to mkarchiso. This effectively provides the possibility to
set the profile directory using a non-option parameter, while still maintaining compatibility to legacy named arguments
used in the configs' `build.sh` scripts.
Extend the warning in regards to legacy `build.sh` based commands to mkarchiso by providing an EOL with archiso v49.
Change the help output to reflect the changes and further elaborate on the legacy commands used by `build.sh` scripts.
Change help output to be ordered alphabetically.
Add help output for `-r` and `-g` options.
Call `_set_overrides()` for legacy commands that accept one or more of the overriden options (i.e. `command_init`,
`command_install`, `command_prepare` and `command_iso`).
Various style fixes.
**configs/{baseline,releng}/build.sh**:
Change call to mkarchiso to use the profile's directory as a named argument instead of an option-argument.
**README.rst**:
Fix documentation on how to call mkarchiso with a profile directory.
Fix wording and ordering of option arguments for run_archiso documentation.
Fixes #52
2020-08-24 17:53:10 +02:00
-v Enable verbose output
-w <work_dir> Set the working directory
Default: '${work_dir}'
profile_dir: Directory of the archiso profile to build
2020-08-01 13:51:11 +02:00
ENDUSAGETEXT
2020-08-20 16:00:06 +02:00
printf '%s' "${usagetext}"
2020-06-25 23:01:54 +02:00
exit "${1}"
2008-09-07 03:39:35 +02:00
}
2020-11-01 08:39:36 +01:00
# Shows configuration options.
2020-08-20 16:00:06 +02:00
_show_config() {
2020-10-24 22:59:52 +02:00
local build_date
2020-09-28 19:12:01 +02:00
build_date="$(date --utc --iso-8601=seconds -d "@${SOURCE_DATE_EPOCH}")"
2020-08-20 16:00:06 +02:00
_msg_info "${app_name} configuration settings"
2011-06-18 23:38:58 +02:00
_msg_info " Architecture: ${arch}"
_msg_info " Working directory: ${work_dir}"
_msg_info " Installation directory: ${install_dir}"
2020-10-24 22:59:52 +02:00
_msg_info " Build date: ${build_date}"
_msg_info " Output directory: ${out_dir}"
_msg_info " GPG key: ${gpg_key:-None}"
_msg_info " Profile: ${profile}"
_msg_info "Pacman configuration file: ${pacman_conf}"
_msg_info " Image file name: ${img_name}"
_msg_info " ISO volume label: ${iso_label}"
_msg_info " ISO publisher: ${iso_publisher}"
_msg_info " ISO application: ${iso_application}"
_msg_info " Boot modes: ${bootmodes[*]}"
_msg_info " Packages: ${pkg_list[*]}"
2008-09-07 03:39:35 +02:00
}
2014-06-28 05:35:50 +02:00
# Cleanup airootfs
2020-11-01 08:39:36 +01:00
_cleanup_airootfs() {
2014-06-28 05:35:50 +02:00
_msg_info "Cleaning up what we can on airootfs..."
2012-03-16 05:48:10 +01:00
2020-08-12 16:34:33 +02:00
# Delete all files in /boot
2020-11-01 08:39:36 +01:00
[[ -d "${airootfs_dir}/boot" ]] && find "${airootfs_dir}/boot" -mindepth 1 -delete
2011-06-18 23:38:58 +02:00
# Delete pacman database sync cache files (*.tar.gz)
2020-11-01 08:39:36 +01:00
[[ -d "${airootfs_dir}/var/lib/pacman" ]] && find "${airootfs_dir}/var/lib/pacman" -maxdepth 1 -type f -delete
2011-06-18 23:38:58 +02:00
# Delete pacman database sync cache
2020-11-01 08:39:36 +01:00
[[ -d "${airootfs_dir}/var/lib/pacman/sync" ]] && find "${airootfs_dir}/var/lib/pacman/sync" -delete
2011-06-18 23:38:58 +02:00
# Delete pacman package cache
2020-11-01 08:39:36 +01:00
[[ -d "${airootfs_dir}/var/cache/pacman/pkg" ]] && find "${airootfs_dir}/var/cache/pacman/pkg" -type f -delete
2011-06-18 23:38:58 +02:00
# Delete all log files, keeps empty dirs.
2020-11-01 08:39:36 +01:00
[[ -d "${airootfs_dir}/var/log" ]] && find "${airootfs_dir}/var/log" -type f -delete
2011-06-18 23:38:58 +02:00
# Delete all temporary files and dirs
2020-11-01 08:39:36 +01:00
[[ -d "${airootfs_dir}/var/tmp" ]] && find "${airootfs_dir}/var/tmp" -mindepth 1 -delete
2012-03-16 05:48:10 +01:00
# Delete package pacman related files.
2020-08-01 13:51:11 +02:00
find "${work_dir}" \( -name '*.pacnew' -o -name '*.pacsave' -o -name '*.pacorig' \) -delete
2020-08-12 14:05:56 +02:00
# Create an empty /etc/machine-id
2021-04-27 12:45:17 +02:00
rm -f -- "${airootfs_dir}/etc/machine-id"
2020-08-18 20:59:18 +02:00
printf '' > "${airootfs_dir}/etc/machine-id"
2020-08-20 16:00:06 +02:00
_msg_info "Done!"
2008-09-14 06:18:10 +02:00
}
2008-09-07 03:39:35 +02:00
2020-11-01 08:39:36 +01:00
_run_mksquashfs() {
local image_path="${isofs_dir}/${install_dir}/${arch}/airootfs.sfs"
if [[ "${quiet}" == "y" ]]; then
mksquashfs "$@" "${image_path}" -noappend "${airootfs_image_tool_options[@]}" -no-progress > /dev/null
2020-10-30 22:20:05 +01:00
else
2020-11-01 08:39:36 +01:00
mksquashfs "$@" "${image_path}" -noappend "${airootfs_image_tool_options[@]}"
2020-10-30 22:20:05 +01:00
fi
}
2015-01-27 18:37:05 +01:00
# Makes a ext4 filesystem inside a SquashFS from a source directory.
2020-11-01 08:39:36 +01:00
_mkairootfs_ext4+squashfs() {
[[ -e "${airootfs_dir}" ]] || _msg_error "The path '${airootfs_dir}' does not exist" 1
2008-12-19 05:08:38 +01:00
2020-08-20 16:00:06 +02:00
_msg_info "Creating ext4 image of 32 GiB..."
2020-06-25 23:01:54 +02:00
if [[ "${quiet}" == "y" ]]; then
2020-08-20 16:00:06 +02:00
mkfs.ext4 -q -O '^has_journal,^resize_inode' -E 'lazy_itable_init=0' -m 0 -F -- "${airootfs_dir}.img" 32G
2020-08-01 13:51:11 +02:00
else
2020-08-20 16:00:06 +02:00
mkfs.ext4 -O '^has_journal,^resize_inode' -E 'lazy_itable_init=0' -m 0 -F -- "${airootfs_dir}.img" 32G
2009-12-04 19:02:44 +01:00
fi
2020-08-20 16:00:06 +02:00
tune2fs -c 0 -i 0 -- "${airootfs_dir}.img" > /dev/null
2012-05-27 05:28:05 +02:00
_msg_info "Done!"
2014-06-28 05:35:50 +02:00
_mount_airootfs
2020-08-14 06:52:59 +02:00
_msg_info "Copying '${airootfs_dir}/' to '${work_dir}/mnt/airootfs/'..."
cp -aT -- "${airootfs_dir}/" "${work_dir}/mnt/airootfs/"
2020-08-20 16:00:06 +02:00
chown -- 0:0 "${work_dir}/mnt/airootfs/"
2012-05-27 05:28:05 +02:00
_msg_info "Done!"
2014-06-28 05:35:50 +02:00
_umount_airootfs
2020-08-20 16:00:06 +02:00
install -d -m 0755 -- "${isofs_dir}/${install_dir}/${arch}"
2014-06-28 05:35:50 +02:00
_msg_info "Creating SquashFS image, this may take some time..."
2020-11-01 08:39:36 +01:00
_run_mksquashfs "${airootfs_dir}.img"
2014-06-28 05:35:50 +02:00
_msg_info "Done!"
2020-08-14 06:52:59 +02:00
rm -- "${airootfs_dir}.img"
2008-12-19 05:08:38 +01:00
}
2015-01-27 18:37:05 +01:00
# Makes a SquashFS filesystem from a source directory.
2020-11-01 08:39:36 +01:00
_mkairootfs_squashfs() {
[[ -e "${airootfs_dir}" ]] || _msg_error "The path '${airootfs_dir}' does not exist" 1
2015-01-27 18:37:05 +01:00
2020-08-20 16:00:06 +02:00
install -d -m 0755 -- "${isofs_dir}/${install_dir}/${arch}"
2015-01-27 18:37:05 +01:00
_msg_info "Creating SquashFS image, this may take some time..."
2020-11-01 08:39:36 +01:00
_run_mksquashfs "${airootfs_dir}"
2020-10-24 14:53:57 +02:00
}
# Makes an EROFS file system from a source directory.
_mkairootfs_erofs() {
local fsuuid
[[ -e "${airootfs_dir}" ]] || _msg_error "The path '${airootfs_dir}' does not exist" 1
install -d -m 0755 -- "${isofs_dir}/${install_dir}/${arch}"
local image_path="${isofs_dir}/${install_dir}/${arch}/airootfs.erofs"
# Generate reproducible file system UUID from SOURCE_DATE_EPOCH
fsuuid="$(uuidgen --sha1 --namespace 93a870ff-8565-4cf3-a67b-f47299271a96 --name "${SOURCE_DATE_EPOCH}")"
_msg_info "Creating EROFS image, this may take some time..."
mkfs.erofs -U "${fsuuid}" "${airootfs_image_tool_options[@]}" -- "${image_path}" "${airootfs_dir}"
2015-01-27 18:37:05 +01:00
_msg_info "Done!"
}
2020-08-20 16:00:06 +02:00
_mkchecksum() {
2014-06-28 05:35:51 +02:00
_msg_info "Creating checksum file for self-test..."
2020-08-02 11:58:42 +02:00
cd -- "${isofs_dir}/${install_dir}/${arch}"
2020-10-24 14:53:57 +02:00
if [[ -e "${isofs_dir}/${install_dir}/${arch}/airootfs.sfs" ]]; then
sha512sum airootfs.sfs > airootfs.sha512
elif [[ -e "${isofs_dir}/${install_dir}/${arch}/airootfs.erofs" ]]; then
sha512sum airootfs.erofs > airootfs.sha512
fi
2020-08-01 13:51:11 +02:00
cd -- "${OLDPWD}"
2014-06-28 05:35:51 +02:00
_msg_info "Done!"
2011-08-12 05:10:44 +02:00
}
2020-08-20 16:00:06 +02:00
_mksignature() {
_msg_info "Signing SquashFS image..."
2020-08-02 11:58:42 +02:00
cd -- "${isofs_dir}/${install_dir}/${arch}"
2020-10-24 14:53:57 +02:00
if [[ -e "${isofs_dir}/${install_dir}/${arch}/airootfs.sfs" ]]; then
gpg --detach-sign --default-key "${gpg_key}" airootfs.sfs
elif [[ -e "${isofs_dir}/${install_dir}/${arch}/airootfs.erofs" ]]; then
gpg --detach-sign --default-key "${gpg_key}" airootfs.erofs
fi
2020-08-01 13:51:11 +02:00
cd -- "${OLDPWD}"
2016-02-13 01:08:50 +01:00
_msg_info "Done!"
}
2020-08-02 11:58:42 +02:00
# Helper function to run functions only one time.
_run_once() {
if [[ ! -e "${work_dir}/build.${1}" ]]; then
"$1"
touch "${work_dir}/build.${1}"
fi
}
2020-08-14 06:52:59 +02:00
2020-10-23 22:13:52 +02:00
# Set up custom pacman.conf with custom cache and pacman hook directories
2020-08-02 11:58:42 +02:00
_make_pacman_conf() {
2020-10-23 22:13:52 +02:00
local _cache_dirs _system_cache_dirs _profile_cache_dirs
_system_cache_dirs="$(pacman-conf CacheDir| tr '\n' ' ')"
_profile_cache_dirs="$(pacman-conf --config "${pacman_conf}" CacheDir| tr '\n' ' ')"
# only use the profile's CacheDir, if it is not the default and not the same as the system cache dir
if [[ "${_profile_cache_dirs}" != "/var/cache/pacman/pkg" ]] && \
[[ "${_system_cache_dirs}" != "${_profile_cache_dirs}" ]]; then
_cache_dirs="${_profile_cache_dirs}"
else
_cache_dirs="${_system_cache_dirs}"
fi
_msg_info "Copying custom pacman.conf to work directory..."
_msg_info "Using pacman CacheDir: ${_cache_dirs}"
2020-12-05 11:01:07 +01:00
# take the profile pacman.conf and strip all settings that would break in chroot when using pacman -r
2020-10-23 22:13:52 +02:00
# append CacheDir and HookDir to [options] section
# HookDir is *always* set to the airootfs' override directory
2020-12-05 11:01:07 +01:00
# see `man 8 pacman` for further info
pacman-conf --config "${pacman_conf}" | \
sed "/CacheDir/d;/DBPath/d;/HookDir/d;/LogFile/d;/RootDir/d;/\[options\]/a CacheDir = ${_cache_dirs}
/\[options\]/a HookDir = ${airootfs_dir}/etc/pacman.d/hooks/" > "${work_dir}/pacman.conf"
2020-08-02 11:58:42 +02:00
}
# Prepare working directory and copy custom airootfs files (airootfs)
_make_custom_airootfs() {
local passwd=()
2020-11-14 10:43:13 +01:00
local filename permissions
2020-08-20 16:00:06 +02:00
install -d -m 0755 -o 0 -g 0 -- "${airootfs_dir}"
2020-08-02 11:58:42 +02:00
if [[ -d "${profile}/airootfs" ]]; then
2020-11-14 10:43:13 +01:00
_msg_info "Copying custom airootfs files..."
cp -af --no-preserve=ownership,mode -- "${profile}/airootfs/." "${airootfs_dir}"
# Set ownership and mode for files and directories
for filename in "${!file_permissions[@]}"; do
IFS=':' read -ra permissions <<< "${file_permissions["${filename}"]}"
2020-11-30 08:19:05 +01:00
# Prevent file path traversal outside of $airootfs_dir
2020-12-05 13:13:56 +01:00
if [[ "$(realpath -q -- "${airootfs_dir}${filename}")" != "${airootfs_dir}"* ]]; then
2020-11-30 08:19:05 +01:00
_msg_error "Failed to set permissions on '${airootfs_dir}${filename}'. Outside of valid path." 1
# Warn if the file does not exist
elif [[ ! -e "${airootfs_dir}${filename}" ]]; then
2020-11-14 10:43:13 +01:00
_msg_warning "Cannot change permissions of '${airootfs_dir}${filename}'. The file or directory does not exist."
2020-11-30 08:19:05 +01:00
else
2021-03-21 15:00:13 +01:00
if [[ "${filename: -1}" == "/" ]]; then
chown -fhR -- "${permissions[0]}:${permissions[1]}" "${airootfs_dir}${filename}"
chmod -fR -- "${permissions[2]}" "${airootfs_dir}${filename}"
else
chown -fh -- "${permissions[0]}:${permissions[1]}" "${airootfs_dir}${filename}"
chmod -f -- "${permissions[2]}" "${airootfs_dir}${filename}"
fi
2020-11-14 10:43:13 +01:00
fi
done
2020-08-20 16:00:06 +02:00
_msg_info "Done!"
2020-08-02 11:58:42 +02:00
fi
}
2020-11-01 08:39:36 +01:00
# Install desired packages to airootfs
2020-08-02 11:58:42 +02:00
_make_packages() {
2020-11-01 08:39:36 +01:00
_msg_info "Installing packages to '${airootfs_dir}/'..."
2020-08-02 11:58:42 +02:00
if [[ -n "${gpg_key}" ]]; then
exec {ARCHISO_GNUPG_FD}<>"${work_dir}/pubkey.gpg"
export ARCHISO_GNUPG_FD
fi
2020-11-01 08:39:36 +01:00
if [[ "${quiet}" = "y" ]]; then
pacstrap -C "${work_dir}/pacman.conf" -c -G -M -- "${airootfs_dir}" "${pkg_list[@]}" &> /dev/null
else
pacstrap -C "${work_dir}/pacman.conf" -c -G -M -- "${airootfs_dir}" "${pkg_list[@]}"
fi
2020-08-02 11:58:42 +02:00
if [[ -n "${gpg_key}" ]]; then
exec {ARCHISO_GNUPG_FD}<&-
unset ARCHISO_GNUPG_FD
fi
2020-11-01 08:39:36 +01:00
_msg_info "Done! Packages installed successfully."
2020-08-02 11:58:42 +02:00
}
# Customize installation (airootfs)
_make_customize_airootfs() {
local passwd=()
2020-08-20 16:00:06 +02:00
2020-08-02 11:58:42 +02:00
if [[ -e "${profile}/airootfs/etc/passwd" ]]; then
2020-08-20 16:00:06 +02:00
_msg_info "Copying /etc/skel/* to user homes..."
2020-08-02 11:58:42 +02:00
while IFS=':' read -a passwd -r; do
2020-11-30 08:19:05 +01:00
# Only operate on UIDs in range 1000– 59999
2020-08-30 17:12:08 +02:00
(( passwd[2] >= 1000 && passwd[2] < 60000 )) || continue
2020-11-30 08:19:05 +01:00
# Skip invalid home directories
2020-08-20 16:00:06 +02:00
[[ "${passwd[5]}" == '/' ]] && continue
[[ -z "${passwd[5]}" ]] && continue
2020-11-30 08:19:05 +01:00
# Prevent path traversal outside of $airootfs_dir
if [[ "$(realpath -q -- "${airootfs_dir}${passwd[5]}")" == "${airootfs_dir}"* ]]; then
if [[ ! -d "${airootfs_dir}${passwd[5]}" ]]; then
install -d -m 0750 -o "${passwd[2]}" -g "${passwd[3]}" -- "${airootfs_dir}${passwd[5]}"
fi
cp -dnRT --preserve=mode,timestamps,links -- "${airootfs_dir}/etc/skel/." "${airootfs_dir}${passwd[5]}"
chmod -f 0750 -- "${airootfs_dir}${passwd[5]}"
chown -hR -- "${passwd[2]}:${passwd[3]}" "${airootfs_dir}${passwd[5]}"
else
_msg_error "Failed to set permissions on '${airootfs_dir}${passwd[5]}'. Outside of valid path." 1
2020-11-14 10:43:13 +01:00
fi
2020-08-02 11:58:42 +02:00
done < "${profile}/airootfs/etc/passwd"
2020-08-20 16:00:06 +02:00
_msg_info "Done!"
2020-08-02 11:58:42 +02:00
fi
if [[ -e "${airootfs_dir}/root/customize_airootfs.sh" ]]; then
2020-08-20 16:00:06 +02:00
_msg_info "Running customize_airootfs.sh in '${airootfs_dir}' chroot..."
2020-08-02 11:58:42 +02:00
_msg_warning "customize_airootfs.sh is deprecated! Support for it will be removed in a future archiso version."
2020-11-14 10:43:13 +01:00
chmod -f -- +x "${airootfs_dir}/root/customize_airootfs.sh"
2020-11-01 08:39:36 +01:00
eval -- arch-chroot "${airootfs_dir}" "/root/customize_airootfs.sh"
2020-08-02 11:58:42 +02:00
rm -- "${airootfs_dir}/root/customize_airootfs.sh"
2020-08-20 16:00:06 +02:00
_msg_info "Done! customize_airootfs.sh run successfully."
2020-08-02 11:58:42 +02:00
fi
}
2020-08-12 18:42:02 +02:00
# Set up boot loaders
_make_bootmodes() {
local bootmode
for bootmode in "${bootmodes[@]}"; do
2020-11-01 10:43:56 +01:00
_run_once "_make_bootmode_${bootmode}"
2020-08-12 18:42:02 +02:00
done
}
2020-08-02 11:58:42 +02:00
# Prepare kernel/initramfs ${install_dir}/boot/
2020-11-01 08:39:36 +01:00
_make_boot_on_iso9660() {
2020-09-02 22:45:18 +02:00
local ucode_image
2021-01-05 22:26:15 +01:00
_msg_info "Preparing kernel and initramfs for the ISO 9660 file system..."
2020-08-20 16:00:06 +02:00
install -d -m 0755 -- "${isofs_dir}/${install_dir}/boot/${arch}"
2020-09-02 22:45:18 +02:00
install -m 0644 -- "${airootfs_dir}/boot/initramfs-"*".img" "${isofs_dir}/${install_dir}/boot/${arch}/"
install -m 0644 -- "${airootfs_dir}/boot/vmlinuz-"* "${isofs_dir}/${install_dir}/boot/${arch}/"
for ucode_image in {intel-uc.img,intel-ucode.img,amd-uc.img,amd-ucode.img,early_ucode.cpio,microcode.cpio}; do
if [[ -e "${airootfs_dir}/boot/${ucode_image}" ]]; then
install -m 0644 -- "${airootfs_dir}/boot/${ucode_image}" "${isofs_dir}/${install_dir}/boot/"
if [[ -e "${airootfs_dir}/usr/share/licenses/${ucode_image%.*}/" ]]; then
install -d -m 0755 -- "${isofs_dir}/${install_dir}/boot/licenses/${ucode_image%.*}/"
install -m 0644 -- "${airootfs_dir}/usr/share/licenses/${ucode_image%.*}/"* \
"${isofs_dir}/${install_dir}/boot/licenses/${ucode_image%.*}/"
fi
fi
done
2020-08-20 16:00:06 +02:00
_msg_info "Done!"
2020-08-02 11:58:42 +02:00
}
2020-11-17 13:10:21 +01:00
# Prepare /syslinux for booting from MBR
2020-11-01 08:39:36 +01:00
_make_bootmode_bios.syslinux.mbr() {
2020-08-20 16:00:06 +02:00
_msg_info "Setting up SYSLINUX for BIOS booting from a disk..."
2020-11-17 13:10:21 +01:00
install -d -m 0755 -- "${isofs_dir}/syslinux"
2020-08-02 11:58:42 +02:00
for _cfg in "${profile}/syslinux/"*.cfg; do
sed "s|%ARCHISO_LABEL%|${iso_label}|g;
2020-08-12 18:42:02 +02:00
s|%INSTALL_DIR%|${install_dir}|g;
s|%ARCH%|${arch}|g" \
2020-11-17 13:10:21 +01:00
"${_cfg}" > "${isofs_dir}/syslinux/${_cfg##*/}"
2020-08-02 11:58:42 +02:00
done
2020-08-12 18:42:02 +02:00
if [[ -e "${profile}/syslinux/splash.png" ]]; then
2020-11-17 13:10:21 +01:00
install -m 0644 -- "${profile}/syslinux/splash.png" "${isofs_dir}/syslinux/"
2020-08-12 18:42:02 +02:00
fi
2020-11-17 13:10:21 +01:00
install -m 0644 -- "${airootfs_dir}/usr/lib/syslinux/bios/"*.c32 "${isofs_dir}/syslinux/"
install -m 0644 -- "${airootfs_dir}/usr/lib/syslinux/bios/lpxelinux.0" "${isofs_dir}/syslinux/"
install -m 0644 -- "${airootfs_dir}/usr/lib/syslinux/bios/memdisk" "${isofs_dir}/syslinux/"
2020-08-12 18:42:02 +02:00
2020-11-01 08:39:36 +01:00
_run_once _make_boot_on_iso9660
2020-08-12 18:42:02 +02:00
2020-11-17 13:10:21 +01:00
if [[ -e "${isofs_dir}/syslinux/hdt.c32" ]]; then
install -d -m 0755 -- "${isofs_dir}/syslinux/hdt"
2020-09-02 22:45:18 +02:00
if [[ -e "${airootfs_dir}/usr/share/hwdata/pci.ids" ]]; then
2021-04-27 12:03:29 +02:00
gzip -cn9 "${airootfs_dir}/usr/share/hwdata/pci.ids" > \
2020-11-17 13:10:21 +01:00
"${isofs_dir}/syslinux/hdt/pciids.gz"
2020-09-02 22:45:18 +02:00
fi
2021-04-27 12:03:29 +02:00
find "${airootfs_dir}/usr/lib/modules" -name 'modules.alias' -print -exec gzip -cn9 '{}' ';' -quit > \
2020-11-17 13:10:21 +01:00
"${isofs_dir}/syslinux/hdt/modalias.gz"
2020-09-02 22:45:18 +02:00
fi
2020-08-12 18:42:02 +02:00
# Add other aditional/extra files to ${install_dir}/boot/
if [[ -e "${airootfs_dir}/boot/memtest86+/memtest.bin" ]]; then
# rename for PXE: https://wiki.archlinux.org/index.php/Syslinux#Using_memtest
install -m 0644 -- "${airootfs_dir}/boot/memtest86+/memtest.bin" "${isofs_dir}/${install_dir}/boot/memtest"
2020-08-20 16:00:06 +02:00
install -d -m 0755 -- "${isofs_dir}/${install_dir}/boot/licenses/memtest86+/"
2020-08-12 18:42:02 +02:00
install -m 0644 -- "${airootfs_dir}/usr/share/licenses/common/GPL2/license.txt" \
"${isofs_dir}/${install_dir}/boot/licenses/memtest86+/"
fi
2020-08-20 16:00:06 +02:00
_msg_info "Done! SYSLINUX set up for BIOS booting from a disk successfully."
2020-08-02 11:58:42 +02:00
}
2020-11-17 13:10:21 +01:00
# Prepare /syslinux for El-Torito booting
2020-11-01 08:39:36 +01:00
_make_bootmode_bios.syslinux.eltorito() {
2020-08-20 16:00:06 +02:00
_msg_info "Setting up SYSLINUX for BIOS booting from an optical disc..."
2020-11-17 13:10:21 +01:00
install -d -m 0755 -- "${isofs_dir}/syslinux"
install -m 0644 -- "${airootfs_dir}/usr/lib/syslinux/bios/isolinux.bin" "${isofs_dir}/syslinux/"
install -m 0644 -- "${airootfs_dir}/usr/lib/syslinux/bios/isohdpfx.bin" "${isofs_dir}/syslinux/"
2020-08-12 18:42:02 +02:00
2020-11-17 13:10:21 +01:00
# ISOLINUX and SYSLINUX installation is shared
2020-11-01 08:39:36 +01:00
_run_once _make_bootmode_bios.syslinux.mbr
2020-08-20 16:00:06 +02:00
_msg_info "Done! SYSLINUX set up for BIOS booting from an optical disc successfully."
2020-08-02 11:58:42 +02:00
}
# Prepare /EFI on ISO-9660
2020-11-01 08:39:36 +01:00
_make_efi_dir_on_iso9660() {
2020-08-20 16:00:06 +02:00
_msg_info "Preparing an /EFI directory for the ISO 9660 file system..."
install -d -m 0755 -- "${isofs_dir}/EFI/BOOT"
2020-08-02 11:58:42 +02:00
install -m 0644 -- "${airootfs_dir}/usr/lib/systemd/boot/efi/systemd-bootx64.efi" \
"${isofs_dir}/EFI/BOOT/BOOTx64.EFI"
2020-08-20 16:00:06 +02:00
install -d -m 0755 -- "${isofs_dir}/loader/entries"
2020-08-02 11:58:42 +02:00
install -m 0644 -- "${profile}/efiboot/loader/loader.conf" "${isofs_dir}/loader/"
2020-09-02 22:45:18 +02:00
for _conf in "${profile}/efiboot/loader/entries/"*".conf"; do
sed "s|%ARCHISO_LABEL%|${iso_label}|g;
s|%INSTALL_DIR%|${install_dir}|g;
s|%ARCH%|${arch}|g" \
"${_conf}" > "${isofs_dir}/loader/entries/${_conf##*/}"
done
2020-08-02 11:58:42 +02:00
# edk2-shell based UEFI shell
# shellx64.efi is picked up automatically when on /
2020-08-12 18:42:02 +02:00
if [[ -e "${airootfs_dir}/usr/share/edk2-shell/x64/Shell_Full.efi" ]]; then
install -m 0644 -- "${airootfs_dir}/usr/share/edk2-shell/x64/Shell_Full.efi" "${isofs_dir}/shellx64.efi"
fi
2020-08-20 16:00:06 +02:00
_msg_info "Done!"
2020-08-02 11:58:42 +02:00
}
2020-08-12 18:42:02 +02:00
# Prepare kernel/initramfs on efiboot.img
_make_boot_on_fat() {
2020-09-02 22:45:18 +02:00
local ucode_image all_ucode_images=()
2021-01-05 22:26:15 +01:00
_msg_info "Preparing kernel and initramfs for the FAT file system..."
2020-10-04 15:13:22 +02:00
mmd -i "${work_dir}/efiboot.img" \
2020-09-02 23:03:38 +02:00
"::/${install_dir}" "::/${install_dir}/boot" "::/${install_dir}/boot/${arch}"
2020-10-04 15:13:22 +02:00
mcopy -i "${work_dir}/efiboot.img" "${airootfs_dir}/boot/vmlinuz-"* \
2020-09-02 22:45:18 +02:00
"${airootfs_dir}/boot/initramfs-"*".img" "::/${install_dir}/boot/${arch}/"
for ucode_image in \
"${airootfs_dir}/boot/"{intel-uc.img,intel-ucode.img,amd-uc.img,amd-ucode.img,early_ucode.cpio,microcode.cpio}
do
if [[ -e "${ucode_image}" ]]; then
all_ucode_images+=("${ucode_image}")
fi
done
if (( ${#all_ucode_images[@]} )); then
2020-10-04 15:13:22 +02:00
mcopy -i "${work_dir}/efiboot.img" "${all_ucode_images[@]}" "::/${install_dir}/boot/"
2020-08-12 18:42:02 +02:00
fi
2020-08-20 16:00:06 +02:00
_msg_info "Done!"
2020-08-12 18:42:02 +02:00
}
# Prepare efiboot.img::/EFI for EFI boot mode
2020-11-01 08:39:36 +01:00
_make_bootmode_uefi-x64.systemd-boot.esp() {
2020-09-17 13:17:27 +02:00
local efiboot_imgsize="0"
2020-08-20 16:00:06 +02:00
_msg_info "Setting up systemd-boot for UEFI booting..."
2020-08-02 11:58:42 +02:00
2020-10-03 19:58:41 +02:00
# the required image size in KiB (rounded up to the next full MiB with an additional MiB for reserved sectors)
efiboot_imgsize="$(du -bc \
2020-09-17 13:17:27 +02:00
"${airootfs_dir}/usr/lib/systemd/boot/efi/systemd-bootx64.efi" \
"${airootfs_dir}/usr/share/edk2-shell/x64/Shell_Full.efi" \
"${profile}/efiboot/" \
"${airootfs_dir}/boot/vmlinuz-"* \
"${airootfs_dir}/boot/initramfs-"*".img" \
"${airootfs_dir}/boot/"{intel-uc.img,intel-ucode.img,amd-uc.img,amd-ucode.img,early_ucode.cpio,microcode.cpio} \
2020-10-03 19:58:41 +02:00
2>/dev/null | awk 'function ceil(x){return int(x)+(x>int(x))}
function byte_to_kib(x){return x/1024}
function mib_to_kib(x){return x*1024}
END {print mib_to_kib(ceil((byte_to_kib($1)+1024)/1024))}'
)"
2020-09-02 18:10:07 +02:00
# The FAT image must be created with mkfs.fat not mformat, as some systems have issues with mformat made images:
# https://lists.gnu.org/archive/html/grub-devel/2019-04/msg00099.html
2020-10-04 15:13:22 +02:00
[[ -e "${work_dir}/efiboot.img" ]] && rm -f -- "${work_dir}/efiboot.img"
2020-10-03 19:58:41 +02:00
_msg_info "Creating FAT image of size: ${efiboot_imgsize} KiB..."
2020-10-04 15:13:22 +02:00
mkfs.fat -C -n ARCHISO_EFI "${work_dir}/efiboot.img" "$efiboot_imgsize"
2020-08-02 11:58:42 +02:00
2020-10-04 15:13:22 +02:00
mmd -i "${work_dir}/efiboot.img" ::/EFI ::/EFI/BOOT
mcopy -i "${work_dir}/efiboot.img" \
2020-09-02 18:10:07 +02:00
"${airootfs_dir}/usr/lib/systemd/boot/efi/systemd-bootx64.efi" ::/EFI/BOOT/BOOTx64.EFI
2020-08-02 11:58:42 +02:00
2020-10-04 15:13:22 +02:00
mmd -i "${work_dir}/efiboot.img" ::/loader ::/loader/entries
mcopy -i "${work_dir}/efiboot.img" "${profile}/efiboot/loader/loader.conf" ::/loader/
2020-09-02 22:45:18 +02:00
for _conf in "${profile}/efiboot/loader/entries/"*".conf"; do
sed "s|%ARCHISO_LABEL%|${iso_label}|g;
s|%INSTALL_DIR%|${install_dir}|g;
s|%ARCH%|${arch}|g" \
2020-10-04 15:13:22 +02:00
"${_conf}" | mcopy -i "${work_dir}/efiboot.img" - "::/loader/entries/${_conf##*/}"
2020-09-02 22:45:18 +02:00
done
2020-08-02 11:58:42 +02:00
# shellx64.efi is picked up automatically when on /
2020-08-12 18:42:02 +02:00
if [[ -e "${airootfs_dir}/usr/share/edk2-shell/x64/Shell_Full.efi" ]]; then
2020-10-04 15:13:22 +02:00
mcopy -i "${work_dir}/efiboot.img" \
2020-09-02 18:10:07 +02:00
"${airootfs_dir}/usr/share/edk2-shell/x64/Shell_Full.efi" ::/shellx64.efi
2020-08-12 18:42:02 +02:00
fi
# Copy kernel and initramfs
2020-10-04 10:28:53 +02:00
_make_boot_on_fat
2012-04-09 03:26:27 +02:00
2020-08-20 16:00:06 +02:00
_msg_info "Done! systemd-boot set up for UEFI booting successfully."
2020-08-02 11:58:42 +02:00
}
2020-08-12 18:42:02 +02:00
# Prepare efiboot.img::/EFI for "El Torito" EFI boot mode
2020-11-01 08:39:36 +01:00
_make_bootmode_uefi-x64.systemd-boot.eltorito() {
_run_once _make_bootmode_uefi-x64.systemd-boot.esp
# Set up /EFI on ISO-9660 to allow preparing an installation medium by manually copying files
_run_once _make_efi_dir_on_iso9660
2020-08-12 18:42:02 +02:00
}
2020-11-01 10:43:56 +01:00
_validate_requirements_bootmode_bios.syslinux.mbr() {
# bios.syslinux.mbr requires bios.syslinux.eltorito
# shellcheck disable=SC2076
if [[ ! " ${bootmodes[*]} " =~ ' bios.syslinux.eltorito ' ]]; then
(( validation_error=validation_error+1 ))
_msg_error "Using 'bios.syslinux.mbr' boot mode without 'bios.syslinux.eltorito' is not supported." 0
fi
# Check if the syslinux package is in the package list
# shellcheck disable=SC2076
if [[ ! " ${pkg_list[*]} " =~ ' syslinux ' ]]; then
(( validation_error=validation_error+1 ))
_msg_error "Validating '${bootmode}': The 'syslinux' package is missing from the package list!" 0
fi
# Check if syslinux configuration files exist
if [[ ! -d "${profile}/syslinux" ]]; then
(( validation_error=validation_error+1 ))
_msg_error "Validating '${bootmode}': The '${profile}/syslinux' directory is missing!" 0
2020-10-30 22:20:05 +01:00
else
2020-11-01 10:43:56 +01:00
local cfgfile
for cfgfile in "${profile}/syslinux/"*'.cfg'; do
if [[ -e "${cfgfile}" ]]; then
break
else
(( validation_error=validation_error+1 ))
_msg_error "Validating '${bootmode}': No configuration file found in '${profile}/syslinux/'!" 0
fi
done
fi
# Check for optional packages
# shellcheck disable=SC2076
if [[ ! " ${pkg_list[*]} " =~ ' memtest86+ ' ]]; then
_msg_info "Validating '${bootmode}': 'memtest86+' is not in the package list. Memmory testing will not be available from syslinux."
2020-08-02 11:58:42 +02:00
fi
2020-11-01 10:43:56 +01:00
}
2020-11-01 08:39:36 +01:00
2020-11-01 10:43:56 +01:00
_validate_requirements_bootmode_bios.syslinux.eltorito() {
2020-11-17 13:10:21 +01:00
_validate_requirements_bootmode_bios.syslinux.mbr
2020-11-01 10:43:56 +01:00
}
_validate_requirements_bootmode_uefi-x64.systemd-boot.esp() {
# Check if mkfs.fat is available
if ! command -v mkfs.fat &> /dev/null; then
(( validation_error=validation_error+1 ))
_msg_error "Validating '${bootmode}': mkfs.fat is not available on this host. Install 'dosfstools'!" 0
fi
# Check if mmd and mcopy are available
if ! { command -v mmd &> /dev/null && command -v mcopy &> /dev/null; }; then
_msg_error "Validating '${bootmode}': mmd and/or mcopy are not available on this host. Install 'mtools'!" 0
fi
# Check if systemd-boot configuration files exist
if [[ ! -d "${profile}/efiboot/loader/entries" ]]; then
(( validation_error=validation_error+1 ))
_msg_error "Validating '${bootmode}': The '${profile}/efiboot/loader/entries' directory is missing!" 0
else
if [[ ! -e "${profile}/efiboot/loader/loader.conf" ]]; then
(( validation_error=validation_error+1 ))
_msg_error "Validating '${bootmode}': File '${profile}/efiboot/loader/loader.conf' not found!" 0
fi
local conffile
for conffile in "${profile}/efiboot/loader/entries/"*'.conf'; do
if [[ -e "${conffile}" ]]; then
break
else
(( validation_error=validation_error+1 ))
_msg_error "Validating '${bootmode}': No configuration file found in '${profile}/efiboot/loader/entries/'!" 0
fi
done
fi
# Check for optional packages
# shellcheck disable=SC2076
if [[ ! " ${pkg_list[*]} " =~ ' edk2-shell ' ]]; then
_msg_info "'edk2-shell' is not in the package list. The ISO will not contain a bootable UEFI shell."
fi
}
_validate_requirements_bootmode_uefi-x64.systemd-boot.eltorito() {
# uefi-x64.systemd-boot.eltorito has the exact same requirements as uefi-x64.systemd-boot.esp
_validate_requirements_bootmode_uefi-x64.systemd-boot.esp
}
# Build airootfs filesystem image
_prepare_airootfs_image() {
_run_once "_mkairootfs_${airootfs_image_type}"
2020-08-02 11:58:42 +02:00
_mkchecksum
2020-11-18 19:24:02 +01:00
if [[ -n "${gpg_key}" ]]; then
_mksignature
fi
2020-08-02 11:58:42 +02:00
}
2020-11-01 10:43:56 +01:00
_validate_requirements_airootfs_image_type_squashfs() {
if ! command -v mksquashfs &> /dev/null; then
(( validation_error=validation_error+1 ))
_msg_error "Validating '${airootfs_image_type}': mksquashfs is not available on this host. Install 'squashfs-tools'!" 0
fi
}
_validate_requirements_airootfs_image_type_ext4+squashfs() {
if ! { command -v mkfs.ext4 &> /dev/null && command -v tune2fs &> /dev/null; }; then
(( validation_error=validation_error+1 ))
_msg_error "Validating '${airootfs_image_type}': mkfs.ext4 and/or tune2fs is not available on this host. Install 'e2fsprogs'!" 0
fi
_validate_requirements_airootfs_image_type_squashfs
}
2020-10-24 14:53:57 +02:00
_validate_requirements_airootfs_image_type_erofs() {
if ! command -v mkfs.erofs; then
(( validation_error=validation_error+1 ))
_msg_error "Validating '${airootfs_image_type}': mkfs.erofs is not available on this host. Install 'erofs-utils'!" 0
fi
}
2020-11-01 14:39:27 +01:00
# SYSLINUX El Torito
_add_xorrisofs_options_bios.syslinux.eltorito() {
xorrisofs_options+=(
# El Torito boot image for x86 BIOS
2020-11-17 13:10:21 +01:00
'-eltorito-boot' 'syslinux/isolinux.bin'
2020-11-01 14:39:27 +01:00
# El Torito boot catalog file
2020-11-17 13:10:21 +01:00
'-eltorito-catalog' 'syslinux/boot.cat'
2020-11-01 14:39:27 +01:00
# Required options to boot with ISOLINUX
'-no-emul-boot' '-boot-load-size' '4' '-boot-info-table'
)
}
# SYSLINUX MBR
_add_xorrisofs_options_bios.syslinux.mbr() {
xorrisofs_options+=(
2020-11-17 13:10:21 +01:00
# SYSLINUX MBR bootstrap code; does not work without "-eltorito-boot syslinux/isolinux.bin"
'-isohybrid-mbr' "${isofs_dir}/syslinux/isohdpfx.bin"
2020-11-01 14:39:27 +01:00
# When GPT is used, create an additional partition in the MBR (besides 0xEE) for sectors 0– 1 (MBR
# bootstrap code area) and mark it as bootable
2021-03-06 08:59:22 +01:00
# May allow booting on some systems
2020-11-01 14:39:27 +01:00
# https://wiki.archlinux.org/index.php/Partitioning#Tricking_old_BIOS_into_booting_from_GPT
'--mbr-force-bootable'
2021-03-06 08:59:22 +01:00
# Move the first partition away from the start of the ISO to match the expectations of partition editors
2020-11-01 14:39:27 +01:00
# May allow booting on some systems
# https://dev.lovelyhq.com/libburnia/libisoburn/src/branch/master/doc/partition_offset.wiki
'-partition_offset' '16'
)
}
# systemd-boot in an attached EFI system partition
_add_xorrisofs_options_uefi-x64.systemd-boot.esp() {
# Move the first partition away from the start of the ISO, otherwise the GPT will not be valid and ISO 9660
# partition will not be mountable
# shellcheck disable=SC2076
[[ " ${xorrisofs_options[*]} " =~ ' -partition_offset ' ]] || xorrisofs_options+=('-partition_offset' '16')
2021-03-06 08:59:22 +01:00
# Attach efiboot.img as a second partition and set its partition type to "EFI system partition"
xorrisofs_options+=('-append_partition' '2' 'C12A7328-F81F-11D2-BA4B-00A0C93EC93B' "${work_dir}/efiboot.img")
# Ensure GPT is used as some systems do not support UEFI booting without it
# shellcheck disable=SC2076
if [[ " ${bootmodes[*]} " =~ ' bios.syslinux.mbr ' ]]; then
# A valid GPT prevents BIOS booting on some systems, instead use an invalid GPT (without a protective MBR).
# The attached partition will have the EFI system partition type code in MBR, but in the invalid GPT it will
# have a Microsoft basic partition type code.
if [[ ! " ${bootmodes[*]} " =~ ' uefi-x64.systemd-boot.eltorito ' ]]; then
# If '-isohybrid-gpt-basdat' is specified before '-e', then the appended EFI system partition will have the
# EFI system partition type ID/GUID in both MBR and GPT. If '-isohybrid-gpt-basdat' is specified after '-e',
# the appended EFI system partition will have the Microsoft basic data type GUID in GPT.
if [[ ! " ${xorrisofs_options[*]} " =~ ' -isohybrid-gpt-basdat ' ]]; then
xorrisofs_options+=('-isohybrid-gpt-basdat')
fi
fi
else
# Use valid GPT if BIOS booting support will not be required
xorrisofs_options+=('-appended_part_as_gpt')
fi
2020-11-01 14:39:27 +01:00
}
# systemd-boot via El Torito
_add_xorrisofs_options_uefi-x64.systemd-boot.eltorito() {
# shellcheck disable=SC2076
if [[ " ${bootmodes[*]} " =~ ' uefi-x64.systemd-boot.esp ' ]]; then
# systemd-boot in an attached EFI system partition via El Torito
xorrisofs_options+=(
# Start a new El Torito boot entry for UEFI
'-eltorito-alt-boot'
# Set the second partition as the El Torito UEFI boot image
'-e' '--interval:appended_partition_2:all::'
# Boot image is not emulating floppy or hard disk; required for all known boot loaders
'-no-emul-boot'
)
2021-03-06 08:59:22 +01:00
# A valid GPT prevents BIOS booting on some systems, use an invalid GPT instead.
if [[ " ${bootmodes[*]} " =~ ' bios.syslinux.mbr ' ]]; then
# If '-isohybrid-gpt-basdat' is specified before '-e', then the appended EFI system partition will have the
# EFI system partition type ID/GUID in both MBR and GPT. If '-isohybrid-gpt-basdat' is specified after '-e',
# the appended EFI system partition will have the Microsoft basic data type GUID in GPT.
if [[ ! " ${xorrisofs_options[*]} " =~ ' -isohybrid-gpt-basdat ' ]]; then
xorrisofs_options+=('-isohybrid-gpt-basdat')
fi
fi
2020-11-01 14:39:27 +01:00
else
# The ISO will not contain a GPT partition table, so to be able to reference efiboot.img, place it as a
# file inside the ISO 9660 file system
install -d -m 0755 -- "${isofs_dir}/EFI/archiso"
cp -a -- "${work_dir}/efiboot.img" "${isofs_dir}/EFI/archiso/efiboot.img"
# systemd-boot in an embedded efiboot.img via El Torito
xorrisofs_options+=(
# Start a new El Torito boot entry for UEFI
'-eltorito-alt-boot'
# Set efiboot.img as the El Torito UEFI boot image
'-e' 'EFI/archiso/efiboot.img'
# Boot image is not emulating floppy or hard disk; required for all known boot loaders
'-no-emul-boot'
)
fi
# Specify where to save the El Torito boot catalog file in case it is not already set by bios.syslinux.eltorito
# shellcheck disable=SC2076
[[ " ${bootmodes[*]} " =~ ' bios.' ]] || xorrisofs_options+=('-eltorito-catalog' 'EFI/boot.cat')
}
2020-08-02 11:58:42 +02:00
# Build ISO
2020-11-01 08:39:36 +01:00
_build_iso() {
2020-08-12 18:42:02 +02:00
local xorrisofs_options=()
2020-11-01 14:39:27 +01:00
local bootmode
2020-08-12 18:42:02 +02:00
2020-08-20 16:00:06 +02:00
[[ -d "${out_dir}" ]] || install -d -- "${out_dir}"
2020-11-01 08:39:36 +01:00
[[ "${quiet}" == "y" ]] && xorrisofs_options+=('-quiet')
2020-10-04 15:13:22 +02:00
2020-11-01 14:39:27 +01:00
# Add required xorrisofs options for each boot mode
for bootmode in "${bootmodes[@]}"; do
typeset -f "_add_xorrisofs_options_${bootmode}" &> /dev/null && "_add_xorrisofs_options_${bootmode}"
done
2020-08-12 18:42:02 +02:00
_msg_info "Creating ISO image..."
xorriso -as mkisofs \
-iso-level 3 \
-full-iso9660-filenames \
2020-08-12 13:20:22 +02:00
-joliet \
-joliet-long \
2020-08-12 18:42:02 +02:00
-rational-rock \
-volid "${iso_label}" \
-appid "${iso_application}" \
-publisher "${iso_publisher}" \
-preparer "prepared by ${app_name}" \
"${xorrisofs_options[@]}" \
-output "${out_dir}/${img_name}" \
"${isofs_dir}/"
2020-08-20 16:00:06 +02:00
_msg_info "Done!"
du -h -- "${out_dir}/${img_name}"
2020-08-02 11:58:42 +02:00
}
# Read profile's values from profiledef.sh
2020-08-20 16:00:06 +02:00
_read_profile() {
2020-08-02 11:58:42 +02:00
if [[ -z "${profile}" ]]; then
_msg_error "No profile specified!" 1
fi
if [[ ! -d "${profile}" ]]; then
_msg_error "Profile '${profile}' does not exist!" 1
elif [[ ! -e "${profile}/profiledef.sh" ]]; then
_msg_error "Profile '${profile}' is missing 'profiledef.sh'!" 1
else
2020-08-20 16:00:06 +02:00
cd -- "${profile}"
2020-08-02 11:58:42 +02:00
# Source profile's variables
# shellcheck source=configs/releng/profiledef.sh
. "${profile}/profiledef.sh"
2020-12-05 13:13:56 +01:00
# Resolve paths of files that are expected to reside in the profile's directory
[[ -n "$packages" ]] || packages="${profile}/packages.${arch}"
packages="$(realpath -- "${packages}")"
2020-08-02 11:58:42 +02:00
pacman_conf="$(realpath -- "${pacman_conf}")"
cd -- "${OLDPWD}"
2020-12-05 13:13:56 +01:00
fi
}
2020-11-01 10:43:56 +01:00
2020-12-05 13:13:56 +01:00
# Validate set options
_validate_options() {
local validation_error=0 bootmode
local pkg_list_from_file=()
_msg_info "Validating options..."
# Check if the package list file exists and read packages from it
if [[ -e "${packages}" ]]; then
mapfile -t pkg_list_from_file < <(sed '/^[[:blank:]]*#.*/d;s/#.*//;/^[[:blank:]]*$/d' "${packages}")
pkg_list+=("${pkg_list_from_file[@]}")
if (( ${#pkg_list_from_file} < 1 )); then
2020-11-01 10:43:56 +01:00
(( validation_error=validation_error+1 ))
2020-12-05 13:13:56 +01:00
_msg_error "No package specified in '${packages}'." 0
2020-11-01 10:43:56 +01:00
fi
2020-12-05 13:13:56 +01:00
else
(( validation_error=validation_error+1 ))
_msg_error "File '${packages}' does not exist." 0
fi
# Check if pacman configuration file exists
if [[ ! -e "${pacman_conf}" ]]; then
(( validation_error=validation_error+1 ))
_msg_error "File '${pacman_conf}' does not exist." 0
fi
# Check if the specified bootmodes are supported
for bootmode in "${bootmodes[@]}"; do
if typeset -f "_make_bootmode_${bootmode}" &> /dev/null; then
if typeset -f "_validate_requirements_bootmode_${bootmode}" &> /dev/null; then
"_validate_requirements_bootmode_${bootmode}"
2020-11-01 10:43:56 +01:00
else
2020-12-05 13:13:56 +01:00
_msg_warning "Function '_validate_requirements_bootmode_${bootmode}' does not exist. Validating the requirements of '${bootmode}' boot mode will not be possible."
2020-11-01 10:43:56 +01:00
fi
else
(( validation_error=validation_error+1 ))
2020-12-05 13:13:56 +01:00
_msg_error "${bootmode} is not a valid boot mode!" 0
2020-11-01 10:43:56 +01:00
fi
2020-12-05 13:13:56 +01:00
done
# Check if the specified airootfs_image_type is supported
if typeset -f "_mkairootfs_${airootfs_image_type}" &> /dev/null; then
if typeset -f "_validate_requirements_airootfs_image_type_${airootfs_image_type}" &> /dev/null; then
"_validate_requirements_airootfs_image_type_${airootfs_image_type}"
else
_msg_warning "Function '_validate_requirements_airootfs_image_type_${airootfs_image_type}' does not exist. Validating the requirements of '${airootfs_image_type}' airootfs image type will not be possible."
2020-11-01 10:43:56 +01:00
fi
2020-12-05 13:13:56 +01:00
else
(( validation_error=validation_error+1 ))
_msg_error "Unsupported image type: '${airootfs_image_type}'" 0
fi
if (( validation_error )); then
_msg_error "${validation_error} errors were encountered while validating the profile. Aborting." 1
2020-08-02 11:58:42 +02:00
fi
2020-11-18 19:24:02 +01:00
_msg_info "Done!"
2020-08-02 11:58:42 +02:00
}
2020-12-05 13:13:56 +01:00
# Set defaults and, if present, overrides from mkarchiso command line option parameters
Pass profile directory as parameter to mkarchiso
**archiso/mkarchiso**:
Change all override option parameters (i.e. `-A`, `-C`, `-D`, `-L`, `-P` and `-g`) to not directly override the global
variable they are tied to, but instead using an `override_` prefixed variable.
Add `_set_overrides()` to use `override_` prefixed variables (if set) to override those without a prefix.
Remove `-B` (a profile directory) from the list of parameters. The profile directory is now provided as separate
non-option parameter.
Add a call to `_read_profile()`, `_set_overrides()` and `command_build_profile()` to the fallthrough option of the
switch-case checking `command_name` - a non-option parameter to mkarchiso. This effectively provides the possibility to
set the profile directory using a non-option parameter, while still maintaining compatibility to legacy named arguments
used in the configs' `build.sh` scripts.
Extend the warning in regards to legacy `build.sh` based commands to mkarchiso by providing an EOL with archiso v49.
Change the help output to reflect the changes and further elaborate on the legacy commands used by `build.sh` scripts.
Change help output to be ordered alphabetically.
Add help output for `-r` and `-g` options.
Call `_set_overrides()` for legacy commands that accept one or more of the overriden options (i.e. `command_init`,
`command_install`, `command_prepare` and `command_iso`).
Various style fixes.
**configs/{baseline,releng}/build.sh**:
Change call to mkarchiso to use the profile's directory as a named argument instead of an option-argument.
**README.rst**:
Fix documentation on how to call mkarchiso with a profile directory.
Fix wording and ordering of option arguments for run_archiso documentation.
Fixes #52
2020-08-24 17:53:10 +02:00
_set_overrides() {
2020-12-05 13:13:56 +01:00
# Set variables that have command line overrides
if [[ -v override_work_dir ]]; then
work_dir="$override_work_dir"
elif [[ -z "$work_dir" ]]; then
work_dir='./work'
fi
work_dir="$(realpath -- "$work_dir")"
if [[ -v override_out_dir ]]; then
out_dir="$override_out_dir"
elif [[ -z "$out_dir" ]]; then
out_dir='./out'
fi
out_dir="$(realpath -- "$out_dir")"
if [[ -v override_pacman_conf ]]; then
pacman_conf="$override_pacman_conf"
elif [[ -z "$pacman_conf" ]]; then
pacman_conf="/etc/pacman.conf"
fi
pacman_conf="$(realpath -- "$pacman_conf")"
[[ ! -v override_pkg_list ]] || pkg_list+=("${override_pkg_list[@]}")
if [[ -v override_iso_label ]]; then
iso_label="$override_iso_label"
elif [[ -z "$iso_label" ]]; then
iso_label="${app_name^^}"
fi
if [[ -v override_iso_publisher ]]; then
iso_publisher="$override_iso_publisher"
elif [[ -z "$iso_publisher" ]]; then
iso_publisher="${app_name}"
fi
if [[ -v override_iso_application ]]; then
iso_application="$override_iso_application"
elif [[ -z "$iso_application" ]]; then
iso_application="${app_name} iso"
fi
if [[ -v override_install_dir ]]; then
install_dir="$override_install_dir"
elif [[ -z "$install_dir" ]]; then
install_dir="${app_name}"
fi
[[ ! -v override_gpg_key ]] || gpg_key="$override_gpg_key"
if [[ -v override_quiet ]]; then
quiet="$override_quiet"
elif [[ -z "$quiet" ]]; then
quiet="y"
fi
# Set variables that do not have overrides
[[ -n "$arch" ]] || arch="$(uname -m)"
[[ -n "$airootfs_image_type" ]] || airootfs_image_type="squashfs"
[[ -n "$iso_name" ]] || iso_name="${app_name}"
[[ -n "$img_name" ]] || img_name="${iso_name}-${iso_version}-${arch}.iso"
Pass profile directory as parameter to mkarchiso
**archiso/mkarchiso**:
Change all override option parameters (i.e. `-A`, `-C`, `-D`, `-L`, `-P` and `-g`) to not directly override the global
variable they are tied to, but instead using an `override_` prefixed variable.
Add `_set_overrides()` to use `override_` prefixed variables (if set) to override those without a prefix.
Remove `-B` (a profile directory) from the list of parameters. The profile directory is now provided as separate
non-option parameter.
Add a call to `_read_profile()`, `_set_overrides()` and `command_build_profile()` to the fallthrough option of the
switch-case checking `command_name` - a non-option parameter to mkarchiso. This effectively provides the possibility to
set the profile directory using a non-option parameter, while still maintaining compatibility to legacy named arguments
used in the configs' `build.sh` scripts.
Extend the warning in regards to legacy `build.sh` based commands to mkarchiso by providing an EOL with archiso v49.
Change the help output to reflect the changes and further elaborate on the legacy commands used by `build.sh` scripts.
Change help output to be ordered alphabetically.
Add help output for `-r` and `-g` options.
Call `_set_overrides()` for legacy commands that accept one or more of the overriden options (i.e. `command_init`,
`command_install`, `command_prepare` and `command_iso`).
Various style fixes.
**configs/{baseline,releng}/build.sh**:
Change call to mkarchiso to use the profile's directory as a named argument instead of an option-argument.
**README.rst**:
Fix documentation on how to call mkarchiso with a profile directory.
Fix wording and ordering of option arguments for run_archiso documentation.
Fixes #52
2020-08-24 17:53:10 +02:00
}
2020-08-02 11:58:42 +02:00
_export_gpg_publickey() {
2020-11-01 08:39:36 +01:00
gpg --batch --output "${work_dir}/pubkey.gpg" --export "${gpg_key}"
2020-08-02 11:58:42 +02:00
}
2021-01-06 11:59:53 +01:00
_make_version() {
2021-04-01 14:06:41 +02:00
local osrelease
2021-01-06 11:59:53 +01:00
install -d -m 0755 -- "${isofs_dir}/${install_dir}"
_msg_info "Creating files with iso version..."
2021-04-01 14:06:41 +02:00
# Write version file to airootfs
rm -f -- "${airootfs_dir}/version"
2021-01-06 11:59:53 +01:00
printf '%s\n' "${iso_version}" > "${airootfs_dir}/version"
2021-04-01 14:06:41 +02:00
# Write version file to ISO 9660
2021-01-06 11:59:53 +01:00
printf '%s\n' "${iso_version}" > "${isofs_dir}/${install_dir}/version"
2021-04-01 14:06:41 +02:00
# Write grubenv with version information to ISO 9660
2021-04-01 14:24:12 +02:00
printf '%.1024s' "$(printf '# GRUB Environment Block\nNAME=%s\nVERSION=%s\n%s' \
"${iso_name}" "${iso_version}" "$(printf '%0.1s' "#"{1..1024})")" \
> "${isofs_dir}/${install_dir}/grubenv"
2021-04-01 14:06:41 +02:00
# Append IMAGE_ID & IMAGE_VERSION to os-release
osrelease="$(realpath -- "${airootfs_dir}/etc/os-release")"
if [[ ! -e "${airootfs_dir}/etc/os-release" && -e "${airootfs_dir}/usr/lib/os-release" ]]; then
osrelease="$(realpath -- "${airootfs_dir}/usr/lib/os-release")"
fi
if [[ "${osrelease}" != "${airootfs_dir}"* ]]; then
_msg_warning "os-release file '${osrelease}' is outside of valid path."
else
[[ ! -e "${osrelease}" ]] || sed -i '/^IMAGE_ID=/d;/^IMAGE_VERSION=/d' "${osrelease}"
printf 'IMAGE_ID=%s\nIMAGE_VERSION=%s\n' "${iso_name}" "${iso_version}" >> "${osrelease}"
fi
2021-01-06 11:59:53 +01:00
_msg_info "Done!"
}
2020-08-02 11:58:42 +02:00
_make_pkglist() {
2020-08-20 16:00:06 +02:00
install -d -m 0755 -- "${isofs_dir}/${install_dir}"
2014-06-28 05:35:50 +02:00
_msg_info "Creating a list of installed packages on live-enviroment..."
2020-08-02 11:58:42 +02:00
pacman -Q --sysroot "${airootfs_dir}" > "${isofs_dir}/${install_dir}/pkglist.${arch}.txt"
2014-06-28 05:35:50 +02:00
_msg_info "Done!"
2020-08-02 11:58:42 +02:00
}
2012-04-09 03:26:27 +02:00
2020-10-24 22:59:52 +02:00
_build_profile() {
2020-08-14 06:52:59 +02:00
# Set up essential directory paths
airootfs_dir="${work_dir}/${arch}/airootfs"
2020-08-02 11:58:42 +02:00
isofs_dir="${work_dir}/iso"
2020-08-20 16:00:06 +02:00
# Create working directory
[[ -d "${work_dir}" ]] || install -d -- "${work_dir}"
2020-09-28 19:12:01 +02:00
# Write build date to file or if the file exists, read it from there
if [[ -e "${work_dir}/build_date" ]]; then
SOURCE_DATE_EPOCH="$(<"${work_dir}/build_date")"
else
printf '%s\n' "$SOURCE_DATE_EPOCH" > "${work_dir}/build_date"
fi
2020-08-20 16:00:06 +02:00
2020-12-05 13:13:56 +01:00
[[ "${quiet}" == "y" ]] || _show_config
2020-08-02 11:58:42 +02:00
_run_once _make_pacman_conf
2020-12-05 13:13:56 +01:00
[[ -z "${gpg_key}" ]] || _run_once _export_gpg_publickey
2020-08-02 11:58:42 +02:00
_run_once _make_custom_airootfs
_run_once _make_packages
2021-01-06 11:59:53 +01:00
_run_once _make_version
2020-08-02 11:58:42 +02:00
_run_once _make_customize_airootfs
_run_once _make_pkglist
2020-08-12 18:42:02 +02:00
_make_bootmodes
2020-11-01 08:39:36 +01:00
_run_once _cleanup_airootfs
_run_once _prepare_airootfs_image
_run_once _build_iso
2020-08-14 06:52:59 +02:00
}
2020-11-01 08:39:36 +01:00
while getopts 'p:C:L:P:A:D:w:o:g:vh?' arg; do
2011-06-18 23:38:58 +02:00
case "${arg}" in
2020-12-05 13:13:56 +01:00
p) read -r -a override_pkg_list <<< "${OPTARG}" ;;
C) override_pacman_conf="${OPTARG}" ;;
Pass profile directory as parameter to mkarchiso
**archiso/mkarchiso**:
Change all override option parameters (i.e. `-A`, `-C`, `-D`, `-L`, `-P` and `-g`) to not directly override the global
variable they are tied to, but instead using an `override_` prefixed variable.
Add `_set_overrides()` to use `override_` prefixed variables (if set) to override those without a prefix.
Remove `-B` (a profile directory) from the list of parameters. The profile directory is now provided as separate
non-option parameter.
Add a call to `_read_profile()`, `_set_overrides()` and `command_build_profile()` to the fallthrough option of the
switch-case checking `command_name` - a non-option parameter to mkarchiso. This effectively provides the possibility to
set the profile directory using a non-option parameter, while still maintaining compatibility to legacy named arguments
used in the configs' `build.sh` scripts.
Extend the warning in regards to legacy `build.sh` based commands to mkarchiso by providing an EOL with archiso v49.
Change the help output to reflect the changes and further elaborate on the legacy commands used by `build.sh` scripts.
Change help output to be ordered alphabetically.
Add help output for `-r` and `-g` options.
Call `_set_overrides()` for legacy commands that accept one or more of the overriden options (i.e. `command_init`,
`command_install`, `command_prepare` and `command_iso`).
Various style fixes.
**configs/{baseline,releng}/build.sh**:
Change call to mkarchiso to use the profile's directory as a named argument instead of an option-argument.
**README.rst**:
Fix documentation on how to call mkarchiso with a profile directory.
Fix wording and ordering of option arguments for run_archiso documentation.
Fixes #52
2020-08-24 17:53:10 +02:00
L) override_iso_label="${OPTARG}" ;;
P) override_iso_publisher="${OPTARG}" ;;
A) override_iso_application="${OPTARG}" ;;
D) override_install_dir="${OPTARG}" ;;
2020-12-05 13:13:56 +01:00
w) override_work_dir="${OPTARG}" ;;
o) override_out_dir="${OPTARG}" ;;
Pass profile directory as parameter to mkarchiso
**archiso/mkarchiso**:
Change all override option parameters (i.e. `-A`, `-C`, `-D`, `-L`, `-P` and `-g`) to not directly override the global
variable they are tied to, but instead using an `override_` prefixed variable.
Add `_set_overrides()` to use `override_` prefixed variables (if set) to override those without a prefix.
Remove `-B` (a profile directory) from the list of parameters. The profile directory is now provided as separate
non-option parameter.
Add a call to `_read_profile()`, `_set_overrides()` and `command_build_profile()` to the fallthrough option of the
switch-case checking `command_name` - a non-option parameter to mkarchiso. This effectively provides the possibility to
set the profile directory using a non-option parameter, while still maintaining compatibility to legacy named arguments
used in the configs' `build.sh` scripts.
Extend the warning in regards to legacy `build.sh` based commands to mkarchiso by providing an EOL with archiso v49.
Change the help output to reflect the changes and further elaborate on the legacy commands used by `build.sh` scripts.
Change help output to be ordered alphabetically.
Add help output for `-r` and `-g` options.
Call `_set_overrides()` for legacy commands that accept one or more of the overriden options (i.e. `command_init`,
`command_install`, `command_prepare` and `command_iso`).
Various style fixes.
**configs/{baseline,releng}/build.sh**:
Change call to mkarchiso to use the profile's directory as a named argument instead of an option-argument.
**README.rst**:
Fix documentation on how to call mkarchiso with a profile directory.
Fix wording and ordering of option arguments for run_archiso documentation.
Fixes #52
2020-08-24 17:53:10 +02:00
g) override_gpg_key="${OPTARG}" ;;
2020-12-05 13:13:56 +01:00
v) override_quiet="n" ;;
2011-06-18 23:38:58 +02:00
h|?) _usage 0 ;;
*)
_msg_error "Invalid argument '${arg}'" 0
_usage 1
;;
esac
done
2020-10-07 10:29:03 +02:00
shift $((OPTIND - 1))
if (( $# < 1 )); then
2020-10-24 22:59:52 +02:00
_msg_error "No profile specified" 0
2020-10-01 16:02:11 +02:00
_usage 1
fi
2020-08-01 13:51:11 +02:00
if (( EUID != 0 )); then
_msg_error "${app_name} must be run as root." 1
fi
2020-10-24 22:59:52 +02:00
# get the absolute path representation of the first non-option argument
profile="$(realpath -- "${1}")"
2011-06-18 23:38:58 +02:00
2020-10-24 22:59:52 +02:00
_read_profile
_set_overrides
2020-12-05 13:13:56 +01:00
_validate_options
2020-10-24 22:59:52 +02:00
_build_profile
2008-09-07 03:39:35 +02:00
# vim:ts=4:sw=4:et: