mirror of
https://mau.dev/maunium/synapse.git
synced 2024-10-01 01:36:05 -04:00
8a24c4eee5
This only considers the /account/3pid API, which should be sufficient as currently we can't change emails associated with push notifs (which are provisioned at registration), and we can't directly create mappings for accounts in an IS other than by answering an invite
147 lines
5.5 KiB
Python
147 lines
5.5 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright 2015, 2016 OpenMarket Ltd
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
from ._base import Config
|
|
|
|
from synapse.util.stringutils import random_string_with_symbols
|
|
|
|
from distutils.util import strtobool
|
|
|
|
|
|
class RegistrationConfig(Config):
|
|
|
|
def read_config(self, config):
|
|
self.enable_registration = bool(
|
|
strtobool(str(config["enable_registration"]))
|
|
)
|
|
if "disable_registration" in config:
|
|
self.enable_registration = not bool(
|
|
strtobool(str(config["disable_registration"]))
|
|
)
|
|
|
|
self.registrations_require_3pid = config.get("registrations_require_3pid", [])
|
|
self.allowed_local_3pids = config.get("allowed_local_3pids", [])
|
|
self.check_is_for_allowed_local_3pids = config.get(
|
|
"check_is_for_allowed_local_3pids", None
|
|
)
|
|
self.allow_invited_3pids = config.get("allow_invited_3pids", False)
|
|
|
|
self.disable_3pid_changes = config.get("disable_3pid_changes", False)
|
|
|
|
self.registration_shared_secret = config.get("registration_shared_secret")
|
|
|
|
self.bcrypt_rounds = config.get("bcrypt_rounds", 12)
|
|
self.trusted_third_party_id_servers = config["trusted_third_party_id_servers"]
|
|
self.allow_guest_access = config.get("allow_guest_access", False)
|
|
|
|
self.invite_3pid_guest = (
|
|
self.allow_guest_access and config.get("invite_3pid_guest", False)
|
|
)
|
|
|
|
self.auto_join_rooms = config.get("auto_join_rooms", [])
|
|
|
|
self.replicate_user_profiles_to = config.get("replicate_user_profiles_to", [])
|
|
if not isinstance(self.replicate_user_profiles_to, list):
|
|
self.replicate_user_profiles_to = [self.replicate_user_profiles_to, ]
|
|
|
|
def default_config(self, **kwargs):
|
|
registration_shared_secret = random_string_with_symbols(50)
|
|
|
|
return """\
|
|
## Registration ##
|
|
|
|
# Enable registration for new users.
|
|
enable_registration: False
|
|
|
|
# The user must provide all of the below types of 3PID when registering.
|
|
#
|
|
# registrations_require_3pid:
|
|
# - email
|
|
# - msisdn
|
|
|
|
# Mandate that users are only allowed to associate certain formats of
|
|
# 3PIDs with accounts on this server.
|
|
#
|
|
# Use an Identity Server to establish which 3PIDs are allowed to register?
|
|
# Overrides allowed_local_3pids below.
|
|
# check_is_for_allowed_local_3pids: matrix.org
|
|
#
|
|
# If you are using an IS you can also check whether that IS registers
|
|
# pending invites for the given 3PID (and then allow it to sign up on
|
|
# the platform):
|
|
#
|
|
# allow_invited_3pids: False
|
|
#
|
|
# allowed_local_3pids:
|
|
# - medium: email
|
|
# pattern: ".*@matrix\\.org"
|
|
# - medium: email
|
|
# pattern: ".*@vector\\.im"
|
|
# - medium: msisdn
|
|
# pattern: "\\+44"
|
|
|
|
# If true, stop users from trying to change the 3PIDs associated with
|
|
# their accounts.
|
|
#
|
|
# disable_3pid_changes: True
|
|
|
|
# If set, allows registration by anyone who also has the shared
|
|
# secret, even if registration is otherwise disabled.
|
|
registration_shared_secret: "%(registration_shared_secret)s"
|
|
|
|
# Set the number of bcrypt rounds used to generate password hash.
|
|
# Larger numbers increase the work factor needed to generate the hash.
|
|
# The default number is 12 (which equates to 2^12 rounds).
|
|
# N.B. that increasing this will exponentially increase the time required
|
|
# to register or login - e.g. 24 => 2^24 rounds which will take >20 mins.
|
|
bcrypt_rounds: 12
|
|
|
|
# Allows users to register as guests without a password/email/etc, and
|
|
# participate in rooms hosted on this server which have been made
|
|
# accessible to anonymous users.
|
|
allow_guest_access: False
|
|
|
|
# The list of identity servers trusted to verify third party
|
|
# identifiers by this server.
|
|
trusted_third_party_id_servers:
|
|
- matrix.org
|
|
- vector.im
|
|
- riot.im
|
|
|
|
# If enabled, user IDs, display names and avatar URLs will be replicated
|
|
# to this server whenever they change.
|
|
# This is an experimental API currently implemented by sydent to support
|
|
# cross-homeserver user directories.
|
|
# replicate_user_profiles_to: example.com
|
|
|
|
# Users who register on this homeserver will automatically be joined
|
|
# to these rooms
|
|
#auto_join_rooms:
|
|
# - "#example:example.com"
|
|
""" % locals()
|
|
|
|
def add_arguments(self, parser):
|
|
reg_group = parser.add_argument_group("registration")
|
|
reg_group.add_argument(
|
|
"--enable-registration", action="store_true", default=None,
|
|
help="Enable registration for new users."
|
|
)
|
|
|
|
def read_arguments(self, args):
|
|
if args.enable_registration is not None:
|
|
self.enable_registration = bool(
|
|
strtobool(str(args.enable_registration))
|
|
)
|