HumanSecurityModule 0.13.0

Human Security .Net Core Enforcer - Module

Latest stable version: [v0.13.0]

Dependencies

• [.NET >= 6]

Installation

To install Human_Security_Module, run the following command:

dotnet add package HumanSecurityModule

Integration

Edit program.cs

1. Add Human Module

using HumanSecurityModule;

2. Add HumanSecurityModule as a service to your web api app:

builder.Services.AddSingleton<HumanSecurityModule.HumanSecurityModule>(provider =>
{
    EnforcerConfig enforcerConfig = new ConfigurationBuilder().AddJsonFile("appsettings.json").Build().GetSection("HumanConfiguration").Get<EnforcerConfig>();
    return new HumanSecurityModule.HumanSecurityModule(enforcerConfig);
});

3. Add site specific configuration (configuration level) On your app configuration JSON file (Default file name appsettings.json), add the following section:

"HumanConfiguration": {
    "px_app_id": "XXX",
    "px_cookie_secret": "XXX",
    "px_auth_token": "XXX"
    Other Human configuration options...
}

⚠️ If you do not wish to add the configuration for Human on your appsettings.json file, you can simply create an instance of EnforcerConfig manually and provide it to the module instead.

Configuring Required Parameters

Configuration options are set in EnforcerConfig

Required parameters:

• px_app_id
• px_cookie_secret
• px_auth_token

Using HumanSecurityModule in a controller

1. Inject HumanSecurityModule to your controller, for example:

public class WeatherForecastController : ControllerBase
{
...
private readonly HumanSecurityModule.HumanSecurityModule _humanModule;

    public WeatherForecastController(HumanSecurityModule.HumanSecurityModule humanModule)
    {
        _humanModule = humanModule;
    }
    ...

2. In the handler function you wish to use Human, create a new instance of HumanRequest by either passing it the httpContext or the different components individually, and then call the Enforce method as follows:

 HumanRequest humanRequest = new HumanRequest(this.HttpContext);

 EnforceResult res = await _humanModule.Enforce(humanRequest);

EnforceResult will always contain the IsValid property, which indicate whether the request is a valid one (not a bot) or not, in addition to the request context which contains additional data about the request.

Upgrading

To upgrade to the latest Enforcer version:

1. In Visual Studio, right click on the solution and Select Manage NuGet packages for solution.
2. Search for HumanSecurityModule in the updates section, and update.