1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
# Copyright (c) 2022 Tulir Asokan
#
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
from __future__ import annotations
from typing import Any, ClassVar
from abc import ABC
import json
import os
import re
import secrets
import time
from mautrix.util.config import (
BaseFileConfig,
BaseValidatableConfig,
ConfigUpdateHelper,
ForbiddenDefault,
yaml,
)
class BaseBridgeConfig(BaseFileConfig, BaseValidatableConfig, ABC):
env_prefix: str | None = None
registration_path: str
_registration: dict | None
_check_tokens: bool
env: dict[str, Any]
def __init__(
self, path: str, registration_path: str, base_path: str, env_prefix: str | None = None
) -> None:
super().__init__(path, base_path)
self.registration_path = registration_path
self._registration = None
self._check_tokens = True
self.env = {}
if not self.env_prefix:
self.env_prefix = env_prefix
if self.env_prefix:
env_prefix = f"{self.env_prefix}_"
for key, value in os.environ.items():
if not key.startswith(env_prefix):
continue
key = key.removeprefix(env_prefix)
if value.startswith("json::"):
value = json.loads(value.removeprefix("json::"))
self.env[key] = value
def __getitem__(self, item: str) -> Any:
if self.env:
try:
sanitized_item = item.replace(".", "_").replace("[", "").replace("]", "").upper()
return self.env[sanitized_item]
except KeyError:
pass
return super().__getitem__(item)
def save(self) -> None:
super().save()
if self._registration and self.registration_path:
with open(self.registration_path, "w") as stream:
yaml.dump(self._registration, stream)
@staticmethod
def _new_token() -> str:
return secrets.token_urlsafe(48)
@property
def forbidden_defaults(self) -> list[ForbiddenDefault]:
return [
ForbiddenDefault("homeserver.address", "https://example.com"),
ForbiddenDefault("homeserver.address", "https://matrix.example.com"),
ForbiddenDefault("homeserver.domain", "example.com"),
] + (
[
ForbiddenDefault(
"appservice.as_token",
"This value is generated when generating the registration",
"Did you forget to generate the registration?",
),
ForbiddenDefault(
"appservice.hs_token",
"This value is generated when generating the registration",
"Did you forget to generate the registration?",
),
]
if self._check_tokens
else []
)
def do_update(self, helper: ConfigUpdateHelper) -> None:
copy, copy_dict = helper.copy, helper.copy_dict
copy("homeserver.address")
copy("homeserver.domain")
copy("homeserver.verify_ssl")
copy("homeserver.http_retry_count")
copy("homeserver.connection_limit")
copy("homeserver.status_endpoint")
copy("homeserver.message_send_checkpoint_endpoint")
copy("homeserver.async_media")
if self.get("homeserver.asmux", False):
helper.base["homeserver.software"] = "asmux"
else:
copy("homeserver.software")
copy("appservice.address")
copy("appservice.hostname")
copy("appservice.port")
copy("appservice.max_body_size")
copy("appservice.tls_cert")
copy("appservice.tls_key")
if "appservice.database" in self and self["appservice.database"].startswith("sqlite:///"):
helper.base["appservice.database"] = self["appservice.database"].replace(
"sqlite:///", "sqlite:"
)
else:
copy("appservice.database")
copy("appservice.database_opts")
copy("appservice.id")
copy("appservice.bot_username")
copy("appservice.bot_displayname")
copy("appservice.bot_avatar")
copy("appservice.as_token")
copy("appservice.hs_token")
copy("appservice.ephemeral_events")
copy("bridge.management_room_text.welcome")
copy("bridge.management_room_text.welcome_connected")
copy("bridge.management_room_text.welcome_unconnected")
copy("bridge.management_room_text.additional_help")
copy("bridge.management_room_multiple_messages")
copy("bridge.encryption.allow")
copy("bridge.encryption.default")
copy("bridge.encryption.require")
copy("bridge.encryption.appservice")
copy("bridge.encryption.delete_keys.delete_outbound_on_ack")
copy("bridge.encryption.delete_keys.dont_store_outbound")
copy("bridge.encryption.delete_keys.ratchet_on_decrypt")
copy("bridge.encryption.delete_keys.delete_fully_used_on_decrypt")
copy("bridge.encryption.delete_keys.delete_prev_on_new_session")
copy("bridge.encryption.delete_keys.delete_on_device_delete")
copy("bridge.encryption.delete_keys.periodically_delete_expired")
copy("bridge.encryption.delete_keys.delete_outdated_inbound")
copy("bridge.encryption.verification_levels.receive")
copy("bridge.encryption.verification_levels.send")
copy("bridge.encryption.verification_levels.share")
copy("bridge.encryption.allow_key_sharing")
if self.get("bridge.encryption.key_sharing.allow", False):
helper.base["bridge.encryption.allow_key_sharing"] = True
require_verif = self.get("bridge.encryption.key_sharing.require_verification", True)
require_cs = self.get("bridge.encryption.key_sharing.require_cross_signing", False)
if require_verif:
helper.base["bridge.encryption.verification_levels.share"] = "verified"
elif not require_cs:
helper.base["bridge.encryption.verification_levels.share"] = "unverified"
# else: default (cross-signed-tofu)
copy("bridge.encryption.rotation.enable_custom")
copy("bridge.encryption.rotation.milliseconds")
copy("bridge.encryption.rotation.messages")
copy("bridge.encryption.rotation.disable_device_change_key_rotation")
copy("bridge.relay.enabled")
copy_dict("bridge.relay.message_formats", override_existing_map=False)
copy("manhole.enabled")
copy("manhole.path")
copy("manhole.whitelist")
copy("logging")
@property
def namespaces(self) -> dict[str, list[dict[str, Any]]]:
"""
Generate the user ID and room alias namespace config for the registration as specified in
https://matrix.org/docs/spec/application_service/r0.1.0.html#application-services
"""
homeserver = self["homeserver.domain"]
regex_ph = f"regexplaceholder{int(time.time())}"
username_format = self["bridge.username_template"].format(userid=regex_ph)
alias_format = (
self["bridge.alias_template"].format(groupname=regex_ph)
if "bridge.alias_template" in self
else None
)
return {
"users": [
{
"exclusive": True,
"regex": re.escape(f"@{username_format}:{homeserver}").replace(regex_ph, ".*"),
}
],
"aliases": (
[
{
"exclusive": True,
"regex": re.escape(f"#{alias_format}:{homeserver}").replace(
regex_ph, ".*"
),
}
]
if alias_format
else []
),
}
def generate_registration(self) -> None:
self["appservice.as_token"] = self._new_token()
self["appservice.hs_token"] = self._new_token()
namespaces = self.namespaces
bot_username = self["appservice.bot_username"]
homeserver_domain = self["homeserver.domain"]
namespaces.setdefault("users", []).append(
{
"exclusive": True,
"regex": re.escape(f"@{bot_username}:{homeserver_domain}"),
}
)
self._registration = {
"id": self["appservice.id"],
"as_token": self["appservice.as_token"],
"hs_token": self["appservice.hs_token"],
"namespaces": namespaces,
"url": self["appservice.address"],
"sender_localpart": self._new_token(),
"rate_limited": False,
}
if self["appservice.ephemeral_events"]:
self._registration["de.sorunome.msc2409.push_ephemeral"] = True
self._registration["push_ephemeral"] = True
|
