From 973b52c98f2f19660e54282554ea12d07483a137 Mon Sep 17 00:00:00 2001 From: Alexander Gabriel Date: Fri, 17 Jan 2025 18:40:56 +0100 Subject: [PATCH] Revert "updated version" This reverts commit 60a946d54d386111828250002b48d69fa8c6cbcc. --- LICENSE | 201 +++++++++++++++++++++++++++++ README.md | 15 +++ defaults/main.yml | 7 + files/.gitignore | 2 + handlers/main.yml | 18 +++ tasks/main.yml | 200 ++++++++++++++++++++++++++++ templates/keycloak.service.j2 | 40 ++++++ templates/keycloak.service_init.j2 | 40 ++++++ 8 files changed, 523 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 defaults/main.yml create mode 100644 files/.gitignore create mode 100644 handlers/main.yml create mode 100644 tasks/main.yml create mode 100644 templates/keycloak.service.j2 create mode 100644 templates/keycloak.service_init.j2 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..f762307 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# ansible-role-keycloak + +Use this to install keycloak. + +Needs: https://github.com/AlexanderGabriel/ansible-role-acme.sh to get certs from letsencrypt + +Hint: Use variables use_local_ca: yes and acme_sh_server: https://host:port/acme/acme/directory to use your own intranet step-ca or acme-compatible CA for local certs + +All vars: +* keycloak_postgresql_database: keycloak +* keycloak_postgresql_username: keycloak +* keycloak_postgresql_password: keycloak +* keycloak_initial_admin_name: keycloak +* keycloak_initial_admin_password: keycloak +* keycloak_http_host: 127.0.0.1 diff --git a/defaults/main.yml b/defaults/main.yml new file mode 100644 index 0000000..3c50535 --- /dev/null +++ b/defaults/main.yml @@ -0,0 +1,7 @@ +--- +keycloak_postgresql_database: keycloak +keycloak_postgresql_username: keycloak +keycloak_postgresql_password: keycloak +keycloak_initial_admin_name: keycloak +keycloak_initial_admin_password: keycloak +keycloak_http_host: 127.0.0.1 diff --git a/files/.gitignore b/files/.gitignore new file mode 100644 index 0000000..8bcfcc5 --- /dev/null +++ b/files/.gitignore @@ -0,0 +1,2 @@ +*.tar.gz +*.zip \ No newline at end of file diff --git a/handlers/main.yml b/handlers/main.yml new file mode 100644 index 0000000..e65344b --- /dev/null +++ b/handlers/main.yml @@ -0,0 +1,18 @@ +--- +- name: reload systemd + command: systemctl daemon-reload + +- name: restart keycloak + service: + name: keycloak + state: restarted + +- name: restart apache2 + service: + name: apache2 + state: restarted + +- name: reload apache2 + service: + name: apache2 + state: reloaded \ No newline at end of file diff --git a/tasks/main.yml b/tasks/main.yml new file mode 100644 index 0000000..ed2a6fd --- /dev/null +++ b/tasks/main.yml @@ -0,0 +1,200 @@ +--- +- name: install stuff + apt: + name: + - default-jre + - unzip + - apache2 + update_cache: yes + +##install database +- name: include role for postgresql + include_role: + name: postgresql + vars: + postgresql_database: "{{ keycloak_postgresql_database }}" + postgresql_username: "{{ keycloak_postgresql_username }}" + postgresql_password: "{{ keycloak_postgresql_password }}" + +- name: include role for website + include_role: + name: website + vars: + domainname: "{{ inventory_hostname }}" + docroot: "/var/www/html" + optionalDirectives: | + ProxyPreserveHost On + SSLProxyEngine On + SSLProxyCheckPeerCN on + SSLProxyCheckPeerExpire on + RequestHeader set X-Forwarded-Proto "https" + RequestHeader set X-Forwarded-Port "443" + ProxyPass / http://127.0.0.1:8080/ + ProxyPassReverse / http://127.0.0.1:8080/ + +- name: create user for keycloak + user: + name: keycloak + state: present + shell: /bin/false + system: yes + createhome: yes + home: /opt/keycloak + +- name: check if keycloak-dir exists + stat: + path: /opt/keycloak/keycloak-21.0.1 + register: keycloak_exists + +- name: Download keycloak-zip + ansible.builtin.get_url: + url: https://github.com/keycloak/keycloak/releases/download/21.1.1/keycloak-21.1.1.zip + dest: /opt/ansiblepackages/keycloak-21.1.1.zip + mode: '0400' + +- name: Extract keycloak-211.1.zip to /opt/keycloak + unarchive: + src: /opt/ansiblepackages/keycloak-21.1.1.zip + dest: /opt/keycloak + owner: keycloak + group: keycloak + remote_src: yes + when: not keycloak_exists.stat.exists or redeploy is defined + +- name: link /opt/keycloak/keycloak-21.1.1 to /opt/keycloak/current + file: + state: link + owner: keycloak + group: keycloak + mode: '0770' + src: /opt/keycloak/keycloak-21.1.1 + dest: /opt/keycloak/current + +##build once +- name: check if /opt/keycloak/current/builtonce.txt exists + stat: + path: /opt/keycloak/current/builtonce.txt + register: builtonce_exists + +- name: build keycloak + command: sudo -u keycloak /opt/keycloak/current/bin/kc.sh build --db=postgres + when: not builtonce_exists.stat.exists + +- name: create file to track build + ansible.builtin.file: + path: /opt/keycloak/current/builtonce.txt + owner: keycloak + group: keycloak + mode: '0770' + state: touch + when: not builtonce_exists.stat.exists + +- name: set permissions correct + file: + dest: /opt/keycloak + owner: keycloak + group: keycloak +# mode: "0770" + recurse: yes + +- name: generate /etc/systemd/system/keycloak.service + template: + src: keycloak.service.j2 + dest: /etc/systemd/system/keycloak.service + owner: root + group: root + mode: "0644" + notify: + - reload systemd + +- name: Flush handlers + meta: flush_handlers + +- name: enable keycloak + systemd: + name: keycloak + enabled: yes + masked: no + notify: + restart keycloak + +- name: Flush handlers + meta: flush_handlers + +##add admin user once +- name: check if /opt/keycloak/current/adminuseradded.txt exists + stat: + path: /opt/keycloak/current/adminuseradded.txt + register: adminuseradded_exists + +- name: stop keycloak + ansible.builtin.service: + name: keycloak + state: stopped + when: not adminuseradded_exists.stat.exists + +- name: generate /etc/systemd/system/keycloak.service + template: + src: keycloak.service_init.j2 + dest: /etc/systemd/system/keycloak.service + owner: root + group: root + mode: "0644" + when: not adminuseradded_exists.stat.exists + notify: + - reload systemd + +- name: Flush handlers + meta: flush_handlers + +- name: start keycloak + ansible.builtin.service: + name: keycloak + state: started + when: not adminuseradded_exists.stat.exists + +- name: Sleep 120 seconds + ansible.builtin.wait_for: + timeout: 120 + delegate_to: localhost + when: not adminuseradded_exists.stat.exists + +- name: stop keycloak + ansible.builtin.service: + name: keycloak + state: stopped + when: not adminuseradded_exists.stat.exists + +- name: generate /etc/systemd/system/keycloak.service + template: + src: keycloak.service.j2 + dest: /etc/systemd/system/keycloak.service + owner: root + group: root + mode: "0644" + when: not adminuseradded_exists.stat.exists + notify: + - reload systemd + +- name: Flush handlers + meta: flush_handlers + +- name: start keycloak + ansible.builtin.service: + name: keycloak + state: started + when: not adminuseradded_exists.stat.exists + +- name: create file to track user creation + ansible.builtin.file: + path: /opt/keycloak/current/adminuseradded.txt + owner: keycloak + group: keycloak + mode: '0770' + state: touch + when: not adminuseradded_exists.stat.exists + +- name: start keycloak + ansible.builtin.service: + name: keycloak + state: started diff --git a/templates/keycloak.service.j2 b/templates/keycloak.service.j2 new file mode 100644 index 0000000..d5c4381 --- /dev/null +++ b/templates/keycloak.service.j2 @@ -0,0 +1,40 @@ +[Unit] +Description=Keycloak server +After=network-online.target +Wants=network-online.target systemd-networkd-wait-online.service + +[Service] +User=keycloak +Group=keycloak +ExecStart=/opt/keycloak/current/bin/kc.sh start +WorkingDirectory=/opt/keycloak/current +ReadWritePaths=/opt/keycloak/current/conf /opt/keycloak/current/data /opt/keycloak/current/lib/quarkus +SuccessExitStatus=0 143 + +TimeoutStartSec=600 +TimeoutStopSec=600 +Environment="KC_HTTP_HOST={{ keycloak_http_host}}" +Environment="KC_HOSTNAME={{ inventory_hostname }}" +Environment="KC_DB=postgres" +Environment="KC_DB_USERNAME={{ keycloak_postgresql_username }}" +Environment="KC_DB_PASSWORD={{ keycloak_postgresql_password }}" +Environment="KC_DB_URL_DATABASE={{ keycloak_postgresql_database }}" +Environment="KC_DB_URL_HOST=localhost" +Environment="KC_PROXY=edge" +Environment="KC_HTTP_RELATIVE_PATH=auth" + +# Hardening options +CapabilityBoundingSet= +AmbientCapabilities= +NoNewPrivileges=true +ProtectHome=true +ProtectSystem=strict +ProtectKernelTunables=true +ProtectKernelModules=true +ProtectControlGroups=true +PrivateTmp=true +PrivateDevices=true +LockPersonality=true + +[Install] +WantedBy=multi-user.target diff --git a/templates/keycloak.service_init.j2 b/templates/keycloak.service_init.j2 new file mode 100644 index 0000000..7fc0336 --- /dev/null +++ b/templates/keycloak.service_init.j2 @@ -0,0 +1,40 @@ +[Unit] +Description=Keycloak server +After=network-online.target +Wants=network-online.target systemd-networkd-wait-online.service + +[Service] +User=keycloak +Group=keycloak +ExecStart=/opt/keycloak/current/bin/kc.sh start +WorkingDirectory=/opt/keycloak/current +ReadWritePaths=/opt/keycloak/current/conf /opt/keycloak/current/data /opt/keycloak/current/lib/quarkus +SuccessExitStatus=0 143 +TimeoutStartSec=600 +TimeoutStopSec=600 +Environment="KC_HTTP_HOST={{ keycloak_http_host}}" +Environment="KC_HOSTNAME={{ inventory_hostname }}" +Environment="KC_DB=postgres" +Environment="KC_DB_USERNAME={{ keycloak_postgresql_username }}" +Environment="KC_DB_PASSWORD={{ keycloak_postgresql_password }}" +Environment="KC_DB_URL_DATABASE={{ keycloak_postgresql_database }}" +Environment="KC_DB_URL_HOST=localhost" +Environment="KC_PROXY=edge" +Environment="KEYCLOAK_ADMIN={{ keycloak_initial_admin_name }}" +Environment="KEYCLOAK_ADMIN_PASSWORD={{ keycloak_initial_admin_password }}" + +# Hardening options +CapabilityBoundingSet= +AmbientCapabilities= +NoNewPrivileges=true +ProtectHome=true +ProtectSystem=strict +ProtectKernelTunables=true +ProtectKernelModules=true +ProtectControlGroups=true +PrivateTmp=true +PrivateDevices=true +LockPersonality=true + +[Install] +WantedBy=multi-user.target