doc/dbus-specification.xml

   1 <?xml version="1.0" standalone="no" ?>
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
   4 [
   5 ]>
   6
   7 <article id="index">
   8   <articleinfo>
   9     <title>D-Bus Specification</title>
  10     <releaseinfo>Version 0.14</releaseinfo>
  11     <date>May 12, 2010</date>
  12     <authorgroup>
  13       <author>
  14         <firstname>Havoc</firstname>
  15         <surname>Pennington</surname>
  16         <affiliation>
  17           <orgname>Red Hat, Inc.</orgname>
  18           <address>
  19             <email>hp@pobox.com</email>
  20           </address>
  21         </affiliation>
  22       </author>
  23       <author>
  24         <firstname>Anders</firstname>
  25         <surname>Carlsson</surname>
  26         <affiliation>
  27           <orgname>CodeFactory AB</orgname>
  28           <address>
  29             <email>andersca@codefactory.se</email>
  30           </address>
  31         </affiliation>
  32       </author>
  33       <author>
  34         <firstname>Alexander</firstname>
  35         <surname>Larsson</surname>
  36         <affiliation>
  37           <orgname>Red Hat, Inc.</orgname>
  38           <address>
  39             <email>alexl@redhat.com</email>
  40           </address>
  41         </affiliation>
  42       </author>
  43     </authorgroup>
  44   </articleinfo>
  45
  46   <sect1 id="introduction">
  47     <title>Introduction</title>
  48     <para>
  49       D-Bus is a system for low-latency, low-overhead, easy to use
  50       interprocess communication (IPC). In more detail:
  51       <itemizedlist>
  52         <listitem>
  53           <para>
  54             D-Bus is <emphasis>low-latency</emphasis> because it is designed
  55             to avoid round trips and allow asynchronous operation, much like
  56             the X protocol.
  57           </para>
  58         </listitem>
  59         <listitem>
  60           <para>
  61             D-Bus is <emphasis>low-overhead</emphasis> because it uses a
  62             binary protocol, and does not have to convert to and from a text
  63             format such as XML. Because D-Bus is intended for potentially
  64             high-resolution same-machine IPC, not primarily for Internet IPC,
  65             this is an interesting optimization.
  66           </para>
  67         </listitem>
  68         <listitem>
  69           <para>
  70             D-Bus is <emphasis>easy to use</emphasis> because it works in terms
  71             of <firstterm>messages</firstterm> rather than byte streams, and
  72             automatically handles a lot of the hard IPC issues. Also, the D-Bus
  73             library is designed to be wrapped in a way that lets developers use
  74             their framework's existing object/type system, rather than learning
  75             a new one specifically for IPC.
  76           </para>
  77         </listitem>
  78       </itemizedlist>
  79     </para>
  80
  81     <para>
  82       The base D-Bus protocol is a one-to-one (peer-to-peer or client-server)
  83       protocol, specified in <xref linkend="message-protocol"/>. That is, it is
  84       a system for one application to talk to a single other
  85       application. However, the primary intended application of the protocol is the
  86       D-Bus <firstterm>message bus</firstterm>, specified in <xref
  87       linkend="message-bus"/>. The message bus is a special application that
  88       accepts connections from multiple other applications, and forwards
  89       messages among them.
  90     </para>
  91
  92     <para>
  93       Uses of D-Bus include notification of system changes (notification of when
  94       a camera is plugged in to a computer, or a new version of some software
  95       has been installed), or desktop interoperability, for example a file
  96       monitoring service or a configuration service.
  97     </para>
  98
  99     <para>
 100       D-Bus is designed for two specific use cases:
 101       <itemizedlist>
 102         <listitem>
 103           <para>
 104             A "system bus" for notifications from the system to user sessions,
 105             and to allow the system to request input from user sessions.
 106           </para>
 107         </listitem>
 108         <listitem>
 109           <para>
 110             A "session bus" used to implement desktop environments such as
 111             GNOME and KDE.
 112           </para>
 113         </listitem>
 114       </itemizedlist>
 115       D-Bus is not intended to be a generic IPC system for any possible
 116       application, and intentionally omits many features found in other
 117       IPC systems for this reason.
 118     </para>
 119
 120     <para>
 121       At the same time, the bus daemons offer a number of features not found in
 122       other IPC systems, such as single-owner "bus names" (similar to X
 123       selections), on-demand startup of services, and security policies.
 124       In many ways, these features are the primary motivation for developing
 125       D-Bus; other systems would have sufficed if IPC were the only goal.
 126     </para>
 127
 128     <para>
 129       D-Bus may turn out to be useful in unanticipated applications, but future
 130       versions of this spec and the reference implementation probably will not
 131       incorporate features that interfere with the core use cases.
 132     </para>
 133
 134     <para>
 135       The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
 136       "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
 137       document are to be interpreted as described in RFC 2119. However, the
 138       document could use a serious audit to be sure it makes sense to do
 139       so. Also, they are not capitalized.
 140     </para>
 141
 142     <sect2 id="stability">
 143       <title>Protocol and Specification Stability</title>
 144       <para>
 145         The D-Bus protocol is frozen (only compatible extensions are allowed) as
 146         of November 8, 2006.  However, this specification could still use a fair
 147         bit of work to make interoperable reimplementation possible without
 148         reference to the D-Bus reference implementation. Thus, this
 149         specification is not marked 1.0. To mark it 1.0, we'd like to see
 150         someone invest significant effort in clarifying the specification
 151         language, and growing the specification to cover more aspects of the
 152         reference implementation's behavior.
 153       </para>
 154       <para>
 155         Until this work is complete, any attempt to reimplement D-Bus will
 156         probably require looking at the reference implementation and/or asking
 157         questions on the D-Bus mailing list about intended behavior.
 158         Questions on the list are very welcome.
 159       </para>
 160       <para>
 161         Nonetheless, this document should be a useful starting point and is
 162         to our knowledge accurate, though incomplete.
 163       </para>
 164     </sect2>
 165
 166   </sect1>
 167
 168   <sect1 id="message-protocol">
 169     <title>Message Protocol</title>
 170
 171     <para>
 172       A <firstterm>message</firstterm> consists of a
 173       <firstterm>header</firstterm> and a <firstterm>body</firstterm>. If you
 174       think of a message as a package, the header is the address, and the body
 175       contains the package contents. The message delivery system uses the header
 176       information to figure out where to send the message and how to interpret
 177       it; the recipient interprets the body of the message.
 178     </para>
 179
 180     <para>
 181       The body of the message is made up of zero or more
 182       <firstterm>arguments</firstterm>, which are typed values, such as an
 183       integer or a byte array.
 184     </para>
 185
 186     <para>
 187       Both header and body use the same type system and format for
 188       serializing data. Each type of value has a wire format.
 189       Converting a value from some other representation into the wire
 190       format is called <firstterm>marshaling</firstterm> and converting
 191       it back from the wire format is <firstterm>unmarshaling</firstterm>.
 192     </para>
 193
 194     <sect2 id="message-protocol-signatures">
 195       <title>Type Signatures</title>
 196
 197       <para>
 198         The D-Bus protocol does not include type tags in the marshaled data; a
 199         block of marshaled values must have a known <firstterm>type
 200         signature</firstterm>.  The type signature is made up of <firstterm>type
 201         codes</firstterm>. A type code is an ASCII character representing the
 202         type of a value. Because ASCII characters are used, the type signature
 203         will always form a valid ASCII string. A simple string compare
 204         determines whether two type signatures are equivalent.
 205       </para>
 206
 207       <para>
 208         As a simple example, the type code for 32-bit integer (<literal>INT32</literal>) is
 209         the ASCII character 'i'. So the signature for a block of values
 210         containing a single <literal>INT32</literal> would be:
 211         <programlisting>
 212           "i"
 213         </programlisting>
 214         A block of values containing two <literal>INT32</literal> would have this signature:
 215         <programlisting>
 216           "ii"
 217         </programlisting>
 218       </para>
 219
 220       <para>
 221         All <firstterm>basic</firstterm> types work like
 222         <literal>INT32</literal> in this example. To marshal and unmarshal
 223         basic types, you simply read one value from the data
 224         block corresponding to each type code in the signature.
 225         In addition to basic types, there are four <firstterm>container</firstterm>
 226         types: <literal>STRUCT</literal>, <literal>ARRAY</literal>, <literal>VARIANT</literal>,
 227         and <literal>DICT_ENTRY</literal>.
 228       </para>
 229
 230       <para>
 231         <literal>STRUCT</literal> has a type code, ASCII character 'r', but this type
 232         code does not appear in signatures. Instead, ASCII characters
 233         '(' and ')' are used to mark the beginning and end of the struct.
 234         So for example, a struct containing two integers would have this
 235         signature:
 236         <programlisting>
 237           "(ii)"
 238         </programlisting>
 239         Structs can be nested, so for example a struct containing
 240         an integer and another struct:
 241         <programlisting>
 242           "(i(ii))"
 243         </programlisting>
 244         The value block storing that struct would contain three integers; the
 245         type signature allows you to distinguish "(i(ii))" from "((ii)i)" or
 246         "(iii)" or "iii".
 247       </para>
 248
 249       <para>
 250         The <literal>STRUCT</literal> type code 'r' is not currently used in the D-Bus protocol,
 251         but is useful in code that implements the protocol. This type code
 252         is specified to allow such code to interoperate in non-protocol contexts.
 253       </para>
 254
 255       <para>
 256         Empty structures are not allowed; there must be at least one
 257         type code between the parentheses.
 258       </para>
 259
 260       <para>
 261         <literal>ARRAY</literal> has ASCII character 'a' as type code. The array type code must be
 262         followed by a <firstterm>single complete type</firstterm>. The single
 263         complete type following the array is the type of each array element. So
 264         the simple example is:
 265         <programlisting>
 266           "ai"
 267         </programlisting>
 268         which is an array of 32-bit integers. But an array can be of any type,
 269         such as this array-of-struct-with-two-int32-fields:
 270         <programlisting>
 271           "a(ii)"
 272         </programlisting>
 273         Or this array of array of integer:
 274         <programlisting>
 275           "aai"
 276         </programlisting>
 277       </para>
 278
 279       <para>
 280         The phrase <firstterm>single complete type</firstterm> deserves some
 281         definition. A single complete type is a basic type code, a variant type code,
 282         an array with its element type, or a struct with its fields.
 283         So the following signatures are not single complete types:
 284         <programlisting>
 285           "aa"
 286         </programlisting>
 287         <programlisting>
 288           "(ii"
 289         </programlisting>
 290         <programlisting>
 291           "ii)"
 292         </programlisting>
 293         And the following signatures contain multiple complete types:
 294         <programlisting>
 295           "ii"
 296         </programlisting>
 297         <programlisting>
 298           "aiai"
 299         </programlisting>
 300         <programlisting>
 301           "(ii)(ii)"
 302         </programlisting>
 303         Note however that a single complete type may <emphasis>contain</emphasis>
 304         multiple other single complete types.
 305       </para>
 306
 307       <para>
 308         <literal>VARIANT</literal> has ASCII character 'v' as its type code. A marshaled value of
 309         type <literal>VARIANT</literal> will have the signature of a single complete type as part
 310         of the <emphasis>value</emphasis>.  This signature will be followed by a
 311         marshaled value of that type.
 312       </para>
 313
 314       <para>
 315         A <literal>DICT_ENTRY</literal> works exactly like a struct, but rather
 316         than parentheses it uses curly braces, and it has more restrictions.
 317         The restrictions are: it occurs only as an array element type; it has
 318         exactly two single complete types inside the curly braces; the first
 319         single complete type (the "key") must be a basic type rather than a
 320         container type. Implementations must not accept dict entries outside of
 321         arrays, must not accept dict entries with zero, one, or more than two
 322         fields, and must not accept dict entries with non-basic-typed keys. A
 323         dict entry is always a key-value pair.
 324       </para>
 325
 326       <para>
 327         The first field in the <literal>DICT_ENTRY</literal> is always the key.
 328         A message is considered corrupt if the same key occurs twice in the same
 329         array of <literal>DICT_ENTRY</literal>. However, for performance reasons
 330         implementations are not required to reject dicts with duplicate keys.
 331       </para>
 332
 333       <para>
 334         In most languages, an array of dict entry would be represented as a
 335         map, hash table, or dict object.
 336       </para>
 337
 338       <para>
 339         The following table summarizes the D-Bus types.
 340         <informaltable>
 341           <tgroup cols="3">
 342             <thead>
 343               <row>
 344                 <entry>Conventional Name</entry>
 345                 <entry>Code</entry>
 346                 <entry>Description</entry>
 347               </row>
 348             </thead>
 349             <tbody>
 350               <row>
 351                 <entry><literal>INVALID</literal></entry>
 352                 <entry>0 (ASCII NUL)</entry>
 353                 <entry>Not a valid type code, used to terminate signatures</entry>
 354               </row><row>
 355                 <entry><literal>BYTE</literal></entry>
 356                 <entry>121 (ASCII 'y')</entry>
 357                 <entry>8-bit unsigned integer</entry>
 358               </row><row>
 359                 <entry><literal>BOOLEAN</literal></entry>
 360                 <entry>98 (ASCII 'b')</entry>
 361                 <entry>Boolean value, 0 is <literal>FALSE</literal> and 1 is <literal>TRUE</literal>. Everything else is invalid.</entry>
 362               </row><row>
 363                 <entry><literal>INT16</literal></entry>
 364                 <entry>110 (ASCII 'n')</entry>
 365                 <entry>16-bit signed integer</entry>
 366               </row><row>
 367                 <entry><literal>UINT16</literal></entry>
 368                 <entry>113 (ASCII 'q')</entry>
 369                 <entry>16-bit unsigned integer</entry>
 370               </row><row>
 371                 <entry><literal>INT32</literal></entry>
 372                 <entry>105 (ASCII 'i')</entry>
 373                 <entry>32-bit signed integer</entry>
 374               </row><row>
 375                 <entry><literal>UINT32</literal></entry>
 376                 <entry>117 (ASCII 'u')</entry>
 377                 <entry>32-bit unsigned integer</entry>
 378               </row><row>
 379                 <entry><literal>INT64</literal></entry>
 380                 <entry>120 (ASCII 'x')</entry>
 381                 <entry>64-bit signed integer</entry>
 382               </row><row>
 383                 <entry><literal>UINT64</literal></entry>
 384                 <entry>116 (ASCII 't')</entry>
 385                 <entry>64-bit unsigned integer</entry>
 386               </row><row>
 387                 <entry><literal>DOUBLE</literal></entry>
 388                 <entry>100 (ASCII 'd')</entry>
 389                 <entry>IEEE 754 double</entry>
 390               </row><row>
 391                 <entry><literal>STRING</literal></entry>
 392                 <entry>115 (ASCII 's')</entry>
 393                 <entry>UTF-8 string (<emphasis>must</emphasis> be valid UTF-8). Must be nul terminated and contain no other nul bytes.</entry>
 394               </row><row>
 395                 <entry><literal>OBJECT_PATH</literal></entry>
 396                 <entry>111 (ASCII 'o')</entry>
 397                 <entry>Name of an object instance</entry>
 398               </row><row>
 399                 <entry><literal>SIGNATURE</literal></entry>
 400                 <entry>103 (ASCII 'g')</entry>
 401                 <entry>A type signature</entry>
 402               </row><row>
 403                 <entry><literal>ARRAY</literal></entry>
 404                 <entry>97 (ASCII 'a')</entry>
 405                 <entry>Array</entry>
 406               </row><row>
 407                 <entry><literal>STRUCT</literal></entry>
 408                 <entry>114 (ASCII 'r'), 40 (ASCII '('), 41 (ASCII ')')</entry>
 409                 <entry>Struct</entry>
 410               </row><row>
 411                 <entry><literal>VARIANT</literal></entry>
 412                 <entry>118 (ASCII 'v') </entry>
 413                 <entry>Variant type (the type of the value is part of the value itself)</entry>
 414               </row><row>
 415                 <entry><literal>DICT_ENTRY</literal></entry>
 416                 <entry>101 (ASCII 'e'), 123 (ASCII '{'), 125 (ASCII '}') </entry>
 417                 <entry>Entry in a dict or map (array of key-value pairs)</entry>
 418               </row><row>
 419                 <entry><literal>UNIX_FD</literal></entry>
 420                 <entry>104 (ASCII 'h')</entry>
 421                 <entry>Unix file descriptor</entry>
 422               </row>
 423             </tbody>
 424           </tgroup>
 425         </informaltable>
 426       </para>
 427
 428     </sect2>
 429
 430     <sect2 id="message-protocol-marshaling">
 431       <title>Marshaling (Wire Format)</title>
 432
 433       <para>
 434         Given a type signature, a block of bytes can be converted into typed
 435         values. This section describes the format of the block of bytes.  Byte
 436         order and alignment issues are handled uniformly for all D-Bus types.
 437       </para>
 438
 439       <para>
 440         A block of bytes has an associated byte order. The byte order
 441         has to be discovered in some way; for D-Bus messages, the
 442         byte order is part of the message header as described in
 443         <xref linkend="message-protocol-messages"/>. For now, assume
 444         that the byte order is known to be either little endian or big
 445           endian.
 446       </para>
 447
 448       <para>
 449         Each value in a block of bytes is aligned "naturally," for example
 450         4-byte values are aligned to a 4-byte boundary, and 8-byte values to an
 451         8-byte boundary. To properly align a value, <firstterm>alignment
 452         padding</firstterm> may be necessary. The alignment padding must always
 453         be the minimum required padding to properly align the following value;
 454         and it must always be made up of nul bytes. The alignment padding must
 455         not be left uninitialized (it can't contain garbage), and more padding
 456         than required must not be used.
 457       </para>
 458
 459       <para>
 460         Given all this, the types are marshaled on the wire as follows:
 461         <informaltable>
 462           <tgroup cols="3">
 463             <thead>
 464               <row>
 465                 <entry>Conventional Name</entry>
 466                 <entry>Encoding</entry>
 467                 <entry>Alignment</entry>
 468               </row>
 469             </thead>
 470             <tbody>
 471               <row>
 472                 <entry><literal>INVALID</literal></entry>
 473                 <entry>Not applicable; cannot be marshaled.</entry>
 474                 <entry>N/A</entry>
 475               </row><row>
 476                 <entry><literal>BYTE</literal></entry>
 477                 <entry>A single 8-bit byte.</entry>
 478                 <entry>1</entry>
 479               </row><row>
 480                 <entry><literal>BOOLEAN</literal></entry>
 481                 <entry>As for <literal>UINT32</literal>, but only 0 and 1 are valid values.</entry>
 482                 <entry>4</entry>
 483               </row><row>
 484                 <entry><literal>INT16</literal></entry>
 485                 <entry>16-bit signed integer in the message's byte order.</entry>
 486                 <entry>2</entry>
 487               </row><row>
 488                 <entry><literal>UINT16</literal></entry>
 489                 <entry>16-bit unsigned integer in the message's byte order.</entry>
 490                 <entry>2</entry>
 491               </row><row>
 492                 <entry><literal>INT32</literal></entry>
 493                 <entry>32-bit signed integer in the message's byte order.</entry>
 494                 <entry>4</entry>
 495               </row><row>
 496                 <entry><literal>UINT32</literal></entry>
 497                 <entry>32-bit unsigned integer in the message's byte order.</entry>
 498                 <entry>4</entry>
 499               </row><row>
 500                 <entry><literal>INT64</literal></entry>
 501                 <entry>64-bit signed integer in the message's byte order.</entry>
 502                 <entry>8</entry>
 503               </row><row>
 504                 <entry><literal>UINT64</literal></entry>
 505                 <entry>64-bit unsigned integer in the message's byte order.</entry>
 506                 <entry>8</entry>
 507               </row><row>
 508                 <entry><literal>DOUBLE</literal></entry>
 509                 <entry>64-bit IEEE 754 double in the message's byte order.</entry>
 510                 <entry>8</entry>
 511               </row><row>
 512                 <entry><literal>STRING</literal></entry>
 513                 <entry>A <literal>UINT32</literal> indicating the string's
 514                   length in bytes excluding its terminating nul, followed by
 515                   non-nul string data of the given length, followed by a terminating nul
 516                   byte.
 517                 </entry>
 518                 <entry>
 519                   4 (for the length)
 520                 </entry>
 521               </row><row>
 522                 <entry><literal>OBJECT_PATH</literal></entry>
 523                 <entry>Exactly the same as <literal>STRING</literal> except the
 524                   content must be a valid object path (see below).
 525                 </entry>
 526                 <entry>
 527                   4 (for the length)
 528                 </entry>
 529               </row><row>
 530                 <entry><literal>SIGNATURE</literal></entry>
 531                 <entry>The same as <literal>STRING</literal> except the length is a single
 532                   byte (thus signatures have a maximum length of 255)
 533                   and the content must be a valid signature (see below).
 534                 </entry>
 535                 <entry>
 536                   1
 537                 </entry>
 538               </row><row>
 539                 <entry><literal>ARRAY</literal></entry>
 540                 <entry>
 541                   A <literal>UINT32</literal> giving the length of the array data in bytes, followed by
 542                   alignment padding to the alignment boundary of the array element type,
 543                   followed by each array element. The array length is from the
 544                   end of the alignment padding to the end of the last element,
 545                   i.e. it does not include the padding after the length,
 546                   or any padding after the last element.
 547                   Arrays have a maximum length defined to be 2 to the 26th power or
 548                   67108864. Implementations must not send or accept arrays exceeding this
 549                   length.
 550                 </entry>
 551                 <entry>
 552                   4 (for the length)
 553                 </entry>
 554               </row><row>
 555                 <entry><literal>STRUCT</literal></entry>
 556                 <entry>
 557                   A struct must start on an 8-byte boundary regardless of the
 558                   type of the struct fields. The struct value consists of each
 559                   field marshaled in sequence starting from that 8-byte
 560                   alignment boundary.
 561                 </entry>
 562                 <entry>
 563                   8
 564                 </entry>
 565               </row><row>
 566                 <entry><literal>VARIANT</literal></entry>
 567                 <entry>
 568                   A variant type has a marshaled <literal>SIGNATURE</literal>
 569                   followed by a marshaled value with the type
 570                   given in the signature.
 571                   Unlike a message signature, the variant signature
 572                   can contain only a single complete type.
 573                   So "i", "ai" or "(ii)" is OK, but "ii" is not.
 574                 </entry>
 575                 <entry>
 576                   1 (alignment of the signature)
 577                 </entry>
 578               </row><row>
 579                 <entry><literal>DICT_ENTRY</literal></entry>
 580                 <entry>
 581                   Identical to STRUCT.
 582                 </entry>
 583                 <entry>
 584                   8
 585                 </entry>
 586               </row><row>
 587                 <entry><literal>UNIX_FD</literal></entry>
 588                 <entry>32-bit unsigned integer in the message's byte
 589                 order. The actual file descriptors need to be
 590                 transferred out-of-band via some platform specific
 591                 mechanism. On the wire, values of this type store the index to the
 592                 file descriptor in the array of file descriptors that
 593                 accompany the message.</entry>
 594                 <entry>4</entry>
 595               </row>
 596             </tbody>
 597           </tgroup>
 598         </informaltable>
 599       </para>
 600
 601       <sect3 id="message-protocol-marshaling-object-path">
 602         <title>Valid Object Paths</title>
 603
 604         <para>
 605           An object path is a name used to refer to an object instance.
 606           Conceptually, each participant in a D-Bus message exchange may have
 607           any number of object instances (think of C++ or Java objects) and each
 608           such instance will have a path. Like a filesystem, the object
 609           instances in an application form a hierarchical tree.
 610         </para>
 611
 612         <para>
 613           The following rules define a valid object path. Implementations must
 614           not send or accept messages with invalid object paths.
 615           <itemizedlist>
 616             <listitem>
 617               <para>
 618                 The path may be of any length.
 619               </para>
 620             </listitem>
 621             <listitem>
 622               <para>
 623                 The path must begin with an ASCII '/' (integer 47) character,
 624                 and must consist of elements separated by slash characters.
 625               </para>
 626             </listitem>
 627             <listitem>
 628               <para>
 629                 Each element must only contain the ASCII characters
 630                 "[A-Z][a-z][0-9]_"
 631               </para>
 632             </listitem>
 633             <listitem>
 634               <para>
 635                 No element may be the empty string.
 636               </para>
 637             </listitem>
 638             <listitem>
 639               <para>
 640                 Multiple '/' characters cannot occur in sequence.
 641               </para>
 642             </listitem>
 643             <listitem>
 644               <para>
 645                 A trailing '/' character is not allowed unless the
 646                 path is the root path (a single '/' character).
 647               </para>
 648             </listitem>
 649           </itemizedlist>
 650         </para>
 651
 652       </sect3>
 653
 654
 655       <sect3 id="message-protocol-marshaling-signature">
 656         <title>Valid Signatures</title>
 657         <para>
 658           An implementation must not send or accept invalid signatures.
 659           Valid signatures will conform to the following rules:
 660           <itemizedlist>
 661             <listitem>
 662               <para>
 663                 The signature ends with a nul byte.
 664               </para>
 665             </listitem>
 666             <listitem>
 667               <para>
 668                 The signature is a list of single complete types.
 669                 Arrays must have element types, and structs must
 670                 have both open and close parentheses.
 671               </para>
 672             </listitem>
 673             <listitem>
 674               <para>
 675                 Only type codes and open and close parentheses are
 676                 allowed in the signature. The <literal>STRUCT</literal> type code
 677                 is not allowed in signatures, because parentheses
 678                 are used instead.
 679               </para>
 680             </listitem>
 681             <listitem>
 682               <para>
 683                 The maximum depth of container type nesting is 32 array type
 684                 codes and 32 open parentheses. This implies that the maximum
 685                 total depth of recursion is 64, for an "array of array of array
 686                 of ... struct of struct of struct of ..."  where there are 32
 687                 array and 32 struct.
 688               </para>
 689             </listitem>
 690             <listitem>
 691               <para>
 692                 The maximum length of a signature is 255.
 693               </para>
 694             </listitem>
 695             <listitem>
 696               <para>
 697                 Signatures must be nul-terminated.
 698               </para>
 699             </listitem>
 700           </itemizedlist>
 701         </para>
 702       </sect3>
 703
 704     </sect2>
 705
 706     <sect2 id="message-protocol-messages">
 707       <title>Message Format</title>
 708
 709       <para>
 710         A message consists of a header and a body. The header is a block of
 711         values with a fixed signature and meaning.  The body is a separate block
 712         of values, with a signature specified in the header.
 713       </para>
 714
 715       <para>
 716         The length of the header must be a multiple of 8, allowing the body to
 717         begin on an 8-byte boundary when storing the entire message in a single
 718         buffer. If the header does not naturally end on an 8-byte boundary
 719         up to 7 bytes of nul-initialized alignment padding must be added.
 720       </para>
 721
 722       <para>
 723         The message body need not end on an 8-byte boundary.
 724       </para>
 725
 726       <para>
 727         The maximum length of a message, including header, header alignment padding,
 728         and body is 2 to the 27th power or 134217728. Implementations must not
 729         send or accept messages exceeding this size.
 730       </para>
 731
 732       <para>
 733         The signature of the header is:
 734         <programlisting>
 735           "yyyyuua(yv)"
 736         </programlisting>
 737         Written out more readably, this is:
 738         <programlisting>
 739           BYTE, BYTE, BYTE, BYTE, UINT32, UINT32, ARRAY of STRUCT of (BYTE,VARIANT)
 740         </programlisting>
 741       </para>
 742
 743       <para>
 744         These values have the following meanings:
 745         <informaltable>
 746           <tgroup cols="2">
 747             <thead>
 748               <row>
 749                 <entry>Value</entry>
 750                 <entry>Description</entry>
 751               </row>
 752             </thead>
 753             <tbody>
 754               <row>
 755                 <entry>1st <literal>BYTE</literal></entry>
 756                 <entry>Endianness flag; ASCII 'l' for little-endian
 757                   or ASCII 'B' for big-endian. Both header and body are
 758                 in this endianness.</entry>
 759               </row>
 760               <row>
 761                 <entry>2nd <literal>BYTE</literal></entry>
 762                 <entry><firstterm>Message type</firstterm>. Unknown types must be ignored.
 763                   Currently-defined types are described below.
 764                 </entry>
 765               </row>
 766               <row>
 767                 <entry>3rd <literal>BYTE</literal></entry>
 768                 <entry>Bitwise OR of flags. Unknown flags
 769                   must be ignored. Currently-defined flags are described below.
 770                 </entry>
 771               </row>
 772               <row>
 773                 <entry>4th <literal>BYTE</literal></entry>
 774                 <entry>Major protocol version of the sending application.  If
 775                 the major protocol version of the receiving application does not
 776                 match, the applications will not be able to communicate and the
 777                 D-Bus connection must be disconnected. The major protocol
 778                 version for this version of the specification is 1.
 779                 </entry>
 780               </row>
 781               <row>
 782                 <entry>1st <literal>UINT32</literal></entry>
 783                 <entry>Length in bytes of the message body, starting
 784                   from the end of the header. The header ends after
 785                   its alignment padding to an 8-boundary.
 786                 </entry>
 787               </row>
 788               <row>
 789                 <entry>2nd <literal>UINT32</literal></entry>
 790                 <entry>The serial of this message, used as a cookie
 791                   by the sender to identify the reply corresponding
 792                   to this request. This must not be zero.
 793                 </entry>
 794               </row>
 795               <row>
 796                 <entry><literal>ARRAY</literal> of <literal>STRUCT</literal> of (<literal>BYTE</literal>,<literal>VARIANT</literal>)</entry>
 797                 <entry>An array of zero or more <firstterm>header
 798                   fields</firstterm> where the byte is the field code, and the
 799                   variant is the field value. The message type determines
 800                   which fields are required.
 801                 </entry>
 802               </row>
 803             </tbody>
 804           </tgroup>
 805         </informaltable>
 806       </para>
 807       <para>
 808         <firstterm>Message types</firstterm> that can appear in the second byte
 809         of the header are:
 810         <informaltable>
 811           <tgroup cols="3">
 812             <thead>
 813               <row>
 814                 <entry>Conventional name</entry>
 815                 <entry>Decimal value</entry>
 816                 <entry>Description</entry>
 817               </row>
 818             </thead>
 819             <tbody>
 820               <row>
 821                 <entry><literal>INVALID</literal></entry>
 822                 <entry>0</entry>
 823                 <entry>This is an invalid type.</entry>
 824               </row>
 825               <row>
 826                 <entry><literal>METHOD_CALL</literal></entry>
 827                 <entry>1</entry>
 828                 <entry>Method call.</entry>
 829               </row>
 830               <row>
 831                 <entry><literal>METHOD_RETURN</literal></entry>
 832                 <entry>2</entry>
 833                 <entry>Method reply with returned data.</entry>
 834               </row>
 835               <row>
 836                 <entry><literal>ERROR</literal></entry>
 837                 <entry>3</entry>
 838                 <entry>Error reply. If the first argument exists and is a
 839                 string, it is an error message.</entry>
 840               </row>
 841               <row>
 842                 <entry><literal>SIGNAL</literal></entry>
 843                 <entry>4</entry>
 844                 <entry>Signal emission.</entry>
 845               </row>
 846             </tbody>
 847           </tgroup>
 848         </informaltable>
 849       </para>
 850       <para>
 851         Flags that can appear in the third byte of the header:
 852         <informaltable>
 853           <tgroup cols="3">
 854             <thead>
 855               <row>
 856                 <entry>Conventional name</entry>
 857                 <entry>Hex value</entry>
 858                 <entry>Description</entry>
 859               </row>
 860             </thead>
 861             <tbody>
 862               <row>
 863                 <entry><literal>NO_REPLY_EXPECTED</literal></entry>
 864                 <entry>0x1</entry>
 865                 <entry>This message does not expect method return replies or
 866                 error replies; the reply can be omitted as an
 867                 optimization. However, it is compliant with this specification
 868                 to return the reply despite this flag and the only harm
 869                   from doing so is extra network traffic.
 870                 </entry>
 871               </row>
 872               <row>
 873                 <entry><literal>NO_AUTO_START</literal></entry>
 874                 <entry>0x2</entry>
 875                 <entry>The bus must not launch an owner
 876                   for the destination name in response to this message.
 877                 </entry>
 878               </row>
 879             </tbody>
 880           </tgroup>
 881         </informaltable>
 882       </para>
 883
 884       <sect3 id="message-protocol-header-fields">
 885         <title>Header Fields</title>
 886
 887         <para>
 888           The array at the end of the header contains <firstterm>header
 889           fields</firstterm>, where each field is a 1-byte field code followed
 890           by a field value. A header must contain the required header fields for
 891           its message type, and zero or more of any optional header
 892           fields. Future versions of this protocol specification may add new
 893           fields. Implementations must ignore fields they do not
 894           understand. Implementations must not invent their own header fields;
 895           only changes to this specification may introduce new header fields.
 896         </para>
 897
 898         <para>
 899           Again, if an implementation sees a header field code that it does not
 900           expect, it must ignore that field, as it will be part of a new
 901           (but compatible) version of this specification. This also applies
 902           to known header fields appearing in unexpected messages, for
 903           example: if a signal has a reply serial it must be ignored
 904           even though it has no meaning as of this version of the spec.
 905         </para>
 906
 907         <para>
 908           However, implementations must not send or accept known header fields
 909           with the wrong type stored in the field value. So for example a
 910           message with an <literal>INTERFACE</literal> field of type
 911           <literal>UINT32</literal> would be considered corrupt.
 912         </para>
 913
 914         <para>
 915           Here are the currently-defined header fields:
 916           <informaltable>
 917             <tgroup cols="5">
 918               <thead>
 919                 <row>
 920                   <entry>Conventional Name</entry>
 921                   <entry>Decimal Code</entry>
 922                   <entry>Type</entry>
 923                   <entry>Required In</entry>
 924                   <entry>Description</entry>
 925                 </row>
 926               </thead>
 927               <tbody>
 928                 <row>
 929                   <entry><literal>INVALID</literal></entry>
 930                   <entry>0</entry>
 931                   <entry>N/A</entry>
 932                   <entry>not allowed</entry>
 933                   <entry>Not a valid field name (error if it appears in a message)</entry>
 934                 </row>
 935                 <row>
 936                   <entry><literal>PATH</literal></entry>
 937                   <entry>1</entry>
 938                   <entry><literal>OBJECT_PATH</literal></entry>
 939                   <entry><literal>METHOD_CALL</literal>, <literal>SIGNAL</literal></entry>
 940                   <entry>The object to send a call to,
 941                     or the object a signal is emitted from.
 942                     The special path
 943                     <literal>/org/freedesktop/DBus/Local</literal> is reserved;
 944                     implementations should not send messages with this path,
 945                     and the reference implementation of the bus daemon will
 946                     disconnect any application that attempts to do so.
 947                   </entry>
 948                 </row>
 949                 <row>
 950                   <entry><literal>INTERFACE</literal></entry>
 951                   <entry>2</entry>
 952                   <entry><literal>STRING</literal></entry>
 953                   <entry><literal>SIGNAL</literal></entry>
 954                   <entry>
 955                     The interface to invoke a method call on, or
 956                     that a signal is emitted from. Optional for
 957                     method calls, required for signals.
 958                     The special interface
 959                     <literal>org.freedesktop.DBus.Local</literal> is reserved;
 960                     implementations should not send messages with this
 961                     interface, and the reference implementation of the bus
 962                     daemon will disconnect any application that attempts to
 963                     do so.
 964                   </entry>
 965                 </row>
 966                 <row>
 967                   <entry><literal>MEMBER</literal></entry>
 968                   <entry>3</entry>
 969                   <entry><literal>STRING</literal></entry>
 970                   <entry><literal>METHOD_CALL</literal>, <literal>SIGNAL</literal></entry>
 971                   <entry>The member, either the method name or signal name.</entry>
 972                 </row>
 973                 <row>
 974                   <entry><literal>ERROR_NAME</literal></entry>
 975                   <entry>4</entry>
 976                   <entry><literal>STRING</literal></entry>
 977                   <entry><literal>ERROR</literal></entry>
 978                   <entry>The name of the error that occurred, for errors</entry>
 979                 </row>
 980                 <row>
 981                   <entry><literal>REPLY_SERIAL</literal></entry>
 982                   <entry>5</entry>
 983                   <entry><literal>UINT32</literal></entry>
 984                   <entry><literal>ERROR</literal>, <literal>METHOD_RETURN</literal></entry>
 985                   <entry>The serial number of the message this message is a reply
 986                     to. (The serial number is the second <literal>UINT32</literal> in the header.)</entry>
 987                 </row>
 988                 <row>
 989                   <entry><literal>DESTINATION</literal></entry>
 990                   <entry>6</entry>
 991                   <entry><literal>STRING</literal></entry>
 992                   <entry>optional</entry>
 993                   <entry>The name of the connection this message is intended for.
 994                     Only used in combination with the message bus, see
 995                     <xref linkend="message-bus"/>.</entry>
 996                 </row>
 997                 <row>
 998                   <entry><literal>SENDER</literal></entry>
 999                   <entry>7</entry>
1000                   <entry><literal>STRING</literal></entry>
1001                   <entry>optional</entry>
1002                   <entry>Unique name of the sending connection.
1003                     The message bus fills in this field so it is reliable; the field is
1004                     only meaningful in combination with the message bus.</entry>
1005                 </row>
1006                 <row>
1007                   <entry><literal>SIGNATURE</literal></entry>
1008                   <entry>8</entry>
1009                   <entry><literal>SIGNATURE</literal></entry>
1010                   <entry>optional</entry>
1011                   <entry>The signature of the message body.
1012                   If omitted, it is assumed to be the
1013                   empty signature "" (i.e. the body must be 0-length).</entry>
1014                 </row>
1015                 <row>
1016                   <entry><literal>UNIX_FDS</literal></entry>
1017                   <entry>9</entry>
1018                   <entry><literal>UINT32</literal></entry>
1019                   <entry>optional</entry>
1020                   <entry>The number of Unix file descriptors that
1021                   accompany the message.  If omitted, it is assumed
1022                   that no Unix file descriptors accompany the
1023                   message. The actual file descriptors need to be
1024                   transferred via platform specific mechanism
1025                   out-of-band. They must be sent at the same time as
1026                   part of the message itself. They may not be sent
1027                   before the first byte of the message itself is
1028                   transferred or after the last byte of the message
1029                   itself.</entry>
1030                 </row>
1031               </tbody>
1032             </tgroup>
1033           </informaltable>
1034         </para>
1035       </sect3>
1036     </sect2>
1037
1038     <sect2 id="message-protocol-names">
1039       <title>Valid Names</title>
1040       <para>
1041         The various names in D-Bus messages have some restrictions.
1042       </para>
1043       <para>
1044         There is a <firstterm>maximum name length</firstterm>
1045         of 255 which applies to bus names, interfaces, and members.
1046       </para>
1047       <sect3 id="message-protocol-names-interface">
1048         <title>Interface names</title>
1049         <para>
1050           Interfaces have names with type <literal>STRING</literal>, meaning that
1051           they must be valid UTF-8. However, there are also some
1052           additional restrictions that apply to interface names
1053           specifically:
1054           <itemizedlist>
1055             <listitem><para>Interface names are composed of 1 or more elements separated by
1056                 a period ('.') character. All elements must contain at least
1057                 one character.
1058                 </para>
1059             </listitem>
1060             <listitem><para>Each element must only contain the ASCII characters
1061                 "[A-Z][a-z][0-9]_" and must not begin with a digit.
1062                 </para>
1063             </listitem>
1064
1065             <listitem><para>Interface names must contain at least one '.' (period)
1066               character (and thus at least two elements).
1067               </para></listitem>
1068
1069             <listitem><para>Interface names must not begin with a '.' (period) character.</para></listitem>
1070             <listitem><para>Interface names must not exceed the maximum name length.</para></listitem>
1071           </itemizedlist>
1072         </para>
1073       </sect3>
1074       <sect3 id="message-protocol-names-bus">
1075         <title>Bus names</title>
1076         <para>
1077           Connections have one or more bus names associated with them.
1078           A connection has exactly one bus name that is a unique connection
1079           name. The unique connection name remains with the connection for
1080           its entire lifetime.
1081           A bus name is of type <literal>STRING</literal>,
1082           meaning that it must be valid UTF-8. However, there are also
1083           some additional restrictions that apply to bus names
1084           specifically:
1085           <itemizedlist>
1086             <listitem><para>Bus names that start with a colon (':')
1087                 character are unique connection names.
1088                 </para>
1089             </listitem>
1090             <listitem><para>Bus names are composed of 1 or more elements separated by
1091                 a period ('.') character. All elements must contain at least
1092                 one character.
1093                 </para>
1094             </listitem>
1095             <listitem><para>Each element must only contain the ASCII characters
1096                 "[A-Z][a-z][0-9]_-". Only elements that are part of a unique
1097                 connection name may begin with a digit, elements in
1098                 other bus names must not begin with a digit.
1099                 </para>
1100             </listitem>
1101
1102             <listitem><para>Bus names must contain at least one '.' (period)
1103               character (and thus at least two elements).
1104               </para></listitem>
1105
1106             <listitem><para>Bus names must not begin with a '.' (period) character.</para></listitem>
1107             <listitem><para>Bus names must not exceed the maximum name length.</para></listitem>
1108           </itemizedlist>
1109         </para>
1110         <para>
1111           Note that the hyphen ('-') character is allowed in bus names but
1112           not in interface names.
1113         </para>
1114       </sect3>
1115       <sect3 id="message-protocol-names-member">
1116         <title>Member names</title>
1117         <para>
1118           Member (i.e. method or signal) names:
1119           <itemizedlist>
1120             <listitem><para>Must only contain the ASCII characters
1121                 "[A-Z][a-z][0-9]_" and may not begin with a
1122                 digit.</para></listitem>
1123             <listitem><para>Must not contain the '.' (period) character.</para></listitem>
1124             <listitem><para>Must not exceed the maximum name length.</para></listitem>
1125             <listitem><para>Must be at least 1 byte in length.</para></listitem>
1126           </itemizedlist>
1127         </para>
1128       </sect3>
1129       <sect3 id="message-protocol-names-error">
1130         <title>Error names</title>
1131         <para>
1132           Error names have the same restrictions as interface names.
1133         </para>
1134       </sect3>
1135     </sect2>
1136
1137     <sect2 id="message-protocol-types">
1138       <title>Message Types</title>
1139       <para>
1140         Each of the message types (<literal>METHOD_CALL</literal>, <literal>METHOD_RETURN</literal>, <literal>ERROR</literal>, and
1141         <literal>SIGNAL</literal>) has its own expected usage conventions and header fields.
1142         This section describes these conventions.
1143       </para>
1144       <sect3 id="message-protocol-types-method">
1145         <title>Method Calls</title>
1146         <para>
1147           Some messages invoke an operation on a remote object.  These are
1148           called method call messages and have the type tag <literal>METHOD_CALL</literal>. Such
1149           messages map naturally to methods on objects in a typical program.
1150         </para>
1151         <para>
1152           A method call message is required to have a <literal>MEMBER</literal> header field
1153           indicating the name of the method. Optionally, the message has an
1154           <literal>INTERFACE</literal> field giving the interface the method is a part of. In the
1155           absence of an <literal>INTERFACE</literal> field, if two interfaces on the same object have
1156           a method with the same name, it is undefined which of the two methods
1157           will be invoked. Implementations may also choose to return an error in
1158           this ambiguous case. However, if a method name is unique
1159           implementations must not require an interface field.
1160         </para>
1161         <para>
1162           Method call messages also include a <literal>PATH</literal> field
1163           indicating the object to invoke the method on. If the call is passing
1164           through a message bus, the message will also have a
1165           <literal>DESTINATION</literal> field giving the name of the connection
1166           to receive the message.
1167         </para>
1168         <para>
1169           When an application handles a method call message, it is required to
1170           return a reply. The reply is identified by a <literal>REPLY_SERIAL</literal> header field
1171           indicating the serial number of the <literal>METHOD_CALL</literal> being replied to. The
1172           reply can have one of two types; either <literal>METHOD_RETURN</literal> or <literal>ERROR</literal>.
1173         </para>
1174         <para>
1175           If the reply has type <literal>METHOD_RETURN</literal>, the arguments to the reply message
1176           are the return value(s) or "out parameters" of the method call.
1177           If the reply has type <literal>ERROR</literal>, then an "exception" has been thrown,
1178           and the call fails; no return value will be provided. It makes
1179           no sense to send multiple replies to the same method call.
1180         </para>
1181         <para>
1182           Even if a method call has no return values, a <literal>METHOD_RETURN</literal>
1183           reply is required, so the caller will know the method
1184           was successfully processed.
1185         </para>
1186         <para>
1187           The <literal>METHOD_RETURN</literal> or <literal>ERROR</literal> reply message must have the <literal>REPLY_SERIAL</literal>
1188           header field.
1189         </para>
1190         <para>
1191           If a <literal>METHOD_CALL</literal> message has the flag <literal>NO_REPLY_EXPECTED</literal>,
1192           then as an optimization the application receiving the method
1193           call may choose to omit the reply message (regardless of
1194           whether the reply would have been <literal>METHOD_RETURN</literal> or <literal>ERROR</literal>).
1195           However, it is also acceptable to ignore the <literal>NO_REPLY_EXPECTED</literal>
1196           flag and reply anyway.
1197         </para>
1198         <para>
1199           Unless a message has the flag <literal>NO_AUTO_START</literal>, if the
1200           destination name does not exist then a program to own the destination
1201           name will be started before the message is delivered.  The message
1202           will be held until the new program is successfully started or has
1203           failed to start; in case of failure, an error will be returned. This
1204           flag is only relevant in the context of a message bus, it is ignored
1205           during one-to-one communication with no intermediate bus.
1206         </para>
1207         <sect4 id="message-protocol-types-method-apis">
1208           <title>Mapping method calls to native APIs</title>
1209           <para>
1210             APIs for D-Bus may map method calls to a method call in a specific
1211             programming language, such as C++, or may map a method call written
1212             in an IDL to a D-Bus message.
1213           </para>
1214           <para>
1215             In APIs of this nature, arguments to a method are often termed "in"
1216             (which implies sent in the <literal>METHOD_CALL</literal>), or "out" (which implies
1217             returned in the <literal>METHOD_RETURN</literal>). Some APIs such as CORBA also have
1218             "inout" arguments, which are both sent and received, i.e. the caller
1219             passes in a value which is modified. Mapped to D-Bus, an "inout"
1220             argument is equivalent to an "in" argument, followed by an "out"
1221             argument. You can't pass things "by reference" over the wire, so
1222             "inout" is purely an illusion of the in-process API.
1223           </para>
1224           <para>
1225             Given a method with zero or one return values, followed by zero or more
1226             arguments, where each argument may be "in", "out", or "inout", the
1227             caller constructs a message by appending each "in" or "inout" argument,
1228             in order. "out" arguments are not represented in the caller's message.
1229           </para>
1230           <para>
1231             The recipient constructs a reply by appending first the return value
1232             if any, then each "out" or "inout" argument, in order.
1233             "in" arguments are not represented in the reply message.
1234           </para>
1235           <para>
1236             Error replies are normally mapped to exceptions in languages that have
1237             exceptions.
1238           </para>
1239           <para>
1240             In converting from native APIs to D-Bus, it is perhaps nice to
1241             map D-Bus naming conventions ("FooBar") to native conventions
1242             such as "fooBar" or "foo_bar" automatically. This is OK
1243             as long as you can say that the native API is one that
1244             was specifically written for D-Bus. It makes the most sense
1245             when writing object implementations that will be exported
1246             over the bus. Object proxies used to invoke remote D-Bus
1247             objects probably need the ability to call any D-Bus method,
1248             and thus a magic name mapping like this could be a problem.
1249           </para>
1250           <para>
1251             This specification doesn't require anything of native API bindings;
1252             the preceding is only a suggested convention for consistency
1253             among bindings.
1254           </para>
1255         </sect4>
1256       </sect3>
1257
1258       <sect3 id="message-protocol-types-signal">
1259         <title>Signal Emission</title>
1260         <para>
1261           Unlike method calls, signal emissions have no replies.
1262           A signal emission is simply a single message of type <literal>SIGNAL</literal>.
1263           It must have three header fields: <literal>PATH</literal> giving the object
1264           the signal was emitted from, plus <literal>INTERFACE</literal> and <literal>MEMBER</literal> giving
1265           the fully-qualified name of the signal. The <literal>INTERFACE</literal> header is required
1266           for signals, though it is optional for method calls.
1267         </para>
1268       </sect3>
1269
1270       <sect3 id="message-protocol-types-errors">
1271         <title>Errors</title>
1272         <para>
1273           Messages of type <literal>ERROR</literal> are most commonly replies
1274           to a <literal>METHOD_CALL</literal>, but may be returned in reply
1275           to any kind of message. The message bus for example
1276           will return an <literal>ERROR</literal> in reply to a signal emission if
1277           the bus does not have enough memory to send the signal.
1278         </para>
1279         <para>
1280           An <literal>ERROR</literal> may have any arguments, but if the first
1281           argument is a <literal>STRING</literal>, it must be an error message.
1282           The error message may be logged or shown to the user
1283           in some way.
1284         </para>
1285       </sect3>
1286
1287       <sect3 id="message-protocol-types-notation">
1288         <title>Notation in this document</title>
1289         <para>
1290           This document uses a simple pseudo-IDL to describe particular method
1291           calls and signals. Here is an example of a method call:
1292           <programlisting>
1293             org.freedesktop.DBus.StartServiceByName (in STRING name, in UINT32 flags,
1294                                                      out UINT32 resultcode)
1295           </programlisting>
1296           This means <literal>INTERFACE</literal> = org.freedesktop.DBus, <literal>MEMBER</literal> = StartServiceByName,
1297           <literal>METHOD_CALL</literal> arguments are <literal>STRING</literal> and <literal>UINT32</literal>, <literal>METHOD_RETURN</literal> argument
1298           is <literal>UINT32</literal>. Remember that the <literal>MEMBER</literal> field can't contain any '.' (period)
1299           characters so it's known that the last part of the name in
1300           the "IDL" is the member name.
1301         </para>
1302         <para>
1303           In C++ that might end up looking like this:
1304           <programlisting>
1305             unsigned int org::freedesktop::DBus::StartServiceByName (const char  *name,
1306                                                                      unsigned int flags);
1307           </programlisting>
1308           or equally valid, the return value could be done as an argument:
1309           <programlisting>
1310             void org::freedesktop::DBus::StartServiceByName (const char   *name,
1311                                                              unsigned int  flags,
1312                                                              unsigned int *resultcode);
1313           </programlisting>
1314           It's really up to the API designer how they want to make
1315           this look. You could design an API where the namespace wasn't used
1316           in C++, using STL or Qt, using varargs, or whatever you wanted.
1317         </para>
1318         <para>
1319           Signals are written as follows:
1320           <programlisting>
1321             org.freedesktop.DBus.NameLost (STRING name)
1322           </programlisting>
1323           Signals don't specify "in" vs. "out" because only
1324           a single direction is possible.
1325         </para>
1326         <para>
1327           It isn't especially encouraged to use this lame pseudo-IDL in actual
1328           API implementations; you might use the native notation for the
1329           language you're using, or you might use COM or CORBA IDL, for example.
1330         </para>
1331       </sect3>
1332     </sect2>
1333
1334     <sect2 id="message-protocol-handling-invalid">
1335       <title>Invalid Protocol and Spec Extensions</title>
1336
1337       <para>
1338         For security reasons, the D-Bus protocol should be strictly parsed and
1339         validated, with the exception of defined extension points. Any invalid
1340         protocol or spec violations should result in immediately dropping the
1341         connection without notice to the other end. Exceptions should be
1342         carefully considered, e.g. an exception may be warranted for a
1343         well-understood idiosyncrasy of a widely-deployed implementation.  In
1344         cases where the other end of a connection is 100% trusted and known to
1345         be friendly, skipping validation for performance reasons could also make
1346         sense in certain cases.
1347       </para>
1348
1349       <para>
1350         Generally speaking violations of the "must" requirements in this spec
1351         should be considered possible attempts to exploit security, and violations
1352         of the "should" suggestions should be considered legitimate (though perhaps
1353         they should generate an error in some cases).
1354       </para>
1355
1356       <para>
1357         The following extension points are built in to D-Bus on purpose and must
1358         not be treated as invalid protocol. The extension points are intended
1359         for use by future versions of this spec, they are not intended for third
1360         parties.  At the moment, the only way a third party could extend D-Bus
1361         without breaking interoperability would be to introduce a way to negotiate new
1362         feature support as part of the auth protocol, using EXTENSION_-prefixed
1363         commands. There is not yet a standard way to negotiate features.
1364         <itemizedlist>
1365           <listitem>
1366             <para>
1367               In the authentication protocol (see <xref linkend="auth-protocol"/>) unknown
1368                 commands result in an ERROR rather than a disconnect. This enables
1369                 future extensions to the protocol. Commands starting with EXTENSION_ are
1370                 reserved for third parties.
1371             </para>
1372           </listitem>
1373           <listitem>
1374             <para>
1375               The authentication protocol supports pluggable auth mechanisms.
1376             </para>
1377           </listitem>
1378           <listitem>
1379             <para>
1380               The address format (see <xref linkend="addresses"/>) supports new
1381               kinds of transport.
1382             </para>
1383           </listitem>
1384           <listitem>
1385             <para>
1386               Messages with an unknown type (something other than
1387               <literal>METHOD_CALL</literal>, <literal>METHOD_RETURN</literal>,
1388               <literal>ERROR</literal>, <literal>SIGNAL</literal>) are ignored.
1389               Unknown-type messages must still be well-formed in the same way
1390               as the known messages, however. They still have the normal
1391               header and body.
1392             </para>
1393           </listitem>
1394           <listitem>
1395             <para>
1396               Header fields with an unknown or unexpected field code must be ignored,
1397               though again they must still be well-formed.
1398             </para>
1399           </listitem>
1400           <listitem>
1401             <para>
1402               New standard interfaces (with new methods and signals) can of course be added.
1403             </para>
1404           </listitem>
1405         </itemizedlist>
1406       </para>
1407
1408     </sect2>
1409
1410   </sect1>
1411
1412   <sect1 id="auth-protocol">
1413     <title>Authentication Protocol</title>
1414     <para>
1415       Before the flow of messages begins, two applications must
1416       authenticate. A simple plain-text protocol is used for
1417       authentication; this protocol is a SASL profile, and maps fairly
1418       directly from the SASL specification. The message encoding is
1419       NOT used here, only plain text messages.
1420     </para>
1421     <para>
1422       In examples, "C:" and "S:" indicate lines sent by the client and
1423       server respectively.
1424     </para>
1425     <sect2 id="auth-protocol-overview">
1426       <title>Protocol Overview</title>
1427       <para>
1428         The protocol is a line-based protocol, where each line ends with
1429         \r\n. Each line begins with an all-caps ASCII command name containing
1430         only the character range [A-Z_], a space, then any arguments for the
1431         command, then the \r\n ending the line. The protocol is
1432         case-sensitive. All bytes must be in the ASCII character set.
1433
1434         Commands from the client to the server are as follows:
1435
1436         <itemizedlist>
1437           <listitem><para>AUTH [mechanism] [initial-response]</para></listitem>
1438           <listitem><para>CANCEL</para></listitem>
1439           <listitem><para>BEGIN</para></listitem>
1440           <listitem><para>DATA &lt;data in hex encoding&gt;</para></listitem>
1441           <listitem><para>ERROR [human-readable error explanation]</para></listitem>
1442           <listitem><para>NEGOTIATE_UNIX_FD</para></listitem>
1443         </itemizedlist>
1444
1445         From server to client are as follows:
1446
1447         <itemizedlist>
1448           <listitem><para>REJECTED &lt;space-separated list of mechanism names&gt;</para></listitem>
1449           <listitem><para>OK &lt;GUID in hex&gt;</para></listitem>
1450           <listitem><para>DATA &lt;data in hex encoding&gt;</para></listitem>
1451           <listitem><para>ERROR</para></listitem>
1452           <listitem><para>AGREE_UNIX_FD</para></listitem>
1453         </itemizedlist>
1454       </para>
1455       <para>
1456         Unofficial extensions to the command set must begin with the letters
1457         "EXTENSION_", to avoid conflicts with future official commands.
1458         For example, "EXTENSION_COM_MYDOMAIN_DO_STUFF".
1459       </para>
1460     </sect2>
1461     <sect2 id="auth-nul-byte">
1462       <title>Special credentials-passing nul byte</title>
1463       <para>
1464         Immediately after connecting to the server, the client must send a
1465         single nul byte. This byte may be accompanied by credentials
1466         information on some operating systems that use sendmsg() with
1467         SCM_CREDS or SCM_CREDENTIALS to pass credentials over UNIX domain
1468         sockets. However, the nul byte must be sent even on other kinds of
1469         socket, and even on operating systems that do not require a byte to be
1470         sent in order to transmit credentials. The text protocol described in
1471         this document begins after the single nul byte. If the first byte
1472         received from the client is not a nul byte, the server may disconnect
1473         that client.
1474       </para>
1475       <para>
1476         A nul byte in any context other than the initial byte is an error;
1477         the protocol is ASCII-only.
1478       </para>
1479       <para>
1480         The credentials sent along with the nul byte may be used with the
1481         SASL mechanism EXTERNAL.
1482       </para>
1483     </sect2>
1484     <sect2 id="auth-command-auth">
1485       <title>AUTH command</title>
1486       <para>
1487         If an AUTH command has no arguments, it is a request to list
1488         available mechanisms. The server must respond with a REJECTED
1489         command listing the mechanisms it understands, or with an error.
1490       </para>
1491       <para>
1492         If an AUTH command specifies a mechanism, and the server supports
1493         said mechanism, the server should begin exchanging SASL
1494         challenge-response data with the client using DATA commands.
1495       </para>
1496       <para>
1497         If the server does not support the mechanism given in the AUTH
1498         command, it must send either a REJECTED command listing the mechanisms
1499         it does support, or an error.
1500       </para>
1501       <para>
1502         If the [initial-response] argument is provided, it is intended for use
1503         with mechanisms that have no initial challenge (or an empty initial
1504         challenge), as if it were the argument to an initial DATA command. If
1505         the selected mechanism has an initial challenge and [initial-response]
1506         was provided, the server should reject authentication by sending
1507         REJECTED.
1508       </para>
1509       <para>
1510         If authentication succeeds after exchanging DATA commands,
1511         an OK command must be sent to the client.
1512       </para>
1513       <para>
1514         The first octet received by the server after the \r\n of the BEGIN
1515         command from the client must be the first octet of the
1516         authenticated/encrypted stream of D-Bus messages.
1517       </para>
1518       <para>
1519         If BEGIN is received by the server, the first octet received
1520         by the client after the \r\n of the OK command must be the
1521         first octet of the authenticated/encrypted stream of D-Bus
1522         messages.
1523       </para>
1524     </sect2>
1525     <sect2 id="auth-command-cancel">
1526       <title>CANCEL Command</title>
1527       <para>
1528         At any time up to sending the BEGIN command, the client may send a
1529         CANCEL command. On receiving the CANCEL command, the server must
1530         send a REJECTED command and abort the current authentication
1531         exchange.
1532       </para>
1533     </sect2>
1534     <sect2 id="auth-command-data">
1535       <title>DATA Command</title>
1536       <para>
1537         The DATA command may come from either client or server, and simply
1538         contains a hex-encoded block of data to be interpreted
1539         according to the SASL mechanism in use.
1540       </para>
1541       <para>
1542         Some SASL mechanisms support sending an "empty string";
1543         FIXME we need some way to do this.
1544       </para>
1545     </sect2>
1546     <sect2 id="auth-command-begin">
1547       <title>BEGIN Command</title>
1548       <para>
1549         The BEGIN command acknowledges that the client has received an
1550         OK command from the server, and that the stream of messages
1551         is about to begin.
1552       </para>
1553       <para>
1554         The first octet received by the server after the \r\n of the BEGIN
1555         command from the client must be the first octet of the
1556         authenticated/encrypted stream of D-Bus messages.
1557       </para>
1558     </sect2>
1559     <sect2 id="auth-command-rejected">
1560       <title>REJECTED Command</title>
1561       <para>
1562         The REJECTED command indicates that the current authentication
1563         exchange has failed, and further exchange of DATA is inappropriate.
1564         The client would normally try another mechanism, or try providing
1565         different responses to challenges.
1566       </para><para>
1567         Optionally, the REJECTED command has a space-separated list of
1568         available auth mechanisms as arguments. If a server ever provides
1569         a list of supported mechanisms, it must provide the same list
1570         each time it sends a REJECTED message. Clients are free to
1571         ignore all lists received after the first.
1572       </para>
1573     </sect2>
1574     <sect2 id="auth-command-ok">
1575       <title>OK Command</title>
1576       <para>
1577         The OK command indicates that the client has been
1578         authenticated. The client may now proceed with negotiating
1579         Unix file descriptor passing. To do that it shall send
1580         NEGOTIATE_UNIX_FD to the server.
1581       </para>
1582       <para>
1583         Otherwise, the client must respond to the OK command by
1584         sending a BEGIN command, followed by its stream of messages,
1585         or by disconnecting.  The server must not accept additional
1586         commands using this protocol after the BEGIN command has been
1587         received. Further communication will be a stream of D-Bus
1588         messages (optionally encrypted, as negotiated) rather than
1589         this protocol.
1590       </para>
1591       <para>
1592         If a client sends BEGIN the first octet received by the client
1593         after the \r\n of the OK command must be the first octet of
1594         the authenticated/encrypted stream of D-Bus messages.
1595       </para>
1596       <para>
1597         The OK command has one argument, which is the GUID of the server.
1598         See <xref linkend="addresses"/> for more on server GUIDs.
1599       </para>
1600     </sect2>
1601     <sect2 id="auth-command-error">
1602       <title>ERROR Command</title>
1603       <para>
1604         The ERROR command indicates that either server or client did not
1605         know a command, does not accept the given command in the current
1606         context, or did not understand the arguments to the command. This
1607         allows the protocol to be extended; a client or server can send a
1608         command present or permitted only in new protocol versions, and if
1609         an ERROR is received instead of an appropriate response, fall back
1610         to using some other technique.
1611       </para>
1612       <para>
1613         If an ERROR is sent, the server or client that sent the
1614         error must continue as if the command causing the ERROR had never been
1615         received. However, the the server or client receiving the error
1616         should try something other than whatever caused the error;
1617         if only canceling/rejecting the authentication.
1618       </para>
1619       <para>
1620         If the D-Bus protocol changes incompatibly at some future time,
1621         applications implementing the new protocol would probably be able to
1622         check for support of the new protocol by sending a new command and
1623         receiving an ERROR from applications that don't understand it. Thus the
1624         ERROR feature of the auth protocol is an escape hatch that lets us
1625         negotiate extensions or changes to the D-Bus protocol in the future.
1626       </para>
1627     </sect2>
1628     <sect2 id="auth-command-negotiate-unix-fd">
1629       <title>NEGOTIATE_UNIX_FD Command</title>
1630       <para>
1631         The NEGOTIATE_UNIX_FD command indicates that the client
1632         supports Unix file descriptor passing. This command may only
1633         be sent after the connection is authenticated, i.e. after OK
1634         was received by the client. This command may only be sent on
1635         transports that support Unix file descriptor passing.
1636       </para>
1637       <para>
1638         On receiving NEGOTIATE_UNIX_FD the server must respond with
1639         either AGREE_UNIX_FD or ERROR. It shall respond the former if
1640         the transport chosen supports Unix file descriptor passing and
1641         the server supports this feature. It shall respond the latter
1642         if the transport does not support Unix file descriptor
1643         passing, the server does not support this feature, or the
1644         server decides not to enable file descriptor passing due to
1645         security or other reasons.
1646       </para>
1647     </sect2>
1648     <sect2 id="auth-command-agree-unix-fd">
1649       <title>AGREE_UNIX_FD Command</title>
1650       <para>
1651         The AGREE_UNIX_FD command indicates that the server supports
1652         Unix file descriptor passing. This command may only be sent
1653         after the connection is authenticated, and the client sent
1654         NEGOTIATE_UNIX_FD to enable Unix file descriptor passing. This
1655         command may only be sent on transports that support Unix file
1656         descriptor passing.
1657       </para>
1658       <para>
1659         On receiving AGREE_UNIX_FD the client must respond with BEGIN,
1660         followed by its stream of messages, or by disconnecting.  The
1661         server must not accept additional commands using this protocol
1662         after the BEGIN command has been received. Further
1663         communication will be a stream of D-Bus messages (optionally
1664         encrypted, as negotiated) rather than this protocol.
1665       </para>
1666     </sect2>
1667     <sect2 id="auth-command-future">
1668       <title>Future Extensions</title>
1669       <para>
1670         Future extensions to the authentication and negotiation
1671         protocol are possible. For that new commands may be
1672         introduced. If a client or server receives an unknown command
1673         it shall respond with ERROR and not consider this fatal. New
1674         commands may be introduced both before, and after
1675         authentication, i.e. both before and after the OK command.
1676       </para>
1677     </sect2>
1678     <sect2 id="auth-examples">
1679       <title>Authentication examples</title>
1680
1681       <para>
1682         <figure>
1683           <title>Example of successful magic cookie authentication</title>
1684           <programlisting>
1685             (MAGIC_COOKIE is a made up mechanism)
1686
1687             C: AUTH MAGIC_COOKIE 3138363935333137393635383634
1688             S: OK 1234deadbeef
1689             C: BEGIN
1690           </programlisting>
1691         </figure>
1692         <figure>
1693           <title>Example of finding out mechanisms then picking one</title>
1694           <programlisting>
1695             C: AUTH
1696             S: REJECTED KERBEROS_V4 SKEY
1697             C: AUTH SKEY 7ab83f32ee
1698             S: DATA 8799cabb2ea93e
1699             C: DATA 8ac876e8f68ee9809bfa876e6f9876g8fa8e76e98f
1700             S: OK 1234deadbeef
1701             C: BEGIN
1702           </programlisting>
1703         </figure>
1704         <figure>
1705           <title>Example of client sends unknown command then falls back to regular auth</title>
1706           <programlisting>
1707             C: FOOBAR
1708             S: ERROR
1709             C: AUTH MAGIC_COOKIE 3736343435313230333039
1710             S: OK 1234deadbeef
1711             C: BEGIN
1712           </programlisting>
1713         </figure>
1714         <figure>
1715           <title>Example of server doesn't support initial auth mechanism</title>
1716           <programlisting>
1717             C: AUTH MAGIC_COOKIE 3736343435313230333039
1718             S: REJECTED KERBEROS_V4 SKEY
1719             C: AUTH SKEY 7ab83f32ee
1720             S: DATA 8799cabb2ea93e
1721             C: DATA 8ac876e8f68ee9809bfa876e6f9876g8fa8e76e98f
1722             S: OK 1234deadbeef
1723             C: BEGIN
1724           </programlisting>
1725         </figure>
1726         <figure>
1727           <title>Example of wrong password or the like followed by successful retry</title>
1728           <programlisting>
1729             C: AUTH MAGIC_COOKIE 3736343435313230333039
1730             S: REJECTED KERBEROS_V4 SKEY
1731             C: AUTH SKEY 7ab83f32ee
1732             S: DATA 8799cabb2ea93e
1733             C: DATA 8ac876e8f68ee9809bfa876e6f9876g8fa8e76e98f
1734             S: REJECTED
1735             C: AUTH SKEY 7ab83f32ee
1736             S: DATA 8799cabb2ea93e
1737             C: DATA 8ac876e8f68ee9809bfa876e6f9876g8fa8e76e98f
1738             S: OK 1234deadbeef
1739             C: BEGIN
1740           </programlisting>
1741         </figure>
1742         <figure>
1743           <title>Example of skey cancelled and restarted</title>
1744           <programlisting>
1745             C: AUTH MAGIC_COOKIE 3736343435313230333039
1746             S: REJECTED KERBEROS_V4 SKEY
1747             C: AUTH SKEY 7ab83f32ee
1748             S: DATA 8799cabb2ea93e
1749             C: CANCEL
1750             S: REJECTED
1751             C: AUTH SKEY 7ab83f32ee
1752             S: DATA 8799cabb2ea93e
1753             C: DATA 8ac876e8f68ee9809bfa876e6f9876g8fa8e76e98f
1754             S: OK 1234deadbeef
1755             C: BEGIN
1756           </programlisting>
1757         </figure>
1758         <figure>
1759           <title>Example of successful magic cookie authentication with successful negotiation of Unix FD passing</title>
1760           <programlisting>
1761             (MAGIC_COOKIE is a made up mechanism)
1762
1763             C: AUTH MAGIC_COOKIE 3138363935333137393635383634
1764             S: OK 1234deadbeef
1765             C: NEGOTIATE_UNIX_FD
1766             S: AGREE_UNIX_FD
1767             C: BEGIN
1768           </programlisting>
1769         </figure>
1770         <figure>
1771           <title>Example of successful magic cookie authentication with unsuccessful negotiation of Unix FD passing</title>
1772           <programlisting>
1773             (MAGIC_COOKIE is a made up mechanism)
1774
1775             C: AUTH MAGIC_COOKIE 3138363935333137393635383634
1776             S: OK 1234deadbeef
1777             C: NEGOTIATE_UNIX_FD
1778             S: ERROR
1779             C: BEGIN
1780           </programlisting>
1781         </figure>
1782       </para>
1783     </sect2>
1784     <sect2 id="auth-states">
1785       <title>Authentication state diagrams</title>
1786
1787       <para>
1788         This section documents the auth protocol in terms of
1789         a state machine for the client and the server. This is
1790         probably the most robust way to implement the protocol.
1791       </para>
1792
1793       <sect3 id="auth-states-client">
1794         <title>Client states</title>
1795
1796         <para>
1797           To more precisely describe the interaction between the
1798           protocol state machine and the authentication mechanisms the
1799           following notation is used: MECH(CHALL) means that the
1800           server challenge CHALL was fed to the mechanism MECH, which
1801           returns one of
1802
1803           <itemizedlist>
1804             <listitem>
1805               <para>
1806                 CONTINUE(RESP) means continue the auth conversation
1807                 and send RESP as the response to the server;
1808               </para>
1809             </listitem>
1810
1811             <listitem>
1812               <para>
1813                 OK(RESP) means that after sending RESP to the server
1814                 the client side of the auth conversation is finished
1815                 and the server should return "OK";
1816               </para>
1817             </listitem>
1818
1819             <listitem>
1820               <para>
1821                 ERROR means that CHALL was invalid and could not be
1822                 processed.
1823               </para>
1824             </listitem>
1825           </itemizedlist>
1826
1827           Both RESP and CHALL may be empty.
1828         </para>
1829
1830         <para>
1831           The Client starts by getting an initial response from the
1832           default mechanism and sends AUTH MECH RESP, or AUTH MECH if
1833           the mechanism did not provide an initial response.  If the
1834           mechanism returns CONTINUE, the client starts in state
1835           <emphasis>WaitingForData</emphasis>, if the mechanism
1836           returns OK the client starts in state
1837           <emphasis>WaitingForOK</emphasis>.
1838         </para>
1839
1840         <para>
1841           The client should keep track of available mechanisms and
1842           which it mechanisms it has already attempted. This list is
1843           used to decide which AUTH command to send. When the list is
1844           exhausted, the client should give up and close the
1845           connection.
1846         </para>
1847
1848         <formalpara>
1849           <title><emphasis>WaitingForData</emphasis></title>
1850           <para>
1851             <itemizedlist>
1852               <listitem>
1853                 <para>
1854                   Receive DATA CHALL
1855                   <simplelist>
1856                     <member>
1857                       MECH(CHALL) returns CONTINUE(RESP) &rarr; send
1858                       DATA RESP, goto
1859                       <emphasis>WaitingForData</emphasis>
1860                     </member>
1861
1862                     <member>
1863                       MECH(CHALL) returns OK(RESP) &rarr; send DATA
1864                       RESP, goto <emphasis>WaitingForOK</emphasis>
1865                     </member>
1866
1867                     <member>
1868                       MECH(CHALL) returns ERROR &rarr; send ERROR
1869                       [msg], goto <emphasis>WaitingForData</emphasis>
1870                     </member>
1871                   </simplelist>
1872                 </para>
1873               </listitem>
1874
1875               <listitem>
1876                 <para>
1877                   Receive REJECTED [mechs] &rarr;
1878                   send AUTH [next mech], goto
1879                   WaitingForData or <emphasis>WaitingForOK</emphasis>
1880                 </para>
1881               </listitem>
1882               <listitem>
1883                 <para>
1884                   Receive ERROR &rarr; send
1885                   CANCEL, goto
1886                   <emphasis>WaitingForReject</emphasis>
1887                 </para>
1888               </listitem>
1889               <listitem>
1890                 <para>
1891                   Receive OK &rarr; send
1892                   BEGIN, terminate auth
1893                   conversation, authenticated
1894                 </para>
1895               </listitem>
1896               <listitem>
1897                 <para>
1898                   Receive anything else &rarr; send
1899                   ERROR, goto
1900                   <emphasis>WaitingForData</emphasis>
1901                 </para>
1902               </listitem>
1903             </itemizedlist>
1904           </para>
1905         </formalpara>
1906
1907         <formalpara>
1908           <title><emphasis>WaitingForOK</emphasis></title>
1909           <para>
1910             <itemizedlist>
1911               <listitem>
1912                 <para>
1913                   Receive OK &rarr; send BEGIN, terminate auth
1914                   conversation, <emphasis>authenticated</emphasis>
1915                 </para>
1916               </listitem>
1917               <listitem>
1918                 <para>
1919                   Receive REJECT [mechs] &rarr; send AUTH [next mech],
1920                   goto <emphasis>WaitingForData</emphasis> or
1921                   <emphasis>WaitingForOK</emphasis>
1922                 </para>
1923               </listitem>
1924
1925               <listitem>
1926                 <para>
1927                   Receive DATA &rarr; send CANCEL, goto
1928                   <emphasis>WaitingForReject</emphasis>
1929                 </para>
1930               </listitem>
1931
1932               <listitem>
1933                 <para>
1934                   Receive ERROR &rarr; send CANCEL, goto
1935                   <emphasis>WaitingForReject</emphasis>
1936                 </para>
1937               </listitem>
1938
1939               <listitem>
1940                 <para>
1941                   Receive anything else &rarr; send ERROR, goto
1942                   <emphasis>WaitingForOK</emphasis>
1943                 </para>
1944               </listitem>
1945             </itemizedlist>
1946           </para>
1947         </formalpara>
1948
1949         <formalpara>
1950           <title><emphasis>WaitingForReject</emphasis></title>
1951           <para>
1952             <itemizedlist>
1953               <listitem>
1954                 <para>
1955                   Receive REJECT [mechs] &rarr; send AUTH [next mech],
1956                   goto <emphasis>WaitingForData</emphasis> or
1957                   <emphasis>WaitingForOK</emphasis>
1958                 </para>
1959               </listitem>
1960
1961               <listitem>
1962                 <para>
1963                   Receive anything else &rarr; terminate auth
1964                   conversation, disconnect
1965                 </para>
1966               </listitem>
1967             </itemizedlist>
1968           </para>
1969         </formalpara>
1970
1971       </sect3>
1972
1973       <sect3 id="auth-states-server">
1974         <title>Server states</title>
1975
1976         <para>
1977           For the server MECH(RESP) means that the client response
1978           RESP was fed to the the mechanism MECH, which returns one of
1979
1980           <itemizedlist>
1981             <listitem>
1982               <para>
1983                 CONTINUE(CHALL) means continue the auth conversation and
1984                 send CHALL as the challenge to the client;
1985               </para>
1986             </listitem>
1987
1988             <listitem>
1989               <para>
1990                 OK means that the client has been successfully
1991                 authenticated;
1992               </para>
1993             </listitem>
1994
1995             <listitem>
1996               <para>
1997                 REJECT means that the client failed to authenticate or
1998                 there was an error in RESP.
1999               </para>
2000             </listitem>
2001           </itemizedlist>
2002
2003           The server starts out in state
2004           <emphasis>WaitingForAuth</emphasis>.  If the client is
2005           rejected too many times the server must disconnect the
2006           client.
2007         </para>
2008
2009         <formalpara>
2010           <title><emphasis>WaitingForAuth</emphasis></title>
2011           <para>
2012             <itemizedlist>
2013
2014               <listitem>
2015                 <para>
2016                   Receive AUTH &rarr; send REJECTED [mechs], goto
2017                   <emphasis>WaitingForAuth</emphasis>
2018                 </para>
2019               </listitem>
2020
2021               <listitem>
2022                 <para>
2023                   Receive AUTH MECH RESP
2024
2025                   <simplelist>
2026                     <member>
2027                       MECH not valid mechanism &rarr; send REJECTED
2028                       [mechs], goto
2029                       <emphasis>WaitingForAuth</emphasis>
2030                     </member>
2031
2032                     <member>
2033                       MECH(RESP) returns CONTINUE(CHALL) &rarr; send
2034                       DATA CHALL, goto
2035                       <emphasis>WaitingForData</emphasis>
2036                     </member>
2037
2038                     <member>
2039                       MECH(RESP) returns OK &rarr; send OK, goto
2040                       <emphasis>WaitingForBegin</emphasis>
2041                     </member>
2042
2043                     <member>
2044                       MECH(RESP) returns REJECT &rarr; send REJECTED
2045                       [mechs], goto
2046                       <emphasis>WaitingForAuth</emphasis>
2047                     </member>
2048                   </simplelist>
2049                 </para>
2050               </listitem>
2051
2052               <listitem>
2053                 <para>
2054                   Receive BEGIN &rarr; terminate
2055                   auth conversation, disconnect
2056                 </para>
2057               </listitem>
2058
2059               <listitem>
2060                 <para>
2061                   Receive ERROR &rarr; send REJECTED [mechs], goto
2062                   <emphasis>WaitingForAuth</emphasis>
2063                 </para>
2064               </listitem>
2065
2066               <listitem>
2067                 <para>
2068                   Receive anything else &rarr; send
2069                   ERROR, goto
2070                   <emphasis>WaitingForAuth</emphasis>
2071                 </para>
2072               </listitem>
2073             </itemizedlist>
2074           </para>
2075         </formalpara>
2076
2077
2078         <formalpara>
2079           <title><emphasis>WaitingForData</emphasis></title>
2080           <para>
2081             <itemizedlist>
2082               <listitem>
2083                 <para>
2084                   Receive DATA RESP
2085                   <simplelist>
2086                     <member>
2087                       MECH(RESP) returns CONTINUE(CHALL) &rarr; send
2088                       DATA CHALL, goto
2089                       <emphasis>WaitingForData</emphasis>
2090                     </member>
2091
2092                     <member>
2093                       MECH(RESP) returns OK &rarr; send OK, goto
2094                       <emphasis>WaitingForBegin</emphasis>
2095                     </member>
2096
2097                     <member>
2098                       MECH(RESP) returns REJECT &rarr; send REJECTED
2099                       [mechs], goto
2100                       <emphasis>WaitingForAuth</emphasis>
2101                     </member>
2102                   </simplelist>
2103                 </para>
2104               </listitem>
2105
2106               <listitem>
2107                 <para>
2108                   Receive BEGIN &rarr; terminate auth conversation,
2109                   disconnect
2110                 </para>
2111               </listitem>
2112
2113               <listitem>
2114                 <para>
2115                   Receive CANCEL &rarr; send REJECTED [mechs], goto
2116                   <emphasis>WaitingForAuth</emphasis>
2117                 </para>
2118               </listitem>
2119
2120               <listitem>
2121                 <para>
2122                   Receive ERROR &rarr; send REJECTED [mechs], goto
2123                   <emphasis>WaitingForAuth</emphasis>
2124                 </para>
2125               </listitem>
2126
2127               <listitem>
2128                 <para>
2129                   Receive anything else &rarr; send ERROR, goto
2130                   <emphasis>WaitingForData</emphasis>
2131                 </para>
2132               </listitem>
2133             </itemizedlist>
2134           </para>
2135         </formalpara>
2136
2137         <formalpara>
2138           <title><emphasis>WaitingForBegin</emphasis></title>
2139           <para>
2140             <itemizedlist>
2141               <listitem>
2142                 <para>
2143                   Receive BEGIN &rarr; terminate auth conversation,
2144                   client authenticated
2145                 </para>
2146               </listitem>
2147
2148               <listitem>
2149                 <para>
2150                   Receive CANCEL &rarr; send REJECTED [mechs], goto
2151                   <emphasis>WaitingForAuth</emphasis>
2152                 </para>
2153               </listitem>
2154
2155               <listitem>
2156                 <para>
2157                   Receive ERROR &rarr; send REJECTED [mechs], goto
2158                   <emphasis>WaitingForAuth</emphasis>
2159                 </para>
2160               </listitem>
2161
2162               <listitem>
2163                 <para>
2164                   Receive anything else &rarr; send ERROR, goto
2165                   <emphasis>WaitingForBegin</emphasis>
2166                 </para>
2167               </listitem>
2168             </itemizedlist>
2169           </para>
2170         </formalpara>
2171
2172       </sect3>
2173
2174     </sect2>
2175     <sect2 id="auth-mechanisms">
2176       <title>Authentication mechanisms</title>
2177       <para>
2178         This section describes some new authentication mechanisms.
2179         D-Bus also allows any standard SASL mechanism of course.
2180       </para>
2181       <sect3 id="auth-mechanisms-sha">
2182         <title>DBUS_COOKIE_SHA1</title>
2183         <para>
2184           The DBUS_COOKIE_SHA1 mechanism is designed to establish that a client
2185           has the ability to read a private file owned by the user being
2186           authenticated. If the client can prove that it has access to a secret
2187           cookie stored in this file, then the client is authenticated.
2188           Thus the security of DBUS_COOKIE_SHA1 depends on a secure home
2189           directory.
2190         </para>
2191         <para>
2192           Throughout this description, "hex encoding" must output the digits
2193           from a to f in lower-case; the digits A to F must not be used
2194           in the DBUS_COOKIE_SHA1 mechanism.
2195         </para>
2196         <para>
2197           Authentication proceeds as follows:
2198           <itemizedlist>
2199             <listitem>
2200               <para>
2201                 The client sends the username it would like to authenticate
2202                 as, hex-encoded.
2203               </para>
2204             </listitem>
2205             <listitem>
2206               <para>
2207                 The server sends the name of its "cookie context" (see below); a
2208                 space character; the integer ID of the secret cookie the client
2209                 must demonstrate knowledge of; a space character; then a
2210                 randomly-generated challenge string, all of this hex-encoded into
2211                 one, single string.
2212               </para>
2213             </listitem>
2214             <listitem>
2215               <para>
2216                 The client locates the cookie and generates its own
2217                 randomly-generated challenge string. The client then concatenates
2218                 the server's decoded challenge, a ":" character, its own challenge,
2219                 another ":" character, and the cookie. It computes the SHA-1 hash
2220                 of this composite string as a hex digest. It concatenates the
2221                 client's challenge string, a space character, and the SHA-1 hex
2222                 digest, hex-encodes the result and sends it back to the server.
2223               </para>
2224             </listitem>
2225             <listitem>
2226               <para>
2227                 The server generates the same concatenated string used by the
2228                 client and computes its SHA-1 hash. It compares the hash with
2229                 the hash received from the client; if the two hashes match, the
2230                 client is authenticated.
2231               </para>
2232             </listitem>
2233           </itemizedlist>
2234         </para>
2235         <para>
2236           Each server has a "cookie context," which is a name that identifies a
2237           set of cookies that apply to that server. A sample context might be
2238           "org_freedesktop_session_bus". Context names must be valid ASCII,
2239           nonzero length, and may not contain the characters slash ("/"),
2240           backslash ("\"), space (" "), newline ("\n"), carriage return ("\r"),
2241           tab ("\t"), or period ("."). There is a default context,
2242           "org_freedesktop_general" that's used by servers that do not specify
2243           otherwise.
2244         </para>
2245         <para>
2246           Cookies are stored in a user's home directory, in the directory
2247           <filename>~/.dbus-keyrings/</filename>. This directory must
2248           not be readable or writable by other users. If it is,
2249           clients and servers must ignore it. The directory
2250           contains cookie files named after the cookie context.
2251         </para>
2252         <para>
2253           A cookie file contains one cookie per line. Each line
2254           has three space-separated fields:
2255           <itemizedlist>
2256             <listitem>
2257               <para>
2258                 The cookie ID number, which must be a non-negative integer and
2259                 may not be used twice in the same file.
2260               </para>
2261             </listitem>
2262             <listitem>
2263               <para>
2264                 The cookie's creation time, in UNIX seconds-since-the-epoch
2265                 format.
2266               </para>
2267             </listitem>
2268             <listitem>
2269               <para>
2270                 The cookie itself, a hex-encoded random block of bytes. The cookie
2271                 may be of any length, though obviously security increases
2272                 as the length increases.
2273               </para>
2274             </listitem>
2275           </itemizedlist>
2276         </para>
2277         <para>
2278           Only server processes modify the cookie file.
2279           They must do so with this procedure:
2280           <itemizedlist>
2281             <listitem>
2282               <para>
2283                 Create a lockfile name by appending ".lock" to the name of the
2284                 cookie file.  The server should attempt to create this file
2285                 using <literal>O_CREAT | O_EXCL</literal>.  If file creation
2286                 fails, the lock fails. Servers should retry for a reasonable
2287                 period of time, then they may choose to delete an existing lock
2288                 to keep users from having to manually delete a stale
2289                 lock. <footnote><para>Lockfiles are used instead of real file
2290                 locking <literal>fcntl()</literal> because real locking
2291                 implementations are still flaky on network
2292                 filesystems.</para></footnote>
2293               </para>
2294             </listitem>
2295             <listitem>
2296               <para>
2297                 Once the lockfile has been created, the server loads the cookie
2298                 file. It should then delete any cookies that are old (the
2299                 timeout can be fairly short), or more than a reasonable
2300                 time in the future (so that cookies never accidentally
2301                 become permanent, if the clock was set far into the future
2302                 at some point). If no recent keys remain, the
2303                 server may generate a new key.
2304               </para>
2305             </listitem>
2306             <listitem>
2307               <para>
2308                 The pruned and possibly added-to cookie file
2309                 must be resaved atomically (using a temporary
2310                 file which is rename()'d).
2311               </para>
2312             </listitem>
2313             <listitem>
2314               <para>
2315                 The lock must be dropped by deleting the lockfile.
2316               </para>
2317             </listitem>
2318           </itemizedlist>
2319         </para>
2320         <para>
2321           Clients need not lock the file in order to load it,
2322           because servers are required to save the file atomically.
2323         </para>
2324       </sect3>
2325     </sect2>
2326   </sect1>
2327   <sect1 id="addresses">
2328     <title>Server Addresses</title>
2329     <para>
2330       Server addresses consist of a transport name followed by a colon, and
2331       then an optional, comma-separated list of keys and values in the form key=value.
2332       Each value is escaped.
2333     </para>
2334     <para>
2335       For example:
2336       <programlisting>unix:path=/tmp/dbus-test</programlisting>
2337       Which is the address to a unix socket with the path /tmp/dbus-test.
2338     </para>
2339     <para>
2340       Value escaping is similar to URI escaping but simpler.
2341       <itemizedlist>
2342         <listitem>
2343           <para>
2344             The set of optionally-escaped bytes is:
2345             <literal>[0-9A-Za-z_-/.\]</literal>. To escape, each
2346             <emphasis>byte</emphasis> (note, not character) which is not in the
2347             set of optionally-escaped bytes must be replaced with an ASCII
2348             percent (<literal>%</literal>) and the value of the byte in hex.
2349             The hex value must always be two digits, even if the first digit is
2350             zero. The optionally-escaped bytes may be escaped if desired.
2351           </para>
2352         </listitem>
2353         <listitem>
2354           <para>
2355             To unescape, append each byte in the value; if a byte is an ASCII
2356             percent (<literal>%</literal>) character then append the following
2357             hex value instead. It is an error if a <literal>%</literal> byte
2358             does not have two hex digits following. It is an error if a
2359             non-optionally-escaped byte is seen unescaped.
2360           </para>
2361         </listitem>
2362       </itemizedlist>
2363       The set of optionally-escaped bytes is intended to preserve address
2364       readability and convenience.
2365     </para>
2366
2367     <para>
2368       A server may specify a key-value pair with the key <literal>guid</literal>
2369       and the value a hex-encoded 16-byte sequence. <xref linkend="uuids"/>
2370       describes the format of the <literal>guid</literal> field.  If present,
2371       this UUID may be used to distinguish one server address from another. A
2372       server should use a different UUID for each address it listens on. For
2373       example, if a message bus daemon offers both UNIX domain socket and TCP
2374       connections, but treats clients the same regardless of how they connect,
2375       those two connections are equivalent post-connection but should have
2376       distinct UUIDs to distinguish the kinds of connection.
2377     </para>
2378
2379     <para>
2380       The intent of the address UUID feature is to allow a client to avoid
2381       opening multiple identical connections to the same server, by allowing the
2382       client to check whether an address corresponds to an already-existing
2383       connection.  Comparing two addresses is insufficient, because addresses
2384       can be recycled by distinct servers, and equivalent addresses may look
2385       different if simply compared as strings (for example, the host in a TCP
2386       address can be given as an IP address or as a hostname).
2387     </para>
2388
2389     <para>
2390       Note that the address key is <literal>guid</literal> even though the
2391       rest of the API and documentation says "UUID," for historical reasons.
2392     </para>
2393
2394     <para>
2395       [FIXME clarify if attempting to connect to each is a requirement
2396       or just a suggestion]
2397       When connecting to a server, multiple server addresses can be
2398       separated by a semi-colon. The library will then try to connect
2399       to the first address and if that fails, it'll try to connect to
2400       the next one specified, and so forth. For example
2401       <programlisting>unix:path=/tmp/dbus-test;unix:path=/tmp/dbus-test2</programlisting>
2402     </para>
2403
2404   </sect1>
2405
2406   <sect1 id="transports">
2407     <title>Transports</title>
2408     <para>
2409       [FIXME we need to specify in detail each transport and its possible arguments]
2410
2411       Current transports include: unix domain sockets (including
2412       abstract namespace on linux), TCP/IP, and a debug/testing transport using
2413       in-process pipes. Future possible transports include one that
2414       tunnels over X11 protocol.
2415     </para>
2416
2417     <sect2 id="transports-unix-domain-sockets">
2418       <title>Unix Domain Sockets</title>
2419       <para>
2420         Unix domain sockets can be either paths in the file system or on Linux
2421         kernels, they can be abstract which are similar to paths but
2422         do not show up in the file system.
2423       </para>
2424
2425       <para>
2426         When a socket is opened by the D-Bus library it truncates the path
2427         name right before the first trailing Nul byte.  This is true for both
2428         normal paths and abstract paths.  Note that this is a departure from
2429         previous versions of D-Bus that would create sockets with a fixed
2430         length path name.  Names which were shorter than the fixed length
2431         would be padded by Nul bytes.
2432       </para>
2433       <para>
2434         Unix domain sockets are not available on windows.
2435       </para>
2436       <sect3 id="transports-unix-domain-sockets-addresses">
2437         <title>Server Address Format</title>
2438         <para>
2439           Unix domain socket addresses are identified by the "unix:" prefix
2440           and support the following key/value pairs:
2441         </para>
2442         <informaltable>
2443          <tgroup cols="3">
2444           <thead>
2445            <row>
2446             <entry>Name</entry>
2447             <entry>Values</entry>
2448             <entry>Description</entry>
2449            </row>
2450           </thead>
2451           <tbody>
2452            <row>
2453             <entry>path</entry>
2454             <entry>(path)</entry>
2455             <entry>path of the unix domain socket. If set, the "tmpdir" and "abstract" key must not be set.</entry>
2456           </row>
2457           <row>
2458             <entry>tmpdir</entry>
2459             <entry>(path)</entry>
2460             <entry>temporary directory in which a socket file with a random file name starting with 'dbus-' will be created by the server. This key can only be used in server addresses, not in client addresses. If set, the "path" and "abstract" key must not be set.</entry>
2461           </row>
2462           <row>
2463             <entry>abstract</entry>
2464             <entry>(string)</entry>
2465             <entry>unique string (path) in the abstract namespace. If set, the "path" or "tempdir" key must not be set.</entry>
2466           </row>
2467         </tbody>
2468         </tgroup>
2469        </informaltable>
2470       </sect3>
2471     </sect2>
2472     <sect2 id="transports-tcp-sockets">
2473       <title>TCP Sockets</title>
2474       <para>
2475         The tcp transport provides TCP/IP based connections between clients
2476         located on the same or different hosts.
2477       </para>
2478       <para>
2479         Using tcp transport without any additional secure authentification mechanismus
2480         over a network is unsecure.
2481       </para>
2482       <para>
2483         Windows notes: Because of the tcp stack on windows does not provide sending
2484         credentials over a tcp connection, the EXTERNAL authentification
2485         mechanismus does not work.
2486       </para>
2487       <sect3 id="transports-tcp-sockets-addresses">
2488         <title>Server Address Format</title>
2489         <para>
2490          TCP/IP socket addresses are identified by the "tcp:" prefix
2491          and support the following key/value pairs:
2492         </para>
2493         <informaltable>
2494          <tgroup cols="3">
2495           <thead>
2496            <row>
2497             <entry>Name</entry>
2498             <entry>Values</entry>
2499             <entry>Description</entry>
2500            </row>
2501           </thead>
2502           <tbody>
2503            <row>
2504             <entry>host</entry>
2505             <entry>(string)</entry>
2506             <entry>dns name or ip address</entry>
2507           </row>
2508           <row>
2509            <entry>port</entry>
2510            <entry>(number)</entry>
2511            <entry>The tcp port the server will open. A zero value let the server
2512             choose a free port provided from the underlaying operating system.
2513             libdbus is able to retrieve the real used port from the server.
2514            </entry>
2515           </row>
2516           <row>
2517            <entry>family</entry>
2518            <entry>(string)</entry>
2519            <entry>If set, provide the type of socket family either "ipv4" or "ipv6". If unset, the family is unspecified.</entry>
2520           </row>
2521          </tbody>
2522         </tgroup>
2523        </informaltable>
2524       </sect3>
2525     </sect2>
2526     <sect2 id="transports-nonce-tcp-sockets">
2527       <title>Nonce-secured TCP Sockets</title>
2528       <para>
2529         The nonce-tcp transport provides a secured TCP transport, using a
2530         simple authentication mechanism to ensure that only clients with read
2531         access to a certain location in the filesystem can connect to the server.
2532         The server writes a secret, the nonce, to a file and an incoming client
2533         connection is only accepted if the client sends the nonce right after
2534         the connect. The nonce mechanism requires no setup and is orthogonal to
2535         the higher-level authentication mechanisms described in the
2536         Authentication section.
2537       </para>
2538
2539       <para>
2540         On start, the server generates a random 16 byte nonce and writes it
2541         to a file in the user's temporary directory. The nonce file location
2542         is published as part of the server's D-Bus address using the
2543         "noncefile" key-value pair.
2544
2545         After an accept, the server reads 16 bytes from the socket. If the
2546         read bytes do not match the nonce stored in the nonce file, the
2547         server MUST immediately drop the connection.
2548         If the nonce match the received byte sequence, the client is accepted
2549         and the transport behaves like an unsecured tcp transport.
2550       </para>
2551       <para>
2552         After a successful connect to the server socket, the client MUST read
2553         the nonce from the file published by the server via the noncefile=
2554         key-value pair and send it over the socket. After that, the
2555         transport behaves like an unsecured tcp transport.
2556       </para>
2557       <sect3 id="transports-nonce-tcp-sockets-addresses">
2558         <title>Server Address Format</title>
2559         <para>
2560          Nonce TCP/IP socket addresses uses the "nonce-tcp:" prefix
2561          and support the following key/value pairs:
2562         </para>
2563         <informaltable>
2564          <tgroup cols="3">
2565           <thead>
2566            <row>
2567             <entry>Name</entry>
2568             <entry>Values</entry>
2569             <entry>Description</entry>
2570            </row>
2571           </thead>
2572           <tbody>
2573            <row>
2574             <entry>host</entry>
2575             <entry>(string)</entry>
2576             <entry>dns name or ip address</entry>
2577           </row>
2578           <row>
2579            <entry>port</entry>
2580            <entry>(number)</entry>
2581            <entry>The tcp port the server will open. A zero value let the server
2582             choose a free port provided from the underlaying operating system.
2583             libdbus is able to retrieve the real used port from the server.
2584            </entry>
2585           </row>
2586           <row>
2587            <entry>family</entry>
2588            <entry>(string)</entry>
2589            <entry>If set, provide the type of socket family either "ipv4" or "ipv6". If unset, the family is unspecified.</entry>
2590           </row>
2591           <row>
2592            <entry>noncefile</entry>
2593            <entry>(path)</entry>
2594            <entry>file location containing the secret</entry>
2595           </row>
2596          </tbody>
2597         </tgroup>
2598        </informaltable>
2599       </sect3>
2600     </sect2>
2601
2602   </sect1>
2603
2604   <sect1 id="naming-conventions">
2605     <title>Naming Conventions</title>
2606
2607     <para>
2608       D-Bus namespaces are all lowercase and correspond to reversed domain
2609       names, as with Java. e.g. "org.freedesktop"
2610     </para>
2611     <para>
2612       Interface, signal, method, and property names are "WindowsStyleCaps", note
2613       that the first letter is capitalized, unlike Java.
2614     </para>
2615     <para>
2616       Object paths are normally all lowercase with underscores used rather than
2617       hyphens.
2618     </para>
2619   </sect1>
2620
2621   <sect1 id="uuids">
2622     <title>UUIDs</title>
2623     <para>
2624       A working D-Bus implementation uses universally-unique IDs in two places.
2625       First, each server address has a UUID identifying the address,
2626       as described in <xref linkend="addresses"/>. Second, each operating
2627       system kernel instance running a D-Bus client or server has a UUID
2628       identifying that kernel, retrieved by invoking the method
2629       org.freedesktop.DBus.Peer.GetMachineId() (see <xref
2630       linkend="standard-interfaces-peer"/>).
2631     </para>
2632     <para>
2633       The term "UUID" in this document is intended literally, i.e. an
2634       identifier that is universally unique. It is not intended to refer to
2635       RFC4122, and in fact the D-Bus UUID is not compatible with that RFC.
2636     </para>
2637     <para>
2638       The UUID must contain 128 bits of data and be hex-encoded.  The
2639       hex-encoded string may not contain hyphens or other non-hex-digit
2640       characters, and it must be exactly 32 characters long.  To generate a
2641       UUID, the current reference implementation concatenates 96 bits of random
2642       data followed by the 32-bit time in seconds since the UNIX epoch (in big
2643       endian byte order).
2644     </para>
2645     <para>
2646       It would also be acceptable and probably better to simply generate 128
2647       bits of random data, as long as the random number generator is of high
2648       quality. The timestamp could conceivably help if the random bits are not
2649       very random. With a quality random number generator, collisions are
2650       extremely unlikely even with only 96 bits, so it's somewhat academic.
2651     </para>
2652     <para>
2653       Implementations should, however, stick to random data for the first 96 bits
2654       of the UUID.
2655     </para>
2656   </sect1>
2657
2658   <sect1 id="standard-interfaces">
2659     <title>Standard Interfaces</title>
2660     <para>
2661       See <xref linkend="message-protocol-types-notation"/> for details on
2662        the notation used in this section. There are some standard interfaces
2663       that may be useful across various D-Bus applications.
2664     </para>
2665     <sect2 id="standard-interfaces-peer">
2666       <title><literal>org.freedesktop.DBus.Peer</literal></title>
2667       <para>
2668         The <literal>org.freedesktop.DBus.Peer</literal> interface
2669         has two methods:
2670         <programlisting>
2671           org.freedesktop.DBus.Peer.Ping ()
2672           org.freedesktop.DBus.Peer.GetMachineId (out STRING machine_uuid)
2673         </programlisting>
2674       </para>
2675       <para>
2676         On receipt of the <literal>METHOD_CALL</literal> message
2677         <literal>org.freedesktop.DBus.Peer.Ping</literal>, an application should do
2678         nothing other than reply with a <literal>METHOD_RETURN</literal> as
2679         usual.  It does not matter which object path a ping is sent to.  The
2680         reference implementation handles this method automatically.
2681       </para>
2682       <para>
2683         On receipt of the <literal>METHOD_CALL</literal> message
2684         <literal>org.freedesktop.DBus.Peer.GetMachineId</literal>, an application should
2685         reply with a <literal>METHOD_RETURN</literal> containing a hex-encoded
2686         UUID representing the identity of the machine the process is running on.
2687         This UUID must be the same for all processes on a single system at least
2688         until that system next reboots. It should be the same across reboots
2689         if possible, but this is not always possible to implement and is not
2690         guaranteed.
2691         It does not matter which object path a GetMachineId is sent to.  The
2692         reference implementation handles this method automatically.
2693       </para>
2694       <para>
2695         The UUID is intended to be per-instance-of-the-operating-system, so may represent
2696         a virtual machine running on a hypervisor, rather than a physical machine.
2697         Basically if two processes see the same UUID, they should also see the same
2698         shared memory, UNIX domain sockets, process IDs, and other features that require
2699         a running OS kernel in common between the processes.
2700       </para>
2701       <para>
2702         The UUID is often used where other programs might use a hostname. Hostnames
2703         can change without rebooting, however, or just be "localhost" - so the UUID
2704         is more robust.
2705       </para>
2706       <para>
2707         <xref linkend="uuids"/> explains the format of the UUID.
2708       </para>
2709     </sect2>
2710
2711     <sect2 id="standard-interfaces-introspectable">
2712       <title><literal>org.freedesktop.DBus.Introspectable</literal></title>
2713       <para>
2714         This interface has one method:
2715         <programlisting>
2716           org.freedesktop.DBus.Introspectable.Introspect (out STRING xml_data)
2717         </programlisting>
2718       </para>
2719       <para>
2720         Objects instances may implement
2721         <literal>Introspect</literal> which returns an XML description of
2722         the object, including its interfaces (with signals and methods), objects
2723         below it in the object path tree, and its properties.
2724       </para>
2725       <para>
2726         <xref linkend="introspection-format"/> describes the format of this XML string.
2727       </para>
2728     </sect2>
2729     <sect2 id="standard-interfaces-properties">
2730       <title><literal>org.freedesktop.DBus.Properties</literal></title>
2731       <para>
2732         Many native APIs will have a concept of object <firstterm>properties</firstterm>
2733         or <firstterm>attributes</firstterm>. These can be exposed via the
2734         <literal>org.freedesktop.DBus.Properties</literal> interface.
2735       </para>
2736       <para>
2737         <programlisting>
2738               org.freedesktop.DBus.Properties.Get (in STRING interface_name,
2739                                                    in STRING property_name,
2740                                                    out VARIANT value);
2741               org.freedesktop.DBus.Properties.Set (in STRING interface_name,
2742                                                    in STRING property_name,
2743                                                    in VARIANT value);
2744               org.freedesktop.DBus.Properties.GetAll (in STRING interface_name,
2745                                                       out DICT&lt;STRING,VARIANT&gt; props);
2746         </programlisting>
2747       </para>
2748       <para>
2749         The available properties and whether they are writable can be determined
2750         by calling <literal>org.freedesktop.DBus.Introspectable.Introspect</literal>,
2751         see <xref linkend="standard-interfaces-introspectable"/>.
2752       </para>
2753       <para>
2754         An empty string may be provided for the interface name; in this case,
2755         if there are multiple properties on an object with the same name,
2756         the results are undefined (picking one by according to an arbitrary
2757         deterministic rule, or returning an error, are the reasonable
2758         possibilities).
2759       </para>
2760       <para>
2761         If one or more properties change on an object, the
2762         <literal>org.freedesktop.DBus.Properties.PropertiesChanged</literal>
2763         signal may be emitted (this signal was added in 0.14):
2764       </para>
2765       <para>
2766         <programlisting>
2767               org.freedesktop.DBus.Properties.PropertiesChanged (STRING interface_name,
2768                                                                  DICT&lt;STRING,VARIANT&gt; changed_properties,
2769                                                                  ARRAY&lt;STRING&gt; invalidated_properties);
2770         </programlisting>
2771       </para>
2772       <para>
2773         where <literal>changed_properties</literal> is a dictionary
2774         containing the changed properties with the new values and
2775         <literal>invalidated_properties</literal> is an array of
2776         properties that changed but the value is not conveyed.
2777       </para>
2778       <para>
2779         Whether the <literal>PropertiesChanged</literal> signal is
2780         supported can be determined by calling
2781         <literal>org.freedesktop.DBus.Introspectable.Introspect</literal>. Note
2782         that the signal may be supported for an object but it may
2783         differ how whether and how it is used on a per-property basis
2784         (for e.g. performance or security reasons). Each property (or
2785         the parent interface) must be annotated with the
2786         <literal>org.freedesktop.DBus.Property.EmitsChangedSignal</literal>
2787         annotation to convey this (usually the default value
2788         <literal>true</literal> is sufficient meaning that the
2789         annotation does not need to be used). See <xref
2790         linkend="introspection-format"/> for details on this
2791         annotation.
2792       </para>
2793     </sect2>
2794   </sect1>
2795
2796   <sect1 id="introspection-format">
2797     <title>Introspection Data Format</title>
2798     <para>
2799       As described in <xref linkend="standard-interfaces-introspectable"/>,
2800       objects may be introspected at runtime, returning an XML string
2801       that describes the object. The same XML format may be used in
2802       other contexts as well, for example as an "IDL" for generating
2803       static language bindings.
2804     </para>
2805     <para>
2806       Here is an example of introspection data:
2807       <programlisting>
2808         &lt;!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
2809          "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd"&gt;
2810         &lt;node name="/org/freedesktop/sample_object"&gt;
2811           &lt;interface name="org.freedesktop.SampleInterface"&gt;
2812             &lt;method name="Frobate"&gt;
2813               &lt;arg name="foo" type="i" direction="in"/&gt;
2814               &lt;arg name="bar" type="s" direction="out"/&gt;
2815               &lt;arg name="baz" type="a{us}" direction="out"/&gt;
2816               &lt;annotation name="org.freedesktop.DBus.Deprecated" value="true"/&gt;
2817             &lt;/method&gt;
2818             &lt;method name="Bazify"&gt;
2819               &lt;arg name="bar" type="(iiu)" direction="in"/&gt;
2820               &lt;arg name="bar" type="v" direction="out"/&gt;
2821             &lt;/method&gt;
2822             &lt;method name="Mogrify"&gt;
2823               &lt;arg name="bar" type="(iiav)" direction="in"/&gt;
2824             &lt;/method&gt;
2825             &lt;signal name="Changed"&gt;
2826               &lt;arg name="new_value" type="b"/&gt;
2827             &lt;/signal&gt;
2828             &lt;property name="Bar" type="y" access="readwrite"/&gt;
2829           &lt;/interface&gt;
2830           &lt;node name="child_of_sample_object"/&gt;
2831           &lt;node name="another_child_of_sample_object"/&gt;
2832        &lt;/node&gt;
2833       </programlisting>
2834     </para>
2835     <para>
2836       A more formal DTD and spec needs writing, but here are some quick notes.
2837       <itemizedlist>
2838         <listitem>
2839           <para>
2840             Only the root &lt;node&gt; element can omit the node name, as it's
2841             known to be the object that was introspected.  If the root
2842             &lt;node&gt; does have a name attribute, it must be an absolute
2843             object path. If child &lt;node&gt; have object paths, they must be
2844             relative.
2845           </para>
2846         </listitem>
2847         <listitem>
2848           <para>
2849             If a child &lt;node&gt; has any sub-elements, then they
2850             must represent a complete introspection of the child.
2851             If a child &lt;node&gt; is empty, then it may or may
2852             not have sub-elements; the child must be introspected
2853             in order to find out. The intent is that if an object
2854             knows that its children are "fast" to introspect
2855             it can go ahead and return their information, but
2856             otherwise it can omit it.
2857           </para>
2858         </listitem>
2859         <listitem>
2860           <para>
2861             The direction element on &lt;arg&gt; may be omitted,
2862             in which case it defaults to "in" for method calls
2863             and "out" for signals. Signals only allow "out"
2864             so while direction may be specified, it's pointless.
2865           </para>
2866         </listitem>
2867         <listitem>
2868           <para>
2869             The possible directions are "in" and "out",
2870             unlike CORBA there is no "inout"
2871           </para>
2872         </listitem>
2873         <listitem>
2874           <para>
2875             The possible property access flags are
2876             "readwrite", "read", and "write"
2877           </para>
2878         </listitem>
2879         <listitem>
2880           <para>
2881             Multiple interfaces can of course be listed for
2882             one &lt;node&gt;.
2883           </para>
2884         </listitem>
2885         <listitem>
2886           <para>
2887             The "name" attribute on arguments is optional.
2888           </para>
2889         </listitem>
2890       </itemizedlist>
2891     </para>
2892     <para>
2893         Method, interface, property, and signal elements may have
2894         "annotations", which are generic key/value pairs of metadata.
2895         They are similar conceptually to Java's annotations and C# attributes.
2896         Well-known annotations:
2897      </para>
2898      <informaltable>
2899        <tgroup cols="3">
2900          <thead>
2901            <row>
2902              <entry>Name</entry>
2903              <entry>Values (separated by ,)</entry>
2904              <entry>Description</entry>
2905            </row>
2906          </thead>
2907          <tbody>
2908            <row>
2909              <entry>org.freedesktop.DBus.Deprecated</entry>
2910              <entry>true,false</entry>
2911              <entry>Whether or not the entity is deprecated; defaults to false</entry>
2912            </row>
2913            <row>
2914              <entry>org.freedesktop.DBus.GLib.CSymbol</entry>
2915              <entry>(string)</entry>
2916              <entry>The C symbol; may be used for methods and interfaces</entry>
2917            </row>
2918            <row>
2919              <entry>org.freedesktop.DBus.Method.NoReply</entry>
2920              <entry>true,false</entry>
2921              <entry>If set, don't expect a reply to the method call; defaults to false.</entry>
2922            </row>
2923            <row>
2924              <entry>org.freedesktop.DBus.Property.EmitsChangedSignal</entry>
2925              <entry>true,invalidates,false</entry>
2926              <entry>
2927                <para>
2928                  If set to <literal>false</literal>, the
2929                  <literal>org.freedesktop.DBus.Properties.PropertiesChanged</literal>
2930                  signal, see <xref
2931                  linkend="standard-interfaces-properties"/> is not
2932                  guaranteed to be emitted if the property changes.
2933                </para>
2934                <para>
2935                  If set to <literal>invalidates</literal> the signal
2936                  is emitted but the value is not included in the
2937                  signal.
2938                </para>
2939                <para>
2940                  If set to <literal>true</literal> the signal is
2941                  emitted with the value included.
2942                </para>
2943                <para>
2944                  The value for the annotation defaults to
2945                  <literal>true</literal> if the enclosing interface
2946                  element does not specify the annotation. Otherwise it
2947                  defaults to the value specified in the enclosing
2948                  interface element.
2949                </para>
2950              </entry>
2951            </row>
2952          </tbody>
2953        </tgroup>
2954      </informaltable>
2955   </sect1>
2956   <sect1 id="message-bus">
2957     <title>Message Bus Specification</title>
2958     <sect2 id="message-bus-overview">
2959       <title>Message Bus Overview</title>
2960       <para>
2961         The message bus accepts connections from one or more applications.
2962         Once connected, applications can exchange messages with other
2963         applications that are also connected to the bus.
2964       </para>
2965       <para>
2966         In order to route messages among connections, the message bus keeps a
2967         mapping from names to connections. Each connection has one
2968         unique-for-the-lifetime-of-the-bus name automatically assigned.
2969         Applications may request additional names for a connection. Additional
2970         names are usually "well-known names" such as
2971         "org.freedesktop.TextEditor". When a name is bound to a connection,
2972         that connection is said to <firstterm>own</firstterm> the name.
2973       </para>
2974       <para>
2975         The bus itself owns a special name, <literal>org.freedesktop.DBus</literal>.
2976         This name routes messages to the bus, allowing applications to make
2977         administrative requests. For example, applications can ask the bus
2978         to assign a name to a connection.
2979       </para>
2980       <para>
2981         Each name may have <firstterm>queued owners</firstterm>.  When an
2982         application requests a name for a connection and the name is already in
2983         use, the bus will optionally add the connection to a queue waiting for
2984         the name. If the current owner of the name disconnects or releases
2985         the name, the next connection in the queue will become the new owner.
2986       </para>
2987
2988       <para>
2989         This feature causes the right thing to happen if you start two text
2990         editors for example; the first one may request "org.freedesktop.TextEditor",
2991         and the second will be queued as a possible owner of that name. When
2992         the first exits, the second will take over.
2993       </para>
2994
2995       <para>
2996         Messages may have a <literal>DESTINATION</literal> field (see <xref
2997         linkend="message-protocol-header-fields"/>).  If the
2998         <literal>DESTINATION</literal> field is present, it specifies a message
2999         recipient by name. Method calls and replies normally specify this field.
3000       </para>
3001
3002       <para>
3003         Signals normally do not specify a destination; they are sent to all
3004         applications with <firstterm>message matching rules</firstterm> that
3005         match the message.
3006       </para>
3007
3008       <para>
3009         When the message bus receives a method call, if the
3010         <literal>DESTINATION</literal> field is absent, the call is taken to be
3011         a standard one-to-one message and interpreted by the message bus
3012         itself. For example, sending an
3013         <literal>org.freedesktop.DBus.Peer.Ping</literal> message with no
3014         <literal>DESTINATION</literal> will cause the message bus itself to
3015         reply to the ping immediately; the message bus will not make this
3016         message visible to other applications.
3017       </para>
3018
3019       <para>
3020         Continuing the <literal>org.freedesktop.DBus.Peer.Ping</literal> example, if
3021         the ping message were sent with a <literal>DESTINATION</literal> name of
3022         <literal>com.yoyodyne.Screensaver</literal>, then the ping would be
3023         forwarded, and the Yoyodyne Corporation screensaver application would be
3024         expected to reply to the ping.
3025       </para>
3026     </sect2>
3027
3028     <sect2 id="message-bus-names">
3029       <title>Message Bus Names</title>
3030       <para>
3031         Each connection has at least one name, assigned at connection time and
3032         returned in response to the
3033         <literal>org.freedesktop.DBus.Hello</literal> method call.  This
3034         automatically-assigned name is called the connection's <firstterm>unique
3035         name</firstterm>.  Unique names are never reused for two different
3036         connections to the same bus.
3037       </para>
3038       <para>
3039         Ownership of a unique name is a prerequisite for interaction with
3040         the message bus. It logically follows that the unique name is always
3041         the first name that an application comes to own, and the last
3042         one that it loses ownership of.
3043       </para>
3044       <para>
3045         Unique connection names must begin with the character ':' (ASCII colon
3046         character); bus names that are not unique names must not begin
3047         with this character. (The bus must reject any attempt by an application
3048         to manually request a name beginning with ':'.) This restriction
3049         categorically prevents "spoofing"; messages sent to a unique name
3050         will always go to the expected connection.
3051       </para>
3052       <para>
3053         When a connection is closed, all the names that it owns are deleted (or
3054         transferred to the next connection in the queue if any).
3055       </para>
3056       <para>
3057         A connection can request additional names to be associated with it using
3058         the <literal>org.freedesktop.DBus.RequestName</literal> message. <xref
3059         linkend="message-protocol-names-bus"/> describes the format of a valid
3060         name. These names can be released again using the
3061         <literal>org.freedesktop.DBus.ReleaseName</literal> message.
3062       </para>
3063
3064       <sect3 id="bus-messages-request-name">
3065         <title><literal>org.freedesktop.DBus.RequestName</literal></title>
3066         <para>
3067           As a method:
3068           <programlisting>
3069             UINT32 RequestName (in STRING name, in UINT32 flags)
3070           </programlisting>
3071           Message arguments:
3072           <informaltable>
3073             <tgroup cols="3">
3074               <thead>
3075                 <row>
3076                   <entry>Argument</entry>
3077                   <entry>Type</entry>
3078                   <entry>Description</entry>
3079                 </row>
3080               </thead>
3081               <tbody>
3082                 <row>
3083                   <entry>0</entry>
3084                   <entry>STRING</entry>
3085                   <entry>Name to request</entry>
3086                 </row>
3087                 <row>
3088                   <entry>1</entry>
3089                   <entry>UINT32</entry>
3090                   <entry>Flags</entry>
3091                 </row>
3092               </tbody>
3093             </tgroup>
3094           </informaltable>
3095           Reply arguments:
3096           <informaltable>
3097             <tgroup cols="3">
3098               <thead>
3099                 <row>
3100                   <entry>Argument</entry>
3101                   <entry>Type</entry>
3102                   <entry>Description</entry>
3103                 </row>
3104               </thead>
3105               <tbody>
3106                 <row>
3107                   <entry>0</entry>
3108                   <entry>UINT32</entry>
3109                   <entry>Return value</entry>
3110                 </row>
3111               </tbody>
3112             </tgroup>
3113           </informaltable>
3114         </para>
3115         <para>
3116           This method call should be sent to
3117           <literal>org.freedesktop.DBus</literal> and asks the message bus to
3118           assign the given name to the method caller. Each name maintains a
3119           queue of possible owners, where the head of the queue is the primary
3120           or current owner of the name. Each potential owner in the queue
3121           maintains the DBUS_NAME_FLAG_ALLOW_REPLACEMENT and
3122           DBUS_NAME_FLAG_DO_NOT_QUEUE settings from its latest RequestName
3123           call.  When RequestName is invoked the following occurs:
3124           <itemizedlist>
3125             <listitem>
3126               <para>
3127                 If the method caller is currently the primary owner of the name,
3128                 the DBUS_NAME_FLAG_ALLOW_REPLACEMENT and DBUS_NAME_FLAG_DO_NOT_QUEUE
3129                 values are updated with the values from the new RequestName call,
3130                 and nothing further happens.
3131               </para>
3132             </listitem>
3133
3134             <listitem>
3135               <para>
3136                 If the current primary owner (head of the queue) has
3137                 DBUS_NAME_FLAG_ALLOW_REPLACEMENT set, and the RequestName
3138                 invocation has the DBUS_NAME_FLAG_REPLACE_EXISTING flag, then
3139                 the caller of RequestName replaces the current primary owner at
3140                 the head of the queue and the current primary owner moves to the
3141                 second position in the queue. If the caller of RequestName was
3142                 in the queue previously its flags are updated with the values from
3143                 the new RequestName in addition to moving it to the head of the queue.
3144               </para>
3145             </listitem>
3146
3147             <listitem>
3148               <para>
3149                 If replacement is not possible, and the method caller is
3150                 currently in the queue but not the primary owner, its flags are
3151                 updated with the values from the new RequestName call.
3152               </para>
3153             </listitem>
3154
3155             <listitem>
3156               <para>
3157                 If replacement is not possible, and the method caller is
3158                 currently not in the queue, the method caller is appended to the
3159                 queue.
3160               </para>
3161             </listitem>
3162
3163             <listitem>
3164               <para>
3165                 If any connection in the queue has DBUS_NAME_FLAG_DO_NOT_QUEUE
3166                 set and is not the primary owner, it is removed from the
3167                 queue. This can apply to the previous primary owner (if it
3168                 was replaced) or the method caller (if it updated the
3169                 DBUS_NAME_FLAG_DO_NOT_QUEUE flag while still stuck in the
3170                 queue, or if it was just added to the queue with that flag set).
3171               </para>
3172             </listitem>
3173           </itemizedlist>
3174         </para>
3175         <para>
3176           Note that DBUS_NAME_FLAG_REPLACE_EXISTING results in "jumping the
3177           queue," even if another application already in the queue had specified
3178           DBUS_NAME_FLAG_REPLACE_EXISTING.  This comes up if a primary owner
3179           that does not allow replacement goes away, and the next primary owner
3180           does allow replacement. In this case, queued items that specified
3181           DBUS_NAME_FLAG_REPLACE_EXISTING <emphasis>do not</emphasis>
3182           automatically replace the new primary owner. In other words,
3183           DBUS_NAME_FLAG_REPLACE_EXISTING is not saved, it is only used at the
3184           time RequestName is called. This is deliberate to avoid an infinite loop
3185           anytime two applications are both DBUS_NAME_FLAG_ALLOW_REPLACEMENT
3186           and DBUS_NAME_FLAG_REPLACE_EXISTING.
3187         </para>
3188         <para>
3189           The flags argument contains any of the following values logically ORed
3190           together:
3191
3192           <informaltable>
3193             <tgroup cols="3">
3194               <thead>
3195                 <row>
3196                   <entry>Conventional Name</entry>
3197                   <entry>Value</entry>
3198                   <entry>Description</entry>
3199                 </row>
3200               </thead>
3201               <tbody>
3202                 <row>
3203                   <entry>DBUS_NAME_FLAG_ALLOW_REPLACEMENT</entry>
3204                   <entry>0x1</entry>
3205                   <entry>
3206
3207                     If an application A specifies this flag and succeeds in
3208                     becoming the owner of the name, and another application B
3209                     later calls RequestName with the
3210                     DBUS_NAME_FLAG_REPLACE_EXISTING flag, then application A
3211                     will lose ownership and receive a
3212                     <literal>org.freedesktop.DBus.NameLost</literal> signal, and
3213                     application B will become the new owner. If DBUS_NAME_FLAG_ALLOW_REPLACEMENT
3214                     is not specified by application A, or DBUS_NAME_FLAG_REPLACE_EXISTING
3215                     is not specified by application B, then application B will not replace
3216                     application A as the owner.
3217
3218                   </entry>
3219                 </row>
3220                 <row>
3221                   <entry>DBUS_NAME_FLAG_REPLACE_EXISTING</entry>
3222                   <entry>0x2</entry>
3223                   <entry>
3224
3225                     Try to replace the current owner if there is one. If this
3226                     flag is not set the application will only become the owner of
3227                     the name if there is no current owner. If this flag is set,
3228                     the application will replace the current owner if
3229                     the current owner specified DBUS_NAME_FLAG_ALLOW_REPLACEMENT.
3230
3231                   </entry>
3232                 </row>
3233                 <row>
3234                   <entry>DBUS_NAME_FLAG_DO_NOT_QUEUE</entry>
3235                   <entry>0x4</entry>
3236                   <entry>
3237
3238                     Without this flag, if an application requests a name that is
3239                     already owned, the application will be placed in a queue to
3240                     own the name when the current owner gives it up. If this
3241                     flag is given, the application will not be placed in the
3242                     queue, the request for the name will simply fail.  This flag
3243                     also affects behavior when an application is replaced as
3244                     name owner; by default the application moves back into the
3245                     waiting queue, unless this flag was provided when the application
3246                     became the name owner.
3247
3248                   </entry>
3249                 </row>
3250               </tbody>
3251             </tgroup>
3252           </informaltable>
3253
3254           The return code can be one of the following values:
3255
3256           <informaltable>
3257             <tgroup cols="3">
3258               <thead>
3259                 <row>
3260                   <entry>Conventional Name</entry>
3261                   <entry>Value</entry>
3262                   <entry>Description</entry>
3263                 </row>
3264               </thead>
3265               <tbody>
3266                 <row>
3267                   <entry>DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER</entry>
3268                   <entry>1</entry> <entry>The caller is now the primary owner of
3269                   the name, replacing any previous owner. Either the name had no
3270                   owner before, or the caller specified
3271                   DBUS_NAME_FLAG_REPLACE_EXISTING and the current owner specified
3272                   DBUS_NAME_FLAG_ALLOW_REPLACEMENT.</entry>
3273                 </row>
3274                 <row>
3275                   <entry>DBUS_REQUEST_NAME_REPLY_IN_QUEUE</entry>
3276                   <entry>2</entry>
3277
3278                   <entry>The name already had an owner,
3279                     DBUS_NAME_FLAG_DO_NOT_QUEUE was not specified, and either
3280                     the current owner did not specify
3281                     DBUS_NAME_FLAG_ALLOW_REPLACEMENT or the requesting
3282                     application did not specify DBUS_NAME_FLAG_REPLACE_EXISTING.
3283                     </entry>
3284                 </row>
3285                 <row>
3286                   <entry>DBUS_REQUEST_NAME_REPLY_EXISTS</entry> <entry>3</entry>
3287                   <entry>The name already has an owner,
3288                   DBUS_NAME_FLAG_DO_NOT_QUEUE was specified, and either
3289                   DBUS_NAME_FLAG_ALLOW_REPLACEMENT was not specified by the
3290                   current owner, or DBUS_NAME_FLAG_REPLACE_EXISTING was not
3291                   specified by the requesting application.</entry>
3292                 </row>
3293                 <row>
3294                   <entry>DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER</entry>
3295                   <entry>4</entry>
3296                   <entry>The application trying to request ownership of a name is already the owner of it.</entry>
3297                 </row>
3298               </tbody>
3299             </tgroup>
3300           </informaltable>
3301         </para>
3302        </sect3>
3303
3304        <sect3 id="bus-messages-release-name">
3305         <title><literal>org.freedesktop.DBus.ReleaseName</literal></title>
3306         <para>
3307           As a method:
3308           <programlisting>
3309             UINT32 ReleaseName (in STRING name)
3310           </programlisting>
3311           Message arguments:
3312           <informaltable>
3313             <tgroup cols="3">
3314               <thead>
3315                 <row>
3316                   <entry>Argument</entry>
3317                   <entry>Type</entry>
3318                   <entry>Description</entry>
3319                 </row>
3320               </thead>
3321               <tbody>
3322                 <row>
3323                   <entry>0</entry>
3324                   <entry>STRING</entry>
3325                   <entry>Name to release</entry>
3326                 </row>
3327               </tbody>
3328             </tgroup>
3329           </informaltable>
3330           Reply arguments:
3331           <informaltable>
3332             <tgroup cols="3">
3333               <thead>
3334                 <row>
3335                   <entry>Argument</entry>
3336                   <entry>Type</entry>
3337                   <entry>Description</entry>
3338                 </row>
3339               </thead>
3340               <tbody>
3341                 <row>
3342                   <entry>0</entry>
3343                   <entry>UINT32</entry>
3344                   <entry>Return value</entry>
3345                 </row>
3346               </tbody>
3347             </tgroup>
3348           </informaltable>
3349         </para>
3350         <para>
3351           This method call should be sent to
3352           <literal>org.freedesktop.DBus</literal> and asks the message bus to
3353           release the method caller's claim to the given name. If the caller is
3354           the primary owner, a new primary owner will be selected from the
3355           queue if any other owners are waiting. If the caller is waiting in
3356           the queue for the name, the caller will removed from the queue and
3357           will not be made an owner of the name if it later becomes available.
3358           If there are no other owners in the queue for the name, it will be
3359           removed from the bus entirely.
3360
3361           The return code can be one of the following values:
3362
3363           <informaltable>
3364             <tgroup cols="3">
3365               <thead>
3366                 <row>
3367                   <entry>Conventional Name</entry>
3368                   <entry>Value</entry>
3369                   <entry>Description</entry>
3370                 </row>
3371               </thead>
3372               <tbody>
3373                 <row>
3374                   <entry>DBUS_RELEASE_NAME_REPLY_RELEASED</entry>
3375                   <entry>1</entry> <entry>The caller has released his claim on
3376                   the given name. Either the caller was the primary owner of
3377                   the name, and the name is now unused or taken by somebody
3378                   waiting in the queue for the name, or the caller was waiting
3379                   in the queue for the name and has now been removed from the
3380                   queue.</entry>
3381                 </row>
3382                 <row>
3383                   <entry>DBUS_RELEASE_NAME_REPLY_NON_EXISTENT</entry>
3384                   <entry>2</entry>
3385                   <entry>The given name does not exist on this bus.</entry>
3386                 </row>
3387                 <row>
3388                   <entry>DBUS_RELEASE_NAME_REPLY_NOT_OWNER</entry>
3389                   <entry>3</entry>
3390                   <entry>The caller was not the primary owner of this name,
3391                   and was also not waiting in the queue to own this name.</entry>
3392                 </row>
3393               </tbody>
3394             </tgroup>
3395           </informaltable>
3396         </para>
3397        </sect3>
3398
3399        <sect3 id="bus-messages-list-queued-owners">
3400         <title><literal>org.freedesktop.DBus.ListQueuedOwners</literal></title>
3401         <para>
3402           As a method:
3403           <programlisting>
3404             ARRAY of STRING ListQueuedOwners (in STRING name)
3405           </programlisting>
3406           Message arguments:
3407           <informaltable>
3408             <tgroup cols="3">
3409               <thead>
3410                 <row>
3411                   <entry>Argument</entry>
3412                   <entry>Type</entry>
3413                   <entry>Description</entry>
3414                 </row>
3415               </thead>
3416               <tbody>
3417                 <row>
3418                   <entry>0</entry>
3419                   <entry>STRING</entry>
3420                   <entry>The well-known bus name to query, such as
3421                     <literal>com.example.cappuccino</literal></entry>
3422                 </row>
3423               </tbody>
3424             </tgroup>
3425           </informaltable>
3426           Reply arguments:
3427           <informaltable>
3428             <tgroup cols="3">
3429               <thead>
3430                 <row>
3431                   <entry>Argument</entry>
3432                   <entry>Type</entry>
3433                   <entry>Description</entry>
3434                 </row>
3435               </thead>
3436               <tbody>
3437                 <row>
3438                   <entry>0</entry>
3439                   <entry>ARRAY of STRING</entry>
3440                   <entry>The unique bus names of connections currently queued
3441                     for the name</entry>
3442                 </row>
3443               </tbody>
3444             </tgroup>
3445           </informaltable>
3446         </para>
3447         <para>
3448           This method call should be sent to
3449           <literal>org.freedesktop.DBus</literal> and lists the connections
3450           currently queued for a bus name (see
3451           <xref linkend="term-queued-owner"/>).
3452         </para>
3453        </sect3>
3454     </sect2>
3455
3456     <sect2 id="message-bus-routing">
3457       <title>Message Bus Message Routing</title>
3458       <para>
3459         FIXME
3460       </para>
3461       <sect3 id="message-bus-routing-match-rules">
3462         <title>Match Rules</title>
3463         <para>
3464           An important part of the message bus routing protocol is match
3465           rules. Match rules describe what messages can be sent to a client
3466           based on the contents of the message.  When a message is routed
3467           through the bus it is compared to clients' match rules.  If any
3468           of the rules match, the message is dispatched to the client.
3469           If none of the rules match the message never leaves the bus.  This
3470           is an effective way to control traffic over the bus and to make sure
3471           only relevant message need to be processed by the client.
3472         </para>
3473         <para>
3474           Match rules are added using the AddMatch bus method
3475           (see <xref linkend="bus-messages-add-match"/>).  Rules are
3476           specified as a string of comma separated key/value pairs.
3477           Excluding a key from the rule indicates a wildcard match.
3478           For instance excluding the the member from a match rule but
3479           adding a sender would let all messages from that sender through.
3480           An example of a complete rule would be
3481           "type='signal',sender='org.freedesktop.DBus',interface='org.freedesktop.DBus',member='Foo',path='/bar/foo',destination=':452345.34',arg2='bar'"
3482         </para>
3483         <para>
3484           The following table describes the keys that can be used to create
3485           a match rule:
3486           The following table summarizes the D-Bus types.
3487           <informaltable>
3488             <tgroup cols="3">
3489               <thead>
3490                 <row>
3491                   <entry>Key</entry>
3492                   <entry>Possible Values</entry>
3493                   <entry>Description</entry>
3494                 </row>
3495               </thead>
3496               <tbody>
3497                 <row>
3498                   <entry><literal>type</literal></entry>
3499                   <entry>'signal', 'method_call', 'method_return', 'error'</entry>
3500                   <entry>Match on the message type.  An example of a type match is type='signal'</entry>
3501                 </row>
3502                 <row>
3503                   <entry><literal>sender</literal></entry>
3504                   <entry>A bus or unique name (see <xref linkend="term-bus-name"/>
3505                   and <xref linkend="term-unique-name"/> respectively)
3506                   </entry>
3507                   <entry>Match messages sent by a particular sender.  An example of a sender match
3508                   is sender='org.freedesktop.Hal'</entry>
3509                 </row>
3510                 <row>
3511                   <entry><literal>interface</literal></entry>
3512                   <entry>An interface name (see <xref linkend="message-protocol-names-interface"/>)</entry>
3513                   <entry>Match messages sent over or to a particular interface.  An example of an
3514                   interface match is interface='org.freedesktop.Hal.Manager'.
3515                   If a message omits the interface header, it must not match any rule
3516                   that specifies this key.</entry>
3517                 </row>
3518                 <row>
3519                   <entry><literal>member</literal></entry>
3520                   <entry>Any valid method or signal name</entry>
3521                   <entry>Matches messages which have the give method or signal name. An example of
3522                   a member match is member='NameOwnerChanged'</entry>
3523                 </row>
3524                 <row>
3525                   <entry><literal>path</literal></entry>
3526                   <entry>An object path (see <xref linkend="message-protocol-marshaling-object-path"/>)</entry>
3527                   <entry>Matches messages which are sent from or to the given object. An example of a
3528                   path match is path='/org/freedesktop/Hal/Manager'</entry>
3529                 </row>
3530                 <row>
3531                   <entry><literal>destination</literal></entry>
3532                   <entry>A unique name (see <xref linkend="term-unique-name"/>)</entry>
3533                   <entry>Matches messages which are being sent to the given unique name. An
3534                   example of a destination match is destination=':1.0'</entry>
3535                 </row>
3536                 <row>
3537                   <entry><literal>arg[0, 1, 2, 3, ...]</literal></entry>
3538                   <entry>Any string</entry>
3539                   <entry>Arg matches are special and are used for further restricting the
3540                   match based on the arguments in the body of a message.  As of this time
3541                   only string arguments can be matched.  An example of an argument match
3542                   would be arg3='Foo'. Only argument indexes from 0 to 63 should be
3543                   accepted.</entry>
3544                 </row>
3545                 <row>
3546                   <entry><literal>arg[0, 1, 2, 3, ...]path</literal></entry>
3547                   <entry>Any string</entry>
3548                   <entry>Argument path matches provide a specialised form of wildcard
3549                   matching for path-like namespaces. As with normal argument matches,
3550                   if the argument is exactly equal to the string given in the match
3551                   rule then the rule is satisfied. Additionally, there is also a
3552                   match when either the string given in the match rule or the
3553                   appropriate message argument ends with '/' and is a prefix of the
3554                   other. An example argument path match is arg0path='/aa/bb/'. This
3555                   would match messages with first arguments of '/', '/aa/',
3556                   '/aa/bb/', '/aa/bb/cc/' and '/aa/bb/cc'. It would not match
3557                   messages with first arguments of '/aa/b', '/aa' or even '/aa/bb'.</entry>
3558                 </row>
3559               </tbody>
3560             </tgroup>
3561           </informaltable>
3562         </para>
3563       </sect3>
3564     </sect2>
3565     <sect2 id="message-bus-starting-services">
3566       <title>Message Bus Starting Services</title>
3567       <para>
3568         The message bus can start applications on behalf of other applications.
3569         In CORBA terms, this would be called <firstterm>activation</firstterm>.
3570         An application that can be started in this way is called a
3571         <firstterm>service</firstterm>.
3572       </para>
3573       <para>
3574         With D-Bus, starting a service is normally done by name. That is,
3575         applications ask the message bus to start some program that will own a
3576         well-known name, such as <literal>org.freedesktop.TextEditor</literal>.
3577         This implies a contract documented along with the name
3578         <literal>org.freedesktop.TextEditor</literal> for which objects
3579         the owner of that name will provide, and what interfaces those
3580         objects will have.
3581       </para>
3582       <para>
3583         To find an executable corresponding to a particular name, the bus daemon
3584         looks for <firstterm>service description files</firstterm>.  Service
3585         description files define a mapping from names to executables. Different
3586         kinds of message bus will look for these files in different places, see
3587         <xref linkend="message-bus-types"/>.
3588       </para>
3589       <para>
3590         [FIXME the file format should be much better specified than "similar to
3591         .desktop entries" esp. since desktop entries are already
3592         badly-specified. ;-)] Service description files have the ".service" file
3593         extension. The message bus will only load service description files
3594         ending with .service; all other files will be ignored.  The file format
3595         is similar to that of <ulink
3596         url="http://www.freedesktop.org/standards/desktop-entry-spec/desktop-entry-spec.html">desktop
3597         entries</ulink>. All service description files must be in UTF-8
3598         encoding. To ensure that there will be no name collisions, service files
3599         must be namespaced using the same mechanism as messages and service
3600         names.
3601
3602         <figure>
3603           <title>Example service description file</title>
3604           <programlisting>
3605             # Sample service description file
3606             [D-BUS Service]
3607             Names=org.freedesktop.ConfigurationDatabase;org.gnome.GConf;
3608             Exec=/usr/libexec/gconfd-2
3609           </programlisting>
3610         </figure>
3611       </para>
3612       <para>
3613         When an application asks to start a service by name, the bus daemon tries to
3614         find a service that will own that name. It then tries to spawn the
3615         executable associated with it. If this fails, it will report an
3616         error. [FIXME what happens if two .service files offer the same service;
3617         what kind of error is reported, should we have a way for the client to
3618         choose one?]
3619       </para>
3620       <para>
3621         The executable launched will have the environment variable
3622         <literal>DBUS_STARTER_ADDRESS</literal> set to the address of the
3623         message bus so it can connect and request the appropriate names.
3624       </para>
3625       <para>
3626         The executable being launched may want to know whether the message bus
3627         starting it is one of the well-known message buses (see <xref
3628         linkend="message-bus-types"/>). To facilitate this, the bus must also set
3629         the <literal>DBUS_STARTER_BUS_TYPE</literal> environment variable if it is one
3630         of the well-known buses. The currently-defined values for this variable
3631         are <literal>system</literal> for the systemwide message bus,
3632         and <literal>session</literal> for the per-login-session message
3633         bus. The new executable must still connect to the address given
3634         in <literal>DBUS_STARTER_ADDRESS</literal>, but may assume that the
3635         resulting connection is to the well-known bus.
3636       </para>
3637       <para>
3638         [FIXME there should be a timeout somewhere, either specified
3639         in the .service file, by the client, or just a global value
3640         and if the client being activated fails to connect within that
3641         timeout, an error should be sent back.]
3642       </para>
3643
3644       <sect3 id="message-bus-starting-services-scope">
3645         <title>Message Bus Service Scope</title>
3646         <para>
3647           The "scope" of a service is its "per-", such as per-session,
3648           per-machine, per-home-directory, or per-display. The reference
3649           implementation doesn't yet support starting services in a different
3650           scope from the message bus itself. So e.g. if you start a service
3651           on the session bus its scope is per-session.
3652         </para>
3653         <para>
3654           We could add an optional scope to a bus name. For example, for
3655           per-(display,session pair), we could have a unique ID for each display
3656           generated automatically at login and set on screen 0 by executing a
3657           special "set display ID" binary. The ID would be stored in a
3658           <literal>_DBUS_DISPLAY_ID</literal> property and would be a string of
3659           random bytes. This ID would then be used to scope names.
3660           Starting/locating a service could be done by ID-name pair rather than
3661           only by name.
3662         </para>
3663         <para>
3664           Contrast this with a per-display scope. To achieve that, we would
3665           want a single bus spanning all sessions using a given display.
3666           So we might set a <literal>_DBUS_DISPLAY_BUS_ADDRESS</literal>
3667           property on screen 0 of the display, pointing to this bus.
3668         </para>
3669       </sect3>
3670     </sect2>
3671
3672     <sect2 id="message-bus-types">
3673       <title>Well-known Message Bus Instances</title>
3674       <para>
3675         Two standard message bus instances are defined here, along with how
3676         to locate them and where their service files live.
3677       </para>
3678       <sect3 id="message-bus-types-login">
3679         <title>Login session message bus</title>
3680         <para>
3681           Each time a user logs in, a <firstterm>login session message
3682             bus</firstterm> may be started. All applications in the user's login
3683           session may interact with one another using this message bus.
3684         </para>
3685         <para>
3686           The address of the login session message bus is given
3687           in the <literal>DBUS_SESSION_BUS_ADDRESS</literal> environment
3688           variable. If that variable is not set, applications may
3689           also try to read the address from the X Window System root
3690           window property <literal>_DBUS_SESSION_BUS_ADDRESS</literal>.
3691           The root window property must have type <literal>STRING</literal>.
3692           The environment variable should have precedence over the
3693           root window property.
3694         </para>
3695         <para>
3696           [FIXME specify location of .service files, probably using
3697           DESKTOP_DIRS etc. from basedir specification, though login session
3698           bus is not really desktop-specific]
3699         </para>
3700       </sect3>
3701       <sect3 id="message-bus-types-system">
3702         <title>System message bus</title>
3703         <para>
3704           A computer may have a <firstterm>system message bus</firstterm>,
3705           accessible to all applications on the system. This message bus may be
3706           used to broadcast system events, such as adding new hardware devices,
3707           changes in the printer queue, and so forth.
3708         </para>
3709         <para>
3710           The address of the system message bus is given
3711           in the <literal>DBUS_SYSTEM_BUS_ADDRESS</literal> environment
3712           variable. If that variable is not set, applications should try
3713           to connect to the well-known address
3714           <literal>unix:path=/var/run/dbus/system_bus_socket</literal>.
3715           <footnote>
3716             <para>
3717               The D-Bus reference implementation actually honors the
3718               <literal>$(localstatedir)</literal> configure option
3719               for this address, on both client and server side.
3720             </para>
3721           </footnote>
3722         </para>
3723         <para>
3724           [FIXME specify location of system bus .service files]
3725         </para>
3726       </sect3>
3727     </sect2>
3728
3729     <sect2 id="message-bus-messages">
3730       <title>Message Bus Messages</title>
3731       <para>
3732         The special message bus name <literal>org.freedesktop.DBus</literal>
3733         responds to a number of additional messages.
3734       </para>
3735
3736       <sect3 id="bus-messages-hello">
3737         <title><literal>org.freedesktop.DBus.Hello</literal></title>
3738         <para>
3739           As a method:
3740           <programlisting>
3741             STRING Hello ()
3742           </programlisting>
3743           Reply arguments:
3744           <informaltable>
3745             <tgroup cols="3">
3746               <thead>
3747                 <row>
3748                   <entry>Argument</entry>
3749                   <entry>Type</entry>
3750                   <entry>Description</entry>
3751                 </row>
3752               </thead>
3753               <tbody>
3754                 <row>
3755                   <entry>0</entry>
3756                   <entry>STRING</entry>
3757                   <entry>Unique name assigned to the connection</entry>
3758                 </row>
3759               </tbody>
3760             </tgroup>
3761           </informaltable>
3762         </para>
3763         <para>
3764           Before an application is able to send messages to other applications
3765           it must send the <literal>org.freedesktop.DBus.Hello</literal> message
3766           to the message bus to obtain a unique name. If an application without
3767           a unique name tries to send a message to another application, or a
3768           message to the message bus itself that isn't the
3769           <literal>org.freedesktop.DBus.Hello</literal> message, it will be
3770           disconnected from the bus.
3771         </para>
3772         <para>
3773           There is no corresponding "disconnect" request; if a client wishes to
3774           disconnect from the bus, it simply closes the socket (or other
3775           communication channel).
3776         </para>
3777       </sect3>
3778       <sect3 id="bus-messages-list-names">
3779         <title><literal>org.freedesktop.DBus.ListNames</literal></title>
3780         <para>
3781           As a method:
3782           <programlisting>
3783             ARRAY of STRING ListNames ()
3784           </programlisting>
3785           Reply arguments:
3786           <informaltable>
3787             <tgroup cols="3">
3788               <thead>
3789                 <row>
3790                   <entry>Argument</entry>
3791                   <entry>Type</entry>
3792                   <entry>Description</entry>
3793                 </row>
3794               </thead>
3795               <tbody>
3796                 <row>
3797                   <entry>0</entry>
3798                   <entry>ARRAY of STRING</entry>
3799                   <entry>Array of strings where each string is a bus name</entry>
3800                 </row>
3801               </tbody>
3802             </tgroup>
3803           </informaltable>
3804         </para>
3805         <para>
3806           Returns a list of all currently-owned names on the bus.
3807         </para>
3808       </sect3>
3809       <sect3 id="bus-messages-list-activatable-names">
3810         <title><literal>org.freedesktop.DBus.ListActivatableNames</literal></title>
3811         <para>
3812           As a method:
3813           <programlisting>
3814             ARRAY of STRING ListActivatableNames ()
3815           </programlisting>
3816           Reply arguments:
3817           <informaltable>
3818             <tgroup cols="3">
3819               <thead>
3820                 <row>
3821                   <entry>Argument</entry>
3822                   <entry>Type</entry>
3823                   <entry>Description</entry>
3824                 </row>
3825               </thead>
3826               <tbody>
3827                 <row>
3828                   <entry>0</entry>
3829                   <entry>ARRAY of STRING</entry>
3830                   <entry>Array of strings where each string is a bus name</entry>
3831                 </row>
3832               </tbody>
3833             </tgroup>
3834           </informaltable>
3835         </para>
3836         <para>
3837           Returns a list of all names that can be activated on the bus.
3838         </para>
3839       </sect3>
3840       <sect3 id="bus-messages-name-exists">
3841         <title><literal>org.freedesktop.DBus.NameHasOwner</literal></title>
3842         <para>
3843           As a method:
3844           <programlisting>
3845             BOOLEAN NameHasOwner (in STRING name)
3846           </programlisting>
3847           Message arguments:
3848           <informaltable>
3849             <tgroup cols="3">
3850               <thead>
3851                 <row>
3852                   <entry>Argument</entry>
3853                   <entry>Type</entry>
3854                   <entry>Description</entry>
3855                 </row>
3856               </thead>
3857               <tbody>
3858                 <row>
3859                   <entry>0</entry>
3860                   <entry>STRING</entry>
3861                   <entry>Name to check</entry>
3862                 </row>
3863               </tbody>
3864             </tgroup>
3865           </informaltable>
3866           Reply arguments:
3867           <informaltable>
3868             <tgroup cols="3">
3869               <thead>
3870                 <row>
3871                   <entry>Argument</entry>
3872                   <entry>Type</entry>
3873                   <entry>Description</entry>
3874                 </row>
3875               </thead>
3876               <tbody>
3877                 <row>
3878                   <entry>0</entry>
3879                   <entry>BOOLEAN</entry>
3880                   <entry>Return value, true if the name exists</entry>
3881                 </row>
3882               </tbody>
3883             </tgroup>
3884           </informaltable>
3885         </para>
3886         <para>
3887           Checks if the specified name exists (currently has an owner).
3888         </para>
3889       </sect3>
3890
3891       <sect3 id="bus-messages-name-owner-changed">
3892         <title><literal>org.freedesktop.DBus.NameOwnerChanged</literal></title>
3893         <para>
3894           This is a signal:
3895           <programlisting>
3896             NameOwnerChanged (STRING name, STRING old_owner, STRING new_owner)
3897           </programlisting>
3898           Message arguments:
3899           <informaltable>
3900             <tgroup cols="3">
3901               <thead>
3902                 <row>
3903                   <entry>Argument</entry>
3904                   <entry>Type</entry>
3905                   <entry>Description</entry>
3906                 </row>
3907               </thead>
3908               <tbody>
3909                 <row>
3910                   <entry>0</entry>
3911                   <entry>STRING</entry>
3912                   <entry>Name with a new owner</entry>
3913                 </row>
3914                 <row>
3915                   <entry>1</entry>
3916                   <entry>STRING</entry>
3917                   <entry>Old owner or empty string if none</entry>
3918                 </row>
3919                 <row>
3920                   <entry>2</entry>
3921                   <entry>STRING</entry>
3922                   <entry>New owner or empty string if none</entry>
3923                 </row>
3924               </tbody>
3925             </tgroup>
3926           </informaltable>
3927         </para>
3928         <para>
3929           This signal indicates that the owner of a name has changed.
3930           It's also the signal to use to detect the appearance of
3931           new names on the bus.
3932         </para>
3933       </sect3>
3934       <sect3 id="bus-messages-name-lost">
3935         <title><literal>org.freedesktop.DBus.NameLost</literal></title>
3936         <para>
3937           This is a signal:
3938           <programlisting>
3939             NameLost (STRING name)
3940           </programlisting>
3941           Message arguments:
3942           <informaltable>
3943             <tgroup cols="3">
3944               <thead>
3945                 <row>
3946                   <entry>Argument</entry>
3947                   <entry>Type</entry>
3948                   <entry>Description</entry>
3949                 </row>
3950               </thead>
3951               <tbody>
3952                 <row>
3953                   <entry>0</entry>
3954                   <entry>STRING</entry>
3955                   <entry>Name which was lost</entry>
3956                 </row>
3957               </tbody>
3958             </tgroup>
3959           </informaltable>
3960         </para>
3961         <para>
3962           This signal is sent to a specific application when it loses
3963           ownership of a name.
3964         </para>
3965       </sect3>
3966
3967       <sect3 id="bus-messages-name-acquired">
3968         <title><literal>org.freedesktop.DBus.NameAcquired</literal></title>
3969         <para>
3970           This is a signal:
3971           <programlisting>
3972             NameAcquired (STRING name)
3973           </programlisting>
3974           Message arguments:
3975           <informaltable>
3976             <tgroup cols="3">
3977               <thead>
3978                 <row>
3979                   <entry>Argument</entry>
3980                   <entry>Type</entry>
3981                   <entry>Description</entry>
3982                 </row>
3983               </thead>
3984               <tbody>
3985                 <row>
3986                   <entry>0</entry>
3987                   <entry>STRING</entry>
3988                   <entry>Name which was acquired</entry>
3989                 </row>
3990               </tbody>
3991             </tgroup>
3992           </informaltable>
3993         </para>
3994         <para>
3995           This signal is sent to a specific application when it gains
3996           ownership of a name.
3997         </para>
3998       </sect3>
3999
4000       <sect3 id="bus-messages-start-service-by-name">
4001         <title><literal>org.freedesktop.DBus.StartServiceByName</literal></title>
4002         <para>
4003           As a method:
4004           <programlisting>
4005             UINT32 StartServiceByName (in STRING name, in UINT32 flags)
4006           </programlisting>
4007           Message arguments:
4008           <informaltable>
4009             <tgroup cols="3">
4010               <thead>
4011                 <row>
4012                   <entry>Argument</entry>
4013                   <entry>Type</entry>
4014                   <entry>Description</entry>
4015                 </row>
4016               </thead>
4017               <tbody>
4018                 <row>
4019                   <entry>0</entry>
4020                   <entry>STRING</entry>
4021                   <entry>Name of the service to start</entry>
4022                 </row>
4023                 <row>
4024                   <entry>1</entry>
4025                   <entry>UINT32</entry>
4026                   <entry>Flags (currently not used)</entry>
4027                 </row>
4028               </tbody>
4029             </tgroup>
4030           </informaltable>
4031         Reply arguments:
4032         <informaltable>
4033           <tgroup cols="3">
4034             <thead>
4035               <row>
4036                 <entry>Argument</entry>
4037                 <entry>Type</entry>
4038                 <entry>Description</entry>
4039               </row>
4040             </thead>
4041             <tbody>
4042               <row>
4043                 <entry>0</entry>
4044                 <entry>UINT32</entry>
4045                 <entry>Return value</entry>
4046               </row>
4047             </tbody>
4048           </tgroup>
4049         </informaltable>
4050           Tries to launch the executable associated with a name. For more information, see <xref linkend="message-bus-starting-services"/>.
4051
4052         </para>
4053         <para>
4054           The return value can be one of the following values:
4055           <informaltable>
4056             <tgroup cols="3">
4057               <thead>
4058                 <row>
4059                   <entry>Identifier</entry>
4060                   <entry>Value</entry>
4061                   <entry>Description</entry>
4062                 </row>
4063               </thead>
4064               <tbody>
4065                 <row>
4066                   <entry>DBUS_START_REPLY_SUCCESS</entry>
4067                   <entry>1</entry>
4068                   <entry>The service was successfully started.</entry>
4069                 </row>
4070                 <row>
4071                   <entry>DBUS_START_REPLY_ALREADY_RUNNING</entry>
4072                   <entry>2</entry>
4073                   <entry>A connection already owns the given name.</entry>
4074                 </row>
4075               </tbody>
4076              </tgroup>
4077            </informaltable>
4078         </para>
4079
4080       </sect3>
4081
4082       <sect3 id="bus-messages-update-activation-environment">
4083         <title><literal>org.freedesktop.DBus.UpdateActivationEnvironment</literal></title>
4084         <para>
4085           As a method:
4086           <programlisting>
4087             UpdateActivationEnvironment (in ARRAY of DICT&lt;STRING,STRING&gt; environment)
4088           </programlisting>
4089           Message arguments:
4090           <informaltable>
4091             <tgroup cols="3">
4092               <thead>
4093                 <row>
4094                   <entry>Argument</entry>
4095                   <entry>Type</entry>
4096                   <entry>Description</entry>
4097                 </row>
4098               </thead>
4099               <tbody>
4100                 <row>
4101                   <entry>0</entry>
4102                   <entry>ARRAY of DICT&lt;STRING,STRING&gt;</entry>
4103                   <entry>Environment to add or update</entry>
4104                 </row>
4105               </tbody>
4106             </tgroup>
4107             </informaltable>
4108             Normally, session bus activated services inherit the environment of the bus daemon.  This method adds to or modifies that environment when activating services.
4109         </para>
4110         <para>
4111           Some bus instances, such as the standard system bus, may disable access to this method for some or all callers.
4112         </para>
4113         <para>
4114           Note, both the environment variable names and values must be valid UTF-8.  There's no way to update the activation environment with data that is invalid UTF-8.
4115         </para>
4116
4117       </sect3>
4118
4119       <sect3 id="bus-messages-get-name-owner">
4120         <title><literal>org.freedesktop.DBus.GetNameOwner</literal></title>
4121         <para>
4122           As a method:
4123           <programlisting>
4124             STRING GetNameOwner (in STRING name)
4125           </programlisting>
4126           Message arguments:
4127           <informaltable>
4128             <tgroup cols="3">
4129               <thead>
4130                 <row>
4131                   <entry>Argument</entry>
4132                   <entry>Type</entry>
4133                   <entry>Description</entry>
4134                 </row>
4135               </thead>
4136               <tbody>
4137                 <row>
4138                   <entry>0</entry>
4139                   <entry>STRING</entry>
4140                   <entry>Name to get the owner of</entry>
4141                 </row>
4142               </tbody>
4143             </tgroup>
4144           </informaltable>
4145         Reply arguments:
4146         <informaltable>
4147           <tgroup cols="3">
4148             <thead>
4149               <row>
4150                 <entry>Argument</entry>
4151                 <entry>Type</entry>
4152                 <entry>Description</entry>
4153               </row>
4154             </thead>
4155             <tbody>
4156               <row>
4157                 <entry>0</entry>
4158                 <entry>STRING</entry>
4159                 <entry>Return value, a unique connection name</entry>
4160               </row>
4161             </tbody>
4162           </tgroup>
4163         </informaltable>
4164         Returns the unique connection name of the primary owner of the name
4165         given. If the requested name doesn't have an owner, returns a
4166         <literal>org.freedesktop.DBus.Error.NameHasNoOwner</literal> error.
4167        </para>
4168       </sect3>
4169
4170       <sect3 id="bus-messages-get-connection-unix-user">
4171         <title><literal>org.freedesktop.DBus.GetConnectionUnixUser</literal></title>
4172         <para>
4173           As a method:
4174           <programlisting>
4175             UINT32 GetConnectionUnixUser (in STRING connection_name)
4176           </programlisting>
4177           Message arguments:
4178           <informaltable>
4179             <tgroup cols="3">
4180               <thead>
4181                 <row>
4182                   <entry>Argument</entry>
4183                   <entry>Type</entry>
4184                   <entry>Description</entry>
4185                 </row>
4186               </thead>
4187               <tbody>
4188                 <row>
4189                   <entry>0</entry>
4190                   <entry>STRING</entry>
4191                   <entry>Name of the connection to query</entry>
4192                 </row>
4193               </tbody>
4194             </tgroup>
4195           </informaltable>
4196         Reply arguments:
4197         <informaltable>
4198           <tgroup cols="3">
4199             <thead>
4200               <row>
4201                 <entry>Argument</entry>
4202                 <entry>Type</entry>
4203                 <entry>Description</entry>
4204               </row>
4205             </thead>
4206             <tbody>
4207               <row>
4208                 <entry>0</entry>
4209                 <entry>UINT32</entry>
4210                 <entry>unix user id</entry>
4211               </row>
4212             </tbody>
4213           </tgroup>
4214         </informaltable>
4215         Returns the unix uid of the process connected to the server. If unable to
4216         determine it, a <literal>org.freedesktop.DBus.Error.Failed</literal>
4217         error is returned.
4218        </para>
4219       </sect3>
4220
4221       <sect3 id="bus-messages-get-connection-unix-process-id">
4222         <title><literal>org.freedesktop.DBus.GetConnectionUnixProcessID</literal></title>
4223         <para>
4224           As a method:
4225           <programlisting>
4226             UINT32 GetConnectionUnixProcessID (in STRING bus_name)
4227           </programlisting>
4228           Message arguments:
4229           <informaltable>
4230             <tgroup cols="3">
4231               <thead>
4232                 <row>
4233                   <entry>Argument</entry>
4234                   <entry>Type</entry>
4235                   <entry>Description</entry>
4236                 </row>
4237               </thead>
4238               <tbody>
4239                 <row>
4240                   <entry>0</entry>
4241                   <entry>STRING</entry>
4242                   <entry>Unique or well-known bus name of the connection to
4243                     query, such as <literal>:12.34</literal> or
4244                     <literal>com.example.tea</literal></entry>
4245                 </row>
4246               </tbody>
4247             </tgroup>
4248           </informaltable>
4249         Reply arguments:
4250         <informaltable>
4251           <tgroup cols="3">
4252             <thead>
4253               <row>
4254                 <entry>Argument</entry>
4255                 <entry>Type</entry>
4256                 <entry>Description</entry>
4257               </row>
4258             </thead>
4259             <tbody>
4260               <row>
4261                 <entry>0</entry>
4262                 <entry>UINT32</entry>
4263                 <entry>Unix process id</entry>
4264               </row>
4265             </tbody>
4266           </tgroup>
4267         </informaltable>
4268         Returns the Unix process ID of the process connected to the server. If
4269         unable to determine it (for instance, because the process is not on the
4270         same machine as the bus daemon), an error is returned.
4271        </para>
4272       </sect3>
4273
4274       <sect3 id="bus-messages-add-match">
4275         <title><literal>org.freedesktop.DBus.AddMatch</literal></title>
4276         <para>
4277           As a method:
4278           <programlisting>
4279             AddMatch (in STRING rule)
4280           </programlisting>
4281           Message arguments:
4282           <informaltable>
4283             <tgroup cols="3">
4284               <thead>
4285                 <row>
4286                   <entry>Argument</entry>
4287                   <entry>Type</entry>
4288                   <entry>Description</entry>
4289                 </row>
4290               </thead>
4291               <tbody>
4292                 <row>
4293                   <entry>0</entry>
4294                   <entry>STRING</entry>
4295                   <entry>Match rule to add to the connection</entry>
4296                 </row>
4297               </tbody>
4298             </tgroup>
4299           </informaltable>
4300         Adds a match rule to match messages going through the message bus (see <xref linkend='message-bus-routing-match-rules'/>).
4301         If the bus does not have enough resources the <literal>org.freedesktop.DBus.Error.OOM</literal>
4302         error is returned.
4303        </para>
4304       </sect3>
4305       <sect3 id="bus-messages-remove-match">
4306         <title><literal>org.freedesktop.DBus.RemoveMatch</literal></title>
4307         <para>
4308           As a method:
4309           <programlisting>
4310             RemoveMatch (in STRING rule)
4311           </programlisting>
4312           Message arguments:
4313           <informaltable>
4314             <tgroup cols="3">
4315               <thead>
4316                 <row>
4317                   <entry>Argument</entry>
4318                   <entry>Type</entry>
4319                   <entry>Description</entry>
4320                 </row>
4321               </thead>
4322               <tbody>
4323                 <row>
4324                   <entry>0</entry>
4325                   <entry>STRING</entry>
4326                   <entry>Match rule to remove from the connection</entry>
4327                 </row>
4328               </tbody>
4329             </tgroup>
4330           </informaltable>
4331         Removes the first rule that matches (see <xref linkend='message-bus-routing-match-rules'/>).
4332         If the rule is not found the <literal>org.freedesktop.DBus.Error.MatchRuleNotFound</literal>
4333         error is returned.
4334        </para>
4335       </sect3>
4336
4337       <sect3 id="bus-messages-get-id">
4338         <title><literal>org.freedesktop.DBus.GetId</literal></title>
4339         <para>
4340           As a method:
4341           <programlisting>
4342             GetId (out STRING id)
4343           </programlisting>
4344         Reply arguments:
4345         <informaltable>
4346           <tgroup cols="3">
4347             <thead>
4348               <row>
4349                 <entry>Argument</entry>
4350                 <entry>Type</entry>
4351                 <entry>Description</entry>
4352               </row>
4353             </thead>
4354             <tbody>
4355               <row>
4356                 <entry>0</entry>
4357                 <entry>STRING</entry>
4358                 <entry>Unique ID identifying the bus daemon</entry>
4359               </row>
4360             </tbody>
4361           </tgroup>
4362         </informaltable>
4363         Gets the unique ID of the bus. The unique ID here is shared among all addresses the
4364         bus daemon is listening on (TCP, UNIX domain socket, etc.) and its format is described in
4365         <xref linkend="uuids"/>. Each address the bus is listening on also has its own unique
4366         ID, as described in <xref linkend="addresses"/>. The per-bus and per-address IDs are not related.
4367         There is also a per-machine ID, described in <xref linkend="standard-interfaces-peer"/> and returned
4368         by org.freedesktop.DBus.Peer.GetMachineId().
4369         For a desktop session bus, the bus ID can be used as a way to uniquely identify a user's session.
4370         </para>
4371       </sect3>
4372
4373     </sect2>
4374
4375   </sect1>
4376 <!--
4377   <appendix id="implementation-notes">
4378     <title>Implementation notes</title>
4379     <sect1 id="implementation-notes-subsection">
4380       <title></title>
4381       <para>
4382       </para>
4383     </sect1>
4384   </appendix>
4385 -->
4386
4387   <glossary><title>Glossary</title>
4388     <para>
4389       This glossary defines some of the terms used in this specification.
4390     </para>
4391
4392     <glossentry id="term-bus-name"><glossterm>Bus Name</glossterm>
4393       <glossdef>
4394         <para>
4395           The message bus maintains an association between names and
4396           connections. (Normally, there's one connection per application.)  A
4397           bus name is simply an identifier used to locate connections. For
4398           example, the hypothetical <literal>com.yoyodyne.Screensaver</literal>
4399           name might be used to send a message to a screensaver from Yoyodyne
4400           Corporation.  An application is said to <firstterm>own</firstterm> a
4401           name if the message bus has associated the application's connection
4402           with the name.  Names may also have <firstterm>queued
4403           owners</firstterm> (see <xref linkend="term-queued-owner"/>).
4404             The bus assigns a unique name to each connection,
4405             see <xref linkend="term-unique-name"/>. Other names
4406               can be thought of as "well-known names" and are
4407               used to find applications that offer specific functionality.
4408         </para>
4409       </glossdef>
4410     </glossentry>
4411
4412     <glossentry id="term-message"><glossterm>Message</glossterm>
4413       <glossdef>
4414         <para>
4415           A message is the atomic unit of communication via the D-Bus
4416           protocol. It consists of a <firstterm>header</firstterm> and a
4417           <firstterm>body</firstterm>; the body is made up of
4418           <firstterm>arguments</firstterm>.
4419         </para>
4420       </glossdef>
4421     </glossentry>
4422
4423     <glossentry id="term-message-bus"><glossterm>Message Bus</glossterm>
4424       <glossdef>
4425         <para>
4426           The message bus is a special application that forwards
4427           or routes messages between a group of applications
4428           connected to the message bus. It also manages
4429           <firstterm>names</firstterm> used for routing
4430           messages.
4431         </para>
4432       </glossdef>
4433     </glossentry>
4434
4435     <glossentry id="term-name"><glossterm>Name</glossterm>
4436       <glossdef>
4437         <para>
4438           See <xref linkend="term-bus-name"/>. "Name" may
4439             also be used to refer to some of the other names
4440             in D-Bus, such as interface names.
4441         </para>
4442       </glossdef>
4443     </glossentry>
4444
4445     <glossentry id="namespace"><glossterm>Namespace</glossterm>
4446       <glossdef>
4447         <para>
4448           Used to prevent collisions when defining new interfaces or bus
4449           names. The convention used is the same one Java uses for defining
4450           classes: a reversed domain name.
4451         </para>
4452       </glossdef>
4453     </glossentry>
4454
4455     <glossentry id="term-object"><glossterm>Object</glossterm>
4456       <glossdef>
4457         <para>
4458           Each application contains <firstterm>objects</firstterm>, which have
4459           <firstterm>interfaces</firstterm> and
4460           <firstterm>methods</firstterm>. Objects are referred to by a name,
4461           called a <firstterm>path</firstterm>.
4462         </para>
4463       </glossdef>
4464     </glossentry>
4465
4466     <glossentry id="one-to-one"><glossterm>One-to-One</glossterm>
4467       <glossdef>
4468         <para>
4469           An application talking directly to another application, without going
4470           through a message bus. One-to-one connections may be "peer to peer" or
4471           "client to server." The D-Bus protocol has no concept of client
4472           vs. server after a connection has authenticated; the flow of messages
4473           is symmetrical (full duplex).
4474         </para>
4475       </glossdef>
4476     </glossentry>
4477
4478     <glossentry id="term-path"><glossterm>Path</glossterm>
4479       <glossdef>
4480         <para>
4481           Object references (object names) in D-Bus are organized into a
4482           filesystem-style hierarchy, so each object is named by a path. As in
4483           LDAP, there's no difference between "files" and "directories"; a path
4484           can refer to an object, while still having child objects below it.
4485         </para>
4486       </glossdef>
4487     </glossentry>
4488
4489     <glossentry id="term-queued-owner"><glossterm>Queued Name Owner</glossterm>
4490       <glossdef>
4491         <para>
4492           Each bus name has a primary owner; messages sent to the name go to the
4493           primary owner. However, certain names also maintain a queue of
4494           secondary owners "waiting in the wings." If the primary owner releases
4495           the name, then the first secondary owner in the queue automatically
4496           becomes the new owner of the name.
4497         </para>
4498       </glossdef>
4499     </glossentry>
4500
4501     <glossentry id="term-service"><glossterm>Service</glossterm>
4502       <glossdef>
4503         <para>
4504           A service is an executable that can be launched by the bus daemon.
4505           Services normally guarantee some particular features, for example they
4506           may guarantee that they will request a specific name such as
4507           "org.freedesktop.Screensaver", have a singleton object
4508           "/org/freedesktop/Application", and that object will implement the
4509           interface "org.freedesktop.ScreensaverControl".
4510         </para>
4511       </glossdef>
4512     </glossentry>
4513
4514     <glossentry id="term-service-description-files"><glossterm>Service Description Files</glossterm>
4515       <glossdef>
4516         <para>
4517           ".service files" tell the bus about service applications that can be
4518           launched (see <xref linkend="term-service"/>). Most importantly they
4519           provide a mapping from bus names to services that will request those
4520             names when they start up.
4521         </para>
4522       </glossdef>
4523     </glossentry>
4524
4525     <glossentry id="term-unique-name"><glossterm>Unique Connection Name</glossterm>
4526       <glossdef>
4527         <para>
4528           The special name automatically assigned to each connection by the
4529           message bus. This name will never change owner, and will be unique
4530           (never reused during the lifetime of the message bus).
4531           It will begin with a ':' character.
4532         </para>
4533       </glossdef>
4534     </glossentry>
4535
4536   </glossary>
4537 </article>