Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matteofabbri/aspnetcore.identity.mongo
This is a MongoDB provider for the ASP.NET Core 2 Identity framework
https://github.com/matteofabbri/aspnetcore.identity.mongo
asp-net-core aspnetcore aspnetcore2 identity identity-management identity-provider mongo mongo-database mongodb role role-management user user-management user-storage user-store
Last synced: about 1 month ago
JSON representation
This is a MongoDB provider for the ASP.NET Core 2 Identity framework
- Host: GitHub
- URL: https://github.com/matteofabbri/aspnetcore.identity.mongo
- Owner: matteofabbri
- License: mit
- Created: 2018-02-14T17:41:23.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-03T23:52:40.000Z (over 1 year ago)
- Last Synced: 2023-08-29T03:19:30.476Z (about 1 year ago)
- Topics: asp-net-core, aspnetcore, aspnetcore2, identity, identity-management, identity-provider, mongo, mongo-database, mongodb, role, role-management, user, user-management, user-storage, user-store
- Language: C#
- Homepage: https://matteofabbri.org
- Size: 23.3 MB
- Stars: 284
- Watchers: 21
- Forks: 78
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# AspNetCore.Identity.Mongo [](https://www.nuget.org/packages/AspNetCore.Identity.Mongo/)
This is a MongoDB provider for the ASP.NET Core Identity framework. It is completely written from scratch and provides support for all Identity framework interfaces:
* IUserClaimStore
* IUserLoginStore
* IUserRoleStore
* IUserPasswordStore
* IUserSecurityStampStore
* IUserEmailStore
* IUserPhoneNumberStore
* IQueryableUserStore
* IUserTwoFactorStore
* IUserLockoutStore
* IUserAuthenticatorKeyStore
* IUserAuthenticationTokenStore
* IUserTwoFactorRecoveryCodeStore
* IProtectedUserStore
* IRoleStore
* IRoleClaimStore
* IQueryableRoleStore
## Dotnet Versions support
Starting from `v9.0.0` library only supports **.Net 6.0** and **.Net 8.0** as they are
only versions maintainable by Microsoft at the moment. [Supported Dotnet Versions](https://dotnet.microsoft.com/en-us/download/dotnet)
Library supports **.Net 6.0**, **.Net 5.0**, **.Net Core 3.1**, **.Net Core 2.1**
simultaneously started from 8.3.0 nuget package.
## MongoDB Indexes
**Important note!**
Starting from `v9.0.0` we no longer apply indexes on `"Users"` collection. Main reason for this change that
you are unable to change default indexes. If you delete index, it will appear again;
if you delete index and re-create it with different options, application won't start due to error.
You most likely have other indexes of your own, and now you have 2 places where they managed.
So it's up to user to decide which indexes should be used (if any), how and where manage them.
Here the old indexes in case someone needs them (collection name could be different):
```
db.Users.createIndex({ "NormalizedEmail" : 1 })
db.Users.createIndex({ "NormalizedUserName" : 1 })
```
## How to use:
AspNetCore.Identity.Mongo is installed from NuGet:
```
Install-Package AspNetCore.Identity.Mongo
```
The simplest way to set up:
```csharp
using AspNetCore.Identity.Mongo;
using AspNetCore.Identity.Mongo.Model;
// At the ConfigureServices section in Startup.cs
services.AddIdentityMongoDbProvider();
```
With Identity and Mongo options:
```csharp
using AspNetCore.Identity.Mongo;
using AspNetCore.Identity.Mongo.Model;
// At the ConfigureServices section in Startup.cs
services.AddIdentityMongoDbProvider(identity =>
{
identity.Password.RequiredLength = 8;
// other options
} ,
mongo =>
{
mongo.ConnectionString = "mongodb://127.0.0.1:27017/identity";
// other options
});
```
Using User and Role models:
```csharp
using AspNetCore.Identity.Mongo;
using AspNetCore.Identity.Mongo.Model;
// At the ConfigureServices section in Startup.cs
services.AddIdentityMongoDbProvider(identity =>
{
identity.Password.RequiredLength = 8;
// other options
},
mongo =>
{
mongo.ConnectionString = "mongodb://127.0.0.1:27017/identity";
// other options
});
```
Using different type of the primary key (default is `MongoDB.Bson.ObjectId`):
```csharp
using AspNetCore.Identity.Mongo;
using AspNetCore.Identity.Mongo.Model;
public class ApplicationUser : MongoUser
{
}
public class ApplicationRole : MongoRole
{
}
// At the ConfigureServices section in Startup.cs
services.AddIdentityMongoDbProvider(identity =>
{
identity.Password.RequiredLength = 8;
// other options
},
mongo =>
{
mongo.ConnectionString = "mongodb://127.0.0.1:27017/identity";
// other options
});
```
To add the stores only, use:
```csharp
using AspNetCore.Identity.Mongo;
using AspNetCore.Identity.Mongo.Model;
// At the ConfigureServices section in Startup.cs
services
.AddIdentityCore()
.AddRoles()
.AddMongoDbStores(mongo =>
{
mongo.ConnectionString = "mongodb://127.0.0.1:27017/identity";
// other options
})
.AddDefaultTokenProviders();
```
## Migration from lower versions
New releases could/will have the breaking changes.
Folder [docs](./docs) contains migration guides. E.g.:
[There](./docs/MigrationGuideToVersion6_7_0AndUpper.md) you can find information how to migrate from 6.0.0-6.3.5 to 6.7.x version.
[There](./docs/MigrationGuideFromVersion3_1_5ToVersion6_7_0AndUpper.md) you can find information how to migrate from 3.1.5 to 6.7.x version.
If you have different version of the library and want to update it, please create a new issue. We will try to help you or will create new instruction.
## How to Contribute
Before create any issue/PR please look at the [CONTRIBUTING](./CONTRIBUTING.md)
## Code of conduct
See [CODE_OF_CONDUCT](./CODE_OF_CONDUCT.md)
## License
This project is licensed under the [MIT license](./blob/master/LICENSE.txt)