Identity.Module.API 2.5.55

.NET Modular Dynamic Identity Manager

A set of libraries to easily integrate and extend authentication in ASP.NET Core projects, using ASP.NET Core Identity.

🏷️ Description

MinimalApi.Identity is a dynamic and modular identity manager for managing users, roles, claims and more for access control in Asp.Net Mvc Core and Web API, using .NET 8 Minimal API, Entity Framework Core and relational database (of your choice).

🧩 Features

• Minimal API: Built using .NET 8 Minimal API for a lightweight and efficient implementation.
• Entity Framework Core: Uses EF Core for data access, making it easy to integrate with your existing database.
• Modular: The library is designed to be modular, allowing you to add or remove features as needed.
• Dynamic: Supports dynamic management of users, roles, claims, forms, licensing and policies.
• Flexible Configuration: Easily configurable via appsettings.json to suit your application's needs.
• Outbox Pattern: Implement the transactional outbox pattern for reliable email sending.

🛠️ Installation

Prerequisites

• .NET 8.0 SDK (latest version)
• SQL Server 2022 Express installed (setup for Windows) or in Docker version (example)

Setup

The library is available on NuGet, just search for Identity.Module.API in the Package Manager GUI or run the following command in the .NET CLI:

dotnet add package Identity.Module.API

⚙️ Configuration

The configuration can be completely managed by adding this section to the appsettings.json file:

"Kestrel": {
    "Limits": {
        "MaxRequestBodySize": 5242880
    }
},
"ConnectionStrings": {
    "DatabaseType": "sqlserver", // Options: "sqlserver"
    "SQLServer": "Data Source=[HOSTNAME];Initial Catalog=IdentityManager;User ID=[USERNAME];Password=[PASSWORD];Encrypt=False",
    "MigrationsAssembly": "MinimalApi.Identity.Migrations.SQLServer"
},
"JwtOptions": {
    "SchemaName": "Bearer",
    "Issuer": "[ISSUER]",
    "Audience": "[AUDIENCE]",
    "SecurityKey": "[SECURITY-KEY]", // Must be 512 characters long
    "ClockSkew": "00:05:00", // Default: 5 minutes
    "AccessTokenExpirationMinutes": 60, // 60 minutes
    "RefreshTokenExpirationMinutes": 60, // 60 minutes
    "RequireUniqueEmail": true,
    "RequireDigit": true,
    "RequiredLength": 8,
    "RequireUppercase": true,
    "RequireLowercase": true,
    "RequireNonAlphanumeric": true,
    "RequiredUniqueChars": 4,
    "RequireConfirmedEmail": true,
    "MaxFailedAccessAttempts": 3,
    "AllowedForNewUsers": true,
    "DefaultLockoutTimeSpan": "00:05:00" // 5 minutes
},
"SmtpOptions": {
    "Host": "smtp.example.org",
    "Port": 25,
    "Security": "StartTls",
    "Username": "Username del server SMTP",
    "Password": "Password del server SMTP",
    "Sender": "MyApplication <noreply@example.org>",
    "MaxRetryAttempts": 10
},
"ApplicationOptions": {
    
    "ErrorResponseFormat": "List"
},
"FeatureFlagsOptions": {
    "EnabledFeatureLicense": true,
    "EnabledFeatureModule": true
},
"HostedServiceOptions": {
    "IntervalAuthPolicyUpdaterMinutes": 5,
    "IntervalEmailSenderMinutes": 1
},
"UsersOptions": {
    "AssignAdminEmail": "admin@example.org",
    "AssignAdminPassword": "StrongPassword",
    "PasswordExpirationDays": 90
},
"ValidationOptions": {
    "MinLength": 3,
    "MaxLength": 50,
    "MinLengthDescription": 5,
    "MaxLengthDescription": 100
}

🗃️ Database

Configuration

The library uses Entity Framework Core to manage the database.

The connection string is configured in the ConnectionStrings section of the appsettings.json file.

• Database Type: Set via ConnectionStrings:DatabaseType (supported values: sqlserver)

After setting the type of database you want to use, modify the corresponding connection string.

Migrations

To create database migrations select MinimalApi.Identity.Core as the default project from the drop-down menu in the Package Manager Console and run the command: Add-Migration MIGRATION-NAME

Example: Add-Migration InitialMigration -Project MinimalApi.Identity.Migrations.SQLServer

🔰 Feature Flags

🚧 coming soon

💡 Usage Examples

An example configuration of the Program.cs class is available here

🔐 Authentication

This library currently supports the following authentication types:

• JWT Bearer Token

🧑‍💼 Administrator Account

🚧 coming soon

📚 API Reference

See the documentation for a list of all available endpoints.

📦 Packages

Name	Type	Version
Identity.Module.API	Main
Identity.Module.AccountManager	Dependence	Coming soon
Identity.Module.ClaimsManager	Dependence	Coming soon
Identity.Module.Core	Dependence
Identity.Module.EmailManager	Dependence
Identity.Module.Licenses	Dependence
Identity.Module.ModuleManager	Dependence	Coming soon
Identity.Module.PolicyManager	Dependence
Identity.Module.ProfileManager	Dependence	Coming soon
Identity.Module.RolesManager	Dependence	Coming soon
Identity.Module.Results	Dependence	Coming soon

🏆 Badges

🗺️ Roadmap

• Move the configuration of the claims to a dedicated library
• Move the configuration of the module to a dedicated library
• Move the configuration of the profile manager to a dedicated library
• Move the configuration of the roles to a dedicated library
• Add CancellationToken to API endpoints (where necessary)
• Move email sending logic to a dedicated library
• Modify email sending logic on a hosted service
• Changing the hosted service type to a background service in Email Manager
• Changing the hosted service type to a background service in Policy Manager
• Add automatic creation of a default administrator account
• Replacing exceptions with implementation of operation results
• Replacing the hosted service email sender using Coravel jobs
• Replacing the hosted service authorization policy updater using Coravel jobs
• Migrate SmtpOptions configuration to database
• Migrate FeatureFlagsOptions configuration to database
• Add support for the MySQL database
• Add support for the PostgreSQL database
• Add support for the SQLite database
• Add support for the AzureSQL database
• Add endpoints for two-factor authentication and management
• Add endpoints for downloading and deleting personal data
• Add support for multi tenancy
• Add authentication support from third-party providers (e.g. GitHub, Azure)

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

⭐ Give a Star

Don't forget that if you find this project useful, put a ⭐ on GitHub to show your support and help others discover it.

🤝 Contributing

The project is constantly evolving. Contributions are always welcome. Feel free to report issues and submit pull requests to the repository, following the steps below:

1. Fork the repository
2. Create a feature branch (starting from the develop branch)
3. Make your changes
4. Submit a pull requests (targeting develop)

🆘 Support

If you have any questions or need help, read here to find out what to do.