Migration of custom attribute mappers and custom providers #10291

Coding-Mike · 2022-02-17T11:15:39Z

Coding-Mike
Feb 17, 2022

Hi,

I currently use the following Dockerfile to create a custom configured docker image for the keycloak.

FROM quay.io/keycloak/keycloak:17.0.0-legacy

ADD ./changeProvider.xsl /opt/jboss/keycloak/
ADD ./jline-2.9.jar /opt/jboss/keycloak/
ADD ./saxon-he-10.3.jar /opt/jboss/keycloak/
ADD ./saxon-xqj-10.3.jar /opt/jboss/keycloak/
RUN java -jar /opt/jboss/keycloak/saxon-he-10.3.jar -s:/opt/jboss/keycloak/standalone/configuration/standalone.xml -xsl:/opt/jboss/keycloak/changeProvider.xsl -o:/opt/jboss/keycloak/standalone/configuration/standalone.xml; java -jar /opt/jboss/keycloak/saxon-he-10.3.jar -s:/opt/jboss/keycloak/standalone/configuration/standalone-ha.xml -xsl:/opt/jboss/keycloak/changeProvider.xsl -o:/opt/jboss/keycloak/standalone/configuration/standalone-ha.xml; rm /opt/jboss/keycloak/changeProvider.xsl; rm /opt/jboss/keycloak/jline-2.9.jar; rm /opt/jboss/keycloak/saxon-he-10.3.jar; rm /opt/jboss/keycloak/saxon-xqj-10.3.jar
#RUN java -jar /opt/jboss/keycloak/saxon-he-10.3.jar -s:/opt/jboss/keycloak/standalone/configuration/standalone.xml -xsl:/opt/jboss/keycloak/changeProvider.xsl -o:/opt/jboss/keycloak/standalone/configuration/standalone.xml; rm /opt/jboss/keycloak/changeProvider.xsl; rm /opt/jboss/keycloak/jline-2.9.jar; rm /opt/jboss/keycloak/saxon-he-10.3.jar; rm /opt/jboss/keycloak/saxon-xqj-10.3.jar

RUN mkdir -p /opt/jboss/keycloak/modules/system/layers/base/mike/pi/oidc-custom-grafanarole-attribute-mapper/main
ADD ./customGrafanaRoleMapper/target/oidc-custom-grafanarole-attribute-mapper.jar /opt/jboss/keycloak/modules/system/layers/base/mike/pi/oidc-custom-grafanarole-attribute-mapper/main/oidc-custom-grafanarole-attribute-mapper.jar
ADD ./customGrafanaRoleMapper/src/main/module/module.xml /opt/jboss/keycloak/modules/system/layers/base/mike/pi/oidc-custom-grafanarole-attribute-mapper/main

RUN mkdir -p /opt/jboss/keycloak/modules/system/layers/base/mike/pi/oidc-custom-usermodel-attribute-mapper/main
ADD ./customUserAttributeMapper/target/oidc-custom-usermodel-attribute-mapper.jar /opt/jboss/keycloak/modules/system/layers/base/mike/pi/oidc-custom-usermodel-attribute-mapper/main/oidc-custom-usermodel-attribute-mapper.jar
ADD ./customUserAttributeMapper/src/main/module/module.xml /opt/jboss/keycloak/modules/system/layers/base/mike/pi/oidc-custom-usermodel-attribute-mapper/main

ADD ./kc_user_role_validate_extension-master/target/user-role-validator.jar /opt/jboss/keycloak/standalone/deployments/user-role-validator.jar

Now with the new Quarkus distribution I don't find a way how to adjust this so that I can use my custom mappers and providers with the new version.

Can someone guide me how to change the docker file to get this running again in the new non legacy version

Thanks in advance and kind regards
Michael

pedroigor · 2022-02-17T14:08:55Z

pedroigor
Feb 17, 2022
Collaborator

@Coding-Mike Could you check if the info here [1] helps on that?

Basically, you need to deploy your providers now within the providers directory. And make sure you run the build command to actually install the provider.

If your provider does not need any configuration, that is it.

If you could give more details about the changes you are doing to standalone.xml, perhaps I can help more.

Regardless, we need to provide a specific guide I think or update the configuration guide for more details.

[1] https://www.keycloak.org/migration/migrating-to-quarkus

0 replies

Coding-Mike · 2022-02-17T14:12:52Z

Coding-Mike
Feb 17, 2022
Author

@pedroigor here is the content of the file used to update the standalone.xml configuration file

<?xml version="1.0" encoding="UTF-8"?>
<!-- To register our own module, which contains the protocol mapper, it is not enough to just
add the jar file to the jboss server. We have to change the jboss xml file too. This is done
by this xslt file -->
<xsl:stylesheet version="2.0"
                xmlns:xsl="http://www.w3.org/1999/XSL/Transform">

    <xsl:output method="xml" indent="yes"/>

    <xsl:template match="//ds:subsystem/ds:providers" xmlns:ds="urn:jboss:domain:keycloak-server:1.1">
        <ds:providers>
            <!-- We add our own module, which contains the protocol mapper, to the providers here.
             Without that, we would be unable to configure keycloak to use our protocol mapper. It wouldn't
             be visible in the list of available protocol mappers. The name of the module must be the
             same as in the module.xml -->
             <ds:provider>module:mike.pi.oidc-custom-usermodel-attribute-mapper</ds:provider>
            <ds:provider>module:mike.pi.oidc-custom-grafanarole-attribute-mapper</ds:provider>
            <ds:provider>
                classpath:${jboss.home.dir}/providers/*
            </ds:provider>
        </ds:providers>
    </xsl:template>

    <xsl:template match="@*|node()">
        <xsl:copy>
            <xsl:apply-templates select="@*|node()"/>
        </xsl:copy>
    </xsl:template>

</xsl:stylesheet>

I hope this helps to explain a solution.

Kind regards
Michael

1 reply

pedroigor Feb 17, 2022
Collaborator

The steps are less painful as we no longer use XML as a configuration format.

In this case, you only need to copy the jar to te providers directory. And the run:

kc.sh build <OPTIONS>

And then start the server with the configuration options you need.

You can also skip the build step and just run kc start --auto-build right after copying the jar.

Or in development mode, just run start-dev.

pedroigor · 2022-02-22T20:03:29Z

pedroigor
Feb 22, 2022
Collaborator

@Coding-Mike Could you please check if this new guide helps you? See #10401.

0 replies

Coding-Mike · 2022-02-23T06:55:00Z

Coding-Mike
Feb 23, 2022
Author

@pedroigor thanks for your help. I already managed to do the migration. The new guide is also a great step ahead to help others in the migration process.

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migration of custom attribute mappers and custom providers #10291

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Replies: 4 comments 1 reply

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Select a reply

Uh oh!

Migration of custom attribute mappers and custom providers #10291

Uh oh!

Uh oh!

Coding-Mike Feb 17, 2022

Replies: 4 comments · 1 reply

Uh oh!

pedroigor Feb 17, 2022 Collaborator

Uh oh!

Coding-Mike Feb 17, 2022 Author

Uh oh!

pedroigor Feb 17, 2022 Collaborator

Uh oh!

pedroigor Feb 22, 2022 Collaborator

Uh oh!

Coding-Mike Feb 23, 2022 Author

Coding-Mike
Feb 17, 2022

Replies: 4 comments 1 reply

pedroigor
Feb 17, 2022
Collaborator

Coding-Mike
Feb 17, 2022
Author

pedroigor Feb 17, 2022
Collaborator

pedroigor
Feb 22, 2022
Collaborator

Coding-Mike
Feb 23, 2022
Author