跳到主要内容
版本:3.8.x

配置 API 身份认证

为保障安全,应只允许通过身份认证并获得授权的消费者访问 API。API7 网关提供多种插件,实现身份认证和授权。

在服务上启用的身份认证插件相当于 API 的锁,消费者凭据则是开锁的钥匙。在 API7 网关中,创建消费者需要唯一的用户名和至少一个凭据。

消费者可以使用多个不同类型的凭据,在身份认证时这些凭据具有同等作用。

前提条件​

  1. 安装 API7 企业版。
  2. 网关组中已有运行中的 API。
备注

避免在同一服务或路由上配置多个身份认证插件,以防止冲突。

为 API 启用 Key Authentication​

针对服务​

如需对服务中的所有路由使用 Key 身份认证,请在服务上启用 Key Auth 插件。

  1. 在侧边导航栏选择网关组的已发布服务,然后选择要修改的服务,例如版本为 1.0.0 的 httpbin。
  2. 在侧边导航栏选择插件,然后点击新增插件。
  3. 搜索 key-auth 插件,然后点击新增。
  4. 在对话框中完成以下操作。
  • 在 JSON 编辑器中添加以下配置。

    {
    }
  • 点击新增。

针对单个路由​

如需对特定路由使用 Key 身份认证,请在该路由上启用 Key Auth 插件,而不是在服务上启用。

  1. 在侧边导航栏选择网关组的已发布服务,然后选择要修改的服务,例如版本为 1.0.0 的 httpbin。
  2. 在已发布服务中,从侧边导航栏选择路由。
  3. 选择目标路由,例如 get-ip。
  4. 在插件字段中,点击新增插件。
  5. 搜索 key-auth 插件,然后点击新增。
  6. 在对话框中完成以下操作。
  • 在 JSON 编辑器中添加以下配置。

    {
    }
  • 点击新增。

验证 Key Authentication​

按照配置 Key Authentication 凭据创建具有 Key 身份认证凭据的消费者。

然后按照以下步骤验证 Key 身份认证。

  1. 发送不包含 apikey 请求头的请求。
curl -i "http://127.0.0.1:9080/ip"

由于未提供 Key,你会收到 HTTP/1.1 401 Unauthorized 响应,响应体如下。

{"message":"Missing API key found in request"}
  1. 发送在 apikey 请求头中包含错误 Key 的请求。
curl -i "http://127.0.0.1:9080/ip" -H "apikey: wrongkey"

由于 Key 错误,你会收到 HTTP/1.1 401 Unauthorized 响应,响应体如下。

{"message":"Invalid API key in request"}
  1. 发送在 apikey 请求头中包含正确 Key 的请求。
curl -i "http://127.0.0.1:9080/ip" -H "apikey: alice-primary-key"

请求包含正确 Key 时,你会收到 HTTP/1.1 200 OK 响应。

为 API 启用 Basic Authentication​

针对服务​

如需对服务中的所有路由使用 Basic 身份认证,请在服务上启用 Basic Auth 插件。

  1. 在侧边导航栏选择网关组的已发布服务,然后选择要修改的服务,例如版本为 1.0.0 的 httpbin。
  2. 在侧边导航栏选择插件,然后点击新增插件。
  3. 搜索 basic-auth 插件,然后点击新增。
  4. 在对话框中完成以下操作。
  • 在 JSON 编辑器中添加以下配置。

    {
    }
  • 点击新增。

验证 Basic Authentication​

按照配置 Basic Authentication 凭据创建具有 Basic 身份认证凭据的消费者。

按照以下步骤验证 Basic 身份认证。

  1. 发送请求,请求头中不包含 Basic 身份认证凭据。
curl -i "http://127.0.0.1:9080/ip"

由于未提供凭据,你会收到 HTTP/1.1 401 Unauthorized 响应,响应体如下。

{"message":"Missing authorization in request"}
  1. 发送请求,请求头中包含无效的 Basic 身份认证凭据,即用户名与密码不匹配,或用户名不存在。
curl -i "http://127.0.0.1:9080/ip" -u alice:wrong-password

由于密码与任何消费者凭据都不匹配,你会收到 HTTP/1.1 401 Unauthorized 响应,响应体如下。

