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