AspNetCore.DataProtection.MySql 1.1.0

dotnet add package AspNetCore.DataProtection.MySql --version 1.1.0                
NuGet\Install-Package AspNetCore.DataProtection.MySql -Version 1.1.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="AspNetCore.DataProtection.MySql" Version="1.1.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add AspNetCore.DataProtection.MySql --version 1.1.0                
#r "nuget: AspNetCore.DataProtection.MySql, 1.1.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install AspNetCore.DataProtection.MySql as a Cake Addin
#addin nuget:?package=AspNetCore.DataProtection.MySql&version=1.1.0

// Install AspNetCore.DataProtection.MySql as a Cake Tool
#tool nuget:?package=AspNetCore.DataProtection.MySql&version=1.1.0                

ASP.NET Core Data Protection for MySQL

Continuous integration License: MIT AspNetCore.DataProtection.MySql

An ASP.NET Core Data Protection provider for MySQL using MySqlConnector.

Getting Started

using AspNetCore.DataProtection.MySql;
using Microsoft.Extensions.DependencyInjection;

public void ConfigureServices(IServiceCollection services)
{
    services.AddDataProtection()
        .PersistKeysToMySql();
}

The schema for the DataProtectionKeys table is below. This table has to be created ahead of time as this library won't automatically create it. The table name can be changed (and supplied to the overloaded .PersistKeysToMySql() method) however the column names are expected to match the default schema.

CREATE TABLE DataProtectionKeys (
    Id BIGINT NOT NULL AUTO_INCREMENT,
    FriendlyName TEXT NULL,
    Xml TEXT NULL,

    PRIMARY KEY CLUSTERED (Id ASC)
) DEFAULT CHARSET=utf8
COMMENT = 'Cryptographic keys for the data protection system';

Note: See key storage providers in ASP.NET Core for other providers.

Configuration

The overload to .PersistKeysToMySql() accepts a parameter to customize behavior:

services.AddDataProtection()
    .PersistKeysToMySql(options =>
    {
        // Change the default table name to something else.
        options.TableName = "AlternateTableName";
    });

There are no options available to configure how it should connect to the database as it assumes that MySqlConnection has already been registered as a service dependency. As a result, it will request a MySqlConnector object from the service registry and run with it.

An example of how to register MySqlConnector as a service:

var connectionString = configuration.GetValue<string>("ConnectionStrings:ConnectionString");

services.AddTransient(container =>
{
    return new MySqlConnection(connectionString);
});

License

See LICENSE for more information.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.0 1,071 2/29/2024
1.0.3 462 9/13/2023