Overview
In this article, I am going to explore the integration of Google reCAPTCHA V2 with ASP.NET applications as well as how to customize the reCAPTCHA widget.
What is reCAPTCHA
Google reCAPTCHA is a free service that protects your website from spam and abuse. reCAPTCHA uses an advanced risk analysis engine and adaptive CAPTCHAs to keep automated software from engaging in abusive activities on your site. It does this while letting your valid users pass through with ease.
reCAPTCHA offers more than just spam protection. Every time our CAPTCHAs are solved, that human effort helps digitize text, annotate images, and build machine learning datasets. This, in turn, helps preserve books, improve maps, and solve hard AI problems.
![Tough on boats, Easy on humans]()
Google reCAPTCHA
Here, I will create a sample ASP.NET website to integrate Google reCAPTCHA. So, the following are the prerequisites for this article.
- We should have a Google account where we can register our sites for reCAPTCHA
- Visual Studio [ optional ]
Here, I am using Visual Studio 2015 for creating an ASP.NET application but it's not mandatory. We may use either the latest version or any older if we want to validate reCAPTCHA at the server-side as well.
Site Registration for reCAPTCHA
reCAPTCHA API's sitekey and secretkey are required.
So, first, we need to register our site/domain with Google reCAPTHCA v2 API to get the site key and secret key. So now, I am going to register our domains (
localhost,
programcafe.in) where I will use these keys for reCAPTCHA integration. Click
here for domain registration.
In the above image, we can see, there are three types of reCAPTCHA, i.e.,
- reCAPTCHA v2
- Invisible reCAPTCHA
- reCAPTCHA Android
But I have checked first one that is reCAPTCHA v2 and typed two domains localhost and programcafe.in . Now, click on the "Register" button after accepting its terms and conditions.
Note
We can mention multiple domains along with localhost. After clicking on Register button, the following screen will appear which contains reCAPTCHA Site key and Secret key.
On this screen, we have an option for Advanced Settings for security preference. We can customize it according to our requirement.
Now, we have all the things ready to integrate the reCAPTCHA on websites.
For this article, I am going to create an empty website with name reCAPTCHA and after that, I will add a new page named Default.aspx.
About reCAPTCHA Auto Rendering
Automatic Rendering Widget
- <body>
- <form id="form1" runat="server">
- <div class="g-recaptcha" data-sitekey="6Lfn8DoUAAAAAEuzI65jbXXNaewCS9BwO_XXXXXXXX"></div>
- </form>
- <script src='https://www.google.com/recaptcha/api.js'></script>
- </body>
This is the easiest way to rendering a reCaptcha on a web page. In the above code snippet, we can see that there is a div element having two attributes class and data-sitekey and both these attributes are mandatory.
- g-recaptcha is mandatory to make render recaptcha widget, we can not use own class name.
- data-sitekey is the key which is provided by Google reCAPTCHA for the domains which are mentioned at the time of reCAPTCHA v2 registration.
Let's execute this page to see how reCAPTCHA is showing.
Apart from these two mandatory attributes, Google provides some additionals attributes to customize the reCAPTCHA widget according to our choice/requirement.
Following are the list of some optional attributes which can be used to customize the reCAPTCHA widget.
- data-theme
we can use either light or dark theme. The default theme is light.
eg.
- <div data-theme="light" ></div>
- <div data-theme="dark" ></div>
![dark-theme]()
- data-type
data type for recaptcha challenges edither may be image or audio but the default data-type is image.
- <div class="g-recaptcha" data-type="image" data-sitekey="site_key_value" />
![data-type-image]()
- <div class="g-recaptcha" data-type="audio" data-sitekey="site_key_value" />
![data-type-audio]()
- data-size
it can be compact or normal but the default size is normal.
- <div class="g-recaptcha" data-size="normal" data-sitekey="site_key_value" />
-
- <div class="g-recaptcha" data-size="compact" data-sitekey="site_key_value" />
![data-size-view]()
- data-tabindex
We can set the tabindex to make access easier
Google reCAPTCHA API Parameters
Following are the reCAPTCHA API Parameters and all these parameters are optional.
- calback - The name of your callback function to be executed once all the dependencies have loaded.
- render - Whether to render the widget explicitly. Defaults to onload, which will render the widget in the first g-recaptcha tag it finds.
- hl - Forces the widget to render in a specific language. Auto-detects the user's language if unspecified.
reCAPTCHA Integration With Website
Rendering reCAPTCHA Explicitly
Step 1
Create an empty ASP.NET website and a new page Default.aspx and put the following code snippet inside the body tag.
Default.aspx
- <div id="ReCaptchContainer"></div>
- <label id="lblMessage" runat="server" clientidmode="static"></label>
- <br />
- <button type="button" >Submit</button>
In the above HTML code snippet, I have taken a div tag where recaptha widget will be rendered and there is a label to display validation message for recaptcha on button click.
Step 2
Refer the reCaptcha API script on the page. For this article, I am putting this script at the bottom of the body.
-
- <script src="https://www.google.com/recaptcha/api.js" async defer></script>
In this article, we are going to render the widget explicitly so we need to add onload and render parameters with reCaptcha API script.
Here, the onload parameter's value is renderRecaptcha which is a JavaScript function that renders the reCaptcha widget and the render value is explicit which show that render the widget explicitly by calling the function renderRecaptcha.
-
- <script src="https://www.google.com/recaptcha/api.js?onload=renderRecaptcha&render=explicit" async defer></script>
Step 3
Now, add the follwing script for reCAPTCHA render and it's callback functions.
- <script src="https://code.jquery.com/jquery-3.2.1.min.js"></script>
-
- <script type="text/javascript">
- var your_site_key = '<%= ConfigurationManager.AppSettings["SiteKey"]%>';
- var renderRecaptcha = function () {
- grecaptcha.render('ReCaptchContainer', {
- 'sitekey': your_site_key,
- 'callback': reCaptchaCallback,
- theme: 'light',
- type: 'image',
- size: 'normal'
- });
- };
-
- var reCaptchaCallback = function (response) {
- if (response !== '') {
- jQuery('#lblMessage').css('color', 'green').html('Success');
- }
- };
-
- jQuery('button[type="button"]').click(function(e) {
- var message = 'Please checck the checkbox';
- if (typeof (grecaptcha) != 'undefined') {
- var response = grecaptcha.getResponse();
- (response.length === 0) ? (message = 'Captcha verification failed') : (message = 'Success!');
- }
- jQuery('#lblMessage').html(message);
- jQuery('#lblMessage').css('color', (message.toLowerCase() == 'success!') ? "green" : "red");
- });
-
- </script>
Step 4
Let us run the page to test the reCAPTCHA functionality.
Step 4 Server Side Validation
For server-side validation, we need to call reCaptcha siteverify API along with parameters secretkey and response (recaptcha response after form submit).
Folliwing are the API URL.
https://www.google.com/recaptcha/api/siteverify?secret=<secret-key>&response=<captcha-response>
- public bool IsReCaptchValid()
- {
- var result = false;
- var captchaResponse = Request.Form["g-recaptcha-response"];
- var secretKey = ConfigurationManager.AppSettings["SecretKey"];
- var apiUrl = "https://www.google.com/recaptcha/api/siteverify?secret={0}&response={1}";
- var requestUri = string.Format(apiUrl, secretKey, captchaResponse);
- var request = (HttpWebRequest)WebRequest.Create(requestUri);
-
- using(WebResponse response = request.GetResponse())
- {
- using (StreamReader stream = new StreamReader(response.GetResponseStream()))
- {
- JObject jResponse = JObject.Parse(stream.ReadToEnd());
- var isSuccess = jResponse.Value<bool>("success");
- result = (isSuccess) ? true : false;
- }
- }
- return result;
- }
Now, call this method on button click to validate the reCaptcha input.
- protected void btnTry_Click(object sender, EventArgs e)
- {
- lblMessage.InnerHtml = (IsReCaptchValid())
- ? "<span style='color:green'>Captcha verification success</span>"
- : "<span style='color:red'>Captcha verification failed</span>";
- }
Step 4
Now, execute the program to test the server-side validation.
![]()
In the above JSON result object, "success: True" indicates that reCAPTCHA challenges validation success.
If anyone wants to see some sites where google reCAPTHCA is used
Summary
In this article, we learned what Google reCAPTCHA is, how to register our site for reCAPTHCA, how to integrate reCAPTCHA widget with the web page, how to validate reCAPTCHA challenges on the client side as well as server side in an ASP.NET application.
In an upcoming article, I will share about Invisible reCAPTCHA.