Merge branch 'braid/matrix-ldap-registration-proxy' of https://github.com/TheOneWithTheBraid/matrix-docker-ansible-deploy into matrix-ldap-registration-proxy

roles/matrix-ldap-registration-proxy/defaults/main.yml

@@ -0,0 +1,47 @@
+---
+# matrix_ldap_registration_proxy - Want to build a large-scale Matrix server using external registration on LDAP?
+# Project source code URL: https://gitlab.com/activism.international/matrix_ldap_registration_proxy
+
+matrix_ldap_registration_proxy_enabled: false
+
+matrix_ldap_registration_proxy_container_image_self_build_repo: "https://gitlab.com/activism.international/matrix_ldap_registration_proxy.git"
+matrix_ldap_registration_proxy_container_image_self_build_branch: "{{ matrix_ldap_registration_proxy_version }}"
+
+matrix_ldap_registration_proxy_version: "296246afc6a9b3105e67fcf6621cf05ebc74b873"
+
+matrix_ldap_registration_proxy_base_path: "{{ matrix_base_data_path }}/matrix_ldap_registration_proxy"
+# We need the docker src directory to be named matrix_ldap_registration_proxy.
+matrix_ldap_registration_proxy_docker_src_files_path: "{{ matrix_ldap_registration_proxy_base_path }}/docker-src/matrix_ldap_registration_proxy"
+matrix_ldap_registration_proxy_config_path: "{{ matrix_ldap_registration_proxy_base_path }}/config"
+
+matrix_ldap_registration_proxy_ldap_uri: "{{ matrix_synapse_ext_password_provider_ldap_uri }}"
+matrix_ldap_registration_proxy_ldap_base_dn: "{{ matrix_synapse_ext_password_provider_ldap_base }}"
+matrix_ldap_registration_proxy_ldap_user: "{{ matrix_synapse_ext_password_provider_ldap_bind_dn }}"
+matrix_ldap_registration_proxy_ldap_password: "{{ matrix_synapse_ext_password_provider_ldap_bind_password }}"
+matrix_ldap_registration_proxy_matrix_server_name: "{{ matrix_domain }}"
+matrix_ldap_registration_proxy_matrix_server_url: "https://{{ matrix_server_fqn_matrix }}"
+
+# Controls whether the self-check feature should validate SSL certificates.
+matrix_matrix_ldap_registration_proxy_self_check_validate_certificates: true
+
+matrix_ldap_registration_proxy_container_port: 8080
+# Controls whether the matrix_ldap_registration_proxy container exposes its HTTP port (tcp/{{ matrix_ldap_registration_proxy_container_port }} in the container).
+#
+# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8080"), or empty string to not expose.
+matrix_ldap_registration_proxy_container_http_host_bind_port: ''
+
+# A list of extra arguments to pass to the container
+matrix_ldap_registration_proxy_container_extra_arguments: []
+
+# List of systemd services that matrix_ldap_registration_proxy.service depends on
+matrix_ldap_registration_proxy_systemd_required_services_list: ['docker.service']
+
+# List of systemd services that matrix_ldap_registration_proxy.service wants
+matrix_ldap_registration_proxy_systemd_wanted_services_list: []
+
+# Default ma1sd configuration template which covers the generic use case.
+# You can customize it by controlling the various variables inside it.
+matrix_ldap_registration_proxy_configuration_env: "{{ lookup('template', 'templates/ldap-registration-proxy.env.j2') }}"
+
+# Holds the final ma1sd configuration (a combination of the default and its extension).
+matrix_ldap_registration_proxy_configuration: "{{ matrix_ldap_registration_proxy_configuration_env }}"

roles/matrix-ldap-registration-proxy/tasks/init.yml

