commit 4f393da1156834ef2690ee4f0ad11882c0df87de Author: Andrew Morgan Date: Mon Nov 25 16:30:18 2019 +0000 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..bd99301 --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +.vscode +.idea +.coverage +.tox/ +__pycache__/ +*.egg-info/ +*.pyc +build/ +env/ +dist/ +_trial_temp/ 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/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..f6edbec --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,6 @@ +include *.in +include *.py +include LICENSE +include tox.ini +include requirements.txt +recursive-include tests *.py diff --git a/README.md b/README.md new file mode 100644 index 0000000..c131792 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# Synapse Mozilla SAML MXID Mapper + +Custom SAML auth response -> MXID mapping algorithm used during the Mozilla +Matrix trial run. + +## Installation + +This plugin can be installed via [PyPi](https://pypi.org): + +``` +pip install matrix-synapse-saml-moz +``` + +## Usage + +Example synapse config: + +```yaml + saml2_config: + mapping_provider: "saml_mapping_provider.SamlMappingProvider" +``` + +## Development and Testing + +This repository uses `tox` to run linting and tests. + +### Linting code + +Code is linted with the `flake8` tool. Run `tox -e pep8` to check for linting +errors in the codebase. + +### Tests + +This repository uses `unittest` to run the tests located in the `tests` +directory. They can be ran with `tox -e tests`. diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..d6e1198 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +-e . diff --git a/saml_mapping_provider.py b/saml_mapping_provider.py new file mode 100644 index 0000000..51fbc87 --- /dev/null +++ b/saml_mapping_provider.py @@ -0,0 +1,78 @@ +# -*- coding: utf-8 -*- +# 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. + +import re +import string + +__version__ = "0.0.1" + + +class SamlMappingProvider(object): + def __init__(self): + mxid_localpart_allowed_characters = set( + "_-./=" + string.ascii_lowercase + string.digits + ) + self._dot_replace_pattern = re.compile( + ("[^%s]" % (re.escape("".join(mxid_localpart_allowed_characters)),)) + ) + self._multiple_to_single_dot_pattern = re.compile(r"\.{2,}") + + self._string_end_dot_pattern = re.compile(r"\.$") + + def mxid_source_to_mxid_localpart(self, mxid_source: str, failures: int = 0) -> str: + """Maps some text from a SAML response to the localpart of a new mxid + + Args: + mxid_source (str): The input text from a SAML auth response + + failures (int): How many times a call to this function with this + mxid_source has resulted in a failure (possibly due to the localpart + already existing) + + Returns: + str: The localpart of a new mxid + """ + # Truncate the username to the first found '@' character to prevent complete + # emails being leaked + pos = mxid_source.find("@") + if pos >= 0: + mxid_source = mxid_source[:pos] + mxid_localpart = self._dotreplace_for_mxid(mxid_source) + + # Append suffix integer if last call to this function failed to produce + # a usable mxid + return mxid_localpart + (str(failures) if failures else "") + + def _dotreplace_for_mxid(self, username: str) -> str: + """Replace non-allowed mxid characters with a '.' + + Args: + username (str): The username to process + + Returns: + str: The processed username + """ + username = username.lower() + username = self._dot_replace_pattern.sub(".", username) + + # regular mxids aren't allowed to start with an underscore either + username = re.sub("^_", "", username) + + # Change all instances of multiple dots together into a single dot + username = self._multiple_to_single_dot_pattern.sub(".", username) + + # Remove any trailing dots + username = self._string_end_dot_pattern.sub("", username) + return username diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..ab5366c --- /dev/null +++ b/setup.cfg @@ -0,0 +1,4 @@ +[flake8] +max-line-length = 90 +# W503 requires that binary operators be at the end, not start, of lines. Erik doesn't like it. +ignore = W503 diff --git a/setup.py b/setup.py new file mode 100755 index 0000000..ebd9e97 --- /dev/null +++ b/setup.py @@ -0,0 +1,54 @@ +#!/usr/bin/env python + +# 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 setuptools import setup +from codecs import open +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-saml-moz", + version=exec_file(("saml_mapping_provider.py",), "__version__"), + py_modules=["matrix-synapse-saml-moz"], + description="An Mozilla-flavoured SAML MXID mapper for Synapse", + install_requires=[], + long_description=read_file(("README.md",)), + classifiers=[ + 'Development Status :: 4 - Beta', + 'License :: OSI Approved :: Apache Software License', + 'Programming Language :: Python :: 3', + ], +) diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..5264967 --- /dev/null +++ b/tests/__init__.py @@ -0,0 +1,5 @@ +from saml_mapping_provider import SamlMappingProvider + + +def create_mapping_provider() -> SamlMappingProvider: + return SamlMappingProvider() diff --git a/tests/test_username.py b/tests/test_username.py new file mode 100644 index 0000000..05998b8 --- /dev/null +++ b/tests/test_username.py @@ -0,0 +1,70 @@ +# -*- coding: utf-8 -*- +# 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. + +import logging +import unittest + +from . import create_mapping_provider + +logging.basicConfig() + + +class SamlUsernameTestCase(unittest.TestCase): + + def test_normal_user(self): + provider = create_mapping_provider() + + username = "john*doe2000#@example.com" + localpart = provider.mxid_source_to_mxid_localpart(username) + self.assertEqual(localpart, "john.doe2000") + + def test_multiple_adjacent_symbols(self): + provider = create_mapping_provider() + + username = "bob%^$&#!bobby@example.com" + localpart = provider.mxid_source_to_mxid_localpart(username) + self.assertEqual(localpart, "bob.bobby") + + def test_username_does_not_end_with_dot(self): + """This is allowed in mxid syntax, but is not aesthetically pleasing""" + provider = create_mapping_provider() + + username = "bob.bobby$@example.com" + localpart = provider.mxid_source_to_mxid_localpart(username) + self.assertEqual(localpart, "bob.bobby") + + def test_username_no_email(self): + provider = create_mapping_provider() + + username = "bob.bobby" + localpart = provider.mxid_source_to_mxid_localpart(username) + self.assertEqual(localpart, "bob.bobby") + + def test_username_starting_with_underscore(self): + provider = create_mapping_provider() + + username = "_twilight (sparkle)@somewhere.com" + localpart = provider.mxid_source_to_mxid_localpart(username) + self.assertEqual(localpart, "twilight.sparkle") + + def test_existing_user(self): + provider = create_mapping_provider() + + username = "wibble%@wobble.com" + localpart = provider.mxid_source_to_mxid_localpart(username) + + # Simulate a failure on the first attempt + localpart = provider.mxid_source_to_mxid_localpart(username, failures=1) + self.assertEqual(localpart, "wibble1") diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..262f7b3 --- /dev/null +++ b/tox.ini @@ -0,0 +1,25 @@ +[tox] +envlist = packaging, pep8 + +[testenv] +setenv = + PYTHONDONTWRITEBYTECODE = no_byte_code + PYTHONPATH = . + +[testenv:tests] +commands = + python -m unittest discover + +[testenv:packaging] +deps = + check-manifest +commands = + check-manifest + +[testenv:pep8] +skip_install = True +basepython = python3 +deps = + flake8 +commands = + flake8 saml_mapping_provider.py tests/*