Kong OIDC 插件使用教程
kong-oidcOIDC plugin for Kong项目地址:https://gitcode.com/gh_mirrors/ko/kong-oidc
目录结构及介绍
Kong OIDC 插件的 GitHub 仓库包含以下主要目录和文件:
docs/
: 包含插件的文档文件。spec/
: 包含插件的测试规范文件。test/
: 包含插件的测试文件。LICENSE
: 项目的许可证文件。README.md
: 项目的主文档文件。kong-oidc-1.1.0-0.rockspec
: 用于 Luarocks 的包规范文件。
项目的启动文件介绍
Kong OIDC 插件本身是一个 Kong 插件,因此没有传统意义上的“启动文件”。插件通过 Kong 的插件机制加载和运行。要启用该插件,需要在 Kong 的配置中添加相应的插件配置。
项目的配置文件介绍
Kong OIDC 插件的配置主要通过 Kong 的配置文件进行。以下是一些关键的配置参数:
name
: 插件名称,必须为oidc
。config.response_type
: 响应类型,通常为code
。config.client_id
: OIDC 客户端 ID。config.discovery
: OIDC 提供者的发现 URL。config.scope
: 请求的 OIDC 范围,通常为openid
。config.ssl_verify
: 是否验证 SSL 证书,通常为no
。config.client_secret
: OIDC 客户端密钥。config.token_endpoint_auth_method
: 令牌端点认证方法,通常为client_secret_post
。
配置示例:
{
"name": "oidc",
"config": {
"response_type": "code",
"client_id": "kong-oidc",
"discovery": "https://<oidc_provider>/.well-known/openid-configuration",
"scope": "openid",
"ssl_verify": "no",
"client_secret": "29d98bf7-168c-4874-b8e9-9ba5e7382fa0",
"token_endpoint_auth_method": "client_secret_post"
}
}
以上是 Kong OIDC 插件的基本使用教程,涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助。
kong-oidcOIDC plugin for Kong项目地址:https://gitcode.com/gh_mirrors/ko/kong-oidc