@@ -0,0 +1,11 @@
+---
+# See https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/1070
+# and https://github.com/spantaleev/matrix-docker-ansible-deploy/commit/1ab507349c752042d26def3e95884f6df8886b74#commitcomment-51108407
+- name: Fail if trying to self-build on Ansible < 2.8
+  ansible.builtin.fail:
+    msg: "To self-build the matrix_ldap_registration_proxy image, you should use Ansible 2.8 or higher. See docs/ansible.md"
+  when: "ansible_version.major == 2 and ansible_version.minor < 8 and matrix_matrix_ldap_registration_proxy_container_image_self_build and matrix_matrix_ldap_registration_proxy_enabled | bool"
+
+- ansible.builtin.set_fact:
+    matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-matrix-ldap-registration-proxy.service'] }}"
+  when: matrix_matrix_ldap_registration_proxy_enabled | bool

roles/matrix-ldap-registration-proxy/tasks/main.yml

@@ -0,0 +1,30 @@
+---
+
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/init.yml"
+  tags:
+    - always
+
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/validate_config.yml"
+  when: "run_setup | bool and matrix_matrix_ldap_registration_proxy_enabled | bool"
+  tags:
+    - setup-all
+    - setup-matrix-ldap-registration-proxy
+
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/setup_install.yml"
+  when: "run_setup | bool and matrix_matrix_ldap_registration_proxy_enabled | bool"
+  tags:
+    - setup-all
+    - setup-matrix-ldap-registration-proxy
+
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/setup_uninstall.yml"
+  when: "run_setup | bool and not matrix_matrix_ldap_registration_proxy_enabled | bool"
+  tags:
+    - setup-all
+    - setup-matrix-ldap-registration-proxy
+
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/self_check_matrix_ldap_registration_proxy.yml"
+  delegate_to: 127.0.0.1
+  become: false
+  when: "run_self_check | bool and matrix_matrix_ldap_registration_proxy_enabled | bool"
+  tags:
+    - self-check

roles/matrix-ldap-registration-proxy/tasks/self_check_matrix_ldap_registration_proxy.yml

@@ -0,0 +1,22 @@
+---
+
+- ansible.builtin.set_fact:
+    matrix_ldap_registration_proxy_url_endpoint_public: "https://{{ matrix_server_fqn_matrix }}/_matrix/client/r0/register"
+
+- name: Check matrix_ldap_registration_proxy Service
+  ansible.builtin.uri:
+    url: "{{ matrix_ldap_registration_proxy_url_endpoint_public }}"
+    follow_redirects: none
+    validate_certs: "{{ matrix_matrix_ldap_registration_proxy_self_check_validate_certificates }}"
+  check_mode: false
+  register: result_matrix_ldap_registration_proxy
+  ignore_errors: true
+
+- name: Fail if matrix_ldap_registration_proxy Service not working
+  ansible.builtin.fail:
+    msg: "Failed checking matrix_ldap_registration_proxy is up at `{{ matrix_server_fqn_matrix }}` (checked endpoint: `{{ matrix_ldap_registration_proxy_url_endpoint_public }}`). Is matrix_ldap_registration_proxy running? Is port 443 open in your firewall? Full error: {{ result_matrix_ldap_registration_proxy }}"
+  when: "result_matrix_ldap_registration_proxy.failed or 'json' not in result_matrix_ldap_registration_proxy"
+
+- name: Report working matrix_ldap_registration_proxy Service
+  ansible.builtin.debug:
+    msg: "matrix_ldap_registration_proxy at `{{ matrix_server_fqn_matrix }}` is working (checked endpoint: `{{ matrix_ldap_registration_proxy_url_endpoint_public }}`)"

roles/matrix-ldap-registration-proxy/tasks/setup_install.yml

