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 2020/10/04 05:04:14 UTC
[GitHub] [apisix] spacewander opened a new pull request #2352: feat: add referer-restriction plugin
spacewander opened a new pull request #2352:
URL: https://github.com/apache/apisix/pull/2352
### What this PR does / why we need it:
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->
### Pre-submission checklist:
* [x] Did you explain what problem does this PR solve? Or what new features have been added?
* [x] Have you added corresponding test cases?
* [ ] Have you modified the corresponding document?
* [ ] Is this PR backward compatible?
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] nic-chen commented on a change in pull request #2352: feat: add referer-restriction plugin
Posted by GitBox <gi...@apache.org>.
nic-chen commented on a change in pull request #2352:
URL: https://github.com/apache/apisix/pull/2352#discussion_r499240977
##########
File path: apisix/plugins/referer-restriction.lua
##########
@@ -0,0 +1,124 @@
+--
+-- 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 ipairs = ipairs
+local core = require("apisix.core")
+local http = require "resty.http"
+local lrucache = core.lrucache.new({
+ ttl = 300, count = 512
+})
+
+
+local schema = {
+ type = "object",
+ properties = {
+ optional = {
Review comment:
It’s still a bit confused, maybe we could use ʻallow_no_referer` or something. just a suggestion
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander commented on a change in pull request #2352: feat: add referer-restriction plugin
Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #2352:
URL: https://github.com/apache/apisix/pull/2352#discussion_r499229809
##########
File path: t/plugin/referer-restriction.t
##########
@@ -0,0 +1,189 @@
+#
+# 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';
+
+add_block_preprocessor(sub {
+ my ($block) = @_;
+
+ $block->set_value("no_error_log", "[error]");
+
+ $block;
+});
+
+repeat_each(1);
+no_long_string();
+no_root_location();
+no_shuffle();
+run_tests;
+
+__DATA__
+
+=== TEST 1: set whitelist
+--- 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,
+ [[{
+ "uri": "/hello",
+ "upstream": {
+ "type": "roundrobin",
+ "nodes": {
+ "127.0.0.1:1980": 1
+ }
+ },
+ "plugins": {
+ "referer-restriction": {
+ "whitelist": [
+ "*.xx.com",
+ "yy.com"
+ ]
+ }
+ }
+ }]]
+ )
+
+ if code >= 300 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+--- request
+GET /t
+--- response_body
+passed
+
+
+
+=== TEST 2: hit route and in the whitelist (wildcard)
+--- request
+GET /hello
+--- more_headers
+Referer: http://www.xx.com
+--- response_body
+hello world
+
+
+
+=== TEST 3: hit route and in the whitelist
+--- request
+GET /hello
+--- more_headers
+Referer: https://yy.com/am
+--- response_body
+hello world
+
+
+
+=== TEST 4: hit route and not in the whitelist
+--- request
+GET /hello
+--- more_headers
+Referer: https://www.yy.com/am
+--- error_code: 403
+
+
+
+=== TEST 5: hit route and without Referer
+--- request
+GET /hello
+--- error_code: 403
+
+
+
+=== TEST 6: set whitelist, allow Referer missing
+--- 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,
+ [[{
+ "uri": "/hello",
+ "upstream": {
+ "type": "roundrobin",
+ "nodes": {
+ "127.0.0.1:1980": 1
+ }
+ },
+ "plugins": {
+ "referer-restriction": {
+ "optional": true,
+ "whitelist": [
+ "*.xx.com",
+ "yy.com"
+ ]
+ }
+ }
+ }]]
+ )
+
+ if code >= 300 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+--- request
+GET /t
+--- response_body
+passed
+
+
+
+=== TEST 7: hit route and without Referer
+--- request
+GET /hello
+--- response_body
+hello world
+
+
+
+=== TEST 8: malformed Referer is treated as missing
+--- request
+GET /hello
+--- more_headers
+Referer: www.yy.com
+--- response_body
+hello world
+
+
+
+=== TEST 9: invalid schema
+--- config
+ location /t {
+ content_by_lua_block {
+ local plugin = require("apisix.plugins.referer-restriction")
+ local cases = {
+ "x.*",
+ "~y.xn",
+ "::1",
+ }
+ for _, c in ipairs(cases) do
+ local ok, err = plugin.check_schema({
+ whitelist = {c}
+ })
+ if ok then
+ ngx.log(ngx.ERR, c)
+ end
+ end
+ }
+ }
+--- request
+GET /t
Review comment:
@nic-chen
All tests under this file already check the error log.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] nic-chen commented on a change in pull request #2352: feat: add referer-restriction plugin
Posted by GitBox <gi...@apache.org>.
nic-chen commented on a change in pull request #2352:
URL: https://github.com/apache/apisix/pull/2352#discussion_r499239677
##########
File path: t/plugin/referer-restriction.t
##########
@@ -0,0 +1,189 @@
+#
+# 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';
+
+add_block_preprocessor(sub {
+ my ($block) = @_;
+
+ $block->set_value("no_error_log", "[error]");
+
+ $block;
+});
+
+repeat_each(1);
+no_long_string();
+no_root_location();
+no_shuffle();
+run_tests;
+
+__DATA__
+
+=== TEST 1: set whitelist
+--- 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,
+ [[{
+ "uri": "/hello",
+ "upstream": {
+ "type": "roundrobin",
+ "nodes": {
+ "127.0.0.1:1980": 1
+ }
+ },
+ "plugins": {
+ "referer-restriction": {
+ "whitelist": [
+ "*.xx.com",
+ "yy.com"
+ ]
+ }
+ }
+ }]]
+ )
+
+ if code >= 300 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+--- request
+GET /t
+--- response_body
+passed
+
+
+
+=== TEST 2: hit route and in the whitelist (wildcard)
+--- request
+GET /hello
+--- more_headers
+Referer: http://www.xx.com
+--- response_body
+hello world
+
+
+
+=== TEST 3: hit route and in the whitelist
+--- request
+GET /hello
+--- more_headers
+Referer: https://yy.com/am
+--- response_body
+hello world
+
+
+
+=== TEST 4: hit route and not in the whitelist
+--- request
+GET /hello
+--- more_headers
+Referer: https://www.yy.com/am
+--- error_code: 403
+
+
+
+=== TEST 5: hit route and without Referer
+--- request
+GET /hello
+--- error_code: 403
+
+
+
+=== TEST 6: set whitelist, allow Referer missing
+--- 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,
+ [[{
+ "uri": "/hello",
+ "upstream": {
+ "type": "roundrobin",
+ "nodes": {
+ "127.0.0.1:1980": 1
+ }
+ },
+ "plugins": {
+ "referer-restriction": {
+ "optional": true,
+ "whitelist": [
+ "*.xx.com",
+ "yy.com"
+ ]
+ }
+ }
+ }]]
+ )
+
+ if code >= 300 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+--- request
+GET /t
+--- response_body
+passed
+
+
+
+=== TEST 7: hit route and without Referer
+--- request
+GET /hello
+--- response_body
+hello world
+
+
+
+=== TEST 8: malformed Referer is treated as missing
+--- request
+GET /hello
+--- more_headers
+Referer: www.yy.com
+--- response_body
+hello world
+
+
+
+=== TEST 9: invalid schema
+--- config
+ location /t {
+ content_by_lua_block {
+ local plugin = require("apisix.plugins.referer-restriction")
+ local cases = {
+ "x.*",
+ "~y.xn",
+ "::1",
+ }
+ for _, c in ipairs(cases) do
+ local ok, err = plugin.check_schema({
+ whitelist = {c}
+ })
+ if ok then
+ ngx.log(ngx.ERR, c)
+ end
+ end
+ }
+ }
+--- request
+GET /t
Review comment:
OK
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] membphis commented on pull request #2352: feat: add referer-restriction plugin
Posted by GitBox <gi...@apache.org>.
membphis commented on pull request #2352:
URL: https://github.com/apache/apisix/pull/2352#issuecomment-704174836
@spacewander merged, many thx
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] nic-chen commented on a change in pull request #2352: feat: add referer-restriction plugin
Posted by GitBox <gi...@apache.org>.
nic-chen commented on a change in pull request #2352:
URL: https://github.com/apache/apisix/pull/2352#discussion_r499209372
##########
File path: apisix/plugins/referer-restriction.lua
##########
@@ -0,0 +1,124 @@
+--
+-- 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 ipairs = ipairs
+local core = require("apisix.core")
+local http = require "resty.http"
+local lrucache = core.lrucache.new({
+ ttl = 300, count = 512
+})
+
+
+local schema = {
+ type = "object",
+ properties = {
+ optional = {
Review comment:
may need a more meaningful name
##########
File path: t/plugin/referer-restriction.t
##########
@@ -0,0 +1,189 @@
+#
+# 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';
+
+add_block_preprocessor(sub {
+ my ($block) = @_;
+
+ $block->set_value("no_error_log", "[error]");
+
+ $block;
+});
+
+repeat_each(1);
+no_long_string();
+no_root_location();
+no_shuffle();
+run_tests;
+
+__DATA__
+
+=== TEST 1: set whitelist
+--- 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,
+ [[{
+ "uri": "/hello",
+ "upstream": {
+ "type": "roundrobin",
+ "nodes": {
+ "127.0.0.1:1980": 1
+ }
+ },
+ "plugins": {
+ "referer-restriction": {
+ "whitelist": [
+ "*.xx.com",
+ "yy.com"
+ ]
+ }
+ }
+ }]]
+ )
+
+ if code >= 300 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+--- request
+GET /t
+--- response_body
+passed
+
+
+
+=== TEST 2: hit route and in the whitelist (wildcard)
+--- request
+GET /hello
+--- more_headers
+Referer: http://www.xx.com
+--- response_body
+hello world
+
+
+
+=== TEST 3: hit route and in the whitelist
+--- request
+GET /hello
+--- more_headers
+Referer: https://yy.com/am
+--- response_body
+hello world
+
+
+
+=== TEST 4: hit route and not in the whitelist
+--- request
+GET /hello
+--- more_headers
+Referer: https://www.yy.com/am
+--- error_code: 403
+
+
+
+=== TEST 5: hit route and without Referer
+--- request
+GET /hello
+--- error_code: 403
+
+
+
+=== TEST 6: set whitelist, allow Referer missing
+--- 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,
+ [[{
+ "uri": "/hello",
+ "upstream": {
+ "type": "roundrobin",
+ "nodes": {
+ "127.0.0.1:1980": 1
+ }
+ },
+ "plugins": {
+ "referer-restriction": {
+ "optional": true,
+ "whitelist": [
+ "*.xx.com",
+ "yy.com"
+ ]
+ }
+ }
+ }]]
+ )
+
+ if code >= 300 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+--- request
+GET /t
+--- response_body
+passed
+
+
+
+=== TEST 7: hit route and without Referer
+--- request
+GET /hello
+--- response_body
+hello world
+
+
+
+=== TEST 8: malformed Referer is treated as missing
+--- request
+GET /hello
+--- more_headers
+Referer: www.yy.com
+--- response_body
+hello world
+
+
+
+=== TEST 9: invalid schema
+--- config
+ location /t {
+ content_by_lua_block {
+ local plugin = require("apisix.plugins.referer-restriction")
+ local cases = {
+ "x.*",
+ "~y.xn",
+ "::1",
+ }
+ for _, c in ipairs(cases) do
+ local ok, err = plugin.check_schema({
+ whitelist = {c}
+ })
+ if ok then
+ ngx.log(ngx.ERR, c)
+ end
+ end
+ }
+ }
+--- request
+GET /t
Review comment:
has no assert here？
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] membphis commented on pull request #2352: feat: add referer-restriction plugin
Posted by GitBox <gi...@apache.org>.
membphis commented on pull request #2352:
URL: https://github.com/apache/apisix/pull/2352#issuecomment-703274516
need to update those docs too(add reference):
https://github.com/apache/apisix/blob/master/README.md
https://github.com/apache/apisix/blob/master/doc/README.md
https://github.com/apache/apisix/blob/master/doc/_sidebar.md
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] membphis merged pull request #2352: feat: add referer-restriction plugin
Posted by GitBox <gi...@apache.org>.
membphis merged pull request #2352:
URL: https://github.com/apache/apisix/pull/2352
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander commented on pull request #2352: feat: add referer-restriction plugin
Posted by GitBox <gi...@apache.org>.
spacewander commented on pull request #2352:
URL: https://github.com/apache/apisix/pull/2352#issuecomment-704057548
@membphis
Done
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org