Skip to main content
Version: 2.13

openid-connect

描述#

OAuth 2 / Open ID Connect（OIDC）插件为 APISIX 提供身份验证和自省功能。

属性列表#

名称类型必选项默认值有效值描述
client_idstring必须OAuth 客户端 ID
client_secretstring必须OAuth 客户端 secret
discoverystring必须身份服务器的发现端点的 URL
scopestring可选"openid"用于认证
realmstring可选"apisix"用于认证
bearer_onlyboolean可选false设置为 true 将检查请求中带有承载令牌的授权标头
logout_pathstring可选"/logout"
post_logout_redirect_uristring可选调用登出接口后想要跳转的地址
redirect_uristring可选"ngx.var.request_uri"
timeoutinteger可选3[1,...]超时时间，单位为秒
ssl_verifyboolean可选false
introspection_endpointstring可选身份服务器的令牌验证端点的 URL
introspection_endpoint_auth_methodstring可选"client_secret_basic"令牌自省的认证方法名称
public_keystring可选验证令牌的公钥
token_signing_alg_values_expectedstring可选用于对令牌进行签名的算法
set_access_token_headerboolean可选true在请求头设置访问令牌
access_token_in_authorization_headerboolean可选false当值为 true 时，将访问令牌设置在请求头参数 Authorization，否则将使用请求头参数 X-Access-Token。
set_id_token_headerboolean可选true是否将 ID 令牌设置到请求头参数 X-ID-Token
set_userinfo_headerboolean可选true是否将用户信息对象设置到请求头参数 X-Userinfo

令牌自省#

令牌自省通过针对 Oauth 2 授权服务器验证令牌来帮助验证请求。 前提条件是，您应该在身份服务器中创建受信任的客户端，并生成用于自省的有效令牌（JWT）。 下图显示了通过网关进行令牌自省的示例（成功）流程。

以下是 curl 命令，用于将插件启用到外部服务。 通过自省请求标头中提供的令牌，此路由将保护 https://httpbin.org/get（echo 服务）。

curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
    "uri":"/get",
    "plugins":{
        "proxy-rewrite":{
            "scheme":"https"
        },
        "openid-connect":{
            "client_id":"api_six_client_id",
            "client_secret":"client_secret_code",
            "discovery":"full_URL_of_the_discovery_endpoint",
            "introspection_endpoint":"full_URL_of_introspection_endpoint",
            "bearer_only":true,
            "realm":"master",
            "introspection_endpoint_auth_method":"client_secret_basic"
        }
    },
    "upstream":{
        "type":"roundrobin",
        "nodes":{
            "httpbin.org:443":1
        }
    }
}'

以下命令可用于访问新路由。

curl -i -X GET http://127.0.0.1:9080/get -H "Host: httpbin.org" -H "Authorization: Bearer {replace_jwt_token}"

当 Oauth 2 授权服务器返回结果里面除了 token 之外还有过期时间, token 将在 APISIX 中缓存直至过期。 具体细节参见：

  1. lua-resty-openidc 的文档和代码。
  2. exp 字段的定义：Introspection Response。

公钥自省#

您还可以提供 JWT 令牌的公钥来验证令牌。如果您提供了公共密钥和令牌自省端点，则将执行公共密钥工作流，而不是通过身份服务器进行验证。如果要减少额外的网络呼叫并加快过程，可以使用此方法。

以下配置显示了如何向路由添加公钥自省。

curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
    "uri":"/get",
    "plugins":{
        "proxy-rewrite":{
            "scheme":"https"
        },
        "openid-connect":{
            "client_id":"api_six_client_id",
            "client_secret":"client_secret_code",
            "discovery":"full_URL_of_the_discovery_endpoint",
            "bearer_only":true,
            "realm":"master",
            "token_signing_alg_values_expected":"RS256",
            "public_key":"-----BEGIN PUBLIC KEY-----
            {public_key}
            -----END PUBLIC KEY-----"
        }
    },
    "upstream":{
        "type":"roundrobin",
        "nodes":{
            "httpbin.org:443":1
        }
    }
}'

通过 OIDC 依赖方认证流程进行身份验证#

当一个请求在请求头或会话 Cookie 中不包含访问令牌时， 插件可以充当 OIDC 依赖方并重定向到身份提供者的授权端点以通过 OIDC 授权代码流程； 请参阅 https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth 。 一旦用户通过身份提供者进行身份验证，插件将代表用户从身份提供者获取和管理访问令牌和更多信息。 该信息当前存储在会话 Cookie 中，该插件将识别 Cookie 并使用其中的信息，以避免再次执行认证流程。

以下命令将此操作模式添加到路由：

curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
  "uri": "/get",
  "plugins": {
    "proxy-rewrite": {
      "scheme": "https"
    },
    "openid-connect": {
      "client_id": "api_six_client_id",
      "client_secret": "client_secret_code",
      "discovery": "full_URL_of_the_discovery_endpoint",
      "bearer_only": false,
      "realm": "master"
}
  },
  "upstream": {
    "type": "roundrobin",
    "nodes": {
      "httpbin.org:443": 1
    }
  }
}'

在该例子中，插件可以强制在各自配置的请求头中设置访问令牌、ID 令牌和 UserInfo 对象。

故障排除#

如果 APISIX 无法解析/连接到身份提供者，请检查/修改 DNS 设置（conf/config.yaml）。