[GitHub] [apisix] vm-001 commented on a diff in pull request #6512: feat: support google reCAPTCHA

[GitBox <gi...@apache.org>]

vm-001 commented on code in PR #6512:
URL: https://github.com/apache/apisix/pull/6512#discussion_r850125657


##########
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:
   Sorry. It's been a while. I have some personal tasks need to work on.  I just add a successful case, Can you please help to review it?



-- 
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: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org