2019-10-31 09:27:28 +08:00
|
|
|
|
<!--
|
|
|
|
|
#
|
|
|
|
|
# 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.
|
|
|
|
|
#
|
|
|
|
|
-->
|
|
|
|
|
|
2019-07-14 09:32:22 +08:00
|
|
|
|
[English](key-auth.md)
|
2019-06-06 15:59:30 +08:00
|
|
|
|
|
|
|
|
|
# 目录
|
|
|
|
|
- [**名字**](#名字)
|
|
|
|
|
- [**属性**](#属性)
|
|
|
|
|
- [**如何启用**](#如何启用)
|
|
|
|
|
- [**测试插件**](#测试插件)
|
|
|
|
|
- [**禁用插件**](#禁用插件)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## 名字
|
|
|
|
|
|
|
|
|
|
`key-auth` 是一个认证插件,它需要与 `consumer` 一起配合才能工作。
|
|
|
|
|
|
|
|
|
|
添加 Key Authentication 到一个 `service` 或 `route`。 然后,`consumer` 将其密钥添加到查询字符串参数或标头中以验证其请求。
|
|
|
|
|
|
|
|
|
|
## 属性
|
|
|
|
|
|
|
|
|
|
* `key`: 不同的 `consumer` 对象应有不同的值,它应当是唯一的。不同 consumer 使用了相同的 `key` ,将会出现请求匹配异常。
|
|
|
|
|
|
|
|
|
|
## 如何启用
|
|
|
|
|
|
|
|
|
|
1. 创建一个 consumer 对象,并设置插件 `key-auth` 的值。
|
|
|
|
|
|
|
|
|
|
```shell
|
2019-06-19 19:14:58 +08:00
|
|
|
|
curl http://127.0.0.1:9080/apisix/admin/consumers -X PUT -d '
|
2019-06-06 15:59:30 +08:00
|
|
|
|
{
|
2019-06-19 19:14:58 +08:00
|
|
|
|
"username": "jack",
|
2019-09-03 13:53:41 +08:00
|
|
|
|
"plugins": {
|
|
|
|
|
"key-auth": {
|
2019-09-22 06:05:58 +08:00
|
|
|
|
"key": "auth-one"
|
2019-09-03 13:53:41 +08:00
|
|
|
|
}
|
|
|
|
|
}
|
2019-06-06 15:59:30 +08:00
|
|
|
|
}'
|
|
|
|
|
```
|
|
|
|
|
|
2019-09-23 06:13:06 +08:00
|
|
|
|
你可以使用浏览器打开 dashboard:`http://127.0.0.1:9080/apisix/dashboard/`,通过 web 界面来完成上面的操作,先增加一个 consumer:
|
|
|
|
|
![](../images/plugin/key-auth-1.png)
|
|
|
|
|
|
|
|
|
|
然后在 consumer 页面中添加 key-auth 插件:
|
|
|
|
|
![](../images/plugin/key-auth-2.png)
|
|
|
|
|
|
2019-06-06 15:59:30 +08:00
|
|
|
|
2. 创建 route 或 service 对象,并开启 `key-auth` 插件。
|
|
|
|
|
|
|
|
|
|
```shell
|
2019-06-19 19:14:58 +08:00
|
|
|
|
curl http://127.0.0.1:9080/apisix/admin/routes/1 -X PUT -d '
|
2019-06-06 15:59:30 +08:00
|
|
|
|
{
|
2019-09-03 13:53:41 +08:00
|
|
|
|
"methods": ["GET"],
|
|
|
|
|
"uri": "/index.html",
|
|
|
|
|
"id": 1,
|
|
|
|
|
"plugins": {
|
|
|
|
|
"key-auth": {}
|
|
|
|
|
},
|
|
|
|
|
"upstream": {
|
|
|
|
|
"type": "roundrobin",
|
|
|
|
|
"nodes": {
|
|
|
|
|
"39.97.63.215:80": 1
|
|
|
|
|
}
|
|
|
|
|
}
|
2019-06-06 15:59:30 +08:00
|
|
|
|
}'
|
|
|
|
|
```
|
|
|
|
|
|
2019-09-23 06:13:06 +08:00
|
|
|
|
## 测试插件
|
2019-06-06 15:59:30 +08:00
|
|
|
|
|
|
|
|
|
下面是一个正常通过 `key-auth` 验证的请求:
|
|
|
|
|
|
|
|
|
|
```shell
|
2019-06-06 16:27:09 +08:00
|
|
|
|
$ curl http://127.0.0.2:9080/index.html -H 'apikey: keykey' -i
|
2019-06-06 15:59:30 +08:00
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
...
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
如果当前请求没有正确设置 `apikey` ,将得到一个 `401` 的应答。
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
$ curl http://127.0.0.2:9080/index.html -i
|
|
|
|
|
HTTP/1.1 401 Unauthorized
|
|
|
|
|
...
|
|
|
|
|
{"message":"Missing API key found in request"}
|
|
|
|
|
|
|
|
|
|
$ curl http://127.0.0.2:9080/index.html -H 'apikey: abcabcabc' -i
|
|
|
|
|
HTTP/1.1 401 Unauthorized
|
|
|
|
|
...
|
|
|
|
|
{"message":"Invalid API key in request"}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## 禁用插件
|
|
|
|
|
|
|
|
|
|
当你想去掉 `key-auth` 插件的时候,很简单,在插件的配置中把对应的 `json` 配置删除即可,无须重启服务,即刻生效:
|
|
|
|
|
|
|
|
|
|
```shell
|
2019-06-06 16:27:09 +08:00
|
|
|
|
$ curl http://127.0.0.1:2379/v2/keys/apisix/routes/1 -X PUT -d value='
|
2019-06-06 15:59:30 +08:00
|
|
|
|
{
|
2019-09-03 13:53:41 +08:00
|
|
|
|
"methods": ["GET"],
|
|
|
|
|
"uri": "/index.html",
|
|
|
|
|
"id": 1,
|
|
|
|
|
"plugins": {
|
|
|
|
|
},
|
|
|
|
|
"upstream": {
|
|
|
|
|
"type": "roundrobin",
|
|
|
|
|
"nodes": {
|
|
|
|
|
"39.97.63.215:80": 1
|
|
|
|
|
}
|
|
|
|
|
}
|
2019-06-06 15:59:30 +08:00
|
|
|
|
}'
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
现在就已经移除了该插件配置,其他插件的开启和移除也是同样的方法。
|