@@ -0,0 +1,63 @@
+---
+
+- name: Ensure matrix_ldap_registration_proxy paths exist
+  ansible.builtin.file:
+    path: "{{ item.path }}"
+    state: directory
+    mode: 0750
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+  with_items:
+    - {path: "{{ matrix_ldap_registration_proxy_config_path }}", when: true}
+    - {path: "{{ matrix_ldap_registration_proxy_docker_src_files_path }}", when: true}
+  when: "item.when | bool"
+
+- ansible.builtin.set_fact:
+    matrix_ldap_registration_proxy_requires_restart: false
+
+- name: Ensure matrix_ldap_registration_proxy repository is present on self-build
+  ansible.builtin.git:
+    repo: "{{ matrix_ldap_registration_proxy_container_image_self_build_repo }}"
+    dest: "{{ matrix_ldap_registration_proxy_docker_src_files_path }}"
+    version: "{{ matrix_ldap_registration_proxy_container_image_self_build_branch }}"
+    force: "yes"
+  become: true
+  become_user: "{{ matrix_user_username }}"
+  register: matrix_ldap_registration_proxy_git_pull_results
+
+- name: Ensure matrix_ldap_registration_proxy Docker image is built
+  docker_image:
+    name: "{{ matrix_ldap_registration_proxy_docker_image }}"
+    source: build
+    force_source: "{{ matrix_ldap_registration_proxy_git_pull_results.changed }}"
+    build:
+      dockerfile: Dockerfile
+      path: "{{ matrix_ldap_registration_proxy_docker_src_files_path }}"
+      pull: true
+  when: true
+
+- name: Ensure matrix_ldap_registration_proxy config installed
+  ansible.builtin.copy:
+    content: "{{ matrix_ldap_registration_proxy_configuration }}"
+    dest: "{{ matrix_ldap_registration_proxy_config_path }}/ldap-registration-proxy.env"
+    mode: 0644
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+
+- name: Ensure matrix-ldap-registration-proxy.service installed
+  ansible.builtin.template:
+    src: "{{ role_path }}/templates/systemd/matrix-ldap-registration-proxy.service.j2"
+    dest: "{{ matrix_systemd_path }}/matrix-ldap-registration-proxy.service"
+    mode: 0644
+  register: matrix_ldap_registration_proxy_systemd_service_result
+
+- name: Ensure systemd reloaded after matrix-ldap-registration-proxy.service installation
+  ansible.builtin.service:
+    daemon_reload: true
+  when: "matrix_ldap_registration_proxy_systemd_service_result.changed | bool"
+
+- name: Ensure matrix-ldap-registration-proxy.service restarted, if necessary
+  ansible.builtin.service:
+    name: "matrix-ldap-registration-proxy.service"
+    state: restarted
+  when: "matrix_ldap_registration_proxy_requires_restart | bool"

roles/matrix-ldap-registration-proxy/tasks/setup_uninstall.yml

@@ -0,0 +1,36 @@
+---
+
+- name: Check existence of matrix-matrix_ldap_registration_proxy service
+  ansible.builtin.stat:
+    path: "{{ matrix_systemd_path }}/matrix-ldap-registration-proxy.service"
+  register: matrix_matrix_ldap_registration_proxy_service_stat
+
+- name: Ensure matrix-matrix_ldap_registration_proxy is stopped
+  ansible.builtin.service:
+    name: matrix-matrix_ldap_registration_proxy
+    state: stopped
+    enabled: false
+    daemon_reload: true
+  register: stopping_result
+  when: "matrix_matrix_ldap_registration_proxy_service_stat.stat.exists | bool"
+
+- name: Ensure matrix-ldap-registration-proxy.service doesn't exist
+  ansible.builtin.file:
+    path: "{{ matrix_systemd_path }}/matrix-ldap-registration-proxy.service"
+    state: absent
+  when: "matrix_matrix_ldap_registration_proxy_service_stat.stat.exists | bool"
+
+- name: Ensure systemd reloaded after matrix-ldap-registration-proxy.service removal
+  ansible.builtin.service:
+    daemon_reload: true
+  when: "matrix_matrix_ldap_registration_proxy_service_stat.stat.exists | bool"
+
+- name: Ensure Matrix matrix_ldap_registration_proxy paths don't exist
+  ansible.builtin.file:
+    path: "{{ matrix_matrix_ldap_registration_proxy_base_path }}"
+    state: absent
+
+- name: Ensure matrix_ldap_registration_proxy Docker image doesn't exist
+  docker_image:
+    name: "{{ matrix_matrix_ldap_registration_proxy_docker_image }}"
+    state: absent

roles/matrix-ldap-registration-proxy/templates/ldap-registration-proxy.env.j2

