This iRule integrates a reCAPTCHA v2 (like the one shown below) with your virtual server.
This iRule is similar to the existing reCAPTCHA v1 on devcentral: Google reCAPTCHA Challenge iRule - DevCentral
Because reCAPTCHA v2 uses Google API for Token validation, the two iRules are different in structure. Nonetheless this iRule borrows a good bit of code from the v1 iRule linked above.
Before you can use this iRule, you must register and obtain a reCAPTCHA API key pair at this link: reCAPTCHA: Easy on Humans, Hard on Bots
The key pair are entered in the iRule under the RULE_INIT event, (lines 14 and 15)
You may also want to read the Getting Started page. https://developers.google.com/recaptcha/docs/start
In order to connect to the Google API using HTTPS, the iRule uses sideband commands that target an internal virtual server. The name of this server is arbitrary, but in my iRule I use “www.google.com”. See line 112. This virtual must be created and assigned a SERVERSSL profile and a pool. The pool only needs one member, but if you specify an FQDN instead of an IP address, all the IP addresses returned by the DNS server will become pool members.
Here is the internal virtual server which is targeted by the sideband commands:
-
<span><span>[root@exch:Active:Standalone] config # tmsh list ltm virtual www.google.com </span></span> -
<span>ltm virtual www.google.com { </span> -
<span> destination 10.1.10.7:http </span> -
<span> ip-protocol tcp </span> -
<span> mask 255.255.255.255 </span> -
<span> pool www.google.com </span> -
<span> profiles { </span> -
<span> serverssl { </span> -
<span> context serverside </span> -
<span> } </span> -
<span> tcp { } </span> -
<span> } </span> -
<span> source 0.0.0.0/0 </span> -
<span> source-address-translation { </span> -
<span> type automap </span> -
<span> } </span> -
<span> translate-address enabled </span> -
<span> translate-port enabled </span> -
<span> vs-index 15 </span> -
<span>}</span>
This is the pool of Google servers:
-
<span><span>[root@exch:Active:Standalone] config # tmsh list ltm pool www.google.com </span></span> -
<span>ltm pool www.google.com { </span> -
<span> members { </span> -
<span> www.google.com:https { </span> -
<span> fqdn { </span> -
<span> autopopulate enabled </span> -
<span> name www.google.com </span> -
<span> } </span> -
<span> state fqdn-up </span> -
<span> } </span> -
<span> www.google.com-<span class="number">74.125</span><span>.</span><span class="number">28.103</span><span>:https { </span></span> -
<span> address <span class="number">74.125</span><span>.</span><span class="number">28.103</span><span> </span></span> -
<span> fqdn { name www.google.com } </span> -
<span> } </span> -
<span> www.google.com-<span class="number">74.125</span><span>.</span><span class="number">28.104</span><span>:https { </span></span> -
<span> address <span class="number">74.125</span><span>.</span><span class="number">28.104</span><span> </span></span> -
<span> fqdn { name www.google.com } </span> -
<span> } </span> -
<span> www.google.com-<span class="number">74.125</span><span>.</span><span class="number">28.105</span><span>:https { </span></span> -
<span> address <span class="number">74.125</span><span>.</span><span class="number">28.105</span><span> </span></span> -
<span> fqdn { name www.google.com } </span> -
<span> } </span> -
<span> www.google.com-<span class="number">74.125</span><span>.</span><span class="number">28.106</span><span>:https { </span></span> -
<span> address <span class="number">74.125</span><span>.</span><span class="number">28.106</span><span> </span></span> -
<span> fqdn { name www.google.com } </span> -
<span> } </span> -
<span> www.google.com-<span class="number">74.125</span><span>.</span><span class="number">28.147</span><span>:https { </span></span> -
<span> address <span class="number">74.125</span><span>.</span><span class="number">28.147</span><span> </span></span> -
<span> fqdn { name www.google.com } </span> -
<span> } </span> -
<span> www.google.com-<span class="number">74.125</span><span>.</span><span class="number">28.99</span><span>:https { </span></span> -
<span> address <span class="number">74.125</span><span>.</span><span class="number">28.99</span><span> </span></span> -
<span> fqdn { name www.google.com } </span> -
<span> } </span> -
<span> } </span> -
<span>} </span>
Additional notes :
- The iRule does not rely on the DNS server. Except for the Google API server pool FQDN.
- The iRule does not rely on tables to keep session information.
- The iRule does not use tables to keep persistence information.
- The iRule uses a cookie (i_am_not_bot) to keep track of users who successfully solved the google captcha. When client connection is SSL/TLS based, this cookie uses the SSL session ID to secure the cookie, as per RFC 6896: SCS: KoanLogic's Secure Cookie Sessions for HTTP | RFC Editor . By default this is a session cookie which will expire when the browser is restarted. User can specify a re-captcha2-session-Cookie timeout in seconds relative to current time. If not using SSL, cookie expiration can be used as the only defense against cookie hijacking attacks.
- If you want to use this iRule without SSL, You will need to remove the SSL event CLIENTSSL_HANDSHAKE. You should also set the Cookie Timeout variable under the RULE_INIT event.
- If the google API server sideband connection is not successful, you will get a message in /var/log/ltm. In this case, you can troubleshoot the google virtual server separately. If you can browse to the IP address you assigned for this virtual and receive the google search engine page, you are good. Note, this virtual does not need an HTTP profile but, adding one could aid in troubleshooting.
- Set the global variable “static::logging” to level 1, 2 or 3 for the desired level of verbose logging. Do not leave it at level 3 for production.
The iRule:
-
<span><span>###################################### </span></span> -
<span># NOTE: </span> -
<span># If not using SSL, the whole CLIENTSSL_HANDSHAKE event should be removed <span class="keyword">or</span><span> commented out. </span></span> -
<span> </span> -
<span>when CLIENTSSL_HANDSHAKE { </span> -
<span> #log local0. <span class="string">"[SSL::sessionid]"</span><span> </span></span> -
<span> set cookie_encr_key [string range [SSL::sessionid] <span class="number">0</span><span> </span><span class="number">31</span><span>] </span></span> -
<span> set secure <span class="string">"; secure"</span><span> </span></span> -
<span>} </span> -
<span>###################################### </span> -
<span> </span> -
<span>when RULE_INIT { </span> -
<span> # set <span class="keyword">public</span><span> </span><span class="keyword">and</span><span> </span><span class="keyword">private</span><span> reCAPTCHA keys (obtain from https:</span><span class="comment">//www.google.com/recaptcha/admin#list)</span><span> </span></span> -
<span> set <span class="keyword">static</span><span>::recaptcha_public_key </span><span class="string">"6LccTygTAAAAA*********izaZ-4LpEXTf35ju1x"</span><span> </span></span> -
<span> set <span class="keyword">static</span><span>::recaptcha_private_key </span><span class="string">"6LccTygTAAAAAA********Gvc_-jLJ_KTtKGvLP3"</span><span> </span></span> -
<span> </span> -
<span> # set the recaptcha session cookie timeout in SECONDS. Only needed <span class="keyword">if</span><span> using https. </span></span> -
<span> # If not using https, this timeout is only defense against Cookie replay attack. </span> -
<span> set <span class="keyword">static</span><span>::recaptcha_session_timeout </span><span class="string">""</span><span> </span></span> -
<span> </span> -
<span> # log level, <span class="number">0</span><span> = silent, </span><span class="number">1</span><span> = log client interaction, </span><span class="number">2</span><span> = log all interaction with client </span><span class="keyword">and</span><span> Google </span></span> -
<span> set <span class="keyword">static</span><span>::logging </span><span class="number">1</span><span> </span></span> -
<span> # begin - HTML <span class="keyword">for</span><span> reCAPTCHA form page </span></span> -
<span> set <span class="keyword">static</span><span>::recaptcha_challenge_form { </span></span> -
<span> <html> </span> -
<span> <head> </span> -
<span> <title>reCAPTCHA demo: Simple page</title> </span> -
<span> <script src=<span class="string">"https://www.google.com/recaptcha/api.js"</span><span> async defer></script> </span></span> -
<span> </head> </span> -
<span> <body> </span> -
<span> <form action=<span class="string">"?"</span><span> method=</span><span class="string">"POST"</span><span>> </span></span> -
<span> <div <span class="keyword">class</span><span>=</span><span class="string">"g-recaptcha"</span><span> data-sitekey=</span><span class="string">"}</span></span> -
append static::recaptcha_challenge_form $static::recaptcha_public_key -
append static::recaptcha_challenge_form <span><span class="string">{"</span><span>></div> </span></span> -
<span> <br/> </span> -
<span> <input type=<span class="string">"submit"</span><span> value=</span><span class="string">"Submit"</span><span>> </span></span> -
<span> </form> </span> -
<span> </body> </span> -
<span></html> </span> -
<span> } </span> -
<span> # <span class="func">end</span><span> - HTML </span><span class="keyword">for</span><span> reCAPTCHA form page </span></span> -
<span>} </span> -
<span> </span> -
<span> </span> -
<span> </span> -
<span>when CLIENT_ACCEPTED { </span> -
<span> <span class="keyword">if</span><span> { </span><span class="vars">$static</span><span>::logging >= </span><span class="number">2</span><span> } { </span></span> -
<span> set session_identifier <span class="string">"[IP::client_addr]:[TCP::client_port]/[IP::local_addr]:[TCP::local_port]"</span><span> </span></span> -
<span> log local0. <span class="string">"New session: $session_identifier"</span><span> </span></span> -
<span> } </span> -
<span> # The following variables will be over-written <span class="keyword">if</span><span> using SSL </span></span> -
<span> set secure <span class="string">""</span><span> </span></span> -
<span> set cookie_encr_key [string range <span class="vars">$static</span><span>::recaptcha_private_key </span><span class="number">8</span><span> </span><span class="number">39</span><span>] </span></span> -
<span>} </span> -
<span> </span> -
<span>when HTTP_REQUEST priority <span class="number">10</span><span> { </span></span> -
<span> </span> -
<span> #log local0. <span class="string">"[HTTP::method] - [HTTP::uri] - [HTTP::path]"</span><span> </span></span> -
<span> # no_bot_cookie is the value that will be stuffed in the i_am_not_a_bot cookie during response </span> -
<span> set no_bot_cookie [IP::client_addr]-[TCP::client_port]-[HTTP::uri] </span> -
<span> </span> -
<span> <span class="keyword">if</span><span> {[HTTP::cookie exists i_am_not_a_bot] </span><span class="keyword">and</span><span> [AES::decrypt </span><span class="vars">$cookie_encr_key</span><span> [b64decode [HTTP::cookie i_am_not_a_bot]]] ne </span><span class="string">""</span><span> } { </span></span> -
<span> </span> -
<span> <span class="keyword">if</span><span> { </span><span class="vars">$static</span><span>::logging >= </span><span class="number">1</span><span> } { </span></span> -
<span> log local0. <span class="string">"URI: [HTTP::uri] Cookie: [HTTP::cookie exists i_am_not_a_bot] - [AES::decrypt $cookie_encr_key [b64decode [HTTP::cookie i_am_not_a_bot]]]"</span><span> </span></span> -
<span> log local0. <span class="string">"Request to [HTTP::uri] with valid cookie ALLOWED."</span><span> </span></span> -
<span> } </span> -
<span> </span> -
<span> } <span class="keyword">else</span><span> { </span></span> -
<span> </span> -
<span> <span class="keyword">if</span><span> {[HTTP::method] equals </span><span class="string">"POST"</span><span> } { </span></span> -
<span> log local0. <span class="string">"Collecting. [HTTP::header Content-Length]"</span><span> </span></span> -
<span> HTTP::collect <span class="number">100</span><span> </span></span> -
<span> <span class="keyword">return</span><span> </span></span> -
<span> } <span class="keyword">else</span><span> { </span></span> -
<span> set redirect_uri [HTTP::uri] </span> -
<span> set no_bot_cookie [IP::client_addr]-[TCP::client_port]-[HTTP::uri] </span> -
<span> HTTP::respond <span class="number">200</span><span> content </span><span class="vars">$static</span><span>::recaptcha_challenge_form Connection </span><span class="string">"Keep-Alive"</span><span> </span></span> -
<span> } </span> -
<span> } </span> -
<span>} </span> -
<span> </span> -
<span> </span> -
<span>when HTTP_REQUEST_DATA { </span> -
<span> <span class="keyword">if</span><span> { </span><span class="vars">$static</span><span>::logging >= </span><span class="number">2</span><span> } { </span></span> -
<span> # Body of POST starts with parameter name: g-recaptcha-response </span> -
<span> # The <span class="number">21</span><span> is the length of the string: </span><span class="string">'g-recaptcha-response='</span><span> </span></span> -
<span> log local0. <span class="string">"Session $session_identifier : user responded with:"</span><span> </span></span> -
<span> log local0. <span class="string">"[string range [HTTP::payload] 21 end]"</span><span> </span></span> -
<span> } </span> -
<span> set recaptcha_response_field [string range [HTTP::payload] <span class="number">21</span><span> </span><span class="func">end</span><span>] </span></span> -
<span> </span> -
<span> # assemble body of reCAPTCHA verification POST </span> -
<span> set recaptcha_post_data <span class="string">"secret=$static::recaptcha_private_key&"</span><span> </span></span> -
<span> append recaptcha_post_data <span class="string">"remoteip=[IP::remote_addr]&"</span><span> </span></span> -
<span> append recaptcha_post_data <span class="string">"response=$recaptcha_response_field"</span><span> </span></span> -
<span> # calculate Content-length header value </span> -
<span> set recaptcha_post_content_length [string length <span class="vars">$recaptcha_post_data</span><span>] </span></span> -
<span> # assemble reCAPTCHA verification POST request </span> -
<span> set recaptcha_verify_request <span class="string">"POST /recaptcha/api/siteverify HTTP/1.1\r\n"</span><span> </span></span> -
<span> append recaptcha_verify_request <span class="string">"Host: www.google.com\r\n"</span><span> </span></span> -
<span> append recaptcha_verify_request <span class="string">"Accept: */*\r\n"</span><span> </span></span> -
<span> append recaptcha_verify_request <span class="string">"Content-length: $recaptcha_post_content_length\r\n"</span><span> </span></span> -
<span> append recaptcha_verify_request <span class="string">"Content-type: application/x-www-form-urlencoded\r\n\r\n"</span><span> </span></span> -
<span> append recaptcha_verify_request <span class="string">"$recaptcha_post_data"</span><span> </span></span> -
<span> # Sideband connection must go through internal virtual server with serverside SSL in order </span> -
<span> # to connect to a server accepting SSL connections. </span> -
<span> # Below is the name of internal virtual server. </span> -
<span> </span> -
<span> # establish connection to Google </span> -
<span> set conn_id [connect -timeout <span class="number">1000</span><span> -idle </span><span class="number">30</span><span> www.google.com] </span></span> -
<span> </span> -
<span> <span class="keyword">if</span><span> { </span><span class="vars">$conn_id</span><span> != </span><span class="string">""</span><span> } { </span></span> -
<span> # send reCATPCHA verification request to Google </span> -
<span> send -timeout <span class="number">1000</span><span> -status send_status </span><span class="vars">$conn_id</span><span> </span><span class="vars">$recaptcha_verify_request</span><span> </span></span> -
<span> </span> -
<span> # receive reCAPTCHA verification response from Google </span> -
<span> set recaptcha_verify_response [recv -timeout <span class="number">1000</span><span> -status recv_info </span><span class="vars">$conn_id</span><span>] </span></span> -
<span> <span class="keyword">if</span><span> { </span><span class="vars">$recaptcha_verify_response</span><span> equals </span><span class="string">""</span><span> } { log local0. </span><span class="string">"Connection to google via internal virtual not successful."</span><span> } </span></span> -
<span> <span class="keyword">if</span><span> { </span><span class="vars">$static</span><span>::logging >= </span><span class="number">2</span><span> } { </span></span> -
<span> log local0. <span class="string">"Received verification response from Google: $recaptcha_verify_response"</span><span> </span></span> -
<span> } </span> -
<span> </span> -
<span> close <span class="vars">$conn_id</span><span> </span></span> -
<span> # process reCAPTCHA verification response <span class="keyword">and</span><span> remove user session from trigger table </span><span class="keyword">if</span><span> successful </span></span> -
<span> <span class="keyword">if</span><span> { </span><span class="vars">$recaptcha_verify_response</span><span> contains </span><span class="string">"success\": true"</span><span> } { </span></span> -
<span> set redirect_uri [HTTP::uri] </span> -
<span> <span class="keyword">if</span><span> { </span><span class="vars">$static</span><span>::logging >= </span><span class="number">1</span><span> } { </span></span> -
<span> log local0. <span class="string">"passed captcha. Redirecting to $redirect_uri with new cookie."</span><span> </span></span> -
<span> } </span> -
<span> </span> -
<span> <span class="keyword">if</span><span> { </span><span class="vars">$static</span><span>::recaptcha_session_timeout != </span><span class="string">""</span><span>} { </span></span> -
<span> #set fmt <span class="string">"%a, %d %b %Y %H:%M:%S %Z"</span><span> </span></span> -
<span> set fmt <span class="string">"%a, %d %h %Y %T GMT"</span><span> </span></span> -
<span> set expiry <span class="string">"; expires=[clock format [expr [clock seconds] + $static::recaptcha_session_timeout] -format $fmt -gmt true]"</span><span> </span></span> -
<span> } <span class="keyword">else</span><span> { </span></span> -
<span> set expiry <span class="string">""</span><span> </span></span> -
<span> } </span> -
<span> </span> -
<span> set cookie <span class="string">"i_am_not_a_bot=[b64encode [AES::encrypt $cookie_encr_key $no_bot_cookie]]; path= /; HTTPonly $expiry"</span><span> </span></span> -
<span> HTTP::respond <span class="number">302</span><span> Location </span><span class="vars">$redirect_uri</span><span> Set-Cookie </span><span class="vars">$cookie</span><span> </span></span> -
<span> </span> -
<span> } <span class="keyword">else</span><span> { </span></span> -
<span> HTTP::respond <span class="number">200</span><span> content </span><span class="vars">$static</span><span>::recaptcha_challenge_form </span></span> -
<span> <span class="keyword">if</span><span> { </span><span class="vars">$static</span><span>::logging >= </span><span class="number">1</span><span> } { </span></span> -
<span> log local0. <span class="string">"failed captcha"</span><span> </span></span> -
<span> } </span> -
<span> } </span> -
<span> } <span class="keyword">else</span><span> { </span></span> -
<span> log local0. <span class="string">"Could not contact google.com to verify token."</span><span> </span></span> -
<span> HTTP::respond <span class="number">500</span><span> content </span><span class="string">"<html>Could not contact goole.com:443</html>"</span><span> Connection close </span></span> -
<span> } </span> -
<span> HTTP::release </span> -
<span> </span> -
<span>} </span>
