-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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.
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
feat: add auth plugin for casdoor #6382
Merged
Merged
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
3752e64
feat: add auth plugin for casdoor
ComradeProgrammer 6097607
fix: revisions according to review comments
ComradeProgrammer ea49e51
style: fix indents
ComradeProgrammer 4dae511
feat: support expire and add tests
ComradeProgrammer f7dd77e
fix: revision according to comments
ComradeProgrammer e2a242d
fix: fix some problems according to the comments
ComradeProgrammer 4407bb7
feat: small revisions
ComradeProgrammer d3e5ac1
fix: revision
ComradeProgrammer 9b013f8
fix: revision
ComradeProgrammer 897c7a9
fix: rebase
ComradeProgrammer aea4d1a
fix: fix spelling mistakes
ComradeProgrammer 3c61648
fix: revisions
ComradeProgrammer 07bdf00
fix: revision
ComradeProgrammer File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,173 @@ | ||
-- | ||
-- 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 session = require("resty.session") | ||
local ngx = ngx | ||
local rand = math.random | ||
local tostring = tostring | ||
|
||
|
||
local plugin_name = "authz-casdoor" | ||
local schema = { | ||
type = "object", | ||
properties = { | ||
-- Note: endpoint_addr and callback_url should not end with '/' | ||
endpoint_addr = {type = "string", pattern = "^[^%?]+[^/]$"}, | ||
client_id = {type = "string"}, | ||
client_secret = {type = "string"}, | ||
callback_url = {type = "string", pattern = "^[^%?]+[^/]$"} | ||
}, | ||
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(code, conf) | ||
local client = http.new() | ||
local url = conf.endpoint_addr .. "/api/login/oauth/access_token" | ||
local res, err = client:request_uri(url, { | ||
method = "POST", | ||
body = ngx.encode_args({ | ||
code = code, | ||
grant_type = "authorization_code", | ||
client_id = conf.client_id, | ||
client_secret = conf.client_secret | ||
}), | ||
headers = { | ||
["Content-Type"] = "application/x-www-form-urlencoded" | ||
} | ||
}) | ||
|
||
if not res then | ||
return nil, nil, err | ||
end | ||
local data, err = core.json.decode(res.body) | ||
|
||
if err or not data then | ||
err = "failed to parse casdoor response data: " .. err .. ", body: " .. res.body | ||
return nil, nil, err | ||
end | ||
|
||
if not data.access_token then | ||
return nil, nil, | ||
"failed when accessing token: no access_token contained" | ||
end | ||
-- In the reply of casdoor, setting expires_in to 0 indicates that the access_token is invalid. | ||
if not data.expires_in or data.expires_in == 0 then | ||
return nil, nil, "failed when accessing token: invalid access_token" | ||
end | ||
|
||
return data.access_token, data.expires_in, nil | ||
end | ||
|
||
leslie-tsang marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
function _M.check_schema(conf) | ||
return core.schema.check(schema, conf) | ||
end | ||
|
||
leslie-tsang marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
function _M.access(conf, ctx) | ||
local current_uri = ctx.var.uri | ||
local session_obj_read, session_present = session.open() | ||
-- step 1: check whether hits the callback | ||
local m, err = ngx.re.match(conf.callback_url, ".+//[^/]+(/.*)", "jo") | ||
if err or not m then | ||
core.log.error(err) | ||
return 503 | ||
end | ||
local real_callback_url = m[1] | ||
if current_uri == real_callback_url then | ||
if not session_present then | ||
err = "no session found" | ||
core.log.error(err) | ||
return 503 | ||
end | ||
local state_in_session = session_obj_read.data.state | ||
if not state_in_session then | ||
err = "no state found in session" | ||
core.log.error(err) | ||
return 503 | ||
end | ||
local args = core.request.get_uri_args(ctx) | ||
if not args or not args.code or not args.state then | ||
err = "failed when accessing token. Invalid code or state" | ||
core.log.error(err) | ||
return 400, err | ||
end | ||
if args.state ~= tostring(state_in_session) then | ||
err = "invalid state" | ||
core.log.error(err) | ||
return 400, err | ||
end | ||
if not args.code then | ||
err = "invalid code" | ||
core.log.error(err) | ||
return 400, err | ||
end | ||
local access_token, lifetime, err = | ||
fetch_access_token(args.code, conf) | ||
if not access_token then | ||
core.log.error(err) | ||
return 503 | ||
end | ||
local original_url = session_obj_read.data.original_uri | ||
if not original_url then | ||
err = "no original_url found in session" | ||
core.log.error(err) | ||
return 503 | ||
end | ||
local session_obj_write = session.new { | ||
cookie = {lifetime = lifetime} | ||
} | ||
session_obj_write:start() | ||
session_obj_write.data.access_token = access_token | ||
session_obj_write:save() | ||
core.response.set_header("Location", original_url) | ||
return 302 | ||
end | ||
|
||
-- step 2: check whether session exists | ||
if not (session_present and session_obj_read.data.access_token) then | ||
-- session not exists, redirect to login page | ||
local state = rand(0x7fffffff) | ||
local session_obj_write = session.start() | ||
session_obj_write.data.original_uri = current_uri | ||
session_obj_write.data.state = state | ||
session_obj_write:save() | ||
|
||
local redirect_url = conf.endpoint_addr .. "/login/oauth/authorize?" .. ngx.encode_args({ | ||
response_type = "code", | ||
scope = "read", | ||
state = state, | ||
client_id = conf.client_id, | ||
redirect_uri = conf.callback_url | ||
}) | ||
core.response.set_header("Location", redirect_url) | ||
return 302 | ||
end | ||
|
||
end | ||
|
||
return _M |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
--- | ||
title: authz-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. | ||
# | ||
--> | ||
|
||
## Description | ||
|
||
`authz-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. | ||
|
||
## Attributes | ||
|
||
| Name | Type | Requirement | Default | Valid | Description | | ||
| ----------- | ------ | ----------- | ------- | ----- | ------------------------------------------------------------ | | ||
| endpoint_addr | string | required | | | The url of casdoor. | | ||
| client_id | string | required | | | The client id in casdoor. | | ||
| client_secret | string | required | | | The client secret in casdoor. | | ||
| callback_url | string | required | | | The callback url which is used to receive state and code. | | ||
|
||
*Note: endpoint_addr and callback_url should not end with '/'* | ||
|
||
## How To Enable | ||
|
||
You can enable the plugin on any route by giving out all attributes mentioned above. | ||
|
||
### Example | ||
|
||
```shell | ||
curl "http://127.0.0.1:9080/apisix/admin/routes/1" -H "X-API-KEY: edd1c9f034335f136f87ad84b625c8f1" -X PUT -d ' | ||
{ | ||
"methods": ["GET"], | ||
"uri": "/anything/*", | ||
"plugins": { | ||
"authz-casdoor": { | ||
"endpoint_addr":"http://localhost:8000", | ||
"callback_url":"http://localhost:9080/anything/callback", | ||
"client_id":"7ceb9b7fda4a9061ec1c", | ||
"client_secret":"3416238e1edf915eac08b8fe345b2b95cdba7e04" | ||
} | ||
}, | ||
"upstream": { | ||
"type": "roundrobin", | ||
"nodes": { | ||
"httpbin.org:80": 1 | ||
} | ||
} | ||
}' | ||
|
||
``` | ||
|
||
In this example, using apisix's admin API we created a route "/anything/*" pointed to "httpbin.org:80", and with "authz-casdoor" enabled. This route is now under authentication protection of Casdoor. | ||
|
||
#### Explanations about parameters of this plugin | ||
|
||
In the configuration of "authz-casdoor" plugin we can see four parameters. | ||
|
||
The first one is "callback_url". This is exactly the callback url in OAuth2. It should be emphasized that this callback url **must belong to the "uri" you specified for the route**, for example, in this example, http://localhost:9080/anything/callback obviously belong to "/anything/*". Only by this way can the visit toward callback_url can be intercepted and utilized by the plugin(so that the plugin can get the code and state in Oauth2). The logic of callback_url is implemented completely by the plugin so that there is no need to modify the server to implement this callback. | ||
|
||
The second parameter "endpoint_addr" is obviously the url of Casdoor. The third and fourth parameters are "client_id" and "client_secret", which you can acquire from Casdoor when you register an app. | ||
|
||
#### How it works? | ||
|
||
Suppose a new user who has never visited this route before is going to visit it (http://localhost:9080/anything/d?param1=foo¶m2=bar), considering that "authz-casdoor" is enabled, this visit would be processed by "authz-casdoor" plugin first. After checking the session and confirming that this user hasn't been authenticated, the visit will be intercepted. With the original url user wants to visit kept, he will be redirected to the login page of Casdoor. | ||
|
||
After successfully logging in with username and password(or whatever method he uses), Casdoor will redirect this user to the "callback_url" with GET parameter "code" and "state" specified. Because the "callback_url" is known by the plugin, when the visit toward the "callback_url" is intercepted this time, the logic of "Authorization code Grant Flow" in Oauth2 will be triggered, which means this plugin will request the access token to confirm whether this user is really logged in. After this confirmation, this plugin will redirect this user to the original url user wants to visit, which was kept by us previously. The logged-in status will also be kept in the session. | ||
|
||
Next time this user want to visit url behind this route (for example, http://localhost:9080/anything/d), after discovering that this user has been authenticated previously, this plugin won't redirect this user anymore so that this user can visit whatever he wants under this route without being interfered. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Need a comment about why expires_in is checked?