Nokia's Kong OIDC插件安装与配置指南

Nokia's Kong OIDC插件安装与配置指南

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

---

1. 目录结构及介绍

Nokia的kong-oidc插件在GitHub上的仓库展示了一个清晰的组织结构，用于实现OpenID Connect（OIDC）功能于Kong API网关中。下面是其主要的目录组成部分及其简介：

• 根目录：
  • LICENSE: 许可证文件，说明了软件使用的Apache-2.0许可条款。
  • README.md: 快速入门指南，包括插件的功能概述、依赖项、安装方法等。
  • kong/plugins/oidc: 包含主要的插件源代码，是实现OIDC逻辑的核心部分。
  • spec/plugins/oidc: 规范测试文件，确保插件按预期工作。
  • test: 测试目录，包含了单元测试相关的脚本和配置。
  • env, gitignore, luacov, travis.yml: 这些文件分别是环境变量设置、Git忽略规则、Lua代码覆盖率工具配置以及Travis CI的构建配置文件。

2. 项目的启动文件介绍

这个插件本身并不直接控制Kong服务的启动，它通过Kong的插件机制集成进Kong环境中。Kong的启动通常是由Kong的主进程管理，例如通过kong start命令执行。然而，要使kong-oidc生效，你需要修改或添加Kong的配置来加载该插件。

如果你需要为Kong启用此插件并进行配置，可以通过编辑Kong的配置文件(kong.conf)来指定插件，并通过API或配置文件的方式为特定的服务或全局启用之。

3. 项目的配置文件介绍

虽然项目本身不直接提供一个配置文件让你编辑以启动插件，但你可以通过Kong的配置系统来设置kong-oidc插件的运行参数。这些配置通常通过环境变量或者Kong的配置文件中的插件部分来完成。

当通过Kong的API或者配置文件添加kong-oidc插件时，典型的配置参数包括但不限于：

• client_id: 客户端ID，必须提供的OIDC客户端标识符。
• client_secret: 客户端秘密，同样必须，用于验证与OIDC提供商的交互。
• discovery: 发现端点URL，用于自动发现OIDC提供商的配置信息。
• scope: 范围，一般至少包含openid。
• ssl_verify: 是否开启SSL验证，默认关闭。
• 还有其他高级配置如session_secret、introspection_endpoint等，根据实际需求配置。

示例配置片段

在Kong的配置文件中添加插件示例：

# 在kong.conf中，如果全局启用，则加入以下到[global]或相应的环境配置段
KONG_PLUGINS=oidc

# 或者通过API为特定服务添加插件
POST /apis/{api}/plugins
{
    "name": "oidc",
    "config": {
        "client_id": "your-client-id",
        "client_secret": "your-client-secret",
        "discovery": "https://your-oidc-provider/.well-known/openid-configuration"
    }
}

请注意，正式部署前务必替换成你的具体值，并确保Kong环境已正确设置了对lua-resty-openidc的依赖以及Kong本身的配置。

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