123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420 |
- # -*- coding: utf-8 -*-
- # Copyright 2015-2016 OpenMarket Ltd
- # Copyright 2017-2018 New Vector Ltd
- # Copyright 2019 The Matrix.org Foundation C.I.C.
- #
- # 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 __future__ import print_function
- # This file can't be called email.py because if it is, we cannot:
- import email.utils
- import os
- from enum import Enum
- from typing import Optional
- import pkg_resources
- from ._base import Config, ConfigError
- MISSING_PASSWORD_RESET_CONFIG_ERROR = """\
- Password reset emails are enabled on this homeserver due to a partial
- 'email' block. However, the following required keys are missing:
- %s
- """
- class EmailConfig(Config):
- section = "email"
- def read_config(self, config, **kwargs):
- # TODO: We should separate better the email configuration from the notification
- # and account validity config.
- self.email_enable_notifs = False
- email_config = config.get("email")
- if email_config is None:
- email_config = {}
- self.email_smtp_host = email_config.get("smtp_host", "localhost")
- self.email_smtp_port = email_config.get("smtp_port", 25)
- self.email_smtp_user = email_config.get("smtp_user", None)
- self.email_smtp_pass = email_config.get("smtp_pass", None)
- self.require_transport_security = email_config.get(
- "require_transport_security", False
- )
- if "app_name" in email_config:
- self.email_app_name = email_config["app_name"]
- else:
- self.email_app_name = "Matrix"
- # TODO: Rename notif_from to something more generic, or have a separate
- # from for password resets, message notifications, etc?
- # Currently the email section is a bit bogged down with settings for
- # multiple functions. Would be good to split it out into separate
- # sections and only put the common ones under email:
- self.email_notif_from = email_config.get("notif_from", None)
- if self.email_notif_from is not None:
- # make sure it's valid
- parsed = email.utils.parseaddr(self.email_notif_from)
- if parsed[1] == "":
- raise RuntimeError("Invalid notif_from address")
- template_dir = email_config.get("template_dir")
- # we need an absolute path, because we change directory after starting (and
- # we don't yet know what auxilliary templates like mail.css we will need).
- # (Note that loading as package_resources with jinja.PackageLoader doesn't
- # work for the same reason.)
- if not template_dir:
- template_dir = pkg_resources.resource_filename("synapse", "res/templates")
- self.email_template_dir = os.path.abspath(template_dir)
- self.email_enable_notifs = email_config.get("enable_notifs", False)
- account_validity_config = config.get("account_validity") or {}
- account_validity_renewal_enabled = account_validity_config.get("renew_at")
- self.threepid_behaviour_email = (
- # Have Synapse handle the email sending if account_threepid_delegates.email
- # is not defined
- # msisdn is currently always remote while Synapse does not support any method of
- # sending SMS messages
- ThreepidBehaviour.REMOTE
- if self.account_threepid_delegate_email
- else ThreepidBehaviour.LOCAL
- )
- # Prior to Synapse v1.4.0, there was another option that defined whether Synapse would
- # use an identity server to password reset tokens on its behalf. We now warn the user
- # if they have this set and tell them to use the updated option, while using a default
- # identity server in the process.
- self.using_identity_server_from_trusted_list = False
- if (
- not self.account_threepid_delegate_email
- and config.get("trust_identity_server_for_password_resets", False) is True
- ):
- # Use the first entry in self.trusted_third_party_id_servers instead
- if self.trusted_third_party_id_servers:
- # XXX: It's a little confusing that account_threepid_delegate_email is modified
- # both in RegistrationConfig and here. We should factor this bit out
- first_trusted_identity_server = self.trusted_third_party_id_servers[0]
- # trusted_third_party_id_servers does not contain a scheme whereas
- # account_threepid_delegate_email is expected to. Presume https
- self.account_threepid_delegate_email = (
- "https://" + first_trusted_identity_server
- ) # type: Optional[str]
- self.using_identity_server_from_trusted_list = True
- else:
- raise ConfigError(
- "Attempted to use an identity server from"
- '"trusted_third_party_id_servers" but it is empty.'
- )
- self.local_threepid_handling_disabled_due_to_email_config = False
- if (
- self.threepid_behaviour_email == ThreepidBehaviour.LOCAL
- and email_config == {}
- ):
- # We cannot warn the user this has happened here
- # Instead do so when a user attempts to reset their password
- self.local_threepid_handling_disabled_due_to_email_config = True
- self.threepid_behaviour_email = ThreepidBehaviour.OFF
- # Get lifetime of a validation token in milliseconds
- self.email_validation_token_lifetime = self.parse_duration(
- email_config.get("validation_token_lifetime", "1h")
- )
- if (
- self.email_enable_notifs
- or account_validity_renewal_enabled
- or self.threepid_behaviour_email == ThreepidBehaviour.LOCAL
- ):
- # make sure we can import the required deps
- import jinja2
- import bleach
- # prevent unused warnings
- jinja2
- bleach
- if self.threepid_behaviour_email == ThreepidBehaviour.LOCAL:
- missing = []
- if not self.email_notif_from:
- missing.append("email.notif_from")
- # public_baseurl is required to build password reset and validation links that
- # will be emailed to users
- if config.get("public_baseurl") is None:
- missing.append("public_baseurl")
- if missing:
- raise ConfigError(
- MISSING_PASSWORD_RESET_CONFIG_ERROR % (", ".join(missing),)
- )
- # These email templates have placeholders in them, and thus must be
- # parsed using a templating engine during a request
- self.email_password_reset_template_html = email_config.get(
- "password_reset_template_html", "password_reset.html"
- )
- self.email_password_reset_template_text = email_config.get(
- "password_reset_template_text", "password_reset.txt"
- )
- self.email_registration_template_html = email_config.get(
- "registration_template_html", "registration.html"
- )
- self.email_registration_template_text = email_config.get(
- "registration_template_text", "registration.txt"
- )
- self.email_add_threepid_template_html = email_config.get(
- "add_threepid_template_html", "add_threepid.html"
- )
- self.email_add_threepid_template_text = email_config.get(
- "add_threepid_template_text", "add_threepid.txt"
- )
- self.email_password_reset_template_failure_html = email_config.get(
- "password_reset_template_failure_html", "password_reset_failure.html"
- )
- self.email_registration_template_failure_html = email_config.get(
- "registration_template_failure_html", "registration_failure.html"
- )
- self.email_add_threepid_template_failure_html = email_config.get(
- "add_threepid_template_failure_html", "add_threepid_failure.html"
- )
- # These templates do not support any placeholder variables, so we
- # will read them from disk once during setup
- email_password_reset_template_success_html = email_config.get(
- "password_reset_template_success_html", "password_reset_success.html"
- )
- email_registration_template_success_html = email_config.get(
- "registration_template_success_html", "registration_success.html"
- )
- email_add_threepid_template_success_html = email_config.get(
- "add_threepid_template_success_html", "add_threepid_success.html"
- )
- # Check templates exist
- for f in [
- self.email_password_reset_template_html,
- self.email_password_reset_template_text,
- self.email_registration_template_html,
- self.email_registration_template_text,
- self.email_add_threepid_template_html,
- self.email_add_threepid_template_text,
- self.email_password_reset_template_failure_html,
- self.email_registration_template_failure_html,
- self.email_add_threepid_template_failure_html,
- email_password_reset_template_success_html,
- email_registration_template_success_html,
- email_add_threepid_template_success_html,
- ]:
- p = os.path.join(self.email_template_dir, f)
- if not os.path.isfile(p):
- raise ConfigError("Unable to find template file %s" % (p,))
- # Retrieve content of web templates
- filepath = os.path.join(
- self.email_template_dir, email_password_reset_template_success_html
- )
- self.email_password_reset_template_success_html = self.read_file(
- filepath, "email.password_reset_template_success_html"
- )
- filepath = os.path.join(
- self.email_template_dir, email_registration_template_success_html
- )
- self.email_registration_template_success_html_content = self.read_file(
- filepath, "email.registration_template_success_html"
- )
- filepath = os.path.join(
- self.email_template_dir, email_add_threepid_template_success_html
- )
- self.email_add_threepid_template_success_html_content = self.read_file(
- filepath, "email.add_threepid_template_success_html"
- )
- if self.email_enable_notifs:
- missing = []
- if not self.email_notif_from:
- missing.append("email.notif_from")
- if config.get("public_baseurl") is None:
- missing.append("public_baseurl")
- if missing:
- raise ConfigError(
- "email.enable_notifs is True but required keys are missing: %s"
- % (", ".join(missing),)
- )
- self.email_notif_template_html = email_config.get(
- "notif_template_html", "notif_mail.html"
- )
- self.email_notif_template_text = email_config.get(
- "notif_template_text", "notif_mail.txt"
- )
- for f in self.email_notif_template_text, self.email_notif_template_html:
- p = os.path.join(self.email_template_dir, f)
- if not os.path.isfile(p):
- raise ConfigError("Unable to find email template file %s" % (p,))
- self.email_notif_for_new_users = email_config.get(
- "notif_for_new_users", True
- )
- self.email_riot_base_url = email_config.get(
- "client_base_url", email_config.get("riot_base_url", None)
- )
- if account_validity_renewal_enabled:
- self.email_expiry_template_html = email_config.get(
- "expiry_template_html", "notice_expiry.html"
- )
- self.email_expiry_template_text = email_config.get(
- "expiry_template_text", "notice_expiry.txt"
- )
- for f in self.email_expiry_template_text, self.email_expiry_template_html:
- p = os.path.join(self.email_template_dir, f)
- if not os.path.isfile(p):
- raise ConfigError("Unable to find email template file %s" % (p,))
- def generate_config_section(self, config_dir_path, server_name, **kwargs):
- return """\
- # Configuration for sending emails from Synapse.
- #
- email:
- # The hostname of the outgoing SMTP server to use. Defaults to 'localhost'.
- #
- #smtp_host: mail.server
- # The port on the mail server for outgoing SMTP. Defaults to 25.
- #
- #smtp_port: 587
- # Username/password for authentication to the SMTP server. By default, no
- # authentication is attempted.
- #
- #smtp_user: "exampleusername"
- #smtp_pass: "examplepassword"
- # Uncomment the following to require TLS transport security for SMTP.
- # By default, Synapse will connect over plain text, and will then switch to
- # TLS via STARTTLS *if the SMTP server supports it*. If this option is set,
- # Synapse will refuse to connect unless the server supports STARTTLS.
- #
- #require_transport_security: true
- # notif_from defines the "From" address to use when sending emails.
- # It must be set if email sending is enabled.
- #
- # The placeholder '%(app)s' will be replaced by the application name,
- # which is normally 'app_name' (below), but may be overridden by the
- # Matrix client application.
- #
- # Note that the placeholder must be written '%(app)s', including the
- # trailing 's'.
- #
- #notif_from: "Your Friendly %(app)s homeserver <noreply@example.com>"
- # app_name defines the default value for '%(app)s' in notif_from. It
- # defaults to 'Matrix'.
- #
- #app_name: my_branded_matrix_server
- # Uncomment the following to enable sending emails for messages that the user
- # has missed. Disabled by default.
- #
- #enable_notifs: true
- # Uncomment the following to disable automatic subscription to email
- # notifications for new users. Enabled by default.
- #
- #notif_for_new_users: false
- # Custom URL for client links within the email notifications. By default
- # links will be based on "https://matrix.to".
- #
- # (This setting used to be called riot_base_url; the old name is still
- # supported for backwards-compatibility but is now deprecated.)
- #
- #client_base_url: "http://localhost/riot"
- # Configure the time that a validation email will expire after sending.
- # Defaults to 1h.
- #
- #validation_token_lifetime: 15m
- # Directory in which Synapse will try to find the template files below.
- # If not set, default templates from within the Synapse package will be used.
- #
- # DO NOT UNCOMMENT THIS SETTING unless you want to customise the templates.
- # If you *do* uncomment it, you will need to make sure that all the templates
- # below are in the directory.
- #
- # Synapse will look for the following templates in this directory:
- #
- # * The contents of email notifications of missed events: 'notif_mail.html' and
- # 'notif_mail.txt'.
- #
- # * The contents of account expiry notice emails: 'notice_expiry.html' and
- # 'notice_expiry.txt'.
- #
- # * The contents of password reset emails sent by the homeserver:
- # 'password_reset.html' and 'password_reset.txt'
- #
- # * HTML pages for success and failure that a user will see when they follow
- # the link in the password reset email: 'password_reset_success.html' and
- # 'password_reset_failure.html'
- #
- # * The contents of address verification emails sent during registration:
- # 'registration.html' and 'registration.txt'
- #
- # * HTML pages for success and failure that a user will see when they follow
- # the link in an address verification email sent during registration:
- # 'registration_success.html' and 'registration_failure.html'
- #
- # * The contents of address verification emails sent when an address is added
- # to a Matrix account: 'add_threepid.html' and 'add_threepid.txt'
- #
- # * HTML pages for success and failure that a user will see when they follow
- # the link in an address verification email sent when an address is added
- # to a Matrix account: 'add_threepid_success.html' and
- # 'add_threepid_failure.html'
- #
- # You can see the default templates at:
- # https://github.com/matrix-org/synapse/tree/master/synapse/res/templates
- #
- #template_dir: "res/templates"
- """
- class ThreepidBehaviour(Enum):
- """
- Enum to define the behaviour of Synapse with regards to when it contacts an identity
- server for 3pid registration and password resets
- REMOTE = use an external server to send tokens
- LOCAL = send tokens ourselves
- OFF = disable registration via 3pid and password resets
- """
- REMOTE = "remote"
- LOCAL = "local"
- OFF = "off"
|