Merge pull request #2198 from etkecc/buscarron-130

update buscarron 1.2.1 -> 1.3.0

docs/configuring-playbook-bot-buscarron.md

@@ -36,10 +36,10 @@ matrix_bot_buscarron_forms:
     room: "!yourRoomID:DOMAIN" # (mandatory) Room ID where form submission will be posted
     redirect: https://DOMAIN # (mandatory) To what page user will be redirected after the form submission
     ratelimit: 1r/m # (optional) rate limit of the form, format: <max requests>r/<interval:s,m>, eg: 1r/s or 54r/m
+    hasemail: 1 # (optional) form has "email" field that should be validated
     extensions: [] # (optional) list of form extensions (not used yet)
 
-matrix_bot_buscarron_spam_hosts: [] # (optional) list of email domains/hosts that should be rejected automatically
-matrix_bot_buscarron_spam_emails: [] # (optional) list of email addresses that should be rejected automatically
+matrix_bot_buscarron_spamlist: [] # (optional) list of emails/domains/hosts (with wildcards support) that should be rejected automatically
 ```
 
 You will also need to add a DNS record so that buscarron can be accessed.

group_vars/matrix_servers

@@ -1194,7 +1194,7 @@ matrix_bot_buscarron_systemd_required_services_list: |
 # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
 matrix_bot_buscarron_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
 matrix_bot_buscarron_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'buscarron.bot.db') | to_uuid }}"
-matrix_bot_buscarron_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm32', 'arm64'] }}"
+matrix_bot_buscarron_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
 
 ######################################################################
 #

roles/matrix-bot-buscarron/defaults/main.yml

@@ -9,7 +9,7 @@ matrix_bot_buscarron_docker_repo: "https://gitlab.com/etke.cc/buscarron.git"
 matrix_bot_buscarron_docker_repo_version: "{{ matrix_bot_buscarron_version }}"
 matrix_bot_buscarron_docker_src_files_path: "{{ matrix_base_data_path }}/buscarron/docker-src"
 
-matrix_bot_buscarron_version: v1.2.1
+matrix_bot_buscarron_version: v1.3.0
 matrix_bot_buscarron_docker_image: "{{ matrix_bot_buscarron_docker_image_name_prefix }}buscarron:{{ matrix_bot_buscarron_version }}"
 matrix_bot_buscarron_docker_image_name_prefix: "{{ 'localhost/' if matrix_bot_buscarron_container_image_self_build else 'registry.gitlab.com/etke.cc/' }}"
 matrix_bot_buscarron_docker_image_force_pull: "{{ matrix_bot_buscarron_docker_image.endswith(':latest') }}"
@@ -78,37 +78,49 @@ matrix_bot_buscarron_homeserver: "{{ matrix_homeserver_container_url }}"
 matrix_bot_buscarron_forms: []
 
 # Disable encryption
-matrix_bot_buscarron_noencryption:
+matrix_bot_buscarron_noencryption: false
 
 # Sentry DSN
-matrix_bot_buscarron_sentry:
+matrix_bot_buscarron_sentry: ''
 
 # Log level
 matrix_bot_buscarron_loglevel: INFO
 
-# spam hosts/domains
+# list of spammers with wildcards support, eg: *@spam.com spam@*, spam@spam.com
+matrix_bot_buscarron_spamlist: []
+
+# spam hosts/domains.
+# deprecated, use matrix_bot_buscarron_spamlist
 matrix_bot_buscarron_spam_hosts: []
 
 # spam email addresses
+# deprecated, use matrix_bot_buscarron_spamlist
 matrix_bot_buscarron_spam_emails: []
 
 # spam email localparts
+# deprecated, use matrix_bot_buscarron_spamlist
 matrix_bot_buscarron_spam_localparts: []
 
-# Ban duration in hours
-matrix_bot_buscarron_ban_duration: 24
-
 # Banlist size
 matrix_bot_buscarron_ban_size: 10000
 
+# Permanent banlist
+matrix_bot_buscarron_ban_list: []
+
 # Postmark token (confirmation emails)
-matrix_bot_buscarron_pm_token:
+matrix_bot_buscarron_pm_token: ''
 
 # Postmark sender signature
-matrix_bot_buscarron_pm_from:
+matrix_bot_buscarron_pm_from: ''
 
 # Postmark confirmation email's reply-to
-matrix_bot_buscarron_pm_replyto:
+matrix_bot_buscarron_pm_replyto: ''
+
+# email address (from) for SMTP validation. Must be valid email on valid SMTP server, otherwise it will be rejected by other servers
+matrix_bot_buscarron_smtp_from: ''
+
+# enforce SMTP validation
+matrix_bot_buscarron_smtp_validation: false
 
 # Additional environment variables to pass to the buscarron container
 #

roles/matrix-bot-buscarron/templates/env.j2

@@ -3,22 +3,26 @@ BUSCARRON_PASSWORD={{ matrix_bot_buscarron_password }}
 BUSCARRON_HOMESERVER={{ matrix_bot_buscarron_homeserver }}
 BUSCARRON_DB_DSN={{ matrix_bot_buscarron_database_connection_string }}
 BUSCARRON_DB_DIALECT={{ matrix_bot_buscarron_database_dialect }}
+BUSCARRON_SPAMLIST={{ matrix_bot_buscarron_spamlist|join(" ") }}
 BUSCARRON_SPAM_HOSTS={{ matrix_bot_buscarron_spam_hosts|join(" ") }}
 BUSCARRON_SPAM_EMAILS={{ matrix_bot_buscarron_spam_emails|join(" ") }}
 BUSCARRON_SPAM_LOCALPARTS={{ matrix_bot_buscarron_spam_localparts|join(" ") }}
 BUSCARRON_SENTRY={{ matrix_bot_buscarron_sentry }}
 BUSCARRON_LOGLEVEL={{ matrix_bot_buscarron_loglevel }}
-BUSCARRON_BAN_DURATION={{ matrix_bot_buscarron_ban_duration }}
 BUSCARRON_BAN_SIZE={{ matrix_bot_buscarron_ban_size }}
+BUSCARRON_BAN_LIST={{ matrix_bot_buscarron_ban_list }}
 BUSCARRON_PM_TOKEN={{ matrix_bot_buscarron_pm_token }}
 BUSCARRON_PM_FROM={{ matrix_bot_buscarron_pm_from }}
 BUSCARRON_PM_REPLYTO={{ matrix_bot_buscarron_pm_replyto }}
+BUSCARRON_SMTP_FROM={{ matrix_bot_buscarron_smtp_from }}
+BUSCARRON_SMTP_VALIDATION={{ matrix_bot_buscarron_smtp_validation }}
 BUSCARRON_NOENCRYPTION={{ matrix_bot_buscarron_noencryption }}
 {% set forms = [] %}
 {% for form in matrix_bot_buscarron_forms -%}{{- forms.append(form.name) -}}
 BUSCARRON_{{ form.name|upper }}_ROOM={{ form.room|default('') }}
 BUSCARRON_{{ form.name|upper }}_REDIRECT={{ form.redirect|default('') }}
 BUSCARRON_{{ form.name|upper }}_HASDOMAIN={{ form.hasdomain|default('') }}
+BUSCARRON_{{ form.name|upper }}_HASEMAIL={{ form.hasemail|default('') }}
 BUSCARRON_{{ form.name|upper }}_RATELIMIT={{ form.ratelimit|default('') }}
 BUSCARRON_{{ form.name|upper }}_EXTENSIONS={{ form.extensions|default('')|join(' ') }}
 BUSCARRON_{{ form.name|upper }}_CONFIRMATION_SUBJECT={{ form.confirmation_subject|default('') }}