From f036e18789ffd332c40d296bc4744a1dc508586a Mon Sep 17 00:00:00 2001 From: wjbeckett Date: Mon, 30 Sep 2024 11:05:11 +1000 Subject: [PATCH] Fix: Restructured Element call configuration files. --- group_vars/matrix_servers | 24 ++---- .../matrix-element-call/defaults/main.yml | 84 +++++++++++++++++-- .../matrix-element-call/tasks/install.yml | 2 +- .../templates/element-call-labels.j2 | 31 ++++--- .../systemd/matrix-element-call.service.j2 | 16 +++- 5 files changed, 117 insertions(+), 40 deletions(-) diff --git a/group_vars/matrix_servers b/group_vars/matrix_servers index 9da357c88..4ba3e6eb2 100755 --- a/group_vars/matrix_servers +++ b/group_vars/matrix_servers @@ -5894,18 +5894,22 @@ matrix_element_call_container_image_registry_prefix: ghcr.io/ matrix_element_call_container_image_force_pull: true # Docker network configuration for Element Call -matrix_element_call_container_network: "{{ matrix_homeserver_container_network }}" # Use the homeserver network by default +matrix_element_call_container_network: "{{ matrix_addons_container_network }}" +matrix_element_call_container_additional_networks: "{{ [matrix_playbook_reverse_proxyable_services_additional_network] if (matrix_element_call_container_labels_traefik_enabled and matrix_playbook_reverse_proxyable_services_additional_network) else [] }}" + # Traefik Configuration for Element Call +matrix_element_call_container_labels_traefik_enabled: "{{ matrix_playbook_reverse_proxy_type in ['playbook-managed-traefik', 'other-traefik-container'] }}" +matrix_element_call_container_labels_traefik_docker_network: "{{ matrix_playbook_reverse_proxyable_services_additional_network }}" +matrix_element_call_container_labels_traefik_entrypoints: "{{ devture_traefik_entrypoint_primary }}" +matrix_element_call_container_labels_traefik_tls_certResolver: "{{ devture_traefik_certResolver_primary }}" + + matrix_element_call_container_labels_traefik_enabled: true matrix_element_call_container_labels_traefik_docker_network: "{{ matrix_playbook_reverse_proxyable_services_additional_network }}" matrix_element_call_container_labels_traefik_hostname: "{{ matrix_element_call_hostname }}" matrix_element_call_container_labels_traefik_path_prefix: "{{ matrix_element_call_path_prefix }}" matrix_element_call_container_labels_traefik_rule: "Host(`{{ matrix_element_call_container_labels_traefik_hostname }}`)" -matrix_element_call_container_labels_traefik_entrypoints: "websecure" -matrix_element_call_container_labels_traefik_tls_certResolver: "default" -matrix_element_call_container_labels_traefik_additional_response_headers: {} -matrix_element_call_container_extra_arguments: {} # JWT Service Configuration matrix_element_call_jwt_service_url: "https://sfu-jwt.{{ matrix_domain }}" # Default JWT service URL; adjust as needed @@ -5919,16 +5923,6 @@ matrix_element_call_redis_hostname: "localhost" # Default Redis hostname; can b matrix_element_call_redis_port: 6379 # Default Redis port; can be overridden matrix_element_call_redis_password: "" # Redis password; should be set in host_vars if needed -# Additional environment variables for the container -matrix_element_call_environment_variables_additional: {} - -# Additional arguments or configuration options for the Docker container -matrix_element_call_container_extra_arguments: [] - -# Enable or disable metrics collection -matrix_element_call_metrics_enabled: false -matrix_element_call_metrics_port: 2112 - ######################################################################## # # # /matrix-element-call # diff --git a/roles/custom/matrix-element-call/defaults/main.yml b/roles/custom/matrix-element-call/defaults/main.yml index c9e9aeaba..d5a9dbb2f 100644 --- a/roles/custom/matrix-element-call/defaults/main.yml +++ b/roles/custom/matrix-element-call/defaults/main.yml @@ -10,7 +10,8 @@ matrix_homeserver_config_path: "{{ matrix_base_data_path }}/synapse/config/homes element_web_config_path: "{{ matrix_base_data_path }}/static-files/public/.well-known/matrix/client" # Docker network configuration -matrix_element_call_container_network: "matrix_element_call_network" +matrix_element_call_container_network: '' +matrix_element_call_container_http_host_bind_port: '' matrix_element_call_container_labels_traefik_additional_response_headers: {} matrix_element_call_container_additional_networks: [] # No additional networks by default @@ -47,15 +48,88 @@ redis_password: "" # Traefik Configuration for Element Call matrix_element_call_container_labels_traefik_enabled: true +matrix_element_call_container_labels_traefik_docker_network: "{{ matrix_element_callcontainer_network }}" matrix_element_call_container_labels_traefik_hostname: "{{ matrix_element_call_domain }}" -matrix_element_call_container_labels_traefik_path_prefix: "/" -matrix_element_call_container_labels_traefik_rule: "Host(`{{ matrix_element_call_container_labels_traefik_hostname }}`)" -matrix_element_call_container_labels_traefik_entrypoints: "websecure" -matrix_element_call_container_labels_traefik_tls_certResolver: "default" +# The path prefix must either be `/` or not end with a slash (e.g. `/element`). +matrix_element_call_container_labels_traefik_path_prefix: "{{ matrix_element_callpath_prefix }}" +matrix_element_call_container_labels_traefik_rule: "Host(`{{ matrix_element_call_container_labels_traefik_hostname }}`){% if matrix_element_call_container_labels_traefik_path_prefix != '/' %} && PathPrefix(`{{ matrix_element_call_container_labels_traefik_path_prefix }}`){% endif %}" +matrix_element_call_container_labels_traefik_priority: 0 +matrix_element_call_container_labels_traefik_entrypoints: web-secure +matrix_element_call_container_labels_traefik_tls: "{{ matrix_element_call_container_labels_traefik_entrypoints != 'web' }}" +matrix_element_call_container_labels_traefik_tls_certResolver: default # noqa var-naming + +# Controls which additional headers to attach to all HTTP responses. +# To add your own headers, use `matrix_element_call_container_labels_traefik_additional_response_headers_custom` +matrix_element_call_container_labels_traefik_additional_response_headers: "{{ matrix_element_call_container_labels_traefik_additional_response_headers_auto | combine(matrix_element_call_container_labels_traefik_additional_response_headers_custom) }}" +matrix_element_call_container_labels_traefik_additional_response_headers_auto: | + {{ + {} + | combine ({'X-XSS-Protection': matrix_element_call_http_header_xss_protection} if matrix_element_call_http_header_xss_protection else {}) + | combine ({'X-Frame-Options': matrix_element_call_http_header_frame_options} if matrix_element_call_http_header_frame_options else {}) + | combine ({'X-Content-Type-Options': matrix_element_call_http_header_content_type_options} if matrix_element_call_http_header_content_type_options else {}) + | combine ({'Content-Security-Policy': matrix_element_call_http_header_content_security_policy} if matrix_element_call_http_header_content_security_policy else {}) + | combine ({'Permission-Policy': matrix_element_call_http_header_content_permission_policy} if matrix_element_call_http_header_content_permission_policy else {}) + | combine ({'Strict-Transport-Security': matrix_element_call_http_header_strict_transport_security} if matrix_element_call_http_header_strict_transport_security and matrix_element_call_container_labels_traefik_tls else {}) + }} +matrix_element_call_container_labels_traefik_additional_response_headers_custom: {} # Additional environment variables for the container matrix_element_call_environment_variables_additional: {} +# List of systemd services that matrix-client-element.service depends on +matrix_element_call_systemd_required_services_list: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}" + +# Specifies the value of the `X-XSS-Protection` header +# Stops pages from loading when they detect reflected cross-site scripting (XSS) attacks. +# +# Learn more about it is here: +# - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection +# - https://portswigger.net/web-security/cross-site-scripting/reflected +matrix_element_call_http_header_xss_protection: "1; mode=block" + +# Specifies the value of the `X-Frame-Options` header which controls whether framing can happen. +# See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options +matrix_element_call_http_header_frame_options: SAMEORIGIN + +# Specifies the value of the `X-Content-Type-Options` header. +# See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options +matrix_element_call_http_header_content_type_options: nosniff + +# Specifies the value of the `Content-Security-Policy` header. +# See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy +matrix_element_call_http_header_content_security_policy: frame-ancestors 'self' + +# Specifies the value of the `Permission-Policy` header. +# See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Permission-Policy +matrix_element_call_http_header_content_permission_policy: "{{ 'interest-cohort=()' if matrix_element_callfloc_optout_enabled else '' }}" + +# Specifies the value of the `Strict-Transport-Security` header. +# See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security +matrix_element_call_http_header_strict_transport_security: "max-age=31536000; includeSubDomains{{ '; preload' if matrix_element_callhsts_preload_enabled else '' }}" + +# Controls whether to send a "Permissions-Policy interest-cohort=();" header along with all responses +# +# Learn more about what it is here: +# - https://www.eff.org/deeplinks/2021/03/googles-floc-terrible-idea +# - https://paramdeo.com/blog/opting-your-website-out-of-googles-floc-network +# - https://amifloced.org/ +# +# Of course, a better solution is to just stop using browsers (like Chrome), which participate in such tracking practices. +# See: `matrix_element_callcontent_permission_policy` +matrix_element_callfloc_optout_enabled: true + +# Controls if HSTS preloading is enabled +# +# In its strongest and recommended form, the [HSTS policy](https://www.chromium.org/hsts) includes all subdomains, and +# indicates a willingness to be "preloaded" into browsers: +# `Strict-Transport-Security: max-age=31536000; includeSubDomains; preload` +# For more information visit: +# - https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security +# - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security +# - https://hstspreload.org/#opt-in +# See: `matrix_element_call_http_header_strict_transport_security` +matrix_element_callhsts_preload_enabled: false + # Enable or disable metrics collection matrix_element_call_metrics_enabled: false matrix_element_call_metrics_port: 2112 diff --git a/roles/custom/matrix-element-call/tasks/install.yml b/roles/custom/matrix-element-call/tasks/install.yml index ba3a8704d..f036fa2f9 100644 --- a/roles/custom/matrix-element-call/tasks/install.yml +++ b/roles/custom/matrix-element-call/tasks/install.yml @@ -9,7 +9,7 @@ mode: 0750 owner: "{{ matrix_user_username }}" group: "{{ matrix_user_groupname }}" - loop: + with_items: - path: "{{ matrix_element_call_base_path }}" - path: "{{ matrix_element_call_base_path }}/data" - path: "{{ matrix_element_call_base_path }}/config" diff --git a/roles/custom/matrix-element-call/templates/element-call-labels.j2 b/roles/custom/matrix-element-call/templates/element-call-labels.j2 index 0428d056a..feeeb2c65 100644 --- a/roles/custom/matrix-element-call/templates/element-call-labels.j2 +++ b/roles/custom/matrix-element-call/templates/element-call-labels.j2 @@ -6,10 +6,6 @@ traefik.enable=true traefik.docker.network={{ matrix_element_call_container_labels_traefik_docker_network }} {% endif %} -# Traefik Router and Service configuration for Element Call -traefik.http.routers.element-call-router.rule=Host(`{{ matrix_element_call_container_labels_traefik_hostname }}`) -traefik.http.routers.element-call-router.entrypoints={{ matrix_element_call_container_labels_traefik_entrypoints }} -traefik.http.routers.element-call-router.tls.certresolver={{ matrix_element_call_container_labels_traefik_tls_certResolver }} traefik.http.services.element-call-service.loadbalancer.server.port=8080 {% set middlewares = [] %} @@ -24,24 +20,27 @@ traefik.http.middlewares.element-call-strip-prefix.stripprefix.prefixes={{ matri {% set middlewares = middlewares + ['element-call-strip-prefix'] %} {% endif %} -# Additional response headers for Element Call -{% if matrix_element_call_container_labels_traefik_additional_response_headers is defined and matrix_element_call_container_labels_traefik_additional_response_headers | length > 0 %} +{% if matrix_element_call_container_labels_traefik_additional_response_headers.keys() | length > 0 %} {% for name, value in matrix_element_call_container_labels_traefik_additional_response_headers.items() %} -traefik.http.middlewares.element-call-add-headers.headers.customresponseheaders.{{ name }}={{ value }} +traefik.http.middlewares.matrix-element-call-add-headers.headers.customresponseheaders.{{ name }}={{ value }} {% endfor %} -{% set middlewares = middlewares + ['element-call-add-headers'] %} +{% set middlewares = middlewares + ['matrix-element-call-add-headers'] %} {% endif %} -# Apply middlewares to the Element Call router +traefik.http.routers.matrix-element-call.rule={{ matrix_element_call_container_labels_traefik_rule }} +{% if matrix_element_call_container_labels_traefik_priority | int > 0 %} +traefik.http.routers.matrix-element-call.priority={{ matrix_element_call_container_labels_traefik_priority }} +{% endif %} +traefik.http.routers.matrix-element-call.service=matrix-element-call {% if middlewares | length > 0 %} -traefik.http.routers.element-call-router.middlewares={{ middlewares | join(',') }} +traefik.http.routers.matrix-element-call.middlewares={{ middlewares | join(',') }} +{% endif %} +traefik.http.routers.matrix-element-call.entrypoints={{ matrix_element_call_container_labels_traefik_entrypoints }} +traefik.http.routers.matrix-element-call.tls={{ matrix_element_call_container_labels_traefik_tls | to_json }} +{% if matrix_element_call_container_labels_traefik_tls %} +traefik.http.routers.matrix-element-call.tls.certResolver={{ matrix_element_call_container_labels_traefik_tls_certResolver }} {% endif %} {% endif %} -# Additional labels (if any) specified by the user -{% if matrix_element_call_container_extra_arguments is defined and matrix_element_call_container_extra_arguments | length > 0 %} -{% for key, value in matrix_element_call_container_extra_arguments.items() %} -{{ key }}={{ value }} -{% endfor %} -{% endif %} +{{ matrix_element_call_container_labels_additional_labels }} diff --git a/roles/custom/matrix-element-call/templates/systemd/matrix-element-call.service.j2 b/roles/custom/matrix-element-call/templates/systemd/matrix-element-call.service.j2 index b64e3fbe8..b4bb602d0 100644 --- a/roles/custom/matrix-element-call/templates/systemd/matrix-element-call.service.j2 +++ b/roles/custom/matrix-element-call/templates/systemd/matrix-element-call.service.j2 @@ -1,7 +1,11 @@ +#jinja2: lstrip_blocks: "True" [Unit] Description=Matrix Element Call Service -After=docker.service -Requires=docker.service +{% for service in matrix_client_element_systemd_required_services_list %} +Requires={{ service }} +After={{ service }} +{% endfor %} +DefaultDependencies=no [Service] Type=simple @@ -15,9 +19,15 @@ ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} create \ --log-driver=none \ --user={{ matrix_user_uid }}:{{ matrix_user_gid }} \ --cap-drop=ALL \ + --read-only \ --network={{ matrix_element_call_container_network }} \ - -p {{ matrix_element_call_port }}:8080 \ + {% if matrix_element_call_container_http_host_bind_port %} + -p {{ matrix_element_call_container_http_host_bind_port }}:8080 \ + {% endif %} --label-file={{ matrix_element_call_base_path }}/config/element-call-labels \ + {% for arg in matrix_element_call_container_extra_arguments %} + {{ arg }} \ + {% endfor %} {{ matrix_element_call_image }} {% for network in matrix_element_call_container_additional_networks %}