Spaier.Recaptcha 3.2.0

Spaier.Recaptcha

Prerequisites

• ASP.NET Core 2.1
• Nuget
• Recaptcha key (V3 or V2)

Table of Contents

• Installation
• Usage
• License

Installation

Nuget

Install-Package Spaier.Recaptcha

.NET CLI

dotnet add package Spaier.Recaptcha

Usage

1. Add recaptcha services in your Startup.cs

public void ConfigureServices(IServiceCollection services) {
    // Your Code
    services.AddRecaptcha()
        // Use appsettings.json
        //.AddInMemoryConfigurationStore(Configuration.GetSection("Recaptcha"))
        .AddInMemoryConfigurationStore(new Dictionary<string, RecaptchaConfiguration>
        {
            ["Sitekey1"] = new RecaptchaConfiguration(RecaptchaDefaults.TestSecretKey, RecaptchaSecretType.V2),
            ["Sitekey2"] = new RecaptchaConfiguration(RecaptchaDefaults.TestSecretKey, RecaptchaSecretType.V2Android),
            ["Sitekey3"] = new RecaptchaConfiguration(RecaptchaDefaults.TestSecretKey, RecaptchaSecretType.V3),
        })
        .AddTokenHeaderProvider()
        .AddConfigurationHeaderProvider()
        .AddRecaptchaHttpClient(configureHttpBuilder: httpBuilder =>
        {
		    // You can setup Polly here
            httpBuilder.AddTransientHttpErrorPolicy(builder => builder.WaitAndRetryAsync(new[]
            {
                TimeSpan.FromSeconds(1),
                TimeSpan.FromSeconds(5),
                TimeSpan.FromSeconds(10)
            }));
        })
        .UseGoogleUrl();
		// UseGlobalUrl(); // will use recaptcha.net mirror. Useful for countries where google.com is blocked.
        // UseCustomUrl("your_url"); // will use custom url for validation.
}

2. Apply ValidateRecaptcha attribute to an action.

Configurations defines allowed configurations for an action. If none is specified you can use any configuration. If only one is specified you can omit configuration token.

AllowedAction works with V2 or V3. Don't specify to skip action check.

MinimumScore works with V3. Defaults to 0.5.

UseModelErrors determines whether errors will be added to MVC Model. True by default.

You can pass a recaptcha response to an action by using the FromRecaptchaResponseAttribute with any method parameter derived from the IRecaptchaResponse.

        [HttpPost]
        [AllowAnonymous]
        [ValidateRecaptcha(Configurations = new[] { "Sitekey1", "Sitekey2" }, MinimumScore = 0.7, AllowedAction = "register")]
        public async Task<ActionResult> ProtectedByV3AndV2([FromRecaptchaResponse] RecaptchaResponse response)
        {
            // Your Code
        }

A reCAPTCHA's response should be passed in a HTTP header with the specified key or g-recaptcha-response.

A reCAPTCHA's configuration key should be passed in a HTTP header with the specified key or g-recaptcha-type if there's more than one configuration in store or specified in Configurations.

If token passed by client-side is invalid model errors will be added to ModelState. See RecaptchaErrorCodes, ValidateRecaptchaAttribute.ErrorCodes and official docs

License

MIT