KITT.Web.ReCaptcha.Http 1.0.1

KITT.Web.ReCaptcha.Http

This project add Google reCaptcha to your ASP.NET Core apps giving the service to validate your reCaptcha client response.<br/> This project targets .NET 6 and .NET 8 as supported Framework versions.

Installation

This project is available on NuGet.

It can be installed using the dotnet add package command or the NuGet wizard on your favourite IDE.

  dotnet add package KITT.Web.ReCaptcha.Http

reCaptcha v2

Usage

The project gives you an HttpClient service which expose a VerifyAsync method to verify the reCaptcha response send by the user from the client.

Add the namespace KITT.Web.ReCaptcha.Http.v2 to your Program.cs and use the AddReCaptchaV2HttpClient extension method to your IServiceCollection instance:

builder.Services.AddReCaptchaV2HttpClient(options =>
{
    options.SecretKey = "<your reCaptcha server-side secret key>";
});

Then you can inject the ReCaptchaService class whenever you need and call the VerifyAsync like this:

app.MapPost("/send", async (ReCaptchaService reCaptchaService, [FromBody] SendRequest request) =>
{
    // Here you call the reCaptcha server-side validation
    var captchaResponse = await reCaptchaService.VerifyAsync(request.CaptchaResponse);
    if (!captchaResponse.Success)
    {
        return Results.BadRequest(captchaResponse.ErrorCodes);
    }

    return Results.Ok();
});

Methods

The VerifyAsync method has the following input parameters:

The method returns an instance of the ReCaptchaResponse class, which have the following properties:

reCaptcha v3

Usage

The project gives you an HttpClient service which expose a VerifyAsync method to verify the reCaptcha response send by the user from the client.

Add the namespace KITT.Web.ReCaptcha.Http.v3 to your Program.cs and use the AddReCaptchaV3HttpClient extension method to your IServiceCollection instance:

builder.Services.AddReCaptchaV3HttpClient(options =>
{
    options.SecretKey = "<your reCaptcha server-side secret key>";
});

Then you can inject the ReCaptchaService class whenever you need and call the VerifyAsync like this:

app.MapPost("/send", async (ReCaptchaService reCaptchaService, [FromBody] SendRequest request) =>
{
    // Here you call the reCaptcha server-side validation
    var captchaResponse = await reCaptchaService.VerifyAsync(request.CaptchaResponse, request.Action);
    if (!captchaResponse.Success)
    {
        return Results.BadRequest(captchaResponse.ErrorCodes);
    }

    return Results.Ok();
});

Methods

The VerifyAsync method has the following input parameters:

The method returns an instance of the ReCaptchaResponse class, which have the following properties: