]> git.ipfire.org Git - thirdparty/dbus.git/commitdiff
spec: Document the direction of each auth command
authorSimon McVittie <smcv@collabora.com>
Tue, 12 Dec 2017 12:31:20 +0000 (12:31 +0000)
committerSimon McVittie <smcv@collabora.com>
Thu, 11 Jan 2018 18:23:54 +0000 (18:23 +0000)
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

doc/dbus-specification.xml

index 2852411e03f771c324078d6fb7f3ceab5e3acde2..c6e204b615071e8b95858561db8833c7c67900f5 100644 (file)
     </sect2>
     <sect2 id="auth-command-auth">
       <title>AUTH command</title>
+      <para>
+        The AUTH command is sent by the client to the server.
+      </para>
       <para>
         If an AUTH command has no arguments, it is a request to list
         available mechanisms. The server must respond with a REJECTED
     </sect2>
     <sect2 id="auth-command-cancel">
       <title>CANCEL Command</title>
+      <para>
+        The CANCEL command is sent by the client to the server.
+      </para>
       <para>
         At any time up to sending the BEGIN command, the client may send a
         CANCEL command. On receiving the CANCEL command, the server must
     </sect2>
     <sect2 id="auth-command-begin">
       <title>BEGIN Command</title>
+      <para>
+        The BEGIN command is sent by the client to the server.
+      </para>
       <para>
         The BEGIN command acknowledges that the client has received an
         OK command from the server and completed any feature negotiation
     </sect2>
     <sect2 id="auth-command-rejected">
       <title>REJECTED Command</title>
+      <para>
+        The REJECTED command is sent by the server to the client.
+      </para>
       <para>
         The REJECTED command indicates that the current authentication
         exchange has failed, and further exchange of DATA is inappropriate.
     </sect2>
     <sect2 id="auth-command-ok">
       <title>OK Command</title>
+      <para>
+        The OK command is sent by the server to the client.
+      </para>
       <para>
         The OK command indicates that the client has been
         authenticated. The client may now proceed with negotiating
     </sect2>
     <sect2 id="auth-command-error">
       <title>ERROR Command</title>
+      <para>
+        The ERROR command can be sent in either direction.
+      </para>
       <para>
         The ERROR command indicates that either server or client did not
         know a command, does not accept the given command in the current
     </sect2>
     <sect2 id="auth-command-negotiate-unix-fd">
       <title>NEGOTIATE_UNIX_FD Command</title>
+      <para>
+        The NEGOTIATE_UNIX_FD command is sent by the client to the server.
+      </para>
       <para>
         The NEGOTIATE_UNIX_FD command indicates that the client
         supports Unix file descriptor passing. This command may only
     </sect2>
     <sect2 id="auth-command-agree-unix-fd">
       <title>AGREE_UNIX_FD Command</title>
+      <para>
+        The AGREE_UNIX_FD command is sent by the server to the client.
+      </para>
       <para>
         The AGREE_UNIX_FD command indicates that the server supports
         Unix file descriptor passing. This command may only be sent