Skip to content

Latest commit

 

History

History
79 lines (66 loc) · 5.08 KB

README.md

File metadata and controls

79 lines (66 loc) · 5.08 KB
Raw

A custom user store for ASP .NET Core Identity built in C#. Designed to allow ASP .NET Core Identity to store user and role data in AWS DynamoDB rather than Microsoft SQL Server etc.

It's designed to be as simple as possible, but it does implement all of the user and role interfaces, except for the IQueryableUserStore. It's fully tested with with XUnit tests and licensed under the MIT license

Getting Setup

DynamoDB Tables

You need to have at least one DynamoDB table set up to store users. If you want to use roles, you'll need one for that also. The tables need to have a string type partition key called Id. This project doesn't use secondary indexes at the moment.

Project Setup

I'm going to assume you're using a freshly bootstrapped ASP .NET Core MVC project with authentication enabled and the options for individual user accounts stored in app are enabled. All this work has already been done in the sample. Feel free to submit an issue if you have problems.

  1. Remove the NuGet packages below from the project:
    • Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore
    • Microsoft.AspNetCore.Identity.EntityFrameworkCore
    • Microsoft.EntityFrameworkCore.SqlServer
    • Microsoft.EntityFrameworkCore.Tools
  2. Delete the Data folder in the project root
  3. Install the package into your ASP .NET Core project from NuGet (Package ID will be ara225.DynamoDBUserStore)
  4. Replace the line using Microsoft.EntityFrameworkCore; in Startup.cs with using ara225.DynamoDBUserStore;
  5. Remove the using statement for the Data folder from Startup.cs
  6. In ConfigureServices in Startup.cs, remove the following code:
services.AddDbContext<ApplicationDbContext>(options =>
    options.UseSqlServer(
        Configuration.GetConnectionString("DefaultConnection")));
services.AddDefaultIdentity<IdentityUser>(options => options.SignIn.RequireConfirmedAccount = true)
    .AddEntityFrameworkStores<ApplicationDbContext>();
  1. In ConfigureServices in Startup.cs, add a singleton to the services collection containing a DynamoDBDataAccessLayer (a class from ara225.DynamoDBUserStore). You need to pass three arguments into it: an AmazonDynamoDBClient (you can pass a AmazonDynamoDBConfig to this to configure it), a string containing the name of the DyanmoDB table for user storage and a string with the name of the roles table (you can put a null or any string if not using Roles).

To use a local DynamoDB in Docker

services.AddSingleton<DynamoDBDataAccessLayer>(x => new DynamoDBDataAccessLayer(new AmazonDynamoDBClient(new AmazonDynamoDBConfig { ServiceURL = "http://localhost:8000" }), "UserStoreTable", "RoleStoreTable"));

To use with DynamoDB in the cloud

services.AddSingleton<DynamoDBDataAccessLayer>(x => new DynamoDBDataAccessLayer(new Amazon.DynamoDBv2.AmazonDynamoDBClient(), "UserStoreTable", "RoleStoreTable"));
  1. Add the user store and role store in ConfigureServices in Startup.cs.The options you set in the function passed to AddDefaultIdentity don't really matter for this purpose.

Use this code to add both user and role stores to Identity:

services.AddDefaultIdentity<DynamoDBUser>(options => options.SignIn.RequireConfirmedAccount = true)
    .AddUserStore<DynamoDBUserStore<DynamoDBUser>>()
    .AddRoles<DynamoDBRole>()
    .AddRoleStore<DynamoDBRoleStore<DynamoDBRole>>();

Use this code to add just a user store to Identity:

services.AddDefaultIdentity<DynamoDBUser>(options => options.SignIn.RequireConfirmedAccount = true)
    .AddUserStore<DynamoDBUserStore<DynamoDBUser>>();
  1. Remove app.UseDatabaseErrorPage(); from Startup.cs
  2. Change the user type in _LoginPartial.cshtml (found in Views/Shared) Replace
@inject SignInManager<IdentityUser> SignInManager
@inject UserManager<IdentityUser> UserManager

with

@using ara225.DynamoDBUserStore
@inject SignInManager<DynamoDBUser> SignInManager
@inject UserManager<DynamoDBUser> UserManager

Running the Sample

I've included a sample ASP .NET Core app in this repo. It's basically just a plain old ASP .Net Core MVC template with this user store instead of the default. It's configured to connect to a DynamoDB running in Docker, though you can change this behavior by setting the environment variable CONNECT_TO_CLOUD_DB to anything. I wrote about setting up a local DynamoDB on dev.to here It creates a test user and a test role on startup.

Aside from that setup, it's just a normal ASP .NET Core app.

Running the Tests

This project uses tests based on the Microsoft tests for Identity found here. These have an Apache 2.0 license. They're configured to connect to a DynamoDB running in Docker, though you can change this behavior by setting the environment variable CONNECT_TO_CLOUD_DB to anything.

Future Plans

This project is fairly complete, and I'm pretty sure it's bug free so there's not much to do. I could implement IQueryableUserStore, but I don't really think it's worth the effort.