2015-02-19 07:16:53 -07:00
|
|
|
# -*- coding: utf-8 -*-
|
2016-01-06 21:26:29 -07:00
|
|
|
# Copyright 2015, 2016 OpenMarket Ltd
|
2015-02-19 07:16:53 -07: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.
|
|
|
|
|
|
2019-07-31 10:12:04 -06:00
|
|
|
import os
|
2018-07-09 00:09:20 -06:00
|
|
|
from distutils.util import strtobool
|
2015-02-19 07:16:53 -07:00
|
|
|
|
2019-08-01 04:11:27 -06:00
|
|
|
import pkg_resources
|
|
|
|
|
|
2018-10-24 09:09:21 -06:00
|
|
|
from synapse.config._base import Config, ConfigError
|
2018-10-12 11:17:36 -06:00
|
|
|
from synapse.types import RoomAlias
|
2015-03-13 09:23:37 -06:00
|
|
|
from synapse.util.stringutils import random_string_with_symbols
|
|
|
|
|
|
2015-02-19 07:16:53 -07:00
|
|
|
|
2019-04-08 10:10:55 -06:00
|
|
|
class AccountValidityConfig(Config):
|
2019-04-10 10:58:47 -06:00
|
|
|
def __init__(self, config, synapse_config):
|
|
|
|
|
self.enabled = config.get("enabled", False)
|
2019-06-20 03:32:02 -06:00
|
|
|
self.renew_by_email_enabled = "renew_at" in config
|
2019-04-08 10:10:55 -06:00
|
|
|
|
2019-04-10 10:58:47 -06:00
|
|
|
if self.enabled:
|
|
|
|
|
if "period" in config:
|
|
|
|
|
self.period = self.parse_duration(config["period"])
|
|
|
|
|
else:
|
|
|
|
|
raise ConfigError("'period' is required when using account validity")
|
|
|
|
|
|
|
|
|
|
if "renew_at" in config:
|
|
|
|
|
self.renew_at = self.parse_duration(config["renew_at"])
|
|
|
|
|
|
|
|
|
|
if "renew_email_subject" in config:
|
|
|
|
|
self.renew_email_subject = config["renew_email_subject"]
|
|
|
|
|
else:
|
|
|
|
|
self.renew_email_subject = "Renew your %(app)s account"
|
|
|
|
|
|
2019-06-20 03:32:02 -06:00
|
|
|
self.startup_job_max_delta = self.period * 10.0 / 100.0
|
2019-05-28 09:47:42 -06:00
|
|
|
|
2019-07-31 10:12:04 -06:00
|
|
|
if self.renew_by_email_enabled:
|
|
|
|
|
if "public_baseurl" not in synapse_config:
|
|
|
|
|
raise ConfigError("Can't send renewal emails without 'public_baseurl'")
|
|
|
|
|
|
|
|
|
|
template_dir = config.get("template_dir")
|
|
|
|
|
|
|
|
|
|
if not template_dir:
|
|
|
|
|
template_dir = pkg_resources.resource_filename("synapse", "res/templates")
|
|
|
|
|
|
|
|
|
|
if "account_renewed_html_path" in config:
|
2019-08-01 04:11:27 -06:00
|
|
|
file_path = os.path.join(template_dir, config["account_renewed_html_path"])
|
2019-07-31 10:12:04 -06:00
|
|
|
|
|
|
|
|
self.account_renewed_html_content = self.read_file(
|
2019-08-01 04:11:27 -06:00
|
|
|
file_path, "account_validity.account_renewed_html_path"
|
2019-07-31 10:12:04 -06:00
|
|
|
)
|
|
|
|
|
else:
|
|
|
|
|
self.account_renewed_html_content = (
|
|
|
|
|
"<html><body>Your account has been successfully renewed.</body><html>"
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
if "invalid_token_html_path" in config:
|
2019-08-01 04:11:27 -06:00
|
|
|
file_path = os.path.join(template_dir, config["invalid_token_html_path"])
|
2019-07-31 10:12:04 -06:00
|
|
|
|
|
|
|
|
self.invalid_token_html_content = self.read_file(
|
2019-08-01 04:11:27 -06:00
|
|
|
file_path, "account_validity.invalid_token_html_path"
|
2019-07-31 10:12:04 -06:00
|
|
|
)
|
|
|
|
|
else:
|
|
|
|
|
self.invalid_token_html_content = (
|
|
|
|
|
"<html><body>Invalid renewal token.</body><html>"
|
|
|
|
|
)
|
2019-04-08 10:10:55 -06:00
|
|
|
|
|
|
|
|
|
2015-02-19 07:16:53 -07:00
|
|
|
class RegistrationConfig(Config):
|
2019-06-24 04:34:45 -06:00
|
|
|
def read_config(self, config, **kwargs):
|
2016-02-03 07:42:01 -07:00
|
|
|
self.enable_registration = bool(
|
2019-03-19 04:06:40 -06:00
|
|
|
strtobool(str(config.get("enable_registration", False)))
|
2015-02-19 07:16:53 -07:00
|
|
|
)
|
2015-04-30 07:34:09 -06:00
|
|
|
if "disable_registration" in config:
|
2016-02-03 07:42:01 -07:00
|
|
|
self.enable_registration = not bool(
|
2015-04-30 08:04:06 -06:00
|
|
|
strtobool(str(config["disable_registration"]))
|
2015-04-30 07:34:09 -06:00
|
|
|
)
|
|
|
|
|
|
2019-04-10 10:58:47 -06:00
|
|
|
self.account_validity = AccountValidityConfig(
|
2019-06-20 03:32:02 -06:00
|
|
|
config.get("account_validity", {}), config
|
2019-04-10 10:58:47 -06:00
|
|
|
)
|
2019-04-08 10:10:55 -06:00
|
|
|
|
2018-01-18 17:19:58 -07:00
|
|
|
self.registrations_require_3pid = config.get("registrations_require_3pid", [])
|
2018-01-19 08:33:55 -07:00
|
|
|
self.allowed_local_3pids = config.get("allowed_local_3pids", [])
|
2019-04-04 10:25:47 -06:00
|
|
|
self.enable_3pid_lookup = config.get("enable_3pid_lookup", True)
|
2015-04-29 21:24:44 -06:00
|
|
|
self.registration_shared_secret = config.get("registration_shared_secret")
|
2016-02-08 09:35:44 -07:00
|
|
|
|
2015-10-16 07:52:08 -06:00
|
|
|
self.bcrypt_rounds = config.get("bcrypt_rounds", 12)
|
2019-03-19 04:06:40 -06:00
|
|
|
self.trusted_third_party_id_servers = config.get(
|
2019-06-20 03:32:02 -06:00
|
|
|
"trusted_third_party_id_servers", ["matrix.org", "vector.im"]
|
2019-03-19 04:06:40 -06:00
|
|
|
)
|
2019-09-06 04:35:28 -06:00
|
|
|
account_threepid_delegates = config.get("account_threepid_delegates") or {}
|
|
|
|
|
self.account_threepid_delegate_email = account_threepid_delegates.get("email")
|
|
|
|
|
self.account_threepid_delegate_msisdn = account_threepid_delegates.get("msisdn")
|
|
|
|
|
|
2018-12-05 06:38:58 -07:00
|
|
|
self.default_identity_server = config.get("default_identity_server")
|
2015-11-04 10:29:07 -07:00
|
|
|
self.allow_guest_access = config.get("allow_guest_access", False)
|
2015-04-29 21:24:44 -06:00
|
|
|
|
2019-07-05 09:47:58 -06:00
|
|
|
if config.get("invite_3pid_guest", False):
|
|
|
|
|
raise ConfigError("invite_3pid_guest is no longer supported")
|
2016-03-14 09:50:40 -06:00
|
|
|
|
2017-10-16 10:57:27 -06:00
|
|
|
self.auto_join_rooms = config.get("auto_join_rooms", [])
|
2018-10-12 11:17:36 -06:00
|
|
|
for room_alias in self.auto_join_rooms:
|
|
|
|
|
if not RoomAlias.is_valid(room_alias):
|
2019-06-20 03:32:02 -06:00
|
|
|
raise ConfigError("Invalid auto_join_rooms entry %s" % (room_alias,))
|
2018-09-28 08:37:28 -06:00
|
|
|
self.autocreate_auto_join_rooms = config.get("autocreate_auto_join_rooms", True)
|
2017-10-16 10:57:27 -06:00
|
|
|
|
2019-06-20 03:32:02 -06:00
|
|
|
self.disable_msisdn_registration = config.get(
|
|
|
|
|
"disable_msisdn_registration", False
|
2019-01-21 08:17:20 -07:00
|
|
|
)
|
2019-01-21 07:59:37 -07:00
|
|
|
|
2019-07-12 10:26:02 -06:00
|
|
|
session_lifetime = config.get("session_lifetime")
|
|
|
|
|
if session_lifetime is not None:
|
|
|
|
|
session_lifetime = self.parse_duration(session_lifetime)
|
|
|
|
|
self.session_lifetime = session_lifetime
|
|
|
|
|
|
2019-06-21 17:00:20 -06:00
|
|
|
def generate_config_section(self, generate_secrets=False, **kwargs):
|
2018-12-21 08:04:57 -07:00
|
|
|
if generate_secrets:
|
|
|
|
|
registration_shared_secret = 'registration_shared_secret: "%s"' % (
|
|
|
|
|
random_string_with_symbols(50),
|
|
|
|
|
)
|
|
|
|
|
else:
|
2019-06-20 03:32:02 -06:00
|
|
|
registration_shared_secret = (
|
|
|
|
|
"# registration_shared_secret: <PRIVATE STRING>"
|
|
|
|
|
)
|
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 18:58:23 -07:00
|
|
|
|
2019-06-20 03:32:02 -06:00
|
|
|
return (
|
|
|
|
|
"""\
|
2015-04-29 21:24:44 -06:00
|
|
|
## Registration ##
|
2019-03-19 04:06:40 -06:00
|
|
|
#
|
2019-03-05 11:03:14 -07:00
|
|
|
# Registration can be rate-limited using the parameters in the "Ratelimiting"
|
|
|
|
|
# section of this file.
|
2015-03-13 06:59:45 -06:00
|
|
|
|
2015-04-29 21:24:44 -06:00
|
|
|
# Enable registration for new users.
|
2019-03-19 04:06:40 -06:00
|
|
|
#
|
|
|
|
|
#enable_registration: false
|
2015-03-13 09:23:37 -06:00
|
|
|
|
2019-04-10 10:58:47 -06:00
|
|
|
# Optional account validity configuration. This allows for accounts to be denied
|
|
|
|
|
# any request after a given period.
|
|
|
|
|
#
|
|
|
|
|
# ``enabled`` defines whether the account validity feature is enabled. Defaults
|
|
|
|
|
# to False.
|
|
|
|
|
#
|
|
|
|
|
# ``period`` allows setting the period after which an account is valid
|
|
|
|
|
# after its registration. When renewing the account, its validity period
|
|
|
|
|
# will be extended by this amount of time. This parameter is required when using
|
|
|
|
|
# the account validity feature.
|
|
|
|
|
#
|
|
|
|
|
# ``renew_at`` is the amount of time before an account's expiry date at which
|
|
|
|
|
# Synapse will send an email to the account's email address with a renewal link.
|
|
|
|
|
# This needs the ``email`` and ``public_baseurl`` configuration sections to be
|
|
|
|
|
# filled.
|
|
|
|
|
#
|
|
|
|
|
# ``renew_email_subject`` is the subject of the email sent out with the renewal
|
|
|
|
|
# link. ``%%(app)s`` can be used as a placeholder for the ``app_name`` parameter
|
|
|
|
|
# from the ``email`` section.
|
2019-04-08 10:10:55 -06:00
|
|
|
#
|
2019-05-21 07:39:36 -06:00
|
|
|
# Once this feature is enabled, Synapse will look for registered users without an
|
|
|
|
|
# expiration date at startup and will add one to every account it found using the
|
|
|
|
|
# current settings at that time.
|
|
|
|
|
# This means that, if a validity period is set, and Synapse is restarted (it will
|
|
|
|
|
# then derive an expiration date from the current validity period), and some time
|
|
|
|
|
# after that the validity period changes and Synapse is restarted, the users'
|
2019-05-31 02:54:46 -06:00
|
|
|
# expiration dates won't be updated unless their account is manually renewed. This
|
2019-05-31 04:09:34 -06:00
|
|
|
# date will be randomly selected within a range [now + period - d ; now + period],
|
2019-05-31 02:56:52 -06:00
|
|
|
# where d is equal to 10%% of the validity period.
|
2019-05-28 09:47:42 -06:00
|
|
|
#
|
2019-04-08 10:10:55 -06:00
|
|
|
#account_validity:
|
2019-04-10 10:58:47 -06:00
|
|
|
# enabled: True
|
2019-04-08 10:10:55 -06:00
|
|
|
# period: 6w
|
2019-04-10 10:58:47 -06:00
|
|
|
# renew_at: 1w
|
|
|
|
|
# renew_email_subject: "Renew your %%(app)s account"
|
2019-07-31 10:12:04 -06:00
|
|
|
# # Directory in which Synapse will try to find the HTML files to serve to the
|
|
|
|
|
# # user when trying to renew an account. Optional, defaults to
|
|
|
|
|
# # synapse/res/templates.
|
2019-08-01 04:11:27 -06:00
|
|
|
# template_dir: "res/templates"
|
2019-07-31 10:12:04 -06:00
|
|
|
# # HTML to be displayed to the user after they successfully renewed their
|
|
|
|
|
# # account. Optional.
|
|
|
|
|
# account_renewed_html_path: "account_renewed.html"
|
|
|
|
|
# # HTML to be displayed when the user tries to renew an account with an invalid
|
|
|
|
|
# # renewal token. Optional.
|
|
|
|
|
# invalid_token_html_path: "invalid_token.html"
|
2019-04-08 10:10:55 -06:00
|
|
|
|
2019-07-12 10:26:02 -06:00
|
|
|
# Time that a user's session remains valid for, after they log in.
|
|
|
|
|
#
|
|
|
|
|
# Note that this is not currently compatible with guest logins.
|
|
|
|
|
#
|
|
|
|
|
# Note also that this is calculated at login time: changes are not applied
|
|
|
|
|
# retrospectively to users who have already logged in.
|
|
|
|
|
#
|
|
|
|
|
# By default, this is infinite.
|
|
|
|
|
#
|
|
|
|
|
#session_lifetime: 24h
|
|
|
|
|
|
2018-01-19 08:33:55 -07:00
|
|
|
# The user must provide all of the below types of 3PID when registering.
|
2018-01-18 17:19:58 -07:00
|
|
|
#
|
2019-02-19 06:54:29 -07:00
|
|
|
#registrations_require_3pid:
|
|
|
|
|
# - email
|
|
|
|
|
# - msisdn
|
2018-01-19 08:33:55 -07:00
|
|
|
|
2019-01-21 07:59:37 -07:00
|
|
|
# Explicitly disable asking for MSISDNs from the registration
|
|
|
|
|
# flow (overrides registrations_require_3pid if MSISDNs are set as required)
|
|
|
|
|
#
|
2019-03-19 04:06:40 -06:00
|
|
|
#disable_msisdn_registration: true
|
2019-01-21 07:59:37 -07:00
|
|
|
|
2018-01-19 08:33:55 -07:00
|
|
|
# Mandate that users are only allowed to associate certain formats of
|
|
|
|
|
# 3PIDs with accounts on this server.
|
|
|
|
|
#
|
2019-02-19 06:54:29 -07:00
|
|
|
#allowed_local_3pids:
|
|
|
|
|
# - medium: email
|
|
|
|
|
# pattern: '.*@matrix\\.org'
|
|
|
|
|
# - medium: email
|
|
|
|
|
# pattern: '.*@vector\\.im'
|
|
|
|
|
# - medium: msisdn
|
|
|
|
|
# pattern: '\\+44'
|
2018-01-18 17:19:58 -07:00
|
|
|
|
2019-04-04 10:25:47 -06:00
|
|
|
# Enable 3PIDs lookup requests to identity servers from this server.
|
|
|
|
|
#
|
|
|
|
|
#enable_3pid_lookup: true
|
|
|
|
|
|
2019-03-11 12:21:52 -06:00
|
|
|
# If set, allows registration of standard or admin accounts by anyone who
|
|
|
|
|
# has the shared secret, even if registration is otherwise disabled.
|
2019-02-19 06:54:29 -07:00
|
|
|
#
|
2018-12-21 08:04:57 -07:00
|
|
|
%(registration_shared_secret)s
|
2016-02-08 09:35:44 -07:00
|
|
|
|
2015-10-16 07:52:08 -06: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 03:27:36 -06: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.
|
2019-02-19 06:54:29 -07:00
|
|
|
#
|
2019-03-19 04:06:40 -06:00
|
|
|
#bcrypt_rounds: 12
|
2015-11-04 10:29:07 -07: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.
|
2019-02-19 06:54:29 -07:00
|
|
|
#
|
2019-03-19 04:06:40 -06:00
|
|
|
#allow_guest_access: false
|
2016-01-29 07:12:26 -07:00
|
|
|
|
2018-12-05 06:38:58 -07:00
|
|
|
# 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.)
|
|
|
|
|
#
|
2019-02-19 06:54:29 -07:00
|
|
|
#default_identity_server: https://matrix.org
|
2018-12-05 06:38:58 -07:00
|
|
|
|
2016-01-29 07:12:26 -07:00
|
|
|
# The list of identity servers trusted to verify third party
|
|
|
|
|
# identifiers by this server.
|
2018-11-20 04:29:25 -07:00
|
|
|
#
|
|
|
|
|
# Also defines the ID server which will be called when an account is
|
|
|
|
|
# deactivated (one will be picked arbitrarily).
|
2019-02-19 06:54:29 -07:00
|
|
|
#
|
2019-09-06 04:35:28 -06:00
|
|
|
# Note: This option is deprecated. Since v0.99.4, Synapse has tracked which identity
|
|
|
|
|
# server a 3PID has been bound to. For 3PIDs bound before then, Synapse runs a
|
|
|
|
|
# background migration script, informing itself that the identity server all of its
|
|
|
|
|
# 3PIDs have been bound to is likely one of the below.
|
|
|
|
|
#
|
|
|
|
|
# As of Synapse v1.4.0, all other functionality of this option has been deprecated, and
|
|
|
|
|
# it is now solely used for the purposes of the background migration script, and can be
|
|
|
|
|
# removed once it has run.
|
2019-03-19 04:06:40 -06:00
|
|
|
#trusted_third_party_id_servers:
|
|
|
|
|
# - matrix.org
|
|
|
|
|
# - vector.im
|
2017-10-16 10:57:27 -06:00
|
|
|
|
2019-09-06 04:35:28 -06:00
|
|
|
# Handle threepid (email/phone etc) registration and password resets through a set of
|
|
|
|
|
# *trusted* identity servers. Note that this allows the configured identity server to
|
|
|
|
|
# reset passwords for accounts!
|
|
|
|
|
#
|
|
|
|
|
# Be aware that if `email` is not set, and SMTP options have not been
|
|
|
|
|
# configured in the email config block, registration and user password resets via
|
|
|
|
|
# email will be globally disabled.
|
|
|
|
|
#
|
|
|
|
|
# Additionally, if `msisdn` is not set, registration and password resets via msisdn
|
|
|
|
|
# will be disabled regardless. This is due to Synapse currently not supporting any
|
|
|
|
|
# method of sending SMS messages on its own.
|
|
|
|
|
#
|
|
|
|
|
# To enable using an identity server for operations regarding a particular third-party
|
|
|
|
|
# identifier type, set the value to the URL of that identity server as shown in the
|
|
|
|
|
# examples below.
|
|
|
|
|
#
|
|
|
|
|
# Servers handling the these requests must answer the `/requestToken` endpoints defined
|
|
|
|
|
# by the Matrix Identity Service API specification:
|
|
|
|
|
# https://matrix.org/docs/spec/identity_service/latest
|
|
|
|
|
#
|
2019-09-23 14:21:03 -06:00
|
|
|
# If a delegate is specified, the config option public_baseurl must also be filled out.
|
|
|
|
|
#
|
2019-09-06 04:35:28 -06:00
|
|
|
account_threepid_delegates:
|
2019-09-18 15:30:44 -06:00
|
|
|
#email: https://example.com # Delegate email sending to example.org
|
2019-09-06 04:35:28 -06:00
|
|
|
#msisdn: http://localhost:8090 # Delegate SMS sending to this local process
|
|
|
|
|
|
2017-10-17 03:13:13 -06:00
|
|
|
# Users who register on this homeserver will automatically be joined
|
|
|
|
|
# to these rooms
|
2019-02-19 06:54:29 -07:00
|
|
|
#
|
2017-10-16 10:57:27 -06:00
|
|
|
#auto_join_rooms:
|
2019-02-19 06:54:29 -07:00
|
|
|
# - "#example:example.com"
|
2018-09-27 18:42:53 -06:00
|
|
|
|
2018-10-12 11:17:36 -06:00
|
|
|
# Where auto_join_rooms are specified, setting this flag ensures that the
|
2018-10-17 04:36:41 -06:00
|
|
|
# the rooms exist by creating them when the first user on the
|
2018-10-12 11:17:36 -06:00
|
|
|
# homeserver registers.
|
|
|
|
|
# Setting to false means that if the rooms are not manually created,
|
2018-10-17 04:36:41 -06:00
|
|
|
# users cannot be auto-joined since they do not exist.
|
2019-02-19 06:54:29 -07:00
|
|
|
#
|
2019-03-19 04:06:40 -06:00
|
|
|
#autocreate_auto_join_rooms: true
|
2019-06-20 03:32:02 -06:00
|
|
|
"""
|
|
|
|
|
% locals()
|
|
|
|
|
)
|
2015-04-30 08:04:06 -06:00
|
|
|
|
2019-07-15 06:15:34 -06:00
|
|
|
@staticmethod
|
|
|
|
|
def add_arguments(parser):
|
2015-04-30 08:04:06 -06:00
|
|
|
reg_group = parser.add_argument_group("registration")
|
|
|
|
|
reg_group.add_argument(
|
2019-06-20 03:32:02 -06:00
|
|
|
"--enable-registration",
|
|
|
|
|
action="store_true",
|
|
|
|
|
default=None,
|
|
|
|
|
help="Enable registration for new users.",
|
2015-04-30 08:04:06 -06:00
|
|
|
)
|
|
|
|
|
|
|
|
|
|
def read_arguments(self, args):
|
|
|
|
|
if args.enable_registration is not None:
|
2019-06-20 03:32:02 -06:00
|
|
|
self.enable_registration = bool(strtobool(str(args.enable_registration)))
|
