summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSimon McVittie <smcv@collabora.com>2017-12-12 12:31:20 +0000
committerSimon McVittie <smcv@collabora.com>2018-01-11 18:23:54 +0000
commit553ca04550564594bc3ff291770636ec4c3324a5 (patch)
treedc60dca4cf202d25794f2be8853f50c10e24591c /doc
parent0436be576cd2ae6e999d07f7baf39300312c4d7e (diff)
downloaddbus-553ca04550564594bc3ff291770636ec4c3324a5.tar.gz
spec: Document the direction of each auth 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
Diffstat (limited to 'doc')
-rw-r--r--doc/dbus-specification.xml24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/dbus-specification.xml b/doc/dbus-specification.xml
index 2852411e..c6e204b6 100644
--- a/doc/dbus-specification.xml
+++ b/doc/dbus-specification.xml
@@ -2304,6 +2304,9 @@
<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
command listing the mechanisms it understands, or with an error.
@@ -2334,6 +2337,9 @@
<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
send a REJECTED command and abort the current authentication
@@ -2355,6 +2361,9 @@
<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
that it wishes to do, and declares that the stream of messages
@@ -2376,6 +2385,9 @@
<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.
The client would normally try another mechanism, or try providing
@@ -2391,6 +2403,9 @@
<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
Unix file descriptor passing. To do that it shall send
@@ -2422,6 +2437,9 @@
<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
context, or did not understand the arguments to the command. This
@@ -2449,6 +2467,9 @@
<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
be sent after the connection is authenticated, i.e. after OK
@@ -2469,6 +2490,9 @@
<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
after the connection is authenticated, and the client sent