{"message":"Invalid user authorization"}
  1. 发送包含正确 Basic 身份认证凭据的请求。
curl -i "http://127.0.0.1:9080/ip" -u alice:alice-password

请求包含正确凭据时,你会收到 HTTP/1.1 200 OK 响应。

为 API 启用 JWT 认证​

针对服务​

如需对服务中的所有路由使用 JWT 身份认证,请在服务上启用 JWT Auth 插件。

  1. 在侧边导航栏选择网关组的已发布服务,然后选择要修改的服务,例如版本为 1.0.0 的 httpbin。
  2. 在侧边导航栏选择插件,然后点击新增插件。
  3. 搜索 jwt-auth 插件,然后点击新增。
  4. 在对话框中完成以下操作。
  • 在 JSON 编辑器中添加以下配置。

    {
    }
  • 点击新增。

针对单个路由​

如需对特定路由使用 JWT 身份认证,请在该路由上启用 JWT Auth 插件,而不是在服务上启用。

  1. 在侧边导航栏选择网关组的已发布服务,然后选择要修改的服务,例如版本为 1.0.0 的 httpbin。
  2. 在已发布服务中,从侧边导航栏选择路由。
  3. 选择目标路由,例如 get-ip。
  4. 在插件字段中,点击新增插件。
  5. 搜索 jwt-auth 插件,然后点击新增。
  6. 在对话框中完成以下操作。
  • 在 JSON 编辑器中添加以下配置。

    {
    }
  • 点击新增。

暴露 JWT 签名端点​

本步骤用于在 API7 企业版中公开 JWT 签名端点。如果使用 HS256(默认)或 HS512 等对称算法,API7 企业版既是 JWT 签发方,也是验证方,必须完成此步骤。如果使用 RS256 或 ES256 等非对称算法,签发方和验证方可以由不同主体担任,此步骤可选。

jwt-auth 插件在 /apisix/plugin/jwt/sign 创建用于签署 JWT 的内部端点。使用 Public API 插件公开该端点。

  1. 新增名为 jwt-auth-api 的已发布服务,以及名称为 jwt-auth-api、路径为 /api7/plugin/jwt/sign 的路由。
  2. 在侧边导航栏选择插件,然后点击新增插件。
  3. 搜索 public-api 插件,然后点击新增。
  4. 在对话框中完成以下操作。
  • 在 JSON 编辑器中添加空配置。

    {
    }
  • 点击新增。

验证 JWT 认证​

按照配置 JWT 身份认证凭据创建具有 JWT 凭据的消费者。

按照以下步骤验证 JWT 身份认证。

  1. 发送不包含凭据的请求。
curl -i "http://127.0.0.1:9080/ip"

由于未提供凭据,你会收到 HTTP/1.1 401 Unauthorized 响应,响应体如下。

{"message":"Missing authorization in request"}
  1. 使用消费者 JWT 凭据中的 key 获取 JWT Token。
jwt_token=$(curl -s "http://127.0.0.1:9080/apisix/plugin/jwt/sign?key=john-jwt-key") && echo $jwt_token
  1. 向 API 发送请求,在请求头中包含 jwt_token。
curl -i "http://127.0.0.1:9080/ip" -H "Authorization: ${jwt_token}"

请求包含正确凭据时,你会收到 HTTP/1.1 200 OK 响应。

30 秒后,Token 应已过期。使用相同 Token 发送请求进行验证,你会收到 HTTP/1.1 401 Unauthorized 响应,响应体如下。

{"message":"failed to verify jwt"}

为 API 启用 HMAC 认证​

针对服务​

如需对服务中的所有路由使用 HMAC 身份认证,请在服务上启用 HMAC Auth 插件。

  1. 在侧边导航栏选择网关组的已发布服务,然后选择要修改的服务,例如版本为 1.0.0 的 httpbin。
  2. 在侧边导航栏选择插件,然后点击新增插件。
  3. 搜索 hmac-auth 插件,然后点击新增。
  4. 在对话框中完成以下操作。
  • 在 JSON 编辑器中添加以下配置。

    {
    }
  • 点击新增。

