123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141 |
- # -*- 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 distutils.util import strtobool
- from synapse.config._base import Config, ConfigError
- from synapse.types import RoomAlias
- from synapse.util.stringutils import random_string_with_symbols
- 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.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.default_identity_server = config.get("default_identity_server")
- 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", [])
- for room_alias in self.auto_join_rooms:
- if not RoomAlias.is_valid(room_alias):
- raise ConfigError('Invalid auto_join_rooms entry %s' % (room_alias,))
- self.autocreate_auto_join_rooms = config.get("autocreate_auto_join_rooms", True)
- def default_config(self, generate_secrets=False, **kwargs):
- if generate_secrets:
- registration_shared_secret = 'registration_shared_secret: "%s"' % (
- random_string_with_symbols(50),
- )
- else:
- registration_shared_secret = '# registration_shared_secret: <PRIVATE STRING>'
- 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.
- #
- # allowed_local_3pids:
- # - medium: email
- # pattern: ".*@matrix\\.org"
- # - medium: email
- # pattern: ".*@vector\\.im"
- # - medium: msisdn
- # pattern: "\\+44"
- # If set, allows registration by anyone who also has the shared
- # secret, even if registration is otherwise disabled.
- %(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 identity server which we suggest that clients should use when users log
- # in on this server.
- #
- # (By default, no suggestion is made, so it is left up to the client.
- # This setting is ignored unless public_baseurl is also set.)
- #
- # default_identity_server: https://matrix.org
- # The list of identity servers trusted to verify third party
- # identifiers by this server.
- #
- # Also defines the ID server which will be called when an account is
- # deactivated (one will be picked arbitrarily).
- trusted_third_party_id_servers:
- - matrix.org
- - vector.im
- # Users who register on this homeserver will automatically be joined
- # to these rooms
- #auto_join_rooms:
- # - "#example:example.com"
- # Where auto_join_rooms are specified, setting this flag ensures that the
- # the rooms exist by creating them when the first user on the
- # homeserver registers.
- # Setting to false means that if the rooms are not manually created,
- # users cannot be auto-joined since they do not exist.
- autocreate_auto_join_rooms: true
- """ % 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))
- )
|