Persilsoft.Recaptcha.Server 1.0.21

Persilsoft.Recaptcha.Server

It exposes an endpoint to interact with the Google API to validate a reCAPTCHA V3 token.

Example:

First, you need to register the group of services required by the backend.

using Persilsoft.Recaptcha.Server.Options;
using ServiceCollectionExtensions;

Action<RecaptchaOptions> recaptchaOptionsConfigurator = options =>
builder.Configuration.GetSection(RecaptchaOptions.SectionKey).Bind(options);

builder.Services.AddRecaptchaService(recaptchaOptionsConfigurator);

In the appsetting.json configuration file, you need to configure the following key:

"RecaptchaOptions": {
    "VerifyEndpoint": "https://www.google.com/recaptcha/api/siteverify",
    "SecretKey": "xxxxxxxx"
  }

Where:
VerifyEndpoint: It is the private key provided by Google to interact with their services.

Once the services are registered, you need to add to the AspNet Core pipeline the Endpoints that interact with the Google API:

using WebApplicationExtensions;

app.MapRecaptchaEndpoints();

Now, you can test the endpoint. If your WebApi has Swagger installed and configured, you'll be able to visualize and execute it.

Verify token

To validate a Recaptcha token, it needs to be validated with the Google API through this endpoint, which has the following JSON structure:

{
  "token": "string"
}

Note: To obtain a Recaptcha token, you can refer to the documentation of the package Persilsoft.Recaptcha.Blazor.

Token restrictions:

• Each reCAPTCHA user response token is valid for two minutes, and can only be verified once to prevent replay attacks. If you need a new token, you can re-run the reCAPTCHA verification.
• After you get the response token, you need to verify it within two minutes with reCAPTCHA using the following API to ensure the token is valid.

If an error occurs while validating the Recaptcha token, a 'VerifyRecaptchaTokenException' exception will be thrown. You can implement a custom exception handler to handle it and format the response appropriately, or you can register the exception handler included in this package.

builder.Services.AddRecaptchaExceptionHandler();

And include it in the pipeline of your AspNet Core application.

app.UseExceptionHandler(builder => { });

For more information about verifying the reCAPTCHA token, you can visit the following link:
https://developers.google.com/recaptcha/docs/verify