You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/04/18 01:15:43 UTC
[GitHub] [apisix] spacewander commented on a diff in pull request #6512: feat: support google reCAPTCHA
spacewander commented on code in PR #6512:
URL: https://github.com/apache/apisix/pull/6512#discussion_r851827827
##########
docs/en/latest/plugins/recaptcha.md:
##########
@@ -0,0 +1,126 @@
+---
+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. |
Review Comment:
The ssl_verify does not just verify the hostname...
##########
apisix/plugins/recaptcha.lua:
##########
@@ -0,0 +1,103 @@
+--
+-- 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.
+--
+local core = require("apisix.core")
+local http = require("resty.http")
+local ngx = ngx
+
+local schema = {
+ type = "object",
+ properties = {
+ secret_key = { type = "string" },
+ parameter_source = { type = "string", default = "header", enum = { "header", "query" } },
+ parameter_name = { type = "string", default = "captcha" },
+ ssl_verify = { type = "boolean", default = true },
+ response = {
+ type = "object",
+ properties = {
+ content_type = { type = "string", default = "application/json; charset=utf-8" },
+ status_code = { type = "number", default = 400 },
+ body = { type = "string", default = '{"message": "invalid captcha"}' }
+ }
+ },
+ },
+ required = { "secret_key" },
+}
+
+local recaptcha_url = "https://www.recaptcha.net"
+
+local _M = {
+ version = 0.1,
+ priority = 700,
+ name = "recaptcha",
+ schema = schema,
+}
+
+function _M.check_schema(conf)
+ return core.schema.check(schema, conf)
+end
+
+
+local function retrieve_captcha(ctx, conf)
+ if conf.parameter_source == "header" then
+ return core.request.header(ctx, conf.parameter_name)
+ end
+
+ if conf.parameter_source == "query" then
+ local uri_args = core.request.get_uri_args(ctx) or {}
+ return uri_args[conf.parameter_name]
+ end
+end
+
+
+function _M.access(conf, ctx)
+ local invalid_captcha = true
+ local captcha = retrieve_captcha(ctx, conf)
+ if captcha ~= nil and captcha ~= "" then
+ local httpc = http.new()
+ local secret = conf.secret_key
+ local remote_ip = core.request.get_remote_client_ip(ctx)
+ local res, err = httpc:request_uri(recaptcha_url .. "/recaptcha/api/siteverify", {
+ method = "POST",
+ body = ngx.encode_args({ secret = secret, response = captcha, remoteip = remote_ip }),
+ headers = {
+ ["Content-Type"] = "application/x-www-form-urlencoded",
+ },
+ ssl_verify = conf.ssl_verify
+ })
+ if not res then
+ core.log.error("request failed: ", err)
+ return 503
+ end
+ core.log.debug("recaptcha verify result: ", res.body)
+ local recaptcha_result, err = core.json.decode(res.body)
+ if err then
+ core.log.error("failed to decode the recaptcha response json: ", err)
Review Comment:
We need to return from here as the recaptcha_result is nil.
And please add a test to cover 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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org