Secrets module (Lombiq Technologies: OCORE-124)

OrchardCore.sln

@@ -505,7 +505,13 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Sms.Abstraction
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Sms", "src\OrchardCore.Modules\OrchardCore.Sms\OrchardCore.Sms.csproj", "{CBF6DB53-FD0C-47F8-9E60-A1D247ACFD05}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OrchardCore.Sms.Core", "src\OrchardCore\OrchardCore.Sms.Core\OrchardCore.Sms.Core.csproj", "{20356393-B16D-466C-8203-877A534E287D}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Sms.Core", "src\OrchardCore\OrchardCore.Sms.Core\OrchardCore.Sms.Core.csproj", "{20356393-B16D-466C-8203-877A534E287D}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Secrets.Abstractions", "src\OrchardCore\OrchardCore.Secrets.Abstractions\OrchardCore.Secrets.Abstractions.csproj", "{E19C8D65-7C32-43FA-BB3D-41F12EB4259D}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Secrets", "src\OrchardCore.Modules\OrchardCore.Secrets\OrchardCore.Secrets.csproj", "{7DC59AC8-E9EE-4015-AA63-8E18DB4AD88F}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Secrets.Azure", "src\OrchardCore.Modules\OrchardCore.Secrets.KeyVault\OrchardCore.Secrets.Azure.csproj", "{854511CE-6DC6-4AE1-A135-B21A94D7E784}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -1335,6 +1341,18 @@ Global
 		{20356393-B16D-466C-8203-877A534E287D}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{20356393-B16D-466C-8203-877A534E287D}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{20356393-B16D-466C-8203-877A534E287D}.Release|Any CPU.Build.0 = Release|Any CPU
+		{E19C8D65-7C32-43FA-BB3D-41F12EB4259D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{E19C8D65-7C32-43FA-BB3D-41F12EB4259D}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{E19C8D65-7C32-43FA-BB3D-41F12EB4259D}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{E19C8D65-7C32-43FA-BB3D-41F12EB4259D}.Release|Any CPU.Build.0 = Release|Any CPU
+		{7DC59AC8-E9EE-4015-AA63-8E18DB4AD88F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{7DC59AC8-E9EE-4015-AA63-8E18DB4AD88F}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{7DC59AC8-E9EE-4015-AA63-8E18DB4AD88F}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{7DC59AC8-E9EE-4015-AA63-8E18DB4AD88F}.Release|Any CPU.Build.0 = Release|Any CPU
+		{854511CE-6DC6-4AE1-A135-B21A94D7E784}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{854511CE-6DC6-4AE1-A135-B21A94D7E784}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{854511CE-6DC6-4AE1-A135-B21A94D7E784}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{854511CE-6DC6-4AE1-A135-B21A94D7E784}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -1566,6 +1584,9 @@ Global
 		{2D93F509-1FB3-4E22-92F0-588D0EFBA921} = {F23AC6C2-DE44-4699-999D-3C478EF3D691}
 		{CBF6DB53-FD0C-47F8-9E60-A1D247ACFD05} = {A066395F-6F73-45DC-B5A6-B4E306110DCE}
 		{20356393-B16D-466C-8203-877A534E287D} = {F23AC6C2-DE44-4699-999D-3C478EF3D691}
+		{E19C8D65-7C32-43FA-BB3D-41F12EB4259D} = {F23AC6C2-DE44-4699-999D-3C478EF3D691}
+		{7DC59AC8-E9EE-4015-AA63-8E18DB4AD88F} = {A066395F-6F73-45DC-B5A6-B4E306110DCE}
+		{854511CE-6DC6-4AE1-A135-B21A94D7E784} = {A066395F-6F73-45DC-B5A6-B4E306110DCE}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {46A1D25A-78D1-4476-9CBF-25B75E296341}

src/OrchardCore.Build/Dependencies.props

@@ -15,6 +15,7 @@
     <PackageManagement Include="Azure.Extensions.AspNetCore.Configuration.Secrets" Version="1.3.0" />
     <PackageManagement Include="Azure.Extensions.AspNetCore.DataProtection.Blobs" Version="1.3.2" />
     <PackageManagement Include="Azure.Identity" Version="1.10.4" />
+    <PackageManagement Include="Azure.Security.KeyVault.Secrets" Version="4.1.0" />
     <PackageManagement Include="Azure.Storage.Blobs" Version="12.19.1" />
     <PackageManagement Include="BenchmarkDotNet" Version="0.13.10" />
     <PackageManagement Include="Castle.Core" Version="5.1.1" />

src/OrchardCore.Cms.Web/appsettings.json

@@ -255,6 +255,19 @@
     //},
     //"OrchardCore_Tenants": {
     //  "TenantRemovalAllowed": true // Whether tenant removal is allowed, false by default.
-    //}
+    //},
+    //"OrchardCore_Secrets": {
+    //  "Secrets": {
+    //    "configuredRsaSecret1": {
+    //      "PublicKey": "...",
+    //      "PrivateKey": "...",
+    //      "KeyType": "PublicPrivatePair"
+    //    }
+    //  },
+    //  "KeyVault": {
+    //    "KeyVaultName": "",
+    //    "Prefix": ""
+    //  }
+    //},
   }
 }

