YouBIM.Common.Security.Lib 8.0.24

YouBIM.Common.Security.Lib

Authentication / Authorization Common Library

Overview

YouBIM.Common.Security.Lib is a common library designed to handle authentication and authorization for microservices in a .NET Core 8 environment. It provides a flexible and robust mechanism for validating JWT tokens and handling client credentials for secure access to APIs.

Features

• JWT Token Validation: Validates tokens, extracting user metadata and roles.
• Client Credentials Validation: Supports authentication using client ID and secret key.
• Custom Authorization Handler: Implements custom authorization logic.
• Configuration Driven: Utilizes IConfiguration for managing authentication settings.
• Logging Support: Integrated logging for tracking authorization processes and errors.

Installation

1. Add the library to your project via NuGet:

   dotnet add package YouBIM.Common.Security.Lib
   

2. Configure your appsettings.json to include the necessary authentication settings:

   {
     "AuthenticationConfiguration": {
       "Authority": "https://your-auth-server.com",
       "Audience": "your-audience",
       "Issuer": "your-issuer",
       "ClientId": "your-client-id",
       "JwtSecretKey": "your-secret-key"
     }
   }
   

Usage

Registering Services

In your Program.cs, after the environment configuration add the authentication services provided by the library:

string environment = Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT");
builder.Configuration.AddJsonFile("appsettings.json", true)
                    .AddJsonFile($"appsettings.{environment}.json", optional: true)
                    .AddEnvironmentVariables()
                    .AddCommandLine(args);
                    
//add auth lib inyection                    
builder.Services.AddAuthentication(builder.Configuration);

Implementing Client Service

Implement the IClientService interface to provide the logic for retrieving user metadata based on client credentials:

public class ClientService : IClientService
{
    public async Task<AuthUserMetadata> GetAuthUserByClientIdentifierAsync(string clientId, string secretKey)
    {
        // Your implementation to fetch user metadata
    }
}

Adding Authorization Policies

Add the custom authorization policy to your controllers or endpoints:

[Authorize(Policy = "AuthHandler")]
public class YourController : ControllerBase
{
    // Your controller actions
}

Classes and Methods

AuthHandler

Handles the main authorization logic, checking for tokens or client credentials in HTTP headers and validating them.

• HandleRequirementAsync: Core method to process authorization.
• HandleTokenAuthorization: Validates JWT tokens.
• HandleClientCredentialsAuthorizationAsync: Validates client credentials.
• SetAuthUserInHttpContext: Sets user metadata in the HTTP context.
• FailAuthorization: Handles authorization failures and sets appropriate response messages.

AuthRequirement

Defines a requirement for authorization policies.

Util

Provides utility methods for token deserialization and HTTP context extraction.

AuthenticationConfiguration

Holds configuration settings for the authentication process.

AuthUserMetadata

Defines the structure for user metadata including user ID, username, role, buildings, and account ID.

IClientService

Interface to be implemented for client credential validation logic.

DependencyInjection

Extension methods for registering authentication and authorization services.

Important Notes

• Ensure that the JWT secret key is securely stored and accessed, such as using environment variables or a secrets manager.
• Update your NuGet packages regularly, but be aware of breaking changes in newer versions, especially for Microsoft.AspNetCore.Authentication.JwtBearer.