Skip to content

Commit 024673d

Browse files
Add safe in-app updater (#28)
## Summary Adds a safe in-app updater for ThreadPilot. This PR does not bump the app version and does not prepare a release; version and release metadata will be handled separately for v1.4.0. ## Type of Change - [x] Feature - [x] Security hardening - [x] Documentation - [x] Added/updated tests ## Update flow - Checks for updates on demand from Settings. - Performs background startup checks only when enabled and the last check is older than the configured interval. - Defaults to a 7-day interval. - Excludes prereleases by default. - Notifies users when an update is available. - Requires explicit user action before download/install. ## Security and safety - Uses release metadata from the official `PrimeBuild-pc/ThreadPilot` repository only. - Selects safe ThreadPilot installer assets from GitHub HTTPS release assets. - Downloads into a ThreadPilot-owned temp update directory. - Verifies SHA256 checksums when `SHA256SUMS.txt` is available. - Rejects checksum mismatches. - Performs best-effort Authenticode verification and rejects explicitly invalid signatures. - Starts the installer elevated without shell command construction. - Prevents concurrent install attempts. ## User data preservation - Update flow does not delete AppData, settings, profiles, CPU masks, rules, custom/imported power plans, or logs. - Only updater temp files are cleaned. - Full uninstall behavior remains separate. ## Validation - `dotnet restore ThreadPilot_1.sln`: passed - `dotnet build ThreadPilot_1.sln`: passed, 0 warnings, 0 errors - `dotnet test ThreadPilot_1.sln`: passed, 537 tests ## Release note This PR intentionally leaves `ThreadPilot.csproj` at `1.3.1`. The `1.4.0` version bump, changelog, packaging metadata, and tag should happen in a separate release-prep branch after this PR is merged.
1 parent b0b65e8 commit 024673d

30 files changed

Lines changed: 1717 additions & 146 deletions

‎Locales/en-US.xaml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -436,6 +436,12 @@
436436
<sys:String x:Key="SettingsView_Translator">Translator: Ylimhs</sys:String>
437437
<sys:String x:Key="SettingsView_License">License: AGPLv3</sys:String>
438438
<sys:String x:Key="SettingsView_CheckUpdates">Check for updates</sys:String>
439+
<sys:String x:Key="SettingsView_DownloadInstallUpdate">Download and install update</sys:String>
440+
<sys:String x:Key="SettingsView_EnableAutomaticUpdateChecks">Check automatically on startup</sys:String>
441+
<sys:String x:Key="SettingsView_UpdateIntervalDays">Check interval (days):</sys:String>
442+
<sys:String x:Key="SettingsView_IncludePrereleaseUpdates">Include prerelease updates</sys:String>
443+
<sys:String x:Key="SettingsView_LatestVersion">Latest version:</sys:String>
444+
<sys:String x:Key="SettingsView_LastUpdateCheck">Last checked:</sys:String>
439445
<sys:String x:Key="SettingsView_UpdatesDescription">Checks on demand using the official GitHub Releases.</sys:String>
440446

441447
<sys:String x:Key="SettingsView_ResetDefaults">Reset to Defaults</sys:String>
@@ -474,6 +480,15 @@
474480
<sys:String x:Key="Settings_StatusNewVersionFormat">New version available: {0}</sys:String>
475481
<sys:String x:Key="Settings_StatusUpToDateFormat">Application is up to date. Installed version: {0}</sys:String>
476482
<sys:String x:Key="Settings_StatusUpdateErrorFormat">Error while checking updates: {0}</sys:String>
483+
<sys:String x:Key="Settings_UpdateLatestUnknown">Unknown</sys:String>
484+
<sys:String x:Key="Settings_UpdateNotChecked">Not checked</sys:String>
485+
<sys:String x:Key="Settings_UpdateLastCheckedNever">Never</sys:String>
486+
<sys:String x:Key="Settings_UpdateConfirmTitle">Install ThreadPilot update</sys:String>
487+
<sys:String x:Key="Settings_UpdateConfirmMessageFormat">ThreadPilot will download and verify version {0}, then ask Windows for permission to run the installer. Continue?</sys:String>
488+
<sys:String x:Key="Settings_StatusUpdateCanceled">Update canceled.</sys:String>
489+
<sys:String x:Key="Settings_StatusDownloadingUpdate">Downloading and verifying update...</sys:String>
490+
<sys:String x:Key="Settings_StatusUpdateInstallerStarted">Update installer started.</sys:String>
491+
<sys:String x:Key="Settings_StatusUpdateInstallFailedFormat">Update install failed: {0}</sys:String>
477492
<sys:String x:Key="Settings_StatusModified">Settings have been modified</sys:String>
478493
<sys:String x:Key="Settings_StatusMatchSaved">Settings match the saved configuration</sys:String>
479494
<sys:String x:Key="Settings_LanguageSimplifiedChinese">Simplified Chinese</sys:String>

‎Locales/zh-CN.xaml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -436,6 +436,12 @@
436436
<sys:String x:Key="SettingsView_Translator">翻译人员:Ylimhs</sys:String>
437437
<sys:String x:Key="SettingsView_License">软件授权: AGPLv3</sys:String>
438438
<sys:String x:Key="SettingsView_CheckUpdates">检查新版本</sys:String>
439+
<sys:String x:Key="SettingsView_DownloadInstallUpdate">下载并安装更新</sys:String>
440+
<sys:String x:Key="SettingsView_EnableAutomaticUpdateChecks">启动时自动检查更新</sys:String>
441+
<sys:String x:Key="SettingsView_UpdateIntervalDays">检查间隔(天):</sys:String>
442+
<sys:String x:Key="SettingsView_IncludePrereleaseUpdates">包含预发布版本</sys:String>
443+
<sys:String x:Key="SettingsView_LatestVersion">最新版本:</sys:String>
444+
<sys:String x:Key="SettingsView_LastUpdateCheck">上次检查:</sys:String>
439445
<sys:String x:Key="SettingsView_UpdatesDescription">按需通过官方 GitHub Releases API 检索最新稳定版本。</sys:String>
440446

441447
<sys:String x:Key="SettingsView_ResetDefaults">重置为默认值</sys:String>
@@ -474,6 +480,15 @@
474480
<sys:String x:Key="Settings_StatusNewVersionFormat">发现新版本: {0}</sys:String>
475481
<sys:String x:Key="Settings_StatusUpToDateFormat">应用已是最新版本。已安装版本: {0}</sys:String>
476482
<sys:String x:Key="Settings_StatusUpdateErrorFormat">检查更新时出错: {0}</sys:String>
483+
<sys:String x:Key="Settings_UpdateLatestUnknown">未知</sys:String>
484+
<sys:String x:Key="Settings_UpdateNotChecked">尚未检查</sys:String>
485+
<sys:String x:Key="Settings_UpdateLastCheckedNever">从未检查</sys:String>
486+
<sys:String x:Key="Settings_UpdateConfirmTitle">安装 ThreadPilot 更新</sys:String>
487+
<sys:String x:Key="Settings_UpdateConfirmMessageFormat">ThreadPilot 将下载并验证版本 {0},然后请求 Windows 权限运行安装程序。是否继续?</sys:String>
488+
<sys:String x:Key="Settings_StatusUpdateCanceled">更新已取消。</sys:String>
489+
<sys:String x:Key="Settings_StatusDownloadingUpdate">正在下载并验证更新...</sys:String>
490+
<sys:String x:Key="Settings_StatusUpdateInstallerStarted">更新安装程序已启动。</sys:String>
491+
<sys:String x:Key="Settings_StatusUpdateInstallFailedFormat">更新安装失败: {0}</sys:String>
477492
<sys:String x:Key="Settings_StatusModified">设置已被修改</sys:String>
478493
<sys:String x:Key="Settings_StatusMatchSaved">设置与已保存的配置一致</sys:String>
479494
<sys:String x:Key="Settings_LanguageSimplifiedChinese">简体中文</sys:String>

‎MainWindow.Behaviors.partial.cs‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -157,27 +157,26 @@ private async Task CheckForUpdatesAtStartupAsync()
157157
try
158158
{
159159
this.LogDebug("Startup update check started");
160-
var checker = this.serviceProvider.GetRequiredService<GitHubUpdateChecker>();
161-
var currentVersion = GetCurrentApplicationVersion();
162-
var (latest, _) = await checker.GetLatestVersionAsync("PrimeBuild-pc", "ThreadPilot");
160+
var updateService = this.serviceProvider.GetRequiredService<IUpdateService>();
161+
var result = await updateService.CheckForUpdatesAsync(new UpdateCheckRequest(UpdateCheckTrigger.Startup));
163162

164-
if (latest == null)
163+
if (result.Status == UpdateCheckStatus.Skipped)
165164
{
166-
this.LogDebug("Startup update check completed without release information");
165+
this.LogDebug($"Startup update check skipped: {result.Message}");
167166
return;
168167
}
169168

170-
if (latest <= currentVersion)
169+
if (!result.IsUpdateAvailable || result.Release == null)
171170
{
172-
this.LogDebug($"Startup update check complete: installed {currentVersion}, latest {latest}");
171+
this.LogDebug($"Startup update check complete: {result.Message}");
173172
return;
174173
}
175174

176175
await this.notificationService.ShowNotificationAsync(
177176
"Update available",
178-
$"ThreadPilot {latest} is available from GitHub releases.",
177+
$"ThreadPilot {result.Release.Version} is available. Open Settings to download and install it.",
179178
NotificationType.Information);
180-
this.LogDebug($"Startup update check found update: installed {currentVersion}, latest {latest}");
179+
this.LogDebug($"Startup update check found update: installed {result.CurrentVersion}, latest {result.Release.Version}");
181180
}
182181
catch (Exception ex)
183182
{

‎Models/ApplicationSettingsModel.cs‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,18 @@ public partial class ApplicationSettingsModel : ObservableObject, IModel
154154
[ObservableProperty]
155155
private string language = LocalizationService.DefaultLanguage;
156156

157+
[ObservableProperty]
158+
private bool enableAutomaticUpdateChecks = true;
159+
160+
[ObservableProperty]
161+
private DateTimeOffset? lastUpdateCheckUtc = null;
162+
163+
[ObservableProperty]
164+
private int updateCheckIntervalDays = 7;
165+
166+
[ObservableProperty]
167+
private bool includePrereleaseUpdates = false;
168+
157169
// Monitoring Settings
158170
[ObservableProperty]
159171
private int pollingIntervalMs = 5000;
@@ -253,6 +265,10 @@ public void CopyFrom(ApplicationSettingsModel other)
253265
this.UseDarkTheme = other.UseDarkTheme;
254266
this.HasUserThemePreference = other.HasUserThemePreference;
255267
this.Language = LocalizationService.NormalizeLanguage(other.Language);
268+
this.EnableAutomaticUpdateChecks = other.EnableAutomaticUpdateChecks;
269+
this.LastUpdateCheckUtc = other.LastUpdateCheckUtc;
270+
this.UpdateCheckIntervalDays = other.UpdateCheckIntervalDays;
271+
this.IncludePrereleaseUpdates = other.IncludePrereleaseUpdates;
256272

257273
// Monitoring Settings
258274
this.PollingIntervalMs = other.PollingIntervalMs;
@@ -298,6 +314,11 @@ public ValidationResult Validate()
298314
errors.Add("Fallback polling interval must be between 1 and 60 seconds");
299315
}
300316

317+
if (this.UpdateCheckIntervalDays < 1 || this.UpdateCheckIntervalDays > 365)
318+
{
319+
errors.Add("Update check interval must be between 1 and 365 days");
320+
}
321+
301322
return errors.Count == 0 ? ValidationResult.Success() : ValidationResult.Failure(errors.ToArray());
302323
}
303324

