From 9ed658c45cd7de40d88716ca1a27a1657e297ec1 Mon Sep 17 00:00:00 2001 From: kaosjammo Date: Fri, 23 Oct 2026 01:07:56 +1100 Subject: [PATCH] fix: seed HKCU redist markers in the user registry (#1286) * fix: seed current-user redist markers in user.reg * test: skip permission case when running as root --------- Co-authored-by: Jammo <8018115+kaosjammo@users.noreply.github.com> Co-authored-by: xXJsonDeruloXx --- .../usr/local/bin/droiddeck-seed-redists | 133 +++++++++-------- tools/tests/test_seed_redists.py | 136 +++++++++++++++++- 2 files changed, 212 insertions(+), 57 deletions(-) diff --git a/tools/linuxfs/overlay/usr/local/bin/droiddeck-seed-redists b/tools/linuxfs/overlay/usr/local/bin/droiddeck-seed-redists index a13f6b417..831a0e4ce 100755 --- a/tools/linuxfs/overlay/usr/local/bin/droiddeck-seed-redists +++ b/tools/linuxfs/overlay/usr/local/bin/droiddeck-seed-redists @@ -96,14 +96,14 @@ done <<<"$pairs" want+=("vcrt"$'\t'"$VCRT_MAJOR.$VCRT_MINOR.$VCRT_BUILD") printf -v now '%(%s)T' -1 -block_for() { printf '%s\n' "$@" | awk -F'\t' -v now="$now" ' +block_for() { printf '%s\n' "$@" | awk -F'\t' -v now="$now" -v hive="$hive" ' { path = $1 - sub(/^HKEY_LOCAL_MACHINE\\\\/, "", path) + sub(/^HKEY_(LOCAL_MACHINE|CURRENT_USER)\\\\/, "", path) if (path == $1) next printf "\n[%s] %d\n\"%s\"=dword:00000001\n", path, now, $2 - if (substr(path, 1, 10) != "Software\\\\") + if (hive != "HKEY_LOCAL_MACHINE" || substr(path, 1, 10) != "Software\\\\") next printf "\n[%s] %d\n\"%s\"=dword:00000001\n", "Software\\\\Wow6432Node\\\\" substr(path, 11), now, $2 } @@ -115,16 +115,17 @@ block_for() { printf '%s\n' "$@" | awk -F'\t' -v now="$now" ' unseed() { local reg=$1 out shift - out=$(mktemp "${reg%/*}/.system.reg.XXXXXX") || return 1 - if printf '%s\n' "$@" | awk -F'\t' ' + [ -w "$reg" ] || return 1 + out=$(mktemp "${reg%/*}/.${reg##*/}.XXXXXX") || return 1 + if printf '%s\n' "$@" | awk -F'\t' -v hive="$hive" ' NR == FNR { path = $1 - sub(/^HKEY_LOCAL_MACHINE\\\\/, "", path) + sub(/^HKEY_(LOCAL_MACHINE|CURRENT_USER)\\\\/, "", path) if (path == $1) next path = tolower(path) drop["[" path "]" SUBSEP tolower($2)] = 1 - if (substr(path, 1, 10) == "software\\\\") + if (hive == "HKEY_LOCAL_MACHINE" && substr(path, 1, 10) == "software\\\\") drop["[software\\\\wow6432node\\\\" substr(path, 11) "]" SUBSEP tolower($2)] = 1 next } @@ -145,11 +146,11 @@ unseed() { # The ledger lines whose values the registry still holds, in both views where we wrote both. A Proton # update replaces its default_pfx system.reg but not our ledger beside it, and new prefixes copy both. -present() { awk -F'\t' ' +present() { awk -F'\t' -v hive="$hive" ' NR == FNR { path = $1 if (path != "vcrt") { - sub(/^HKEY_LOCAL_MACHINE\\\\/, "", path) + sub(/^HKEY_(LOCAL_MACHINE|CURRENT_USER)\\\\/, "", path) if (path == $1) next } @@ -163,7 +164,7 @@ present() { awk -F'\t' ' key[n, ++need[n]] = "[software\\\\wow6432node\\\\" runtime "]" SUBSEP "installed" } } else { - both = substr(path, 1, 10) == "Software\\\\" + both = hive == "HKEY_LOCAL_MACHINE" && substr(path, 1, 10) == "Software\\\\" path = tolower(path) key[n, ++need[n]] = "[" path "]" SUBSEP tolower($2) if (both) @@ -200,60 +201,80 @@ for reg in "$steam_root"/steamapps/common/Proton*/files/share/default_pfx*/syste done declare -A regid=() if [ ${#regs[@]} -gt 0 ]; then + users=() + for reg in "${regs[@]}"; do users+=("${reg%/*}/user.reg"); done while IFS=$'\t' read -r id name; do regid[$name]=$id - done < <(stat -c $'%i %s %.9Y\t%n' -- "${regs[@]}" 2>/dev/null) + done < <(stat -c $'%i %s %.9Y\t%n' -- "${regs[@]}" "${users[@]}" 2>/dev/null) fi -for reg in "${regs[@]}"; do - seeded=${reg%/*}/.droiddeck-redists - checked=${reg%/*}/.droiddeck-redists-checked - id=${regid[$reg]:-} +for system in "${regs[@]}"; do + user=${system%/*}/user.reg + seeded=${system%/*}/.droiddeck-redists + checked=${system%/*}/.droiddeck-redists-checked + id="${regid[$system]:-}|${regid[$user]:-missing}" prev= [ -f "$checked" ] && read -r prev <"$checked" - legacy=${reg%/*}/.bannerlator-redists + legacy=${system%/*}/.bannerlator-redists if [ -f "$legacy" ] && [ ! -f "$seeded" ]; then mv -f "$legacy" "$seeded" fi - declare -A had=() - if [ -f "$seeded" ]; then - while IFS= read -r line; do [[ $line == *$'\t'* ]] && had[$line]=1; done <"$seeded" - fi - stale=() kept=() - for line in "${!had[@]}"; do - if [ -n "${vulkan[$line]:-}" ]; then stale+=("$line"); else kept+=("$line"); fi - done - if [ ${#stale[@]} -gt 0 ] && unseed "$reg" "${stale[@]}"; then - id= - had=() - for line in "${kept[@]}"; do had[$line]=1; done - printf '%s\n' "${kept[@]}" >"$seeded" - echo "== took Vulkan runtime markers out of $reg" - fi - if [ ${#had[@]} -gt 0 ] && { [ -z "$id" ] || [ "$id" != "$prev" ]; }; then - declare -A held=() - while IFS= read -r line; do [[ $line == *$'\t'* ]] && held[$line]=1; done < <(printf '%s\n' "${!had[@]}" | present "$reg") - if [ ${#held[@]} -lt ${#had[@]} ]; then - echo "== $((${#had[@]} - ${#held[@]})) recorded redist markers are gone from $reg" - had=() - for line in "${!held[@]}"; do had[$line]=1; done - printf '%s\n' "${!had[@]}" >"$seeded" + for reg in "$system" "$user"; do + hive=HKEY_LOCAL_MACHINE + [ "$reg" == "$user" ] && hive=HKEY_CURRENT_USER + declare -A had=() + other=() + if [ -f "$seeded" ]; then + while IFS= read -r line; do + [[ $line == *$'\t'* ]] || continue + if [[ $line == "$hive\\"* ]] || { [ "$reg" == "$system" ] && [[ $line == vcrt$'\t'* ]]; }; then + had[$line]=1 + else + other+=("$line") + fi + done <"$seeded" fi - unset held - fi - missing=() - for line in "${want[@]}"; do [ -n "${had[$line]:-}" ] || missing+=("$line"); done - if [ ${#missing[@]} -eq 0 ]; then - [ -n "$id" ] && [ "$id" != "$prev" ] && printf '%s\n' "$id" >"$checked" - continue - fi - rm -f "$checked" - dated=$(mktemp) || continue - touch -r "$reg" "$dated" - if printf '%s\n' "$(block_for "${missing[@]}")" >>"$reg"; then - printf '%s\n' "${!had[@]}" "${missing[@]}" >"$seeded" - echo "== seeded redist markers into $reg" - fi - touch -r "$dated" "$reg" - rm -f "$dated" + stale=() kept=() + for line in "${!had[@]}"; do + if [ -n "${vulkan[$line]:-}" ]; then stale+=("$line"); else kept+=("$line"); fi + done + if [ ${#stale[@]} -gt 0 ] && unseed "$reg" "${stale[@]}"; then + id= + had=() + for line in "${kept[@]}"; do had[$line]=1; done + printf '%s\n' "${other[@]}" "${kept[@]}" >"$seeded" + echo "== took Vulkan runtime markers out of $reg" + fi + if [ ${#had[@]} -gt 0 ] && { [ -z "$id" ] || [ "$id" != "$prev" ]; }; then + declare -A held=() + while IFS= read -r line; do [[ $line == *$'\t'* ]] && held[$line]=1; done < <([ -f "$reg" ] && printf '%s\n' "${!had[@]}" | present "$reg") + if [ ${#held[@]} -lt ${#had[@]} ]; then + echo "== $((${#had[@]} - ${#held[@]})) recorded redist markers are gone from $reg" + had=() + for line in "${!held[@]}"; do had[$line]=1; done + printf '%s\n' "${other[@]}" "${!had[@]}" >"$seeded" + fi + unset held + fi + missing=() + for line in "${want[@]}"; do + [[ $line == "$hive\\"* ]] || { [ "$reg" == "$system" ] && [[ $line == vcrt$'\t'* ]]; } || continue + [ -n "${had[$line]:-}" ] || missing+=("$line") + done + if [ ${#missing[@]} -eq 0 ]; then + [ -n "$id" ] && [ "$id" != "$prev" ] && printf '%s\n' "$id" >"$checked" + continue + fi + [ -f "$reg" ] && [ -w "$reg" ] || continue + rm -f "$checked" + dated=$(mktemp) || continue + touch -r "$reg" "$dated" + if printf '%s\n' "$(block_for "${missing[@]}")" >>"$reg"; then + printf '%s\n' "${other[@]}" "${!had[@]}" "${missing[@]}" >"$seeded" + id= + echo "== seeded redist markers into $reg" + fi + touch -r "$dated" "$reg" + rm -f "$dated" + done done diff --git a/tools/tests/test_seed_redists.py b/tools/tests/test_seed_redists.py index 27c5d42a9..042ab87d4 100644 --- a/tools/tests/test_seed_redists.py +++ b/tools/tests/test_seed_redists.py @@ -53,6 +53,8 @@ class SeedRedistsTest(unittest.TestCase): self.reg = self.steam / "steamapps/compatdata/1234/pfx/system.reg" self.reg.parent.mkdir(parents=True) self.reg.write_text("WINE REGISTRY Version 2\n") + self.user = self.reg.with_name("user.reg") + self.user.write_text('WINE REGISTRY Version 2\n\n[Software\\\\Unrelated] 1\n"Keep"="untouched"\n') def game(self, name="Some Game", script=GAME_SCRIPT, library=None): root = Path(library or self.steam) @@ -81,6 +83,93 @@ class SeedRedistsTest(unittest.TestCase): self.run_seed(str(sd)) self.assertIn('"VCRedist2022"=dword:00000001', self.reg.read_text()) + def test_current_user_and_machine_markers_go_to_their_own_registries(self): + self.game(script=GAME_SCRIPT + GAME_SCRIPT.replace("HKEY_LOCAL_MACHINE", "HKEY_CURRENT_USER").replace("VCRedist2022", "UserRedist")) + with self.reg.open("a") as out: + out.write('\n[Software\\\\Unrelated] 1\n"Keep"="machine"\n') + for reg in (self.reg, self.user): + os.utime(reg, ns=(1_000_000_000_123456789, 1_000_000_000_123456789)) + self.run_seed() + system, user = self.reg.read_text(), self.user.read_text() + self.assertEqual(system.count('"VCRedist2022"=dword:00000001'), 2) + self.assertNotIn("UserRedist", system) + self.assertEqual(user.count('"UserRedist"=dword:00000001'), 1) + self.assertNotIn("Wow6432Node", user) + self.assertNotIn("VCRedist2022", user) + self.assertIn('"Keep"="machine"', system) + self.assertIn('"Keep"="untouched"', user) + self.run_seed() + self.assertEqual(system, self.reg.read_text()) + self.assertEqual(user, self.user.read_text()) + for reg in (self.reg, self.user): + self.assertEqual(reg.stat().st_mtime_ns, 1_000_000_000_123456789) + + def test_a_user_marker_with_the_same_machine_path_and_value_is_separate(self): + self.game(script=GAME_SCRIPT + GAME_SCRIPT.replace("HKEY_LOCAL_MACHINE", "HKEY_CURRENT_USER")) + self.run_seed() + system = self.reg.read_text() + self.assertEqual(self.user.read_text().count('"VCRedist2022"=dword:00000001'), 1) + self.user.write_text("WINE REGISTRY Version 2\n") + self.run_seed() + self.assertEqual(self.user.read_text().count('"VCRedist2022"=dword:00000001'), 1) + self.assertEqual(system, self.reg.read_text()) + + def test_a_legacy_user_ledger_entry_is_checked_in_user_reg(self): + self.game(script=GAME_SCRIPT.replace("HKEY_LOCAL_MACHINE", "HKEY_CURRENT_USER")) + self.run_seed() + system = self.reg.read_bytes() + self.user.write_text("WINE REGISTRY Version 2\n") + (self.reg.parent / ".droiddeck-redists-checked").write_text(subprocess.check_output(["stat", "-c", "%i %s %.9Y", str(self.reg)], text=True)) + self.run_seed() + self.assertEqual(self.user.read_text().count('"VCRedist2022"=dword:00000001'), 1) + self.assertEqual(system, self.reg.read_bytes()) + + def test_an_absent_user_registry_is_not_created_or_claimed(self): + self.game(script=GAME_SCRIPT + GAME_SCRIPT.replace("HKEY_LOCAL_MACHINE", "HKEY_CURRENT_USER").replace("VCRedist2022", "UserRedist")) + self.user.unlink() + self.run_seed() + self.assertFalse(self.user.exists()) + self.assertNotIn("UserRedist", (self.reg.parent / ".droiddeck-redists").read_text()) + self.assertEqual(self.reg.read_text().count('"VCRedist2022"=dword:00000001'), 2) + system = self.reg.read_bytes() + self.user.write_text("WINE REGISTRY Version 2\n") + self.run_seed() + self.assertIn('"UserRedist"=dword:00000001', self.user.read_text()) + self.run_seed() + self.user.unlink() + self.run_seed() + self.assertFalse(self.user.exists()) + self.assertNotIn("UserRedist", (self.reg.parent / ".droiddeck-redists").read_text()) + self.assertEqual(system, self.reg.read_bytes()) + + @unittest.skipIf(os.name == "posix" and os.geteuid() == 0, "root can write through read-only mode bits") + def test_an_unwritable_user_registry_does_not_claim_a_missing_marker(self): + self.game(script=GAME_SCRIPT + GAME_SCRIPT.replace("HKEY_LOCAL_MACHINE", "HKEY_CURRENT_USER").replace("VCRedist2022", "UserRedist")) + ledger = self.reg.parent / ".droiddeck-redists" + ledger.write_text("HKEY_CURRENT_USER\\\\Software\\\\Valve\\\\Steam\\\\Apps\\\\CommonRedist\\\\vcredist\\\\2022\tUserRedist\n") + user = self.user.read_bytes() + self.user.chmod(0o444) + try: + self.run_seed() + self.assertEqual(user, self.user.read_bytes()) + self.assertEqual(self.user.stat().st_mode & 0o777, 0o444) + self.assertNotIn("UserRedist", ledger.read_text()) + self.assertEqual(self.reg.read_text().count('"VCRedist2022"=dword:00000001'), 2) + finally: + self.user.chmod(0o644) + + def test_user_markers_in_a_default_prefix_and_another_library_are_seeded(self): + default = self.steam / "steamapps/common/Proton Test/files/share/default_pfx" + default.mkdir(parents=True) + for name in ("system.reg", "user.reg"): + (default / name).write_text("WINE REGISTRY Version 2\n") + sd = self.tmp / "sd" + self.game(library=sd, script=GAME_SCRIPT.replace("HKEY_LOCAL_MACHINE", "HKEY_CURRENT_USER")) + self.run_seed(str(sd)) + self.assertIn('"VCRedist2022"=dword:00000001', (default / "user.reg").read_text()) + self.assertNotIn('"VCRedist2022"', (default / "system.reg").read_text()) + self.assertIn('"VCRedist2022"=dword:00000001', self.user.read_text()) + def test_the_vc_runtime_is_recorded_for_every_architecture_and_view(self): self.run_seed() reg = self.reg.read_text() @@ -156,7 +245,7 @@ class SeedRedistsTest(unittest.TestCase): self.assertIn('"x64 14.99.1.0"=dword:00000001', self.reg.read_text()) def test_an_unchanged_registry_is_not_read_again(self): - self.game() + self.game(script=GAME_SCRIPT + GAME_SCRIPT.replace("HKEY_LOCAL_MACHINE", "HKEY_CURRENT_USER").replace("VCRedist2022", "UserRedist")) self.run_seed() self.run_seed() shim = self.tmp / "bin" @@ -166,9 +255,21 @@ class SeedRedistsTest(unittest.TestCase): (shim / "awk").chmod(0o755) env = dict(os.environ, DROIDDECK_LIBRARIES="", PATH="%s:%s" % (shim, os.environ["PATH"])) once = self.reg.read_text() + user = self.user.read_text() subprocess.run(["bash", str(SCRIPT), str(self.steam)], env=env, capture_output=True, text=True, check=True) self.assertEqual(once, self.reg.read_text()) + self.assertEqual(user, self.user.read_text()) self.assertNotIn(str(self.reg), log.read_text() if log.exists() else "") + self.assertNotIn(str(self.user), log.read_text() if log.exists() else "") + replaced = self.user.with_name("user.reg.new") + replaced.write_text(user.replace('"UserRedist"', '"OtherValue"')) + os.utime(replaced, ns=(self.user.stat().st_atime_ns, self.user.stat().st_mtime_ns)) + self.assertEqual(replaced.stat().st_size, self.user.stat().st_size) + os.replace(replaced, self.user) + subprocess.run(["bash", str(SCRIPT), str(self.steam)], env=env, capture_output=True, text=True, check=True) + self.assertEqual(self.user.read_text().count('"UserRedist"=dword:00000001'), 1) + self.assertIn('"OtherValue"=dword:00000001', self.user.read_text()) + self.assertEqual(once, self.reg.read_text()) replaced = self.reg.with_name("system.reg.new") replaced.write_text("WINE REGISTRY Version 2\n") os.replace(replaced, self.reg) @@ -194,6 +295,39 @@ class SeedRedistsTest(unittest.TestCase): self.assertIn('"RockstarLauncher"=dword:00000001', reg) self.assertNotIn("Vulkan111080", (self.reg.parent / ".droiddeck-redists").read_text()) + def test_a_current_user_vulkan_installer_is_left_to_run(self): + self.game(script=VULKAN_SCRIPT.replace("HKEY_LOCAL_MACHINE", "HKEY_CURRENT_USER")) + self.run_seed() + self.assertIn('"RockstarLauncher"=dword:00000001', self.user.read_text()) + self.assertNotIn("Vulkan111080", self.user.read_text()) + self.assertNotIn("Vulkan111080", self.reg.read_text()) + self.assertNotIn("Vulkan111080", (self.reg.parent / ".droiddeck-redists").read_text()) + + def test_a_current_user_vulkan_marker_comes_out_of_only_its_own_hive(self): + self.game(script=VULKAN_SCRIPT.replace("HKEY_LOCAL_MACHINE", "HKEY_CURRENT_USER")) + self.run_seed() + system = self.reg.read_bytes() + b'\n[Software\\\\Valve\\\\Steam\\\\Apps\\\\1174180] 1\n"Vulkan111080"=dword:00000001\n' + self.reg.write_bytes(system) + with self.user.open("a") as out: + out.write('\n[Software\\\\Valve\\\\Steam\\\\Apps\\\\1174180] 1\n"Other"="keep"\n"Vulkan111080"=dword:00000001\n' + '\n[Software\\\\Wow6432Node\\\\Valve\\\\Steam\\\\Apps\\\\1174180] 1\n"Vulkan111080"=dword:00000001\n' + '\n[Software\\\\Valve\\\\Steam\\\\Apps\\\\22380] 1\n"Vulkan111080"=dword:00000001\n') + with (self.reg.parent / ".droiddeck-redists").open("a") as out: + out.write("HKEY_CURRENT_USER\\\\Software\\\\Valve\\\\Steam\\\\Apps\\\\1174180\tVulkan111080\n") + os.utime(self.user, ns=(1_000_000_000_123456789, 1_000_000_000_123456789)) + self.run_seed() + user = self.user.read_text() + self.assertEqual(user.count('"Vulkan111080"'), 2, "the other path and the unseeded user view stay") + self.assertIn('"Other"="keep"', user) + self.assertEqual(system, self.reg.read_bytes()) + self.assertNotIn("Vulkan111080", (self.reg.parent / ".droiddeck-redists").read_text()) + self.assertEqual(self.user.stat().st_mtime_ns, 1_000_000_000_123456789) + with self.user.open("a") as out: + out.write('\n[Software\\\\Valve\\\\Steam\\\\Apps\\\\1174180] 1\n"Vulkan111080"=dword:00000001\n') + user = self.user.read_bytes() + self.run_seed() + self.assertEqual(user, self.user.read_bytes()) + def test_a_vulkan_marker_an_earlier_seeding_wrote_comes_out_once(self): self.rdr2() marker = "HKEY_LOCAL_MACHINE\\\\Software\\\\Valve\\\\Steam\\\\Apps\\\\1174180\tVulkan111080"