From: Simon McVittie <smcv@collabora.com>
Date: Tue, 12 Dec 2017 12:33:00 +0000 (+0000)
Subject: spec: Document expected reply for each client-to-server auth command
X-Git-Tag: dbus-1.13.0~46
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2c19572f7a224ae9d7126f5f6d6be458c54a2e44;p=thirdparty%2Fdbus.git

spec: Document expected reply for each client-to-server auth command

Client-to-server auth commands expect a reply, whereas
server-to-client auth commands don't (the client is expected to send
another command that is valid in the new state, but it isn't really
a direct reply to the server-to-client command).

Signed-off-by: Simon McVittie <smcv@collabora.com>
Reviewed-by: Philip Withnall <withnall@endlessm.com>
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=104224
---

diff --git a/doc/dbus-specification.xml b/doc/dbus-specification.xml
index c6e204b61..a3a0bd429 100644
--- a/doc/dbus-specification.xml
+++ b/doc/dbus-specification.xml
@@ -2305,6 +2305,7 @@
       <title>AUTH command</title>
       <para>
         The AUTH command is sent by the client to the server.
+        The server replies with DATA, OK or REJECTED.
       </para>
       <para>
         If an AUTH command has no arguments, it is a request to list
@@ -2338,6 +2339,7 @@
       <title>CANCEL Command</title>
       <para>
         The CANCEL command is sent by the client to the server.
+        The server replies with REJECTED.
       </para>
       <para>
         At any time up to sending the BEGIN command, the client may send a
@@ -2352,6 +2354,7 @@
         The DATA command may come from either client or server, and simply
         contains a hex-encoded block of data to be interpreted
         according to the SASL mechanism in use.
+        If sent by the client, the server replies with DATA, OK or REJECTED.
       </para>
       <para>
         Some SASL mechanisms support sending an "empty string";
@@ -2362,6 +2365,7 @@
       <title>BEGIN Command</title>
       <para>
         The BEGIN command is sent by the client to the server.
+        The server does not reply.
       </para>
       <para>
         The BEGIN command acknowledges that the client has received an
@@ -2438,6 +2442,7 @@
       <title>ERROR Command</title>
       <para>
         The ERROR command can be sent in either direction.
+        If sent by the client, the server replies with REJECTED.
       </para>
       <para>
         The ERROR command indicates that either server or client did not
@@ -2468,6 +2473,7 @@
       <title>NEGOTIATE_UNIX_FD Command</title>
       <para>
         The NEGOTIATE_UNIX_FD command is sent by the client to the server.
+        The server replies with AGREE_UNIX_FD or ERROR.
       </para>
       <para>
         The NEGOTIATE_UNIX_FD command indicates that the client