Skip to content

feat(ip-restriction): support 404 response code #12076

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Baoyuantop merged 1 commit into from
Mar 26, 2025
Merged

feat(ip-restriction): support 404 response code #12076

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion apisix/plugins/ip-restriction/init.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@ local schema = {
maxLength = 1024,
default = "Your IP address is not allowed"
},
response_code = {
type = "integer",
minimum = 403,
maximum = 404,
default = 403
},
whitelist = {
type = "array",
items = {anyOf = core.schema.ip_def},
Expand Down Expand Up @@ -108,7 +114,7 @@ function _M.restrict(conf, ctx)
end

if block then
return 403, { message = conf.message }
return conf.response_code, { message = conf.message }
end
end

Expand Down
11 changes: 6 additions & 5 deletions docs/en/latest/plugins/ip-restriction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,12 @@ Single IPs, multiple IPs or even IP ranges in CIDR notation like `10.10.10.0/24`

## Attributes

| Name | Type | Required | Default | Valid values | Description |
|-----------|---------------|----------|---------------------------------|--------------|-------------------------------------------------------------|
| whitelist | array[string] | False | | | List of IPs or CIDR ranges to whitelist. |
| blacklist | array[string] | False | | | List of IPs or CIDR ranges to blacklist. |
| message | string | False | "Your IP address is not allowed" | [1, 1024] | Message returned when the IP address is not allowed access. |
| Name | Type | Required | Default | Valid values | Description |
|---------------|---------------|----------|----------------------------------|--------------|------------------------------------------------------------------------|
| whitelist | array[string] | False | | | List of IPs or CIDR ranges to whitelist. |
| blacklist | array[string] | False | | | List of IPs or CIDR ranges to blacklist. |
| message | string | False | "Your IP address is not allowed" | [1, 1024] | Message returned when the IP address is not allowed access. |
| response_code | integer | False | 403 | [403, 404] | HTTP response code returned when the IP address is not allowed access. |

:::note

Expand Down
93 changes: 92 additions & 1 deletion t/plugin/ip-restriction.t
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ __DATA__
--- request
GET /t
--- response_body
{"message":"Your IP address is not allowed","whitelist":["10.255.254.0/24","192.168.0.0/16"]}
{"message":"Your IP address is not allowed","response_code":403,"whitelist":["10.255.254.0/24","192.168.0.0/16"]}



Expand Down Expand Up @@ -754,3 +754,94 @@ qr/string too short, expected at least 1, got 0/
GET /t
--- response_body_like eval
qr/string too long, expected at most 1024, got 1025/



=== TEST 33: set whitelist and 404 response code
--- 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": {
"ip-restriction": {
"whitelist": [
"127.0.0.0/24",
"113.74.26.106"
],
"response_code": 404
}
}
}]]
)

if code >= 300 then
ngx.status = code
end
ngx.say(body)
}
}
--- request
GET /t
--- response_body
passed



=== TEST 34: hit route and ip not in the whitelist expect 404
--- http_config
set_real_ip_from 127.0.0.1;
real_ip_header X-Forwarded-For;
--- more_headers
X-Forwarded-For: 114.114.114.114
--- request
GET /hello
--- error_code: 404
--- error_log
ip-restriction exits with http status code 404



=== TEST 35: set wrong response code
--- 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": {
"ip-restriction": {
"whitelist": [
"127.0.0.0/24",
"113.74.26.106"
],
"response_code": 409
}
}
}]]
)

ngx.say(body)
}
}
--- request
GET /t
--- response_body_like eval
qr/property \\"response_code\\" validation failed: expected 409 to be at most 404/
Loading