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/06/12 06:03:19 UTC
[GitHub] [incubator-apisix] membphis commented on a change in pull request #1701: Authorization Plugin for Keycloak Identity Server
membphis commented on a change in pull request #1701:
URL: https://github.com/apache/incubator-apisix/pull/1701#discussion_r439221876
##########
File path: apisix/plugins/authz-keycloak.lua
##########
@@ -0,0 +1,128 @@
+--
+-- 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 sub_str = string.sub
+local plugin_name = "authz-keycloak"
+local url = require "net.url"
+local tostring = tostring
+
+
+local schema = {
+ type = "object",
+ properties = {
+ token_endpoint = {type = "string"},
+ permissions = {type = "string"},
+ grant_type = {
+ type = "string",
+ default="urn:ietf:params:oauth:grant-type:uma-ticket"
+ },
+ audience = {type = "string"},
+ timeout = {type = "integer", minimum = 1, default = 3},
+ enforcement_mode = {
+ type = "string",
+ enum = {"ENFORCING", "PERMISSIVE"},
+ default = "ENFORCING"
+ }
+ },
+ required = {"token_endpoint"}
+}
+
+
+local _M = {
+ version = 0.1,
+ priority = 2000,
+ type = 'auth',
+ name = plugin_name,
+ schema = schema,
+}
+
+function _M.check_schema(conf)
+ local ok, err = core.schema.check(schema, conf)
+ if not ok then
+ return false, err
+ end
+
+ return true
+end
+
+
+local function evaluate_permissions(conf, token)
+ local url_decoded = url.parse(conf.token_endpoint)
+ local host = url_decoded.host
+ local port = url_decoded.port
+
+ if ((not port) and url_decoded.scheme == "https") then
+ port = 443
+ elseif not port then
+ port = 80
+ end
+
+ local httpc = http.new()
+ local httpc_res, httpc_err = httpc:request_uri(conf.token_endpoint, {
+ method = "POST",
+ body = "grant_type=" .. conf.grant_type .. "&audience="
+ .. conf.audience .. "&permission=" .. conf.permissions .. "&response_mode=decision",
+ headers = {
+ ["Content-Type"] = "application/x-www-form-urlencoded",
+ ["Authorization"] = token
+ },
+ keepalive_timeout = 60000,
+ keepalive_pool = 5
+ })
+
+ if not httpc_res then
+ core.response.exit(500, httpc_err)
Review comment:
we need to write the error log first
```
core.log.error(...)
core.response.exit(500, ...)
return
```
##########
File path: apisix/plugins/authz-keycloak.lua
##########
@@ -0,0 +1,128 @@
+--
+-- 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 sub_str = string.sub
+local plugin_name = "authz-keycloak"
+local url = require "net.url"
+local tostring = tostring
+
+
+local schema = {
+ type = "object",
+ properties = {
+ token_endpoint = {type = "string"},
+ permissions = {type = "string"},
Review comment:
ditoo ?
##########
File path: apisix/plugins/authz-keycloak.lua
##########
@@ -0,0 +1,128 @@
+--
+-- 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 sub_str = string.sub
+local plugin_name = "authz-keycloak"
+local url = require "net.url"
+local tostring = tostring
+
+
+local schema = {
+ type = "object",
+ properties = {
+ token_endpoint = {type = "string"},
+ permissions = {type = "string"},
+ grant_type = {
+ type = "string",
+ default="urn:ietf:params:oauth:grant-type:uma-ticket"
+ },
+ audience = {type = "string"},
+ timeout = {type = "integer", minimum = 1, default = 3},
+ enforcement_mode = {
+ type = "string",
+ enum = {"ENFORCING", "PERMISSIVE"},
+ default = "ENFORCING"
+ }
+ },
+ required = {"token_endpoint"}
+}
+
+
+local _M = {
+ version = 0.1,
+ priority = 2000,
+ type = 'auth',
+ name = plugin_name,
+ schema = schema,
+}
+
+function _M.check_schema(conf)
+ local ok, err = core.schema.check(schema, conf)
+ if not ok then
+ return false, err
+ end
+
+ return true
+end
+
+
+local function evaluate_permissions(conf, token)
+ local url_decoded = url.parse(conf.token_endpoint)
+ local host = url_decoded.host
+ local port = url_decoded.port
+
+ if ((not port) and url_decoded.scheme == "https") then
+ port = 443
+ elseif not port then
+ port = 80
+ end
+
+ local httpc = http.new()
+ local httpc_res, httpc_err = httpc:request_uri(conf.token_endpoint, {
+ method = "POST",
+ body = "grant_type=" .. conf.grant_type .. "&audience="
+ .. conf.audience .. "&permission=" .. conf.permissions .. "&response_mode=decision",
+ headers = {
+ ["Content-Type"] = "application/x-www-form-urlencoded",
+ ["Authorization"] = token
+ },
+ keepalive_timeout = 60000,
+ keepalive_pool = 5
+ })
+
+ if not httpc_res then
+ core.response.exit(500, httpc_err)
+ core.log.error("error while sending authz request to [" .. host .. "] port["
+ .. tostring(port) .. "] " .. httpc_err)
+ return
+ end
+
+ if httpc_res.status >= 400 then
+ core.log.error("status code: " .. httpc_res.status .. " msg: ".. httpc_res.body)
+ core.response.exit(httpc_res.status, httpc_res.body)
+ end
+end
+
+
+local function fetch_jwt_token(ctx)
+ local token = core.request.header(ctx, "authorization")
+ if token then
Review comment:
bad style, here is the good one:
```
if not token then
return nil, "authorization header not available"
end
local prefix = sub_str(token, 1, 7)
...
return token
```
##########
File path: apisix/plugins/authz-keycloak.lua
##########
@@ -0,0 +1,128 @@
+--
+-- 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 sub_str = string.sub
+local plugin_name = "authz-keycloak"
+local url = require "net.url"
+local tostring = tostring
+
+
+local schema = {
+ type = "object",
+ properties = {
+ token_endpoint = {type = "string"},
+ permissions = {type = "string"},
+ grant_type = {
+ type = "string",
+ default="urn:ietf:params:oauth:grant-type:uma-ticket"
+ },
+ audience = {type = "string"},
+ timeout = {type = "integer", minimum = 1, default = 3},
+ enforcement_mode = {
+ type = "string",
+ enum = {"ENFORCING", "PERMISSIVE"},
+ default = "ENFORCING"
+ }
+ },
+ required = {"token_endpoint"}
+}
+
+
+local _M = {
+ version = 0.1,
+ priority = 2000,
+ type = 'auth',
+ name = plugin_name,
+ schema = schema,
+}
+
+function _M.check_schema(conf)
+ local ok, err = core.schema.check(schema, conf)
+ if not ok then
+ return false, err
+ end
+
+ return true
+end
+
+
+local function evaluate_permissions(conf, token)
+ local url_decoded = url.parse(conf.token_endpoint)
+ local host = url_decoded.host
+ local port = url_decoded.port
+
+ if ((not port) and url_decoded.scheme == "https") then
+ port = 443
+ elseif not port then
+ port = 80
+ end
+
+ local httpc = http.new()
+ local httpc_res, httpc_err = httpc:request_uri(conf.token_endpoint, {
+ method = "POST",
+ body = "grant_type=" .. conf.grant_type .. "&audience="
Review comment:
that is unsafe. please take a look at this doc:
https://github.com/openresty/lua-nginx-module#ngxencode_args
##########
File path: apisix/plugins/authz-keycloak.lua
##########
@@ -0,0 +1,128 @@
+--
+-- 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 sub_str = string.sub
+local plugin_name = "authz-keycloak"
+local url = require "net.url"
+local tostring = tostring
+
+
+local schema = {
+ type = "object",
+ properties = {
+ token_endpoint = {type = "string"},
+ permissions = {type = "string"},
+ grant_type = {
+ type = "string",
+ default="urn:ietf:params:oauth:grant-type:uma-ticket"
+ },
+ audience = {type = "string"},
+ timeout = {type = "integer", minimum = 1, default = 3},
+ enforcement_mode = {
+ type = "string",
+ enum = {"ENFORCING", "PERMISSIVE"},
+ default = "ENFORCING"
+ }
+ },
+ required = {"token_endpoint"}
+}
+
+
+local _M = {
+ version = 0.1,
+ priority = 2000,
+ type = 'auth',
+ name = plugin_name,
+ schema = schema,
+}
+
+function _M.check_schema(conf)
+ local ok, err = core.schema.check(schema, conf)
+ if not ok then
+ return false, err
+ end
+
+ return true
+end
+
+
+local function evaluate_permissions(conf, token)
+ local url_decoded = url.parse(conf.token_endpoint)
+ local host = url_decoded.host
+ local port = url_decoded.port
+
+ if ((not port) and url_decoded.scheme == "https") then
+ port = 443
+ elseif not port then
+ port = 80
+ end
+
+ local httpc = http.new()
+ local httpc_res, httpc_err = httpc:request_uri(conf.token_endpoint, {
+ method = "POST",
+ body = "grant_type=" .. conf.grant_type .. "&audience="
+ .. conf.audience .. "&permission=" .. conf.permissions .. "&response_mode=decision",
+ headers = {
+ ["Content-Type"] = "application/x-www-form-urlencoded",
+ ["Authorization"] = token
+ },
+ keepalive_timeout = 60000,
+ keepalive_pool = 5
+ })
+
+ if not httpc_res then
+ core.response.exit(500, httpc_err)
+ core.log.error("error while sending authz request to [" .. host .. "] port["
Review comment:
String concatenation should be avoided here.
that is the good style: `core.log.error("xxx", "bb", "c")`
##########
File path: apisix/plugins/authz-keycloak.lua
##########
@@ -0,0 +1,128 @@
+--
+-- 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 sub_str = string.sub
+local plugin_name = "authz-keycloak"
+local url = require "net.url"
+local tostring = tostring
+
+
+local schema = {
+ type = "object",
+ properties = {
+ token_endpoint = {type = "string"},
Review comment:
I think we need to limit his maximum and minimum length.
##########
File path: apisix/plugins/authz-keycloak.lua
##########
@@ -0,0 +1,128 @@
+--
+-- 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 sub_str = string.sub
+local plugin_name = "authz-keycloak"
+local url = require "net.url"
+local tostring = tostring
+
+
+local schema = {
+ type = "object",
+ properties = {
+ token_endpoint = {type = "string"},
+ permissions = {type = "string"},
+ grant_type = {
+ type = "string",
+ default="urn:ietf:params:oauth:grant-type:uma-ticket"
+ },
+ audience = {type = "string"},
+ timeout = {type = "integer", minimum = 1, default = 3},
Review comment:
It is recommended to use milliseconds here. So the default value should be 3000 .
----------------------------------------------------------------
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