spec, dbus-daemon(1): Recommend against remote TCP for debugging

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=106004
Reviewed-by: Ralf Habacker <ralf.habacker@freenet.de>
Reviewed-by: Philip Withnall <withnall@endlessm.com>
[smcv: Add a TODO comment as suggested]
Signed-off-by: Simon McVittie <smcv@collabora.com>

diff --git a/doc/dbus-daemon.1.xml.in b/doc/dbus-daemon.1.xml.in
index b0e0aae05fb7c9a527da855512386a28466c434a..3761f7e0a3fc15affcef867e2d42cd83b66f3c49 100644 (file)
--- a/doc/dbus-daemon.1.xml.in
+++ b/doc/dbus-daemon.1.xml.in
@@ -415,6 +415,16 @@ a transport name plus possible parameters/options.</para>
   configuring the well-known system bus or the well-known session
   bus to listen on a non-loopback TCP address is insecure.
 </para>
+<para>
+  Developers are sometimes tempted to use remote TCP as a debugging
+  tool. However, if this functionality is left enabled in finished
+  products, the result will be dangerously insecure. Instead of
+  using remote TCP, developers should <ulink
+    url="https://lists.freedesktop.org/archives/dbus/2018-April/017447.html"
+    >relay connections via Secure Shell or a similar protocol</ulink>.
+  <!-- TODO: Ideally someone would write a more formal guide to
+       remote D-Bus debugging, and we could link to that instead -->
+</para>
 
 <para>Example: &lt;listen&gt;unix:path=/tmp/foo&lt;/listen&gt;</para>
 

diff --git a/doc/dbus-specification.xml b/doc/dbus-specification.xml
index b60868f5a3e0f036648d1c76a67e9ceb4d4ca7e0..6ed317ff6f73ff573ed1c9c36a96883b292b4408 100644 (file)
--- a/doc/dbus-specification.xml
+++ b/doc/dbus-specification.xml
@@ -3730,6 +3730,16 @@
         credentials over a TCP connection, so the EXTERNAL authentication
         mechanism does not work for this transport.
       </para>
+      <para>
+        Developers are sometimes tempted to use remote TCP as a debugging
+        tool. However, if this functionality is left enabled in finished
+        products, the result will be dangerously insecure. Instead of
+        using remote TCP, developers should <ulink
+          url="https://lists.freedesktop.org/archives/dbus/2018-April/017447.html"
+          >relay connections via Secure Shell or a similar protocol</ulink>.
+        <!-- TODO: Ideally someone would write a more formal guide to
+             remote D-Bus debugging, and we could link to that instead -->
+      </para>
       <para>
         All <literal>tcp</literal> addresses are listenable.
         <literal>tcp</literal> addresses in which both