Build Plymouth assets in a root-owned stage
This commit is contained in:
Erik Melton
+203
-219
@@ -7,19 +7,25 @@
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
# Configure the Plymouth boot theme with a custom background color, text color,
|
||||
# and logo. Assets are prepared without privileges, pinned to their recorded
|
||||
# hashes, then published one at a time through root-owned temporary files.
|
||||
# Build the authoritative theme in a root-owned directory, then publish each
|
||||
# fixed destination atomically. The caller opens the selected logo before sudo,
|
||||
# so the privileged process never resolves a user-controlled input path.
|
||||
|
||||
refresh_default=false
|
||||
if (( $# == 1 )) && [[ $1 == --refresh-default ]]; then
|
||||
if (( $# == 1 )) && [[ $1 == "--refresh-default" ]]; then
|
||||
refresh_default=true
|
||||
elif (( $# != 3 )); then
|
||||
echo "Usage: omarchy-plymouth-set <background-hex> <text-hex> <path-to-logo.png>" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if ! $refresh_default; then
|
||||
logo_fd=
|
||||
if $refresh_default; then
|
||||
mode=refresh
|
||||
bg_hex=
|
||||
text_hex=
|
||||
else
|
||||
mode=set
|
||||
bg_hex="${1#\#}"
|
||||
text_hex="${2#\#}"
|
||||
logo_path="$3"
|
||||
@@ -39,230 +45,215 @@ if ! $refresh_default; then
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# omarchy-plymouth-set-by-theme passes a theme's unlock.png straight from
|
||||
# ~/.config/omarchy/themes, where an installed theme can make it a symlink to
|
||||
# anything. The copies below land in world-readable /usr/share, so following
|
||||
# one would republish whatever it points at.
|
||||
if [[ -L $logo_path ]]; then
|
||||
echo "Logo file is a symlink, which is not accepted: $logo_path" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Open the logo while still unprivileged. A replacement symlink to a root-only
|
||||
# file therefore fails here instead of being followed after sudo starts.
|
||||
if ! exec {logo_fd}<"$logo_path"; then
|
||||
echo "Unable to open logo file as the current user: $logo_path" >&2
|
||||
exit 1
|
||||
fi
|
||||
if [[ ! -f /proc/$$/fd/$logo_fd ]]; then
|
||||
echo "Logo input is no longer a regular file: $logo_path" >&2
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
theme_dir="/usr/share/plymouth/themes/omarchy"
|
||||
sddm_dir="/usr/share/sddm/themes/omarchy"
|
||||
max_asset_size=$((64 * 1024 * 1024))
|
||||
run_root_transaction() {
|
||||
sudo /bin/bash -c '
|
||||
set -euo pipefail
|
||||
PATH=/usr/bin:/bin
|
||||
export PATH
|
||||
|
||||
plymouth_theme_assets=(
|
||||
bullet.png
|
||||
entry.png
|
||||
lock.png
|
||||
logo.png
|
||||
omarchy.plymouth
|
||||
omarchy.script
|
||||
preview-unlock.png
|
||||
progress_bar.png
|
||||
progress_box.png
|
||||
)
|
||||
plymouth_default_assets=(
|
||||
"${plymouth_theme_assets[@]}"
|
||||
logos/oma.png
|
||||
)
|
||||
sddm_theme_assets=(
|
||||
Main.qml
|
||||
bullet.png
|
||||
entry-failed.png
|
||||
entry.png
|
||||
lock-failed.png
|
||||
lock.png
|
||||
logo.png
|
||||
)
|
||||
mode=$1
|
||||
source_root=$2
|
||||
bg_hex=$3
|
||||
text_hex=$4
|
||||
max_asset_size=$5
|
||||
|
||||
staging_dir=$(mktemp -d)
|
||||
trap 'rm -rf -- "$staging_dir"' EXIT
|
||||
chmod 0700 "$staging_dir"
|
||||
plymouth_stage="$staging_dir/plymouth"
|
||||
sddm_stage="$staging_dir/sddm"
|
||||
mkdir -m 0700 -p "$plymouth_stage/logos" "$sddm_stage"
|
||||
[[ $mode == "set" || $mode == "refresh" ]]
|
||||
[[ $source_root == /* ]]
|
||||
canonical_source_root=$(realpath -e -- "$source_root")
|
||||
[[ $canonical_source_root == "$source_root" ]]
|
||||
[[ $max_asset_size =~ ^[0-9]+$ ]]
|
||||
(( max_asset_size > 0 ))
|
||||
|
||||
copy_regular_file() {
|
||||
local source="$1" destination="$2"
|
||||
if [[ $mode == "set" ]]; then
|
||||
[[ $bg_hex =~ ^[0-9a-fA-F]{6}$ ]]
|
||||
[[ $text_hex =~ ^[0-9a-fA-F]{6}$ ]]
|
||||
fi
|
||||
|
||||
if [[ ! -f $source || -L $source ]]; then
|
||||
echo "Refusing non-regular or symlinked asset: $source" >&2
|
||||
exit 1
|
||||
fi
|
||||
theme_dir=/usr/share/plymouth/themes/omarchy
|
||||
sddm_dir=/usr/share/sddm/themes/omarchy
|
||||
plymouth_theme_assets=(
|
||||
bullet.png
|
||||
entry.png
|
||||
lock.png
|
||||
logo.png
|
||||
omarchy.plymouth
|
||||
omarchy.script
|
||||
preview-unlock.png
|
||||
progress_bar.png
|
||||
progress_box.png
|
||||
)
|
||||
plymouth_default_assets=("${plymouth_theme_assets[@]}" logos/oma.png)
|
||||
sddm_theme_assets=(Main.qml bullet.png entry-failed.png entry.png lock-failed.png lock.png logo.png)
|
||||
|
||||
# -P ensures a source swapped to a symlink is copied as a symlink instead of
|
||||
# followed; the post-copy check then rejects it.
|
||||
cp -P --reflink=never -- "$source" "$destination"
|
||||
if [[ ! -f $destination || -L $destination ]]; then
|
||||
rm -f -- "$destination"
|
||||
echo "Asset changed while it was being staged: $source" >&2
|
||||
exit 1
|
||||
fi
|
||||
chmod 0600 "$destination"
|
||||
validate_trusted_directory() {
|
||||
local directory=$1 canonical uid directory_mode
|
||||
|
||||
canonical=$(realpath -e -- "$directory")
|
||||
[[ $canonical == "$directory" && -d $directory && ! -L $directory ]]
|
||||
|
||||
while :; do
|
||||
uid=$(stat -c %u -- "$directory")
|
||||
directory_mode=$(stat -c %a -- "$directory")
|
||||
(( uid == 0 ))
|
||||
(( (8#$directory_mode & 0022) == 0 ))
|
||||
[[ $directory == "/" ]] && break
|
||||
directory=${directory%/*}
|
||||
[[ -n $directory ]] || directory=/
|
||||
done
|
||||
}
|
||||
|
||||
validate_trusted_file() {
|
||||
local source=$1 canonical uid file_mode size
|
||||
|
||||
[[ -f $source && ! -L $source ]]
|
||||
canonical=$(realpath -e -- "$source")
|
||||
[[ $canonical == "$source" ]]
|
||||
validate_trusted_directory "${source%/*}"
|
||||
uid=$(stat -c %u -- "$source")
|
||||
file_mode=$(stat -c %a -- "$source")
|
||||
size=$(stat -c %s -- "$source")
|
||||
(( uid == 0 ))
|
||||
(( (8#$file_mode & 0022) == 0 ))
|
||||
(( size > 0 && size <= max_asset_size ))
|
||||
}
|
||||
|
||||
copy_trusted_file() {
|
||||
local source=$1 destination=$2
|
||||
|
||||
validate_trusted_file "$source"
|
||||
cp --reflink=never -- "$source" "$destination"
|
||||
chown 0:0 -- "$destination"
|
||||
chmod 0600 -- "$destination"
|
||||
}
|
||||
|
||||
staging_dir=$(mktemp -d /tmp/omarchy-plymouth.XXXXXXXX)
|
||||
temporary=
|
||||
cleanup() {
|
||||
[[ -z $temporary ]] || rm -f -- "$temporary"
|
||||
rm -rf -- "$staging_dir"
|
||||
}
|
||||
trap cleanup EXIT HUP INT TERM
|
||||
chown 0:0 -- "$staging_dir"
|
||||
chmod 0700 -- "$staging_dir"
|
||||
|
||||
plymouth_stage=$staging_dir/plymouth
|
||||
sddm_stage=$staging_dir/sddm
|
||||
mkdir -m 0700 -p -- "$plymouth_stage/logos" "$sddm_stage"
|
||||
|
||||
if [[ $mode == "refresh" ]]; then
|
||||
assets_to_stage=("${plymouth_default_assets[@]}")
|
||||
else
|
||||
assets_to_stage=("${plymouth_theme_assets[@]}")
|
||||
fi
|
||||
|
||||
for asset in "${assets_to_stage[@]}"; do
|
||||
copy_trusted_file "$source_root/default/plymouth/$asset" "$plymouth_stage/$asset"
|
||||
done
|
||||
|
||||
if [[ $mode == "set" ]]; then
|
||||
# stdin was opened by the unprivileged caller. Read no more than the
|
||||
# documented limit into the root-owned stage before doing other work.
|
||||
head -c "$((max_asset_size + 1))" >"$plymouth_stage/logo.png"
|
||||
logo_size=$(stat -c %s -- "$plymouth_stage/logo.png")
|
||||
(( logo_size > 0 && logo_size <= max_asset_size ))
|
||||
chown 0:0 -- "$plymouth_stage/logo.png"
|
||||
chmod 0600 -- "$plymouth_stage/logo.png"
|
||||
cp --reflink=never -- "$plymouth_stage/logo.png" "$sddm_stage/logo.png"
|
||||
|
||||
bg_r=$(awk -v n=$((16#${bg_hex:0:2})) "BEGIN{printf \"%.3f\", n/255}")
|
||||
bg_g=$(awk -v n=$((16#${bg_hex:2:2})) "BEGIN{printf \"%.3f\", n/255}")
|
||||
bg_b=$(awk -v n=$((16#${bg_hex:4:2})) "BEGIN{printf \"%.3f\", n/255}")
|
||||
|
||||
sed -i \
|
||||
-e "s/^Window.SetBackgroundTopColor.*/Window.SetBackgroundTopColor($bg_r, $bg_g, $bg_b);/" \
|
||||
-e "s/^Window.SetBackgroundBottomColor.*/Window.SetBackgroundBottomColor($bg_r, $bg_g, $bg_b);/" \
|
||||
"$plymouth_stage/omarchy.script"
|
||||
|
||||
for asset in bullet.png entry.png lock.png progress_bar.png; do
|
||||
magick "$plymouth_stage/$asset" -channel RGB +level-colors "#$text_hex","#$text_hex" "$plymouth_stage/$asset"
|
||||
done
|
||||
|
||||
copy_trusted_file "$source_root/default/sddm/omarchy/Main.qml" "$sddm_stage/Main.qml"
|
||||
sed -i \
|
||||
-e "s/#1a1b26/#__OMARCHY_SDDM_BG__/g" \
|
||||
-e "s/#ffffff/#__OMARCHY_SDDM_TEXT__/g" \
|
||||
-e "s/#__OMARCHY_SDDM_BG__/#$bg_hex/g" \
|
||||
-e "s/#__OMARCHY_SDDM_TEXT__/#$text_hex/g" \
|
||||
"$sddm_stage/Main.qml"
|
||||
|
||||
for asset in bullet.png entry.png lock.png; do
|
||||
cp --reflink=never -- "$plymouth_stage/$asset" "$sddm_stage/$asset"
|
||||
done
|
||||
for asset in entry lock; do
|
||||
magick "$plymouth_stage/$asset.png" -channel RGB +level-colors "#f7768e","#f7768e" "$sddm_stage/$asset-failed.png"
|
||||
done
|
||||
chown -R 0:0 -- "$staging_dir"
|
||||
find "$staging_dir" -type f -exec chmod 0600 -- {} +
|
||||
fi
|
||||
|
||||
publish_asset() {
|
||||
local source=$1 destination=$2 parent filename source_size copied_size
|
||||
|
||||
[[ -f $source && ! -L $source ]]
|
||||
(( $(stat -c %u -- "$source") == 0 ))
|
||||
source_size=$(stat -c %s -- "$source")
|
||||
(( source_size > 0 && source_size <= max_asset_size ))
|
||||
|
||||
[[ $destination == /* && $destination != */ && $destination != *"/../"* ]]
|
||||
parent=${destination%/*}
|
||||
filename=${destination##*/}
|
||||
[[ -n $parent && -n $filename && $filename != "." && $filename != ".." ]]
|
||||
validate_trusted_directory "$parent"
|
||||
|
||||
temporary=$(mktemp --tmpdir="$parent" ".$filename.omarchy-new.XXXXXXXX")
|
||||
cp --reflink=never -- "$source" "$temporary"
|
||||
copied_size=$(stat -c %s -- "$temporary")
|
||||
(( copied_size == source_size ))
|
||||
cmp -s -- "$source" "$temporary"
|
||||
chown 0:0 -- "$temporary"
|
||||
chmod 0644 -- "$temporary"
|
||||
sync -f -- "$temporary"
|
||||
mv --no-copy -fT -- "$temporary" "$destination"
|
||||
temporary=
|
||||
}
|
||||
|
||||
for asset in "${assets_to_stage[@]}"; do
|
||||
publish_asset "$plymouth_stage/$asset" "$theme_dir/$asset"
|
||||
done
|
||||
|
||||
if [[ $mode == "set" ]]; then
|
||||
for asset in "${sddm_theme_assets[@]}"; do
|
||||
publish_asset "$sddm_stage/$asset" "$sddm_dir/$asset"
|
||||
done
|
||||
validate_trusted_directory "$sddm_dir"
|
||||
rm -f -- "$sddm_dir/logo.svg"
|
||||
fi
|
||||
' bash "$mode" "$OMARCHY_PATH" "$bg_hex" "$text_hex" "$((64 * 1024 * 1024))"
|
||||
}
|
||||
|
||||
if $refresh_default; then
|
||||
assets_to_stage=("${plymouth_default_assets[@]}")
|
||||
run_root_transaction </dev/null
|
||||
else
|
||||
assets_to_stage=("${plymouth_theme_assets[@]}")
|
||||
run_root_transaction <&"$logo_fd"
|
||||
fi
|
||||
|
||||
for asset in "${assets_to_stage[@]}"; do
|
||||
copy_regular_file "$OMARCHY_PATH/default/plymouth/$asset" "$plymouth_stage/$asset"
|
||||
done
|
||||
|
||||
if ! $refresh_default; then
|
||||
for asset in "${sddm_theme_assets[@]}"; do
|
||||
copy_regular_file "$OMARCHY_PATH/default/sddm/omarchy/$asset" "$sddm_stage/$asset"
|
||||
done
|
||||
|
||||
copy_regular_file "$logo_path" "$plymouth_stage/logo.png"
|
||||
copy_regular_file "$logo_path" "$sddm_stage/logo.png"
|
||||
|
||||
bg_r=$(awk -v n=$((16#${bg_hex:0:2})) 'BEGIN{printf "%.3f", n/255}')
|
||||
bg_g=$(awk -v n=$((16#${bg_hex:2:2})) 'BEGIN{printf "%.3f", n/255}')
|
||||
bg_b=$(awk -v n=$((16#${bg_hex:4:2})) 'BEGIN{printf "%.3f", n/255}')
|
||||
|
||||
sed -i \
|
||||
-e "s/^Window.SetBackgroundTopColor.*/Window.SetBackgroundTopColor($bg_r, $bg_g, $bg_b);/" \
|
||||
-e "s/^Window.SetBackgroundBottomColor.*/Window.SetBackgroundBottomColor($bg_r, $bg_g, $bg_b);/" \
|
||||
"$plymouth_stage/omarchy.script"
|
||||
|
||||
for asset in bullet.png entry.png lock.png progress_bar.png; do
|
||||
magick "$plymouth_stage/$asset" -channel RGB +level-colors "#$text_hex","#$text_hex" "$plymouth_stage/$asset"
|
||||
done
|
||||
|
||||
# Substitute through unique tokens. Otherwise White's #ffffff background is
|
||||
# immediately mistaken for the template's text placeholder by the next sed
|
||||
# expression and rewritten to black.
|
||||
sed -i \
|
||||
-e 's/#1a1b26/#__OMARCHY_SDDM_BG__/g' \
|
||||
-e 's/#ffffff/#__OMARCHY_SDDM_TEXT__/g' \
|
||||
-e "s/#__OMARCHY_SDDM_BG__/#$bg_hex/g" \
|
||||
-e "s/#__OMARCHY_SDDM_TEXT__/#$text_hex/g" \
|
||||
"$sddm_stage/Main.qml"
|
||||
|
||||
for asset in bullet.png entry.png lock.png; do
|
||||
cp --reflink=never -- "$plymouth_stage/$asset" "$sddm_stage/$asset"
|
||||
done
|
||||
for asset in entry lock; do
|
||||
magick "$plymouth_stage/$asset.png" -channel RGB +level-colors "#f7768e","#f7768e" "$sddm_stage/$asset-failed.png"
|
||||
done
|
||||
fi
|
||||
|
||||
declare -A staged_hashes=()
|
||||
declare -A staged_sizes=()
|
||||
|
||||
record_staged_asset() {
|
||||
local source="$1" hash size
|
||||
|
||||
if [[ ! -f $source || -L $source ]]; then
|
||||
echo "Refusing non-regular or symlinked staged asset: $source" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
size=$(stat -c %s -- "$source")
|
||||
if (( size == 0 || size > max_asset_size )); then
|
||||
echo "Staged asset is empty or exceeds the ${max_asset_size}-byte limit: $source" >&2
|
||||
exit 1
|
||||
fi
|
||||
hash=$(sha256sum -- "$source")
|
||||
staged_sizes["$source"]=$size
|
||||
staged_hashes["$source"]=${hash%% *}
|
||||
}
|
||||
|
||||
# Record every asset before the first sudo prompt. Root verifies both values
|
||||
# after consuming stdin, so an in-place rewrite after this point fails instead
|
||||
# of changing what is published. This pins the recorded result, not the trust
|
||||
# of an already-user-writable OMARCHY_PATH checkout.
|
||||
for asset in "${assets_to_stage[@]}"; do
|
||||
record_staged_asset "$plymouth_stage/$asset"
|
||||
done
|
||||
if ! $refresh_default; then
|
||||
for asset in "${sddm_theme_assets[@]}"; do
|
||||
record_staged_asset "$sddm_stage/$asset"
|
||||
done
|
||||
fi
|
||||
|
||||
publish_asset() {
|
||||
local source="$1" destination="$2"
|
||||
local expected_hash="${staged_hashes[$source]}"
|
||||
local expected_size="${staged_sizes[$source]}"
|
||||
|
||||
# The caller's shell opens source before sudo starts. Root reads only stdin,
|
||||
# verifies the recorded bytes, and never opens or chmods the final pathname.
|
||||
# Its temporary file is on the destination filesystem, so mv is atomic for
|
||||
# this one asset and replaces a destination symlink instead of following it.
|
||||
sudo /bin/bash -c '
|
||||
set -euo pipefail
|
||||
PATH=/usr/bin:/bin
|
||||
export PATH
|
||||
|
||||
destination=$1
|
||||
expected_hash=$2
|
||||
expected_size=$3
|
||||
max_size=$4
|
||||
|
||||
[[ $destination == /* && $destination != */ && $destination != *"/../"* ]]
|
||||
[[ $expected_hash =~ ^[0-9a-f]{64}$ ]]
|
||||
[[ $expected_size =~ ^[0-9]+$ && $max_size =~ ^[0-9]+$ ]]
|
||||
(( expected_size > 0 && expected_size <= max_size ))
|
||||
|
||||
parent=${destination%/*}
|
||||
filename=${destination##*/}
|
||||
[[ -n $parent && -n $filename && $filename != . && $filename != .. ]]
|
||||
[[ -d $parent && ! -L $parent ]]
|
||||
canonical_parent=$(realpath -e -- "$parent")
|
||||
[[ $canonical_parent == "$parent" ]]
|
||||
[[ $(stat -c %u -- "$parent") == 0 ]]
|
||||
parent_mode=$(stat -c %a -- "$parent")
|
||||
(( (8#$parent_mode & 0022) == 0 ))
|
||||
|
||||
temporary=$(mktemp --tmpdir="$parent" ".$filename.omarchy-new.XXXXXXXX")
|
||||
cleanup() { rm -f -- "$temporary"; }
|
||||
trap cleanup EXIT HUP INT TERM
|
||||
|
||||
head -c "$((expected_size + 1))" >"$temporary"
|
||||
actual_size=$(stat -c %s -- "$temporary")
|
||||
(( actual_size == expected_size ))
|
||||
actual_hash=$(sha256sum -- "$temporary")
|
||||
[[ ${actual_hash%% *} == "$expected_hash" ]]
|
||||
|
||||
chown 0:0 -- "$temporary"
|
||||
chmod 0644 -- "$temporary"
|
||||
sync -f -- "$temporary"
|
||||
mv --no-copy -fT -- "$temporary" "$destination"
|
||||
trap - EXIT HUP INT TERM
|
||||
' bash "$destination" "$expected_hash" "$expected_size" "$max_asset_size" <"$source"
|
||||
}
|
||||
|
||||
remove_legacy_asset() {
|
||||
local destination="$1"
|
||||
|
||||
sudo /bin/bash -c '
|
||||
set -euo pipefail
|
||||
PATH=/usr/bin:/bin
|
||||
export PATH
|
||||
|
||||
destination=$1
|
||||
[[ $destination == /* && $destination != */ && $destination != *"/../"* ]]
|
||||
parent=${destination%/*}
|
||||
[[ -d $parent && ! -L $parent ]]
|
||||
canonical_parent=$(realpath -e -- "$parent")
|
||||
[[ $canonical_parent == "$parent" ]]
|
||||
[[ $(stat -c %u -- "$parent") == 0 ]]
|
||||
parent_mode=$(stat -c %a -- "$parent")
|
||||
(( (8#$parent_mode & 0022) == 0 ))
|
||||
rm -f -- "$destination"
|
||||
' bash "$destination"
|
||||
}
|
||||
|
||||
for asset in "${assets_to_stage[@]}"; do
|
||||
publish_asset "$plymouth_stage/$asset" "$theme_dir/$asset"
|
||||
done
|
||||
sudo plymouth-set-default-theme omarchy
|
||||
|
||||
if omarchy-cmd-present limine-mkinitcpio; then
|
||||
@@ -270,10 +261,3 @@ if omarchy-cmd-present limine-mkinitcpio; then
|
||||
else
|
||||
sudo mkinitcpio -P
|
||||
fi
|
||||
|
||||
if ! $refresh_default; then
|
||||
for asset in "${sddm_theme_assets[@]}"; do
|
||||
publish_asset "$sddm_stage/$asset" "$sddm_dir/$asset"
|
||||
done
|
||||
remove_legacy_asset "$sddm_dir/logo.svg"
|
||||
fi
|
||||
|
||||
Reference in New Issue
Block a user