Kong OIDC 插件教程

Kong OIDC 插件教程

kong-oidcOIDC plugin for Kong项目地址:https://gitcode.com/gh_mirrors/ko/kong-oidc

1. 项目介绍

Kong OIDC 是一个专为Kong设计的OpenID Connect插件，实现了Relying Party（RP）功能。该插件用于通过OpenID Connect Discovery和Basic Client Profile（即Authorization Code流程）对用户进行认证。它利用lua-resty-openidc库维护已认证用户的会话，提供了一种在API网关层实现身份验证的方法。

2. 项目快速启动

安装

首先确保你已经安装了Luarocks。然后执行以下命令来安装Kong OIDC插件：

luarocks install kong-oidc

设置环境变量KONG_PLUGINS以启用OIDC插件：

export KONG_PLUGINS=oidc

配置示例

配置Kong并启用OIDC插件，创建一个如下所示的配置文件：

plugins:
  - oidc

services:
  - name: my-service
    url: http://my-backend
    routes:
      - paths: 
        - /my-route

consumers:
  - username: alice

oidc:
  config:
    client_id: your_client_id
    client_secret: your_client_secret
    discovery: https://your_oidc_provider/.well-known/openid-configuration
    scope: openid email profile
    redirect_uri: http://your-kong-instance/callback

将上述配置加载到Kong:

kong migrations bootstrap
kong prepare
kong start

使用

现在，当客户端尝试访问/my-route时，它们会被重定向到OIDC提供商进行身份验证。

3. 应用案例和最佳实践

• 单点登录（SSO）: 利用Kong OIDC插件，可以轻松实现在多个服务之间的用户单点登录。
• 安全策略: 根据Userinfo Endpoint的数据设置权限控制，例如基于用户角色或属性。
• 故障转移: 配置多个OIDC提供者，以便在主提供者不可用时使用备用。

4. 典型生态项目

• Kong: API管理平台，作为OAuth2和OpenID Connect的基础。
• Keycloak: 开源的身份和访问管理系统，可以作为Kong OIDC插件的身份提供者。
• lua-resty-openidc: 提供了OpenID Connect的Lua实现，是Kong OIDC插件的核心依赖。

以上就是关于Kong OIDC插件的基本介绍、快速启动指南、应用示例以及相关生态项目的概览。希望对你构建安全的API服务有所帮助。

kong-oidcOIDC plugin for Kong项目地址:https://gitcode.com/gh_mirrors/ko/kong-oidc