XWiki: two-phase bootstrap + extension install before enabling auth; add XOR validation

- Add 02_validation.yml to prevent OIDC+LDAP enabled simultaneously
- Introduce _flush_config.yml with switches (OIDC/LDAP/superadmin)
- Bootstrap with native+superadmin → create admin → install extensions (superadmin) → enable final auth
- Refactor REST vars (XWIKI_REST_BASE, XWIKI_REST_XWIKI, XWIKI_REST_EXTENSION_INSTALL)
- Update templates to use switch vars; gate OIDC block in properties
- Idempotent REST readiness waits

Conversation: https://chatgpt.com/share/68c40c1e-2b3c-800f-b59f-8d37baa9ebb2
This commit is contained in:
2025-09-12 14:04:02 +02:00
parent b0f10aa0d0
commit f576b42579
8 changed files with 103 additions and 70 deletions

View File

@@ -1,70 +1,30 @@
- name: Validate XWiki variables
include_tasks: 02_validation.yml
- name: "load docker, db and proxy for {{ application_id }}" - name: "load docker, db and proxy for {{ application_id }}"
include_role: include_role:
name: sys-stk-full-stateful name: sys-stk-full-stateful
vars: vars:
docker_compose_flush_handlers: false docker_compose_flush_handlers: false
- name: "Render xwiki.cfg" - name: Deploy Bootstrap Config
template: include_tasks: _flush_config.yml
src: "xwiki.cfg.j2" vars:
dest: "{{ XWIKI_HOST_CONF_PATH }}" xwiki_oidc_enabled_switch: false
notify: docker compose up xwiki_ldap_enabled_switch: false
xwiki_superadmin_enabled_switch: true
- name: "Render xwiki.properties" - name: Load setup procedures for admin
template: include_tasks: 03_administrator.yml
src: "xwiki.properties.j2"
dest: "{{ XWIKI_HOST_PROPERTIES_PATH }}"
notify: docker compose up
- name: "flush docker compose for '{{ application_id }}'" - name: Load setup procedures for extensions
meta: flush_handlers include_tasks: 04_extensions.yml
- name: "Wait until XWiki REST is ready" - name: Deploy Final Config
uri: include_tasks: _flush_config.yml
url: "http://127.0.0.1:{{ XWIKI_HOST_PORT }}/xwiki/rest/" vars:
status_code: [200, 401, 302] xwiki_oidc_enabled_switch: "{{ XWIKI_OIDC_ENABLED | bool }}"
return_content: no xwiki_ldap_enabled_switch: "{{ XWIKI_LDAP_ENABLED | bool }}"
register: xwiki_rest_up xwiki_superadmin_enabled_switch: false
retries: 60
delay: 5
until: xwiki_rest_up is succeeded
- include_tasks: 02_bootstrap_admin.yml
- name: "Check if OIDC extension installed"
uri:
url: "{{ XWIKI_REST_GENERAL }}/extensions/{{ XWIKI_EXT_OIDC_ID | urlencode }}"
method: GET
user: "{{ XWIKI_ADMIN_USER }}"
password: "{{ XWIKI_ADMIN_PASS }}"
force_basic_auth: yes
status_code: [200, 404, 302]
register: xwiki_oidc_ext
when: XWIKI_OIDC_ENABLED | bool
- name: "Check if LDAP extension installed"
uri:
url: "{{ XWIKI_REST_GENERAL }}/extensions/{{ XWIKI_EXT_LDAP_ID | urlencode }}"
method: GET
user: "{{ XWIKI_ADMIN_USER }}"
password: "{{ XWIKI_ADMIN_PASS }}"
force_basic_auth: yes
status_code: [200, 404, 302]
register: xwiki_ldap_ext
when: XWIKI_LDAP_ENABLED | bool
- name: "Install LDAP and/or OIDC extensions"
uri:
url: "{{ XWIKI_REST_BASE }}"
method: PUT
user: "{{ XWIKI_ADMIN_USER }}"
password: "{{ XWIKI_ADMIN_PASS }}"
force_basic_auth: yes
headers: { Content-Type: "text/xml" }
body: "{{ lookup('template', 'installjobrequest.xml.j2') }}"
status_code: 200
when:
- (XWIKI_OIDC_ENABLED | bool and xwiki_oidc_ext.status == 404) or
(XWIKI_LDAP_ENABLED | bool and (xwiki_ldap_ext is not skipped) and xwiki_ldap_ext.status == 404)
- include_tasks: utils/run_once.yml - include_tasks: utils/run_once.yml

View File

@@ -0,0 +1,9 @@
- name: "ASSERT | Only one auth backend (OIDC or LDAP) may be enabled"
assert:
that:
- not ((XWIKI_OIDC_ENABLED | bool) and (XWIKI_LDAP_ENABLED | bool))
fail_msg: >-
Invalid auth configuration: both OIDC and LDAP are enabled
(features.oidc={{ XWIKI_OIDC_ENABLED }}, features.ldap={{ XWIKI_LDAP_ENABLED }}).
Enable only one, or disable both to use native/superadmin login.
success_msg: "Auth config OK: OIDC={{ XWIKI_OIDC_ENABLED }}, LDAP={{ XWIKI_LDAP_ENABLED }}."

