AspNetCore.ReCaptcha

ReCAPTCHA Library for .NET Core 3.x/5.x.

Requirements

This package requires a secret key as well as a site key provided by ReCaptcha. You can aquire your keyset at https://www.google.com/recaptcha/intro/v3.html. It's possible to use either v2 or v3 ReCaptcha.

Installation

You can install this package using NuGet. You can use the following command:

# Package Manager PM> Install-Package AspNetCore.ReCaptcha # .NET CLI dotnet add package AspNetCore.ReCaptcha

Configuration

Place the aquired secret key and site key in the appsettings.json of your project. An example of the appsettings file is below:

{ "ReCaptcha": { "SiteKey": "your site key here", "SecretKey": "your secret key here", "Version": "v2" } }

Usage

To use AspNetCore.ReCaptcha in your project, you must add the following code to your startup.cs:

public void ConfigureServices(IServiceCollection services) { services.AddReCaptcha(Configuration.GetSection("ReCaptcha")); }

In your .cshtml file you add the following using statement:

@using AspNetCore.ReCaptcha

And then you can add the ReCaptcha element to your DOM using the following code or make use of the tag-helper:

@Html.ReCaptcha() <recaptcha />

To be able to make use of the taghelper, you will need to include the following line of code in your _ViewImports.cshtml:

@addTagHelper *, AspNetCore.ReCaptcha

The action that you will be posting to (in this case SubmitForm) will need the following attribute on the method:

[ValidateReCaptcha] [HttpPost] public IActionResult SubmitForm(ContactViewModel model) { if (!ModelState.IsValid) return View("Index"); TempData["Message"] = "Your form has been sent!"; return RedirectToAction("Index"); }