spacewander commented on a change in pull request #6512: URL: https://github.com/apache/apisix/pull/6512#discussion_r828704807
########## File path: apisix/plugins/recaptcha.lua ########## @@ -0,0 +1,102 @@ +-- +-- 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 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, schema_type) + return core.schema.check(schema, conf) +end + +local function retrieve_captcha(ctx, conf) + local captcha + if conf.parameter_source == "header" then + captcha = core.request.header(ctx, conf.parameter_name) + elseif conf.parameter_source == "query" then + local uri_args = core.request.get_uri_args(ctx) or {} + captcha = uri_args[conf.parameter_name] + end + return captcha +end + +function _M.access(conf, ctx) + local path = ctx.var.uri + local method = core.request.get_method() + + core.log.debug("path: ", path, ", method: ", method, ", conf: ", core.json.encode(conf)) + + 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 = "secret=" .. secret .. "&response=" .. captcha .. "&remoteip=" .. remote_ip, Review comment: Let's use `ngx.encode_args` to build the body ########## File path: apisix/plugins/recaptcha.lua ########## @@ -0,0 +1,102 @@ +-- +-- 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 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, schema_type) + return core.schema.check(schema, conf) +end + +local function retrieve_captcha(ctx, conf) + local captcha + if conf.parameter_source == "header" then + captcha = core.request.header(ctx, conf.parameter_name) + elseif conf.parameter_source == "query" then + local uri_args = core.request.get_uri_args(ctx) or {} + captcha = uri_args[conf.parameter_name] + end + return captcha +end + +function _M.access(conf, ctx) + local path = ctx.var.uri + local method = core.request.get_method() + + core.log.debug("path: ", path, ", method: ", method, ", conf: ", core.json.encode(conf)) + + 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 = "secret=" .. secret .. "&response=" .. captcha .. "&remoteip=" .. remote_ip, + headers = { + ["Content-Type"] = "application/x-www-form-urlencoded", + }, + ssl_verify = conf.ssl_verify + }) + if err then + core.log.error("request failed: ", err) + return 503 + end + core.log.debug("recaptcha veirfy result: ", res.body) + local recaptcha_result = core.json.decode(res.body) Review comment: ```suggestion local recaptcha_result, err = core.json.decode(res.body) ``` Need to check the result ########## File path: t/plugin/recaptcha.t ########## @@ -0,0 +1,242 @@ +# +# 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('debug'); +repeat_each(1); +no_long_string(); +no_root_location(); +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" + } + }) + if not ok then + ngx.say(err) + end + + ngx.say("done") + } + } +--- request Review comment: It's easy to do it. Here is the script: ``` #!/usr/bin/env python # coding: utf-8 # Usage: ./simpify.py $test_filename import sys with open(sys.argv[1]) as f: lines = [l.rstrip() for l in f.readlines()] newlines = [] for i, l in enumerate(lines): if ((l == "GET /t" and lines[i-1] == "--- request") or (l == "[error]" and lines[i-1] == "--- no_error_log")): newlines = newlines[:-1] continue newlines.append(l) res = "\n".join(newlines) # print(res) with open(sys.argv[1], "w") as f: f.write(res + '\n') ``` ########## File path: docs/en/latest/plugins/recaptcha.md ########## @@ -0,0 +1,114 @@ +--- +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. +# +--> + +## Name + +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`<br />status_code = `400`<br />body = `{"message":"invalid captcha"}` | | The response of invalid recaptcha token. | Review comment: ```suggestion | response | object | optional | content_type = `application/json; charset=utf-8`<br />status_code = `400`<br />body = `{"message":"invalid captcha"}` | | The response for invalid recaptcha token. | ``` ########## File path: docs/zh/latest/plugins/recaptcha.md ########## @@ -0,0 +1,110 @@ +--- +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. +# +--> + +## 简介 Review comment: ```suggestion ## 描述 ``` ########## File path: docs/en/latest/plugins/recaptcha.md ########## @@ -0,0 +1,114 @@ +--- +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. +# +--> + +## Name Review comment: ```suggestion ## Description ``` -- 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]
