如何在Keycloak中注册自定义ProtocolMapper?

时间:2018-05-25 07:34:35

标签: keycloak

我正在努力在Keycloak中注册自定义ProtocolMapper。我想在令牌请求中添加数据库中的一些数据。所以我遵循了Keycloak add extra claims from database / external source中给出的想法。

我实现了ProtocolMapper接口并添加了文件

  

META-INF /服务/ org.keycloak.protocol.ProtocolMapper

包含对我班级的引用。到目前为止,Keycloak非常了解新的实现。我也可以通过管理控制台进行配置。

要向令牌添加一些数据,我想我还必须添加一个/一些接口

  

org.keycloak.protocol.oidc.mappers.UserInfoTokenMapper   org.keycloak.protocol.oidc.mappers.OIDCIDTokenMapper   org.keycloak.protocol.oidc.mappers.OIDCAccessTokenMapper

并根据接口实现方法。

现在的问题是,只要添加界面,我就会收到以下日志消息:

08:55:07,292 ERROR [org.jboss.msc.service.fail] (MSC service thread 1-6) MSC000001: Failed to start service jboss.deployment.unit."keycloak-spi.jar".POST_MODULE: org.jboss.msc.service.StartException in service jboss.deployment.unit."keycloak-spi.jar".POST_MODULE
: WFLYSRV0153: Failed to process phase POST_MODULE of deployment "keycloak-spi.jar"
        at org.jboss.as.server.deployment.DeploymentUnitPhaseService.start(DeploymentUnitPhaseService.java:172)
        at org.jboss.msc.service.ServiceControllerImpl$StartTask.startService(ServiceControllerImpl.java:2032)
        at org.jboss.msc.service.ServiceControllerImpl$StartTask.run(ServiceControllerImpl.java:1955)
        at java.util.concurrent.ThreadPoolExecutor.runWorker(Unknown Source)
        at java.util.concurrent.ThreadPoolExecutor$Worker.run(Unknown Source)
        at java.lang.Thread.run(Unknown Source)
Caused by: java.lang.NoClassDefFoundError: Failed to link at/lotterien/jam/keycloak/spi/JamAuthorizationInfoProtocolMapper (Module "deployment.keycloak-spi.jar" from Service Module Loader): org/keycloak/protocol/oidc/mappers/UserInfoTokenMapper
        at sun.reflect.NativeConstructorAccessorImpl.newInstance0(Native Method)
        at sun.reflect.NativeConstructorAccessorImpl.newInstance(Unknown Source)
        at sun.reflect.DelegatingConstructorAccessorImpl.newInstance(Unknown Source)
        at java.lang.reflect.Constructor.newInstance(Unknown Source)
        at org.jboss.modules.ModuleClassLoader.defineClass(ModuleClassLoader.java:446)
        at org.jboss.modules.ModuleClassLoader.loadClassLocal(ModuleClassLoader.java:274)
        at org.jboss.modules.ModuleClassLoader$1.loadClassLocal(ModuleClassLoader.java:77)
        at org.jboss.modules.Module.loadModuleClass(Module.java:713)
        at org.jboss.modules.ModuleClassLoader.findClass(ModuleClassLoader.java:190)
        at org.jboss.modules.ConcurrentClassLoader.performLoadClassUnchecked(ConcurrentClassLoader.java:412)
        at org.jboss.modules.ConcurrentClassLoader.performLoadClass(ConcurrentClassLoader.java:400)
        at org.jboss.modules.ConcurrentClassLoader.loadClass(ConcurrentClassLoader.java:116)
        at java.lang.Class.forName0(Native Method)
        at java.lang.Class.forName(Unknown Source)
        at java.util.ServiceLoader$LazyIterator.nextService(Unknown Source)
        at java.util.ServiceLoader$LazyIterator.next(Unknown Source)
        at java.util.ServiceLoader$1.next(Unknown Source)
        at org.keycloak.provider.DefaultProviderLoader.load(DefaultProviderLoader.java:60)
        at org.keycloak.provider.ProviderManager.load(ProviderManager.java:92)
        at org.keycloak.services.DefaultKeycloakSessionFactory.loadFactories(DefaultKeycloakSessionFactory.java:214)
        at org.keycloak.services.DefaultKeycloakSessionFactory.deploy(DefaultKeycloakSessionFactory.java:115)
        at org.keycloak.provider.ProviderManagerRegistry.deploy(ProviderManagerRegistry.java:42)
        at org.keycloak.subsystem.server.extension.KeycloakProviderDeploymentProcessor.deploy(KeycloakProviderDeploymentProcessor.java:55)
        at org.jboss.as.server.deployment.DeploymentUnitPhaseService.start(DeploymentUnitPhaseService.java:165)
        ... 5 more

为什么Keycloak找不到自己的界面?不应该开箱即用吗?

我想错过什么让它起作用?

修改1

我得到了一点点。我添加了一个文件

  

META-INF / JBoss的部署-structure.xml

内容

<?xml version="1.0" encoding="UTF-8"?>
<jboss-deployment-structure>
    <deployment>
        <dependencies>
            <module name="org.keycloak.keycloak-services"/>
        </dependencies>
    </deployment>
</jboss-deployment-structure>

现在异常消失了。

不幸的是,我的类中的方法 transformUserInfoToken()仍未在令牌请求中调用。

有人能把我放在正确的方向吗?

2 个答案:

答案 0 :(得分:1)

终于有效了。即使仍然有一些问题我可以实现所需的功能。

我必须实现接口

  

org.keycloak.protocol.oidc.mappers.OIDCAccessTokenMapper

(而不是org.keycloak.protocol.oidc.mappers.UserInfoTokenMapper

现在,每次对网址http://<host>:<port>/auth/realms/testrealm/protocol/openid-connect/token

的请求都会调用 transformAccessToken()方法

我认为问题来自于我对AccessToken,UserInfo和IDToken这两个术语的误解。我以为这三个都是生成的令牌的一部分。但似乎 OIDCAccessTokenMapper 是获取访问令牌的唯一方法。

对我来说,剩下的未解决问题是UserInfo和IDToken会出现在哪里。也许有人可以给出答案。

答案 1 :(得分:0)

对于我的特定问题,我有解决方案。我有同样的错误-但已经有一个jboss-deployment-structure.xml且内容可比。它对我不起作用的原因是,我有一个包含我的实现和作为JAR的库的EAR。因此jboss-deployment-structure.xml的所需结构有所不同。 我在这里将其发布给其他遇到相同问题的人:

<?xml version="1.0"?>
<jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.1">
    <ear-subdeployments-isolated>false</ear-subdeployments-isolated>
    <deployment>
        <dependencies>
            <system export="true">
                <paths>
                    <path name="com/sun/xml/internal/ws/spi"/>
                </paths>
            </system>
        </dependencies>
    </deployment>
    <sub-deployment name="org.my.implementation-1.0-SNAPSHOT.jar">
        <dependencies>
            <module name="org.keycloak.keycloak-core"/>
            <module name="org.keycloak.keycloak-server-spi"/>
            <module name="org.keycloak.keycloak-server-spi-private"/>
            <module name="org.keycloak.keycloak-services"/>
            <module name="javax.ws.rs.api"/>
        </dependencies>
    </sub-deployment>
</jboss-deployment-structure>
相关问题