Add config variables for enabling terms auth and the policy name

changelog.d/4142.feature

@@ -0,0 +1 @@
+Add configuration options for enabling consent at registration and changing the policy name.

synapse/config/consent_config.py

@@ -42,6 +42,14 @@
 # until the user consents to the privacy policy. The value of the setting is
 # used as the text of the error.
 #
+# 'require_at_registration', if enabled, will add a step to the registration
+# process, similar to how captcha works. Users will be required to accept the
+# policy before their account is created.
+#
+# 'policy_name' is the name of the policy users will see when registering for
+# an account. Defaults to "Privacy Policy" and requires require_at_registration
+# to be enabled.
+#
 # user_consent:
 # template_dir: res/templates/privacy
 # version: 1.0
@@ -54,6 +62,8 @@
 # block_events_error: >-
 # To continue using this homeserver you must review and agree to the
 # terms and conditions at %(consent_uri)s
+# require_at_registration: False
+# policy_name: Privacy Policy
 #
 """
 
@@ -67,6 +77,8 @@ def __init__(self):
  self.user_consent_server_notice_content = None
  self.user_consent_server_notice_to_guests = False
  self.block_events_without_consent_error = None
+ self.user_consent_at_registration = False
+ self.user_consent_policy_name = "Privacy Policy"
 
  def read_config(self, config):
  consent_config = config.get("user_consent")
@@ -83,6 +95,12 @@ def read_config(self, config):
  self.user_consent_server_notice_to_guests = bool(consent_config.get(
  "send_server_notice_to_guests", False,
  ))
+ self.user_consent_at_registration = bool(consent_config.get(
+ "require_at_registration", False,
+ ))
+ self.user_consent_policy_name = consent_config.get(
+ "policy_name", "Privacy Policy",
+ )
 
  def default_config(self, **kwargs):
  return DEFAULT_CONFIG

synapse/handlers/auth.py

@@ -472,7 +472,7 @@ def _get_params_terms(self):
  "privacy_policy": {
  "version": self.hs.config.user_consent_version,
  "en": {
- "name": "Privacy Policy",
+ "name": self.hs.config.user_consent_policy_name,
  "url": "%s/_matrix/consent?v=%s" % (
  self.hs.config.public_baseurl,
  self.hs.config.user_consent_version,

synapse/rest/client/v2_alpha/register.py

@@ -360,7 +360,7 @@ def on_POST(self, request):
  ])
 
  # Append m.login.terms to all flows if we're requiring consent
- if self.hs.config.block_events_without_consent_error is not None:
+ if self.hs.config.user_consent_at_registration:
  new_flows = []
  for flow in flows:
  flow.append(LoginType.TERMS)

synapse/rest/consent/consent_resource.py

@@ -142,7 +142,7 @@ def _async_render_GET(self, request):
  userhmac = None
  has_consented = False
  public_version = username == ""
- if not public_version:
+ if not public_version or not self.hs.config.user_consent_at_registration:
  userhmac = parse_string(request, "h", required=True, encoding=None)
 
  self._check_hash(username, userhmac)

tests/test_terms_auth.py

@@ -42,7 +42,8 @@ def prepare(self, reactor, clock, hs):
  hs.config.enable_registration_captcha = False
 
  def test_ui_auth(self):
- self.hs.config.block_events_without_consent_error = True
+ self.hs.config.user_consent_at_registration = True
+ self.hs.config.user_consent_policy_name = "My Cool Privacy Policy"
  self.hs.config.public_baseurl = "https://example.org"
  self.hs.config.user_consent_version = "1.0"
 
@@ -66,7 +67,7 @@ def test_ui_auth(self):
  "policies": {
  "privacy_policy": {
  "en": {
- "name": "Privacy Policy",
+ "name": "My Cool Privacy Policy",
  "url": "https://example.org/_matrix/consent?v=1.0",
  },
  "version": "1.0"

tests/utils.py

@@ -123,6 +123,8 @@ def default_config(name):
  config.user_directory_search_all_users = False
  config.user_consent_server_notice_content = None
  config.block_events_without_consent_error = None
+ config.user_consent_at_registration = False
+ config.user_consent_policy_name = "Privacy Policy"
  config.media_storage_providers = []
  config.autocreate_auto_join_rooms = True
  config.auto_join_rooms = []