├── .github └── workflows │ ├── build.yml │ └── maven-publish.yml ├── .gitignore ├── .mvn └── wrapper │ └── maven-wrapper.properties ├── License.md ├── README.md ├── mvnw ├── mvnw.cmd ├── pom.xml ├── src └── main │ ├── java │ └── com │ │ └── github │ │ └── aznamier │ │ └── keycloak │ │ └── event │ │ └── provider │ │ ├── EventAdminNotificationMqMsg.java │ │ ├── EventClientNotificationMqMsg.java │ │ ├── RabbitMqConfig.java │ │ ├── RabbitMqEventListenerProvider.java │ │ └── RabbitMqEventListenerProviderFactory.java │ └── resources │ └── META-INF │ └── services │ └── org.keycloak.events.EventListenerProviderFactory └── utils └── cli ├── KEYCLOAK_TO_RABBIT.cli └── usage.txt /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Build 2 | 3 | on: 4 | push: 5 | pull_request: 6 | 7 | jobs: 8 | build: 9 | name: build 10 | runs-on: ubuntu-latest 11 | env: 12 | MAVEN_CLI_OPTS: "--batch-mode --errors --fail-at-end --show-version" 13 | steps: 14 | - name: Checkout repository 15 | uses: actions/checkout@v3 16 | with: 17 | fetch-depth: 0 18 | - name: Set up JDK 17 19 | uses: actions/setup-java@v3 20 | with: 21 | distribution: 'temurin' 22 | java-version: 17 23 | - name: Build 24 | run: > 25 | ./mvnw $MAVEN_CLI_OPTS 26 | dependency:go-offline 27 | clean verify 28 | -------------------------------------------------------------------------------- /.github/workflows/maven-publish.yml: -------------------------------------------------------------------------------- 1 | # This workflow will build a package using Maven and then publish it to GitHub packages when a release is created 2 | # For more information see: https://github.com/actions/setup-java#apache-maven-with-a-settings-path 3 | 4 | name: Maven Package 5 | 6 | on: 7 | release: 8 | types: [created] 9 | 10 | jobs: 11 | build: 12 | 13 | runs-on: ubuntu-latest 14 | 15 | steps: 16 | - name: Checkout repository 17 | uses: actions/checkout@v3 18 | - name: Set up JDK 17 19 | uses: actions/setup-java@v3 20 | with: 21 | distribution: 'temurin' 22 | java-version: 17 23 | server-id: github # Value of the distributionManagement/repository/id field of the pom.xml 24 | settings-path: ${{ github.workspace }} # location for the settings.xml file 25 | 26 | - name: Build with Maven 27 | run: ./mvnw -B package --file pom.xml 28 | 29 | - name: Publish to GitHub Packages Apache Maven 30 | run: ./mvnw deploy -s $GITHUB_WORKSPACE/settings.xml 31 | env: 32 | GITHUB_TOKEN: ${{ github.token }} 33 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.class 2 | 3 | # Package Files # 4 | *.jar 5 | *.war 6 | *.ear 7 | target/ 8 | .settings/ 9 | .project 10 | .classpath 11 | .idea 12 | .vscode/ -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.properties: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.3/apache-maven-3.9.3-bin.zip 18 | wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar 19 | -------------------------------------------------------------------------------- /License.md: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # keycloak-event-listener-rabbitmq 2 | 3 | ##### A Keycloak SPI plugin that publishes events to a RabbitMq server. 4 | 5 | | Plugin | min Keycloak ver | 6 | | -- | ---- | 7 | | 1.x | 10.x | 8 | | 2.x | 13.x | 9 | | 3.x | 16.x | 10 | 11 | For example here is the notification of the user updated by administrator 12 | 13 | * routing key: `KK.EVENT.ADMIN.MYREALM.SUCCESS.USER.UPDATE` 14 | * published to exchange: `amq.topic` 15 | * content: 16 | 17 | 18 | ``` 19 | { 20 | "@class" : "com.github.aznamier.keycloak.event.provider.EventAdminNotificationMqMsg", 21 | "time" : 1596951200408, 22 | "realmId" : "MYREALM", 23 | "authDetails" : { 24 | "realmId" : "master", 25 | "clientId" : "********-****-****-****-**********", 26 | "userId" : "********-****-****-****-**********", 27 | "ipAddress" : "192.168.1.1" 28 | }, 29 | "resourceType" : "USER", 30 | "operationType" : "UPDATE", 31 | "resourcePath" : "users/********-****-****-****-**********", 32 | "representation" : "representation details here....", 33 | "error" : null, 34 | "resourceTypeAsString" : "USER" 35 | } 36 | ``` 37 | 38 | The routing key is calculated as follows: 39 | * admin events: `KK.EVENT.ADMIN....` 40 | * client events: `KK.EVENT.CLIENT....` 41 | 42 | And because the recommended exchange is a **TOPIC (amq.topic)**, 43 | therefore its easy for Rabbit client to subscribe to selective combinations eg: 44 | * all events: `KK.EVENT.#` 45 | * all events from my realm: `KK.EVENT.*.MYREALM.#` 46 | * all error events from my realm: `KK.EVENT.*.MYREALM.ERROR.#` 47 | * all user events from my-relam and my-client: `KK.EVENT.*.MY-REALM.*.MY-CLIENT.USER` 48 | 49 | 50 | ## USAGE: 51 | 1. [Download the latest jar](https://github.com/aznamier/keycloak-event-listener-rabbitmq/blob/target/keycloak-to-rabbit-3.0.5.jar?raw=true) or build from source: ``mvn clean install`` 52 | 2. Copy jar into your Keycloak 53 | 1. Keycloak version 17+ (Quarkus) `/opt/keycloak/providers/keycloak-to-rabbit-3.0.5.jar` 54 | 2. Keycloak version 16 and older `/opt/jboss/keycloak/standalone/deployments/keycloak-to-rabbit-3.0.5.jar` 55 | 3. Configure as described below (option 1 or 2 or 3) 56 | 4. Restart the Keycloak server 57 | 5. Enable logging in Keycloak UI by adding **keycloak-to-rabbitmq** 58 | `Manage > Events > Config > Events Config > Event Listeners` 59 | 60 | #### Configuration 61 | ###### Recommended: OPTION 1: just configure **ENVIRONMENT VARIABLES** 62 | - `KK_TO_RMQ_URL` - default: *localhost* 63 | - `KK_TO_RMQ_PORT` - default: *5672* 64 | - `KK_TO_RMQ_VHOST` - default: *empty* 65 | - `KK_TO_RMQ_EXCHANGE` - default: *amq.topic* 66 | - `KK_TO_RMQ_USERNAME` - default: *admin* 67 | - `KK_TO_RMQ_PASSWORD` - default: *admin* 68 | - `KK_TO_RMQ_USE_TLS` - default: *false* 69 | - `KK_TO_RMQ_KEY_STORE` - default: *empty* 70 | - `KK_TO_RMQ_KEY_STORE_PASS` - default: *empty* 71 | - `KK_TO_RMQ_TRUST_STORE` - default: *empty* 72 | - `KK_TO_RMQ_TRUST_STORE_PASS` - default: *empty* 73 | 74 | ###### Deprecated OPTION 2: edit Keycloak subsystem of WildFly (Keycloak 16 and older) standalone.xml or standalone-ha.xml: 75 | 76 | ```xml 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | ``` 95 | ###### Deprecated OPTION 3 same effect as OPTION 2 but programatically WildFly (Keycloak 16 and older): 96 | ``` 97 | echo "yes" | $KEYCLOAK_HOME/bin/jboss-cli.sh --file=$KEYCLOAK_HOME/KEYCLOAK_TO_RABBIT.cli 98 | ``` 99 | 100 | 101 | -------------------------------------------------------------------------------- /mvnw: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # ---------------------------------------------------------------------------- 3 | # Licensed to the Apache Software Foundation (ASF) under one 4 | # or more contributor license agreements. See the NOTICE file 5 | # distributed with this work for additional information 6 | # regarding copyright ownership. The ASF licenses this file 7 | # to you under the Apache License, Version 2.0 (the 8 | # "License"); you may not use this file except in compliance 9 | # with the License. You may obtain a copy of the License at 10 | # 11 | # http://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, 14 | # software distributed under the License is distributed on an 15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 | # KIND, either express or implied. See the License for the 17 | # specific language governing permissions and limitations 18 | # under the License. 19 | # ---------------------------------------------------------------------------- 20 | 21 | # ---------------------------------------------------------------------------- 22 | # Maven Start Up Batch script 23 | # 24 | # Required ENV vars: 25 | # ------------------ 26 | # JAVA_HOME - location of a JDK home dir 27 | # 28 | # Optional ENV vars 29 | # ----------------- 30 | # M2_HOME - location of maven2's installed home dir 31 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven 32 | # e.g. to debug Maven itself, use 33 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 34 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files 35 | # ---------------------------------------------------------------------------- 36 | 37 | if [ -z "$MAVEN_SKIP_RC" ] ; then 38 | 39 | if [ -f /usr/local/etc/mavenrc ] ; then 40 | . /usr/local/etc/mavenrc 41 | fi 42 | 43 | if [ -f /etc/mavenrc ] ; then 44 | . /etc/mavenrc 45 | fi 46 | 47 | if [ -f "$HOME/.mavenrc" ] ; then 48 | . "$HOME/.mavenrc" 49 | fi 50 | 51 | fi 52 | 53 | # OS specific support. $var _must_ be set to either true or false. 54 | cygwin=false; 55 | darwin=false; 56 | mingw=false 57 | case "`uname`" in 58 | CYGWIN*) cygwin=true ;; 59 | MINGW*) mingw=true;; 60 | Darwin*) darwin=true 61 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home 62 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html 63 | if [ -z "$JAVA_HOME" ]; then 64 | if [ -x "/usr/libexec/java_home" ]; then 65 | export JAVA_HOME="`/usr/libexec/java_home`" 66 | else 67 | export JAVA_HOME="/Library/Java/Home" 68 | fi 69 | fi 70 | ;; 71 | esac 72 | 73 | if [ -z "$JAVA_HOME" ] ; then 74 | if [ -r /etc/gentoo-release ] ; then 75 | JAVA_HOME=`java-config --jre-home` 76 | fi 77 | fi 78 | 79 | if [ -z "$M2_HOME" ] ; then 80 | ## resolve links - $0 may be a link to maven's home 81 | PRG="$0" 82 | 83 | # need this for relative symlinks 84 | while [ -h "$PRG" ] ; do 85 | ls=`ls -ld "$PRG"` 86 | link=`expr "$ls" : '.*-> \(.*\)$'` 87 | if expr "$link" : '/.*' > /dev/null; then 88 | PRG="$link" 89 | else 90 | PRG="`dirname "$PRG"`/$link" 91 | fi 92 | done 93 | 94 | saveddir=`pwd` 95 | 96 | M2_HOME=`dirname "$PRG"`/.. 97 | 98 | # make it fully qualified 99 | M2_HOME=`cd "$M2_HOME" && pwd` 100 | 101 | cd "$saveddir" 102 | # echo Using m2 at $M2_HOME 103 | fi 104 | 105 | # For Cygwin, ensure paths are in UNIX format before anything is touched 106 | if $cygwin ; then 107 | [ -n "$M2_HOME" ] && 108 | M2_HOME=`cygpath --unix "$M2_HOME"` 109 | [ -n "$JAVA_HOME" ] && 110 | JAVA_HOME=`cygpath --unix "$JAVA_HOME"` 111 | [ -n "$CLASSPATH" ] && 112 | CLASSPATH=`cygpath --path --unix "$CLASSPATH"` 113 | fi 114 | 115 | # For Mingw, ensure paths are in UNIX format before anything is touched 116 | if $mingw ; then 117 | [ -n "$M2_HOME" ] && 118 | M2_HOME="`(cd "$M2_HOME"; pwd)`" 119 | [ -n "$JAVA_HOME" ] && 120 | JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" 121 | fi 122 | 123 | if [ -z "$JAVA_HOME" ]; then 124 | javaExecutable="`which javac`" 125 | if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then 126 | # readlink(1) is not available as standard on Solaris 10. 127 | readLink=`which readlink` 128 | if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then 129 | if $darwin ; then 130 | javaHome="`dirname \"$javaExecutable\"`" 131 | javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" 132 | else 133 | javaExecutable="`readlink -f \"$javaExecutable\"`" 134 | fi 135 | javaHome="`dirname \"$javaExecutable\"`" 136 | javaHome=`expr "$javaHome" : '\(.*\)/bin'` 137 | JAVA_HOME="$javaHome" 138 | export JAVA_HOME 139 | fi 140 | fi 141 | fi 142 | 143 | if [ -z "$JAVACMD" ] ; then 144 | if [ -n "$JAVA_HOME" ] ; then 145 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 146 | # IBM's JDK on AIX uses strange locations for the executables 147 | JAVACMD="$JAVA_HOME/jre/sh/java" 148 | else 149 | JAVACMD="$JAVA_HOME/bin/java" 150 | fi 151 | else 152 | JAVACMD="`\\unset -f command; \\command -v java`" 153 | fi 154 | fi 155 | 156 | if [ ! -x "$JAVACMD" ] ; then 157 | echo "Error: JAVA_HOME is not defined correctly." >&2 158 | echo " We cannot execute $JAVACMD" >&2 159 | exit 1 160 | fi 161 | 162 | if [ -z "$JAVA_HOME" ] ; then 163 | echo "Warning: JAVA_HOME environment variable is not set." 164 | fi 165 | 166 | CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher 167 | 168 | # traverses directory structure from process work directory to filesystem root 169 | # first directory with .mvn subdirectory is considered project base directory 170 | find_maven_basedir() { 171 | 172 | if [ -z "$1" ] 173 | then 174 | echo "Path not specified to find_maven_basedir" 175 | return 1 176 | fi 177 | 178 | basedir="$1" 179 | wdir="$1" 180 | while [ "$wdir" != '/' ] ; do 181 | if [ -d "$wdir"/.mvn ] ; then 182 | basedir=$wdir 183 | break 184 | fi 185 | # workaround for JBEAP-8937 (on Solaris 10/Sparc) 186 | if [ -d "${wdir}" ]; then 187 | wdir=`cd "$wdir/.."; pwd` 188 | fi 189 | # end of workaround 190 | done 191 | echo "${basedir}" 192 | } 193 | 194 | # concatenates all lines of a file 195 | concat_lines() { 196 | if [ -f "$1" ]; then 197 | echo "$(tr -s '\n' ' ' < "$1")" 198 | fi 199 | } 200 | 201 | BASE_DIR=`find_maven_basedir "$(pwd)"` 202 | if [ -z "$BASE_DIR" ]; then 203 | exit 1; 204 | fi 205 | 206 | ########################################################################################## 207 | # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 208 | # This allows using the maven wrapper in projects that prohibit checking in binary data. 209 | ########################################################################################## 210 | if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then 211 | if [ "$MVNW_VERBOSE" = true ]; then 212 | echo "Found .mvn/wrapper/maven-wrapper.jar" 213 | fi 214 | else 215 | if [ "$MVNW_VERBOSE" = true ]; then 216 | echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..." 217 | fi 218 | if [ -n "$MVNW_REPOURL" ]; then 219 | jarUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" 220 | else 221 | jarUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" 222 | fi 223 | while IFS="=" read key value; do 224 | case "$key" in (wrapperUrl) jarUrl="$value"; break ;; 225 | esac 226 | done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties" 227 | if [ "$MVNW_VERBOSE" = true ]; then 228 | echo "Downloading from: $jarUrl" 229 | fi 230 | wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" 231 | if $cygwin; then 232 | wrapperJarPath=`cygpath --path --windows "$wrapperJarPath"` 233 | fi 234 | 235 | if command -v wget > /dev/null; then 236 | if [ "$MVNW_VERBOSE" = true ]; then 237 | echo "Found wget ... using wget" 238 | fi 239 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then 240 | wget "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" 241 | else 242 | wget --http-user=$MVNW_USERNAME --http-password=$MVNW_PASSWORD "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" 243 | fi 244 | elif command -v curl > /dev/null; then 245 | if [ "$MVNW_VERBOSE" = true ]; then 246 | echo "Found curl ... using curl" 247 | fi 248 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then 249 | curl -o "$wrapperJarPath" "$jarUrl" -f 250 | else 251 | curl --user $MVNW_USERNAME:$MVNW_PASSWORD -o "$wrapperJarPath" "$jarUrl" -f 252 | fi 253 | 254 | else 255 | if [ "$MVNW_VERBOSE" = true ]; then 256 | echo "Falling back to using Java to download" 257 | fi 258 | javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java" 259 | # For Cygwin, switch paths to Windows format before running javac 260 | if $cygwin; then 261 | javaClass=`cygpath --path --windows "$javaClass"` 262 | fi 263 | if [ -e "$javaClass" ]; then 264 | if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 265 | if [ "$MVNW_VERBOSE" = true ]; then 266 | echo " - Compiling MavenWrapperDownloader.java ..." 267 | fi 268 | # Compiling the Java class 269 | ("$JAVA_HOME/bin/javac" "$javaClass") 270 | fi 271 | if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 272 | # Running the downloader 273 | if [ "$MVNW_VERBOSE" = true ]; then 274 | echo " - Running MavenWrapperDownloader.java ..." 275 | fi 276 | ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR") 277 | fi 278 | fi 279 | fi 280 | fi 281 | ########################################################################################## 282 | # End of extension 283 | ########################################################################################## 284 | 285 | export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} 286 | if [ "$MVNW_VERBOSE" = true ]; then 287 | echo $MAVEN_PROJECTBASEDIR 288 | fi 289 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" 290 | 291 | # For Cygwin, switch paths to Windows format before running java 292 | if $cygwin; then 293 | [ -n "$M2_HOME" ] && 294 | M2_HOME=`cygpath --path --windows "$M2_HOME"` 295 | [ -n "$JAVA_HOME" ] && 296 | JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` 297 | [ -n "$CLASSPATH" ] && 298 | CLASSPATH=`cygpath --path --windows "$CLASSPATH"` 299 | [ -n "$MAVEN_PROJECTBASEDIR" ] && 300 | MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"` 301 | fi 302 | 303 | # Provide a "standardized" way to retrieve the CLI args that will 304 | # work with both Windows and non-Windows executions. 305 | MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@" 306 | export MAVEN_CMD_LINE_ARGS 307 | 308 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 309 | 310 | exec "$JAVACMD" \ 311 | $MAVEN_OPTS \ 312 | $MAVEN_DEBUG_OPTS \ 313 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ 314 | "-Dmaven.home=${M2_HOME}" \ 315 | "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ 316 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" 317 | -------------------------------------------------------------------------------- /mvnw.cmd: -------------------------------------------------------------------------------- 1 | @REM ---------------------------------------------------------------------------- 2 | @REM Licensed to the Apache Software Foundation (ASF) under one 3 | @REM or more contributor license agreements. See the NOTICE file 4 | @REM distributed with this work for additional information 5 | @REM regarding copyright ownership. The ASF licenses this file 6 | @REM to you under the Apache License, Version 2.0 (the 7 | @REM "License"); you may not use this file except in compliance 8 | @REM with the License. You may obtain a copy of the License at 9 | @REM 10 | @REM http://www.apache.org/licenses/LICENSE-2.0 11 | @REM 12 | @REM Unless required by applicable law or agreed to in writing, 13 | @REM software distributed under the License is distributed on an 14 | @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | @REM KIND, either express or implied. See the License for the 16 | @REM specific language governing permissions and limitations 17 | @REM under the License. 18 | @REM ---------------------------------------------------------------------------- 19 | 20 | @REM ---------------------------------------------------------------------------- 21 | @REM Maven Start Up Batch script 22 | @REM 23 | @REM Required ENV vars: 24 | @REM JAVA_HOME - location of a JDK home dir 25 | @REM 26 | @REM Optional ENV vars 27 | @REM M2_HOME - location of maven2's installed home dir 28 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands 29 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending 30 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven 31 | @REM e.g. to debug Maven itself, use 32 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 33 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files 34 | @REM ---------------------------------------------------------------------------- 35 | 36 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' 37 | @echo off 38 | @REM set title of command window 39 | title %0 40 | @REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' 41 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% 42 | 43 | @REM set %HOME% to equivalent of $HOME 44 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") 45 | 46 | @REM Execute a user defined script before this one 47 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre 48 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending 49 | if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* 50 | if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* 51 | :skipRcPre 52 | 53 | @setlocal 54 | 55 | set ERROR_CODE=0 56 | 57 | @REM To isolate internal variables from possible post scripts, we use another setlocal 58 | @setlocal 59 | 60 | @REM ==== START VALIDATION ==== 61 | if not "%JAVA_HOME%" == "" goto OkJHome 62 | 63 | echo. 64 | echo Error: JAVA_HOME not found in your environment. >&2 65 | echo Please set the JAVA_HOME variable in your environment to match the >&2 66 | echo location of your Java installation. >&2 67 | echo. 68 | goto error 69 | 70 | :OkJHome 71 | if exist "%JAVA_HOME%\bin\java.exe" goto init 72 | 73 | echo. 74 | echo Error: JAVA_HOME is set to an invalid directory. >&2 75 | echo JAVA_HOME = "%JAVA_HOME%" >&2 76 | echo Please set the JAVA_HOME variable in your environment to match the >&2 77 | echo location of your Java installation. >&2 78 | echo. 79 | goto error 80 | 81 | @REM ==== END VALIDATION ==== 82 | 83 | :init 84 | 85 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn". 86 | @REM Fallback to current working directory if not found. 87 | 88 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% 89 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir 90 | 91 | set EXEC_DIR=%CD% 92 | set WDIR=%EXEC_DIR% 93 | :findBaseDir 94 | IF EXIST "%WDIR%"\.mvn goto baseDirFound 95 | cd .. 96 | IF "%WDIR%"=="%CD%" goto baseDirNotFound 97 | set WDIR=%CD% 98 | goto findBaseDir 99 | 100 | :baseDirFound 101 | set MAVEN_PROJECTBASEDIR=%WDIR% 102 | cd "%EXEC_DIR%" 103 | goto endDetectBaseDir 104 | 105 | :baseDirNotFound 106 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR% 107 | cd "%EXEC_DIR%" 108 | 109 | :endDetectBaseDir 110 | 111 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig 112 | 113 | @setlocal EnableExtensions EnableDelayedExpansion 114 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a 115 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% 116 | 117 | :endReadAdditionalConfig 118 | 119 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" 120 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" 121 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 122 | 123 | set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" 124 | 125 | FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( 126 | IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B 127 | ) 128 | 129 | @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 130 | @REM This allows using the maven wrapper in projects that prohibit checking in binary data. 131 | if exist %WRAPPER_JAR% ( 132 | if "%MVNW_VERBOSE%" == "true" ( 133 | echo Found %WRAPPER_JAR% 134 | ) 135 | ) else ( 136 | if not "%MVNW_REPOURL%" == "" ( 137 | SET DOWNLOAD_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" 138 | ) 139 | if "%MVNW_VERBOSE%" == "true" ( 140 | echo Couldn't find %WRAPPER_JAR%, downloading it ... 141 | echo Downloading from: %DOWNLOAD_URL% 142 | ) 143 | 144 | powershell -Command "&{"^ 145 | "$webclient = new-object System.Net.WebClient;"^ 146 | "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ 147 | "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ 148 | "}"^ 149 | "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')"^ 150 | "}" 151 | if "%MVNW_VERBOSE%" == "true" ( 152 | echo Finished downloading %WRAPPER_JAR% 153 | ) 154 | ) 155 | @REM End of extension 156 | 157 | @REM Provide a "standardized" way to retrieve the CLI args that will 158 | @REM work with both Windows and non-Windows executions. 159 | set MAVEN_CMD_LINE_ARGS=%* 160 | 161 | %MAVEN_JAVA_EXE% ^ 162 | %JVM_CONFIG_MAVEN_PROPS% ^ 163 | %MAVEN_OPTS% ^ 164 | %MAVEN_DEBUG_OPTS% ^ 165 | -classpath %WRAPPER_JAR% ^ 166 | "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ 167 | %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* 168 | if ERRORLEVEL 1 goto error 169 | goto end 170 | 171 | :error 172 | set ERROR_CODE=1 173 | 174 | :end 175 | @endlocal & set ERROR_CODE=%ERROR_CODE% 176 | 177 | if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost 178 | @REM check for post script, once with legacy .bat ending and once with .cmd ending 179 | if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" 180 | if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" 181 | :skipRcPost 182 | 183 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' 184 | if "%MAVEN_BATCH_PAUSE%"=="on" pause 185 | 186 | if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% 187 | 188 | cmd /C exit /B %ERROR_CODE% 189 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 3 | 4.0.0 4 | 5 | com.github.aznamier.keycloak.event.provider 6 | keycloak-to-rabbit 7 | jar 8 | 3.0.5 9 | 10 | 11 | 12 | Keycloak: Event Publisher to RabbitMQ 13 | 14 | 21.1.2 15 | ${project.artifactId}-${project.version} 16 | 17 | 18 | 19 | 20 | github 21 | GitHub AZNAMIER Apache Maven Packages 22 | https://maven.pkg.github.com/aznamier/keycloak-event-listener-rabbitmq 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | org.keycloak 32 | keycloak-core 33 | provided 34 | ${keycloak.version} 35 | 36 | 37 | org.keycloak 38 | keycloak-server-spi 39 | provided 40 | ${keycloak.version} 41 | 42 | 43 | org.keycloak 44 | keycloak-server-spi-private 45 | provided 46 | ${keycloak.version} 47 | 48 | 49 | org.keycloak 50 | keycloak-services 51 | provided 52 | ${keycloak.version} 53 | 54 | 55 | org.keycloak 56 | keycloak-saml-core-public 57 | provided 58 | ${keycloak.version} 59 | 60 | 61 | 62 | 63 | com.rabbitmq 64 | amqp-client 65 | 5.14.2 66 | 67 | 68 | 69 | 70 | 71 | keycloak-to-rabbit 72 | 73 | 74 | org.apache.maven.plugins 75 | maven-compiler-plugin 76 | 77 | 1.8 78 | 1.8 79 | 80 | 81 | 82 | 83 | 84 | org.apache.maven.plugins 85 | maven-assembly-plugin 86 | 87 | ${jar.finalName} 88 | 89 | jar-with-dependencies 90 | 91 | false 92 | 93 | 94 | 95 | make-assembly 96 | package 97 | 98 | single 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | -------------------------------------------------------------------------------- /src/main/java/com/github/aznamier/keycloak/event/provider/EventAdminNotificationMqMsg.java: -------------------------------------------------------------------------------- 1 | package com.github.aznamier.keycloak.event.provider; 2 | 3 | import java.io.Serializable; 4 | 5 | import javax.xml.bind.annotation.XmlRootElement; 6 | 7 | import org.keycloak.events.admin.AdminEvent; 8 | 9 | import com.fasterxml.jackson.annotation.JsonIgnoreProperties; 10 | import com.fasterxml.jackson.annotation.JsonTypeInfo; 11 | import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; 12 | 13 | @JsonIgnoreProperties(ignoreUnknown = true) 14 | @XmlRootElement 15 | @JsonTypeInfo(use = Id.CLASS) 16 | public class EventAdminNotificationMqMsg extends AdminEvent implements Serializable { 17 | 18 | private static final long serialVersionUID = -7367949289101799624L; 19 | 20 | public static EventAdminNotificationMqMsg create(AdminEvent adminEvent) { 21 | EventAdminNotificationMqMsg msg = new EventAdminNotificationMqMsg(); 22 | msg.setAuthDetails(adminEvent.getAuthDetails()); 23 | msg.setError(adminEvent.getError()); 24 | msg.setOperationType(adminEvent.getOperationType()); 25 | msg.setRealmId(adminEvent.getRealmId()); 26 | msg.setRepresentation(adminEvent.getRepresentation()); 27 | msg.setResourcePath(adminEvent.getResourcePath()); 28 | msg.setResourceType(adminEvent.getResourceType()); 29 | msg.setResourceTypeAsString(adminEvent.getResourceTypeAsString()); 30 | msg.setTime(adminEvent.getTime()); 31 | return msg; 32 | } 33 | 34 | 35 | } 36 | -------------------------------------------------------------------------------- /src/main/java/com/github/aznamier/keycloak/event/provider/EventClientNotificationMqMsg.java: -------------------------------------------------------------------------------- 1 | package com.github.aznamier.keycloak.event.provider; 2 | 3 | import java.io.Serializable; 4 | 5 | import javax.xml.bind.annotation.XmlRootElement; 6 | 7 | import org.keycloak.events.Event; 8 | 9 | import com.fasterxml.jackson.annotation.JsonIgnoreProperties; 10 | import com.fasterxml.jackson.annotation.JsonTypeInfo; 11 | import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; 12 | 13 | @JsonIgnoreProperties(ignoreUnknown = true) 14 | @XmlRootElement 15 | @JsonTypeInfo(use = Id.CLASS) 16 | public class EventClientNotificationMqMsg extends Event implements Serializable { 17 | 18 | private static final long serialVersionUID = -2192461924304841222L; 19 | 20 | public static EventClientNotificationMqMsg create(Event event) { 21 | EventClientNotificationMqMsg msg = new EventClientNotificationMqMsg(); 22 | msg.setClientId(event.getClientId()); 23 | msg.setDetails(event.getDetails()); 24 | msg.setError(event.getError()); 25 | msg.setIpAddress(event.getIpAddress()); 26 | msg.setRealmId(event.getRealmId()); 27 | msg.setSessionId(event.getSessionId()); 28 | msg.setTime(event.getTime()); 29 | msg.setType(event.getType()); 30 | msg.setUserId(event.getUserId()); 31 | 32 | return msg; 33 | } 34 | 35 | 36 | } 37 | -------------------------------------------------------------------------------- /src/main/java/com/github/aznamier/keycloak/event/provider/RabbitMqConfig.java: -------------------------------------------------------------------------------- 1 | package com.github.aznamier.keycloak.event.provider; 2 | 3 | 4 | import org.jboss.logging.Logger; 5 | import org.keycloak.Config.Scope; 6 | import org.keycloak.events.Event; 7 | import org.keycloak.events.admin.AdminEvent; 8 | import org.keycloak.models.KeycloakSession; 9 | import org.keycloak.util.JsonSerialization; 10 | 11 | import java.util.Locale; 12 | import java.util.regex.Pattern; 13 | 14 | 15 | public class RabbitMqConfig { 16 | 17 | private static final Logger log = Logger.getLogger(RabbitMqConfig.class); 18 | public static final String ROUTING_KEY_PREFIX = "KK.EVENT"; 19 | private static final Pattern SPECIAL_CHARACTERS = Pattern.compile("[^*#a-zA-Z0-9 _.-]"); 20 | private static final Pattern SPACE = Pattern.compile(" "); 21 | private static final Pattern DOT = Pattern.compile("\\."); 22 | 23 | private String hostUrl; 24 | private Integer port; 25 | private String username; 26 | private String password; 27 | private String vhost; 28 | private Boolean useTls; 29 | 30 | // SSL context settings 31 | private String trustStore; 32 | private String trustStorePass; 33 | private String keyStore; 34 | private String keyStorePass; 35 | // 36 | 37 | 38 | private String exchange; 39 | 40 | public static String calculateRoutingKey(AdminEvent adminEvent, KeycloakSession session) { 41 | //KK.EVENT.ADMIN.... 42 | String routingKey = ROUTING_KEY_PREFIX 43 | + ".ADMIN" 44 | + "." + removeDots(session.getContext().getRealm().getName()) 45 | + "." + (adminEvent.getError() != null ? "ERROR" : "SUCCESS") 46 | + "." + adminEvent.getResourceTypeAsString() 47 | + "." + adminEvent.getOperationType().toString() 48 | 49 | ; 50 | return normalizeKey(routingKey); 51 | } 52 | 53 | public static String calculateRoutingKey(Event event, KeycloakSession session) { 54 | //KK.EVENT.CLIENT.... 55 | String routingKey = ROUTING_KEY_PREFIX 56 | + ".CLIENT" 57 | + "." + removeDots(session.realms().getRealm(event.getRealmId()).getName()) 58 | + "." + (event.getError() != null ? "ERROR" : "SUCCESS") 59 | + "." + removeDots(event.getClientId()) 60 | + "." + event.getType(); 61 | 62 | return normalizeKey(routingKey); 63 | } 64 | 65 | //Remove all characters apart a-z, A-Z, 0-9, space, underscore, replace all spaces and hyphens with underscore 66 | public static String normalizeKey(CharSequence stringToNormalize) { 67 | return SPACE.matcher(SPECIAL_CHARACTERS.matcher(stringToNormalize).replaceAll("")) 68 | .replaceAll("_"); 69 | } 70 | 71 | public static String removeDots(String stringToNormalize) { 72 | if(stringToNormalize != null) { 73 | return DOT.matcher(stringToNormalize).replaceAll(""); 74 | } 75 | return stringToNormalize; 76 | } 77 | 78 | public static String writeAsJson(Object object, boolean isPretty) { 79 | try { 80 | if(isPretty) { 81 | return JsonSerialization.writeValueAsPrettyString(object); 82 | } 83 | return JsonSerialization.writeValueAsString(object); 84 | 85 | } catch (Exception e) { 86 | log.error("Could not serialize to JSON", e); 87 | } 88 | return "unparseable"; 89 | } 90 | 91 | 92 | public static RabbitMqConfig createFromScope(Scope config) { 93 | RabbitMqConfig cfg = new RabbitMqConfig(); 94 | 95 | cfg.hostUrl = resolveConfigVar(config, "url", "localhost"); 96 | cfg.port = Integer.valueOf(resolveConfigVar(config, "port", "5672")); 97 | cfg.username = resolveConfigVar(config, "username", "admin"); 98 | cfg.password = resolveConfigVar(config, "password", "admin"); 99 | cfg.vhost = resolveConfigVar(config, "vhost", ""); 100 | cfg.useTls = Boolean.valueOf(resolveConfigVar(config, "use_tls", "false")); 101 | 102 | // SSL context settings 103 | cfg.trustStore = resolveConfigVar(config, "trust_store", ""); 104 | cfg.trustStorePass = resolveConfigVar(config, "trust_store_pass", ""); 105 | cfg.keyStore = resolveConfigVar(config, "key_store", ""); 106 | cfg.keyStorePass = resolveConfigVar(config, "key_store_pass", ""); 107 | // 108 | 109 | cfg.exchange = resolveConfigVar(config, "exchange", "amq.topic"); 110 | return cfg; 111 | 112 | } 113 | 114 | private static String resolveConfigVar(Scope config, String variableName, String defaultValue) { 115 | 116 | String value = defaultValue; 117 | if(config != null && config.get(variableName) != null) { 118 | value = config.get(variableName); 119 | } else { 120 | //try from env variables eg: KK_TO_RMQ_URL: 121 | String envVariableName = "KK_TO_RMQ_" + variableName.toUpperCase(Locale.ENGLISH); 122 | String env = System.getenv(envVariableName); 123 | if(env != null) { 124 | value = env; 125 | } 126 | } 127 | if (!"password".equals(variableName)) { 128 | log.infof("keycloak-to-rabbitmq configuration: %s=%s%n", variableName, value); 129 | } 130 | return value; 131 | 132 | } 133 | 134 | 135 | public String getHostUrl() { 136 | return hostUrl; 137 | } 138 | public void setHostUrl(String hostUrl) { 139 | this.hostUrl = hostUrl; 140 | } 141 | public Integer getPort() { 142 | return port; 143 | } 144 | public void setPort(Integer port) { 145 | this.port = port; 146 | } 147 | public String getUsername() { 148 | return username; 149 | } 150 | public void setUsername(String username) { 151 | this.username = username; 152 | } 153 | public String getPassword() { 154 | return password; 155 | } 156 | public void setPassword(String password) { 157 | this.password = password; 158 | } 159 | public String getVhost() { 160 | return vhost; 161 | } 162 | public void setVhost(String vhost) { 163 | this.vhost = vhost; 164 | } 165 | public Boolean getUseTls() { 166 | return useTls; 167 | } 168 | public void setUseTls(Boolean useTls) { 169 | this.useTls = useTls; 170 | } 171 | 172 | // setters and getters SSL context setting 173 | public void setTrustStore(String trustStore) { 174 | this.trustStore = trustStore; 175 | } 176 | public void setTrustStorePass(String trustStorePass) { 177 | this.trustStorePass = trustStorePass; 178 | } 179 | public void setKeyStore(String keyStore) { 180 | this.keyStore = keyStore; 181 | } 182 | public void setKeyStorePass(String keyStorePass) { 183 | this.keyStorePass = keyStorePass; 184 | } 185 | public String getTrustStore() { 186 | return trustStore; 187 | } 188 | public String getTrustStorePass() { 189 | return trustStorePass; 190 | } 191 | public String getKeyStore() { 192 | return keyStore; 193 | } 194 | public String getKeytStorePass() { 195 | return keyStorePass; 196 | } 197 | // 198 | 199 | public String getExchange() { 200 | return exchange; 201 | } 202 | public void setExchange(String exchange) { 203 | this.exchange = exchange; 204 | } 205 | 206 | } 207 | -------------------------------------------------------------------------------- /src/main/java/com/github/aznamier/keycloak/event/provider/RabbitMqEventListenerProvider.java: -------------------------------------------------------------------------------- 1 | package com.github.aznamier.keycloak.event.provider; 2 | 3 | import java.nio.charset.StandardCharsets; 4 | import java.util.HashMap; 5 | import java.util.Map; 6 | 7 | import org.jboss.logging.Logger; 8 | import org.keycloak.events.Event; 9 | import org.keycloak.events.EventListenerProvider; 10 | import org.keycloak.events.EventListenerTransaction; 11 | import org.keycloak.events.admin.AdminEvent; 12 | import org.keycloak.models.KeycloakSession; 13 | 14 | import com.rabbitmq.client.AMQP; 15 | import com.rabbitmq.client.AMQP.BasicProperties; 16 | import com.rabbitmq.client.AMQP.BasicProperties.Builder; 17 | import com.rabbitmq.client.Channel; 18 | 19 | public class RabbitMqEventListenerProvider implements EventListenerProvider { 20 | 21 | private static final Logger log = Logger.getLogger(RabbitMqEventListenerProvider.class); 22 | 23 | private final RabbitMqConfig cfg; 24 | private final Channel channel; 25 | 26 | private final KeycloakSession session; 27 | 28 | private final EventListenerTransaction tx = new EventListenerTransaction(this::publishAdminEvent, this::publishEvent); 29 | 30 | public RabbitMqEventListenerProvider(Channel channel, KeycloakSession session, RabbitMqConfig cfg) { 31 | this.cfg = cfg; 32 | this.channel = channel; 33 | this.session = session; 34 | session.getTransactionManager().enlistAfterCompletion(tx); 35 | } 36 | 37 | @Override 38 | public void close() { 39 | 40 | } 41 | 42 | @Override 43 | public void onEvent(Event event) { 44 | tx.addEvent(event.clone()); 45 | } 46 | 47 | @Override 48 | public void onEvent(AdminEvent adminEvent, boolean includeRepresentation) { 49 | tx.addAdminEvent(adminEvent, includeRepresentation); 50 | } 51 | 52 | private void publishEvent(Event event) { 53 | EventClientNotificationMqMsg msg = EventClientNotificationMqMsg.create(event); 54 | String routingKey = RabbitMqConfig.calculateRoutingKey(event, session); 55 | String messageString = RabbitMqConfig.writeAsJson(msg, true); 56 | 57 | BasicProperties msgProps = RabbitMqEventListenerProvider.getMessageProps(EventClientNotificationMqMsg.class.getName()); 58 | this.publishNotification(messageString, msgProps, routingKey); 59 | } 60 | 61 | private void publishAdminEvent(AdminEvent adminEvent, boolean includeRepresentation) { 62 | EventAdminNotificationMqMsg msg = EventAdminNotificationMqMsg.create(adminEvent); 63 | String routingKey = RabbitMqConfig.calculateRoutingKey(adminEvent, session); 64 | String messageString = RabbitMqConfig.writeAsJson(msg, true); 65 | 66 | BasicProperties msgProps = RabbitMqEventListenerProvider.getMessageProps(EventAdminNotificationMqMsg.class.getName()); 67 | this.publishNotification(messageString,msgProps, routingKey); 68 | } 69 | 70 | private static BasicProperties getMessageProps(String className) { 71 | 72 | Map headers = new HashMap<>(); 73 | headers.put("__TypeId__", className); 74 | 75 | Builder propsBuilder = new AMQP.BasicProperties.Builder() 76 | .appId("Keycloak") 77 | .headers(headers) 78 | .contentType("application/json") 79 | .contentEncoding("UTF-8"); 80 | return propsBuilder.build(); 81 | } 82 | 83 | private void publishNotification(String messageString, BasicProperties props, String routingKey) { 84 | try { 85 | channel.basicPublish(cfg.getExchange(), routingKey, props, messageString.getBytes(StandardCharsets.UTF_8)); 86 | log.tracef("keycloak-to-rabbitmq SUCCESS sending message: %s%n", routingKey); 87 | } catch (Exception ex) { 88 | log.errorf(ex, "keycloak-to-rabbitmq ERROR sending message: %s%n", routingKey); 89 | } 90 | } 91 | 92 | } -------------------------------------------------------------------------------- /src/main/java/com/github/aznamier/keycloak/event/provider/RabbitMqEventListenerProviderFactory.java: -------------------------------------------------------------------------------- 1 | package com.github.aznamier.keycloak.event.provider; 2 | 3 | import com.rabbitmq.client.Channel; 4 | import com.rabbitmq.client.Connection; 5 | import com.rabbitmq.client.ConnectionFactory; 6 | import java.io.IOException; 7 | import java.util.concurrent.TimeoutException; 8 | // 9 | import java.io.*; 10 | import java.security.*; 11 | import javax.net.ssl.*; 12 | // 13 | import org.jboss.logging.Logger; 14 | import org.keycloak.Config.Scope; 15 | import org.keycloak.events.EventListenerProvider; 16 | import org.keycloak.events.EventListenerProviderFactory; 17 | import org.keycloak.models.KeycloakSession; 18 | import org.keycloak.models.KeycloakSessionFactory; 19 | 20 | public class RabbitMqEventListenerProviderFactory implements EventListenerProviderFactory { 21 | 22 | private static final Logger log = Logger.getLogger(RabbitMqEventListenerProviderFactory.class); 23 | private RabbitMqConfig cfg; 24 | private ConnectionFactory connectionFactory; 25 | private Connection connection; 26 | private Channel channel; 27 | 28 | @Override 29 | public EventListenerProvider create(KeycloakSession session) { 30 | checkConnectionAndChannel(); 31 | return new RabbitMqEventListenerProvider(channel, session, cfg); 32 | } 33 | 34 | private synchronized void checkConnectionAndChannel() { 35 | try { 36 | if (connection == null || !connection.isOpen()) { 37 | this.connection = connectionFactory.newConnection(); 38 | } 39 | if (channel == null || !channel.isOpen()) { 40 | channel = connection.createChannel(); 41 | } 42 | } 43 | catch (IOException | TimeoutException e) { 44 | log.error("keycloak-to-rabbitmq ERROR on connection to rabbitmq", e); 45 | } 46 | } 47 | 48 | @Override 49 | public void init(Scope config) { 50 | cfg = RabbitMqConfig.createFromScope(config); 51 | this.connectionFactory = new ConnectionFactory(); 52 | 53 | this.connectionFactory.setUsername(cfg.getUsername()); 54 | this.connectionFactory.setPassword(cfg.getPassword()); 55 | this.connectionFactory.setVirtualHost(cfg.getVhost()); 56 | this.connectionFactory.setHost(cfg.getHostUrl()); 57 | this.connectionFactory.setPort(cfg.getPort()); 58 | this.connectionFactory.setAutomaticRecoveryEnabled(true); 59 | 60 | if (cfg.getUseTls()) { 61 | try { 62 | Boolean context = false; 63 | SSLContext c = SSLContext.getInstance("TLSv1.2"); 64 | 65 | TrustManagerFactory tmf = TrustManagerFactory.getInstance("SunX509"); 66 | if (! cfg.getTrustStore().isEmpty()){ 67 | char[] trustPassphrase = cfg.getTrustStorePass().toCharArray(); 68 | KeyStore tks = KeyStore.getInstance("JKS"); 69 | tks.load(new FileInputStream(cfg.getTrustStore()), trustPassphrase); 70 | 71 | tmf.init(tks); 72 | 73 | c.init(null, tmf.getTrustManagers(), null); 74 | context = true; 75 | } 76 | 77 | KeyManagerFactory kmf = KeyManagerFactory.getInstance("SunX509"); 78 | if (! cfg.getKeyStore().isEmpty()){ 79 | char[] keyPassphrase = cfg.getKeytStorePass().toCharArray(); 80 | KeyStore ks = KeyStore.getInstance("PKCS12"); 81 | ks.load(new FileInputStream(cfg.getKeyStore()), keyPassphrase); 82 | 83 | kmf.init(ks, keyPassphrase); 84 | 85 | if (context){ 86 | c.init(kmf.getKeyManagers(), tmf.getTrustManagers(), null); 87 | } 88 | else{ 89 | c.init(kmf.getKeyManagers(), null, null); 90 | context = true; 91 | } 92 | } 93 | 94 | if ( context ){ 95 | this.connectionFactory.useSslProtocol(c); 96 | } 97 | else { 98 | this.connectionFactory.useSslProtocol(); 99 | } 100 | 101 | } 102 | catch (Exception e) { 103 | log.error("Could not use SSL protocol", e); 104 | } 105 | } 106 | } 107 | 108 | @Override 109 | public void postInit(KeycloakSessionFactory factory) { 110 | 111 | } 112 | 113 | @Override 114 | public void close() { 115 | try { 116 | channel.close(); 117 | connection.close(); 118 | } 119 | catch (IOException | TimeoutException e) { 120 | log.error("keycloak-to-rabbitmq ERROR on close", e); 121 | } 122 | } 123 | 124 | @Override 125 | public String getId() { 126 | return "keycloak-to-rabbitmq"; 127 | } 128 | 129 | } 130 | -------------------------------------------------------------------------------- /src/main/resources/META-INF/services/org.keycloak.events.EventListenerProviderFactory: -------------------------------------------------------------------------------- 1 | com.github.aznamier.keycloak.event.provider.RabbitMqEventListenerProviderFactory -------------------------------------------------------------------------------- /utils/cli/KEYCLOAK_TO_RABBIT.cli: -------------------------------------------------------------------------------- 1 | embed-server --server-config=standalone-ha.xml --std-out=echo 2 | batch 3 | 4 | 5 | /subsystem=keycloak-server/spi=eventsListener/:add 6 | /subsystem=keycloak-server/spi=eventsListener/provider=keycloak-to-rabbitmq/:add(enabled="true") 7 | /subsystem=keycloak-server/spi=eventsListener/provider=keycloak-to-rabbitmq/:map-put(name=properties,key=url,value="${env.KK_TO_RMQ_URL:localhost}") 8 | /subsystem=keycloak-server/spi=eventsListener/provider=keycloak-to-rabbitmq/:map-put(name=properties,key=username,value="${env.KK_TO_RMQ_USERNAME:admin}") 9 | /subsystem=keycloak-server/spi=eventsListener/provider=keycloak-to-rabbitmq/:map-put(name=properties,key=password,value="${env.KK_TO_RMQ_PASSWORD:admin}") 10 | /subsystem=keycloak-server/spi=eventsListener/provider=keycloak-to-rabbitmq/:map-put(name=properties,key=vhost,value="${env.KK_TO_RMQ_VHOST:}") 11 | /subsystem=keycloak-server/spi=eventsListener/provider=keycloak-to-rabbitmq/:map-put(name=properties,key=port,value=${env.KK_TO_RMQ_PORT:5672}) 12 | /subsystem=keycloak-server/spi=eventsListener/provider=keycloak-to-rabbitmq/:map-put(name=properties,key=exchange,value="${env.KK_TO_RMQ_EXCHANGE:amq.topic}") 13 | /subsystem=keycloak-server/spi=eventsListener/provider=keycloak-to-rabbitmq/:map-put(name=properties,key=use_tls,value="${env.KK_TO_RMQ_USE_TLS:false}") 14 | /subsystem=keycloak-server/spi=eventsListener/provider=keycloak-to-rabbitmq/:map-put(name=properties,key=key_store,value="${env.KK_TO_RMQ_KEY_STORE:false}") 15 | /subsystem=keycloak-server/spi=eventsListener/provider=keycloak-to-rabbitmq/:map-put(name=properties,key=key_store_pass,value="${env.KK_TO_RMQ_KEY_STORE_PASS:false}") 16 | /subsystem=keycloak-server/spi=eventsListener/provider=keycloak-to-rabbitmq/:map-put(name=properties,key=trust_store,value="${env.KK_TO_RMQ_TRUST_STORE:false}") 17 | /subsystem=keycloak-server/spi=eventsListener/provider=keycloak-to-rabbitmq/:map-put(name=properties,key=trust_store_pass,value="${env.KK_TO_RMQ_TRUST_STORE_PASS:false}") 18 | 19 | 20 | run-batch 21 | stop-embedded-server -------------------------------------------------------------------------------- /utils/cli/usage.txt: -------------------------------------------------------------------------------- 1 | KEYCLOAK_TO_RABBIT.cli 2 | 3 | To use it put it into /opt/jboss/startup-scripts/ 4 | 5 | This will install this pluging into WildFly configuration XML on a startup 6 | --------------------------------------------------------------------------------