Merge pull request #8 from totalretribution/update-checker

Author: totalretribution

.vscode/launch.json

@@ -11,6 +11,7 @@
             "preLaunchTask": "build:cli",
             "program": "${workspaceFolder}/src/SshAgentEcho.Cli/bin/Debug/net10.0/ssh-agent-echo.dll",
             "args": [
+                "--update",
                 "--print",
                 "--sync",
                 "--force"

Assets/icon.png

@@ -26,10 +26,15 @@ static int Main(string[] args) {
             Description = "Force sync even if CRC matches"
         };
 
+        Option<bool> updateOption = new("--update") {
+            Description = "Check for updates"
+        };
+
         RootCommand rootCommand = new("ssh-agent-echo - A tool to sync SSH agent public keys to ssh config");
         rootCommand.Options.Add(printOption);
         rootCommand.Options.Add(syncOption);
         rootCommand.Options.Add(forceOption);
+        rootCommand.Options.Add(updateOption);
 
         var version = Assembly.GetEntryAssembly()?
             .GetCustomAttribute<AssemblyInformationalVersionAttribute>()?.InformationalVersion ?? "unknown";
@@ -42,6 +47,23 @@ static int Main(string[] args) {
         Console.WriteLine(bar + "\n");
 
         rootCommand.SetAction(parseResult => {
+            bool isUpdate = parseResult.GetValue(updateOption);
+            if (isUpdate) {
+                var updateChecker = new Update();
+                updateChecker.Check().Wait();
+                if (updateChecker.IsNewVersionAvailable()) {
+                    Log.Info("A new version is available!");
+                    Log.Info($"Current version: {version}");
+                    Log.Info($"Latest version: {updateChecker.LatestVersion}");
+                    Log.Info($"Release URL: {updateChecker.GetReleaseURL()}");
+                    Log.Info($"Download URL: {updateChecker.GetDownloadUrl()}");
+                    // Log.Info($"Release notes: {updateChecker.ReleaseNotes}");
+                } else {
+                    Log.Info("You are using the latest version.");
+                }
+                return;
+            }
+
             bool isVerbose = parseResult.GetValue(printOption);
             if (isVerbose) {
                 var agent = new Agent();

src/SshAgentEcho.Cli/Program.cs

@@ -7,41 +7,33 @@
 
 namespace SshAgentEcho.Core;
 
-public class Agent : IEnumerable<Agent.Identity>
-{
-    public readonly record struct Identity(string Comment, string User, string Host, string? Name, string Hash, string Type, string Filename)
-    {
-        public override string ToString()
-        {
+public class Agent : IEnumerable<Agent.Identity> {
+    public readonly record struct Identity(string Comment, string User, string Host, string? Name, string Hash, string Type, string Filename) {
+        public override string ToString() {
             return $"{Type} {Hash} {Comment}";
         }
     }
 
     private readonly List<Identity> _identities = new();
     private int _cursor = -1;
 
-    public Agent()
-    {
+    public Agent() {
         PopulateIdentities();
     }
 
-    public void Refresh()
-    {
+    public void Refresh() {
         PopulateIdentities();
     }
 
-    public void PrintIdentities()
-    {
-        foreach (var identity in _identities)
-        {
+    public void PrintIdentities() {
+        foreach (var identity in _identities) {
             Log.Info(identity);
         }
     }
 
     public IReadOnlyList<Identity> GetIdentities() => _identities.ToList();
 
-    public Identity? Next()
-    {
+    public Identity? Next() {
         if (_cursor + 1 >= _identities.Count) return null;
         _cursor++;
         return _identities[_cursor];
@@ -52,8 +44,7 @@ public void PrintIdentities()
     public IEnumerator<Identity> GetEnumerator() => _identities.GetEnumerator();
     IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
 
-    private String? GetOpenSshKey(SshAgentPrivateKey? identity)
-    {
+    private String? GetOpenSshKey(SshAgentPrivateKey? identity) {
         if (identity?.Key == null) return null;
 
         var key = identity.Key;
@@ -70,38 +61,31 @@ public void PrintIdentities()
         return Convert.ToBase64String(publicKeyBlob);
     }
 
-    private string? ExtractChevronContent(string input)
-    {
+    private string? ExtractChevronContent(string input) {
         int start = input.IndexOf('<');
         int end = input.IndexOf('>');
-        if (start >= 0 && end > start)
-        {
+        if (start >= 0 && end > start) {
             return input.Substring(start + 1, end - start - 1);
         }
         return null;
     }
 
-    private (string User, string Host, string? Name)? ProcessComment(string comment)
-    {
+    private (string User, string Host, string? Name)? ProcessComment(string comment) {
         string? user_host = comment.Trim();
         string user = "";
         string host = "";
         string? name = null;
-        if (comment.Contains('<') || comment.Contains('>'))
-        {
+        if (comment.Contains('<') || comment.Contains('>')) {
             // Must have exactly one '<' and one '>'
-            if (comment.Count(c => c == '<') != 1 || comment.Count(c => c == '>') != 1)
-            {
+            if (comment.Count(c => c == '<') != 1 || comment.Count(c => c == '>') != 1) {
                 return null;
             }
             // '>' must come after '<'
-            if (comment.IndexOf('<') > comment.IndexOf('>'))
-            {
+            if (comment.IndexOf('<') > comment.IndexOf('>')) {
                 return null;
             }
             // '<' must not be the first character, the name must be at least 2 characters long.
-            if (comment.IndexOf('<') < 2)
-            {
+            if (comment.IndexOf('<') < 2) {
                 return null;
             }
             user_host = ExtractChevronContent(comment);
@@ -123,64 +107,50 @@ public void PrintIdentities()
         return (user, host, name);
     }
 
-    private string GenerateFileName(string? name, string host)
-    {
+    private string GenerateFileName(string? name, string host) {
         String filename = "";
-        if (!string.IsNullOrEmpty(name))
-        {
+        if (!string.IsNullOrEmpty(name)) {
             filename = name;
-        }
-        else
-        {
+        } else {
             filename = host;
         }
         filename = filename.Replace(".", "_").Replace(" ", "_");
         filename += ".pub";
         return filename;
     }
 
-    private SshAgentPrivateKey[]? RequestIdentities()
-    {
+    private SshAgentPrivateKey[]? RequestIdentities() {
         var agent = new SshAgent();
 
-        try
-        {
+        try {
             return Task
                 .Run(() => agent.RequestIdentities())
                 .WaitAsync(TimeSpan.FromMinutes(3))
                 .GetAwaiter()
                 .GetResult();
-        }
-        catch (TimeoutException)
-        {
+        } catch (TimeoutException) {
             // Handle the fact that the agent is ghosting you
-            Console.WriteLine("SSH Agent failed to respond within the timeout.");
-        }
-        catch (Exception ex)
-        {
+            Log.Error("SSH Agent failed to respond within the timeout.");
+        } catch (Exception ex) {
             // Handle other potential connection/SSH errors
-            Console.WriteLine($"An error occurred: {ex.Message}");
+            Log.Error($"An error occurred: {ex.Message}");
         }
         return null;
     }
 
-    private void PopulateIdentities()
-    {
+    private void PopulateIdentities() {
         Log.Info("Querying SSH agent for identities...");
         this._identities.Clear();
         _cursor = -1;
-        try
-        {
+        try {
             var agentIdentities = RequestIdentities();
 
-            if (agentIdentities == null)
-            {
+            if (agentIdentities == null) {
                 Log.Warning("No identities found or failed to retrieve identities from SSH agent.");
                 return;
             }
 
-            foreach (var id in agentIdentities)
-            {
+            foreach (var id in agentIdentities) {
                 var hash = GetOpenSshKey(id);
                 var type = id?.Key?.ToString();
                 var comment = id?.Key.Comment;
@@ -195,9 +165,7 @@ private void PopulateIdentities()
                 var identity = new Identity(Comment: comment, User: user, Host: host, Name: name, Hash: hash, Type: type, Filename: filename);
                 this._identities.Add(identity);
             }
-        }
-        catch (Exception ex)
-        {
+        } catch (Exception ex) {
             Log.Error($"Error querying SSH agent: {ex.Message}");
         }
     }

src/SshAgentEcho.Core/Agent.cs

@@ -7,6 +7,7 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <PackageReference Include="Octokit" Version="14.0.0" />
     <PackageReference Include="SSH.NET" Version="2025.1.0" />
     <PackageReference Include="SshNet.Agent" Version="2024.2.0.1" />
   </ItemGroup>

src/SshAgentEcho.Core/SshAgentEcho.Core.csproj

@@ -0,0 +1,94 @@
+using Octokit;
+using System.Runtime.InteropServices;
+using System.Reflection;
+
+namespace SshAgentEcho.Core;
+
+public class Update {
+    public string? LatestVersion { get; private set; } = null;
+    public string? ReleaseNotes { get; private set; } = null;
+    public ReleaseAsset? LatestAsset { get; private set; } = null;
+    public Release? LatestRelease { get; private set; } = null;
+
+    private string _currentVersion;
+    private string _repo;
+    private string _owner;
+
+    public Update() {
+        _repo = "ssh-agent-echo";
+        _owner = "totalretribution";
+        var version = Assembly.GetEntryAssembly()?
+            .GetCustomAttribute<AssemblyInformationalVersionAttribute>()?.InformationalVersion;
+        if (version == null) {
+            _currentVersion = "0.0.0";
+        } else {
+            _currentVersion = version;
+        }
+    }
+
+    public bool IsNewVersionAvailable() {
+        if (LatestVersion == null) return false;
+        try {
+            var current = Version.Parse(_currentVersion);
+            var latest = Version.Parse(LatestVersion);
+            return latest > current;
+        } catch (Exception) {
+            return false;
+        }
+    }
+
+    public string? GetDownloadUrl() {
+        return LatestAsset?.BrowserDownloadUrl;
+    }
+
+    public string? GetReleaseURL() {
+        return LatestRelease?.HtmlUrl;
+    }
+
+    public string? GetContentType() {
+        return LatestAsset?.ContentType;
+    }
+
+    public DateTime? GetReleaseUTC() {
+        return LatestRelease?.PublishedAt?.UtcDateTime;
+    }
+
+    public int? GetUpdateSize() {
+        return LatestAsset?.Size;
+    }
+
+    private ReleaseAsset? GetAsset(IReadOnlyList<ReleaseAsset>? assets = null) {
+        if (assets == null) return null;
+        string rid = RuntimeInformation.RuntimeIdentifier;
+        var asset = assets.FirstOrDefault(a => a.Name.Contains(rid, StringComparison.OrdinalIgnoreCase));
+        return asset;
+    }
+
+    public async Task Check() {
+        if (_repo == null || _owner == null || _currentVersion == null) {
+            throw new InvalidOperationException("Repo, owner, and current version must be set.");
+        }
+        var client = new GitHubClient(new Octokit.ProductHeaderValue(_repo));
+
+        try {
+            Log.Info("Checking for updates...");
+            var latestRelease = await client.Repository.Release.GetLatest(_owner, _repo);
+            var latestVersion = Version.Parse(latestRelease.TagName.TrimStart('v'));
+            LatestVersion = latestVersion.ToString();
+            ReleaseNotes = latestRelease.Body;
+            var asset = GetAsset(latestRelease.Assets);
+            if (asset == null) {
+                throw new Exception("No suitable asset found for the current platform.");
+            }
+            LatestAsset = asset;
+            LatestRelease = latestRelease;
+
+        } catch (Exception ex) {
+            Log.Error($"An error occurred while checking for updates: {ex.Message}");
+            LatestVersion = null;
+            ReleaseNotes = null;
+            LatestAsset = null;
+            LatestRelease = null;
+        }
+    }
+}