src/OrchardCore.Modules/OrchardCore.AdminMenu/Controllers/MenuController.cs

@@ -72,7 +72,7 @@ public async Task<IActionResult> List(ContentOptions options, PagerParameters pa
             var pageSize = pager.PageSize;
             IEnumerable<Models.AdminMenu> results = new List<Models.AdminMenu>();
 
-            //todo: handle the case where there is a deserialization exception on some of the presets.
+            // Todo: handle the case where there is a deserialization exception on some of the presets.
             // load at least the ones without error. Provide a way to delete the ones on error.
             try
             {

src/OrchardCore.Modules/OrchardCore.Deployment.Remote/Controllers/ExportRemoteInstanceController.cs

@@ -1,6 +1,7 @@
 using System;
 using System.IO;
 using System.IO.Compression;
+using System.Net;
 using System.Net.Http;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Authorization;
@@ -14,6 +15,8 @@
 using OrchardCore.DisplayManagement.Notify;
 using OrchardCore.Mvc.Utilities;
 using OrchardCore.Recipes.Models;
+using OrchardCore.Secrets;
+using OrchardCore.Secrets.Models;
 using YesSql;
 
 namespace OrchardCore.Deployment.Remote.Controllers
@@ -27,6 +30,7 @@ public class ExportRemoteInstanceController : Controller
         private readonly IAuthorizationService _authorizationService;
         private readonly ISession _session;
         private readonly RemoteInstanceService _service;
+        private readonly ISecretService _secretService;
         private readonly INotifier _notifier;
         protected readonly IHtmlLocalizer H;
 
@@ -35,13 +39,15 @@ public ExportRemoteInstanceController(
             ISession session,
             RemoteInstanceService service,
             IDeploymentManager deploymentManager,
+            ISecretService secretService,
             INotifier notifier,
             IHtmlLocalizer<ExportRemoteInstanceController> localizer)
         {
             _authorizationService = authorizationService;
             _deploymentManager = deploymentManager;
             _session = session;
             _service = service;
+            _secretService = secretService;
             _notifier = notifier;
             H = localizer;
         }
@@ -75,7 +81,7 @@ public async Task<IActionResult> Execute(long id, string remoteInstanceId, strin
             {
                 archiveFileName = PathExtensions.Combine(Path.GetTempPath(), filename);
 
-                var deploymentPlanResult = new DeploymentPlanResult(fileBuilder, new RecipeDescriptor());
+                var deploymentPlanResult = new DeploymentPlanResult(fileBuilder, new RecipeDescriptor(), remoteInstance.RsaEncryptionSecret, remoteInstance.RsaSigningSecret);
                 await _deploymentManager.ExecuteDeploymentPlanAsync(deploymentPlan, deploymentPlanResult);
 
                 if (System.IO.File.Exists(archiveFileName))
@@ -93,17 +99,32 @@ public async Task<IActionResult> Execute(long id, string remoteInstanceId, strin
                 using (var requestContent = new MultipartFormDataContent())
                 {
                     requestContent.Add(new StreamContent(
-                        new FileStream(archiveFileName,
-                        FileMode.Open, FileAccess.Read, FileShare.ReadWrite, 1, FileOptions.Asynchronous | FileOptions.SequentialScan)
-                    ),
-                        nameof(ImportViewModel.Content), Path.GetFileName(archiveFileName));
+                        new FileStream(
+                            archiveFileName,
+                            FileMode.Open,
+                            FileAccess.Read,
+                            FileShare.ReadWrite,
+                            1,
+                            FileOptions.Asynchronous | FileOptions.SequentialScan)),
+                        nameof(ImportViewModel.Content),
+                        Path.GetFileName(archiveFileName));
+
                     requestContent.Add(new StringContent(remoteInstance.ClientName), nameof(ImportViewModel.ClientName));
-                    requestContent.Add(new StringContent(remoteInstance.ApiKey), nameof(ImportViewModel.ApiKey));
+
+                    if (!string.IsNullOrEmpty(remoteInstance.ApiKeySecret))
+                    {
+                        var secret = await _secretService.GetSecretAsync<TextSecret>(remoteInstance.ApiKeySecret);
+                        requestContent.Add(new StringContent(secret?.Text), nameof(ImportViewModel.ApiKey));
+                    }
+                    else
+                    {
+                        requestContent.Add(new StringContent(remoteInstance.ApiKey), nameof(ImportViewModel.ApiKey));
+                    }
 
                     response = await _httpClient.PostAsync(remoteInstance.Url, requestContent);
                 }
 
-                if (response.StatusCode == System.Net.HttpStatusCode.OK)
+                if (response.StatusCode == HttpStatusCode.OK)
                 {
                     await _notifier.SuccessAsync(H["Deployment executed successfully."]);
                 }

src/OrchardCore.Modules/OrchardCore.Deployment.Remote/Controllers/ImportRemoteInstanceController.cs

@@ -1,3 +1,4 @@
+using System;
 using System.IO;
 using System.IO.Compression;
 using System.Linq;
@@ -7,9 +8,12 @@
 using Microsoft.AspNetCore.DataProtection;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.FileProviders;
+using Microsoft.Extensions.Logging;
 using OrchardCore.Deployment.Remote.Services;
 using OrchardCore.Deployment.Remote.ViewModels;
 using OrchardCore.Deployment.Services;
+using OrchardCore.Secrets;
+using OrchardCore.Secrets.Models;
 
 namespace OrchardCore.Deployment.Remote.Controllers
 {
@@ -18,15 +22,21 @@ public class ImportRemoteInstanceController : Controller
         private readonly RemoteClientService _remoteClientService;
         private readonly IDeploymentManager _deploymentManager;
         private readonly IDataProtector _dataProtector;
+        private readonly ISecretService _secretService;
+        private readonly ILogger _logger;
 
         public ImportRemoteInstanceController(
-            IDataProtectionProvider dataProtectionProvider,
             RemoteClientService remoteClientService,
-            IDeploymentManager deploymentManager)
+            IDeploymentManager deploymentManager,
+            IDataProtectionProvider dataProtectionProvider,
+            ISecretService secretService,
+            ILogger<ImportRemoteInstanceController> logger)
         {
-            _deploymentManager = deploymentManager;
             _remoteClientService = remoteClientService;
+            _deploymentManager = deploymentManager;
             _dataProtector = dataProtectionProvider.CreateProtector("OrchardCore.Deployment").ToTimeLimitedDataProtector();
+            _secretService = secretService;
+            _logger = logger;
         }
 
         /// <remarks>
@@ -40,13 +50,27 @@ public async Task<IActionResult> Import(ImportViewModel model)
             var remoteClientList = await _remoteClientService.GetRemoteClientListAsync();
 
             var remoteClient = remoteClientList.RemoteClients.FirstOrDefault(x => x.ClientName == model.ClientName);
-
             if (remoteClient == null)
             {
                 return StatusCode((int)HttpStatusCode.BadRequest, "The remote client was not provided");
             }
 
-            var apiKey = Encoding.UTF8.GetString(_dataProtector.Unprotect(remoteClient.ProtectedApiKey));
+            var apiKey = string.Empty;
+            if (!string.IsNullOrEmpty(remoteClient.ApiKeySecret))
+            {
+                apiKey = (await _secretService.GetSecretAsync<TextSecret>(remoteClient.ApiKeySecret))?.Text;
+            }
+            else
+            {
+                try
+                {
+                    apiKey = Encoding.UTF8.GetString(_dataProtector.Unprotect(remoteClient.ProtectedApiKey));
+                }
+                catch
+                {
+                    _logger.LogError("The Api Key could not be decrypted. It may have been encrypted using a different key.");
+                }
+            }
 
             if (model.ApiKey != apiKey || model.ClientName != remoteClient.ClientName)
             {

src/OrchardCore.Modules/OrchardCore.Deployment.Remote/Controllers/RemoteClientController.cs

@@ -86,11 +86,12 @@ public async Task<IActionResult> Index(ContentOptions options, PagerParameters p
             {
                 RemoteClients = remoteClients,
                 Pager = pagerShape,
-                Options = options
+                Options = options,
             };
 
-            model.Options.ContentsBulkAction = new List<SelectListItem>() {
-                new SelectListItem() { Text = S["Delete"], Value = nameof(ContentsBulkAction.Remove) }
+            model.Options.ContentsBulkAction = new List<SelectListItem>()
+            {
+                new() { Text = S["Delete"], Value = nameof(ContentsBulkAction.Remove) },
             };
 
             return View(model);
@@ -100,8 +101,9 @@ public async Task<IActionResult> Index(ContentOptions options, PagerParameters p
         [FormValueRequired("submit.Filter")]
         public ActionResult IndexFilterPOST(RemoteClientIndexViewModel model)
         {
-            return RedirectToAction("Index", new RouteValueDictionary {
-                { "Options.Search", model.Options.Search }
+            return RedirectToAction("Index", new RouteValueDictionary
+            {
+                { "Options.Search", model.Options.Search },
             });
         }
 
@@ -132,7 +134,7 @@ public async Task<IActionResult> Create(EditRemoteClientViewModel model)
 
             if (ModelState.IsValid)
             {
-                await _remoteClientService.CreateRemoteClientAsync(model.ClientName, model.ApiKey);
+                await _remoteClientService.CreateRemoteClientAsync(model.ClientName, model.ApiKey, model.ApiKeySecret);
 
                 await _notifier.SuccessAsync(H["Remote client created successfully."]);
                 return RedirectToAction(nameof(Index));
@@ -160,9 +162,14 @@ public async Task<IActionResult> Edit(string id)
             {
                 Id = remoteClient.Id,
                 ClientName = remoteClient.ClientName,
-                ApiKey = Encoding.UTF8.GetString(_dataProtector.Unprotect(remoteClient.ProtectedApiKey)),
+                ApiKeySecret = remoteClient.ApiKeySecret,
             };
 
+            if (remoteClient.ProtectedApiKey?.Length > 0)
+            {
+                model.ApiKey = Encoding.UTF8.GetString(_dataProtector.Unprotect(remoteClient.ProtectedApiKey));
+            }
+
             return View(model);
         }
 
@@ -188,7 +195,7 @@ public async Task<IActionResult> Edit(EditRemoteClientViewModel model)
 
             if (ModelState.IsValid)
             {
-                await _remoteClientService.TryUpdateRemoteClient(model.Id, model.ClientName, model.ApiKey);
+                await _remoteClientService.TryUpdateRemoteClient(model.Id, model.ClientName, model.ApiKey, model.ApiKeySecret);
 
                 await _notifier.SuccessAsync(H["Remote client updated successfully."]);
 
@@ -261,7 +268,7 @@ private void ValidateViewModel(EditRemoteClientViewModel model)
                 ModelState.AddModelError(nameof(EditRemoteClientViewModel.ClientName), S["The client name is mandatory."]);
             }
 
-            if (string.IsNullOrWhiteSpace(model.ApiKey))
+            if (string.IsNullOrWhiteSpace(model.ApiKey) && string.IsNullOrWhiteSpace(model.ApiKeySecret))
             {
                 ModelState.AddModelError(nameof(EditRemoteClientViewModel.ApiKey), S["The api key is mandatory."]);
             }

src/OrchardCore.Modules/OrchardCore.Deployment.Remote/Controllers/RemoteInstanceController.cs

@@ -79,11 +79,12 @@ public async Task<IActionResult> Index(ContentOptions options, PagerParameters p
             {
                 RemoteInstances = remoteInstances,
                 Pager = pagerShape,
-                Options = options
+                Options = options,
             };
 
-            model.Options.ContentsBulkAction = new List<SelectListItem>() {
-                new SelectListItem() { Text = S["Delete"], Value = nameof(ContentsBulkAction.Remove) }
+            model.Options.ContentsBulkAction = new List<SelectListItem>()
+            {
+                new() { Text = S["Delete"], Value = nameof(ContentsBulkAction.Remove) },
             };
 
             return View(model);
@@ -93,8 +94,9 @@ public async Task<IActionResult> Index(ContentOptions options, PagerParameters p
         [FormValueRequired("submit.Filter")]
         public ActionResult IndexFilterPOST(RemoteInstanceIndexViewModel model)
         {
-            return RedirectToAction(nameof(Index), new RouteValueDictionary {
-                { "Options.Search", model.Options.Search }
+            return RedirectToAction(nameof(Index), new RouteValueDictionary
+            {
+                { "Options.Search", model.Options.Search },
             });
         }
 
@@ -125,7 +127,7 @@ public async Task<IActionResult> Create(EditRemoteInstanceViewModel model)
 
             if (ModelState.IsValid)
             {
-                await _service.CreateRemoteInstanceAsync(model.Name, model.Url, model.ClientName, model.ApiKey);
+                await _service.CreateRemoteInstanceAsync(model.Name, model.Url, model.ClientName, model.ApiKey, model.ApiKeySecret, model.RsaEncryptionSecret, model.RsaSigningSecret);
 
                 await _notifier.SuccessAsync(H["Remote instance created successfully."]);
                 return RedirectToAction(nameof(Index));
@@ -155,7 +157,10 @@ public async Task<IActionResult> Edit(string id)
                 Name = remoteInstance.Name,
                 ClientName = remoteInstance.ClientName,
                 ApiKey = remoteInstance.ApiKey,
-                Url = remoteInstance.Url
+                ApiKeySecret = remoteInstance.ApiKeySecret,
+                Url = remoteInstance.Url,
+                RsaEncryptionSecret = remoteInstance.RsaEncryptionSecret,
+                RsaSigningSecret = remoteInstance.RsaSigningSecret,
             };
 
             return View(model);
@@ -183,7 +188,7 @@ public async Task<IActionResult> Edit(EditRemoteInstanceViewModel model)
 
             if (ModelState.IsValid)
             {
-                await _service.UpdateRemoteInstance(model.Id, model.Name, model.Url, model.ClientName, model.ApiKey);
+                await _service.UpdateRemoteInstance(model.Id, model.Name, model.Url, model.ClientName, model.ApiKey, model.ApiKeySecret, model.RsaEncryptionSecret, model.RsaSigningSecret);
 
                 await _notifier.SuccessAsync(H["Remote instance updated successfully."]);
 
@@ -261,7 +266,7 @@ private void ValidateViewModel(EditRemoteInstanceViewModel model)
                 ModelState.AddModelError(nameof(EditRemoteInstanceViewModel.ClientName), S["The client name is mandatory."]);
             }
 
-            if (string.IsNullOrWhiteSpace(model.ApiKey))
+            if (string.IsNullOrWhiteSpace(model.ApiKey) && string.IsNullOrWhiteSpace(model.ApiKeySecret))
             {
                 ModelState.AddModelError(nameof(EditRemoteInstanceViewModel.ApiKey), S["The api key is mandatory."]);
             }

src/OrchardCore.Modules/OrchardCore.Deployment.Remote/Models/RemoteClient.cs

@@ -5,5 +5,11 @@ public class RemoteClient
         public string Id { get; set; }
         public string ClientName { get; set; }
         public byte[] ProtectedApiKey { get; set; }
+
+        /// <summary>
+        /// The name of the api key secret that will be used to authenticate this remote client.
+        /// When a secret key is provided, it overrides the <see cref="ProtectedApiKey"/> value.
+        /// </summary>        
+        public string ApiKeySecret { get; set; }
     }
 }