Added support for Azure Key Vault in Umbraco 7, based on #182

Rachel Breeze · Rachel Breeze · commit dc725bebc0b0 · 2021-04-05T15:15:29.000+01:00
diff --git a/README.md b/README.md
@@ -138,6 +138,18 @@ In `Web.config` create the new application keys and post fix each key with the `
 <add key="AzureBlobFileSystem.UsePrivateContainer:media" value="false" />
 ```
 
+#### Configuration for Azure Key Vault
+For Azure Key Vault only the key values in the `Web.config` should use '-', rather than a '.' or ':' as shown below
+
+```xml
+<add key="AzureBlobFileSystem-ConnectionString-media" value="DefaultEndpointsProtocol=https;AccountName=[myAccountName];AccountKey=[myAccountKey]" />
+<add key="AzureBlobFileSystem-ContainerName-media" value="media" />
+<add key="AzureBlobFileSystem-RootUrl-media" value="https://[myAccountName].blob.core.windows.net/" />
+<add key="AzureBlobFileSystem-MaxDays-media" value="365" />
+<add key="AzureBlobFileSystem-UseDefaultRoute-media" value="true" />
+<add key="AzureBlobFileSystem-UsePrivateContainer-media" value="false" />
+```
+
 ## Virtual Path Provider
 By default the plugin will serve files transparently from your domain or serve media directly from Azure. This is made possible by using a custom [Virtual Path Provider](https://msdn.microsoft.com/en-us/library/system.web.hosting.virtualpathprovider%28v=vs.110%29.aspx) included and automatically initialised upon application startup. This can be disable by adding the configuration setting noted above.
 
diff --git a/src/UmbracoFileSystemProviders.Azure.Installer/InstallerController.cs b/src/UmbracoFileSystemProviders.Azure.Installer/InstallerController.cs
@@ -3,6 +3,8 @@
 // Licensed under the Apache License, Version 2.0.
 // </copyright>
 
+using Our.Umbraco.FileSystemProviders.Azure.Helpers;
+
 namespace Our.Umbraco.FileSystemProviders.Azure.Installer
 {
     using System;
@@ -447,8 +449,8 @@ private static bool ExecuteImageProcessorWebConfigTransform()
 
         private static bool TestAzureCredentials(string connectionString, string containerName)
         {
-            bool useEmulator = ConfigurationManager.AppSettings[Azure.Constants.Configuration.UseStorageEmulatorKey] != null
-                               && ConfigurationManager.AppSettings[Azure.Constants.Configuration.UseStorageEmulatorKey]
+            bool useEmulator = ConfigurationHelper.GetAppSetting(Azure.Constants.Configuration.UseStorageEmulatorKey) != null
+                               && ConfigurationHelper.GetAppSetting(Azure.Constants.Configuration.UseStorageEmulatorKey)
                                                       .Equals("true", StringComparison.InvariantCultureIgnoreCase);
             try
             {
diff --git a/src/UmbracoFileSystemProviders.Azure/AzureBlobFileSystem.cs b/src/UmbracoFileSystemProviders.Azure/AzureBlobFileSystem.cs
@@ -3,6 +3,8 @@
 // Licensed under the Apache License, Version 2.0.
 // </copyright>
 
+using Our.Umbraco.FileSystemProviders.Azure.Helpers;
+
 namespace Our.Umbraco.FileSystemProviders.Azure
 {
     using System;
@@ -104,34 +106,34 @@ public AzureBlobFileSystem(string containerName, string rootUrl, string connecti
         /// <param name="alias">The alias of the provider</param>
         public AzureBlobFileSystem(string alias)
         {
-            string connectionString = ConfigurationManager.AppSettings[$"{ConnectionStringKey}:{alias}"];
+            string connectionString = ConfigurationHelper.GetAppSetting($"{ConnectionStringKey}:{alias}");
             if (!string.IsNullOrWhiteSpace(connectionString))
             {
-                string rootUrl = ConfigurationManager.AppSettings[$"{RootUrlKey}:{alias}"];
+                string rootUrl = ConfigurationHelper.GetAppSetting($"{RootUrlKey}:{alias}");
                 if (string.IsNullOrWhiteSpace(rootUrl))
                 {
                     throw new InvalidOperationException("Azure Storage Root URL is not defined in application settings. The " + RootUrlKey + " property was not defined or is empty.");
                 }
 
-                string containerName = ConfigurationManager.AppSettings[$"{ContainerNameKey}:{alias}"];
+                string containerName = ConfigurationHelper.GetAppSetting($"{ContainerNameKey}:{alias}");
                 if (string.IsNullOrWhiteSpace(containerName))
                 {
                     containerName = "media";
                 }
 
-                string maxDays = ConfigurationManager.AppSettings[$"{MaxDaysKey}:{alias}"];
+                string maxDays = ConfigurationHelper.GetAppSetting($"{MaxDaysKey}:{alias}");
                 if (string.IsNullOrWhiteSpace(maxDays))
                 {
                     maxDays = "365";
                 }
 
-                string useDefaultRoute = ConfigurationManager.AppSettings[$"{UseDefaultRootKey}:{alias}"];
+                string useDefaultRoute = ConfigurationHelper.GetAppSetting($"{UseDefaultRootKey}:{alias}");
                 if (string.IsNullOrWhiteSpace(useDefaultRoute))
                 {
                     useDefaultRoute = "true";
                 }
 
-                string accessType = ConfigurationManager.AppSettings[$"{UsePrivateContainerKey}:{alias}"];
+                string accessType = ConfigurationHelper.GetAppSetting($"{UsePrivateContainerKey}:{alias}");
                 if (string.IsNullOrWhiteSpace(accessType))
                 {
                     accessType = "true";
diff --git a/src/UmbracoFileSystemProviders.Azure/AzureFileSystem.cs b/src/UmbracoFileSystemProviders.Azure/AzureFileSystem.cs
@@ -6,6 +6,9 @@
 // <summary>
 // A singleton class for communicating with Azure Blob Storage.
 // </summary>
+
+using Our.Umbraco.FileSystemProviders.Azure.Helpers;
+
 namespace Our.Umbraco.FileSystemProviders.Azure
 {
     using System;
@@ -93,12 +96,12 @@ internal AzureFileSystem(string containerName, string rootUrl, string connection
                 throw new ArgumentNullException(nameof(containerName));
             }
 
-            this.DisableVirtualPathProvider = ConfigurationManager.AppSettings[DisableVirtualPathProviderKey] != null
-                                              && ConfigurationManager.AppSettings[DisableVirtualPathProviderKey]
+            this.DisableVirtualPathProvider = ConfigurationHelper.GetAppSetting(DisableVirtualPathProviderKey) != null
+                                              && ConfigurationHelper.GetAppSetting(DisableVirtualPathProviderKey)
                                              .Equals("true", StringComparison.InvariantCultureIgnoreCase);
 
-            bool useEmulator = ConfigurationManager.AppSettings[UseStorageEmulatorKey] != null
-                               && ConfigurationManager.AppSettings[UseStorageEmulatorKey]
+            bool useEmulator = ConfigurationHelper.GetAppSetting(UseStorageEmulatorKey) != null
+                               && ConfigurationHelper.GetAppSetting(UseStorageEmulatorKey)
                                                       .Equals("true", StringComparison.InvariantCultureIgnoreCase);
 
             CloudStorageAccount cloudStorageAccount;
diff --git a/src/UmbracoFileSystemProviders.Azure/Helpers/ConfigurationHelper.cs b/src/UmbracoFileSystemProviders.Azure/Helpers/ConfigurationHelper.cs
@@ -0,0 +1,36 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Configuration;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Our.Umbraco.FileSystemProviders.Azure.Helpers
+{
+    public static class ConfigurationHelper
+    {
+        public static string GetAppSetting(string key)
+        {
+            var settings = ConfigurationManager.AppSettings[key];
+
+            if (!string.IsNullOrEmpty(settings))
+            {
+                return settings;
+            }
+
+            return ConfigurationManager.AppSettings[key.Replace(".", "-")];
+        }
+
+        public static string GetAppSetting(string key, string providerAlias)
+        {
+            var settings = ConfigurationManager.AppSettings[$"{key}:{providerAlias}"];
+
+            if (!string.IsNullOrEmpty(settings))
+            {
+                return settings;
+            }
+
+            return ConfigurationManager.AppSettings[$"{key.Replace(".", "-")}-{providerAlias}"];
+        }
+    }
+}
diff --git a/src/UmbracoFileSystemProviders.Azure/UmbracoFileSystemProviders.Azure.csproj b/src/UmbracoFileSystemProviders.Azure/UmbracoFileSystemProviders.Azure.csproj
@@ -265,6 +265,7 @@
     <Compile Include="AzureBlobFileSystem.cs" />
     <Compile Include="AzureFileSystem.cs" />
     <Compile Include="Constants.cs" />
+    <Compile Include="Helpers\ConfigurationHelper.cs" />
     <Compile Include="Helpers\IMimeTypeResolver.cs" />
     <Compile Include="Helpers\MimeTypeResolver.cs" />
     <Compile Include="Helpers\WrappedLogHelper.cs" />
diff --git a/src/UmbracoFileSystemProviders.Azure/VirtualPathProviderController.cs b/src/UmbracoFileSystemProviders.Azure/VirtualPathProviderController.cs
@@ -3,6 +3,8 @@
 // Licensed under the Apache License, Version 2.0.
 // </copyright>
 
+using Our.Umbraco.FileSystemProviders.Azure.Helpers;
+
 namespace Our.Umbraco.FileSystemProviders.Azure
 {
     using System;
@@ -29,8 +31,8 @@ public class VirtualPathProviderController : ApplicationEventHandler
         /// <param name="applicationContext">The Umbraco <see cref="ApplicationContext"/> for the current application.</param>
         protected override void ApplicationStarting(UmbracoApplicationBase umbracoApplication, ApplicationContext applicationContext)
         {
-            bool disable = ConfigurationManager.AppSettings[DisableVirtualPathProviderKey] != null
-                           && ConfigurationManager.AppSettings[DisableVirtualPathProviderKey]
+            bool disable = ConfigurationHelper.GetAppSetting(DisableVirtualPathProviderKey) != null
+                           && ConfigurationHelper.GetAppSetting(DisableVirtualPathProviderKey)
                                                   .Equals("true", StringComparison.InvariantCultureIgnoreCase);
 
             IFileSystem fileSystem = FileSystemProviderManager.Current.GetUnderlyingFileSystemProvider(Constants.DefaultMediaRoute);

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,8 @@`
`3`	`3`	`// Licensed under the Apache License, Version 2.0.`
`4`	`4`	`// </copyright>`
`5`	`5`
	`6`	`+using Our.Umbraco.FileSystemProviders.Azure.Helpers;`
	`7`	`+`
`6`	`8`	`namespace Our.Umbraco.FileSystemProviders.Azure.Installer`
`7`	`9`	`{`
`8`	`10`	`using System;`
`@@ -447,8 +449,8 @@ private static bool ExecuteImageProcessorWebConfigTransform()`
`447`	`449`
`448`	`450`	`private static bool TestAzureCredentials(string connectionString, string containerName)`
`449`	`451`	`{`
`450`		`- bool useEmulator = ConfigurationManager.AppSettings[Azure.Constants.Configuration.UseStorageEmulatorKey] != null`
`451`		`- && ConfigurationManager.AppSettings[Azure.Constants.Configuration.UseStorageEmulatorKey]`
	`452`	`+ bool useEmulator = ConfigurationHelper.GetAppSetting(Azure.Constants.Configuration.UseStorageEmulatorKey) != null`
	`453`	`+ && ConfigurationHelper.GetAppSetting(Azure.Constants.Configuration.UseStorageEmulatorKey)`
`452`	`454`	`.Equals("true", StringComparison.InvariantCultureIgnoreCase);`
`453`	`455`	`try`
`454`	`456`	`{`