‎Services/Abstractions/IGitHubReleaseClient.cs‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,7 @@ namespace ThreadPilot.Services.Abstractions
99
public interface IGitHubReleaseClient
1010
{
1111
Task<string> GetLatestReleaseJsonAsync(string owner, string repo, CancellationToken cancellationToken = default);
12+
13+
Task<string> GetReleasesJsonAsync(string owner, string repo, CancellationToken cancellationToken = default);
1214
}
1315
}

‎Services/ApplicationSettingsService.cs‎

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -246,18 +246,28 @@ public void ValidateAndFixSettings()
246246
this.settings.MaxNotificationHistoryItems = 1000;
247247
}
248248

249-
// Validate custom icon path
250-
if (this.settings.UseCustomTrayIcon && !string.IsNullOrEmpty(this.settings.CustomTrayIconPath))
251-
{
252-
if (!File.Exists(this.settings.CustomTrayIconPath))
253-
{
249+
// Validate custom icon path
250+
if (this.settings.UseCustomTrayIcon && !string.IsNullOrEmpty(this.settings.CustomTrayIconPath))
251+
{
252+
if (!File.Exists(this.settings.CustomTrayIconPath))
253+
{
254254
this.logger.LogWarning("Custom tray icon file not found: {Path}", this.settings.CustomTrayIconPath);
255-
this.settings.UseCustomTrayIcon = false;
256-
}
257-
}
258-
259-
this.settings.Language = LocalizationService.NormalizeLanguage(this.settings.Language);
260-
}
255+
this.settings.UseCustomTrayIcon = false;
256+
}
257+
}
258+
259+
this.settings.Language = LocalizationService.NormalizeLanguage(this.settings.Language);
260+
261+
if (this.settings.UpdateCheckIntervalDays < 1)
262+
{
263+
this.settings.UpdateCheckIntervalDays = 1;
264+
}
265+
266+
if (this.settings.UpdateCheckIntervalDays > 365)
267+
{
268+
this.settings.UpdateCheckIntervalDays = 365;
269+
}
270+
}
261271