View File

@@ -2,7 +2,7 @@
# Wait until REST endpoint is available (01_core usually ensures this, but add safety) # Wait until REST endpoint is available (01_core usually ensures this, but add safety)
- name: "XWIKI | Wait until REST answers" - name: "XWIKI | Wait until REST answers"
uri: uri:
url: "http://127.0.0.1:{{ XWIKI_HOST_PORT }}/xwiki/rest/" url: "{{ XWIKI_REST_BASE }}"
status_code: [200, 401] status_code: [200, 401]
register: _rest_ping register: _rest_ping
retries: 60 retries: 60
@@ -13,7 +13,7 @@
# 404 => missing, 302 => DW redirect (treat as missing for bootstrap) # 404 => missing, 302 => DW redirect (treat as missing for bootstrap)
- name: "XWIKI | Check if target admin user exists" - name: "XWIKI | Check if target admin user exists"
uri: uri:
url: "{{ XWIKI_REST_GENERAL }}/users/{{ XWIKI_ADMIN_USER | urlencode }}" url: "{{ XWIKI_REST_XWIKI }}/users/{{ XWIKI_ADMIN_USER | urlencode }}"
method: GET method: GET
user: "{{ XWIKI_SUPERADMIN_USERNAME }}" user: "{{ XWIKI_SUPERADMIN_USERNAME }}"
password: "{{ XWIKI_SUPERADMIN_PASSWORD }}" password: "{{ XWIKI_SUPERADMIN_PASSWORD }}"
@@ -24,7 +24,7 @@
# Create admin user if not existing (or DW still redirecting) # Create admin user if not existing (or DW still redirecting)
- name: "XWIKI | Create admin user via REST" - name: "XWIKI | Create admin user via REST"
uri: uri:
url: "{{ XWIKI_REST_GENERAL }}/users" url: "{{ XWIKI_REST_XWIKI }}/users"
method: POST method: POST
user: "{{ XWIKI_SUPERADMIN_USERNAME }}" user: "{{ XWIKI_SUPERADMIN_USERNAME }}"
password: "{{ XWIKI_SUPERADMIN_PASSWORD }}" password: "{{ XWIKI_SUPERADMIN_PASSWORD }}"

View File

@@ -0,0 +1,38 @@
- name: "Check if OIDC extension installed"
uri:
url: "{{ XWIKI_REST_XWIKI }}/extensions/{{ XWIKI_EXT_OIDC_ID | urlencode }}"
method: GET
user: "{{ XWIKI_SUPERADMIN_USERNAME }}"
password: "{{ XWIKI_SUPERADMIN_PASSWORD }}"
force_basic_auth: yes
status_code: [200, 404, 302]
register: xwiki_oidc_ext
when: XWIKI_OIDC_ENABLED | bool
no_log: "{{ MASK_CREDENTIALS_IN_LOGS | bool }}"
- name: "Check if LDAP extension installed"
uri:
url: "{{ XWIKI_REST_XWIKI }}/extensions/{{ XWIKI_EXT_LDAP_ID | urlencode }}"
method: GET
user: "{{ XWIKI_SUPERADMIN_USERNAME }}"
password: "{{ XWIKI_SUPERADMIN_PASSWORD }}"
force_basic_auth: yes
status_code: [200, 404, 302]
register: xwiki_ldap_ext
when: XWIKI_LDAP_ENABLED | bool
no_log: "{{ MASK_CREDENTIALS_IN_LOGS | bool }}"
- name: "Install LDAP and/or OIDC extensions"
uri:
url: "{{ XWIKI_REST_EXTENSION_INSTALL }}"
method: PUT
user: "{{ XWIKI_SUPERADMIN_USERNAME }}"
password: "{{ XWIKI_SUPERADMIN_PASSWORD }}"
force_basic_auth: yes
headers: { Content-Type: "text/xml" }
body: "{{ lookup('template', 'installjobrequest.xml.j2') }}"
status_code: 200
when:
- (XWIKI_OIDC_ENABLED | bool and xwiki_oidc_ext.status == 404) or
(XWIKI_LDAP_ENABLED | bool and (xwiki_ldap_ext is not skipped) and xwiki_ldap_ext.status == 404)
no_log: "{{ MASK_CREDENTIALS_IN_LOGS | bool }}"

View File

