feature: integrate ASP.NET Core Data Protection with Umbraco CMS

Author: jcdcdev

src/Umbraco.Community.DataProtection/Composing/Composer.cs

@@ -0,0 +1,12 @@
+using Umbraco.Cms.Core.Composing;
+using Umbraco.Cms.Core.DependencyInjection;
+
+namespace Umbraco.Community.DataProtection.Composing;
+
+public class Composer : IComposer
+{
+    public void Compose(IUmbracoBuilder builder)
+    {
+        builder.AddUmbracoDataProtection();
+    }
+}

src/Umbraco.Community.DataProtection/Composing/UmbracoBuilderExtensions.cs

@@ -0,0 +1,37 @@
+using Microsoft.AspNetCore.DataProtection;
+using Microsoft.AspNetCore.DataProtection.KeyManagement;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Options;
+using Umbraco.Cms.Core.DependencyInjection;
+using Umbraco.Community.DataProtection.Persistence;
+using Umbraco.Extensions;
+
+namespace Umbraco.Community.DataProtection.Composing;
+
+public static class UmbracoBuilderExtensions
+{
+    public static IDataProtectionBuilder AddUmbracoDataProtection(this IUmbracoBuilder builder, string? applicationDiscriminator = null, Action<KeyManagementOptions>? configureOptions = null)
+    {
+        builder.ManifestFilters().Append<ManifestFilter>();
+        builder.PackageMigrationPlans()!.Add<MigrationPlan>();
+        builder.Services.AddSingleton<UmbracoXmlRepository>();
+        builder.Services.AddSingleton<IConfigureOptions<KeyManagementOptions>>(services =>
+        {
+            var repository = services.GetRequiredService<UmbracoXmlRepository>();
+            return new ConfigureOptions<KeyManagementOptions>(options =>
+            {
+                options.XmlRepository = repository;
+                options.AutoGenerateKeys = true;
+                configureOptions?.Invoke(options);
+            });
+        });
+
+        return builder.Services.AddDataProtection(x =>
+        {
+            if (!applicationDiscriminator.IsNullOrWhiteSpace())
+            {
+                x.ApplicationDiscriminator = applicationDiscriminator;
+            }
+        });
+    }
+}

src/Umbraco.Community.DataProtection/Constants.cs

@@ -0,0 +1,12 @@
+namespace Umbraco.Community.DataProtection;
+
+public static class Constants
+{
+    public const string PackageId = "Umbraco.Community.DataProtection";
+    public const string PackageName = "Simple Data Protection";
+
+    public static class Tables
+    {
+        public const string DataProtectionKeys = "DataProtectionKeys";
+    }
+}

src/Umbraco.Community.DataProtection/Persistence/DataProtectionMigration.cs

@@ -0,0 +1,35 @@
+using Microsoft.Extensions.Options;
+using Umbraco.Cms.Core.Configuration.Models;
+using Umbraco.Cms.Core.IO;
+using Umbraco.Cms.Core.PropertyEditors;
+using Umbraco.Cms.Core.Services;
+using Umbraco.Cms.Core.Strings;
+using Umbraco.Cms.Infrastructure.Migrations;
+using Umbraco.Cms.Infrastructure.Packaging;
+using Umbraco.Community.DataProtection.Persistence.Models;
+
+namespace Umbraco.Community.DataProtection.Persistence;
+
+public class DataProtectionMigration : PackageMigrationBase
+{
+    public DataProtectionMigration(
+        IPackagingService packagingService,
+        IMediaService mediaService,
+        MediaFileManager mediaFileManager,
+        MediaUrlGeneratorCollection mediaUrlGenerators,
+        IShortStringHelper shortStringHelper,
+        IContentTypeBaseServiceProvider contentTypeBaseServiceProvider,
+        IMigrationContext context,
+        IOptions<PackageMigrationSettings> packageMigrationsSettings) : base(packagingService, mediaService, mediaFileManager, mediaUrlGenerators, shortStringHelper, contentTypeBaseServiceProvider,
+        context, packageMigrationsSettings)
+    {
+    }
+
+    protected override void Migrate()
+    {
+        if (!TableExists(Constants.Tables.DataProtectionKeys))
+        {
+            Create.Table<DataProtectionKey>().Do();
+        }
+    }
+}

src/Umbraco.Community.DataProtection/Persistence/MigrationPlan.cs