针对单个路由​

如需对特定路由使用 HMAC 身份认证,请在该路由上启用 HMAC Auth 插件,而不是在服务上启用。

  1. 在侧边导航栏选择网关组的已发布服务,然后选择要修改的服务,例如版本为 1.0.0 的 httpbin。
  2. 在已发布服务中,从侧边导航栏选择路由。
  3. 选择目标路由,例如 get-ip。
  4. 在插件字段中,点击新增插件。
  5. 搜索 hmac-auth 插件,然后点击新增。
  6. 在对话框中完成以下操作。
  • 在 JSON 编辑器中添加以下配置。

    {
    }
  • 点击新增。

验证 HMAC 认证​

按照配置 HMAC 身份认证凭据创建具有 HMAC 凭据的消费者。

按照以下步骤验证 HMAC 身份认证。

  1. 生成签名

你可以使用以下 Python 代码片段,也可以选择其他技术栈。

hmac-sig-header-gen.py
import hmac
import hashlib
import base64
from datetime import datetime, timezone
key_id = "john-key" # Key ID
secret_key = b"john-hmac-key" # Secret Key
request_method = "GET" # HTTP 方法
request_path = "/headers" # 路由 URI
algorithm= "hmac-sha256" # 可使用 allowed_algorithms 中的其他算法
# 获取 GMT 当前日期和时间
# 注意,签名会在允许的时钟偏差(默认 300 秒)后失效
# 签名失效后可以重新生成,也可以在建议的安全范围内增大
# 时钟偏差以延长有效期
gmt_time = datetime.now(timezone.utc).strftime('%a, %d %b %Y %H:%M:%S GMT')
# 按顺序构造签名字符串
# 日期和后续自定义请求头应使用小写,并以单个空格分隔,
# 即 `<key>:<space><value>`
# https://datatracker.ietf.org/doc/html/draft-cavage-http-signatures-12#section-2.1.6
signing_string = (
f"{key_id}\n"
f"{request_method} {request_path}\n"
f"date: {gmt_time}\n"
)

# 创建签名
signature = hmac.new(secret_key, signing_string.encode('utf-8'), hashlib.sha256).digest()
signature_base64 = base64.b64encode(signature).decode('utf-8')

# 构造请求头
headers = {
"Date": gmt_time,
"Authorization": (
f'Signature keyId="{key_id}",algorithm="{algorithm}",'
f'headers="@request-target date",'
f'signature="{signature_base64}"'
)
}

# 打印请求头
print(headers)

运行脚本。

python3 hmac-sig-header-gen.py
  1. 发送不包含这些请求头的请求。
curl -i "http://127.0.0.1:9080/ip"

由于未提供凭据,你会收到 HTTP/1.1 401 Unauthorized 响应,响应体如下。

{"message":"Missing authorization in request"}
  1. 向 API 发送包含这些请求头的请求。
curl -X GET "http://127.0.0.1:9080/ip" \
-H "Date: Fri, 06 Sep 2024 06:41:29 GMT" \
-H 'Authorization: Signature keyId="alice-keyid",algorithm="hmac-sha256",headers="@request-target date",signature="wWfKQvPDr0wHQ4IHdluB4IzeNZcj0bGJs2wvoCOT5rM="'

请求包含正确凭据时,你会收到 HTTP/1.1 200 OK 响应,内容类似以下示例。

{
"headers":{
"Accept": "*/*",
"Authorization": "Signature keyId=\"john-key\",aigorithm=\'hmac-sha256\",headers=\"@reques
t-target date\", signature=\'HtQm1m8kGvnVlztZ59)XokweovFqQN04Ui6P6NfzjRr4=\'"
"Date": "Tue, 24 Sep 2024 10:28:41 GMT",
"Host": "127.0.0.1",
"User-Agent":"curl/8.7.1",
"X-Amzn-Trace-Id": "Root=1-66f29481-7355340a05778cbb21e9b25a",
"X-Consumer-Username": "John",
"X-Credential-Identifier": "4130bb4a-0fdc-461d-be8d-2bba8a1e36dc",
"X-Forwarded-Host": "127.0.0.1"
}
}

相关阅读​