262272
public async Task ExportSettingsAsync(string filePath)
263273
{
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
/*
2+
* ThreadPilot - application version provider for update checks.
3+
*/
4+
namespace ThreadPilot.Services
5+
{
6+
using System;
7+
using System.Linq;
8+
using System.Reflection;
9+
10+
public sealed class ApplicationVersionProvider : IApplicationVersionProvider
11+
{
12+
public SemanticVersion CurrentVersion
13+
{
14+
get
15+
{
16+
var rawVersion = GetRawVersion();
17+
return SemanticVersion.TryParse(rawVersion, out var version)
18+
? version
19+
: new SemanticVersion(0, 0, 0);
20+
}
21+
}
22+
23+
public string DisplayVersion => $"v{this.CurrentVersion}";
24+
25+
private static string GetRawVersion()
26+
{
27+
return typeof(App).Assembly
28+
.GetCustomAttributes(typeof(AssemblyInformationalVersionAttribute), false)
29+
.OfType<AssemblyInformationalVersionAttribute>()
30+
.FirstOrDefault()?
31+
.InformationalVersion
32+
?? typeof(App).Assembly.GetName().Version?.ToString()
33+
?? "0.0.0";
34+
}
35+
}
36+
}
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
/*
2+
* ThreadPilot - best-effort Authenticode signature detection.
3+
*/
4+
namespace ThreadPilot.Services
5+
{
6+
using System;
7+
using System.IO;
8+
using System.Security.Cryptography;
9+
using System.Security.Cryptography.X509Certificates;
10+
11+
public sealed class AuthenticodeSignatureVerifier : IUpdateSignatureVerifier
12+
{
13+
public UpdateSignatureStatus Verify(string installerPath)
14+
{
15+
if (!File.Exists(installerPath))
16+
{
17+
return UpdateSignatureStatus.Invalid;
18+
}
19+
20+
try
21+
{
22+
using var certificate = new X509Certificate2(X509Certificate.CreateFromSignedFile(installerPath));
23+
using var chain = new X509Chain
24+
{
25+
ChainPolicy =
26+
{
27+
RevocationMode = X509RevocationMode.Online,
28+
RevocationFlag = X509RevocationFlag.ExcludeRoot,
29+
},
30+
};
31+
32+
return chain.Build(certificate)
33+
? UpdateSignatureStatus.Valid
34+
: UpdateSignatureStatus.Unknown;
35+
}
36+
catch (CryptographicException)
37+
{
38+
return UpdateSignatureStatus.Unknown;
39+
}
40+
catch (PlatformNotSupportedException)
41+
{
42+
return UpdateSignatureStatus.Unknown;
43+
}
44+
}
45+
}
46+
}

‎Services/GitHubReleaseClient.cs‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,11 @@ public Task<string> GetLatestReleaseJsonAsync(string owner, string repo, Cancell
2323
var url = $"https://api.github.com/repos/{owner}/{repo}/releases/latest";
2424
return this.httpClient.GetStringAsync(url, cancellationToken);
2525
}
26+
27+
public Task<string> GetReleasesJsonAsync(string owner, string repo, CancellationToken cancellationToken = default)
28+
{
29+
var url = $"https://api.github.com/repos/{owner}/{repo}/releases";
30+
return this.httpClient.GetStringAsync(url, cancellationToken);
31+
}
2632
}
2733
}

