Merge pull request #2038 from TheOneWithTheBraid/braid/matrix-ldap-registration-proxy

Draft: feat: include matrix_ldap_registration_proxy

README.md

@@ -45,6 +45,8 @@ Using this playbook, you can get the following services configured on your serve
 
 - (optional, advanced) the [matrix-synapse-ldap3](https://github.com/matrix-org/matrix-synapse-ldap3) LDAP Auth password provider module
 
+- (optional, advanced) the [matrix-ldap-registration-proxy](https://gitlab.com/activism.international/matrix_ldap_registration_proxy)  a proxy that handles Matrix registration requests and forwards them to LDAP.
+
 - (optional, advanced) the [synapse-simple-antispam](https://github.com/t2bot/synapse-simple-antispam) spam checker module
 
 - (optional, advanced) the [Matrix Corporal](https://github.com/devture/matrix-corporal) reconciliator and gateway for a managed Matrix server

docs/configuring-playbook-matrix-ldap-registration-proxy.md

@@ -0,0 +1,33 @@
+# Setting up matrix-ldap-registration-proxy (optional)
+
+The playbook can install and configure [matrix-ldap-registration-proxy](https://gitlab.com/activism.international/matrix_ldap_registration_proxy) for you.
+
+This proxy handles Matrix registration requests and forwards them to LDAP.
+
+**Please note:** This does support the full Matrix specification for registrations. It only provide a very coarse
+implementation of a basic password registration.
+
+## Quickstart
+
+Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file:
+
+```yaml
+matrix_ldap_registration_proxy_enabled: true
+# LDAP credentials
+matrix_ldap_registration_proxy_ldap_uri: <URI>
+matrix_ldap_registration_proxy_ldap_base_dn: <DN>
+matrix_ldap_registration_proxy_ldap_user: <USER>
+matrix_ldap_registration_proxy_ldap_password: <password>
+```
+
+If you already use the [synapse external password provider via LDAP](docs/configuring-playbook-ldap-auth.md) (that is, you have `matrix_synapse_ext_password_provider_ldap_enabled: true` and other options in your configuration)
+you can use the following values as configuration:
+
+```yaml
+# Use the LDAP values specified for the synapse role to setup LDAP proxy
+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 }}"
+```
+

docs/configuring-playbook.md

@@ -86,6 +86,8 @@ When you're done with all the configuration you'd like to do, continue with [Ins
 
 - [Setting up the LDAP password provider module](configuring-playbook-ldap-auth.md) (optional, advanced)
 
+- [Setting up the ldap-registration-proxy](configuring-playbook-matrix-ldap-registration-proxy.md) (optional, advanced)
+
 - [Setting up Synapse Simple Antispam](configuring-playbook-synapse-simple-antispam.md) (optional, advanced)
 
 - [Setting up Matrix Corporal](configuring-playbook-matrix-corporal.md) (optional, advanced)

group_vars/matrix_servers

@@ -1570,6 +1570,20 @@ matrix_jitsi_etherpad_base: "{{ matrix_etherpad_base_url if matrix_etherpad_enab
 # /matrix-jitsi
 #
 ######################################################################
+######################################################################
+#
+# matrix-ldap-registration-proxy
+#
+######################################################################
+
+# This is only for users with a specific LDAP setup
+matrix_ldap_registration_proxy_enabled: false
+
+######################################################################
+#
+# /matrix-ldap-registration-proxy
+#
+######################################################################
 
 ######################################################################
 #

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

@@ -0,0 +1,58 @@
+---
+# 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: true
+
+matrix_ldap_registration_proxy_docker_image: matrix_ldap_registration_proxy
+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_ldap_registration_proxy_ldap_base_dn: ""
+matrix_ldap_registration_proxy_ldap_user: ""
+matrix_ldap_registration_proxy_ldap_password: ""
+matrix_ldap_registration_proxy_matrix_server_name: "{{ matrix_domain }}"
+matrix_ldap_registration_proxy_matrix_server_url: "https://{{ matrix_server_fqn_matrix }}"
+
+matrix_ldap_registration_proxy_registration_endpoint: "/_matrix/client/r0/register"
+
+# 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: ''
+
+# `matrix_ldap_registration_proxy_container_http_host_bind_port_number_raw` contains the raw port number extracted from `matrix_ldap_registration_proxy_container_http_host_bind_port`,
+# which can contain values like this: ('1234', '127.0.0.1:1234', '0.0.0.0:1234')
+matrix_ldap_registration_proxy_container_http_host_bind_port_number_raw: "{{ '' if matrix_ldap_registration_proxy_container_http_host_bind_port == '' else (matrix_ldap_registration_proxy_container_http_host_bind_port.split(':')[1] if ':' in matrix_ldap_registration_proxy_container_http_host_bind_port else matrix_ldap_registration_proxy_container_http_host_bind_port) }}"
+
+matrix_ldap_registration_proxy_registration_addr_with_container: "matrix-ldap_registration-proxy:{{  matrix_ldap_registration_proxy_container_http_host_bind_port_number_raw }}"
+matrix_ldap_registration_proxy_registration_addr_sans_container: "127.0.0.1:{{  matrix_ldap_registration_proxy_container_http_host_bind_port_number_raw }}"
+
+
+# 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: []
+
+# Additional environment variables to pass to the LDAP proxy environment variables.
+#
+# Example:
+# matrix_ldap_registration_proxy_env_variables_extension: |
+#   KEY=value
+matrix_ldap_registration_proxy_env_variables_extension: ''

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

@@ -0,0 +1,58 @@
+---
+# 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_ldap_registration_proxy_container_image_self_build and matrix_ldap_registration_proxy_enabled | bool"
+
+- ansible.builtin.set_fact:
+    matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-ldap-registration-proxy.service'] }}"
+  when: matrix_ldap_registration_proxy_enabled | bool
+
+- block:
+    - name: Fail if matrix-nginx-proxy role already executed
+      ansible.builtin.fail:
+        msg: >-
+          Trying to append Matrix LDAP registration proxy's reverse-proxying configuration to matrix-nginx-proxy,
+          but it's pointless since the matrix-nginx-proxy role had already executed.
+          To fix this, please change the order of roles in your playbook,
+          so that the matrix-nginx-proxy role would run after the matrix-bridge-mautrix-telegram role.
+      when: matrix_nginx_proxy_role_executed | default(False) | bool
+
+    - name: Generate Matrix LDAP registration proxy proxying configuration for matrix-nginx-proxy
+      ansible.builtin.set_fact:
+        matrix_ldap_registration_proxy_matrix_nginx_proxy_configuration: |
+          location {{ matrix_ldap_registration_proxy_registration_endpoint }} {
+          {% if matrix_nginx_proxy_enabled | default(False) %}
+             {# Use the embedded DNS resolver in Docker containers to discover the service #}
+             resolver 127.0.0.11 valid=5s;
+             set $backend "{{ matrix_ldap_registration_proxy_registration_addr_with_container }}";
+             proxy_pass http://$backend/register;
+          {% else %}
+             {# Generic configuration for use outside of our container setup #}
+             proxy_pass http://{{ matrix_ldap_registration_proxy_registration_addr_sans_container }}/register;
+          {% endif %}
+          }
+
+    - name: Register Matrix LDAP registration proxy proxying configuration with matrix-nginx-proxy
+      ansible.builtin.set_fact:
+        matrix_nginx_proxy_proxy_matrix_additional_server_configuration_blocks: |
+          {{
+            matrix_nginx_proxy_proxy_matrix_additional_server_configuration_blocks | default([])
+            +
+            [matrix_ldap_registration_proxy_matrix_nginx_proxy_configuration]
+          }}
+    - name: Warn about reverse-proxying if matrix-nginx-proxy not used
+      ansible.builtin.debug:
+        msg: >-
+          NOTE: You've enabled the Matrix LDAP registration proxy bridge but are not using the matrix-nginx-proxy
+          reverse proxy.
+          Please make sure that you're proxying the `{{ matrix_ldap_registration_proxy_public_endpoint }}`
+          URL endpoint to the matrix-ldap-proxy container.
+          You can expose the container's port using the `matrix_ldap_registration_proxy_container_http_host_bind_port` variable.
+      when: "not matrix_nginx_proxy_enabled | default(False) | bool"
+
+  tags:
+    - always
+  when: matrix_ldap_registration_proxy_enabled | bool

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

@@ -0,0 +1,23 @@
+---
+
+- 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_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_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_ldap_registration_proxy_enabled | bool"
+  tags:
+    - setup-all
+    - setup-matrix-ldap-registration-proxy

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.template:
+    src: "{{ role_path }}/templates/ldap-registration-proxy.env.j2"
+    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_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_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_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_ldap_registration_proxy_service_stat.stat.exists | bool"
+
+- name: Ensure Matrix matrix_ldap_registration_proxy paths don't exist
+  ansible.builtin.file:
+    path: "{{ matrix_ldap_registration_proxy_base_path }}"
+    state: absent
+
+- name: Ensure matrix_ldap_registration_proxy Docker image doesn't exist
+  docker_image:
+    name: "{{ matrix_ldap_registration_proxy_docker_image }}"
+    state: absent

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

@@ -0,0 +1,12 @@
+---
+
+- name: Fail if required settings not defined
+  ansible.builtin.fail:
+    msg: >-
+      You need to define a required configuration setting (`{{ item }}`).
+  when: "vars[item] == ''"
+  with_items:
+    - "matrix_ldap_registration_proxy_ldap_uri"
+    - "matrix_ldap_registration_proxy_ldap_base_dn"
+    - "matrix_ldap_registration_proxy_ldap_user"
+    - "matrix_ldap_registration_proxy_ldap_password"

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

@@ -0,0 +1,35 @@
+# 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 }}
+
+# Use this to extend the configuration with custom variables
+{{ matrix_ldap_registration_proxy_env_variables_extension }}

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-ldap-registration-proxy 2>/dev/null || true'
+ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm 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

setup.yml

@@ -60,6 +60,7 @@
     - matrix-client-hydrogen
     - matrix-client-cinny
     - matrix-jitsi
+    - matrix-ldap-registration-proxy
     - matrix-ma1sd
     - matrix-dimension
     - matrix-etherpad