-
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 forward-auth plugin #6037
Merged
Merged
Changes from all commits
Commits
Show all changes
40 commits
Select commit
Hold shift + click to select a range
98d9671
feat: add forward auth plugin
bzp2010 da4c5ef
test: add get uri case
bzp2010 8525a76
feat: support client_headers
bzp2010 868fced
test: add forward-auth case
bzp2010 1060fcb
test: add plugin list
bzp2010 1a14ab1
feat: add default plugin list
bzp2010 5952350
fix: description typo
bzp2010 ea6d529
test: remove unused code
bzp2010 24882f8
fix: typo
bzp2010 eeaf575
docs: add forward-auth document
bzp2010 bf5ade0
feat: improve config check
bzp2010 e31e6da
docs: fix lint
bzp2010 4209f5a
Merge remote-tracking branch 'upstream/master' into feat-forward-auth
bzp2010 c2257c4
docs: add category
bzp2010 7ce1bac
fix: lint
bzp2010 e9d1fa6
fix: lint
bzp2010 18db978
feat: remove unused code
bzp2010 211c37f
docs: fix typo
bzp2010 8a853d3
feat: ignore client X headers
bzp2010 a84ddf9
docs: remove unused code
bzp2010 67b1a7e
docs: improve document
bzp2010 a4b05d9
fix: wrong code push
bzp2010 6c73cbd
test: improve too long codes
bzp2010 3df3ba5
test: fix typo
bzp2010 63811b5
test: add ignore client X-Forwarded headers case
bzp2010 ac3ae02
test: improve ignore client X-Forwarded headers case
bzp2010 8fef52c
feat: remove get uri
bzp2010 07eb935
chore: change http client error check
bzp2010 4fb97f7
test: split single line of long code
bzp2010 868fa43
feat: reverse request_headers and client_headers meaning
bzp2010 01f33f2
test: add headers logger
bzp2010 53f736b
test: add no upsteam_headers and client_headers case
bzp2010 6c6304c
test: remove headers logger
bzp2010 96a23ba
chore: remove default GET method
bzp2010 ba64f8f
chore: change error check
bzp2010 9565348
docs: update outdatad desc
bzp2010 beea582
test: extend APISIX generated headers check
bzp2010 c49890f
docs: add data definitions
bzp2010 a83e2b9
docs: add more data desc
bzp2010 8d11c22
docs: fix lint
bzp2010 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,140 @@ | ||
-- | ||
-- 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 service" | ||
}, | ||
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 authorizing failed" | ||
}, | ||
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"] = ctx.var.request_uri, | ||
["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 | ||
if not auth_headers[header] then | ||
auth_headers[header] = core.request.header(ctx, header) | ||
end | ||
end | ||
end | ||
|
||
local params = { | ||
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 then | ||
core.log.error("failed to process forward auth, err: ", err) | ||
return 403 | ||
end | ||
|
||
if res.status >= 300 then | ||
local client_headers = {} | ||
|
||
if #conf.client_headers > 0 then | ||
for _, header in ipairs(conf.client_headers) do | ||
client_headers[header] = res.headers[header] | ||
end | ||
end | ||
|
||
core.response.set_header(client_headers) | ||
return res.status, res.body | ||
end | ||
|
||
-- append headers that need to be get from the auth response header | ||
for _, header in ipairs(conf.upstream_headers) do | ||
local header_value = res.headers[header] | ||
if header_value then | ||
core.request.set_header(ctx, header, header_value) | ||
end | ||
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,139 @@ | ||
--- | ||
title: forward-auth | ||
--- | ||
|
||
<!-- | ||
# | ||
# 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 | ||
|
||
- [**Description**](#description) | ||
- [**Attributes**](#attributes) | ||
- [**Data Definition**](#data-definition) | ||
- [**Example**](#example) | ||
|
||
## Description | ||
|
||
The `forward-auth` plugin implements a classic external authentication model. We can implement a custom error return or user redirection to the authentication page if the authentication fails. | ||
|
||
Forward Auth cleverly moves the authentication and authorization logic to a dedicated external service, where the gateway forwards the user's request to the authentication service and blocks the original request, and replaces the result when the authentication service responds with a non-2xx status. | ||
|
||
## Attributes | ||
|
||
| Name | Type | Requirement | Default | Valid | Description | | ||
| -- | -- | -- | -- | -- | -- | | ||
| host | string | required | | | Authorization service host (eg. https://localhost:9188) | | ||
| ssl_verify | boolean | optional | true | | Whether to verify the certificate | | ||
| request_headers | array[string] | optional | | | `client` request header that will be sent to the `authorization` service. When it is not set, no `client` request headers are sent to the `authorization` service, except for those provided by APISIX (X-Forwarded-XXX). | | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's provide a list of the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. the |
||
| upstream_headers | array[string] | optional | | | `authorization` service response header that will be sent to the `upstream`. When it is not set, will not forward the `authorization` service response header to the `upstream`. | | ||
| client_headers | array[string] | optional | | | `authorization` response header that will be sent to the `client` when authorize failure. When it is not set, will not forward the `authorization` service response header to the `client`. | | ||
| timeout | integer | optional | 3000ms | [1, 60000]ms | Authorization service HTTP call timeout | | ||
| keepalive | boolean | optional | true | | HTTP keepalive | | ||
| keepalive_timeout | integer | optional | 60000ms | [1000, ...]ms | keepalive idle timeout | | ||
| keepalive_pool | integer | optional | 5 | [1, ...]ms | Connection pool limit | | ||
|
||
## Data Definition | ||
|
||
The request headers in the following list will have APISIX generated and sent to the `authorization` service. | ||
|
||
| Scheme | HTTP Method | Host | URI | Source IP | | ||
| -- | -- | -- | -- | -- | | ||
| X-Forwarded-Proto | X-Forwarded-Method | X-Forwarded-Host | X-Forwarded-Uri | X-Forwarded-For | | ||
|
||
## Example | ||
|
||
First, you need to setup an external authorization service. Here is an example of using Apache APISIX's serverless plugin to mock. | ||
|
||
```shell | ||
$ curl -X PUT 'http://127.0.0.1:9080/apisix/admin/routes/auth' \ | ||
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' \ | ||
-H 'Content-Type: application/json' \ | ||
-d '{ | ||
"uri": "/auth", | ||
"plugins": { | ||
"serverless-pre-function": { | ||
"phase": "rewrite", | ||
"functions": [ | ||
"return function (conf, ctx) local core = require(\"apisix.core\"); local authorization = core.request.header(ctx, \"Authorization\"); if authorization == \"123\" then core.response.exit(200); elseif authorization == \"321\" then core.response.set_header(\"X-User-ID\", \"i-am-user\"); core.response.exit(200); else core.response.set_header(\"Location\", \"http://example.com/auth\"); core.response.exit(403); end end" | ||
] | ||
} | ||
} | ||
}' | ||
``` | ||
|
||
Next, we create a route for testing. | ||
|
||
```shell | ||
$ curl -X PUT http://127.0.0.1:9080/apisix/admin/routes/1 | ||
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' | ||
-d '{ | ||
"uri": "/headers", | ||
"plugins": { | ||
"forward-auth": { | ||
"host": "http://127.0.0.1:9080/auth", | ||
"request_headers": ["Authorization"], | ||
"upstream_headers": ["X-User-ID"], | ||
"client_headers": ["Location"] | ||
} | ||
}, | ||
"upstream": { | ||
"nodes": { | ||
"httpbin.org:80": 1 | ||
}, | ||
"type": "roundrobin" | ||
} | ||
}' | ||
``` | ||
|
||
We can perform the following three tests. | ||
|
||
1. **request_headers** Send Authorization header from `client` to `authorization` service | ||
|
||
```shell | ||
$ curl http://127.0.0.1:9080/headers -H 'Authorization: 123' | ||
{ | ||
"headers": { | ||
"Authorization": "123", | ||
"Next": "More-headers" | ||
} | ||
} | ||
``` | ||
|
||
2. **upstream_headers** Send `authorization` service response header to the `upstream` | ||
|
||
```shell | ||
$ curl http://127.0.0.1:9080/headers -H 'Authorization: 321' | ||
{ | ||
"headers": { | ||
"Authorization": "321", | ||
"X-User-ID": "i-am-user", | ||
"Next": "More-headers" | ||
} | ||
} | ||
``` | ||
|
||
3. **client_headers** Send `authorization` service response header to `client` when authorizing failed | ||
|
||
```shell | ||
$ curl -i http://127.0.0.1:9080/headers | ||
HTTP/1.1 403 Forbidden | ||
Location: http://example.com/auth | ||
``` | ||
|
||
Finally, you can disable the `forward-auth` plugin by removing it from the route. |
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 |
---|---|---|
|
@@ -83,6 +83,7 @@ basic-auth | |
jwt-auth | ||
key-auth | ||
consumer-restriction | ||
forward-auth | ||
opa | ||
authz-keycloak | ||
proxy-mirror | ||
|
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.
Look like we can't support forward no headers from the client?
If this field is empty, all headers are forwarded. What about don't provide a default value? (Use empty array if no headers are need)
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.
I think it's rightfully so, and that's an oversight on my part. I have reversed the meaning of
request_headers
andclient_headers
, if the user does not set this parameter, APISIX will send nothing.