问Keycloak使用自定义协议映射程序从数据库/外部源添加额外的声明

EN

我希望这个一步步的指南能帮助你。

我使用Keycloak 4.5.0 -因为我安装了这个较新的版本-但我不应该有很大的区别。我在这个例子中实现了一个OIDCProtocolMapper。

简单地总结一下--对于其他人的快速概述--后面将对每一步进行更详细的描述。

1. 您实现了基于CustomProtocolMapper的AbstractOIDCProtocolMapper类
2. META/services文件名为org.keycloak.protocol.ProtocolMapper，必须可用，并包含映射程序的名称
3. jboss-deployment-structure.xml需要可用，才能使用类中内置的keycloak
4. Jar文件部署在/opt/jboss/keycloak/standalone/deployments/中

好的，现在更详细:-)

创建自定义Mapper

我上传了我的maven pom.xml (pom) --只要将它导入到您的IDE中，所有的依赖项都会自动加载。这些依赖项只是provided，稍后将在运行时直接从keycloak中使用。

相关的是keycloak.version属性？？所有的keycloak依赖项当前都加载在4.5.0.Final版本中。

现在，我创建了一个名为CustomOIDCProtocolMapper的定制协议Mapper类。查找“完整”代码这里

它应该扩展AbstractOIDCProtocolMapper，并且需要实现所有的抽象方法。也许您想要一个SAML，然后它是另一个基类(AbstractSAMLProtocolMapper)

一个相关的方法是transformAccessToken --在这里，我对AccessToken设置了一个额外的声明。你需要你的逻辑，但是的-取决于你的数据库，等等;-)

服务档案

服务文件是重要的，用于查找您的自定义实现

将文件与fileName org.keycloak.protocol.ProtocolMapper放在\src\main\resources\META-INF\services\中。

在这个文件中，您将写入自定义提供程序的名称-因此keycloak知道这个类可以作为协议映射程序使用。

在我的示例中，文件内容只是一行

com.stackoverflow.keycloak.custom.CustomOIDCProtocolMapper

部署结构XML

在您的自定义映射器中，您使用来自keycloak的文件。为了使用它们，我们需要将这种依赖性告知jboss。因此，在jboss-deployment-structure.xml内容中创建一个文件\src\main\resources\META-INF\：

<jboss-deployment-structure>
    <deployment>
        <dependencies>
            <module name="org.keycloak.keycloak-services" />
        </dependencies>
    </deployment>
</jboss-deployment-structure>

构建和部署扩展程序

构建扩展名jar文件(mvn clean package) --并将jar放置在/opt/jboss/keycloak/standalone/deployments/中并重新启动密钥披风

在日志文件中，您应该看到它何时部署，以及(希望没有)错误消息。

现在您可以使用映射器了--在我的示例中，我可以在keycloak管理ui中创建一个mapper，并从下拉列表中选择Stackoverflow Custom Protocol Mapper。

正如信息-这不是完全官方支持的keycloak所以接口可能会改变在以后的版本。

我希望这是可以理解的，你将能够成功地实现你自己的地图

编辑:导出的eclipse文件结构zip