From 17eaa432e500253f2d7c8a305050a0f5b92b7aa9 Mon Sep 17 00:00:00 2001 From: Eric Eastwood Date: Wed, 28 Oct 2026 09:54:31 -0500 Subject: [PATCH] Clarify that manhole uses SSH (not Telnet) (#20417) Spawning from looking at a [security advisory](https://github.com/element-hq/synapse/security/dependabot/241) but it doesn't apply because we don't use Telnet. Updating our erroneous Telnet references to make it more clear that it doesn't apply to us. Relevant code showing that we initialize a *SSH* listener: https://github.com/element-hq/synapse/blob/bde63a807e81c1b1f36e983b9f1874011181a13d/synapse/util/manhole.py#L74-L117 --- changelog.d/20417.doc | 1 + docs/usage/configuration/config_documentation.md | 2 +- schema/synapse-config.schema.yaml | 2 +- synapse/config/server.py | 2 +- 4 files changed, 4 insertions(+), 3 deletions(-) create mode 100644 changelog.d/20417.doc diff --git a/changelog.d/20417.doc b/changelog.d/20417.doc new file mode 100644 index 0000000000..f89beb24bf --- /dev/null +++ b/changelog.d/20417.doc @@ -0,0 +1 @@ +Clarify config docs that manhole uses SSH (not Telnet). diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index 96a257571a..2be56d6f22 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -613,7 +613,7 @@ listeners: --- ### `manhole` -*(integer|null)* Turn on the Twisted telnet manhole service on the given port. +*(integer|null)* Turn on the Twisted manhole service on the given port. This can also be set by the `--manhole` argument when starting Synapse. diff --git a/schema/synapse-config.schema.yaml b/schema/synapse-config.schema.yaml index 22ed084c72..3f7ff39ea0 100644 --- a/schema/synapse-config.schema.yaml +++ b/schema/synapse-config.schema.yaml @@ -670,7 +670,7 @@ properties: manhole: type: ["integer", "null"] description: >- - Turn on the Twisted telnet manhole service on the given port. + Turn on the Twisted manhole service on the given port. This can also be set by the `--manhole` argument when starting Synapse. diff --git a/synapse/config/server.py b/synapse/config/server.py index c02a50211b..b3a4cd3399 100644 --- a/synapse/config/server.py +++ b/synapse/config/server.py @@ -1088,7 +1088,7 @@ class ServerConfig(Config): metavar="PORT", dest="manhole", type=int, - help="Turn on the twisted telnet manhole service on the given port.", + help="Turn on the twisted manhole service on the given port.", ) def read_gc_intervals(self, durations: Any) -> tuple[float, float, float] | None: