2015-02-19 09:16:53 -05:00
|
|
|
# -*- coding: utf-8 -*-
|
2016-01-06 23:26:29 -05:00
|
|
|
# Copyright 2015, 2016 OpenMarket Ltd
|
2015-02-19 09:16:53 -05:00
|
|
|
#
|
|
|
|
# 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.
|
|
|
|
|
2018-07-09 02:09:20 -04:00
|
|
|
from distutils.util import strtobool
|
2015-02-19 09:16:53 -05:00
|
|
|
|
2015-03-13 11:23:37 -04:00
|
|
|
from synapse.util.stringutils import random_string_with_symbols
|
|
|
|
|
2018-07-09 02:09:20 -04:00
|
|
|
from ._base import Config
|
2015-03-13 12:49:18 -04:00
|
|
|
|
2015-02-19 09:16:53 -05:00
|
|
|
|
|
|
|
class RegistrationConfig(Config):
|
|
|
|
|
2015-04-29 23:24:44 -04:00
|
|
|
def read_config(self, config):
|
2016-02-03 09:42:01 -05:00
|
|
|
self.enable_registration = bool(
|
2015-04-30 10:04:06 -04:00
|
|
|
strtobool(str(config["enable_registration"]))
|
2015-02-19 09:16:53 -05:00
|
|
|
)
|
2015-04-30 09:34:09 -04:00
|
|
|
if "disable_registration" in config:
|
2016-02-03 09:42:01 -05:00
|
|
|
self.enable_registration = not bool(
|
2015-04-30 10:04:06 -04:00
|
|
|
strtobool(str(config["disable_registration"]))
|
2015-04-30 09:34:09 -04:00
|
|
|
)
|
|
|
|
|
2018-01-18 19:19:58 -05:00
|
|
|
self.registrations_require_3pid = config.get("registrations_require_3pid", [])
|
2018-01-19 10:33:55 -05:00
|
|
|
self.allowed_local_3pids = config.get("allowed_local_3pids", [])
|
2015-04-29 23:24:44 -04:00
|
|
|
self.registration_shared_secret = config.get("registration_shared_secret")
|
2016-02-08 11:35:44 -05:00
|
|
|
|
2015-10-16 09:52:08 -04:00
|
|
|
self.bcrypt_rounds = config.get("bcrypt_rounds", 12)
|
2016-01-29 09:12:26 -05:00
|
|
|
self.trusted_third_party_id_servers = config["trusted_third_party_id_servers"]
|
2015-11-04 12:29:07 -05:00
|
|
|
self.allow_guest_access = config.get("allow_guest_access", False)
|
2015-04-29 23:24:44 -04:00
|
|
|
|
2016-03-14 11:50:40 -04:00
|
|
|
self.invite_3pid_guest = (
|
|
|
|
self.allow_guest_access and config.get("invite_3pid_guest", False)
|
|
|
|
)
|
|
|
|
|
2017-10-16 12:57:27 -04:00
|
|
|
self.auto_join_rooms = config.get("auto_join_rooms", [])
|
2018-09-28 10:37:28 -04:00
|
|
|
self.autocreate_auto_join_rooms = config.get("autocreate_auto_join_rooms", True)
|
2017-10-16 12:57:27 -04:00
|
|
|
|
2016-02-08 11:35:44 -05:00
|
|
|
def default_config(self, **kwargs):
|
2015-04-29 23:24:44 -04:00
|
|
|
registration_shared_secret = random_string_with_symbols(50)
|
Error if macaroon key is missing from config
Currently we store all access tokens in the DB, and fall back to that
check if we can't validate the macaroon, so our fallback works here, but
for guests, their macaroons don't get persisted, so we don't get to
find them in the database. Each restart, we generate a new ephemeral
key, so guests lose access after each server restart.
I tried to fix up the config stuff to be less insane, but gave up, so
instead I bolt on yet another piece of custom one-off insanity.
Also, add some basic tests for config generation and loading.
2016-02-04 20:58:23 -05:00
|
|
|
|
2015-04-29 23:24:44 -04:00
|
|
|
return """\
|
|
|
|
## Registration ##
|
2015-03-13 08:59:45 -04:00
|
|
|
|
2015-04-29 23:24:44 -04:00
|
|
|
# Enable registration for new users.
|
2015-05-28 06:01:34 -04:00
|
|
|
enable_registration: False
|
2015-03-13 11:23:37 -04:00
|
|
|
|
2018-01-19 10:33:55 -05:00
|
|
|
# The user must provide all of the below types of 3PID when registering.
|
2018-01-18 19:19:58 -05:00
|
|
|
#
|
|
|
|
# registrations_require_3pid:
|
2018-01-19 10:33:55 -05:00
|
|
|
# - email
|
|
|
|
# - msisdn
|
|
|
|
|
|
|
|
# Mandate that users are only allowed to associate certain formats of
|
|
|
|
# 3PIDs with accounts on this server.
|
|
|
|
#
|
|
|
|
# allowed_local_3pids:
|
2018-01-18 19:19:58 -05:00
|
|
|
# - medium: email
|
|
|
|
# pattern: ".*@matrix\\.org"
|
|
|
|
# - medium: email
|
|
|
|
# pattern: ".*@vector\\.im"
|
|
|
|
# - medium: msisdn
|
|
|
|
# pattern: "\\+44"
|
|
|
|
|
2015-04-29 23:24:44 -04:00
|
|
|
# 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"
|
2016-02-08 11:35:44 -05:00
|
|
|
|
2015-10-16 09:52:08 -04:00
|
|
|
# Set the number of bcrypt rounds used to generate password hash.
|
|
|
|
# Larger numbers increase the work factor needed to generate the hash.
|
2018-03-19 05:27:36 -04:00
|
|
|
# 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.
|
2015-10-16 09:52:08 -04:00
|
|
|
bcrypt_rounds: 12
|
2015-11-04 12:29:07 -05:00
|
|
|
|
|
|
|
# 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
|
2016-01-29 09:12:26 -05:00
|
|
|
|
|
|
|
# The list of identity servers trusted to verify third party
|
|
|
|
# identifiers by this server.
|
|
|
|
trusted_third_party_id_servers:
|
|
|
|
- matrix.org
|
|
|
|
- vector.im
|
2017-04-10 12:58:28 -04:00
|
|
|
- riot.im
|
2017-10-16 12:57:27 -04:00
|
|
|
|
2017-10-17 05:13:13 -04:00
|
|
|
# Users who register on this homeserver will automatically be joined
|
|
|
|
# to these rooms
|
2017-10-16 12:57:27 -04:00
|
|
|
#auto_join_rooms:
|
|
|
|
# - "#example:example.com"
|
2018-09-27 20:42:53 -04:00
|
|
|
|
|
|
|
# Have first user on server autocreate autojoin rooms
|
|
|
|
autocreate_auto_join_rooms: true
|
2015-04-29 23:24:44 -04:00
|
|
|
""" % locals()
|
2015-04-30 10:04:06 -04:00
|
|
|
|
|
|
|
def add_arguments(self, parser):
|
|
|
|
reg_group = parser.add_argument_group("registration")
|
|
|
|
reg_group.add_argument(
|
2015-05-01 08:54:38 -04:00
|
|
|
"--enable-registration", action="store_true", default=None,
|
2015-04-30 10:04:06 -04:00
|
|
|
help="Enable registration for new users."
|
|
|
|
)
|
|
|
|
|
|
|
|
def read_arguments(self, args):
|
|
|
|
if args.enable_registration is not None:
|
2016-02-03 09:42:01 -05:00
|
|
|
self.enable_registration = bool(
|
2015-04-30 10:04:06 -04:00
|
|
|
strtobool(str(args.enable_registration))
|
|
|
|
)
|