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