├── .gitreview
├── .zuul.yaml
├── LICENSE
├── README.md
├── demo.sh
├── pom.xml
├── src
└── main
│ └── java
│ └── org
│ └── softwarefactory
│ └── keycloak
│ └── social
│ └── github
│ └── GithubSSHKeyMapper.java
└── testing
├── Dockerfile
└── docker-compose.yaml
/.gitreview:
--------------------------------------------------------------------------------
1 | [gerrit]
2 | host=softwarefactory-project.io
3 | port=29418
4 | project=software-factory/keycloak-github-ssh-key-attribute-mapper
5 | defaultbranch=master
6 |
--------------------------------------------------------------------------------
/.zuul.yaml:
--------------------------------------------------------------------------------
1 | ---
2 | - project:
3 | check:
4 | jobs:
5 | - keycloak-extensions-maven-build:
6 | vars:
7 | jdk_version: 17
8 | - keycloak-extensions-test-deploy-23.0:
9 | vars:
10 | jdk_version: 17
11 | - keycloak-extensions-test-deploy-latest:
12 | voting: false
13 | gate:
14 | jobs:
15 | - keycloak-extensions-maven-build:
16 | vars:
17 | jdk_version: 17
18 | - keycloak-extensions-test-deploy-23.0:
19 | vars:
20 | jdk_version: 17
21 | - keycloak-extensions-test-deploy-latest:
22 | voting: false
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
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-github-ssh-key-attribute-mapper
2 |
3 | This custom attribute mapper can be used to fetch a user's public SSH key whenever they log in with Github, and store it into a custom attribute.
4 |
5 | # Build
6 |
7 | ```
8 | mvn clean install
9 | ```
10 |
11 | To build the SPI for use with a version of Keycloak prior to 22.X, you need to use openjdk 11 and patch pom.xml to target java 11:
12 |
13 | ```
14 | 11
15 | 11
16 | ```
17 |
18 | # Prerequisites
19 |
20 | A SQL database backend is required. The user attributes table must be manually modified to allow larger attributes like public keys.
21 |
22 | Example for mariadb/mysql:
23 |
24 | `alter table USER_ATTRIBUTE drop index IDX_USER_ATTRIBUTE_NAME; alter table USER_ATTRIBUTE modify VALUE TEXT(100000) CHARACTER SET utf8 COLLATE utf8_general_ci; alter table USER_ATTRIBUTE ADD KEY IDX_USER_ATTRIBUTE_NAME (NAME, VALUE(400));`
25 |
26 | # Deploy (Wildfly)
27 |
28 | Copy the built jar into {KEYCLOAK_HOME}/standalone/deployments
29 |
30 | # Deploy (Quarkus)
31 |
32 | Copy the built jar into /opt/keycloak/providers
33 |
34 | # Testing it out
35 |
36 | The `testing` directory contains a Dockerfile that can be used to generate an optimized keycloak image with the mapper preinstalled.
37 |
38 | There is also a compose spinning up keycloak, the mapper, and a mariadb instance - but the database needs to be modified manually (a Github oauth provider as well).
39 |
40 | The `demo.sh` script automates everything, but requires the following preparation:
41 |
42 | * Create a Github OAuth app for your test deployment, the callback URL will be http://localhost:8082/realms/test/broker/github/endpoint
43 | * Set the environment variables GH_CLIENT_ID and GH_CLIENT_PASSWORD to the generated client ID and password, respectively
44 | * run `demo.sh`
45 | * Log in with Github when prompted and press any key to display the user's attributes, your SSH key should appear in "pubKey".
--------------------------------------------------------------------------------
/demo.sh:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | # Set up keycloak and a mariadb backend to test the github ssh key mapper manually.
4 | # Set env variable KEYCLOAK_VERSION to any version you would like to
5 | # test the mapper against (it must be Quarkus-based so > 17)
6 |
7 | # TODO support docker and choose the runtime to use automatically
8 |
9 | echo "Building event listener provider ..."
10 | mvn clean install
11 | echo "Done."
12 | echo
13 |
14 | echo "Building keycloak with github ssh key mapper ..."
15 | podman build -t test_kc_github_ssh_key_mapper --build-arg KEYCLOAK_VERSION=${KEYCLOAK_VERSION:-22.0} -f testing/Dockerfile .
16 | echo "Done."
17 | echo
18 |
19 | echo "Starting compose ..."
20 | podman-compose -f testing/docker-compose.yaml up -d
21 | echo
22 | echo "Waiting for keycloak to start ..."
23 | until curl -s -f -o /dev/null http://localhost:8082/health/ready
24 | do
25 | echo "."
26 | sleep 5
27 | done
28 | echo "Ready."
29 |
30 | KC_CFG="--no-config --user admin --realm master --server http://localhost:8082 --password kcadmin"
31 |
32 | echo "Patching database ..."
33 | podman exec -ti testing_db_1 mysql -u keycloak -pkeycloak keycloak -e "alter table USER_ATTRIBUTE drop index IDX_USER_ATTRIBUTE_NAME; alter table USER_ATTRIBUTE modify VALUE TEXT(100000) CHARACTER SET utf8 COLLATE utf8_general_ci; alter table USER_ATTRIBUTE ADD KEY IDX_USER_ATTRIBUTE_NAME (NAME, VALUE(400));"
34 | echo "Done."
35 | echo
36 |
37 | echo "Creating test realm and adding github auth ..."
38 | podman exec -ti testing_keycloak_1 /opt/keycloak/bin/kcadm.sh create realms \
39 | --set realm=test \
40 | --set enabled=true \
41 | $KC_CFG
42 | podman exec -ti testing_keycloak_1 /opt/keycloak/bin/kcadm.sh create identity-provider/instances \
43 | --target-realm test \
44 | --set alias=github \
45 | --set providerId=github \
46 | --set enabled=true \
47 | --set 'config.useJwksUrl="true"' \
48 | --set config.clientId=$GH_CLIENT_ID \
49 | --set config.clientSecret=$GH_CLIENT_PASSWORD \
50 | $KC_CFG
51 | podman exec -ti testing_keycloak_1 /opt/keycloak/bin/kcadm.sh create identity-provider/instances/github/mappers \
52 | --target-realm test \
53 | --set name=pubkey_mapper \
54 | --set identityProviderMapper=github-ssh-key-mapper \
55 | --set 'config={"keyAttribute":"publicKey"}' \
56 | --set identityProviderAlias=github \
57 | $KC_CFG
58 | echo "Done."
59 | echo
60 |
61 | read -n 1 -s -r -p "Log in with Github at: http://localhost:8082/realms/test/account/#/, then press any key to display user info"
62 |
63 | podman exec -ti testing_keycloak_1 /opt/keycloak/bin/kcadm.sh get users \
64 | -r test \
65 | --limit 1 \
66 | $KC_CFG
--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
1 |
17 |
20 | org.softwarefactory.keycloak.social.github.sshkeysmapper
21 | 2.0.0
22 |
23 | Keycloak: Github provider SSH keys mapper
24 |
25 | 4.0.0
26 |
27 | github-ssh-mapper
28 | jar
29 |
30 |
31 |
32 | UTF-8
33 | 17
34 | ${java.version}
35 | ${java.version}
36 |
37 |
38 | 22.0.0
39 |
40 | 1.18.26
41 | 1.0-rc7
42 |
43 |
44 |
45 |
46 |
47 | org.apache.httpcomponents
48 | httpclient
49 | 4.5.14
50 |
51 |
52 | org.projectlombok
53 | lombok
54 | true
55 | ${lombok.version}
56 |
57 |
58 |
59 | com.google.auto.service
60 | auto-service
61 | true
62 | ${auto-service.version}
63 |
64 |
65 |
66 | org.keycloak
67 | keycloak-server-spi
68 | ${keycloak.version}
69 | provided
70 |
71 |
72 |
73 | org.keycloak
74 | keycloak-server-spi-private
75 | ${keycloak.version}
76 | provided
77 |
78 |
79 |
80 | org.keycloak
81 | keycloak-services
82 | ${keycloak.version}
83 | provided
84 |
85 |
86 |
87 |
88 |
89 |
90 | org.apache.maven.plugins
91 | maven-jar-plugin
92 | 3.2.0
93 |
94 |
95 |
97 |
98 |
100 |
101 |
102 |
103 |
104 |
105 |
106 |
107 |
108 |
--------------------------------------------------------------------------------
/src/main/java/org/softwarefactory/keycloak/social/github/GithubSSHKeyMapper.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2019 Red Hat, Inc. and/or its affiliates
3 | * and other contributors as indicated by the @author tags.
4 | *
5 | * Licensed under the Apache License, Version 2.0 (the "License");
6 | * you may not use this file except in compliance with the License.
7 | * 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, software
12 | * distributed under the License is distributed on an "AS IS" BASIS,
13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | * See the License for the specific language governing permissions and
15 | * limitations under the License.
16 | */
17 |
18 | package org.softwarefactory.keycloak.social.github;
19 |
20 | import com.fasterxml.jackson.databind.JsonNode;
21 | import com.fasterxml.jackson.databind.node.ArrayNode;
22 | import com.google.auto.service.AutoService;
23 | import lombok.extern.jbosslog.JBossLog;
24 | import org.keycloak.broker.provider.AbstractIdentityProviderMapper;
25 | import org.keycloak.broker.provider.BrokeredIdentityContext;
26 | import org.keycloak.broker.provider.IdentityBrokerException;
27 | import org.keycloak.broker.provider.IdentityProviderMapper;
28 | import org.keycloak.broker.provider.util.SimpleHttp;
29 | import org.keycloak.models.IdentityProviderMapperModel;
30 | import org.keycloak.models.IdentityProviderMapperSyncMode;
31 | import org.keycloak.models.KeycloakSession;
32 | import org.keycloak.models.RealmModel;
33 | import org.keycloak.models.UserModel;
34 | import org.keycloak.provider.ProviderConfigProperty;
35 |
36 | import java.util.ArrayList;
37 | import java.util.Collections;
38 | import java.util.Iterator;
39 | import java.util.List;
40 | import java.util.function.BiConsumer;
41 |
42 | @JBossLog
43 | @AutoService(IdentityProviderMapper.class)
44 | public class GithubSSHKeyMapper extends AbstractIdentityProviderMapper {
45 |
46 | private static final String[] COMPATIBLE_PROVIDERS = {"github"};
47 |
48 | public static final String SSH_KEYS_URL = "https://api.github.com/users/%s/keys";
49 |
50 | public static final String CONF_KEY_ATTRIBUTE = "keyAttribute";
51 |
52 | private static final List configProperties;
53 |
54 | static {
55 | ProviderConfigProperty keysAttributeProperty = new ProviderConfigProperty();
56 | keysAttributeProperty.setName(CONF_KEY_ATTRIBUTE);
57 | keysAttributeProperty.setLabel("User Attribute Name");
58 | keysAttributeProperty.setHelpText("User attribute name to store the SSH public keys into.");
59 | keysAttributeProperty.setType("String");
60 | configProperties = Collections.singletonList(keysAttributeProperty);
61 | }
62 |
63 | public String[] getCompatibleProviders() {
64 | return COMPATIBLE_PROVIDERS;
65 | }
66 |
67 | public String getId() {
68 | return "github-ssh-key-mapper";
69 | }
70 |
71 | public List getConfigProperties() {
72 | return configProperties;
73 | }
74 |
75 | public String getDisplayCategory() {
76 | return "SSH Keys Importer";
77 | }
78 |
79 | public String getDisplayType() {
80 | return "SSH Keys Importer";
81 | }
82 |
83 | public String getHelpText() {
84 | return "Import user SSH keys into the specified user attribute.";
85 | }
86 |
87 | @SuppressWarnings("unchecked")
88 | public void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
89 |
90 | if (!IdentityProviderMapperSyncMode.FORCE.equals(mapperModel.getSyncMode())) {
91 | return;
92 | }
93 |
94 | fetchKeysAndUpdateAttributes(session, mapperModel, context, (keyAttribute, keys) -> {
95 | if (keys instanceof List) {
96 | user.setAttribute(keyAttribute, (List) keys);
97 | } else {
98 | user.setSingleAttribute(keyAttribute, keys.toString());
99 | }
100 | });
101 | }
102 |
103 | @SuppressWarnings("unchecked")
104 | public void preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
105 |
106 | fetchKeysAndUpdateAttributes(session, mapperModel, context, (keyAttribute, keys) -> {
107 |
108 | if (keys instanceof List) {
109 | context.setUserAttribute(keyAttribute, (List) keys);
110 | } else {
111 | context.setUserAttribute(keyAttribute, keys.toString());
112 | }
113 | });
114 | }
115 |
116 | private void fetchKeysAndUpdateAttributes(KeycloakSession session, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context, BiConsumer updater) {
117 |
118 | String attribute = getKeyAttribute(mapperModel);
119 | if (attribute == null) {
120 | return;
121 | }
122 |
123 | Object value = getKeys(context, session);
124 |
125 | if (value == null) {
126 | return;
127 | }
128 |
129 | updater.accept(attribute, value);
130 | }
131 |
132 | private String getKeyAttribute(IdentityProviderMapperModel mapperModel) {
133 |
134 | String attribute = mapperModel.getConfig() == null ? null : mapperModel.getConfig().get(CONF_KEY_ATTRIBUTE);
135 | if (attribute == null || attribute.trim().isEmpty()) {
136 | log.warnf("Attribute is not configured for mapper %s", mapperModel.getName());
137 | return null;
138 | }
139 | return attribute.trim();
140 | }
141 |
142 | protected static Object getKeys(BrokeredIdentityContext context, KeycloakSession session) {
143 |
144 | String keysUrl = String.format(SSH_KEYS_URL, context.getUsername());
145 |
146 | List keys = new ArrayList<>();
147 | try {
148 | ArrayNode keyList = (ArrayNode) SimpleHttp.doGet(keysUrl, session).asJson();
149 | Iterator loop = keyList.elements();
150 | while (loop.hasNext()) {
151 | JsonNode key = loop.next();
152 | keys.add(key.get("key").textValue());
153 | }
154 | return keys;
155 | } catch (Exception e) {
156 | throw new IdentityBrokerException("Could not obtain user public keys from github.", e);
157 | }
158 | }
159 | }
160 |
--------------------------------------------------------------------------------
/testing/Dockerfile:
--------------------------------------------------------------------------------
1 | ARG KEYCLOAK_VERSION=22.0
2 |
3 | FROM quay.io/keycloak/keycloak:$KEYCLOAK_VERSION as builder
4 |
5 | # Install built provider - this assumes "maven clean build" was run before
6 | COPY ./target/*.jar /opt/keycloak/providers/
7 |
8 | USER 1000
9 |
10 | RUN /opt/keycloak/bin/kc.sh build --health-enabled=true
11 |
12 | FROM quay.io/keycloak/keycloak:$KEYCLOAK_VERSION
13 | COPY --from=builder /opt/keycloak/ /opt/keycloak/
14 | WORKDIR /opt/keycloak
15 |
16 |
17 | ENTRYPOINT ["/opt/keycloak/bin/kc.sh"]
--------------------------------------------------------------------------------
/testing/docker-compose.yaml:
--------------------------------------------------------------------------------
1 | services:
2 | db:
3 | image: docker.io/mariadb:latest
4 | environment:
5 | MARIADB_USER: keycloak
6 | MARIADB_DATABASE: keycloak
7 | MARIADB_PASSWORD: keycloak
8 | MARIADB_ROOT_PASSWORD: password
9 | ports:
10 | - "3306:3306"
11 | networks:
12 | - test_kc
13 | healthcheck:
14 | test: [ "CMD", "mysqladmin", "ping", "--silent" ]
15 | keycloak:
16 | depends_on:
17 | - db
18 | image: localhost/test_kc_github_ssh_key_mapper
19 | build:
20 | context: ../
21 | dockerfile: ./testing/Dockerfile
22 | args: "KEYCLOAK_VERSION=$KEYCLOAK_VERSION"
23 | environment:
24 | KEYCLOAK_ADMIN: admin
25 | KEYCLOAK_ADMIN_PASSWORD: kcadmin
26 | KC_DB_USERNAME: keycloak
27 | KC_DB_PASSWORD: keycloak
28 | KC_HTTP_PORT: 8082
29 | KC_HEALTH_ENABLED: true
30 | KC_LOG_LEVEL: debug
31 | JGROUPS_DISCOVERY_PROTOCOL: JDBC_PING
32 | command:
33 | - "start-dev"
34 | - "--db=mariadb"
35 | - "--db-url=jdbc:mariadb://db/keycloak"
36 | ports:
37 | - "8082:8082"
38 | networks:
39 | - test_kc
40 | networks:
41 | test_kc:
42 | driver: bridge
43 |
--------------------------------------------------------------------------------