Add SyncTriggerKey authentication to /api/sync endpoint

Co-authored-by: hajekj <8337913+hajekj@users.noreply.github.com>
Agent-Logs-Url: https://github.com/NETWORG/github-organization-management/sessions/9cf4b695-d1a9-42f4-8a12-0d0008dbdfbf

Author: Copilot

README.md

@@ -69,7 +69,8 @@ The application secrets can be also passed in as [environment variables](https:/
   },
   "ExemptUsers": [
     "<Case_Sensitive_List_Of_Users>"
-  ]
+  ],
+  "SyncTriggerKey": "<secret_key_to_trigger_sync>"
 }
 ```
 

Web/Controllers/SyncController.cs

@@ -3,6 +3,7 @@
 using Web.Services;
 using Microsoft.AspNetCore.Mvc;
 using Octokit;
+using System.Security.Cryptography;
 using System.Text;
 
 namespace Web.Controllers
@@ -14,18 +15,38 @@ public class SyncController : Controller
         private readonly string _privateKeyPem;
         private readonly string _clientId;
         private readonly string _appId;
+        private readonly string? _syncTriggerKey;
         private readonly MicrosoftGraphService _microsoftGraph;
         private readonly ILogger _logger;
         public SyncController(IConfiguration configuration, MicrosoftGraphService microsoftGraph, ILoggerFactory loggerFactory)
         {
             _privateKeyPem = Encoding.UTF8.GetString(Convert.FromBase64String(configuration["GitHubProvisioning:PrivateKey"]));
             _clientId = configuration["GitHubProvisioning:ClientId"];
             _appId = configuration["GitHubProvisioning:AppId"];
+            _syncTriggerKey = configuration["SyncTriggerKey"];
             _microsoftGraph = microsoftGraph;
             _logger = loggerFactory.CreateLogger<SyncController>();
         }
         public async Task<IActionResult> Index()
         {
+            if (string.IsNullOrWhiteSpace(_syncTriggerKey))
+            {
+                _logger.LogError("SyncTriggerKey is not configured. The /api/sync endpoint cannot be used.");
+                return new StatusCodeResult(StatusCodes.Status500InternalServerError);
+            }
+
+            if (!Request.Headers.TryGetValue("X-Sync-Trigger-Key", out var providedKey))
+            {
+                return new UnauthorizedResult();
+            }
+
+            if (!CryptographicOperations.FixedTimeEquals(
+                    Encoding.UTF8.GetBytes(providedKey.FirstOrDefault() ?? string.Empty),
+                    Encoding.UTF8.GetBytes(_syncTriggerKey)))
+            {
+                return new UnauthorizedResult();
+            }
+
             var appClient = new GitHubClient(new ProductHeaderValue(Constants.UserAgent), new GitHubAppCredentialStore(long.Parse(_appId), _privateKeyPem));;
             var installations = await appClient.GitHubApps.GetAllInstallationsForCurrent();
 

Web/Program.cs

@@ -18,6 +18,11 @@
 Web.Helpers.Constants.ExtensionAttributeName = builder.Configuration["AzureAd:ExtensionAttributeName"];
 Web.Helpers.Constants.ExemptUsers = builder.Configuration.GetSection("ExemptUsers").Get<string[]>();
 
+if (string.IsNullOrWhiteSpace(builder.Configuration["SyncTriggerKey"]))
+{
+    Console.WriteLine("WARNING: SyncTriggerKey is not configured. The /api/sync endpoint will be unavailable.");
+}
+
 // Add services to the container.
 builder.Services.AddRazorPages();
 builder.Services.AddControllers();