NexumNovus.AppSettings.MsSql 0.1.4

NexumNovus.AppSettings.MsSql

This package enables you to load and persist settings into MsSql database, and encrypt/decrypt settings marked with SecretSetting attribute.

About

MsSql configuration provider implementation for Microsoft.Extensions.Configuration. This package enables you to

• read application settings from MsSql database.
• update application settings and save changes to MsSql database.
• cryptographically protect selected application settings

Use MsSqlHostBuilderExtensions.AddMsSqlConfig extension method on IHostBuilder to add the MsSql configuration provider to the configuration builder and register MsSqlSettingsRepository with service collection.

Use ISettingsRepository.UpdateSettingsAsync to update MsSql settings.

Mark properties with SecretSetting attribute to cryptographically protect them.

Example

using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Options;
using NexumNovus.AppSettings.Common;
using NexumNovus.AppSettings.Common.Secure;
using NexumNovus.AppSettings.MsSql;

var builder = WebApplication.CreateBuilder(args);

// Load settings from MsSql database and register settings repository with service collection
builder.Host.AddMsSqlConfig("Data Source=.;Initial Catalog=NexumNovus;Integrated Security=true;");

// Use of options pattern to register configuration elements is optional.
builder.Services.AddOptions<EmailSettings>().BindConfiguration(EmailSettings.ConfigElement);

var app = builder.Build();

// Api's to get and update EmailSettings
app.MapGet("/emailSettings", (IOptionsMonitor<EmailSettings> emailSettings) => emailSettings.CurrentValue);
app.MapPost("/emailSettings", async (EmailSettings emailSettings, ISettingsRepository settingsRepo)
  => await settingsRepo.UpdateSettingsAsync(EmailSettings.ConfigElement, emailSettings)
);

// Api's to get and update a setting
app.MapGet("/settings", (string section, IConfiguration settings) => settings.GetSection(section));
app.MapPost("/settings", async (string section, string value, ISettingsRepository settingsRepo)
  => await settingsRepo.UpdateSettingsAsync(section, value)
);

app.Run();

public record EmailSettings
{
  public static string ConfigElement = "Email";
  public string Host { get; set; }
  public string Username { get; set; }
  [SecretSetting]
  public string Password { get; set; } //this setting will be cryptographically protected
} 

If a setting is not found in the database, then it's created.

Note that password is marked with [SecretSetting] and it will be protected. After update MsSql database will have a table __AppSettings with data:

Default implementation for ISecretProtector uses Microsoft.AspNetCore.DataProtection. You can also provide your own implementation.

By default settings are reloaded if updated using ISettingsRepository. If you need to reload them on external database changes set CheckForChangesPeriod to a timespan value larger that zero.

builder.Host.AddMsSqlConfig(x =>
{
  x.ConnectionString = "Data Source=.;Initial Catalog=NexumNovus;Integrated Security=true;",
  x.TableName = "MyCustomNameForAppSettingsTable",
  x.CheckForChangesPeriod = TimeSpan.FromSeconds(60),
  x.Protector = <your implementation of ISecretProtector>
});