commit c6a72509d4ff2cb4df7621e5563808c710a38c66 Author: Paul van Tilburg Date: Fri Sep 20 23:09:51 2019 +0200 Initial import into Git diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2b152b8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +__pycache__/ +*.egg-info/ +*.pyc +/build/ +/dist/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f433b1a --- /dev/null +++ b/LICENSE @@ -0,0 +1,177 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..95fd49c --- /dev/null +++ b/README.rst @@ -0,0 +1,59 @@ +Synapse IMAP Auth Provider +========================== + +Allows Synapse to use IMAP as a password provider. + +This allows users to log in to Synapse with their username and password from an +IMAP server. + +Installation +------------ + +Install with ``./setup.py install``. + +Usage +----- + +Example Synapse config: + +.. code:: yaml + + password_providers: + - module: "imap_auth_provider.IMAPAuthProvider" + config: + host: imap.example.tld + port: 143 + start_tls: true + domain: example.tld + create_users: true + +The ``create_users``-key specifies whether to create Matrix accounts for valid +(local parts) of IMAP accounts. + +Troubleshooting and Debugging +----------------------------- + +``matrix-synapse-imap`` logging is included in the Synapse homeserver log +(typically ``homeserver.log``). The IMAP plugin log level can be increased to +``DEBUG`` for troubleshooting and debugging by making the following modifications +to your Synapse server's logging configuration file: + +- Set the value for `handlers.file.level` to `DEBUG`: + +.. code:: yaml + + handlers: + file: + # [...] + level: DEBUG + +- Add the following to the `loggers` section: + +.. code:: yaml + + loggers: + # [...] + imap_auth_provider: + level: DEBUG + +Finally, restart your Synapse server for the changes to take effect. diff --git a/imap_auth_provider.py b/imap_auth_provider.py new file mode 100644 index 0000000..31a31c6 --- /dev/null +++ b/imap_auth_provider.py @@ -0,0 +1,110 @@ +# -*- coding: utf-8 -*- +# Copyright 2019 Paul van Tilburg +# +# 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. + +import imaplib +from imaplib import IMAP4 + +import pwd + +from collections import namedtuple +from twisted.internet import defer + +import logging + +__version__ = "0.1.0" + +logger = logging.getLogger(__name__) + +class IMAPAuthProvider: + def __init__(self, config, account_handler): + self.account_handler = account_handler + self.config = config + + @defer.inlineCallbacks + def check_password(self, user_id, password): + """ Attempt to authenticate a user against IMAP + and register an account if none exists. + + Returns: + True if authentication against IMAP was successful + """ + if not password: + defer.returnValue(False) + + # The user_id is of the form @foo:bar.com, get the relevant part + localpart = user_id.split(":", 1)[0][1:] + user = localpart + + # Append the domain to the user if configured. + if self.config.domain: + user += "@" + self.config.domain + + # Now try to authenticate. + logger.debug( + "Attemping IMAP connection with %s:%s (TLS: %s)", + self.config.host, + self.config.port, + self.config.start_tls + ) + with IMAP4(self.config.host, self.config.port) as M: + if self.config.start_tls: + M.starttls() + try: + logger.debug("Attempting to login using user: %s", user) + M.login(user, password) + except imaplib.IMAP4.error as e: + logger.info("Could not authenticate user %s: %s", user, e) + defer.returnValue(False) + + # From here on, the user is authenticated! + logger.info("Successfully authenticated user %s", user) + + # Bail if we don't want to create users in Matrix. + if not self.config.create_users: + defer.returnValue(False) + + # Create the user in Matrix if it doesn't exist yet. + if not (yield self.account_handler.check_user_exists(user_id)): + yield self.account_handler.register(localpart=localpart) + + defer.returnValue(True) + + @staticmethod + def parse_config(config): + imap_config = namedtuple('_Config', 'create_users host port') + imap_config.create_users = config.get('create_users', True) + imap_config.host = config.get('host', 'localhost') + imap_config.port = config.get('port', 143) + imap_config.domain = config.get('domain', None) + imap_config.start_tls = config.get('start_tls', True) + + logger.debug("Parsed IMAP config: %s", imap_config) + + return imap_config + +# This is just here for testing purposes. Feel free to change the `test_config` +# object and `check_password` function arguments. +if __name__ == '__main__': + class DummyAccountHandler: + def check_user_exists(self, user_id): + return False + + def register(self, localpart=None): + print("User %s successfully authenticated, created account" % localpart) + + test_config = {} + parsed_config = IMAPAuthProvider.parse_config(test_config) + prov = IMAPAuthProvider(parsed_config, DummyAccountHandler()) + prov.check_password('@user:matrix.tld', 'password') diff --git a/setup.py b/setup.py new file mode 100755 index 0000000..8f06d54 --- /dev/null +++ b/setup.py @@ -0,0 +1,52 @@ +#!/usr/bin/env python3 +# +# Copyright 2019 Paul van Tilburg +# +# 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 setuptools import setup +import os + +here = os.path.abspath(os.path.dirname(__file__)) + +def read_file(path_segments): + """Read a UTF-8 file from the package. Takes a list of strings to join to + make the path""" + file_path = os.path.join(here, *path_segments) + with open(file_path, encoding="utf-8") as f: + return f.read() + +def exec_file(path_segments, name): + """Extract a constant from a python file by looking for a line defining + the constant and executing it.""" + result = {} + code = read_file(path_segments) + lines = [line for line in code.split('\n') if line.startswith(name)] + exec("\n".join(lines), result) + return result[name] + +setup( + name="matrix-synapse-imap", + version=exec_file(("imap_auth_provider.py",), "__version__"), + author="Paul van Tilburg", + author_email="paul@luon.net", + description="An IMAP auth provider for Synapse", + url="https://gitlab.com/paulvt/matrix-synapse-imap", + + py_modules=['imap_auth_provider'], + install_requires=[ + "Twisted>=15.0.0", + ], + long_description=read_file(("README.rst",)), + license="Apache-2.0" +)