@@ -0,0 +1,32 @@
+# please specify the configuration here
+#
+# these settings are mandatory
+
+# The server to connect to. Please note it must be accessible from the Docker network
+# example: `ldap://127.0.0.1:389`
+LDAP_SERVER={{ matrix_ldap_registration_proxy_ldap_uri }}
+
+# the base DN used for user creation
+
+LDAP_BASE_DN={{ matrix_ldap_registration_proxy_ldap_base_dn }}
+
+# the privileged user used for user creation including it's DN
+# example: `uid=admin,cn=users,cn=accounts,dc=example,dc=org`
+
+LDAP_USER={{ matrix_ldap_registration_proxy_ldap_user }}
+
+# the password of the `LDAP_USER` used for authentication
+LDAP_PASSWORD={{ matrix_ldap_registration_proxy_ldap_password }}
+
+# the human-readable server name of your Matrix server as used in the Matrix ID
+# example: `example.org`
+MATRIX_SERVER_NAME={{ matrix_ldap_registration_proxy_matrix_server_name }}
+
+# the url to access the Matrix server API without trailing `/`
+# example: `https://matrix.example.org`
+MATRIX_SERVER_URL={{ matrix_ldap_registration_proxy_matrix_server_url }}
+
+# these settings are optional:
+
+# Specify the port to listen on. Default to 8080
+LISTEN_PORT={{ matrix_ldap_registration_proxy_container_port }}

roles/matrix-ldap-registration-proxy/templates/systemd/matrix-ldap-registration-proxy.service.j2

@@ -0,0 +1,43 @@
+#jinja2: lstrip_blocks: "True"
+[Unit]
+Description=matrix_ldap_registration_proxy
+{% for service in matrix_ldap_registration_proxy_systemd_required_services_list %}
+Requires={{ service }}
+After={{ service }}
+{% endfor %}
+{% for service in matrix_ldap_registration_proxy_systemd_wanted_services_list %}
+Wants={{ service }}
+{% endfor %}
+DefaultDependencies=no
+
+[Service]
+Type=simple
+Environment="HOME={{ matrix_systemd_unit_home_path }}"
+ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-matrix_ldap_registration_proxy 2>/dev/null || true'
+ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-matrix_ldap_registration_proxy 2>/dev/null || true'
+
+# matrix_ldap_registration_proxy writes an SQLite shared library (libsqlitejdbc.so) to /tmp and executes it from there,
+# so /tmp needs to be mounted with an exec option.
+ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-ldap-registration-proxy \
+			--log-driver=none \
+			--user={{ matrix_user_uid }}:{{ matrix_user_gid }} \
+			--cap-drop=ALL \
+			--read-only \
+			--network={{ matrix_docker_network }} \
+			{% if matrix_ldap_registration_proxy_container_http_host_bind_port %}
+			-p {{ matrix_ldap_registration_proxy_container_http_host_bind_port }}:{{ matrix_ldap_registration_proxy_container_port }} \
+			{% endif %}
+			--env-file {{ matrix_ldap_registration_proxy_config_path }}/ldap-registration-proxy.env \
+			{% for arg in matrix_ldap_registration_proxy_container_extra_arguments %}
+			{{ arg }} \
+			{% endfor %}
+			{{ matrix_ldap_registration_proxy_docker_image }}
+
+ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-ldap-registration-proxy 2>/dev/null || true'
+ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-ldap-registration-proxy 2>/dev/null || true'
+Restart=always
+RestartSec=30
+SyslogIdentifier=matrix-ldap-registration-proxy
+
+[Install]
+WantedBy=multi-user.target

roles/matrix-ldap-registration-proxy/vars/main.yml

@@ -0,0 +1,5 @@
+---
+
+# Doing `|from_yaml` when the extension contains nothing yields an empty string ("").
+# We need to ensure it's a dictionary or `|combine` (when building `matrix_ma1sd_configuration`) will fail later.
+matrix_ma1sd_configuration_extension: "{{ matrix_ma1sd_configuration_extension_yaml | from_yaml if matrix_ma1sd_configuration_extension_yaml | from_yaml else {} }}"