From 386073c0e84ceb4f943d622ac3183f94ceb90ec8 Mon Sep 17 00:00:00 2001 From: Andrew Ferrazzutti Date: Tue, 4 Feb 2025 09:21:06 -0500 Subject: [PATCH 01/20] Merge commit '01af446be7cbd63b38f2fe35c2c9a25fac4fdef8' as 'modules/restricted-guests/synapse' --- .../restricted-guests/synapse/.dockerignore | 3 + .../restricted-guests/synapse/CHANGELOG.md | 45 ++++ modules/restricted-guests/synapse/Dockerfile | 6 + modules/restricted-guests/synapse/README.md | 93 ++++++++ modules/restricted-guests/synapse/mypy.ini | 2 + .../restricted-guests/synapse/package.json | 21 ++ .../restricted-guests/synapse/pyproject.toml | 10 + .../synapse/scripts/run_in_venv.js | 58 +++++ modules/restricted-guests/synapse/setup.cfg | 48 +++++ .../synapse/synapse_guest_module/__init__.py | 17 ++ .../synapse/synapse_guest_module/config.py | 23 ++ .../synapse_guest_module/guest_module.py | 177 +++++++++++++++ .../guest_registration_servlet.py | 93 ++++++++ .../synapse_guest_module/guest_user_reaper.py | 142 ++++++++++++ .../synapse/synapse_guest_module/py.typed | 0 .../synapse/tests/__init__.py | 134 ++++++++++++ .../synapse/tests/test_guest_module.py | 202 ++++++++++++++++++ .../tests/test_guest_registration_servlet.py | 91 ++++++++ .../synapse/tests/test_guest_user_reaper.py | 128 +++++++++++ modules/restricted-guests/synapse/tox.ini | 37 ++++ 20 files changed, 1330 insertions(+) create mode 100644 modules/restricted-guests/synapse/.dockerignore create mode 100644 modules/restricted-guests/synapse/CHANGELOG.md create mode 100644 modules/restricted-guests/synapse/Dockerfile create mode 100644 modules/restricted-guests/synapse/README.md create mode 100644 modules/restricted-guests/synapse/mypy.ini create mode 100644 modules/restricted-guests/synapse/package.json create mode 100644 modules/restricted-guests/synapse/pyproject.toml create mode 100644 modules/restricted-guests/synapse/scripts/run_in_venv.js create mode 100644 modules/restricted-guests/synapse/setup.cfg create mode 100644 modules/restricted-guests/synapse/synapse_guest_module/__init__.py create mode 100644 modules/restricted-guests/synapse/synapse_guest_module/config.py create mode 100644 modules/restricted-guests/synapse/synapse_guest_module/guest_module.py create mode 100644 modules/restricted-guests/synapse/synapse_guest_module/guest_registration_servlet.py create mode 100644 modules/restricted-guests/synapse/synapse_guest_module/guest_user_reaper.py create mode 100644 modules/restricted-guests/synapse/synapse_guest_module/py.typed create mode 100644 modules/restricted-guests/synapse/tests/__init__.py create mode 100644 modules/restricted-guests/synapse/tests/test_guest_module.py create mode 100644 modules/restricted-guests/synapse/tests/test_guest_registration_servlet.py create mode 100644 modules/restricted-guests/synapse/tests/test_guest_user_reaper.py create mode 100644 modules/restricted-guests/synapse/tox.ini diff --git a/modules/restricted-guests/synapse/.dockerignore b/modules/restricted-guests/synapse/.dockerignore new file mode 100644 index 0000000000..5b69719716 --- /dev/null +++ b/modules/restricted-guests/synapse/.dockerignore @@ -0,0 +1,3 @@ +# ignore all files except the build folder +* +!/synapse_guest_module/*.py diff --git a/modules/restricted-guests/synapse/CHANGELOG.md b/modules/restricted-guests/synapse/CHANGELOG.md new file mode 100644 index 0000000000..0bf2ec3720 --- /dev/null +++ b/modules/restricted-guests/synapse/CHANGELOG.md @@ -0,0 +1,45 @@ +# @nordeck/synapse-guest-module + +## 2.0.0 + +### Major Changes + +- 5539790: Guest users are now only allowed in Ask to Join rooms + +## 1.0.0 + +### Major Changes + +- a05ce45: First stable release. + +## 0.3.1 + +### Patch Changes + +- 344b7bf: Update the repository name + +## 0.3.0 + +### Minor Changes + +- 27680cd: Provide a dedicated registration endpoint to not interfere with the original + registration endpoint. +- 997f47b: Deactivate guest users after a configured expiration time. + +## 0.2.0 + +### Minor Changes + +- 00c92e0: Don't include guest users in the search results. + +## 0.1.0 + +### Minor Changes + +- b43b066: Disable certain homeserver-wide actions (create room, invite user) for guest users. + +## 0.0.1 + +### Patch Changes + +- Add initial version. diff --git a/modules/restricted-guests/synapse/Dockerfile b/modules/restricted-guests/synapse/Dockerfile new file mode 100644 index 0000000000..3941d9511e --- /dev/null +++ b/modules/restricted-guests/synapse/Dockerfile @@ -0,0 +1,6 @@ +FROM debian:bookworm-slim + +WORKDIR /src +ADD synapse_guest_module /src/synapse_guest_module + +CMD ["cp", "-r", "/src/synapse_guest_module", "/modules"] diff --git a/modules/restricted-guests/synapse/README.md b/modules/restricted-guests/synapse/README.md new file mode 100644 index 0000000000..3fb51aacba --- /dev/null +++ b/modules/restricted-guests/synapse/README.md @@ -0,0 +1,93 @@ +# Synapse Guest Module + +A [pluggable synapse module](https://matrix-org.github.io/synapse/latest/modules/index.html) to restrict the actions of guests. + +**Features:** + +1. Provides an endpoint that creates temporary users with a same pattern (default: `guest-[randomstring]`). +2. The temporary users have a mandatory displayname suffix (default: ` (Guest)`) that they can't remove from their profile. +3. The temporary users are limited in what they can do (examples: create room, invite users). +4. The temporary users won't be returned by the user directory search results. +5. The temporary users are disabled after an expiration timeout (default: `24 hours`). + +## Synapse configuration + +This modules requires that the homeserver has the following configuration in their `homeserver.yaml`: + +```yaml +# Required so Element is able to show the room preview where the user can login. +allow_guest_access: true +``` + +## Module installation + +Copy the `synapse_guest_module` folder into the python modules path. +This can also be achieved by the [`PYTHONPATH` environment variable](https://docs.python.org/3/using/cmdline.html#envvar-PYTHONPATH). + +Add module configuration into `modules` section of `homeserver.yaml`: + +```yaml +modules: + - module: synapse_guest_module.GuestModule + config: {} +``` + +## Module configuration + +The module provides (optional) configuration options: + +- `user_id_prefix` - the prefix of the usernames that are created by this module. Default: `guest-`. +- `display_name_suffix` - the suffix added to the display name of guest users. Default: ` (Guest)`. +- `enable_user_reaper` - if true, the module disables all users that are older than the configured expiration time. Default: `true`. +- `user_expiration_seconds` - the expiration time in seconds when a guest user expires after their creation. Default: `86400` (=24 hours). + +Example configuration: + +```yaml +modules: + - module: synapse_guest_module.GuestModule + config: + # Use a german suffix + display_name_suffix: ' (Gast)' +``` + +## Production installation + +The module is not published to a python registry, but we provide a docker container that can be used as an `initContainer` in Kubernetes: + +```diff + apiVersion: apps/v1 + kind: "StatefulSet" + metadata: + name: synapse + spec: + # ... + template: + spec: ++ # The init container copies the module to he `synapse-modules` volume ++ initContainers: ++ - image: ghcr.io/nordeck/synapse-guest-module: ++ name: install-guest-module ++ volumeMounts: ++ - mountPath: /modules ++ name: synapse-modules + containers: + - name: "synapse" + image: "matrixdotorg/synapse:v1.87.0" ++ env: ++ # Tell python to read the modules from the `/modules` directory ++ - name: PYTHONPATH ++ value: /modules ++ volumeMounts: ++ # Mount the `synapse-modules` volume ++ - mountPath: /modules ++ name: synapse-modules + # ... ++ # Use a local volume to store the module ++ volumes: ++ - emptyDir: ++ medium: Memory ++ sizeLimit: 50Mi ++ name: synapse-modules + # ... +``` diff --git a/modules/restricted-guests/synapse/mypy.ini b/modules/restricted-guests/synapse/mypy.ini new file mode 100644 index 0000000000..be0671c339 --- /dev/null +++ b/modules/restricted-guests/synapse/mypy.ini @@ -0,0 +1,2 @@ +[mypy] +strict = true diff --git a/modules/restricted-guests/synapse/package.json b/modules/restricted-guests/synapse/package.json new file mode 100644 index 0000000000..d2f45f0442 --- /dev/null +++ b/modules/restricted-guests/synapse/package.json @@ -0,0 +1,21 @@ +{ + "name": "@nordeck/synapse-guest-module", + "version": "2.0.0", + "private": true, + "description": "A synapse module to restrict the actions of guests", + "author": "Nordeck IT + Consulting GmbH", + "license": "Apache-2.0", + "scripts": { + "clean": "echo \"Nothing to clean\"", + "build": "echo \"Nothing to build\"", + "docker:build": "docker build -t nordeck/synapse-guest-module -f Dockerfile .", + "tsc": "echo \"Nothing to tsc\"", + "lint": "echo \"Nothing to lint\"", + "types:py": "node ./scripts/run_in_venv.js tox -e check_types", + "lint:py": "node ./scripts/run_in_venv.js tox -e check_codestyle", + "lint:fix": "node ./scripts/run_in_venv.js tox -e fix_codestyle", + "test": "node ./scripts/run_in_venv.js tox -e py", + "depcheck": "echo \"Nothing to check\"", + "package": "yarn docker:build" + } +} diff --git a/modules/restricted-guests/synapse/pyproject.toml b/modules/restricted-guests/synapse/pyproject.toml new file mode 100644 index 0000000000..827968917c --- /dev/null +++ b/modules/restricted-guests/synapse/pyproject.toml @@ -0,0 +1,10 @@ +[build-system] +requires = ["setuptools", "wheel"] +build-backend = "setuptools.build_meta" + +[tool.isort] +profile = "black" +known_first_party = [ + "synapse_guest_module", + "tests" +] diff --git a/modules/restricted-guests/synapse/scripts/run_in_venv.js b/modules/restricted-guests/synapse/scripts/run_in_venv.js new file mode 100644 index 0000000000..12146be693 --- /dev/null +++ b/modules/restricted-guests/synapse/scripts/run_in_venv.js @@ -0,0 +1,58 @@ +/* + * Copyright 2023 Nordeck IT + Consulting GmbH + * + * 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. + */ + +// A script to run a command in a python virtual environment that is stored in +// `/.venv`. If the virtual environment doesn't exist yet, it will +// be created. +// +// Example: $ node ./run_in_venv.js python --version + +const fs = require('fs'); +const path = require('path'); +const child_process = require('child_process'); + +const cwd = path.resolve(__dirname, '..'); +const venvPath = path.resolve(__dirname, '../../../.venv'); +const venvRelativeToCwd = path.relative(cwd, venvPath); + +function run(command) { + return new Promise((resolve) => { + const proc = child_process.spawn( + `source ${venvRelativeToCwd}/bin/activate && ${command}`, + [], + { cwd, stdio: 'inherit', shell: true }, + ); + + proc.on('close', (code) => { + console.log('command terminated:', code); + resolve(); + }); + }); +} + +async function main() { + if (!fs.existsSync(venvPath) || !fs.lstatSync(venvPath).isDirectory()) { + child_process.execSync(`python3 -m venv ${venvRelativeToCwd}`, { cwd }); + await run('pip install tox'); + await run('pip install -e ."[dev]"'); + } + + const command = process.argv.slice(2).join(' '); + + await run(command); +} + +main(); diff --git a/modules/restricted-guests/synapse/setup.cfg b/modules/restricted-guests/synapse/setup.cfg new file mode 100644 index 0000000000..a810e40931 --- /dev/null +++ b/modules/restricted-guests/synapse/setup.cfg @@ -0,0 +1,48 @@ +[metadata] +name = synapse_guest_module +description = A synapse module to restrict the actions of guests +long_description = file: README.md +long_description_content_type = text/markdown +version = 2.0.0 + +classifiers = + License :: OSI Approved :: Apache Software License + + +[options] +packages = + synapse_guest_module +python_requires = >= 3.7 +install_requires = + attrs + + +[options.package_data] +synapse_guest_module = py.typed + + +[options.extras_require] +dev = + # for tests + matrix-synapse + tox + twisted + aiounittest + # for type checking + mypy == 1.10.0 + pydantic == 2.4.2 + # for linting + black == 22.3.0 + flake8 == 4.0.1 + isort == 5.9.3 + + +[flake8] +# see https://pycodestyle.readthedocs.io/en/latest/intro.html#error-codes +# for error codes. The ones we ignore are: +# W503: line break before binary operator +# W504: line break after binary operator +# E203: whitespace before ':' (which is contrary to pep8?) +# E501: Line too long (black enforces this for us) +# (this is a subset of those ignored in Synapse) +ignore=W503,W504,E203,E501 diff --git a/modules/restricted-guests/synapse/synapse_guest_module/__init__.py b/modules/restricted-guests/synapse/synapse_guest_module/__init__.py new file mode 100644 index 0000000000..1b9ff4fa47 --- /dev/null +++ b/modules/restricted-guests/synapse/synapse_guest_module/__init__.py @@ -0,0 +1,17 @@ +# Copyright 2023 Nordeck IT + Consulting GmbH +# +# 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 synapse_guest_module.guest_module import GuestModule + +__all__ = ["GuestModule"] diff --git a/modules/restricted-guests/synapse/synapse_guest_module/config.py b/modules/restricted-guests/synapse/synapse_guest_module/config.py new file mode 100644 index 0000000000..b522f56e0f --- /dev/null +++ b/modules/restricted-guests/synapse/synapse_guest_module/config.py @@ -0,0 +1,23 @@ +# Copyright 2023 Nordeck IT + Consulting GmbH +# +# 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 attr + + +@attr.s(frozen=True, auto_attribs=True) +class GuestModuleConfig: + user_id_prefix: str + display_name_suffix: str + enable_user_reaper: bool + user_expiration_seconds: int diff --git a/modules/restricted-guests/synapse/synapse_guest_module/guest_module.py b/modules/restricted-guests/synapse/synapse_guest_module/guest_module.py new file mode 100644 index 0000000000..51af4fdc00 --- /dev/null +++ b/modules/restricted-guests/synapse/synapse_guest_module/guest_module.py @@ -0,0 +1,177 @@ +# Copyright 2023 Nordeck IT + Consulting GmbH +# +# 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 +from typing import Any, Dict, Literal, Tuple, Union + +from synapse.module_api import ( + NOT_SPAM, + ModuleApi, + ProfileInfo, + UserProfile, + errors, + run_as_background_process, +) +from synapse.module_api.errors import ConfigError +from synapse.types import UserID + +from synapse_guest_module.config import GuestModuleConfig +from synapse_guest_module.guest_registration_servlet import GuestRegistrationServlet +from synapse_guest_module.guest_user_reaper import GuestUserReaper + +logger = logging.getLogger("synapse.contrib." + __name__) + + +class GuestModule: + def __init__(self, config: GuestModuleConfig, api: ModuleApi): + self._api = api + self._config = config + + self.registration_servlet = GuestRegistrationServlet(config, api) + self._api.register_web_resource( + "/_synapse/client/register_guest", self.registration_servlet + ) + self._api.register_third_party_rules_callbacks( + on_profile_update=self.profile_update + ) + self._api.register_spam_checker_callbacks( + user_may_create_room=self.callback_user_may_create_room, + user_may_invite=self.callback_user_may_invite, + user_may_join_room=self.callback_user_may_join_room, + check_username_for_spam=self.callback_check_username_for_spam, + ) + + # Start the user reaper + self.reaper = GuestUserReaper(api, config) + if config.enable_user_reaper: + run_as_background_process( + "guest_module_reaper_bg_task", + self.reaper.run, + bg_start_span=False, + ) + + @staticmethod + def parse_config(config: Dict[str, Any]) -> GuestModuleConfig: + """Parse the module configuration""" + + user_id_prefix = config.get("user_id_prefix", "guest-") + if not isinstance(user_id_prefix, str): + raise ConfigError("Config option 'user_id_prefix' must be a string") + + display_name_suffix = config.get("display_name_suffix", " (Guest)") + if not isinstance(display_name_suffix, str): + raise ConfigError("Config option 'display_name_suffix' must be a string") + + enable_user_reaper = config.get("enable_user_reaper", True) + if not isinstance(enable_user_reaper, bool): + raise ConfigError("Config option 'enable_user_reaper' must be a bool") + + user_expiration_seconds = config.get( + "user_expiration_seconds", + 24 * 60 * 60, + ) + if not isinstance(user_expiration_seconds, int): + raise ConfigError( + "Config option 'user_expiration_seconds' must be a number" + ) + + return GuestModuleConfig( + user_id_prefix, + display_name_suffix, + enable_user_reaper, + user_expiration_seconds, + ) + + async def profile_update( + self, + user_id: str, + new_profile: ProfileInfo, + by_admin: bool, + deactivation: bool, + ) -> None: + """Is called whenever a profile is updated. We check that a guest user + always contains the configured suffix (default ` (Guest)`) and add it if + it is missing. + """ + user_is_guest = user_id.startswith("@" + self._config.user_id_prefix) + if user_is_guest: + new_profile_display_name = ( + "" if new_profile.display_name is None else new_profile.display_name + ) + guest_display_name_not_valid = not new_profile_display_name.endswith( + self._config.display_name_suffix + ) + if guest_display_name_not_valid: + user_id_1 = UserID.from_string(user_id) + guest_display_name = ( + new_profile_display_name.strip() + self._config.display_name_suffix + ) + await self._api.set_displayname(user_id_1, guest_display_name) + + async def callback_user_may_create_room( + self, + user_id: str, + ) -> bool: + """Returns whether this user is allowed to create a room. Guest users + should not be able to do that. + """ + user_is_guest = user_id.startswith("@" + self._config.user_id_prefix) + return not user_is_guest + + async def callback_user_may_invite( + self, + inviter: str, + invitee: str, + room_id: str, + ) -> bool: + """Returns whether this user is allowed to invite someone into a room. + Guest users should not be able to to that. + """ + user_is_guest = inviter.startswith("@" + self._config.user_id_prefix) + return not user_is_guest + + async def callback_user_may_join_room( + self, user_id: str, room_id: str, is_invited: bool + ) -> Union[ + Literal["NOT_SPAM"], errors.Codes, Tuple[errors.Codes, Dict[str, Any]], bool + ]: + """Returns whether this user is allowed to join a room. Guest users + should only be able to do that if the room is Ask to Join (knock). + """ + user_is_guest = user_id.startswith("@" + self._config.user_id_prefix) + if not user_is_guest or is_invited: + return NOT_SPAM + + join_rules_events = await self._api.get_state_events_in_room( + room_id, [("m.room.join_rules", None)] + ) + if join_rules_events is None or len(list(join_rules_events)) == 0: + return errors.Codes.BAD_STATE + + for event in join_rules_events: + join_rule = event.get("content", {}) + is_knock = join_rule.get("join_rule").startswith("knock") + if user_is_guest and is_knock: + return NOT_SPAM + + return errors.Codes.FORBIDDEN + + async def callback_check_username_for_spam(self, user_profile: UserProfile) -> bool: + """Returns whether this user should appear in the user directory. Since + we prefer to not invite guests into normal rooms, we hide them here. + """ + user_is_guest = user_profile["user_id"].startswith( + "@" + self._config.user_id_prefix + ) + return user_is_guest diff --git a/modules/restricted-guests/synapse/synapse_guest_module/guest_registration_servlet.py b/modules/restricted-guests/synapse/synapse_guest_module/guest_registration_servlet.py new file mode 100644 index 0000000000..d3ec94c4ab --- /dev/null +++ b/modules/restricted-guests/synapse/synapse_guest_module/guest_registration_servlet.py @@ -0,0 +1,93 @@ +# Copyright 2023 Nordeck IT + Consulting GmbH +# +# 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 secrets +import string +from typing import Any, Dict, Tuple + +from synapse.module_api import ( + DirectServeJsonResource, + ModuleApi, + parse_json_object_from_request, +) +from twisted.web.server import Request + +from synapse_guest_module.config import GuestModuleConfig + +logger = logging.getLogger("synapse.contrib." + __name__) + + +class GuestRegistrationServlet(DirectServeJsonResource): + """The `POST /_synapse/client/register_guest` endpoints provides an endpoint + to register a new guest user. It requires the `displayname` property and + returns an object that matches the `AccountAuthInfo` of the + `@matrix-org/react-sdk-module-api`. + """ + + def __init__( + self, + config: GuestModuleConfig, + api: ModuleApi, + ): + super().__init__() + self._api = api + self._config = config + + async def _async_render_POST(self, request: Request) -> Tuple[int, Dict[str, Any]]: + """On POST requests, generate a new username for a guest, check that it + doesn't exist yet, append the suffix to the displayname, create the user, + create a device, and return the session data to the caller. + """ + + json_dict = parse_json_object_from_request(request) + + displayname = json_dict.get("displayname") + if not isinstance(displayname, str) or len(displayname.strip()) == 0: + return 400, {"msg": "You must provide a 'displayname' as a string"} + + # make sure the regex is unique + for _ in range(10): + random_string = "".join( + secrets.choice(string.ascii_lowercase + string.digits) + for _ in range(32) + ) + + localpart = self._config.user_id_prefix + random_string + + # make sure the user-id does not exist yet + if await self._api.check_user_exists( + self._api.get_qualified_user_id(localpart) + ): + continue + + logger.info("Register guest with user %s", localpart) + user_id = await self._api.register_user( + localpart, displayname.strip() + self._config.display_name_suffix + ) + + device_id, access_token, _, _ = await self._api.register_device(user_id) + + logger.debug("Registered user %s", user_id) + + res = { + "userId": user_id, + "deviceId": device_id, + "accessToken": access_token, + "homeserverUrl": self._api.public_baseurl, + } + + return 201, res + + return 500, {"msg": "Internal error: Could not find a free username"} diff --git a/modules/restricted-guests/synapse/synapse_guest_module/guest_user_reaper.py b/modules/restricted-guests/synapse/synapse_guest_module/guest_user_reaper.py new file mode 100644 index 0000000000..9fd6c59877 --- /dev/null +++ b/modules/restricted-guests/synapse/synapse_guest_module/guest_user_reaper.py @@ -0,0 +1,142 @@ +# Copyright 2023 Nordeck IT + Consulting GmbH +# +# 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 time +from typing import List + +from synapse.module_api import DatabasePool, LoggingTransaction, ModuleApi + +from synapse_guest_module.config import GuestModuleConfig + +logger = logging.getLogger("synapse.contrib." + __name__) + + +class GuestUserReaper: + def __init__(self, api: ModuleApi, config: GuestModuleConfig): + self._api = api + self._config = config + self.reaper_user = f"{config.user_id_prefix}reaper" + + async def run(self) -> None: + logger.info("User cleanup job started") + + await self._api.sleep(5.0) # Wait for Synapse to start properly + + while True: + logger.debug("Run deactivation loop") + + try: + await self.deactivate_expired_guest_users() + except Exception as e: + logger.error("Error in the user deactivation: %s", e) + + await self._api.sleep(60.0) + + async def deactivate_expired_guest_users(self) -> None: + """Deactivate all users that are older than the specified expiration + interval. This uses the admin API to disable the user. + """ + + def get_expired_users(txn: LoggingTransaction) -> List[str]: + sql = """ + SELECT name + FROM users + WHERE name != ? + AND name LIKE ? + AND deactivated = 0 + AND creation_ts < ?; + """ + + # date operations are database-specific (postgres, sqlite, ...) + expire_ts_seconds = int(time.time() - self._config.user_expiration_seconds) + txn.execute( + sql, + ( + self._api.get_qualified_user_id(self.reaper_user), + f"@{self._config.user_id_prefix}%:{self._api.server_name}", + expire_ts_seconds, + ), + ) + expired_users_rows = txn.fetchall() + + return [row[0] for row in expired_users_rows] + + expired_users: List[str] = await self._api.run_db_interaction( + "guest_module_get_expired_users", + get_expired_users, + ) + + if len(expired_users) > 0: + logger.info("Deactivate %d users", len(expired_users)) + + token = await self.get_admin_token() + + for user_id in expired_users: + logger.debug("Deactivate user %s", user_id) + + url = f"http://localhost:8008/_synapse/admin/v1/deactivate/{user_id}" + + try: + await self._api.http_client.post_json_get_json( + uri=url, + post_json={}, + headers={"Authorization": ["Bearer {}".format(token)]}, + ) + except Exception as e: + logger.error('Failed to delete user "%s": %s', user_id, e) + + async def get_admin_token(self) -> str: + """Create a new admin user in synapse so the module can call the admin + api. If no user or login session exists, we create new ones. + """ + + def get_access_token_txn(txn: LoggingTransaction) -> str | None: + tokens = DatabasePool.simple_select_onecol_txn( + txn, + table="access_tokens", + keyvalues={ + "user_id": self._api.get_qualified_user_id(self.reaper_user), + }, + retcol="token", + ) + + if len(tokens) > 0 and isinstance(tokens[0], str): + return tokens[0] + else: + return None + + token: str | None = await self._api.run_db_interaction( + "guest_module_get_access_token", + get_access_token_txn, + ) + + if token is not None: + return token + + if not await self._api.check_user_exists(self.reaper_user): + logger.info( + 'Register new administrator user "%s"', + self.reaper_user, + ) + + await self._api.register_user(self.reaper_user, admin=True) + + logger.info('Register new device for administrator user "%s"', self.reaper_user) + + _, access_token, _, _ = await self._api.register_device( + self._api.get_qualified_user_id(self.reaper_user) + ) + + return access_token diff --git a/modules/restricted-guests/synapse/synapse_guest_module/py.typed b/modules/restricted-guests/synapse/synapse_guest_module/py.typed new file mode 100644 index 0000000000..e69de29bb2 diff --git a/modules/restricted-guests/synapse/tests/__init__.py b/modules/restricted-guests/synapse/tests/__init__.py new file mode 100644 index 0000000000..b642bd56ef --- /dev/null +++ b/modules/restricted-guests/synapse/tests/__init__.py @@ -0,0 +1,134 @@ +# Copyright 2023 Nordeck IT + Consulting GmbH +# +# 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 sqlite3 +from asyncio import Future +from typing import Any, Awaitable, Callable, Tuple, TypeVar +from unittest.mock import Mock + +from synapse.http.client import SimpleHttpClient +from synapse.module_api import ModuleApi + +from synapse_guest_module import GuestModule + +RV = TypeVar("RV") +TV = TypeVar("TV") + + +class SQLiteStore: + """In-memory SQLite store. We can't just use a run_db_interaction function that opens + its own connection, since we need to use the same connection for all queries in a + test. + """ + + def __init__(self) -> None: + self.conn = sqlite3.connect(":memory:") + + async def run_db_interaction( + self, desc: str, f: Callable[..., RV], *args: Any, **kwargs: Any + ) -> RV: + cur = CursorWrapper(self.conn.cursor()) + try: + res = f(cur, *args, **kwargs) + self.conn.commit() + return res + except Exception: + self.conn.rollback() + raise + + +class CursorWrapper: + """Wrapper around a SQLite cursor.""" + + def __init__(self, cursor: sqlite3.Cursor) -> None: + self.cur = cursor + + def execute(self, sql: str, args: Any) -> None: + self.cur.execute(sql, args) + + @property + def rowcount(self) -> Any: + return self.cur.rowcount + + def fetchone(self) -> Any: + return self.cur.fetchone() + + def fetchall(self) -> Any: + return self.cur.fetchall() + + def __iter__(self) -> Any: + return self.cur.__iter__() + + def __next__(self) -> Any: + return self.cur.__next__() + + +def make_awaitable(result: TV) -> Awaitable[TV]: + """ + Makes an awaitable, suitable for mocking an `async` function. + This uses Futures as they can be awaited multiple times so can be returned + to multiple callers. + This function has been copied directly from Synapse's tests code. + """ + future = Future() # type: ignore + future.set_result(result) + return future + + +def get_qualified_user_id(username: str) -> str: + return f"@{username}:matrix.local" + + +async def register_user(localpart: str, admin: bool = False) -> str: + return f"@{localpart}:matrix.local" + + +def create_module() -> Tuple[GuestModule, Mock, SQLiteStore]: + store = SQLiteStore() + _setup_db(store.conn) + + client = Mock(spec=SimpleHttpClient) + client.post_json_get_json.return_value = make_awaitable(None) + + # Create a mock based on the ModuleApi spec, but override some mocked functions + # because some capabilities are needed for running the tests. + module_api = Mock(spec=ModuleApi) + module_api.http_client = client + module_api.server_name = "matrix.local" + module_api.public_baseurl = "https://matrix.local:1234/" + module_api.run_db_interaction.side_effect = store.run_db_interaction + module_api.get_qualified_user_id.side_effect = get_qualified_user_id + module_api.check_user_exists.return_value = make_awaitable(False) + module_api.register_user.side_effect = register_user + module_api.register_device.return_value = make_awaitable( + ("DEVICEID", "syn_registered_token", None, None) + ) + + # If necessary, give parse_config some configuration to parse. + config = GuestModule.parse_config( + { + "enable_user_reaper": False, + } + ) + + module = GuestModule(config, module_api) + + return module, module_api, store + + +def _setup_db(conn: sqlite3.Connection) -> None: + conn.execute("CREATE TABLE access_tokens(user_id text, token text)") + conn.execute( + "CREATE TABLE users(name text, deactivated smallint, creation_ts bigint)" + ) diff --git a/modules/restricted-guests/synapse/tests/test_guest_module.py b/modules/restricted-guests/synapse/tests/test_guest_module.py new file mode 100644 index 0000000000..fefc669641 --- /dev/null +++ b/modules/restricted-guests/synapse/tests/test_guest_module.py @@ -0,0 +1,202 @@ +# Copyright 2023 Nordeck IT + Consulting GmbH +# +# 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 aiounittest +from synapse.module_api import ProfileInfo, UserProfile +from synapse.module_api.errors import ConfigError +from synapse.types import UserID + +from synapse_guest_module.config import GuestModuleConfig +from synapse_guest_module.guest_module import GuestModule +from tests import create_module + + +class GuestModuleTest(aiounittest.AsyncTestCase): + async def test_parse_config_empty(self) -> None: + config = GuestModule.parse_config({}) + + self.assertEqual( + config, + GuestModuleConfig( + user_id_prefix="guest-", + display_name_suffix=" (Guest)", + enable_user_reaper=True, + user_expiration_seconds=24 * 60 * 60, + ), + ) + + async def test_parse_config_custom(self) -> None: + config = GuestModule.parse_config( + { + "user_id_prefix": "tmp-", + "display_name_suffix": " (Temporary)", + "enable_user_reaper": False, + "user_expiration_seconds": 100, + } + ) + + self.assertEqual( + config, + GuestModuleConfig( + user_id_prefix="tmp-", + display_name_suffix=" (Temporary)", + enable_user_reaper=False, + user_expiration_seconds=100, + ), + ) + + async def test_parse_config_fail_user_id_prefix(self) -> None: + with self.assertRaisesRegex( + ConfigError, "Config option 'user_id_prefix' must be a string" + ): + GuestModule.parse_config( + { + "user_id_prefix": 1234, + } + ) + + async def test_parse_config_fail_display_name_suffix(self) -> None: + with self.assertRaisesRegex( + ConfigError, "Config option 'display_name_suffix' must be a string" + ): + GuestModule.parse_config( + { + "display_name_suffix": 1234, + } + ) + + async def test_parse_config_fail_enable_user_reaper(self) -> None: + with self.assertRaisesRegex( + ConfigError, "Config option 'enable_user_reaper' must be a bool" + ): + GuestModule.parse_config( + { + "enable_user_reaper": "False", + } + ) + + async def test_parse_config_fail_user_expiration_seconds(self) -> None: + with self.assertRaisesRegex( + ConfigError, "Config option 'user_expiration_seconds' must be a number" + ): + GuestModule.parse_config( + { + "user_expiration_seconds": "1", + } + ) + + async def test_profile_update_no_guest(self) -> None: + module, module_api, _ = create_module() + + await module.profile_update( + "@my-user:matrix.local", + ProfileInfo(display_name="My User", avatar_url=None), + True, + False, + ) + + module_api.set_displayname.assert_not_called() + + async def test_profile_update_guest_keep(self) -> None: + module, module_api, _ = create_module() + + await module.profile_update( + "@guest-asdf:matrix.local", + ProfileInfo(display_name="My User (Guest)", avatar_url=None), + True, + False, + ) + + module_api.set_displayname.assert_not_called() + + async def test_profile_update_guest_add_and_trim(self) -> None: + module, module_api, _ = create_module() + + await module.profile_update( + "@guest-asdf:matrix.local", + ProfileInfo(display_name="My User ", avatar_url=None), + True, + False, + ) + + module_api.set_displayname.assert_awaited_once_with( + UserID.from_string("@guest-asdf:matrix.local"), + "My User (Guest)", + ) + + async def test_callback_user_may_create_room_no_guest(self) -> None: + module, _, _ = create_module() + + allow = await module.callback_user_may_create_room( + "@my-user:matrix.local", + ) + + self.assertTrue(allow) + + async def test_callback_user_may_create_room_guest(self) -> None: + module, _, _ = create_module() + + allow = await module.callback_user_may_create_room( + "@guest-asdf:matrix.local", + ) + + self.assertFalse(allow) + + async def test_callback_user_may_invite_no_guest(self) -> None: + module, _, _ = create_module() + + allow = await module.callback_user_may_invite( + "@my-user:matrix.local", + "@inviter:matrix.local", + "!room:matrix.local", + ) + + self.assertTrue(allow) + + async def test_callback_user_may_invite_guest(self) -> None: + module, _, _ = create_module() + + allow = await module.callback_user_may_invite( + "@guest-asdf:matrix.local", + "@inviter:matrix.local", + "!room:matrix.local", + ) + + self.assertFalse(allow) + + async def test_callback_check_username_for_spam_no_guest(self) -> None: + module, _, _ = create_module() + + allow = await module.callback_check_username_for_spam( + UserProfile( + user_id="@my-user:matrix.local", + display_name=None, + avatar_url=None, + ), + ) + + self.assertFalse(allow) + + async def test_callback_check_username_for_spam_guest(self) -> None: + module, _, _ = create_module() + + allow = await module.callback_check_username_for_spam( + UserProfile( + user_id="@guest-asdf:matrix.local", + display_name=None, + avatar_url=None, + ), + ) + + self.assertTrue(allow) diff --git a/modules/restricted-guests/synapse/tests/test_guest_registration_servlet.py b/modules/restricted-guests/synapse/tests/test_guest_registration_servlet.py new file mode 100644 index 0000000000..ccbfdad569 --- /dev/null +++ b/modules/restricted-guests/synapse/tests/test_guest_registration_servlet.py @@ -0,0 +1,91 @@ +# Copyright 2023 Nordeck IT + Consulting GmbH +# +# 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 io +from typing import cast +from unittest.mock import ANY + +import aiounittest +from twisted.web.server import Request +from twisted.web.test.requesthelper import DummyRequest + +from tests import create_module, make_awaitable + + +class GuestUserReaperTest(aiounittest.AsyncTestCase): + async def test_async_render_POST_missing_displayname(self) -> None: + module, _, _ = create_module() + + request = cast(Request, DummyRequest([])) + request.content = io.BytesIO(b"{}") + + status, response = await module.registration_servlet._async_render_POST(request) + + self.assertEqual(status, 400) + self.assertEqual( + response, {"msg": "You must provide a 'displayname' as a string"} + ) + + async def test_async_render_POST_empty_displayname(self) -> None: + module, _, _ = create_module() + + request = cast(Request, DummyRequest([])) + request.content = io.BytesIO(b'{"displayname":" "}') + + status, response = await module.registration_servlet._async_render_POST(request) + + self.assertEqual(status, 400) + self.assertEqual( + response, {"msg": "You must provide a 'displayname' as a string"} + ) + + async def test_async_render_POST_no_free_username(self) -> None: + module, module_api, _ = create_module() + + request = cast(Request, DummyRequest([])) + request.content = io.BytesIO(b'{"displayname":"My Name"}') + + module_api.check_user_exists.return_value = make_awaitable(True) + + status, response = await module.registration_servlet._async_render_POST(request) + + self.assertEqual(status, 500) + self.assertEqual( + response, {"msg": "Internal error: Could not find a free username"} + ) + + self.assertEqual(module_api.check_user_exists.call_count, 10) + + async def test_async_render_POST_success(self) -> None: + module, module_api, _ = create_module() + + request = cast(Request, DummyRequest([])) + request.content = io.BytesIO(b'{"displayname":"My Name "}') + + status, response = await module.registration_servlet._async_render_POST(request) + + self.assertEqual(status, 201) + + self.assertRegex(response.pop("userId"), r"^@guest-[A-Za-z0-9]+:matrix.local$") + self.assertDictEqual( + response, + { + "accessToken": "syn_registered_token", + "deviceId": "DEVICEID", + "homeserverUrl": "https://matrix.local:1234/", + # "userId" was already checked by self.assertRegex and was removed from the object + }, + ) + + module_api.register_user.assert_called_with(ANY, "My Name (Guest)") diff --git a/modules/restricted-guests/synapse/tests/test_guest_user_reaper.py b/modules/restricted-guests/synapse/tests/test_guest_user_reaper.py new file mode 100644 index 0000000000..e85a55c980 --- /dev/null +++ b/modules/restricted-guests/synapse/tests/test_guest_user_reaper.py @@ -0,0 +1,128 @@ +# Copyright 2023 Nordeck IT + Consulting GmbH +# +# 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 time +from unittest.mock import call + +import aiounittest + +from tests import create_module, make_awaitable + + +class GuestUserReaperTest(aiounittest.AsyncTestCase): + async def test_get_admin_token_register(self) -> None: + module, module_api, _ = create_module() + + token = await module.reaper.get_admin_token() + + module_api.check_user_exists.assert_called_with("guest-reaper") + module_api.register_user.assert_called_with("guest-reaper", admin=True) + module_api.register_device.assert_called_with("@guest-reaper:matrix.local") + + self.assertEqual(token, "syn_registered_token") + + async def test_get_admin_token_create_device(self) -> None: + module, module_api, _ = create_module() + + module_api.check_user_exists.return_value = make_awaitable(True) + + token = await module.reaper.get_admin_token() + + module_api.check_user_exists.assert_called_with("guest-reaper") + module_api.register_user.assert_not_called() + module_api.register_device.assert_called_with("@guest-reaper:matrix.local") + + self.assertEqual(token, "syn_registered_token") + + async def test_get_admin_token_read_from_db(self) -> None: + module, module_api, store = create_module() + + store.conn.execute( + "INSERT INTO access_tokens VALUES ('@guest-reaper:matrix.local', 'syn_db_token')" + ) + + module_api.check_user_exists.return_value = make_awaitable(True) + + token = await module.reaper.get_admin_token() + + module_api.check_user_exists.assert_not_called() + module_api.register_user.assert_not_called() + module_api.register_device.assert_not_called() + + self.assertEqual(token, "syn_db_token") + + async def test_deactivate_expired_guest_users_success(self) -> None: + module, module_api, store = create_module() + + now = int(time.time()) + store.conn.executemany( + "INSERT INTO users VALUES (?, ?, ?)", + [ + ["@user-1:matrix.local", 0, 0], + ["@guest-reaper:matrix.local", 0, 0], + ["@guest-active:matrix.local", 0, now], + ["@guest-deactivated:matrix.local", 1, 0], + ["@guest-old-1:matrix.local", 0, 0], + ["@guest-old-2:matrix.local", 0, 0], + ], + ) + + await module.reaper.deactivate_expired_guest_users() + + self.assertEqual(module_api.http_client.post_json_get_json.await_count, 2) + + module_api.http_client.post_json_get_json.assert_has_awaits( + [ + call( + uri="http://localhost:8008/_synapse/admin/v1/deactivate/@guest-old-1:matrix.local", + post_json={}, + headers={"Authorization": ["Bearer syn_registered_token"]}, + ), + call( + uri="http://localhost:8008/_synapse/admin/v1/deactivate/@guest-old-2:matrix.local", + post_json={}, + headers={"Authorization": ["Bearer syn_registered_token"]}, + ), + ] + ) + + async def test_deactivate_expired_guest_users_with_failure(self) -> None: + module, module_api, store = create_module() + + store.conn.executemany( + "INSERT INTO users VALUES (?, ?, ?)", + [ + ["@guest-old-1:matrix.local", 0, 0], + ["@guest-old-2:matrix.local", 0, 0], + ], + ) + + module_api.http_client.post_json_get_json.side_effect = Exception("") + + await module.reaper.deactivate_expired_guest_users() + + module_api.http_client.post_json_get_json.assert_has_awaits( + [ + call( + uri="http://localhost:8008/_synapse/admin/v1/deactivate/@guest-old-1:matrix.local", + post_json={}, + headers={"Authorization": ["Bearer syn_registered_token"]}, + ), + call( + uri="http://localhost:8008/_synapse/admin/v1/deactivate/@guest-old-2:matrix.local", + post_json={}, + headers={"Authorization": ["Bearer syn_registered_token"]}, + ), + ] + ) diff --git a/modules/restricted-guests/synapse/tox.ini b/modules/restricted-guests/synapse/tox.ini new file mode 100644 index 0000000000..1410d2ee59 --- /dev/null +++ b/modules/restricted-guests/synapse/tox.ini @@ -0,0 +1,37 @@ +[tox] +envlist = py, check_codestyle, check_types + +# required for PEP 517 (pyproject.toml-style) builds +isolated_build = true + +[testenv:py] + +extras = dev + +commands = + python -m twisted.trial tests + +[testenv:check_codestyle] + +extras = dev + +commands = + flake8 synapse_guest_module tests + black --check --diff synapse_guest_module tests + isort --check-only --diff synapse_guest_module tests + +[testenv:fix_codestyle] + +extras = dev + +commands = + black synapse_guest_module tests + isort synapse_guest_module tests + + +[testenv:check_types] + +extras = dev + +commands = + mypy synapse_guest_module tests From ffb5fdaa3002448cb2a3d5492bb5b115dc2dd582 Mon Sep 17 00:00:00 2001 From: Andrew Ferrazzutti Date: Tue, 4 Feb 2025 13:43:51 -0500 Subject: [PATCH 02/20] synapse guest module: update copyright --- modules/restricted-guests/synapse/scripts/run_in_venv.js | 1 + .../restricted-guests/synapse/synapse_guest_module/__init__.py | 1 + modules/restricted-guests/synapse/synapse_guest_module/config.py | 1 + .../synapse/synapse_guest_module/guest_module.py | 1 + .../synapse/synapse_guest_module/guest_registration_servlet.py | 1 + .../synapse/synapse_guest_module/guest_user_reaper.py | 1 + modules/restricted-guests/synapse/tests/__init__.py | 1 + modules/restricted-guests/synapse/tests/test_guest_module.py | 1 + .../synapse/tests/test_guest_registration_servlet.py | 1 + .../restricted-guests/synapse/tests/test_guest_user_reaper.py | 1 + 10 files changed, 10 insertions(+) diff --git a/modules/restricted-guests/synapse/scripts/run_in_venv.js b/modules/restricted-guests/synapse/scripts/run_in_venv.js index 12146be693..ee392ecbee 100644 --- a/modules/restricted-guests/synapse/scripts/run_in_venv.js +++ b/modules/restricted-guests/synapse/scripts/run_in_venv.js @@ -1,5 +1,6 @@ /* * Copyright 2023 Nordeck IT + Consulting GmbH + * Copyright 2025 New Vector Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/modules/restricted-guests/synapse/synapse_guest_module/__init__.py b/modules/restricted-guests/synapse/synapse_guest_module/__init__.py index 1b9ff4fa47..fc47effa9f 100644 --- a/modules/restricted-guests/synapse/synapse_guest_module/__init__.py +++ b/modules/restricted-guests/synapse/synapse_guest_module/__init__.py @@ -1,4 +1,5 @@ # Copyright 2023 Nordeck IT + Consulting GmbH +# Copyright 2025 New Vector Ltd. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/modules/restricted-guests/synapse/synapse_guest_module/config.py b/modules/restricted-guests/synapse/synapse_guest_module/config.py index b522f56e0f..2ef607a491 100644 --- a/modules/restricted-guests/synapse/synapse_guest_module/config.py +++ b/modules/restricted-guests/synapse/synapse_guest_module/config.py @@ -1,4 +1,5 @@ # Copyright 2023 Nordeck IT + Consulting GmbH +# Copyright 2025 New Vector Ltd. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/modules/restricted-guests/synapse/synapse_guest_module/guest_module.py b/modules/restricted-guests/synapse/synapse_guest_module/guest_module.py index 51af4fdc00..89fb3f87de 100644 --- a/modules/restricted-guests/synapse/synapse_guest_module/guest_module.py +++ b/modules/restricted-guests/synapse/synapse_guest_module/guest_module.py @@ -1,4 +1,5 @@ # Copyright 2023 Nordeck IT + Consulting GmbH +# Copyright 2025 New Vector Ltd. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/modules/restricted-guests/synapse/synapse_guest_module/guest_registration_servlet.py b/modules/restricted-guests/synapse/synapse_guest_module/guest_registration_servlet.py index d3ec94c4ab..7f9849d781 100644 --- a/modules/restricted-guests/synapse/synapse_guest_module/guest_registration_servlet.py +++ b/modules/restricted-guests/synapse/synapse_guest_module/guest_registration_servlet.py @@ -1,4 +1,5 @@ # Copyright 2023 Nordeck IT + Consulting GmbH +# Copyright 2025 New Vector Ltd. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/modules/restricted-guests/synapse/synapse_guest_module/guest_user_reaper.py b/modules/restricted-guests/synapse/synapse_guest_module/guest_user_reaper.py index 9fd6c59877..c2492be9bb 100644 --- a/modules/restricted-guests/synapse/synapse_guest_module/guest_user_reaper.py +++ b/modules/restricted-guests/synapse/synapse_guest_module/guest_user_reaper.py @@ -1,4 +1,5 @@ # Copyright 2023 Nordeck IT + Consulting GmbH +# Copyright 2025 New Vector Ltd. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/modules/restricted-guests/synapse/tests/__init__.py b/modules/restricted-guests/synapse/tests/__init__.py index b642bd56ef..49012b4ca7 100644 --- a/modules/restricted-guests/synapse/tests/__init__.py +++ b/modules/restricted-guests/synapse/tests/__init__.py @@ -1,4 +1,5 @@ # Copyright 2023 Nordeck IT + Consulting GmbH +# Copyright 2025 New Vector Ltd. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/modules/restricted-guests/synapse/tests/test_guest_module.py b/modules/restricted-guests/synapse/tests/test_guest_module.py index fefc669641..c5d7164edf 100644 --- a/modules/restricted-guests/synapse/tests/test_guest_module.py +++ b/modules/restricted-guests/synapse/tests/test_guest_module.py @@ -1,4 +1,5 @@ # Copyright 2023 Nordeck IT + Consulting GmbH +# Copyright 2025 New Vector Ltd. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/modules/restricted-guests/synapse/tests/test_guest_registration_servlet.py b/modules/restricted-guests/synapse/tests/test_guest_registration_servlet.py index ccbfdad569..e8700d2f03 100644 --- a/modules/restricted-guests/synapse/tests/test_guest_registration_servlet.py +++ b/modules/restricted-guests/synapse/tests/test_guest_registration_servlet.py @@ -1,4 +1,5 @@ # Copyright 2023 Nordeck IT + Consulting GmbH +# Copyright 2025 New Vector Ltd. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/modules/restricted-guests/synapse/tests/test_guest_user_reaper.py b/modules/restricted-guests/synapse/tests/test_guest_user_reaper.py index e85a55c980..191312f380 100644 --- a/modules/restricted-guests/synapse/tests/test_guest_user_reaper.py +++ b/modules/restricted-guests/synapse/tests/test_guest_user_reaper.py @@ -1,4 +1,5 @@ # Copyright 2023 Nordeck IT + Consulting GmbH +# Copyright 2025 New Vector Ltd. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. From caabc37519151a98aa9284956baa511af9d4f22f Mon Sep 17 00:00:00 2001 From: Andrew Ferrazzutti Date: Tue, 4 Feb 2025 14:02:11 -0500 Subject: [PATCH 03/20] synapse guest module: update org name & docs --- .../restricted-guests/synapse/CHANGELOG.md | 42 +------------------ modules/restricted-guests/synapse/README.md | 2 +- .../restricted-guests/synapse/package.json | 6 +-- 3 files changed, 6 insertions(+), 44 deletions(-) diff --git a/modules/restricted-guests/synapse/CHANGELOG.md b/modules/restricted-guests/synapse/CHANGELOG.md index 0bf2ec3720..2d5904137d 100644 --- a/modules/restricted-guests/synapse/CHANGELOG.md +++ b/modules/restricted-guests/synapse/CHANGELOG.md @@ -1,45 +1,7 @@ -# @nordeck/synapse-guest-module - -## 2.0.0 - -### Major Changes - -- 5539790: Guest users are now only allowed in Ask to Join rooms +# @element-hq/synapse-guest-module ## 1.0.0 ### Major Changes -- a05ce45: First stable release. - -## 0.3.1 - -### Patch Changes - -- 344b7bf: Update the repository name - -## 0.3.0 - -### Minor Changes - -- 27680cd: Provide a dedicated registration endpoint to not interfere with the original - registration endpoint. -- 997f47b: Deactivate guest users after a configured expiration time. - -## 0.2.0 - -### Minor Changes - -- 00c92e0: Don't include guest users in the search results. - -## 0.1.0 - -### Minor Changes - -- b43b066: Disable certain homeserver-wide actions (create room, invite user) for guest users. - -## 0.0.1 - -### Patch Changes - -- Add initial version. +- Fork from [Nordeck's version](https://github.com/nordeck/element-web-modules/tree/main/packages/synapse-guest-module). diff --git a/modules/restricted-guests/synapse/README.md b/modules/restricted-guests/synapse/README.md index 3fb51aacba..52e14ae710 100644 --- a/modules/restricted-guests/synapse/README.md +++ b/modules/restricted-guests/synapse/README.md @@ -1,6 +1,6 @@ # Synapse Guest Module -A [pluggable synapse module](https://matrix-org.github.io/synapse/latest/modules/index.html) to restrict the actions of guests. +A [pluggable synapse module](https://element-hq.github.io/synapse/latest/modules/index.html) to restrict the actions of guests. **Features:** diff --git a/modules/restricted-guests/synapse/package.json b/modules/restricted-guests/synapse/package.json index d2f45f0442..468b3f4254 100644 --- a/modules/restricted-guests/synapse/package.json +++ b/modules/restricted-guests/synapse/package.json @@ -1,14 +1,14 @@ { - "name": "@nordeck/synapse-guest-module", + "name": "@element-hq/synapse-guest-module", "version": "2.0.0", "private": true, "description": "A synapse module to restrict the actions of guests", - "author": "Nordeck IT + Consulting GmbH", + "author": "New Vector Ltd.", "license": "Apache-2.0", "scripts": { "clean": "echo \"Nothing to clean\"", "build": "echo \"Nothing to build\"", - "docker:build": "docker build -t nordeck/synapse-guest-module -f Dockerfile .", + "docker:build": "docker build -t element-hq/synapse-guest-module -f Dockerfile .", "tsc": "echo \"Nothing to tsc\"", "lint": "echo \"Nothing to lint\"", "types:py": "node ./scripts/run_in_venv.js tox -e check_types", From b36705c4f4155d4eb5320b60573aa28d36a4e64a Mon Sep 17 00:00:00 2001 From: Andrew Ferrazzutti Date: Wed, 5 Feb 2025 09:43:21 -0500 Subject: [PATCH 04/20] Run lint-staged on all new files --- modules/restricted-guests/synapse/README.md | 12 ++--- .../restricted-guests/synapse/package.json | 38 ++++++++-------- .../synapse/scripts/run_in_venv.js | 44 +++++++++---------- 3 files changed, 47 insertions(+), 47 deletions(-) diff --git a/modules/restricted-guests/synapse/README.md b/modules/restricted-guests/synapse/README.md index 52e14ae710..621a648707 100644 --- a/modules/restricted-guests/synapse/README.md +++ b/modules/restricted-guests/synapse/README.md @@ -28,8 +28,8 @@ Add module configuration into `modules` section of `homeserver.yaml`: ```yaml modules: - - module: synapse_guest_module.GuestModule - config: {} + - module: synapse_guest_module.GuestModule + config: {} ``` ## Module configuration @@ -45,10 +45,10 @@ Example configuration: ```yaml modules: - - module: synapse_guest_module.GuestModule - config: - # Use a german suffix - display_name_suffix: ' (Gast)' + - module: synapse_guest_module.GuestModule + config: + # Use a german suffix + display_name_suffix: " (Gast)" ``` ## Production installation diff --git a/modules/restricted-guests/synapse/package.json b/modules/restricted-guests/synapse/package.json index 468b3f4254..7f1ef45b65 100644 --- a/modules/restricted-guests/synapse/package.json +++ b/modules/restricted-guests/synapse/package.json @@ -1,21 +1,21 @@ { - "name": "@element-hq/synapse-guest-module", - "version": "2.0.0", - "private": true, - "description": "A synapse module to restrict the actions of guests", - "author": "New Vector Ltd.", - "license": "Apache-2.0", - "scripts": { - "clean": "echo \"Nothing to clean\"", - "build": "echo \"Nothing to build\"", - "docker:build": "docker build -t element-hq/synapse-guest-module -f Dockerfile .", - "tsc": "echo \"Nothing to tsc\"", - "lint": "echo \"Nothing to lint\"", - "types:py": "node ./scripts/run_in_venv.js tox -e check_types", - "lint:py": "node ./scripts/run_in_venv.js tox -e check_codestyle", - "lint:fix": "node ./scripts/run_in_venv.js tox -e fix_codestyle", - "test": "node ./scripts/run_in_venv.js tox -e py", - "depcheck": "echo \"Nothing to check\"", - "package": "yarn docker:build" - } + "name": "@element-hq/synapse-guest-module", + "version": "2.0.0", + "private": true, + "description": "A synapse module to restrict the actions of guests", + "author": "New Vector Ltd.", + "license": "Apache-2.0", + "scripts": { + "clean": "echo \"Nothing to clean\"", + "build": "echo \"Nothing to build\"", + "docker:build": "docker build -t element-hq/synapse-guest-module -f Dockerfile .", + "tsc": "echo \"Nothing to tsc\"", + "lint": "echo \"Nothing to lint\"", + "types:py": "node ./scripts/run_in_venv.js tox -e check_types", + "lint:py": "node ./scripts/run_in_venv.js tox -e check_codestyle", + "lint:fix": "node ./scripts/run_in_venv.js tox -e fix_codestyle", + "test": "node ./scripts/run_in_venv.js tox -e py", + "depcheck": "echo \"Nothing to check\"", + "package": "yarn docker:build" + } } diff --git a/modules/restricted-guests/synapse/scripts/run_in_venv.js b/modules/restricted-guests/synapse/scripts/run_in_venv.js index ee392ecbee..472d471c32 100644 --- a/modules/restricted-guests/synapse/scripts/run_in_venv.js +++ b/modules/restricted-guests/synapse/scripts/run_in_venv.js @@ -21,39 +21,39 @@ // // Example: $ node ./run_in_venv.js python --version -const fs = require('fs'); -const path = require('path'); -const child_process = require('child_process'); +const fs = require("fs"); +const path = require("path"); +const child_process = require("child_process"); -const cwd = path.resolve(__dirname, '..'); -const venvPath = path.resolve(__dirname, '../../../.venv'); +const cwd = path.resolve(__dirname, ".."); +const venvPath = path.resolve(__dirname, "../../../.venv"); const venvRelativeToCwd = path.relative(cwd, venvPath); function run(command) { - return new Promise((resolve) => { - const proc = child_process.spawn( - `source ${venvRelativeToCwd}/bin/activate && ${command}`, - [], - { cwd, stdio: 'inherit', shell: true }, - ); + return new Promise((resolve) => { + const proc = child_process.spawn(`source ${venvRelativeToCwd}/bin/activate && ${command}`, [], { + cwd, + stdio: "inherit", + shell: true, + }); - proc.on('close', (code) => { - console.log('command terminated:', code); - resolve(); + proc.on("close", (code) => { + console.log("command terminated:", code); + resolve(); + }); }); - }); } async function main() { - if (!fs.existsSync(venvPath) || !fs.lstatSync(venvPath).isDirectory()) { - child_process.execSync(`python3 -m venv ${venvRelativeToCwd}`, { cwd }); - await run('pip install tox'); - await run('pip install -e ."[dev]"'); - } + if (!fs.existsSync(venvPath) || !fs.lstatSync(venvPath).isDirectory()) { + child_process.execSync(`python3 -m venv ${venvRelativeToCwd}`, { cwd }); + await run("pip install tox"); + await run('pip install -e ."[dev]"'); + } - const command = process.argv.slice(2).join(' '); + const command = process.argv.slice(2).join(" "); - await run(command); + await run(command); } main(); From 124068294e2fb9010a9651e2039bc09b8ad16f9f Mon Sep 17 00:00:00 2001 From: Andrew Ferrazzutti Date: Wed, 5 Feb 2025 10:48:53 -0500 Subject: [PATCH 05/20] synapse guest module: add to yarn workspaces This fixes a false-positive "missing file" check in knip --- modules/restricted-guests/synapse/package.json | 2 ++ 1 file changed, 2 insertions(+) diff --git a/modules/restricted-guests/synapse/package.json b/modules/restricted-guests/synapse/package.json index 7f1ef45b65..05cfd61802 100644 --- a/modules/restricted-guests/synapse/package.json +++ b/modules/restricted-guests/synapse/package.json @@ -6,11 +6,13 @@ "author": "New Vector Ltd.", "license": "Apache-2.0", "scripts": { + "prepare": "echo \"Nothing to prepare\"", "clean": "echo \"Nothing to clean\"", "build": "echo \"Nothing to build\"", "docker:build": "docker build -t element-hq/synapse-guest-module -f Dockerfile .", "tsc": "echo \"Nothing to tsc\"", "lint": "echo \"Nothing to lint\"", + "lint:ts": "echo \"Nothing to lint:ts\"", "types:py": "node ./scripts/run_in_venv.js tox -e check_types", "lint:py": "node ./scripts/run_in_venv.js tox -e check_codestyle", "lint:fix": "node ./scripts/run_in_venv.js tox -e fix_codestyle", From 88f098a2f7ee4fd04474e888352ae9642f940559 Mon Sep 17 00:00:00 2001 From: Andrew Ferrazzutti Date: Wed, 5 Feb 2025 15:21:53 -0500 Subject: [PATCH 06/20] Use CI job for only synapse guest module Also remove jobs for E2E & changeset, which aren't set up in this repo --- modules/restricted-guests/synapse/README.md | 2 +- modules/restricted-guests/synapse/pyproject.toml | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/modules/restricted-guests/synapse/README.md b/modules/restricted-guests/synapse/README.md index 621a648707..5db9f5c867 100644 --- a/modules/restricted-guests/synapse/README.md +++ b/modules/restricted-guests/synapse/README.md @@ -66,7 +66,7 @@ The module is not published to a python registry, but we provide a docker contai spec: + # The init container copies the module to he `synapse-modules` volume + initContainers: -+ - image: ghcr.io/nordeck/synapse-guest-module: ++ - image: ghcr.io/element-hq/synapse-guest-module: + name: install-guest-module + volumeMounts: + - mountPath: /modules diff --git a/modules/restricted-guests/synapse/pyproject.toml b/modules/restricted-guests/synapse/pyproject.toml index 827968917c..8ba1e996ca 100644 --- a/modules/restricted-guests/synapse/pyproject.toml +++ b/modules/restricted-guests/synapse/pyproject.toml @@ -8,3 +8,6 @@ known_first_party = [ "synapse_guest_module", "tests" ] +known_third_party = [ + "synapse" +] From 88f578a51bd347d7da53037aa0253d49a44b5f1e Mon Sep 17 00:00:00 2001 From: Andrew Ferrazzutti Date: Thu, 6 Feb 2025 10:23:37 -0500 Subject: [PATCH 07/20] synapse guest module: replace ADD with COPY --- modules/restricted-guests/synapse/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/restricted-guests/synapse/Dockerfile b/modules/restricted-guests/synapse/Dockerfile index 3941d9511e..baaab8c2ca 100644 --- a/modules/restricted-guests/synapse/Dockerfile +++ b/modules/restricted-guests/synapse/Dockerfile @@ -1,6 +1,6 @@ FROM debian:bookworm-slim WORKDIR /src -ADD synapse_guest_module /src/synapse_guest_module +COPY synapse_guest_module /src/synapse_guest_module CMD ["cp", "-r", "/src/synapse_guest_module", "/modules"] From 5fe56e414c804b414ce564b5d69c5655c78d18a1 Mon Sep 17 00:00:00 2001 From: Andrew Ferrazzutti Date: Thu, 6 Feb 2025 10:28:36 -0500 Subject: [PATCH 08/20] synapse guest module: use minimal container image --- modules/restricted-guests/synapse/Dockerfile | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/modules/restricted-guests/synapse/Dockerfile b/modules/restricted-guests/synapse/Dockerfile index baaab8c2ca..80d9b87f12 100644 --- a/modules/restricted-guests/synapse/Dockerfile +++ b/modules/restricted-guests/synapse/Dockerfile @@ -1,4 +1,5 @@ -FROM debian:bookworm-slim +ARG DEBIAN_VERSION_NUMERIC=12 +FROM gcr.io/distroless/base-nossl-debian${DEBIAN_VERSION_NUMERIC} WORKDIR /src COPY synapse_guest_module /src/synapse_guest_module From c6c04d399f5f2a8a33928ac04b39daf1933bf631 Mon Sep 17 00:00:00 2001 From: Andrew Ferrazzutti Date: Fri, 7 Feb 2025 08:38:58 -0500 Subject: [PATCH 09/20] Convert run_in_venv Node script to Bash The work done by the script is simpler to achieve in Bash, and avoids a potential mis-parsing of arguments. --- .../restricted-guests/synapse/package.json | 8 +-- .../synapse/scripts/run_in_venv.js | 59 ------------------- .../synapse/scripts/run_in_venv.sh | 36 +++++++++++ 3 files changed, 40 insertions(+), 63 deletions(-) delete mode 100644 modules/restricted-guests/synapse/scripts/run_in_venv.js create mode 100755 modules/restricted-guests/synapse/scripts/run_in_venv.sh diff --git a/modules/restricted-guests/synapse/package.json b/modules/restricted-guests/synapse/package.json index 05cfd61802..397948309c 100644 --- a/modules/restricted-guests/synapse/package.json +++ b/modules/restricted-guests/synapse/package.json @@ -13,10 +13,10 @@ "tsc": "echo \"Nothing to tsc\"", "lint": "echo \"Nothing to lint\"", "lint:ts": "echo \"Nothing to lint:ts\"", - "types:py": "node ./scripts/run_in_venv.js tox -e check_types", - "lint:py": "node ./scripts/run_in_venv.js tox -e check_codestyle", - "lint:fix": "node ./scripts/run_in_venv.js tox -e fix_codestyle", - "test": "node ./scripts/run_in_venv.js tox -e py", + "types:py": "./scripts/run_in_venv.sh tox -e check_types", + "lint:py": "./scripts/run_in_venv.sh tox -e check_codestyle", + "lint:fix": "./scripts/run_in_venv.sh tox -e fix_codestyle", + "test": "./scripts/run_in_venv.sh tox -e py", "depcheck": "echo \"Nothing to check\"", "package": "yarn docker:build" } diff --git a/modules/restricted-guests/synapse/scripts/run_in_venv.js b/modules/restricted-guests/synapse/scripts/run_in_venv.js deleted file mode 100644 index 472d471c32..0000000000 --- a/modules/restricted-guests/synapse/scripts/run_in_venv.js +++ /dev/null @@ -1,59 +0,0 @@ -/* - * Copyright 2023 Nordeck IT + Consulting GmbH - * Copyright 2025 New Vector Ltd. - * - * 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. - */ - -// A script to run a command in a python virtual environment that is stored in -// `/.venv`. If the virtual environment doesn't exist yet, it will -// be created. -// -// Example: $ node ./run_in_venv.js python --version - -const fs = require("fs"); -const path = require("path"); -const child_process = require("child_process"); - -const cwd = path.resolve(__dirname, ".."); -const venvPath = path.resolve(__dirname, "../../../.venv"); -const venvRelativeToCwd = path.relative(cwd, venvPath); - -function run(command) { - return new Promise((resolve) => { - const proc = child_process.spawn(`source ${venvRelativeToCwd}/bin/activate && ${command}`, [], { - cwd, - stdio: "inherit", - shell: true, - }); - - proc.on("close", (code) => { - console.log("command terminated:", code); - resolve(); - }); - }); -} - -async function main() { - if (!fs.existsSync(venvPath) || !fs.lstatSync(venvPath).isDirectory()) { - child_process.execSync(`python3 -m venv ${venvRelativeToCwd}`, { cwd }); - await run("pip install tox"); - await run('pip install -e ."[dev]"'); - } - - const command = process.argv.slice(2).join(" "); - - await run(command); -} - -main(); diff --git a/modules/restricted-guests/synapse/scripts/run_in_venv.sh b/modules/restricted-guests/synapse/scripts/run_in_venv.sh new file mode 100755 index 0000000000..fb20a0a6d4 --- /dev/null +++ b/modules/restricted-guests/synapse/scripts/run_in_venv.sh @@ -0,0 +1,36 @@ +#!/usr/bin/env sh + +# Copyright 2023 Nordeck IT + Consulting GmbH +# Copyright 2025 New Vector Ltd. +# +# 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. + +# A script to run a command in a python virtual environment that is stored in +# `/.venv`. If the virtual environment doesn't exist yet, it will +# be created. +# +# Example: $ ./run_in_venv.sh python --version + +set -e + +cd -- "$(dirname -- "${BASH_SOURCE[0]}")/.." + +repo_root=$(git rev-parse --show-cdup) +venv_path=${repo_root:-./}.venv + +[ -d "$venv_path" ] || python3.11 -m venv "$venv_path" +source "$venv_path/bin/activate" + +pip install -e ."[dev]" + +[ $# -gt 1 ] && $* From 2f8c31797ba397a927d0f556f28b74ba4a2a6276 Mon Sep 17 00:00:00 2001 From: Andrew Ferrazzutti Date: Fri, 7 Feb 2025 10:06:01 -0500 Subject: [PATCH 10/20] Make run_in_venv POSIX compliant (not just Bash) --- modules/restricted-guests/synapse/scripts/run_in_venv.sh | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/restricted-guests/synapse/scripts/run_in_venv.sh b/modules/restricted-guests/synapse/scripts/run_in_venv.sh index fb20a0a6d4..7a222359ab 100755 --- a/modules/restricted-guests/synapse/scripts/run_in_venv.sh +++ b/modules/restricted-guests/synapse/scripts/run_in_venv.sh @@ -23,14 +23,14 @@ set -e -cd -- "$(dirname -- "${BASH_SOURCE[0]}")/.." +cd -- "$(dirname -- "$0")/.." repo_root=$(git rev-parse --show-cdup) venv_path=${repo_root:-./}.venv [ -d "$venv_path" ] || python3.11 -m venv "$venv_path" -source "$venv_path/bin/activate" +. "$venv_path/bin/activate" pip install -e ."[dev]" -[ $# -gt 1 ] && $* +[ $# -gt 1 ] && "$@" From d0f183517562dfebc073ab2bd2cdc5310556d80c Mon Sep 17 00:00:00 2001 From: Andrew Ferrazzutti Date: Fri, 7 Feb 2025 10:53:54 -0500 Subject: [PATCH 11/20] run_in_venv: allow setting Python version --- modules/restricted-guests/synapse/scripts/run_in_venv.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/restricted-guests/synapse/scripts/run_in_venv.sh b/modules/restricted-guests/synapse/scripts/run_in_venv.sh index 7a222359ab..1125d3f238 100755 --- a/modules/restricted-guests/synapse/scripts/run_in_venv.sh +++ b/modules/restricted-guests/synapse/scripts/run_in_venv.sh @@ -28,7 +28,7 @@ cd -- "$(dirname -- "$0")/.." repo_root=$(git rev-parse --show-cdup) venv_path=${repo_root:-./}.venv -[ -d "$venv_path" ] || python3.11 -m venv "$venv_path" +[ -d "$venv_path" ] || python${PYTHON_VERSION:-3} -m venv "$venv_path" . "$venv_path/bin/activate" pip install -e ."[dev]" From 2e58691093afa05a74d7bff23395b4d4751cd87d Mon Sep 17 00:00:00 2001 From: Andrew Ferrazzutti Date: Fri, 7 Feb 2025 11:36:10 -0500 Subject: [PATCH 12/20] run_in_venv: skip unnecessary env reinstallation --- .../restricted-guests/synapse/scripts/run_in_venv.sh | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/modules/restricted-guests/synapse/scripts/run_in_venv.sh b/modules/restricted-guests/synapse/scripts/run_in_venv.sh index 1125d3f238..21e676f0c0 100755 --- a/modules/restricted-guests/synapse/scripts/run_in_venv.sh +++ b/modules/restricted-guests/synapse/scripts/run_in_venv.sh @@ -28,9 +28,9 @@ cd -- "$(dirname -- "$0")/.." repo_root=$(git rev-parse --show-cdup) venv_path=${repo_root:-./}.venv -[ -d "$venv_path" ] || python${PYTHON_VERSION:-3} -m venv "$venv_path" -. "$venv_path/bin/activate" +if [ ! -d "$venv_path" ]; then + "python${PYTHON_VERSION:-3}" -m venv "$venv_path" + "$venv_path/bin/pip" install -e ."[dev]" +fi -pip install -e ."[dev]" - -[ $# -gt 1 ] && "$@" +[ $# -gt 1 ] && . "$venv_path/bin/activate" && "$@" From 65d75c3779499415783808a0f7a5605b9a1ada15 Mon Sep 17 00:00:00 2001 From: Andrew Ferrazzutti Date: Fri, 7 Feb 2025 12:02:19 -0500 Subject: [PATCH 13/20] Split out vitest from general tests --- modules/opendesk/element-web/package.json | 3 ++- modules/restricted-guests/synapse/package.json | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/modules/opendesk/element-web/package.json b/modules/opendesk/element-web/package.json index ca9e7b3f2d..d051def5c1 100644 --- a/modules/opendesk/element-web/package.json +++ b/modules/opendesk/element-web/package.json @@ -9,7 +9,8 @@ "scripts": { "prepare": "vite build", "lint:ts": "tsc --noEmit", - "test": "echo no tests yet" + "test": "echo no tests yet", + "vitest": "echo no tests yet" }, "devDependencies": { "@element-hq/element-web-module-api": "^0.1.0", diff --git a/modules/restricted-guests/synapse/package.json b/modules/restricted-guests/synapse/package.json index 397948309c..f166cec809 100644 --- a/modules/restricted-guests/synapse/package.json +++ b/modules/restricted-guests/synapse/package.json @@ -17,6 +17,7 @@ "lint:py": "./scripts/run_in_venv.sh tox -e check_codestyle", "lint:fix": "./scripts/run_in_venv.sh tox -e fix_codestyle", "test": "./scripts/run_in_venv.sh tox -e py", + "vitest": "echo \"Nothing to vitest\"", "depcheck": "echo \"Nothing to check\"", "package": "yarn docker:build" } From 673bda4515eb554d726165ae3d4c6c18af38979d Mon Sep 17 00:00:00 2001 From: Andrew Ferrazzutti Date: Mon, 10 Feb 2025 15:04:35 -0500 Subject: [PATCH 14/20] synapse guest module: set version to 1.0.0 as opposed to picking up from where upstream left off at 2.0.0. (Note that CHANGELOG.md was already at 1.0.0.) --- modules/restricted-guests/synapse/package.json | 2 +- modules/restricted-guests/synapse/setup.cfg | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/restricted-guests/synapse/package.json b/modules/restricted-guests/synapse/package.json index f166cec809..00d2345ef8 100644 --- a/modules/restricted-guests/synapse/package.json +++ b/modules/restricted-guests/synapse/package.json @@ -1,6 +1,6 @@ { "name": "@element-hq/synapse-guest-module", - "version": "2.0.0", + "version": "1.0.0", "private": true, "description": "A synapse module to restrict the actions of guests", "author": "New Vector Ltd.", diff --git a/modules/restricted-guests/synapse/setup.cfg b/modules/restricted-guests/synapse/setup.cfg index a810e40931..8eeff887b1 100644 --- a/modules/restricted-guests/synapse/setup.cfg +++ b/modules/restricted-guests/synapse/setup.cfg @@ -3,7 +3,7 @@ name = synapse_guest_module description = A synapse module to restrict the actions of guests long_description = file: README.md long_description_content_type = text/markdown -version = 2.0.0 +version = 1.0.0 classifiers = License :: OSI Approved :: Apache Software License From 226b89f846862e8799a41ddd3f072d17e30a48d4 Mon Sep 17 00:00:00 2001 From: Andrew Ferrazzutti Date: Mon, 10 Feb 2025 15:01:20 -0500 Subject: [PATCH 15/20] synapse guest module: change license Set license to multi-license of AGPL + Element Commercial, and add associated license files to the repository root. This does not add a notice of "This file includes modifications" to any files because they were only moved and relicensed, but otherwise unmodified. The exception is run_in_venv.sh, which is a rewrite of upstream's run_in_venv.js and thus lacks the original copyright entirely. --- modules/restricted-guests/synapse/README.md | 12 ++++++++++++ modules/restricted-guests/synapse/package.json | 2 +- .../synapse/scripts/run_in_venv.sh | 17 +++-------------- modules/restricted-guests/synapse/setup.cfg | 7 ++++--- .../synapse/synapse_guest_module/__init__.py | 16 +++++----------- .../synapse/synapse_guest_module/config.py | 16 +++++----------- .../synapse_guest_module/guest_module.py | 16 +++++----------- .../guest_registration_servlet.py | 16 +++++----------- .../synapse_guest_module/guest_user_reaper.py | 16 +++++----------- .../restricted-guests/synapse/tests/__init__.py | 16 +++++----------- .../synapse/tests/test_guest_module.py | 16 +++++----------- .../tests/test_guest_registration_servlet.py | 16 +++++----------- .../synapse/tests/test_guest_user_reaper.py | 16 +++++----------- 13 files changed, 65 insertions(+), 117 deletions(-) diff --git a/modules/restricted-guests/synapse/README.md b/modules/restricted-guests/synapse/README.md index 5db9f5c867..958806ae7f 100644 --- a/modules/restricted-guests/synapse/README.md +++ b/modules/restricted-guests/synapse/README.md @@ -91,3 +91,15 @@ The module is not published to a python registry, but we provide a docker contai + name: synapse-modules # ... ``` + +## Copyright & License + +Copyright 2023 Nordeck IT + Consulting GmbH +Copyright (c) 2025 New Vector Ltd + +This software is multi licensed by New Vector Ltd (Element). It can be used either: + +(1) for free under the terms of the GNU Affero General Public License (as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version); OR + +(2) under the terms of a paid-for Element Commercial License agreement between you and Element (the terms of which may vary depending on what you and Element have agreed to). +Unless required by applicable law or agreed to in writing, software distributed under the Licenses is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licenses for the specific language governing permissions and limitations under the Licenses. diff --git a/modules/restricted-guests/synapse/package.json b/modules/restricted-guests/synapse/package.json index 00d2345ef8..529323342e 100644 --- a/modules/restricted-guests/synapse/package.json +++ b/modules/restricted-guests/synapse/package.json @@ -4,7 +4,7 @@ "private": true, "description": "A synapse module to restrict the actions of guests", "author": "New Vector Ltd.", - "license": "Apache-2.0", + "license": "SEE LICENSE IN README.md", "scripts": { "prepare": "echo \"Nothing to prepare\"", "clean": "echo \"Nothing to clean\"", diff --git a/modules/restricted-guests/synapse/scripts/run_in_venv.sh b/modules/restricted-guests/synapse/scripts/run_in_venv.sh index 21e676f0c0..3c97ad3e8c 100755 --- a/modules/restricted-guests/synapse/scripts/run_in_venv.sh +++ b/modules/restricted-guests/synapse/scripts/run_in_venv.sh @@ -1,19 +1,8 @@ #!/usr/bin/env sh - -# Copyright 2023 Nordeck IT + Consulting GmbH -# Copyright 2025 New Vector Ltd. +# Copyright (C) 2025 New Vector Ltd. # -# 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. +# SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial +# Please see LICENSE files in the repository root for full details. # A script to run a command in a python virtual environment that is stored in # `/.venv`. If the virtual environment doesn't exist yet, it will diff --git a/modules/restricted-guests/synapse/setup.cfg b/modules/restricted-guests/synapse/setup.cfg index 8eeff887b1..4ebc42cd85 100644 --- a/modules/restricted-guests/synapse/setup.cfg +++ b/modules/restricted-guests/synapse/setup.cfg @@ -4,9 +4,10 @@ description = A synapse module to restrict the actions of guests long_description = file: README.md long_description_content_type = text/markdown version = 1.0.0 - -classifiers = - License :: OSI Approved :: Apache Software License +license = AGPL-3.0-only OR LicenseRef-Element-Commercial +license_files = + ../../../LICENSE-AGPL-3.0 + ../../../LICENSE-COMMERCIAL [options] diff --git a/modules/restricted-guests/synapse/synapse_guest_module/__init__.py b/modules/restricted-guests/synapse/synapse_guest_module/__init__.py index fc47effa9f..33a6e8331f 100644 --- a/modules/restricted-guests/synapse/synapse_guest_module/__init__.py +++ b/modules/restricted-guests/synapse/synapse_guest_module/__init__.py @@ -1,17 +1,11 @@ # Copyright 2023 Nordeck IT + Consulting GmbH -# Copyright 2025 New Vector Ltd. +# Copyright (C) 2025 New Vector Ltd. # -# 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 +# SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial +# Please see LICENSE files in the repository root for full details. # -# 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. +# Originally licensed under the Apache License, Version 2.0: +# . from synapse_guest_module.guest_module import GuestModule diff --git a/modules/restricted-guests/synapse/synapse_guest_module/config.py b/modules/restricted-guests/synapse/synapse_guest_module/config.py index 2ef607a491..4a53ae47c5 100644 --- a/modules/restricted-guests/synapse/synapse_guest_module/config.py +++ b/modules/restricted-guests/synapse/synapse_guest_module/config.py @@ -1,17 +1,11 @@ # Copyright 2023 Nordeck IT + Consulting GmbH -# Copyright 2025 New Vector Ltd. +# Copyright (C) 2025 New Vector Ltd. # -# 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 +# SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial +# Please see LICENSE files in the repository root for full details. # -# 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. +# Originally licensed under the Apache License, Version 2.0: +# . import attr diff --git a/modules/restricted-guests/synapse/synapse_guest_module/guest_module.py b/modules/restricted-guests/synapse/synapse_guest_module/guest_module.py index 89fb3f87de..ec09c0a58b 100644 --- a/modules/restricted-guests/synapse/synapse_guest_module/guest_module.py +++ b/modules/restricted-guests/synapse/synapse_guest_module/guest_module.py @@ -1,17 +1,11 @@ # Copyright 2023 Nordeck IT + Consulting GmbH -# Copyright 2025 New Vector Ltd. +# Copyright (C) 2025 New Vector Ltd. # -# 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 +# SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial +# Please see LICENSE files in the repository root for full details. # -# 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. +# Originally licensed under the Apache License, Version 2.0: +# . import logging from typing import Any, Dict, Literal, Tuple, Union diff --git a/modules/restricted-guests/synapse/synapse_guest_module/guest_registration_servlet.py b/modules/restricted-guests/synapse/synapse_guest_module/guest_registration_servlet.py index 7f9849d781..4555823b22 100644 --- a/modules/restricted-guests/synapse/synapse_guest_module/guest_registration_servlet.py +++ b/modules/restricted-guests/synapse/synapse_guest_module/guest_registration_servlet.py @@ -1,17 +1,11 @@ # Copyright 2023 Nordeck IT + Consulting GmbH -# Copyright 2025 New Vector Ltd. +# Copyright (C) 2025 New Vector Ltd. # -# 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 +# SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial +# Please see LICENSE files in the repository root for full details. # -# 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. +# Originally licensed under the Apache License, Version 2.0: +# . import logging import secrets diff --git a/modules/restricted-guests/synapse/synapse_guest_module/guest_user_reaper.py b/modules/restricted-guests/synapse/synapse_guest_module/guest_user_reaper.py index c2492be9bb..d03d5da4f4 100644 --- a/modules/restricted-guests/synapse/synapse_guest_module/guest_user_reaper.py +++ b/modules/restricted-guests/synapse/synapse_guest_module/guest_user_reaper.py @@ -1,17 +1,11 @@ # Copyright 2023 Nordeck IT + Consulting GmbH -# Copyright 2025 New Vector Ltd. +# Copyright (C) 2025 New Vector Ltd. # -# 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 +# SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial +# Please see LICENSE files in the repository root for full details. # -# 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. +# Originally licensed under the Apache License, Version 2.0: +# . import logging import time diff --git a/modules/restricted-guests/synapse/tests/__init__.py b/modules/restricted-guests/synapse/tests/__init__.py index 49012b4ca7..4def99172a 100644 --- a/modules/restricted-guests/synapse/tests/__init__.py +++ b/modules/restricted-guests/synapse/tests/__init__.py @@ -1,17 +1,11 @@ # Copyright 2023 Nordeck IT + Consulting GmbH -# Copyright 2025 New Vector Ltd. +# Copyright (C) 2025 New Vector Ltd. # -# 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 +# SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial +# Please see LICENSE files in the repository root for full details. # -# 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. +# Originally licensed under the Apache License, Version 2.0: +# . import sqlite3 from asyncio import Future diff --git a/modules/restricted-guests/synapse/tests/test_guest_module.py b/modules/restricted-guests/synapse/tests/test_guest_module.py index c5d7164edf..c08ce3071d 100644 --- a/modules/restricted-guests/synapse/tests/test_guest_module.py +++ b/modules/restricted-guests/synapse/tests/test_guest_module.py @@ -1,17 +1,11 @@ # Copyright 2023 Nordeck IT + Consulting GmbH -# Copyright 2025 New Vector Ltd. +# Copyright (C) 2025 New Vector Ltd. # -# 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 +# SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial +# Please see LICENSE files in the repository root for full details. # -# 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. +# Originally licensed under the Apache License, Version 2.0: +# . import aiounittest from synapse.module_api import ProfileInfo, UserProfile diff --git a/modules/restricted-guests/synapse/tests/test_guest_registration_servlet.py b/modules/restricted-guests/synapse/tests/test_guest_registration_servlet.py index e8700d2f03..314264b657 100644 --- a/modules/restricted-guests/synapse/tests/test_guest_registration_servlet.py +++ b/modules/restricted-guests/synapse/tests/test_guest_registration_servlet.py @@ -1,17 +1,11 @@ # Copyright 2023 Nordeck IT + Consulting GmbH -# Copyright 2025 New Vector Ltd. +# Copyright (C) 2025 New Vector Ltd. # -# 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 +# SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial +# Please see LICENSE files in the repository root for full details. # -# 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. +# Originally licensed under the Apache License, Version 2.0: +# . import io from typing import cast diff --git a/modules/restricted-guests/synapse/tests/test_guest_user_reaper.py b/modules/restricted-guests/synapse/tests/test_guest_user_reaper.py index 191312f380..3ad2b03d6a 100644 --- a/modules/restricted-guests/synapse/tests/test_guest_user_reaper.py +++ b/modules/restricted-guests/synapse/tests/test_guest_user_reaper.py @@ -1,17 +1,11 @@ # Copyright 2023 Nordeck IT + Consulting GmbH -# Copyright 2025 New Vector Ltd. +# Copyright (C) 2025 New Vector Ltd. # -# 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 +# SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial +# Please see LICENSE files in the repository root for full details. # -# 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. +# Originally licensed under the Apache License, Version 2.0: +# . import time from unittest.mock import call From 3e107737aad827a56014d250b06e1b9732c62e82 Mon Sep 17 00:00:00 2001 From: Andrew Ferrazzutti Date: Tue, 11 Feb 2025 14:00:07 -0500 Subject: [PATCH 16/20] Remove "(C)" from copyright lines for consistency with other copyright lines, and readability --- modules/restricted-guests/synapse/scripts/run_in_venv.sh | 2 +- .../restricted-guests/synapse/synapse_guest_module/__init__.py | 2 +- .../restricted-guests/synapse/synapse_guest_module/config.py | 2 +- .../synapse/synapse_guest_module/guest_module.py | 2 +- .../synapse/synapse_guest_module/guest_registration_servlet.py | 2 +- .../synapse/synapse_guest_module/guest_user_reaper.py | 2 +- modules/restricted-guests/synapse/tests/__init__.py | 2 +- modules/restricted-guests/synapse/tests/test_guest_module.py | 2 +- .../synapse/tests/test_guest_registration_servlet.py | 2 +- .../restricted-guests/synapse/tests/test_guest_user_reaper.py | 2 +- 10 files changed, 10 insertions(+), 10 deletions(-) diff --git a/modules/restricted-guests/synapse/scripts/run_in_venv.sh b/modules/restricted-guests/synapse/scripts/run_in_venv.sh index 3c97ad3e8c..f53288d162 100755 --- a/modules/restricted-guests/synapse/scripts/run_in_venv.sh +++ b/modules/restricted-guests/synapse/scripts/run_in_venv.sh @@ -1,5 +1,5 @@ #!/usr/bin/env sh -# Copyright (C) 2025 New Vector Ltd. +# Copyright 2025 New Vector Ltd. # # SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial # Please see LICENSE files in the repository root for full details. diff --git a/modules/restricted-guests/synapse/synapse_guest_module/__init__.py b/modules/restricted-guests/synapse/synapse_guest_module/__init__.py index 33a6e8331f..777308ee00 100644 --- a/modules/restricted-guests/synapse/synapse_guest_module/__init__.py +++ b/modules/restricted-guests/synapse/synapse_guest_module/__init__.py @@ -1,5 +1,5 @@ # Copyright 2023 Nordeck IT + Consulting GmbH -# Copyright (C) 2025 New Vector Ltd. +# Copyright 2025 New Vector Ltd. # # SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial # Please see LICENSE files in the repository root for full details. diff --git a/modules/restricted-guests/synapse/synapse_guest_module/config.py b/modules/restricted-guests/synapse/synapse_guest_module/config.py index 4a53ae47c5..4d2248c710 100644 --- a/modules/restricted-guests/synapse/synapse_guest_module/config.py +++ b/modules/restricted-guests/synapse/synapse_guest_module/config.py @@ -1,5 +1,5 @@ # Copyright 2023 Nordeck IT + Consulting GmbH -# Copyright (C) 2025 New Vector Ltd. +# Copyright 2025 New Vector Ltd. # # SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial # Please see LICENSE files in the repository root for full details. diff --git a/modules/restricted-guests/synapse/synapse_guest_module/guest_module.py b/modules/restricted-guests/synapse/synapse_guest_module/guest_module.py index ec09c0a58b..eb89099d90 100644 --- a/modules/restricted-guests/synapse/synapse_guest_module/guest_module.py +++ b/modules/restricted-guests/synapse/synapse_guest_module/guest_module.py @@ -1,5 +1,5 @@ # Copyright 2023 Nordeck IT + Consulting GmbH -# Copyright (C) 2025 New Vector Ltd. +# Copyright 2025 New Vector Ltd. # # SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial # Please see LICENSE files in the repository root for full details. diff --git a/modules/restricted-guests/synapse/synapse_guest_module/guest_registration_servlet.py b/modules/restricted-guests/synapse/synapse_guest_module/guest_registration_servlet.py index 4555823b22..7d6e575b37 100644 --- a/modules/restricted-guests/synapse/synapse_guest_module/guest_registration_servlet.py +++ b/modules/restricted-guests/synapse/synapse_guest_module/guest_registration_servlet.py @@ -1,5 +1,5 @@ # Copyright 2023 Nordeck IT + Consulting GmbH -# Copyright (C) 2025 New Vector Ltd. +# Copyright 2025 New Vector Ltd. # # SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial # Please see LICENSE files in the repository root for full details. diff --git a/modules/restricted-guests/synapse/synapse_guest_module/guest_user_reaper.py b/modules/restricted-guests/synapse/synapse_guest_module/guest_user_reaper.py index d03d5da4f4..df5f7160dc 100644 --- a/modules/restricted-guests/synapse/synapse_guest_module/guest_user_reaper.py +++ b/modules/restricted-guests/synapse/synapse_guest_module/guest_user_reaper.py @@ -1,5 +1,5 @@ # Copyright 2023 Nordeck IT + Consulting GmbH -# Copyright (C) 2025 New Vector Ltd. +# Copyright 2025 New Vector Ltd. # # SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial # Please see LICENSE files in the repository root for full details. diff --git a/modules/restricted-guests/synapse/tests/__init__.py b/modules/restricted-guests/synapse/tests/__init__.py index 4def99172a..199848523d 100644 --- a/modules/restricted-guests/synapse/tests/__init__.py +++ b/modules/restricted-guests/synapse/tests/__init__.py @@ -1,5 +1,5 @@ # Copyright 2023 Nordeck IT + Consulting GmbH -# Copyright (C) 2025 New Vector Ltd. +# Copyright 2025 New Vector Ltd. # # SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial # Please see LICENSE files in the repository root for full details. diff --git a/modules/restricted-guests/synapse/tests/test_guest_module.py b/modules/restricted-guests/synapse/tests/test_guest_module.py index c08ce3071d..dfa6ed20e4 100644 --- a/modules/restricted-guests/synapse/tests/test_guest_module.py +++ b/modules/restricted-guests/synapse/tests/test_guest_module.py @@ -1,5 +1,5 @@ # Copyright 2023 Nordeck IT + Consulting GmbH -# Copyright (C) 2025 New Vector Ltd. +# Copyright 2025 New Vector Ltd. # # SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial # Please see LICENSE files in the repository root for full details. diff --git a/modules/restricted-guests/synapse/tests/test_guest_registration_servlet.py b/modules/restricted-guests/synapse/tests/test_guest_registration_servlet.py index 314264b657..d45b992fa6 100644 --- a/modules/restricted-guests/synapse/tests/test_guest_registration_servlet.py +++ b/modules/restricted-guests/synapse/tests/test_guest_registration_servlet.py @@ -1,5 +1,5 @@ # Copyright 2023 Nordeck IT + Consulting GmbH -# Copyright (C) 2025 New Vector Ltd. +# Copyright 2025 New Vector Ltd. # # SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial # Please see LICENSE files in the repository root for full details. diff --git a/modules/restricted-guests/synapse/tests/test_guest_user_reaper.py b/modules/restricted-guests/synapse/tests/test_guest_user_reaper.py index 3ad2b03d6a..a9144619f7 100644 --- a/modules/restricted-guests/synapse/tests/test_guest_user_reaper.py +++ b/modules/restricted-guests/synapse/tests/test_guest_user_reaper.py @@ -1,5 +1,5 @@ # Copyright 2023 Nordeck IT + Consulting GmbH -# Copyright (C) 2025 New Vector Ltd. +# Copyright 2025 New Vector Ltd. # # SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial # Please see LICENSE files in the repository root for full details. From 523758cbea6eecefdbb4bcf926bdae1f5d184f04 Mon Sep 17 00:00:00 2001 From: Andrew Ferrazzutti Date: Wed, 12 Feb 2025 15:42:18 -0500 Subject: [PATCH 17/20] synapse guest module: move license files Move them into the module folder so that they'll be properly included in distribution builds, such as when installing this module via pip. Also reword copyright headers to refer to the project root instead of the repository root, which isn't included in distribution builds. --- .../synapse/LICENSE-AGPL-3.0 | 661 ++++++++++++++++++ .../synapse/LICENSE-COMMERCIAL | 6 + .../synapse/scripts/run_in_venv.sh | 2 +- modules/restricted-guests/synapse/setup.cfg | 4 +- .../synapse/synapse_guest_module/__init__.py | 2 +- .../synapse/synapse_guest_module/config.py | 2 +- .../synapse_guest_module/guest_module.py | 2 +- .../guest_registration_servlet.py | 2 +- .../synapse_guest_module/guest_user_reaper.py | 2 +- .../synapse/tests/__init__.py | 2 +- .../synapse/tests/test_guest_module.py | 2 +- .../tests/test_guest_registration_servlet.py | 2 +- .../synapse/tests/test_guest_user_reaper.py | 2 +- 13 files changed, 679 insertions(+), 12 deletions(-) create mode 100644 modules/restricted-guests/synapse/LICENSE-AGPL-3.0 create mode 100644 modules/restricted-guests/synapse/LICENSE-COMMERCIAL diff --git a/modules/restricted-guests/synapse/LICENSE-AGPL-3.0 b/modules/restricted-guests/synapse/LICENSE-AGPL-3.0 new file mode 100644 index 0000000000..19bae35887 --- /dev/null +++ b/modules/restricted-guests/synapse/LICENSE-AGPL-3.0 @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. + + Preamble + +The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + +A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + +The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + +An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + +The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + +0. Definitions. + +"This License" refers to version 3 of the GNU Affero General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + +An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +1. Source Code. + +The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + +The Corresponding Source for a work in source code form is that +same work. + +2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + +3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + +4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + +8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + +13. Remote Network Interaction; Use with the GNU General Public License. + +Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + +14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + +If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + +17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + +If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + +You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/modules/restricted-guests/synapse/LICENSE-COMMERCIAL b/modules/restricted-guests/synapse/LICENSE-COMMERCIAL new file mode 100644 index 0000000000..173e03e0c0 --- /dev/null +++ b/modules/restricted-guests/synapse/LICENSE-COMMERCIAL @@ -0,0 +1,6 @@ +Licensees holding a valid commercial license with Element may use this +software in accordance with the terms contained in a written agreement +between you and Element. + +To purchase a commercial license please contact our sales team at +licensing@element.io diff --git a/modules/restricted-guests/synapse/scripts/run_in_venv.sh b/modules/restricted-guests/synapse/scripts/run_in_venv.sh index f53288d162..9f5ba12584 100755 --- a/modules/restricted-guests/synapse/scripts/run_in_venv.sh +++ b/modules/restricted-guests/synapse/scripts/run_in_venv.sh @@ -2,7 +2,7 @@ # Copyright 2025 New Vector Ltd. # # SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial -# Please see LICENSE files in the repository root for full details. +# Please see LICENSE files in the project root for full details. # A script to run a command in a python virtual environment that is stored in # `/.venv`. If the virtual environment doesn't exist yet, it will diff --git a/modules/restricted-guests/synapse/setup.cfg b/modules/restricted-guests/synapse/setup.cfg index 4ebc42cd85..8fe46af1a8 100644 --- a/modules/restricted-guests/synapse/setup.cfg +++ b/modules/restricted-guests/synapse/setup.cfg @@ -6,8 +6,8 @@ long_description_content_type = text/markdown version = 1.0.0 license = AGPL-3.0-only OR LicenseRef-Element-Commercial license_files = - ../../../LICENSE-AGPL-3.0 - ../../../LICENSE-COMMERCIAL + LICENSE-AGPL-3.0 + LICENSE-COMMERCIAL [options] diff --git a/modules/restricted-guests/synapse/synapse_guest_module/__init__.py b/modules/restricted-guests/synapse/synapse_guest_module/__init__.py index 777308ee00..29b1836399 100644 --- a/modules/restricted-guests/synapse/synapse_guest_module/__init__.py +++ b/modules/restricted-guests/synapse/synapse_guest_module/__init__.py @@ -2,7 +2,7 @@ # Copyright 2025 New Vector Ltd. # # SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial -# Please see LICENSE files in the repository root for full details. +# Please see LICENSE files in the project root for full details. # # Originally licensed under the Apache License, Version 2.0: # . diff --git a/modules/restricted-guests/synapse/synapse_guest_module/config.py b/modules/restricted-guests/synapse/synapse_guest_module/config.py index 4d2248c710..a0ddbe569a 100644 --- a/modules/restricted-guests/synapse/synapse_guest_module/config.py +++ b/modules/restricted-guests/synapse/synapse_guest_module/config.py @@ -2,7 +2,7 @@ # Copyright 2025 New Vector Ltd. # # SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial -# Please see LICENSE files in the repository root for full details. +# Please see LICENSE files in the project root for full details. # # Originally licensed under the Apache License, Version 2.0: # . diff --git a/modules/restricted-guests/synapse/synapse_guest_module/guest_module.py b/modules/restricted-guests/synapse/synapse_guest_module/guest_module.py index eb89099d90..156012c35d 100644 --- a/modules/restricted-guests/synapse/synapse_guest_module/guest_module.py +++ b/modules/restricted-guests/synapse/synapse_guest_module/guest_module.py @@ -2,7 +2,7 @@ # Copyright 2025 New Vector Ltd. # # SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial -# Please see LICENSE files in the repository root for full details. +# Please see LICENSE files in the project root for full details. # # Originally licensed under the Apache License, Version 2.0: # . diff --git a/modules/restricted-guests/synapse/synapse_guest_module/guest_registration_servlet.py b/modules/restricted-guests/synapse/synapse_guest_module/guest_registration_servlet.py index 7d6e575b37..6cdb382831 100644 --- a/modules/restricted-guests/synapse/synapse_guest_module/guest_registration_servlet.py +++ b/modules/restricted-guests/synapse/synapse_guest_module/guest_registration_servlet.py @@ -2,7 +2,7 @@ # Copyright 2025 New Vector Ltd. # # SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial -# Please see LICENSE files in the repository root for full details. +# Please see LICENSE files in the project root for full details. # # Originally licensed under the Apache License, Version 2.0: # . diff --git a/modules/restricted-guests/synapse/synapse_guest_module/guest_user_reaper.py b/modules/restricted-guests/synapse/synapse_guest_module/guest_user_reaper.py index df5f7160dc..7b3f2c7288 100644 --- a/modules/restricted-guests/synapse/synapse_guest_module/guest_user_reaper.py +++ b/modules/restricted-guests/synapse/synapse_guest_module/guest_user_reaper.py @@ -2,7 +2,7 @@ # Copyright 2025 New Vector Ltd. # # SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial -# Please see LICENSE files in the repository root for full details. +# Please see LICENSE files in the project root for full details. # # Originally licensed under the Apache License, Version 2.0: # . diff --git a/modules/restricted-guests/synapse/tests/__init__.py b/modules/restricted-guests/synapse/tests/__init__.py index 199848523d..04d9c250b8 100644 --- a/modules/restricted-guests/synapse/tests/__init__.py +++ b/modules/restricted-guests/synapse/tests/__init__.py @@ -2,7 +2,7 @@ # Copyright 2025 New Vector Ltd. # # SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial -# Please see LICENSE files in the repository root for full details. +# Please see LICENSE files in the project root for full details. # # Originally licensed under the Apache License, Version 2.0: # . diff --git a/modules/restricted-guests/synapse/tests/test_guest_module.py b/modules/restricted-guests/synapse/tests/test_guest_module.py index dfa6ed20e4..f92614c714 100644 --- a/modules/restricted-guests/synapse/tests/test_guest_module.py +++ b/modules/restricted-guests/synapse/tests/test_guest_module.py @@ -2,7 +2,7 @@ # Copyright 2025 New Vector Ltd. # # SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial -# Please see LICENSE files in the repository root for full details. +# Please see LICENSE files in the project root for full details. # # Originally licensed under the Apache License, Version 2.0: # . diff --git a/modules/restricted-guests/synapse/tests/test_guest_registration_servlet.py b/modules/restricted-guests/synapse/tests/test_guest_registration_servlet.py index d45b992fa6..f0a63b7a62 100644 --- a/modules/restricted-guests/synapse/tests/test_guest_registration_servlet.py +++ b/modules/restricted-guests/synapse/tests/test_guest_registration_servlet.py @@ -2,7 +2,7 @@ # Copyright 2025 New Vector Ltd. # # SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial -# Please see LICENSE files in the repository root for full details. +# Please see LICENSE files in the project root for full details. # # Originally licensed under the Apache License, Version 2.0: # . diff --git a/modules/restricted-guests/synapse/tests/test_guest_user_reaper.py b/modules/restricted-guests/synapse/tests/test_guest_user_reaper.py index a9144619f7..0a865c3f2d 100644 --- a/modules/restricted-guests/synapse/tests/test_guest_user_reaper.py +++ b/modules/restricted-guests/synapse/tests/test_guest_user_reaper.py @@ -2,7 +2,7 @@ # Copyright 2025 New Vector Ltd. # # SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial -# Please see LICENSE files in the repository root for full details. +# Please see LICENSE files in the project root for full details. # # Originally licensed under the Apache License, Version 2.0: # . From 504f35a65bbf851cc4a3c76c09cb13770b26a525 Mon Sep 17 00:00:00 2001 From: Andrew Ferrazzutti Date: Wed, 12 Feb 2025 15:42:59 -0500 Subject: [PATCH 18/20] synapse guest module: nitpick quote refactor --- modules/restricted-guests/synapse/scripts/run_in_venv.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/restricted-guests/synapse/scripts/run_in_venv.sh b/modules/restricted-guests/synapse/scripts/run_in_venv.sh index 9f5ba12584..23adf1e03b 100755 --- a/modules/restricted-guests/synapse/scripts/run_in_venv.sh +++ b/modules/restricted-guests/synapse/scripts/run_in_venv.sh @@ -19,7 +19,7 @@ venv_path=${repo_root:-./}.venv if [ ! -d "$venv_path" ]; then "python${PYTHON_VERSION:-3}" -m venv "$venv_path" - "$venv_path/bin/pip" install -e ."[dev]" + "$venv_path/bin/pip" install -e '.[dev]' fi [ $# -gt 1 ] && . "$venv_path/bin/activate" && "$@" From b429ae9c10bcdbd625273c3664ff8062be361397 Mon Sep 17 00:00:00 2001 From: Andrew Ferrazzutti Date: Wed, 12 Feb 2025 16:01:24 -0500 Subject: [PATCH 19/20] synapse guest module: generate coverage report --- modules/restricted-guests/synapse/setup.cfg | 6 ++++++ modules/restricted-guests/synapse/tox.ini | 3 ++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/modules/restricted-guests/synapse/setup.cfg b/modules/restricted-guests/synapse/setup.cfg index 8fe46af1a8..75fead2743 100644 --- a/modules/restricted-guests/synapse/setup.cfg +++ b/modules/restricted-guests/synapse/setup.cfg @@ -29,6 +29,7 @@ dev = tox twisted aiounittest + coverage # for type checking mypy == 1.10.0 pydantic == 2.4.2 @@ -38,6 +39,11 @@ dev = isort == 5.9.3 +[coverage:run] +relative_files = True +branch = True + + [flake8] # see https://pycodestyle.readthedocs.io/en/latest/intro.html#error-codes # for error codes. The ones we ignore are: diff --git a/modules/restricted-guests/synapse/tox.ini b/modules/restricted-guests/synapse/tox.ini index 1410d2ee59..0da1d491aa 100644 --- a/modules/restricted-guests/synapse/tox.ini +++ b/modules/restricted-guests/synapse/tox.ini @@ -9,7 +9,8 @@ isolated_build = true extras = dev commands = - python -m twisted.trial tests + coverage run -m twisted.trial tests + coverage xml [testenv:check_codestyle] From ab17724182db1c6ccfde0f920a845b41a18004a5 Mon Sep 17 00:00:00 2001 From: Andrew Ferrazzutti Date: Thu, 13 Feb 2025 11:37:53 -0500 Subject: [PATCH 20/20] Make "yarn test" always enable coverage --- modules/opendesk/element-web/package.json | 3 +-- modules/restricted-guests/synapse/package.json | 1 - 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/modules/opendesk/element-web/package.json b/modules/opendesk/element-web/package.json index d051def5c1..ca9e7b3f2d 100644 --- a/modules/opendesk/element-web/package.json +++ b/modules/opendesk/element-web/package.json @@ -9,8 +9,7 @@ "scripts": { "prepare": "vite build", "lint:ts": "tsc --noEmit", - "test": "echo no tests yet", - "vitest": "echo no tests yet" + "test": "echo no tests yet" }, "devDependencies": { "@element-hq/element-web-module-api": "^0.1.0", diff --git a/modules/restricted-guests/synapse/package.json b/modules/restricted-guests/synapse/package.json index 529323342e..868aadef5b 100644 --- a/modules/restricted-guests/synapse/package.json +++ b/modules/restricted-guests/synapse/package.json @@ -17,7 +17,6 @@ "lint:py": "./scripts/run_in_venv.sh tox -e check_codestyle", "lint:fix": "./scripts/run_in_venv.sh tox -e fix_codestyle", "test": "./scripts/run_in_venv.sh tox -e py", - "vitest": "echo \"Nothing to vitest\"", "depcheck": "echo \"Nothing to check\"", "package": "yarn docker:build" }