‎Services/GitHubUpdateChecker.cs‎

Lines changed: 68 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@
1717
namespace ThreadPilot.Services
1818
{
1919
using System;
20+
using System.Collections.Generic;
21+
using System.Linq;
2022
using System.Text.Json;
2123
using System.Threading;
2224
using System.Threading.Tasks;
@@ -26,7 +28,14 @@ public sealed class GitHubUpdateChecker
2628
{
2729
private readonly IGitHubReleaseClient gitHubReleaseClient;
2830

29-
private record LatestRelease(string Tag_name, bool Prerelease, bool Draft, string Html_url);
31+
private record LatestRelease(
32+
string Tag_name,
33+
bool Prerelease,
34+
bool Draft,
35+
string Html_url,
36+
IReadOnlyList<LatestReleaseAsset>? Assets);
37+
38+
private record LatestReleaseAsset(string Name, string Browser_download_url, long Size);
3039

3140
public GitHubUpdateChecker(IGitHubReleaseClient gitHubReleaseClient)
3241
{
@@ -71,6 +80,64 @@ public GitHubUpdateChecker(IGitHubReleaseClient gitHubReleaseClient)
7180
? (version, release.Html_url)
7281
: (null, release.Html_url);
7382
}
83+
84+
public async Task<UpdateReleaseInfo?> GetLatestReleaseInfoAsync(
85+
string owner,
86+
string repo,
87+
bool includePrereleases = false,
88+
CancellationToken cancellationToken = default)
89+
{
90+
if (string.IsNullOrWhiteSpace(owner))
91+
{
92+
throw new ArgumentException("Owner is required", nameof(owner));
93+
}
94+
95+
if (string.IsNullOrWhiteSpace(repo))
96+
{
97+
throw new ArgumentException("Repository is required", nameof(repo));
98+
}
99+
100+
var json = await this.gitHubReleaseClient.GetReleasesJsonAsync(owner, repo, cancellationToken).ConfigureAwait(false);
101+
var releases = JsonSerializer.Deserialize<List<LatestRelease>>(json, new JsonSerializerOptions
102+
{
103+
PropertyNameCaseInsensitive = true,
104+
});
105+
106+
if (releases == null || releases.Count == 0)
107+
{
108+
return null;
109+
}
110+
111+
return releases
112+
.Where(release => !release.Draft)
113+
.Where(release => includePrereleases || !release.Prerelease)
114+
.Select(TryMapRelease)
115+
.Where(release => release != null)
116+
.Cast<UpdateReleaseInfo>()
117+
.OrderByDescending(release => release.Version)
118+
.FirstOrDefault();
119+
}
120+
121+
private static UpdateReleaseInfo? TryMapRelease(LatestRelease release)
122+
{
123+
if (!SemanticVersion.TryParse(release.Tag_name, out var version) ||
124+
string.IsNullOrWhiteSpace(release.Html_url) ||
125+
!Uri.TryCreate(release.Html_url, UriKind.Absolute, out var releasePageUrl))
126+
{
127+
return null;
128+
}
129+
130+
var assets = (release.Assets ?? Array.Empty<LatestReleaseAsset>())
131+
.Where(asset => !string.IsNullOrWhiteSpace(asset.Name))
132+
.Where(asset => Uri.TryCreate(asset.Browser_download_url, UriKind.Absolute, out _))
133+
.Select(asset => new UpdateAsset(
134+
asset.Name,
135+
new Uri(asset.Browser_download_url, UriKind.Absolute),
136+
asset.Size))
137+
.ToArray();
138+
139+
return new UpdateReleaseInfo(version, release.Tag_name, releasePageUrl, release.Prerelease, assets);
140+
}
74141
}
75142
}
76143

0 commit comments

Comments
 (0)