@@ -0,0 +1,15 @@
+using Umbraco.Cms.Core.Packaging;
+
+namespace Umbraco.Community.DataProtection.Persistence;
+
+public class MigrationPlan : PackageMigrationPlan
+{
+    public MigrationPlan() : base(Constants.PackageId)
+    {
+    }
+
+    protected override void DefinePlan()
+    {
+        To<DataProtectionMigration>(nameof(DataProtectionMigration));
+    }
+}

src/Umbraco.Community.DataProtection/Persistence/Models/DataProtectionKey.cs

@@ -0,0 +1,25 @@
+using NPoco;
+using Umbraco.Cms.Infrastructure.Persistence.DatabaseAnnotations;
+
+namespace Umbraco.Community.DataProtection.Persistence.Models;
+
+[TableName(Constants.Tables.DataProtectionKeys)]
+public class DataProtectionKey
+{
+    /// <summary>
+    ///     The entity identifier of the <see cref="DataProtectionKey" />.
+    /// </summary>
+    [PrimaryKeyColumn(AutoIncrement = true)]
+    public int Id { get; set; }
+
+    /// <summary>
+    ///     The friendly name of the <see cref="DataProtectionKey" />.
+    /// </summary>
+    public string? FriendlyName { get; set; }
+
+    /// <summary>
+    ///     The XML representation of the <see cref="DataProtectionKey" />.
+    /// </summary>
+    [SpecialDbType(SpecialDbTypes.NVARCHARMAX)]
+    public string? Xml { get; set; }
+}

src/Umbraco.Community.DataProtection/Persistence/UmbracoXmlRepository.cs

@@ -0,0 +1,57 @@
+using System.Xml.Linq;
+using Microsoft.AspNetCore.DataProtection.Repositories;
+using Microsoft.Extensions.Logging;
+using Umbraco.Cms.Infrastructure.Scoping;
+using Umbraco.Community.DataProtection.Persistence.Models;
+using Umbraco.Extensions;
+
+namespace Umbraco.Community.DataProtection.Persistence;
+
+public class UmbracoXmlRepository : IXmlRepository
+{
+    private readonly IScopeProvider _scopeProvider;
+    private readonly ILogger<UmbracoXmlRepository> _logger;
+
+    public UmbracoXmlRepository(IScopeProvider scopeProvider, ILogger<UmbracoXmlRepository> logger)
+    {
+        _scopeProvider = scopeProvider;
+        _logger = logger;
+    }
+
+    public IReadOnlyCollection<XElement> GetAllElements()
+    {
+        try
+        {
+            using var scope = _scopeProvider.CreateScope();
+            var sql = scope.SqlContext.Sql().SelectAll().From<DataProtectionKey>();
+            var results = scope.Database.Fetch<DataProtectionKey>(sql);
+            var output = results.Select(x => XElement.Parse(x.Xml!)).WhereNotNull().ToList().AsReadOnly();
+            scope.Complete();
+            return output;
+        }
+        catch (Exception ex)
+        {
+            _logger.LogError(ex, "Error getting all elements");
+            return Array.Empty<XElement>();
+        }
+    }
+
+    public void StoreElement(XElement element, string friendlyName)
+    {
+        try
+        {
+            using var scope = _scopeProvider.CreateScope(autoComplete: false);
+            var key = new DataProtectionKey
+            {
+                FriendlyName = friendlyName,
+                Xml = element.ToString(SaveOptions.DisableFormatting)
+            };
+            scope.Database.Save(key);
+            scope.Complete();
+        }
+        catch (Exception ex)
+        {
+            _logger.LogError(ex, "Error storing element");
+        }
+    }
+}

src/Umbraco.Community.DataProtection/Umbraco.Community.DataProtection.csproj

@@ -24,6 +24,12 @@
         <NuGetAuditLevel>high</NuGetAuditLevel>
         <RestorePackagesWithLockFile>true</RestorePackagesWithLockFile>
     </PropertyGroup>
+
+    <ItemGroup>
+        <FrameworkReference Include="Microsoft.AspNetCore.App"/>
+        <PackageReference Include="jcdcdev.Umbraco.Core" Version="0.3.1"/>
+    </ItemGroup>
+
     <ItemGroup Condition="'$(TargetFramework)' == 'net6.0'">
         <PackageReference Include="Umbraco.Cms.Core" Version="[10.4.0,11.0.0)"/>
         <PackageReference Include="Umbraco.Cms.Infrastructure" Version="[10.4.0,11.0.0)"/>