跳转至

Keycloak 自定义 IdP

要求:keycloak >= v20

已知问题 keycloak >= v21,删除了旧版 theme 的支持,可能会在 v22 修复。 参见 Issue #15344

此次 demo 使用 Keycloak v20.0.5。

基于 source 开发

配置环境

参照 keycloak/building.md 配置环境。

参照 keycloak/README.md 运行以下命令:

cd quarkus
mvn -f ../pom.xml clean install -DskipTestsuite -DskipExamples -DskipTests

从 IDE 运行

从 IDE 运行

添加 service 代码

如果可从 keycloak 继承部分功能

在目录 services/src/main/java/org/keycloak/broker 下添加文件:

文件名需要是 xxxProvider.javaxxxProviderFactory.java

java

xxxProviderFactory.java 示例:

留意 PROVIDER_ID = "oauth"; 这个变量,后面定义 html 会用到。

xxxProvider.java 示例

如果不能从 keycloak 继承功能

参考下图中的三个文件编写你的代码:

none heritance

添加 xxxProviderFactory 到 resource service

services/src/main/resources/META-INF/services/org.keycloak.broker.provider.IdentityProviderFactory 添加 xxxProviderFactory,这样刚刚编写的能工作了:

running

添加 html 文件

复制 themes/src/main/resources/theme/base/admin/resources/partials/realm-identity-provider-oidc.html 文件到(改名为 realm-identity-provider-oauth.html ,还记得上文中需要留意的变量吗) themes/src/main/resources/theme/base/admin/resources/partials/realm-identity-provider-oauth.html

到此所有的文件都添加完成了,开始调试功能。

打包成 jar 作为插件运行

新建一个 java 项目,并将上面的代码复制到项目中,如下所示:

pom

参见 pom.xml

运行 mvn clean package ,打包完成得到 xxx-jar-with-dependencies.jar 文件。

下载 keycloak Release 20.0.5 zip 包并解压。

release

xxx-jar-with-dependencies.jar 复制到 keycloak-20.0.5/providers 目录中。

运行以下命令查看功能是否完整:

bin/kc.sh start-dev

评论