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/01/07 01:44:34 UTC
[GitHub] [apisix] shuaijinchao commented on a change in pull request #6037: feat: add forward-auth plugin
shuaijinchao commented on a change in pull request #6037:
URL: https://github.com/apache/apisix/pull/6037#discussion_r779975193
##########
File path: apisix/plugins/forward-auth.lua
##########
@@ -0,0 +1,145 @@
+--
+-- 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 schema = {
+ type = "object",
+ properties = {
+ host = {type = "string"},
+ ssl_verify = {
+ type = "boolean",
+ default = true,
+ },
+ request_headers = {
+ type = "array",
+ default = {},
+ items = {type = "string"},
+ description = "client request header that will be sent to the authorization"
+ },
+ upstream_headers = {
+ type = "array",
+ default = {},
+ items = {type = "string"},
+ description = "authorization response header that will be sent to the upstream"
+ },
+ client_headers = {
+ type = "array",
+ default = {},
+ items = {type = "string"},
+ description = "authorization response header that will be sent to"
+ .. "the client when authorize failure"
+ },
+ timeout = {
+ type = "integer",
+ minimum = 1,
+ maximum = 60000,
+ default = 3000,
+ description = "timeout in milliseconds",
+ },
+ keepalive = {type = "boolean", default = true},
+ keepalive_timeout = {type = "integer", minimum = 1000, default = 60000},
+ keepalive_pool = {type = "integer", minimum = 1, default = 5},
+ },
+ required = {"host"}
+}
+
+
+local _M = {
+ version = 0.1,
+ priority = 2002,
+ name = "forward-auth",
+ schema = schema,
+}
+
+
+function _M.check_schema(conf)
+ return core.schema.check(schema, conf)
+end
+
+
+function _M.access(conf, ctx)
+ local auth_headers = {
+ ["X-Forwarded-Proto"] = core.request.get_scheme(ctx),
+ ["X-Forwarded-Method"] = core.request.get_method(),
+ ["X-Forwarded-Host"] = core.request.get_host(ctx),
+ ["X-Forwarded-Uri"] = core.request.get_uri(ctx),
+ ["X-Forwarded-For"] = core.request.get_remote_client_ip(ctx),
+ }
+
+ -- append headers that need to be get from the client request header
+ if #conf.request_headers > 0 then
+ for _, header in ipairs(conf.request_headers) do
+ auth_headers[header] = core.request.header(ctx, header)
+ end
+ else
+ auth_headers = core.table.merge(core.request.headers(), auth_headers)
+ end
+
+ local params = {
+ method = "GET",
Review comment:
Should the request method be mapped to the client request method?
##########
File path: apisix/plugins/forward-auth.lua
##########
@@ -0,0 +1,145 @@
+--
+-- 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 schema = {
+ type = "object",
+ properties = {
+ host = {type = "string"},
+ ssl_verify = {
+ type = "boolean",
+ default = true,
+ },
+ request_headers = {
+ type = "array",
+ default = {},
+ items = {type = "string"},
+ description = "client request header that will be sent to the authorization"
+ },
+ upstream_headers = {
+ type = "array",
+ default = {},
+ items = {type = "string"},
+ description = "authorization response header that will be sent to the upstream"
+ },
+ client_headers = {
+ type = "array",
+ default = {},
+ items = {type = "string"},
+ description = "authorization response header that will be sent to"
+ .. "the client when authorize failure"
+ },
+ timeout = {
+ type = "integer",
+ minimum = 1,
+ maximum = 60000,
+ default = 3000,
+ description = "timeout in milliseconds",
+ },
+ keepalive = {type = "boolean", default = true},
+ keepalive_timeout = {type = "integer", minimum = 1000, default = 60000},
+ keepalive_pool = {type = "integer", minimum = 1, default = 5},
+ },
+ required = {"host"}
+}
+
+
+local _M = {
+ version = 0.1,
+ priority = 2002,
+ name = "forward-auth",
+ schema = schema,
+}
+
+
+function _M.check_schema(conf)
+ return core.schema.check(schema, conf)
+end
+
+
+function _M.access(conf, ctx)
+ local auth_headers = {
+ ["X-Forwarded-Proto"] = core.request.get_scheme(ctx),
+ ["X-Forwarded-Method"] = core.request.get_method(),
+ ["X-Forwarded-Host"] = core.request.get_host(ctx),
+ ["X-Forwarded-Uri"] = core.request.get_uri(ctx),
+ ["X-Forwarded-For"] = core.request.get_remote_client_ip(ctx),
+ }
+
+ -- append headers that need to be get from the client request header
+ if #conf.request_headers > 0 then
+ for _, header in ipairs(conf.request_headers) do
+ auth_headers[header] = core.request.header(ctx, header)
+ end
+ else
+ auth_headers = core.table.merge(core.request.headers(), auth_headers)
+ end
+
+ local params = {
+ method = "GET",
+ headers = auth_headers,
+ keepalive = conf.keepalive,
+ ssl_verify = conf.ssl_verify
+ }
+
+ if conf.keepalive then
+ params.keepalive_timeout = conf.keepalive_timeout
+ params.keepalive_pool = conf.keepalive_pool
+ end
+
+ local httpc = http.new()
+ httpc:set_timeout(conf.timeout)
+
+ local res, err = httpc:request_uri(conf.host, params)
+
+ -- block by default when authorization service is unavailable
+ if not res or err then
+ core.log.error("failed to process forward auth, err: ", err)
+ return 403
+ end
Review comment:
```suggestion
if not res then
core.log.error("failed to process forward auth, err: ", err)
return 403
end
```
Would it be better to judge this way?
--
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