spacewander commented on a change in pull request #6512: URL: https://github.com/apache/apisix/pull/6512#discussion_r831737089
########## File path: docs/en/latest/plugins/recaptcha.md ########## @@ -0,0 +1,116 @@ +--- +title: recaptcha +--- + +<!-- +# + +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +--> + +## Description + +Restrict access to an upstream service by verifying request captcha token to the Google reCAPTCHA service. The Plugin supports customizing the invalid captcha response. + +> Note that the plugin only supports reCAPTCHA v2(verify requests with a challenge). + +## Attributes + +| Name | Type | Requirement | Default | Valid | Description | +| --------- | ------------- | ----------- |----------------------------------------------------------------------------------------------------------------| ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | +| secret_key | string | required | | | The secret key of the Google reCAPTCHA v2 service. | +| parameter_source | string | optional | header | | The enum of captcha parameter source. Only `header`, `query` are supported. | +| parameter_name | string | optional | captcha | | The name of captcha parameter. | +| response | object | optional | content_type = `application/json; charset=utf-8`; status_code = `400`; body = `{"message":"invalid captcha"}` | | The response for invalid recaptcha token. | +| ssl_verify | boolean | optional | true | | verify if SSL cert matches hostname. | + +The example configuration of plugin is + +```json +{ + "secret_key":"6LeIxAcTAAAAAGGXXXXXXXXXXXXXXXXXXX", + "parameter_source": "header", + "parameter_name": "captcha", + "response":{ + "content_type":"application/json; charset=utf-8", + "body":"{\"message\":\"invalid captcha\"}\n", + "status_code":400 + } +} +``` + +## How To Enable + +Here's an example, enable this plugin on the specified route: + +```shell +$ curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' +{ + "plugins": { + "recaptcha": { + "secret_key": "6LeIxAcTAAAAAGG-XXXXXXXXXXXXXX", + "parameter_source": "header", + "parameter_name": "captcha", + "response": { + "content_type": "application/json; charset=utf-8", + "status_code": 400, + "body": "{\"message\":\"invalid captcha\"}\n" + } + } + }, + "upstream": { + "nodes": { + "127.0.0.1:1980": 1 + }, + "type": "roundrobin" + }, + "uri": "/login" +}' +``` + +## Test Plugin + +Use curl to request: + +```shell +$ curl -X POST 'http://127.0.0.1:9080/login' +{"message":"invalid captcha"} + +$ curl -X POST 'http://127.0.0.1:9080/login' -H 'captcha: the_invalid_captcha' +{"message":"invalid captcha"} Review comment: Need a successful case ########## File path: t/plugin/recaptcha.t ########## @@ -0,0 +1,241 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +use t::APISIX 'no_plan'; + +log_level('info'); +repeat_each(1); +no_long_string(); +no_root_location(); + +add_block_preprocessor(sub { + my ($block) = @_; + + if (! $block->request) { + $block->set_value("request", "GET /t"); + } + + if (! $block->no_error_log && ! $block->error_log) { + $block->set_value("no_error_log", "[error]\n[alert]"); + } +}); + +run_tests; + + +__DATA__ + +=== TEST 1: sanity +--- config + location /t { + content_by_lua_block { + local plugin = require("apisix.plugins.recaptcha") + local ok, err = plugin.check_schema({ + # https://developers.google.com/recaptcha/docs/faq#id-like-to-run-automated-tests-with-recaptcha + secret_key = "6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe", # Google automated-tests secret key + parameter_source = "header", + parameter_name = "captcha", + response = { + content_type = "application/json; charset=utf-8", + status_code = 400, + body = "{\"message\":\"invalid captcha\"}\n" + }, + ssl_verify = false, + }) + if not ok then + ngx.say(err) + end + + ngx.say("done") + } + } +--- response_body +done + + + +== TEST 2: invalid secret_key +--- config + location /t { + content_by_lua_block { + local plugin = require("apisix.plugins.recaptcha") + local ok, err = plugin.check_schema({ + secret_key = nil, + }) + if not ok then + ngx.say(err) + end + + ngx.say("done") + } + } +--- response_body +property "secret_key" is required +done + + + +=== TEST 2: add plugin +--- config + location /t { + content_by_lua_block { + local t = require("lib.test_admin").test + local code, body = t('/apisix/admin/routes/1', + ngx.HTTP_PUT, + [[{ + "plugins": { + "recaptcha": { + "secret_key": "6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe", + "parameter_source": "header", + "parameter_name": "captcha", + "response": { + "content_type": "application/json; charset=utf-8", + "status_code": 400, + "body": "{\"message\":\"invalid captcha\"}\n" + }, + "ssl_verify": false + } + }, + "upstream": { + "nodes": { + "127.0.0.1:1980": 1 + }, + "type": "roundrobin" + }, + "uri": "/index" + }]] + ) + + if code >= 300 then + ngx.status = code + end + ngx.say(body) + } + } +--- response_body +passed + + + +=== TEST 3: add plugin on routes +--- config + location /t { + content_by_lua_block { + local t = require("lib.test_admin").test + local code, body = t('/apisix/admin/routes/1', + ngx.HTTP_PUT, + [=[{ + "plugins": { + "recaptcha": { + "secret_key": "6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe", + "parameter_source": "header", + "parameter_name": "captcha", + "response": { + "content_type": "application/json; charset=utf-8", + "status_code": 400, + "body": "{\"message\":\"invalid captcha\"}\n" + }, + "ssl_verify": false + } + }, + "upstream": { + "nodes": { + "127.0.0.1:1980": 1 + }, + "type": "roundrobin" + }, + "uri": "/login" + }]=] + ) + if code >= 300 then + ngx.status = code + ngx.say(body) + end + + code, body = t('/apisix/admin/routes/2', + ngx.HTTP_PUT, + [=[{ + "plugins": { + "recaptcha": { + "secret_key": "6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe", + "parameter_source": "query", + "parameter_name": "captcha", + "response": { + "content_type": "application/json; charset=utf-8", + "status_code": 400, + "body": "{\"message\":\"invalid captcha\"}\n" + }, + "ssl_verify": false + } + }, + "upstream": { + "nodes": { + "127.0.0.1:1980": 1 + }, + "type": "roundrobin" + }, + "uri": "/active" + }]=] + ) + if code >= 300 then + ngx.status = code + end + + ngx.say(body) + } + } +--- response_body +passed + + + +=== TEST 4: request is terminated by recaptcha plugin 1 +--- request +POST /login +--- error_code: 400 +--- response_headers +Content-Type: application/json; charset=utf-8 +--- response_body +{"message":"invalid captcha"} + + + +=== TEST 5: request is terminated by recaptcha plugin 2 +--- request +POST /active +--- error_code: 400 +--- response_headers +Content-Type: application/json; charset=utf-8 +--- response_body +{"message":"invalid captcha"} + + + +=== TEST 6: recaptcha valid +--- request +POST /login +--- more_headers +captcha: test +--- error_code: 404 + + + +=== TEST 7: recaptcha valid +--- request +POST /active?captcha=test +--- error_code: 404 +--- no_error_log Review comment: We don't need this? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
