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/03/01 02:10:39 UTC
[GitHub] [apisix] tzssangglass commented on a change in pull request #6382: feat: add auth plugin for casdoor
tzssangglass commented on a change in pull request #6382:
URL: https://github.com/apache/apisix/pull/6382#discussion_r816387663
##########
File path: apisix/plugins/auth-casdoor.lua
##########
@@ -0,0 +1,127 @@
+--
+-- 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 cjson = require("cjson")
+local http = require("resty.http")
+local session = require("resty.session")
+local log = core.log
+
+local plugin_name = "auth-casdoor"
+local schema = {
+ type = "object",
+ properties = {
+ endpoint_addr = {type = "string", pattern = "^[^%?]+[^/]$"},
+ client_id = {type = "string"},
+ client_secret = {type = "string"},
+ callback_url = {type = "string", pattern = "^[^%?]+[^/]$"},
+ test = {type = "boolean", default = false}
+ },
+ required = {
+ "callback_url", "endpoint_addr", "client_id", "client_secret"
+ }
+}
+
+local _M = {
+ version = 0.1,
+ priority = 2559,
+ name = plugin_name,
+ schema = schema
+}
+
+local function fetch_access_token(ctx, conf)
+ local args = core.request.get_uri_args(ctx)
+ if not args or not args.code or not args.state then
+ return nil, "failed when accessing token. Invalid cofde or state"
+ end
+ local client = http.new()
+ local url = conf.endpoint_addr ..
+ "/api/login/oauth/access_token"
+
+ if conf.test then
+ url = conf.endpoint_addr ..
+ "/casdoor_fake_access_token_api"
+ end
+
+ local res, err = client:request_uri(url, {
+ method = "POST",
+ query = {
+ code = args.code,
+ grant_type = "authorization_code",
+ client_id = conf.client_id,
+ client_secret = conf.client_secret
+ }
+ })
+ if not res then return nil, err end
+ local data, err = cjson.decode(res.body)
+
+ if err or not data then return nil, err end
+
+ if not data.access_token then
+ return nil, "failed when accessing token: no access_token contained"
+ end
+
+ return data.access_token, nil
+end
+
+function _M.check_schema(conf)
+ return core.schema.check(schema, conf)
+end
+
+function _M.access(conf, ctx)
+ -- log.info("hit auth-casdoor access")
+ local current_uri = ctx.var.uri
+ local session_obj_read = session.open()
Review comment:
should we check if session exist? ref: https://github.com/bungle/lua-resty-session/issues/12#issuecomment-127621307
##########
File path: apisix/plugins/auth-casdoor.lua
##########
@@ -0,0 +1,127 @@
+--
+-- 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 cjson = require("cjson")
+local http = require("resty.http")
+local session = require("resty.session")
+local log = core.log
+
+local plugin_name = "auth-casdoor"
+local schema = {
+ type = "object",
+ properties = {
+ endpoint_addr = {type = "string", pattern = "^[^%?]+[^/]$"},
+ client_id = {type = "string"},
+ client_secret = {type = "string"},
+ callback_url = {type = "string", pattern = "^[^%?]+[^/]$"},
+ test = {type = "boolean", default = false}
+ },
+ required = {
+ "callback_url", "endpoint_addr", "client_id", "client_secret"
+ }
+}
+
+local _M = {
+ version = 0.1,
+ priority = 2559,
+ name = plugin_name,
+ schema = schema
+}
+
+local function fetch_access_token(ctx, conf)
+ local args = core.request.get_uri_args(ctx)
+ if not args or not args.code or not args.state then
+ return nil, "failed when accessing token. Invalid cofde or state"
+ end
+ local client = http.new()
+ local url = conf.endpoint_addr ..
+ "/api/login/oauth/access_token"
+
+ if conf.test then
+ url = conf.endpoint_addr ..
+ "/casdoor_fake_access_token_api"
+ end
+
+ local res, err = client:request_uri(url, {
+ method = "POST",
+ query = {
+ code = args.code,
+ grant_type = "authorization_code",
+ client_id = conf.client_id,
+ client_secret = conf.client_secret
+ }
+ })
+ if not res then return nil, err end
+ local data, err = cjson.decode(res.body)
+
+ if err or not data then return nil, err end
+
+ if not data.access_token then
+ return nil, "failed when accessing token: no access_token contained"
+ end
+
+ return data.access_token, nil
+end
+
+function _M.check_schema(conf)
+ return core.schema.check(schema, conf)
+end
+
+function _M.access(conf, ctx)
+ -- log.info("hit auth-casdoor access")
+ local current_uri = ctx.var.uri
+ local session_obj_read = session.open()
+ -- step 1: check whether hits the callback
+
+ if current_uri == conf.callback_url:match(".-//[^/]+(/.*)") then
Review comment:
```suggestion
-- step 1: check whether hits the callback
if current_uri == conf.callback_url:match(".-//[^/]+(/.*)") then
```
##########
File path: t/plugin/auth-casdoor.t
##########
@@ -0,0 +1,271 @@
+#
+# 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';
+
+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.auth-casdoor")
+ local fake_uri = "http://127.0.0.1:" .. ngx.var.server_port .. "/casdoor_fake_access_token_api"
+ local callback_url="http://127.0.0.1:" .. ngx.var.server_port .. "/anything/callback"
+ local conf = {
+ callback_url=callback_url,
+ endpoint_addr=fake_uri,
+ client_id="7ceb9b7fda4a9061ec1c",
+ client_secret="3416238e1edf915eac08b8fe345b2b95cdba7e04"
+ }
+ local ok, err = plugin.check_schema(conf)
+ if not ok then
+ ngx.say(err)
+ end
+
+ local conf2 = {
+ callback_url=callback_url.."/?code=aaa",
+ endpoint_addr=fake_uri,
+ client_id="7ceb9b7fda4a9061ec1c",
+ client_secret="3416238e1edf915eac08b8fe345b2b95cdba7e04"
+ }
+ local ok2, err2 = plugin.check_schema(conf2)
+ if ok2 then
+ ngx.say(err)
+ end
+
+ local conf3 = {
+ callback_url=callback_url,
+ endpoint_addr=fake_uri.."/",
+ client_id="7ceb9b7fda4a9061ec1c",
+ client_secret="3416238e1edf915eac08b8fe345b2b95cdba7e04"
+ }
+ local ok3, err3 = plugin.check_schema(conf3)
+ if ok3 then
+ ngx.say(err)
+ end
+
+ ngx.say("done")
+ }
+ }
+--- request
+GET /t
+--- response_body
+done
+--- no_error_log
+[error]
+
+
+
+=== TEST 2: enable plugin test redirect
+--- config
+ location /t {
+ content_by_lua_block {
+ local plugin = require("apisix.plugins.auth-casdoor")
+ local core = require("apisix.core")
+ local log = core.log
+ local t = require("lib.test_admin").test
+
+ local fake_uri = "http://127.0.0.1:" .. ngx.var.server_port
+ local callback_url="http://127.0.0.1:" .. ngx.var.server_port .. "/anything/callback"
+ local code, body = t('/apisix/admin/routes/1',
+ ngx.HTTP_PUT,
+ [[{
+ "methods": ["GET"],
+ "uri": "/anything/*",
+ "plugins": {
+ "auth-casdoor": {
+ "callback_url":"]]..callback_url..[[",
+ "endpoint_addr":"]]..fake_uri..[[",
+ "client_id":"7ceb9b7fda4a9061ec1c",
+ "client_secret":"3416238e1edf915eac08b8fe345b2b95cdba7e04",
+ "test":true
+ }
+ },
+ "upstream": {
+ "type": "roundrobin",
+ "nodes": {
+ "httpbin.org:80": 1
+ }
+ }
+ }]]
+ )
+ if not code ==200 then
+ ngx.say("failed to set up routing rule")
+ end
+
+
+ ngx.say("done")
+ }
+ }
+--- request
+GET /t
+--- response_body
+done
+--- no_error_log
+[error]
+
+
+
+=== TEST 3: test redirect
+--- config
+ location /t {
+ content_by_lua_block {
+ local plugin = require("apisix.plugins.auth-casdoor")
+ local core = require("apisix.core")
+ local log = core.log
+ local t = require("lib.test_admin").test
+
+ local code, body = t('/anything/d?param1=foo¶m2=bar',ngx.HTTP_GET,[[]])
+ if not code ==302 then
+ ngx.say("should have redirected")
+ end
+
+ ngx.say("done")
+ }
+ }
+--- request
+GET /t
+--- response_body
+done
+--- no_error_log
+[error]
+
+
+
+=== TEST 4: enable fake casdoor
+--- config
+ location /t {
+ content_by_lua_block {
+ local t = require("lib.test_admin").test
+ local code, body = t('/apisix/admin/routes/2',
+ ngx.HTTP_PUT,
+ [[{
+
+ "uri": "/casdoor_fake_access_token_api",
+ "upstream": {
+ "nodes": {
+ "127.0.0.1:1980": 1
+ },
+ "type": "roundrobin"
+ }
+ }]]
+ )
+
+ if not code == 200 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+--- request
+GET /t
+--- response_body
+passed
+--- no_error_log
+[error]
+
+
+
+=== TEST 5: test fake casdoor
+--- config
+ location /t {
+ content_by_lua_block {
+ local plugin = require("apisix.plugins.auth-casdoor")
+ local core = require("apisix.core")
+ local log = core.log
+ local t = require("lib.test_admin").test
+ local httpc= require("resty.http").new()
+ local cjson = require("cjson")
+ local fake_uri = "http://127.0.0.1:" .. ngx.var.server_port .. "/casdoor_fake_access_token_api"
+
+
+ local res, err = httpc:request_uri(fake_uri, {method = "GET"})
+ if not res then
+ ngx.say(err)
+ end
+
+ local data = cjson.decode(res.body)
+ if not data then
+ ngx.say("invalid res.body")
+ end
+
+ if not data.access_token=="aaaaaaaaaaaaaaaa" then
+ ngx.say("invalid token")
+ end
+ ngx.say("done")
+ }
+ }
+--- request
+GET /t
+--- response_body
+done
+--- no_error_log
+[error]
+
+
+
+=== TEST 6: test code handling
+--- config
+ location /t {
+ content_by_lua_block {
+ local plugin = require("apisix.plugins.auth-casdoor")
+ local core = require("apisix.core")
+ local log = core.log
+ local t = require("lib.test_admin").test
+ local cjson = require("cjson")
+ local fake_uri = "http://127.0.0.1:" .. ngx.var.server_port .. "/anything/d?param1=foo¶m2=bar"
+ local callback_url="http://127.0.0.1:" .. ngx.var.server_port .. "/anything/callback?code=aaa&state=bbb"
+
+
+ local httpc= require("resty.http").new()
+ local res1, err1 = httpc:request_uri(fake_uri, {method = "GET"})
+ if not res1 then
+ ngx.say(err1)
+ end
+
+ local cookie = res1.headers["Set-Cookie"]
+
+
+ local res2,err2=httpc:request_uri(callback_url, {
Review comment:
```suggestion
local res2,err2 = httpc:request_uri(callback_url, {
```
Please pay more attention to similar formatting issues in this PR.
##########
File path: docs/en/latest/plugins/auth-casdoor.md
##########
@@ -0,0 +1,93 @@
+---
+title: auth-casdoor
+---
+
+<!--
+#
+# 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.
+#
+-->
+
+## Summary
+
+- [**Name**](#name)
+- [**Attributes**](#attributes)
+- [**Metadata**](#metadata)
+- [**How To Enable**](#how-to-enable)
+- [**Test Plugin**](#test-plugin)
+- [**Disable Plugin**](#disable-plugin)
+- [**Examples**](#examples)
+
+## Name
+
+`auth-casdoor` is an authorization plugin based on [Casdoor](https://casdoor.org/). Casdoor is a centralized authentication / Single-Sign-On (SSO) platform supporting OAuth 2.0, OIDC and SAML, integrated with Casbin RBAC and ABAC permission management
Review comment:
```suggestion
`auth-casdoor` is an authorization plugin based on [Casdoor](https://casdoor.org/). Casdoor is a centralized authentication / Single-Sign-On (SSO) platform supporting OAuth 2.0, OIDC and SAML, integrated with Casbin RBAC and ABAC permission management.
```
--
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