Pandorax.Recaptcha 3.1.0

Pandorax.Recaptcha

This project is a library for validating Google reCAPTCHA responses in .NET applications.

Installation

To install the library, add the following NuGet package to your project:

dotnet add package Pandorax.Recaptcha

Usage

Configuration

First, configure the reCAPTCHA options in your appsettings.json:

{
  "Recaptcha": {
    "SiteKey": "your-site-key",
    "SecretKey": "your-secret-key"
  }
}

Then, register the reCAPTCHA services in your Startup.cs or Program.cs:

public void ConfigureServices(IServiceCollection services)
{
    services.AddRecaptcha(Configuration.GetSection("Recaptcha"));
}

Or, if you are using Program.cs with top-level statements:

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddRecaptcha(builder.Configuration.GetSection("Recaptcha"));

Validation

When validating a reCAPTCHA response, you should check the following properties on the validation response:

• Success: Indicates whether the validation was successful.
• Score: Represents the confidence score (for reCAPTCHA v3). You may want to set a threshold (e.g., 0.5).
• Action: Should match the expected action you specified when rendering the reCAPTCHA widget.

To validate a reCAPTCHA response, inject the IRecaptchaService into your controller or service and call the ValidateAsync method:

public class MyController : Controller
{
    private readonly IRecaptchaService _recaptchaService;

    public MyController(IRecaptchaService recaptchaService)
    {
        _recaptchaService = recaptchaService;
    }

    [HttpPost]
    public async Task<IActionResult> SubmitForm(string recaptchaResponse)
    {
        var validationResponse = await _recaptchaService.ValidateAsync(recaptchaResponse, HttpContext.Connection.RemoteIpAddress);

        if (validationResponse.Success)
        {
            // reCAPTCHA validation succeeded
            if (validationResponse.Score >= 0.5)
            {
                // High confidence in the user's interaction
                if (validationResponse.Action == "submit_form")
                {
                    // Action matches expected value
                }
                else
                {
                    // Action does not match expected value
                }
            }
            else
            {
                // Low confidence in the user's interaction
            }
        }
        else
        {
            // reCAPTCHA validation failed
        }

        return View();
    }
}

License

This project is licensed under the MIT License.