├── .gitignore ├── Dockerfile ├── LICENSE ├── README.md ├── docker-compose.yml ├── docs └── images │ └── How_Keycloak_Auth_Proxy_works.svg ├── openshift_template.yml ├── proxy.json ├── proxy.tmpl └── start-proxy.sh /.gitignore: -------------------------------------------------------------------------------- 1 | .history 2 | .env -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM quay.io/gambol99/keycloak-proxy:v2.1.1 2 | EXPOSE 8080 3 | COPY start-proxy.sh . 4 | RUN chmod -R g+rwX . && chmod 755 -R . 5 | ENTRYPOINT [] 6 | CMD ["/opt/start-proxy.sh"] -------------------------------------------------------------------------------- /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 Auth Proxy 2 | 3 | [![Docker Automated build](https://img.shields.io/docker/automated/8gears/keycloak-auth-proxy.svg?style=flat-square)](https://hub.docker.com/r/8gears/keycloak-auth-proxy/) 4 | [![Docker Pulls](https://img.shields.io/docker/pulls/8gears/keycloak-auth-proxy.svg?style=flat-square)](https://hub.docker.com/r/8gears/keycloak-auth-proxy/) 5 | [![Docker Stars](https://img.shields.io/docker/stars/8gears/keycloak-auth-proxy.svg?style=flat-square)](https://hub.docker.com/r/8gears/keycloak-auth-proxy/) 6 | [![MicroBadger Size](https://img.shields.io/microbadger/image-size/8gears/keycloak-auth-proxy.svg?style=flat-square)](https://hub.docker.com/r/8gears/keycloak-auth-proxy/) 7 | 8 | The Reverse Auth Proxy in a Docker Container the provides OpenID Connect/OAuth authentication and authorization for HTTP services that that can't or won't do it themself. 9 | 10 | This Auth Proxy Service uses [gambol99/keycloak-proxy](https://github.com/gambol99/keycloak-proxy), which is a Java/Undertow solution designed for Keycloak. However it should also work with any other OpenID Connect Provider. 11 | 12 | What makes this project special is, that it can be configured with environment variables and can be easily deployed to Docker, Kubernetes or OpenShift. 13 | 14 | ## Mode of operation 15 | 16 | ![How reverse auth proxy works][prx_diag] 17 | 18 | 1. External traffic is directed to the auth proxy. The Auth proxy decides based on it configuration if the destination needs authentication. 19 | 2. The Auth Proxy work together with the IAM (Keycloak) and redirects the user to the IAM so the user can login. 20 | 3. After a successful login the proxy forwards the user to the protected content. According to proxy configuration setting the proxy checks if the user is allowed to access the path. 21 | 22 | ## Typical Use cases 23 | 24 | There are two very common use cases why one would use the Keycloak Auth Proxy in combination with an Identity & Access Management Service (IAM). 25 | 26 | It is recommended that every service that needs authentication has a dedicated auth proxy in front of it. 27 | 28 | - Protect static websites from unauthorized access, allowing only authenticated users to see the content. 29 | This is useful in combination with static website generator or other generated documentation. 30 | - Outsource the authentication/authorization step to Keycloak Auth Proxy and just relay on the forward HTTP headers with username/grants in the upstream application. 31 | This approach can be handy if you have an application, where there are no OpenID Connect library or if you don't won't perform to many changes in the application. 32 | 33 | ## Usage 34 | 35 | There are three ways how the proxy can be configured. 36 | The proxy configuration settings can be set with environment variables,environment variables plus config template or with the file `proxy.json` mounted as a volume to `/app/proxy.json`. 37 | 38 | The option that you choose depend on the use case. For simple static website auth the default proxy template is sufficient. For more complex scenarios the custom Proxy Config Template is able cover all possible options. 39 | 40 | ### Running with the default Proxy Config Template 41 | 42 | In the simplest case the only thing you need to do is to set the mandatory environment variables. Prior the execution the variables merged with the default proxy config and then the proxy application is started. 43 | 44 | ```sh 45 | docker run -ti \ 46 | -e TARGET_URL=asdf \ 47 | -e REALM="realm" \ 48 | -e REALM_PUBLIC_KEY='pub' 49 | -e .... \ 50 | 8gears/keycloak-auth-proxy 51 | ``` 52 | 53 | With Docker Compose download the default docker-compose.yml 54 | 55 | ```sh 56 | wget https://raw.githubusercontent.com/8gears/keycloak-auth-proxy/master/docker-compose.yml 57 | ``` 58 | 59 | Adapt the mandatory env variables in `docker-compose.yml` and hit: 60 | 61 | ```sh 62 | docker-compose - up 63 | ``` 64 | 65 | ### Running with custom Proxy Config Template 66 | 67 | In order to combine the simplicity of the environment variables with the flexibility of the custom proxy config it is possible to provide your own template. 68 | 69 | Take the existing `proxy.tmpl` from this repository and extended it to your need. 70 | When you are done with the template minfy the content and set the variable ??`PROXY_TMPL` with the content. 71 | 72 | ```sh 73 | docker run -ti \ 74 | -e PROXY_TMPL={"target-url": "http://172.17.0.2:2015","bind-address": "0.0.0.0", .... 75 | -e TARGET_URL=asdf \ 76 | -e REALM="realm" \ 77 | -e REALM_PUBLIC_KEY='pub' 78 | -e .... \ 79 | 8gears/keycloak-auth-proxy 80 | ``` 81 | 82 | ### Running with custom Proxy Config 83 | 84 | Write your `proxy.json` file and mount it to `/app/proxy.json`. Prior start the Auth proxy startup script will check if the file exist and start the proxy with the provided file ignoring the template or any provided environment variables. 85 | 86 | Instead of mapping you can provide the content via environment variable ?`PROXY_JSON` just like in the template example above. 87 | 88 | ```sh 89 | docker run -v proxy.json:/app/proxy.json 8gears/keycloak-auth-proxy 90 | ``` 91 | 92 | ## Environment Variables 93 | 94 | Can be used if you want to auth one service. 95 | 96 | See the file [proxy.tmpl](proxy.tmpl) 97 | 98 | Variables without default values are mandatory. 99 | 100 | - `TARGET_URL` The URL to forward the traffic through 101 | - `HTTP_PORT` (default `8080`) The port to bind the Auth Proxy too 102 | - `BASE_PATH` (default `/` ) 103 | - `REALM` Adapter config realm 104 | - `REALM_PUBLIC_KEY` Realm public key 105 | - `AUTH_SERVER_URL` The auth server URL 106 | - `RESOURCE` (default `account`) The resource to request aka client id 107 | - `SECRET` Credential secret 108 | - `CONSTRAINT_PATH` (default `/*`) You can define multiple path but they must be separated with an `;` 109 | - `PROXY_TMPL` Instead of using the provided proxy config it is possible to provide a custom config. 110 | 111 | ## OpenShift Deployment 112 | 113 | In OpenShift you can create the service from the template `openshift_template.yml` by using the Web UI or CLI. 114 | 115 | Copy the content of `openshift_template.yml` and paste it to the _Import YAML / JSON_ tab in the service catalog. 116 | The OpenShift has a [detailed tutorial]([create_from_ui]) that covers the manual template instantiation. 117 | 118 | From the CLI execute the first command with the `--parameter` argument to get a list of all the possible parameters. 119 | Next in the second command add all the needed parameters and pipe it to create. 120 | 121 | ```sh 122 | oc process --parameter -f https://raw.githubusercontent.com/8gears/keycloak-auth-proxy/master/openshift_template.yml 123 | 124 | oc process -f https://raw.githubusercontent.com/8gears/keycloak-auth-proxy/master/openshift_template.yml \ 125 | -p TARGET_URL=http://service-name:123 \ 126 | -p REALM=app42 \ 127 | | oc create -f - 128 | ``` 129 | 130 | ### OpenShift Service Catalog import 131 | 132 | Import the template to the current namespace service catalog. 133 | 134 | ```sh 135 | oc create -f https://raw.githubusercontent.com/8gears/keycloak-auth-proxy/master/openshift_template.yml 136 | ``` 137 | 138 | Import template to global service catalog, so all users in all namespaces can use that template. 139 | 140 | ```sh 141 | oc create -f https://raw.githubusercontent.com/8gears/keycloak-auth-proxy/master/openshift_template.yml -n openshift 142 | ``` 143 | 144 | ## Alternatives 145 | 146 | Despite the uniqueness of _keycloak-auth-proxy_ there are other project that solve the similar problem differently. 147 | 148 | - [OpenID / Keycloak Proxy service](https://github.com/gambol99/keycloak-proxy) This in Golang written proxy should work nicely with Keycloak and might be a value alternative to the current jvm proxy. 149 | - [OAuth2 Proxy](https://github.com/bitly/oauth2_proxy) 150 | - [Lua Resty OpenID/Connect](https://github.com/pingidentity/lua-resty-openidc) This library is designed for Nginx/OpenResty. 151 | 152 | 153 | 154 | [kcp]: https://github.com/keycloak/keycloak/tree/master/proxy 155 | [prx_diag]: https://cdn.rawgit.com/8gears/keycloak-auth-proxy/master/docs/images/How_Keycloak_Auth_Proxy_works.svg 156 | [create_from_ui]: https://docs.openshift.org/latest/dev_guide/templates.html#creating-from-templates-using-the-web-console 157 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '3' 2 | services: 3 | auth-proxy: 4 | build: . 5 | ports: 6 | - "8080:80" 7 | # This placeholders should be overwritten with the .env file or environmenr variables 8 | environment: 9 | - PROXY_DISCOVERY_URL 10 | - PROXY_CLIENT_ID 11 | - PROXY_CLIENT_SECRET 12 | - PROXY_ENABLE_REFRESH_TOKEN 13 | - PROXY_SECURE_COOKIE 14 | - PROXY_ENCRYPTION_KEY 15 | - PROXY_UPSTREAM_URL 16 | - PROXY_RESOURCES 17 | - PROXY_MATCH_CLAIMS 18 | # Demo Application 19 | demoapp: 20 | image: vad1mo/hello-world-rest 21 | ports: 22 | - "5050:5050" -------------------------------------------------------------------------------- /docs/images/How_Keycloak_Auth_Proxy_works.svg: -------------------------------------------------------------------------------- 1 | 2 |
Keycloak
Keycloak
Auth Proxy
Auth Proxy<br>
Protected Content
<span>Protected Content</span>
1
1
2
2
3
3 -------------------------------------------------------------------------------- /openshift_template.yml: -------------------------------------------------------------------------------- 1 | kind: Template 2 | apiVersion: v1 3 | metadata: 4 | name: keycloak-auth-proxy 5 | annotations: 6 | 'openshift.io/display-name': Reverse Authentication Proxy 7 | description: | 8 | The Keycloak Auth Proxy provides OpenID Connect/OAuth authentication and authorization for web resources that have no build in authentication. 9 | iconClass: fa fa-address-card-o 10 | tags: 'Authentication, Proxy, OIDC, OpenID, Reverse Proxy' 11 | 12 | parameters: 13 | - name: NAME 14 | displayName: Name 15 | value: keycloak-auth-proxy 16 | description: The name of the service 17 | required: false 18 | - name: APP_NAME 19 | displayName: The App Name 20 | value: keycloak-auth-proxy 21 | description: The application name, by default same as name. 22 | required: false 23 | - name: HOST_NAME 24 | displayName: The external proxy host name 25 | value: HOST_NAME 26 | description: The full qualified external proxy host name 27 | required: false 28 | - name: DISCOVERY_URL 29 | displayName: Discovery URL 30 | description: Discovery url to retrieve the openid configuration. Normally for keycloak its /auth/realm/ 31 | value: https://auth.domain.io/auth/realms/8gears 32 | required: true 33 | - name: CLIENT_ID 34 | displayName: Client ID 35 | description: Specifies ID referenced in URI and tokens. For example 'my-client'. For SAML this is also the expected issuer value from authn requests 36 | value: account 37 | required: true 38 | - name: CLIENT_SECRET 39 | displayName: Client Secret 40 | description: Client secret used to authenticate to the oauth service 41 | required: true 42 | - name: LISTEN 43 | displayName: Proxy Listen Port 44 | description: The interface definition you wish the proxy to listen, all interfaces is specified as ':', unix sockets as unix://| 45 | value: :8080 46 | required: false 47 | - name: ENABLE_REFRESH_TOKENS 48 | displayName: Refresh Token Enabled 49 | description: Enables the handling of the refresh tokens 50 | value: 'true' 51 | required: false 52 | - name: REDIRECTION_URL 53 | displayName: The redirect URL 54 | description: Redirection url for the oauth callback url, defaults to host header is absent. 55 | required: false 56 | - name: SECURE_COOKIE 57 | displayName: Secure Cookie 58 | description: Enforces the cookie to be secure. Works only with Secure redirect URL 59 | value: 'false' 60 | required: false 61 | - name: ENCRYPTION_KEY 62 | displayName: Encryption key 63 | description: Encryption key used to encryption the session state 64 | from: '[a-zA-Z0-9]{32}' 65 | generate: 'expression' 66 | - name: UPSTREAM_URL 67 | displayName: Upstrean URL 68 | description: URL for the upstream endpoint you wish to proxy the traffic too. 69 | value: 'http://example.org/' 70 | required: true 71 | - name: RESOURCES 72 | displayName: Resources 73 | description: list of resources 'uri=/admin|methods=GET,PUT|roles=role1,role2' 74 | value: 'uri=/*' 75 | required: true 76 | - name: PROXY_CONFIG 77 | displayName: Proxy Configuration File 78 | description: Provide the complete content of a custom config file that should be used instead of the default one. 79 | required: false 80 | - name: MATCH_CLAIMS 81 | displayName: Token claim matching for additional ACL controls 82 | description: eypair values for matching access token claims e.g. aud=myapp, iss=http://example.*, email=^.*@domain.com$ 83 | required: false 84 | objects: 85 | - kind: Service 86 | apiVersion: v1 87 | metadata: 88 | name: ${NAME} 89 | labels: 90 | app: ${APP_NAME} 91 | app-component: ${NAME} 92 | spec: 93 | ports: 94 | - name: 8080-tcp 95 | protocol: TCP 96 | port: 8080 97 | targetPort: 8080 98 | selector: 99 | deploymentconfig: ${NAME} 100 | - kind: Route 101 | apiVersion: v1 102 | metadata: 103 | name: ${NAME} 104 | labels: 105 | app: ${APP_NAME} 106 | app-component: ${NAME} 107 | spec: 108 | host: ${HOST_NAME} 109 | to: 110 | kind: Service 111 | name: ${NAME} 112 | tls: 113 | termination: edge 114 | 115 | - kind: DeploymentConfig 116 | apiVersion: v1 117 | metadata: 118 | name: ${NAME} 119 | labels: 120 | app: ${APP_NAME} 121 | app-component: ${NAME} 122 | spec: 123 | replicas: 1 124 | selector: 125 | app: ${APP_NAME} 126 | deploymentconfig: ${NAME} 127 | strategy: 128 | type: Rolling 129 | 130 | template: 131 | metadata: 132 | labels: 133 | app: ${APP_NAME} 134 | app-component: ${NAME} 135 | deploymentconfig: ${NAME} 136 | spec: 137 | containers: 138 | - name: ${NAME} 139 | image: 8gears/keycloak-auth-proxy:2.1.1 140 | ports: 141 | - containerPort: 8080 142 | protocol: TCP 143 | env: 144 | - name: PROXY_DISCOVERY_URL 145 | value: ${DISCOVERY_URL} 146 | - name: PROXY_CLIENT_ID 147 | value: ${CLIENT_ID} 148 | - name: PROXY_CLIENT_SECRET 149 | value: ${CLIENT_SECRET} 150 | - name: PROXY_LISTEN 151 | value: ${LISTEN} 152 | - name: PROXY_ENABLE_REFRESH_TOKENS 153 | value: ${ENABLE_REFRESH_TOKENS} 154 | - name: PROXY_REDIRECTION_URL 155 | value: ${REDIRECTION_URL} 156 | - name: PROXY_SECURE_COOKIE 157 | value: ${SECURE_COOKIE} 158 | - name: PROXY_ENCRYPTION_KEY 159 | value: ${ENCRYPTION_KEY} 160 | - name: PROXY_UPSTREAM_URL 161 | value: ${UPSTREAM_URL} 162 | - name: PROXY_RESOURCES 163 | value: ${RESOURCES} 164 | - name: PROXY_CONFIG 165 | value: ${PROXY_CONFIG} 166 | - name: PROXY_MATCH_CLAIMS 167 | value: ${MATCH_CLAIMS} 168 | imagePullPolicy: Always 169 | restartPolicy: Always 170 | terminationGracePeriodSeconds: 30 171 | -------------------------------------------------------------------------------- /proxy.json: -------------------------------------------------------------------------------- 1 | /* 2 | This is an Example of proxy file config that was generated from from the proxy.tmpl 3 | For more details regarding file format and meaning see: https://keycloak.gitbooks.io/documentation/server_installation/topics/proxy.html 4 | */ 5 | { 6 | "target-url": "http://172.17.0.2:2015", 7 | "bind-address": "0.0.0.0", 8 | "http-port": "8080", 9 | "applications": [ 10 | { 11 | "base-path": "/", 12 | "adapter-config": { 13 | "realm": "horizon-docs", 14 | "realm-public-key": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmy26qnQkdzE9LtXsir1sgqCb914Iovt13TReQ6UDPGExQvsGidlkrLBKBf823n4sdG6PjVJBom7Hwj5yQkLEmYiGdFVLcecWa5SH0WYeWD/F2093cxc+B76EaetgvKRVtlDuW4M/2BIk+AAsJO6cxx4crafRE/Cg4yzZz6W/W7ztroGVg4TtylQnvnT4H9ybPsFd5D46QnqiLliahVdSXsQKhPp3gllqqdzUHe35TVjAU000UdXjK3ly68sRIrlN76DZVIitlYuJuHEP8snICJw1f21asuXRR6i7ywNBsl03dy1oCqlAIRboeRYZM52w4dgrTaGNUwx9J2aRBEAVawIDAQAB", 15 | "auth-server-url": "http://keycloak.example.com/auth", 16 | "ssl-required": "external", 17 | "resource": "account", 18 | "credentials": { 19 | "secret": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" 20 | } 21 | }, 22 | "constraints": [ 23 | { 24 | "pattern": "/*", 25 | "authenticate": true 26 | } 27 | ], 28 | "proxy-address-forwarding": true 29 | } 30 | ] 31 | } -------------------------------------------------------------------------------- /proxy.tmpl: -------------------------------------------------------------------------------- 1 | { 2 | "target-url": "{{ .Env.TARGET_URL }}", 3 | "bind-address": "0.0.0.0", 4 | "http-port": "{{ default .Env.HTTP_PORT "8080" }}", 5 | "applications": [ 6 | { 7 | "base-path": "{{ default .Env.BASE_PATH "/" }}", 8 | "adapter-config": { 9 | "realm": "{{ .Env.REALM }}", 10 | "realm-public-key": "{{ .Env.REALM_PUBLIC_KEY }}", 11 | "auth-server-url": "{{ .Env.AUTH_SERVER_URL }}", 12 | "ssl-required": "external", 13 | "resource": "{{ default .Env.RESOURCE "account" }}", 14 | "credentials": { 15 | "secret": "{{ .Env.SECRET }}" 16 | } 17 | }, 18 | "constraints": [ 19 | {{range $element := split (default .Env.CONSTRAINT_PATH "/*") ";"}} 20 | { 21 | "pattern": "{{$element}}", 22 | "authenticate": true 23 | } 24 | {{end}} 25 | ], 26 | "proxy-address-forwarding": true 27 | } 28 | ] 29 | } -------------------------------------------------------------------------------- /start-proxy.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | if [ -n "$PROXY_CONFIG" ]; then 4 | echo "Starting proxy and using the provided proxy json/yml file." 5 | echo $PROXY_CONFIG > /opt/proxy.config 6 | export PROXY_CONFIG_FILE=/opt/proxy.config 7 | /opt/keycloak-proxy --verbose ${PROX_DEBUG: false} --config $PROXY_CONFIG_FILE 8 | else 9 | if [ -n "$PROXY_MATCH_CLAIMS" ];then 10 | export PROXY_MATCH_CLAIM="--match-claims=$PROXY_MATCH_CLAIMS" 11 | fi 12 | echo "Starting proxy." 13 | export PROXY_LISTEN=${PROXY_LISTEN:-:8080} 14 | /opt/keycloak-proxy \ 15 | --verbose=${PROX_DEBUG:=false} \ 16 | --enable-refresh-tokens=${PROXY_ENABLE_REFRESH_TOKEN:=false} \ 17 | --secure-cookie=${PROXY_SECURE_COOKIE:=true} \ 18 | --resources=$PROXY_RESOURCES $PROXY_MATCH_CLAIM 19 | fi 20 | --------------------------------------------------------------------------------