@@ -0,0 +1,25 @@
- name: "Render xwiki.cfg"
template:
src: "xwiki.cfg.j2"
dest: "{{ XWIKI_HOST_CONF_PATH }}"
notify: docker compose up
- name: "Deploy xwiki.properties"
template:
src: "xwiki.properties.j2"
dest: "{{ XWIKI_HOST_PROPERTIES_PATH }}"
notify: docker compose up
- name: "flush docker compose for '{{ application_id }}'"
meta: flush_handlers
- name: "Wait until XWiki REST is ready"
uri:
url: "{{ XWIKI_REST_BASE }}"
status_code: [200, 401, 302]
return_content: no
changed_when: false
register: xwiki_rest_up
retries: 60
delay: 5
until: xwiki_rest_up is succeeded

View File

@@ -1,7 +1,7 @@
# ---- Authentication selection # ---- Authentication selection
{% if XWIKI_OIDC_ENABLED | bool %} {% if xwiki_oidc_enabled_switch | bool %}
xwiki.authentication.authclass=org.xwiki.contrib.oidc.auth.OIDCAuthServiceImpl xwiki.authentication.authclass=org.xwiki.contrib.oidc.auth.OIDCAuthServiceImpl
{% elif XWIKI_LDAP_ENABLED | bool %} {% elif xwiki_ldap_enabled_switch | bool %}
xwiki.authentication.authclass=org.xwiki.contrib.ldap.XWikiLDAPAuthServiceImpl xwiki.authentication.authclass=org.xwiki.contrib.ldap.XWikiLDAPAuthServiceImpl
xwiki.authentication.ldap=1 xwiki.authentication.ldap=1
xwiki.authentication.ldap.trylocal={{ (XWIKI_LDAP_TRYLOCAL | bool) | ternary(1, 0) }} xwiki.authentication.ldap.trylocal={{ (XWIKI_LDAP_TRYLOCAL | bool) | ternary(1, 0) }}
@@ -15,9 +15,9 @@ xwiki.authentication.ldap.bind_pass={{ XWIKI_LDAP_BIND_PASS }}
xwiki.authentication.ldap.fields_mapping={{ XWIKI_LDAP_FIELDS_MAPPING }} xwiki.authentication.ldap.fields_mapping={{ XWIKI_LDAP_FIELDS_MAPPING }}
xwiki.authentication.ldap.update_user=1 xwiki.authentication.ldap.update_user=1
{% else %} {% else %}
# Fallback: Native XWiki Auth xwiki.authentication.authclass=com.xpn.xwiki.user.impl.xwiki.XWikiAuthServiceImpl
# xwiki.authentication.authclass=com.xpn.xwiki.user.impl.xwiki.XWikiAuthServiceImpl
{% endif %} {% endif %}
{% if xwiki_superadmin_enabled_switch | bool %}
# ---- Superadmin must live in xwiki.cfg (not in xwiki.properties) # ---- Superadmin must live in xwiki.cfg (not in xwiki.properties)
xwiki.superadminpassword={{ XWIKI_SUPERADMIN_PASSWORD }} xwiki.superadminpassword={{ XWIKI_SUPERADMIN_PASSWORD }}
{% endif %}

View File

@@ -1,6 +1,6 @@
############################################ ############################################
# OIDC # OIDC
{% if XWIKI_OIDC_ENABLED | bool %} {% if xwiki_oidc_enabled_switch | bool %}
oidc.provider={{ XWIKI_OIDC_PROVIDER }} oidc.provider={{ XWIKI_OIDC_PROVIDER }}
oidc.endpoint.authorization={{ XWIKI_OIDC_AUTHORIZATION }} oidc.endpoint.authorization={{ XWIKI_OIDC_AUTHORIZATION }}
oidc.endpoint.token={{ XWIKI_OIDC_TOKEN }} oidc.endpoint.token={{ XWIKI_OIDC_TOKEN }}

View File

@@ -37,8 +37,9 @@ XWIKI_SUPERADMIN_PASSWORD: "{{ applications | get_app_conf(applicatio
XWIKI_SUPERADMIN_USERNAME: "superadmin" XWIKI_SUPERADMIN_USERNAME: "superadmin"
# REST endpoint (local inside container) # REST endpoint (local inside container)
XWIKI_REST_BASE: "http://127.0.0.1:{{ XWIKI_HOST_PORT }}/xwiki/rest/jobs?jobType=install&async=false" XWIKI_REST_BASE: "http://127.0.0.1:{{ XWIKI_HOST_PORT }}/xwiki/rest/"
XWIKI_REST_GENERAL: "http://127.0.0.1:{{ XWIKI_HOST_PORT }}/xwiki/rest/wikis/xwiki" XWIKI_REST_EXTENSION_INSTALL: "{{ XWIKI_REST_BASE }}jobs?jobType=install&async=false"
XWIKI_REST_XWIKI: "{{ XWIKI_REST_BASE }}wikis/xwiki"
# Extension IDs + Versions (pin versions explicitly) # Extension IDs + Versions (pin versions explicitly)
XWIKI_EXT_LDAP_ID: "org.xwiki.contrib.ldap:ldap-authenticator" XWIKI_EXT_LDAP_ID: "org.xwiki.contrib.ldap:ldap-authenticator"