doc/dbus-specification.xml

   1 <?xml version="1.0" standalone="no" ?>
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
   4 [
   5 ]>
   6 <article id="index">
   7   <articleinfo>
   8     <title>D-Bus Specification</title>
   9     <releaseinfo>Version 0.26</releaseinfo>
  10     <date>2015-02-19</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       <author>
  43         <firstname>Sven</firstname>
  44         <surname>Herzberg</surname>
  45         <affiliation>
  46           <orgname>Imendio AB</orgname>
  47           <address>
  48             <email>sven@imendio.com</email>
  49           </address>
  50         </affiliation>
  51       </author>
  52       <author>
  53         <firstname>Simon</firstname>
  54         <surname>McVittie</surname>
  55         <affiliation>
  56           <orgname>Collabora Ltd.</orgname>
  57           <address>
  58             <email>simon.mcvittie@collabora.co.uk</email>
  59           </address>
  60         </affiliation>
  61       </author>
  62       <author>
  63         <firstname>David</firstname>
  64         <surname>Zeuthen</surname>
  65         <affiliation>
  66           <address>
  67             <email>zeuthen@gmail.com</email>
  68           </address>
  69         </affiliation>
  70       </author>
  71     </authorgroup>
  72    <revhistory>
  73      <revision>
  74        <revnumber>0.26</revnumber>
  75        <date>2015-02-19</date>
  76        <authorinitials>smcv, rh</authorinitials>
  77        <revremark>
  78          GetConnectionCredentials can return LinuxSecurityLabel or
  79          WindowsSID; add privileged BecomeMonitor method
  80        </revremark>
  81      </revision>
  82      <revision>
  83        <revnumber>0.25</revnumber>
  84        <date>2014-11-10</date>
  85        <authorinitials>smcv, lennart</authorinitials>
  86        <revremark>
  87          ALLOW_INTERACTIVE_AUTHORIZATION flag, EmitsChangedSignal=const
  88        </revremark>
  89      </revision>
  90      <revision>
  91        <revnumber>0.24</revnumber>
  92        <date>2014-10-01</date>
  93        <authorinitials>SMcV</authorinitials>
  94        <revremark>
  95          non-method-calls never expect a reply even without NO_REPLY_EXPECTED;
  96          document how to quote match rules
  97        </revremark>
  98      </revision>
  99      <revision>
 100        <revnumber>0.23</revnumber>
 101        <date>2014-01-06</date>
 102        <authorinitials>SMcV, CY</authorinitials>
 103        <revremark>
 104          method call messages with no INTERFACE may be considered an error;
 105          document tcp:bind=... and nonce-tcp:bind=...; define listenable
 106          and connectable addresses
 107        </revremark>
 108      </revision>
 109      <revision>
 110        <revnumber>0.22</revnumber>
 111        <date>2013-10-09</date>
 112        <authorinitials></authorinitials>
 113        <revremark>add GetConnectionCredentials, document
 114         GetAtdAuditSessionData, document GetConnectionSELinuxSecurityContext,
 115         document and correct .service file syntax and naming
 116       </revremark>
 117      </revision>
 118      <revision>
 119        <revnumber>0.21</revnumber>
 120        <date>2013-04-25</date>
 121        <authorinitials>smcv</authorinitials>
 122        <revremark>allow Unicode noncharacters in UTF-8 (Unicode
 123          Corrigendum #9)</revremark>
 124      </revision>
 125      <revision>
 126        <revnumber>0.20</revnumber>
 127        <date>22 February 2013</date>
 128        <authorinitials>smcv, walters</authorinitials>
 129        <revremark>reorganise for clarity, remove false claims about
 130          basic types, mention /o/fd/DBus</revremark>
 131      </revision>
 132      <revision>
 133        <revnumber>0.19</revnumber>
 134        <date>20 February 2012</date>
 135        <authorinitials>smcv/lp</authorinitials>
 136        <revremark>formally define unique connection names and well-known
 137         bus names; document best practices for interface, bus, member and
 138         error names, and object paths; document the search path for session
 139         and system services on Unix; document the systemd transport</revremark>
 140      </revision>
 141      <revision>
 142        <revnumber>0.18</revnumber>
 143        <date>29 July 2011</date>
 144        <authorinitials>smcv</authorinitials>
 145        <revremark>define eavesdropping, unicast, broadcast; add eavesdrop
 146          match keyword; promote type system to a top-level section</revremark>
 147      </revision>
 148      <revision>
 149        <revnumber>0.17</revnumber>
 150        <date>1 June 2011</date>
 151        <authorinitials>smcv/davidz</authorinitials>
 152        <revremark>define ObjectManager; reserve extra pseudo-type-codes used
 153          by GVariant</revremark>
 154      </revision>
 155      <revision>
 156        <revnumber>0.16</revnumber>
 157        <date>11 April 2011</date>
 158        <authorinitials></authorinitials>
 159        <revremark>add path_namespace, arg0namespace; argNpath matches object
 160         paths</revremark>
 161      </revision>
 162      <revision>
 163        <revnumber>0.15</revnumber>
 164        <date>3 November 2010</date>
 165        <authorinitials></authorinitials>
 166        <revremark></revremark>
 167      </revision>
 168      <revision>
 169        <revnumber>0.14</revnumber>
 170        <date>12 May 2010</date>
 171        <authorinitials></authorinitials>
 172        <revremark></revremark>
 173      </revision>
 174      <revision>
 175        <revnumber>0.13</revnumber>
 176        <date>23 Dezember 2009</date>
 177        <authorinitials></authorinitials>
 178        <revremark></revremark>
 179      </revision>
 180      <revision>
 181        <revnumber>0.12</revnumber>
 182        <date>7 November, 2006</date>
 183        <authorinitials></authorinitials>
 184        <revremark></revremark>
 185      </revision>
 186      <revision>
 187        <revnumber>0.11</revnumber>
 188        <date>6 February 2005</date>
 189        <authorinitials></authorinitials>
 190        <revremark></revremark>
 191      </revision>
 192      <revision>
 193        <revnumber>0.10</revnumber>
 194        <date>28 January 2005</date>
 195        <authorinitials></authorinitials>
 196        <revremark></revremark>
 197      </revision>
 198      <revision>
 199        <revnumber>0.9</revnumber>
 200        <date>7 Januar 2005</date>
 201        <authorinitials></authorinitials>
 202        <revremark></revremark>
 203      </revision>
 204      <revision>
 205        <revnumber>0.8</revnumber>
 206        <date>06 September 2003</date>
 207        <authorinitials></authorinitials>
 208        <revremark>First released document.</revremark>
 209      </revision>
 210    </revhistory>
 211   </articleinfo>
 212
 213   <sect1 id="introduction">
 214     <title>Introduction</title>
 215     <para>
 216       D-Bus is a system for low-overhead, easy to use
 217       interprocess communication (IPC). In more detail:
 218       <itemizedlist>
 219         <listitem>
 220           <para>
 221             D-Bus is <emphasis>low-overhead</emphasis> because it uses a
 222             binary protocol, and does not have to convert to and from a text
 223             format such as XML. Because D-Bus is intended for potentially
 224             high-resolution same-machine IPC, not primarily for Internet IPC,
 225             this is an interesting optimization. D-Bus is also designed to
 226             avoid round trips and allow asynchronous operation, much like
 227             the X protocol.
 228           </para>
 229         </listitem>
 230         <listitem>
 231           <para>
 232             D-Bus is <emphasis>easy to use</emphasis> because it works in terms
 233             of <firstterm>messages</firstterm> rather than byte streams, and
 234             automatically handles a lot of the hard IPC issues. Also, the D-Bus
 235             library is designed to be wrapped in a way that lets developers use
 236             their framework's existing object/type system, rather than learning
 237             a new one specifically for IPC.
 238           </para>
 239         </listitem>
 240       </itemizedlist>
 241     </para>
 242
 243     <para>
 244       The base D-Bus protocol is a one-to-one (peer-to-peer or client-server)
 245       protocol, specified in <xref linkend="message-protocol"/>. That is, it is
 246       a system for one application to talk to a single other
 247       application. However, the primary intended application of the protocol is the
 248       D-Bus <firstterm>message bus</firstterm>, specified in <xref
 249       linkend="message-bus"/>. The message bus is a special application that
 250       accepts connections from multiple other applications, and forwards
 251       messages among them.
 252     </para>
 253
 254     <para>
 255       Uses of D-Bus include notification of system changes (notification of when
 256       a camera is plugged in to a computer, or a new version of some software
 257       has been installed), or desktop interoperability, for example a file
 258       monitoring service or a configuration service.
 259     </para>
 260
 261     <para>
 262       D-Bus is designed for two specific use cases:
 263       <itemizedlist>
 264         <listitem>
 265           <para>
 266             A "system bus" for notifications from the system to user sessions,
 267             and to allow the system to request input from user sessions.
 268           </para>
 269         </listitem>
 270         <listitem>
 271           <para>
 272             A "session bus" used to implement desktop environments such as
 273             GNOME and KDE.
 274           </para>
 275         </listitem>
 276       </itemizedlist>
 277       D-Bus is not intended to be a generic IPC system for any possible
 278       application, and intentionally omits many features found in other
 279       IPC systems for this reason.
 280     </para>
 281
 282     <para>
 283       At the same time, the bus daemons offer a number of features not found in
 284       other IPC systems, such as single-owner "bus names" (similar to X
 285       selections), on-demand startup of services, and security policies.
 286       In many ways, these features are the primary motivation for developing
 287       D-Bus; other systems would have sufficed if IPC were the only goal.
 288     </para>
 289
 290     <para>
 291       D-Bus may turn out to be useful in unanticipated applications, but future
 292       versions of this spec and the reference implementation probably will not
 293       incorporate features that interfere with the core use cases.
 294     </para>
 295
 296     <para>
 297       The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
 298       "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
 299       document are to be interpreted as described in RFC 2119. However, the
 300       document could use a serious audit to be sure it makes sense to do
 301       so. Also, they are not capitalized.
 302     </para>
 303
 304     <sect2 id="stability">
 305       <title>Protocol and Specification Stability</title>
 306       <para>
 307         The D-Bus protocol is frozen (only compatible extensions are allowed) as
 308         of November 8, 2006.  However, this specification could still use a fair
 309         bit of work to make interoperable reimplementation possible without
 310         reference to the D-Bus reference implementation. Thus, this
 311         specification is not marked 1.0. To mark it 1.0, we'd like to see
 312         someone invest significant effort in clarifying the specification
 313         language, and growing the specification to cover more aspects of the
 314         reference implementation's behavior.
 315       </para>
 316       <para>
 317         Until this work is complete, any attempt to reimplement D-Bus will
 318         probably require looking at the reference implementation and/or asking
 319         questions on the D-Bus mailing list about intended behavior.
 320         Questions on the list are very welcome.
 321       </para>
 322       <para>
 323         Nonetheless, this document should be a useful starting point and is
 324         to our knowledge accurate, though incomplete.
 325       </para>
 326     </sect2>
 327
 328   </sect1>
 329
 330   <sect1 id="type-system">
 331     <title>Type System</title>
 332
 333     <para>
 334       D-Bus has a type system, in which values of various types can be
 335       serialized into a sequence of bytes referred to as the
 336       <firstterm>wire format</firstterm> in a standard way.
 337       Converting a value from some other representation into the wire
 338       format is called <firstterm>marshaling</firstterm> and converting
 339       it back from the wire format is <firstterm>unmarshaling</firstterm>.
 340     </para>
 341
 342     <para>
 343       The D-Bus protocol does not include type tags in the marshaled data; a
 344       block of marshaled values must have a known <firstterm>type
 345         signature</firstterm>. The type signature is made up of zero or more
 346       <firstterm id="term-single-complete-type">single complete
 347         types</firstterm>, each made up of one or more
 348       <firstterm>type codes</firstterm>.
 349     </para>
 350
 351     <para>
 352       A type code is an ASCII character representing the
 353       type of a value. Because ASCII characters are used, the type signature
 354       will always form a valid ASCII string. A simple string compare
 355       determines whether two type signatures are equivalent.
 356     </para>
 357
 358     <para>
 359       A single complete type is a sequence of type codes that fully describes
 360       one type: either a basic type, or a single fully-described container type.
 361       A single complete type is a basic type code, a variant type code,
 362       an array with its element type, or a struct with its fields (all of which
 363       are defined below). So the following signatures are not single complete
 364       types:
 365       <programlisting>
 366         "aa"
 367       </programlisting>
 368       <programlisting>
 369         "(ii"
 370       </programlisting>
 371       <programlisting>
 372         "ii)"
 373       </programlisting>
 374       And the following signatures contain multiple complete types:
 375       <programlisting>
 376         "ii"
 377       </programlisting>
 378       <programlisting>
 379         "aiai"
 380       </programlisting>
 381       <programlisting>
 382         "(ii)(ii)"
 383       </programlisting>
 384       Note however that a single complete type may <emphasis>contain</emphasis>
 385       multiple other single complete types, by containing a struct or dict
 386       entry.
 387     </para>
 388
 389     <sect2 id="basic-types">
 390       <title>Basic types</title>
 391
 392       <para>
 393         The simplest type codes are the <firstterm id="term-basic-type">basic
 394           types</firstterm>, which are the types whose structure is entirely
 395         defined by their 1-character type code. Basic types consist of
 396         fixed types and string-like types.
 397       </para>
 398
 399       <para>
 400         The <firstterm id="term-fixed-type">fixed types</firstterm>
 401         are basic types whose values have a fixed length, namely BYTE,
 402         BOOLEAN, DOUBLE, UNIX_FD, and signed or unsigned integers of length
 403         16, 32 or 64 bits.
 404       </para>
 405
 406       <para>
 407         As a simple example, the type code for 32-bit integer (<literal>INT32</literal>) is
 408         the ASCII character 'i'. So the signature for a block of values
 409         containing a single <literal>INT32</literal> would be:
 410         <programlisting>
 411           "i"
 412         </programlisting>
 413         A block of values containing two <literal>INT32</literal> would have this signature:
 414         <programlisting>
 415           "ii"
 416         </programlisting>
 417       </para>
 418
 419       <para>
 420         The characteristics of the fixed types are listed in this table.
 421
 422         <informaltable>
 423           <tgroup cols="3">
 424             <thead>
 425               <row>
 426                 <entry>Conventional name</entry>
 427                 <entry>ASCII type-code</entry>
 428                 <entry>Encoding</entry>
 429               </row>
 430             </thead>
 431             <tbody>
 432               <row>
 433                 <entry><literal>BYTE</literal></entry>
 434                 <entry><literal>y</literal> (121)</entry>
 435                 <entry>Unsigned 8-bit integer</entry>
 436               </row>
 437               <row>
 438                 <entry><literal>BOOLEAN</literal></entry>
 439                 <entry><literal>b</literal> (98)</entry>
 440                 <entry>Boolean value: 0 is false, 1 is true, any other value
 441                   allowed by the marshalling format is invalid</entry>
 442               </row>
 443               <row>
 444                 <entry><literal>INT16</literal></entry>
 445                 <entry><literal>n</literal> (110)</entry>
 446                 <entry>Signed (two's complement) 16-bit integer</entry>
 447               </row>
 448               <row>
 449                 <entry><literal>UINT16</literal></entry>
 450                 <entry><literal>q</literal> (113)</entry>
 451                 <entry>Unsigned 16-bit integer</entry>
 452               </row>
 453               <row>
 454                 <entry><literal>INT32</literal></entry>
 455                 <entry><literal>i</literal> (105)</entry>
 456                 <entry>Signed (two's complement) 32-bit integer</entry>
 457               </row>
 458               <row>
 459                 <entry><literal>UINT32</literal></entry>
 460                 <entry><literal>u</literal> (117)</entry>
 461                 <entry>Unsigned 32-bit integer</entry>
 462               </row>
 463               <row>
 464                 <entry><literal>INT64</literal></entry>
 465                 <entry><literal>x</literal> (120)</entry>
 466                 <entry>Signed (two's complement) 64-bit integer
 467                   (mnemonic: x and t are the first characters in "sixty" not
 468                   already used for something more common)</entry>
 469               </row>
 470               <row>
 471                 <entry><literal>UINT64</literal></entry>
 472                 <entry><literal>t</literal> (116)</entry>
 473                 <entry>Unsigned 64-bit integer</entry>
 474               </row>
 475               <row>
 476                 <entry><literal>DOUBLE</literal></entry>
 477                 <entry><literal>d</literal> (100)</entry>
 478                 <entry>IEEE 754 double-precision floating point</entry>
 479               </row>
 480               <row>
 481                 <entry><literal>UNIX_FD</literal></entry>
 482                 <entry><literal>h</literal> (104)</entry>
 483                 <entry>Unsigned 32-bit integer representing an index into an
 484                   out-of-band array of file descriptors, transferred via some
 485                   platform-specific mechanism (mnemonic: h for handle)</entry>
 486               </row>
 487             </tbody>
 488           </tgroup>
 489         </informaltable>
 490       </para>
 491
 492       <para>
 493         The <firstterm id="term-string-like-type">string-like types</firstterm>
 494         are basic types with a variable length. The value of any string-like
 495         type is conceptually 0 or more Unicode codepoints encoded in UTF-8,
 496         none of which may be U+0000. The UTF-8 text must be validated
 497         strictly: in particular, it must not contain overlong sequences
 498         or codepoints above U+10FFFF.
 499       </para>
 500
 501       <para>
 502         Since D-Bus Specification version 0.21, in accordance with Unicode
 503         Corrigendum #9, the "noncharacters" U+FDD0..U+FDEF, U+nFFFE and
 504         U+nFFFF are allowed in UTF-8 strings (but note that older versions of
 505         D-Bus rejected these noncharacters).
 506       </para>
 507
 508       <para>
 509         The marshalling formats for the string-like types all end with a
 510         single zero (NUL) byte, but that byte is not considered to be part of
 511         the text.
 512       </para>
 513
 514       <para>
 515         The characteristics of the string-like types are listed in this table.
 516
 517         <informaltable>
 518           <tgroup cols="3">
 519             <thead>
 520               <row>
 521                 <entry>Conventional name</entry>
 522                 <entry>ASCII type-code</entry>
 523                 <entry>Validity constraints</entry>
 524               </row>
 525             </thead>
 526             <tbody>
 527               <row>
 528                 <entry><literal>STRING</literal></entry>
 529                 <entry><literal>s</literal> (115)</entry>
 530                 <entry>No extra constraints</entry>
 531               </row>
 532               <row>
 533                 <entry><literal>OBJECT_PATH</literal></entry>
 534                 <entry><literal>o</literal> (111)</entry>
 535                 <entry>Must be
 536                   <link linkend="message-protocol-marshaling-object-path">a
 537                     syntactically valid object path</link></entry>
 538               </row>
 539               <row>
 540                 <entry><literal>SIGNATURE</literal></entry>
 541                 <entry><literal>g</literal> (103)</entry>
 542                 <entry>Zero or more
 543                   <firstterm linkend="term-single-complete-type">single
 544                     complete types</firstterm></entry>
 545               </row>
 546             </tbody>
 547           </tgroup>
 548         </informaltable>
 549       </para>
 550
 551       <sect3 id="message-protocol-marshaling-object-path">
 552         <title>Valid Object Paths</title>
 553
 554         <para>
 555           An object path is a name used to refer to an object instance.
 556           Conceptually, each participant in a D-Bus message exchange may have
 557           any number of object instances (think of C++ or Java objects) and each
 558           such instance will have a path. Like a filesystem, the object
 559           instances in an application form a hierarchical tree.
 560         </para>
 561
 562         <para>
 563           Object paths are often namespaced by starting with a reversed
 564           domain name and containing an interface version number, in the
 565           same way as
 566           <link linkend="message-protocol-names-interface">interface
 567             names</link> and
 568           <link linkend="message-protocol-names-bus">well-known
 569             bus names</link>.
 570           This makes it possible to implement more than one service, or
 571           more than one version of a service, in the same process,
 572           even if the services share a connection but cannot otherwise
 573           co-operate (for instance, if they are implemented by different
 574           plugins).
 575         </para>
 576
 577         <para>
 578           For instance, if the owner of <literal>example.com</literal> is
 579           developing a D-Bus API for a music player, they might use the
 580           hierarchy of object paths that start with
 581           <literal>/com/example/MusicPlayer1</literal> for its objects.
 582         </para>
 583
 584         <para>
 585           The following rules define a valid object path. Implementations must
 586           not send or accept messages with invalid object paths.
 587           <itemizedlist>
 588             <listitem>
 589               <para>
 590                 The path may be of any length.
 591               </para>
 592             </listitem>
 593             <listitem>
 594               <para>
 595                 The path must begin with an ASCII '/' (integer 47) character,
 596                 and must consist of elements separated by slash characters.
 597               </para>
 598             </listitem>
 599             <listitem>
 600               <para>
 601                 Each element must only contain the ASCII characters
 602                 "[A-Z][a-z][0-9]_"
 603               </para>
 604             </listitem>
 605             <listitem>
 606               <para>
 607                 No element may be the empty string.
 608               </para>
 609             </listitem>
 610             <listitem>
 611               <para>
 612                 Multiple '/' characters cannot occur in sequence.
 613               </para>
 614             </listitem>
 615             <listitem>
 616               <para>
 617                 A trailing '/' character is not allowed unless the
 618                 path is the root path (a single '/' character).
 619               </para>
 620             </listitem>
 621           </itemizedlist>
 622         </para>
 623
 624       </sect3>
 625
 626       <sect3 id="message-protocol-marshaling-signature">
 627         <title>Valid Signatures</title>
 628         <para>
 629           An implementation must not send or accept invalid signatures.
 630           Valid signatures will conform to the following rules:
 631           <itemizedlist>
 632             <listitem>
 633               <para>
 634                 The signature is a list of single complete types.
 635                 Arrays must have element types, and structs must
 636                 have both open and close parentheses.
 637               </para>
 638             </listitem>
 639             <listitem>
 640               <para>
 641                 Only type codes, open and close parentheses, and open and
 642                 close curly brackets are allowed in the signature. The
 643                 <literal>STRUCT</literal> type code
 644                 is not allowed in signatures, because parentheses
 645                 are used instead. Similarly, the
 646                 <literal>DICT_ENTRY</literal> type code is not allowed in
 647                 signatures, because curly brackets are used instead.
 648               </para>
 649             </listitem>
 650             <listitem>
 651               <para>
 652                 The maximum depth of container type nesting is 32 array type
 653                 codes and 32 open parentheses. This implies that the maximum
 654                 total depth of recursion is 64, for an "array of array of array
 655                 of ... struct of struct of struct of ..."  where there are 32
 656                 array and 32 struct.
 657               </para>
 658             </listitem>
 659             <listitem>
 660               <para>
 661                 The maximum length of a signature is 255.
 662               </para>
 663             </listitem>
 664           </itemizedlist>
 665         </para>
 666
 667         <para>
 668           When signatures appear in messages, the marshalling format
 669           guarantees that they will be followed by a nul byte (which can
 670           be interpreted as either C-style string termination or the INVALID
 671           type-code), but this is not conceptually part of the signature.
 672         </para>
 673       </sect3>
 674
 675     </sect2>
 676
 677     <sect2 id="container-types">
 678       <title>Container types</title>
 679
 680       <para>
 681         In addition to basic types, there are four <firstterm>container</firstterm>
 682         types: <literal>STRUCT</literal>, <literal>ARRAY</literal>, <literal>VARIANT</literal>,
 683         and <literal>DICT_ENTRY</literal>.
 684       </para>
 685
 686       <para>
 687         <literal>STRUCT</literal> has a type code, ASCII character 'r', but this type
 688         code does not appear in signatures. Instead, ASCII characters
 689         '(' and ')' are used to mark the beginning and end of the struct.
 690         So for example, a struct containing two integers would have this
 691         signature:
 692         <programlisting>
 693           "(ii)"
 694         </programlisting>
 695         Structs can be nested, so for example a struct containing
 696         an integer and another struct:
 697         <programlisting>
 698           "(i(ii))"
 699         </programlisting>
 700         The value block storing that struct would contain three integers; the
 701         type signature allows you to distinguish "(i(ii))" from "((ii)i)" or
 702         "(iii)" or "iii".
 703       </para>
 704
 705       <para>
 706         The <literal>STRUCT</literal> type code 'r' is not currently used in the D-Bus protocol,
 707         but is useful in code that implements the protocol. This type code
 708         is specified to allow such code to interoperate in non-protocol contexts.
 709       </para>
 710
 711       <para>
 712         Empty structures are not allowed; there must be at least one
 713         type code between the parentheses.
 714       </para>
 715
 716       <para>
 717         <literal>ARRAY</literal> has ASCII character 'a' as type code. The array type code must be
 718         followed by a <firstterm>single complete type</firstterm>. The single
 719         complete type following the array is the type of each array element. So
 720         the simple example is:
 721         <programlisting>
 722           "ai"
 723         </programlisting>
 724         which is an array of 32-bit integers. But an array can be of any type,
 725         such as this array-of-struct-with-two-int32-fields:
 726         <programlisting>
 727           "a(ii)"
 728         </programlisting>
 729         Or this array of array of integer:
 730         <programlisting>
 731           "aai"
 732         </programlisting>
 733       </para>
 734
 735       <para>
 736         <literal>VARIANT</literal> has ASCII character 'v' as its type code. A marshaled value of
 737         type <literal>VARIANT</literal> will have the signature of a single complete type as part
 738         of the <emphasis>value</emphasis>.  This signature will be followed by a
 739         marshaled value of that type.
 740       </para>
 741
 742       <para>
 743         Unlike a message signature, the variant signature can
 744         contain only a single complete type.  So "i", "ai"
 745         or "(ii)" is OK, but "ii" is not.  Use of variants may not
 746         cause a total message depth to be larger than 64, including
 747         other container types such as structures.
 748       </para>
 749
 750       <para>
 751         A <literal>DICT_ENTRY</literal> works exactly like a struct, but rather
 752         than parentheses it uses curly braces, and it has more restrictions.
 753         The restrictions are: it occurs only as an array element type; it has
 754         exactly two single complete types inside the curly braces; the first
 755         single complete type (the "key") must be a basic type rather than a
 756         container type. Implementations must not accept dict entries outside of
 757         arrays, must not accept dict entries with zero, one, or more than two
 758         fields, and must not accept dict entries with non-basic-typed keys. A
 759         dict entry is always a key-value pair.
 760       </para>
 761
 762       <para>
 763         The first field in the <literal>DICT_ENTRY</literal> is always the key.
 764         A message is considered corrupt if the same key occurs twice in the same
 765         array of <literal>DICT_ENTRY</literal>. However, for performance reasons
 766         implementations are not required to reject dicts with duplicate keys.
 767       </para>
 768
 769       <para>
 770         In most languages, an array of dict entry would be represented as a
 771         map, hash table, or dict object.
 772       </para>
 773     </sect2>
 774
 775     <sect2>
 776       <title>Summary of types</title>
 777
 778       <para>
 779         The following table summarizes the D-Bus types.
 780         <informaltable>
 781           <tgroup cols="3">
 782             <thead>
 783               <row>
 784                 <entry>Category</entry>
 785                 <entry>Conventional Name</entry>
 786                 <entry>Code</entry>
 787                 <entry>Description</entry>
 788               </row>
 789             </thead>
 790             <tbody>
 791               <row>
 792                 <entry>reserved</entry>
 793                 <entry><literal>INVALID</literal></entry>
 794                 <entry>0 (ASCII NUL)</entry>
 795                 <entry>Not a valid type code, used to terminate signatures</entry>
 796               </row><row>
 797                 <entry>fixed, basic</entry>
 798                 <entry><literal>BYTE</literal></entry>
 799                 <entry>121 (ASCII 'y')</entry>
 800                 <entry>8-bit unsigned integer</entry>
 801               </row><row>
 802                 <entry>fixed, basic</entry>
 803                 <entry><literal>BOOLEAN</literal></entry>
 804                 <entry>98 (ASCII 'b')</entry>
 805                 <entry>Boolean value, 0 is <literal>FALSE</literal> and 1 is <literal>TRUE</literal>. Everything else is invalid.</entry>
 806               </row><row>
 807                 <entry>fixed, basic</entry>
 808                 <entry><literal>INT16</literal></entry>
 809                 <entry>110 (ASCII 'n')</entry>
 810                 <entry>16-bit signed integer</entry>
 811               </row><row>
 812                 <entry>fixed, basic</entry>
 813                 <entry><literal>UINT16</literal></entry>
 814                 <entry>113 (ASCII 'q')</entry>
 815                 <entry>16-bit unsigned integer</entry>
 816               </row><row>
 817                 <entry>fixed, basic</entry>
 818                 <entry><literal>INT32</literal></entry>
 819                 <entry>105 (ASCII 'i')</entry>
 820                 <entry>32-bit signed integer</entry>
 821               </row><row>
 822                 <entry>fixed, basic</entry>
 823                 <entry><literal>UINT32</literal></entry>
 824                 <entry>117 (ASCII 'u')</entry>
 825                 <entry>32-bit unsigned integer</entry>
 826               </row><row>
 827                 <entry>fixed, basic</entry>
 828                 <entry><literal>INT64</literal></entry>
 829                 <entry>120 (ASCII 'x')</entry>
 830                 <entry>64-bit signed integer</entry>
 831               </row><row>
 832                 <entry>fixed, basic</entry>
 833                 <entry><literal>UINT64</literal></entry>
 834                 <entry>116 (ASCII 't')</entry>
 835                 <entry>64-bit unsigned integer</entry>
 836               </row><row>
 837                 <entry>fixed, basic</entry>
 838                 <entry><literal>DOUBLE</literal></entry>
 839                 <entry>100 (ASCII 'd')</entry>
 840                 <entry>IEEE 754 double</entry>
 841               </row><row>
 842                 <entry>string-like, basic</entry>
 843                 <entry><literal>STRING</literal></entry>
 844                 <entry>115 (ASCII 's')</entry>
 845                 <entry>UTF-8 string (<emphasis>must</emphasis> be valid UTF-8). Must be nul terminated and contain no other nul bytes.</entry>
 846               </row><row>
 847                 <entry>string-like, basic</entry>
 848                 <entry><literal>OBJECT_PATH</literal></entry>
 849                 <entry>111 (ASCII 'o')</entry>
 850                 <entry>Name of an object instance</entry>
 851               </row><row>
 852                 <entry>string-like, basic</entry>
 853                 <entry><literal>SIGNATURE</literal></entry>
 854                 <entry>103 (ASCII 'g')</entry>
 855                 <entry>A type signature</entry>
 856               </row><row>
 857                 <entry>container</entry>
 858                 <entry><literal>ARRAY</literal></entry>
 859                 <entry>97 (ASCII 'a')</entry>
 860                 <entry>Array</entry>
 861               </row><row>
 862                 <entry>container</entry>
 863                 <entry><literal>STRUCT</literal></entry>
 864                 <entry>114 (ASCII 'r'), 40 (ASCII '('), 41 (ASCII ')')</entry>
 865                 <entry>Struct; type code 114 'r' is reserved for use in
 866                   bindings and implementations to represent the general
 867                   concept of a struct, and must not appear in signatures
 868                   used on D-Bus.</entry>
 869               </row><row>
 870                 <entry>container</entry>
 871                 <entry><literal>VARIANT</literal></entry>
 872                 <entry>118 (ASCII 'v') </entry>
 873                 <entry>Variant type (the type of the value is part of the value itself)</entry>
 874               </row><row>
 875                 <entry>container</entry>
 876                 <entry><literal>DICT_ENTRY</literal></entry>
 877                 <entry>101 (ASCII 'e'), 123 (ASCII '{'), 125 (ASCII '}') </entry>
 878                 <entry>Entry in a dict or map (array of key-value pairs).
 879                   Type code 101 'e' is reserved for use in bindings and
 880                   implementations to represent the general concept of a
 881                   dict or dict-entry, and must not appear in signatures
 882                   used on D-Bus.</entry>
 883               </row><row>
 884                 <entry>fixed, basic</entry>
 885                 <entry><literal>UNIX_FD</literal></entry>
 886                 <entry>104 (ASCII 'h')</entry>
 887                 <entry>Unix file descriptor</entry>
 888               </row>
 889               <row>
 890                 <entry>reserved</entry>
 891                 <entry>(reserved)</entry>
 892                 <entry>109 (ASCII 'm')</entry>
 893                 <entry>Reserved for <ulink
 894                     url="https://bugs.freedesktop.org/show_bug.cgi?id=27857">a
 895                   'maybe' type compatible with the one in GVariant</ulink>,
 896                   and must not appear in signatures used on D-Bus until
 897                   specified here</entry>
 898               </row>
 899               <row>
 900                 <entry>reserved</entry>
 901                 <entry>(reserved)</entry>
 902                 <entry>42 (ASCII '*')</entry>
 903                 <entry>Reserved for use in bindings/implementations to
 904                   represent any <firstterm>single complete type</firstterm>,
 905                   and must not appear in signatures used on D-Bus.</entry>
 906               </row>
 907               <row>
 908                 <entry>reserved</entry>
 909                 <entry>(reserved)</entry>
 910                 <entry>63 (ASCII '?')</entry>
 911                 <entry>Reserved for use in bindings/implementations to
 912                   represent any <firstterm>basic type</firstterm>, and must
 913                   not appear in signatures used on D-Bus.</entry>
 914               </row>
 915               <row>
 916                 <entry>reserved</entry>
 917                 <entry>(reserved)</entry>
 918                 <entry>64 (ASCII '@'), 38 (ASCII '&amp;'),
 919                   94 (ASCII '^')</entry>
 920                 <entry>Reserved for internal use by bindings/implementations,
 921                   and must not appear in signatures used on D-Bus.
 922                   GVariant uses these type-codes to encode calling
 923                   conventions.</entry>
 924               </row>
 925             </tbody>
 926           </tgroup>
 927         </informaltable>
 928       </para>
 929
 930     </sect2>
 931   </sect1>
 932
 933   <sect1 id="message-protocol-marshaling">
 934     <title>Marshaling (Wire Format)</title>
 935
 936     <para>
 937       D-Bus defines a marshalling format for its type system, which is
 938       used in D-Bus messages. This is not the only possible marshalling
 939       format for the type system: for instance, GVariant (part of GLib)
 940       re-uses the D-Bus type system but implements an alternative marshalling
 941       format.
 942     </para>
 943
 944     <sect2>
 945       <title>Byte order and alignment</title>
 946
 947       <para>
 948         Given a type signature, a block of bytes can be converted into typed
 949         values. This section describes the format of the block of bytes.  Byte
 950         order and alignment issues are handled uniformly for all D-Bus types.
 951       </para>
 952
 953       <para>
 954         A block of bytes has an associated byte order. The byte order
 955         has to be discovered in some way; for D-Bus messages, the
 956         byte order is part of the message header as described in
 957         <xref linkend="message-protocol-messages"/>. For now, assume
 958         that the byte order is known to be either little endian or big
 959           endian.
 960       </para>
 961
 962       <para>
 963         Each value in a block of bytes is aligned "naturally," for example
 964         4-byte values are aligned to a 4-byte boundary, and 8-byte values to an
 965         8-byte boundary. To properly align a value, <firstterm>alignment
 966         padding</firstterm> may be necessary. The alignment padding must always
 967         be the minimum required padding to properly align the following value;
 968         and it must always be made up of nul bytes. The alignment padding must
 969         not be left uninitialized (it can't contain garbage), and more padding
 970         than required must not be used.
 971       </para>
 972
 973       <para>
 974         As an exception to natural alignment, <literal>STRUCT</literal> and
 975         <literal>DICT_ENTRY</literal> values are always aligned to an 8-byte
 976         boundary, regardless of the alignments of their contents.
 977       </para>
 978     </sect2>
 979
 980     <sect2>
 981       <title>Marshalling basic types</title>
 982
 983       <para>
 984         To marshal and unmarshal fixed types, you simply read one value
 985         from the data block corresponding to each type code in the signature.
 986         All signed integer values are encoded in two's complement, DOUBLE
 987         values are IEEE 754 double-precision floating-point, and BOOLEAN
 988         values are encoded in 32 bits (of which only the least significant
 989         bit is used).
 990       </para>
 991
 992       <para>
 993         The string-like types are all marshalled as a
 994         fixed-length unsigned integer <varname>n</varname> giving the
 995         length of the variable part, followed by <varname>n</varname>
 996         nonzero bytes of UTF-8 text, followed by a single zero (nul) byte
 997         which is not considered to be part of the text. The alignment
 998         of the string-like type is the same as the alignment of
 999         <varname>n</varname>.
1000       </para>
1001
1002       <para>
1003         For the STRING and OBJECT_PATH types, <varname>n</varname> is
1004         encoded in 4 bytes, leading to 4-byte alignment.
1005         For the SIGNATURE type, <varname>n</varname> is encoded as a single
1006         byte. As a result, alignment padding is never required before a
1007         SIGNATURE.
1008       </para>
1009     </sect2>
1010
1011     <sect2>
1012       <title>Marshalling containers</title>
1013
1014       <para>
1015         Arrays are marshalled as a <literal>UINT32</literal>
1016         <varname>n</varname> giving the length of the array data in bytes,
1017         followed by alignment padding to the alignment boundary of the array
1018         element type, followed by the <varname>n</varname> bytes of the
1019         array elements marshalled in sequence. <varname>n</varname> does not
1020         include the padding after the length, or any padding after the
1021         last element.
1022       </para>
1023
1024       <para>
1025         For instance, if the current position in the message is a multiple
1026         of 8 bytes and the byte-order is big-endian, an array containing only
1027         the 64-bit integer 5 would be marshalled as:
1028
1029         <screen>
1030 00 00 00 08               <lineannotation>8 bytes of data</lineannotation>
1031 00 00 00 00               <lineannotation>padding to 8-byte boundary</lineannotation>
1032 00 00 00 00  00 00 00 05  <lineannotation>first element = 5</lineannotation>
1033         </screen>
1034       </para>
1035
1036       <para>
1037         Arrays have a maximum length defined to be 2 to the 26th power or
1038         67108864 (64 MiB). Implementations must not send or accept arrays
1039         exceeding this length.
1040       </para>
1041
1042       <para>
1043         Structs and dict entries are marshalled in the same way as their
1044         contents, but their alignment is always to an 8-byte boundary,
1045         even if their contents would normally be less strictly aligned.
1046       </para>
1047
1048       <para>
1049         Variants are marshalled as the <literal>SIGNATURE</literal> of
1050         the contents (which must be a single complete type), followed by a
1051         marshalled value with the type given by that signature. The
1052         variant has the same 1-byte alignment as the signature, which means
1053         that alignment padding before a variant is never needed.
1054         Use of variants may not cause a total message depth to be larger
1055         than 64, including other container types such as structures.
1056       </para>
1057     </sect2>
1058
1059     <sect2>
1060       <title>Summary of D-Bus marshalling</title>
1061
1062       <para>
1063         Given all this, the types are marshaled on the wire as follows:
1064         <informaltable>
1065           <tgroup cols="3">
1066             <thead>
1067               <row>
1068                 <entry>Conventional Name</entry>
1069                 <entry>Encoding</entry>
1070                 <entry>Alignment</entry>
1071               </row>
1072             </thead>
1073             <tbody>
1074               <row>
1075                 <entry><literal>INVALID</literal></entry>
1076                 <entry>Not applicable; cannot be marshaled.</entry>
1077                 <entry>N/A</entry>
1078               </row><row>
1079                 <entry><literal>BYTE</literal></entry>
1080                 <entry>A single 8-bit byte.</entry>
1081                 <entry>1</entry>
1082               </row><row>
1083                 <entry><literal>BOOLEAN</literal></entry>
1084                 <entry>As for <literal>UINT32</literal>, but only 0 and 1 are valid values.</entry>
1085                 <entry>4</entry>
1086               </row><row>
1087                 <entry><literal>INT16</literal></entry>
1088                 <entry>16-bit signed integer in the message's byte order.</entry>
1089                 <entry>2</entry>
1090               </row><row>
1091                 <entry><literal>UINT16</literal></entry>
1092                 <entry>16-bit unsigned integer in the message's byte order.</entry>
1093                 <entry>2</entry>
1094               </row><row>
1095                 <entry><literal>INT32</literal></entry>
1096                 <entry>32-bit signed integer in the message's byte order.</entry>
1097                 <entry>4</entry>
1098               </row><row>
1099                 <entry><literal>UINT32</literal></entry>
1100                 <entry>32-bit unsigned integer in the message's byte order.</entry>
1101                 <entry>4</entry>
1102               </row><row>
1103                 <entry><literal>INT64</literal></entry>
1104                 <entry>64-bit signed integer in the message's byte order.</entry>
1105                 <entry>8</entry>
1106               </row><row>
1107                 <entry><literal>UINT64</literal></entry>
1108                 <entry>64-bit unsigned integer in the message's byte order.</entry>
1109                 <entry>8</entry>
1110               </row><row>
1111                 <entry><literal>DOUBLE</literal></entry>
1112                 <entry>64-bit IEEE 754 double in the message's byte order.</entry>
1113                 <entry>8</entry>
1114               </row><row>
1115                 <entry><literal>STRING</literal></entry>
1116                 <entry>A <literal>UINT32</literal> indicating the string's
1117                   length in bytes excluding its terminating nul, followed by
1118                   non-nul string data of the given length, followed by a terminating nul
1119                   byte.
1120                 </entry>
1121                 <entry>
1122                   4 (for the length)
1123                 </entry>
1124               </row><row>
1125                 <entry><literal>OBJECT_PATH</literal></entry>
1126                 <entry>Exactly the same as <literal>STRING</literal> except the
1127                   content must be a valid object path (see above).
1128                 </entry>
1129                 <entry>
1130                   4 (for the length)
1131                 </entry>
1132               </row><row>
1133                 <entry><literal>SIGNATURE</literal></entry>
1134                 <entry>The same as <literal>STRING</literal> except the length is a single
1135                   byte (thus signatures have a maximum length of 255)
1136                   and the content must be a valid signature (see above).
1137                 </entry>
1138                 <entry>
1139                   1
1140                 </entry>
1141               </row><row>
1142                 <entry><literal>ARRAY</literal></entry>
1143                 <entry>
1144                   A <literal>UINT32</literal> giving the length of the array data in bytes, followed by
1145                   alignment padding to the alignment boundary of the array element type,
1146                   followed by each array element.
1147                 </entry>
1148                 <entry>
1149                   4 (for the length)
1150                 </entry>
1151               </row><row>
1152                 <entry><literal>STRUCT</literal></entry>
1153                 <entry>
1154                   A struct must start on an 8-byte boundary regardless of the
1155                   type of the struct fields. The struct value consists of each
1156                   field marshaled in sequence starting from that 8-byte
1157                   alignment boundary.
1158                 </entry>
1159                 <entry>
1160                   8
1161                 </entry>
1162               </row><row>
1163                 <entry><literal>VARIANT</literal></entry>
1164                 <entry>
1165                   The marshaled <literal>SIGNATURE</literal> of a single
1166                   complete type, followed by a marshaled value with the type
1167                   given in the signature.
1168                 </entry>
1169                 <entry>
1170                   1 (alignment of the signature)
1171                 </entry>
1172               </row><row>
1173                 <entry><literal>DICT_ENTRY</literal></entry>
1174                 <entry>
1175                   Identical to STRUCT.
1176                 </entry>
1177                 <entry>
1178                   8
1179                 </entry>
1180               </row><row>
1181                 <entry><literal>UNIX_FD</literal></entry>
1182                 <entry>32-bit unsigned integer in the message's byte
1183                 order. The actual file descriptors need to be
1184                 transferred out-of-band via some platform specific
1185                 mechanism. On the wire, values of this type store the index to the
1186                 file descriptor in the array of file descriptors that
1187                 accompany the message.</entry>
1188                 <entry>4</entry>
1189               </row>
1190             </tbody>
1191           </tgroup>
1192         </informaltable>
1193       </para>
1194
1195     </sect2>
1196
1197   </sect1>
1198
1199   <sect1 id="message-protocol">
1200     <title>Message Protocol</title>
1201
1202     <para>
1203       A <firstterm>message</firstterm> consists of a
1204       <firstterm>header</firstterm> and a <firstterm>body</firstterm>. If you
1205       think of a message as a package, the header is the address, and the body
1206       contains the package contents. The message delivery system uses the header
1207       information to figure out where to send the message and how to interpret
1208       it; the recipient interprets the body of the message.
1209     </para>
1210
1211     <para>
1212       The body of the message is made up of zero or more
1213       <firstterm>arguments</firstterm>, which are typed values, such as an
1214       integer or a byte array.
1215     </para>
1216
1217     <para>
1218       Both header and body use the D-Bus <link linkend="type-system">type
1219         system</link> and format for serializing data.
1220     </para>
1221
1222     <sect2 id="message-protocol-messages">
1223       <title>Message Format</title>
1224
1225       <para>
1226         A message consists of a header and a body. The header is a block of
1227         values with a fixed signature and meaning.  The body is a separate block
1228         of values, with a signature specified in the header.
1229       </para>
1230
1231       <para>
1232         The length of the header must be a multiple of 8, allowing the body to
1233         begin on an 8-byte boundary when storing the entire message in a single
1234         buffer. If the header does not naturally end on an 8-byte boundary
1235         up to 7 bytes of nul-initialized alignment padding must be added.
1236       </para>
1237
1238       <para>
1239         The message body need not end on an 8-byte boundary.
1240       </para>
1241
1242       <para>
1243         The maximum length of a message, including header, header alignment padding,
1244         and body is 2 to the 27th power or 134217728 (128 MiB).
1245         Implementations must not send or accept messages exceeding this size.
1246       </para>
1247
1248       <para>
1249         The signature of the header is:
1250         <programlisting>
1251           "yyyyuua(yv)"
1252         </programlisting>
1253         Written out more readably, this is:
1254         <programlisting>
1255           BYTE, BYTE, BYTE, BYTE, UINT32, UINT32, ARRAY of STRUCT of (BYTE,VARIANT)
1256         </programlisting>
1257       </para>
1258
1259       <para>
1260         These values have the following meanings:
1261         <informaltable>
1262           <tgroup cols="2">
1263             <thead>
1264               <row>
1265                 <entry>Value</entry>
1266                 <entry>Description</entry>
1267               </row>
1268             </thead>
1269             <tbody>
1270               <row>
1271                 <entry>1st <literal>BYTE</literal></entry>
1272                 <entry>Endianness flag; ASCII 'l' for little-endian
1273                   or ASCII 'B' for big-endian. Both header and body are
1274                 in this endianness.</entry>
1275               </row>
1276               <row>
1277                 <entry>2nd <literal>BYTE</literal></entry>
1278                 <entry><firstterm>Message type</firstterm>. Unknown types must be ignored.
1279                   Currently-defined types are described below.
1280                 </entry>
1281               </row>
1282               <row>
1283                 <entry>3rd <literal>BYTE</literal></entry>
1284                 <entry>Bitwise OR of flags. Unknown flags
1285                   must be ignored. Currently-defined flags are described below.
1286                 </entry>
1287               </row>
1288               <row>
1289                 <entry>4th <literal>BYTE</literal></entry>
1290                 <entry>Major protocol version of the sending application.  If
1291                 the major protocol version of the receiving application does not
1292                 match, the applications will not be able to communicate and the
1293                 D-Bus connection must be disconnected. The major protocol
1294                 version for this version of the specification is 1.
1295                 </entry>
1296               </row>
1297               <row>
1298                 <entry>1st <literal>UINT32</literal></entry>
1299                 <entry>Length in bytes of the message body, starting
1300                   from the end of the header. The header ends after
1301                   its alignment padding to an 8-boundary.
1302                 </entry>
1303               </row>
1304               <row>
1305                 <entry>2nd <literal>UINT32</literal></entry>
1306                 <entry>The serial of this message, used as a cookie
1307                   by the sender to identify the reply corresponding
1308                   to this request. This must not be zero.
1309                 </entry>
1310               </row>
1311               <row>
1312                 <entry><literal>ARRAY</literal> of <literal>STRUCT</literal> of (<literal>BYTE</literal>,<literal>VARIANT</literal>)</entry>
1313                 <entry>An array of zero or more <firstterm>header
1314                   fields</firstterm> where the byte is the field code, and the
1315                   variant is the field value. The message type determines
1316                   which fields are required.
1317                 </entry>
1318               </row>
1319             </tbody>
1320           </tgroup>
1321         </informaltable>
1322       </para>
1323       <para>
1324         <firstterm>Message types</firstterm> that can appear in the second byte
1325         of the header are:
1326         <informaltable>
1327           <tgroup cols="3">
1328             <thead>
1329               <row>
1330                 <entry>Conventional name</entry>
1331                 <entry>Decimal value</entry>
1332                 <entry>Description</entry>
1333               </row>
1334             </thead>
1335             <tbody>
1336               <row>
1337                 <entry><literal>INVALID</literal></entry>
1338                 <entry>0</entry>
1339                 <entry>This is an invalid type.</entry>
1340               </row>
1341               <row>
1342                 <entry><literal>METHOD_CALL</literal></entry>
1343                 <entry>1</entry>
1344                 <entry>Method call. This message type may prompt a
1345                   reply.</entry>
1346               </row>
1347               <row>
1348                 <entry><literal>METHOD_RETURN</literal></entry>
1349                 <entry>2</entry>
1350                 <entry>Method reply with returned data.</entry>
1351               </row>
1352               <row>
1353                 <entry><literal>ERROR</literal></entry>
1354                 <entry>3</entry>
1355                 <entry>Error reply. If the first argument exists and is a
1356                 string, it is an error message.</entry>
1357               </row>
1358               <row>
1359                 <entry><literal>SIGNAL</literal></entry>
1360                 <entry>4</entry>
1361                 <entry>Signal emission.</entry>
1362               </row>
1363             </tbody>
1364           </tgroup>
1365         </informaltable>
1366       </para>
1367       <para>
1368         Flags that can appear in the third byte of the header:
1369         <informaltable>
1370           <tgroup cols="3">
1371             <thead>
1372               <row>
1373                 <entry>Conventional name</entry>
1374                 <entry>Hex value</entry>
1375                 <entry>Description</entry>
1376               </row>
1377             </thead>
1378             <tbody>
1379               <row>
1380                 <entry><literal>NO_REPLY_EXPECTED</literal></entry>
1381                 <entry>0x1</entry>
1382                 <entry>
1383                   <para>
1384                     This message does not expect method return replies or
1385                     error replies, even if it is of a type that can
1386                     have a reply; the reply can be omitted as an
1387                     optimization. It is compliant with this specification
1388                     to return the reply despite this flag, although doing
1389                     so on a bus with a non-trivial security policy
1390                     (such as the well-known system bus) may result in
1391                     access denial messages being logged for the reply.
1392                   </para>
1393                   <para>
1394                     Note that METHOD_CALL is the only message type currently
1395                     defined in this specification that can expect a reply,
1396                     so the presence or absence of this flag in the other
1397                     three message types that are currently
1398                     documented is meaningless: replies to those message
1399                     types should not be sent, whether this flag is present
1400                     or not.
1401                   </para>
1402                 </entry>
1403               </row>
1404               <row>
1405                 <entry><literal>NO_AUTO_START</literal></entry>
1406                 <entry>0x2</entry>
1407                 <entry>The bus must not launch an owner
1408                   for the destination name in response to this message.
1409                 </entry>
1410               </row>
1411               <row>
1412                 <entry><literal>ALLOW_INTERACTIVE_AUTHORIZATION</literal></entry>
1413                 <entry>0x4</entry>
1414                 <entry>
1415                   <para>
1416                     This flag may be set on a method call message to
1417                     inform the receiving side that the caller is prepared
1418                     to wait for interactive authorization, which might
1419                     take a considerable time to complete. For instance,
1420                     if this flag is set, it would be appropriate to
1421                     query the user for passwords or confirmation via
1422                     Polkit or a similar framework.
1423                   </para>
1424                   <para>
1425                     This flag is only useful when
1426                     unprivileged code calls a more privileged method call,
1427                     and an authorization framework is deployed that allows
1428                     possibly interactive authorization. If no such framework
1429                     is deployed it has no effect. This flag should not
1430                     be set by default by client implementations. If it is
1431                     set, the caller should also set a suitably long timeout
1432                     on the method call to make sure the user interaction
1433                     may complete. This flag is only valid for method call
1434                     messages, and shall be ignored otherwise.
1435                   </para>
1436                   <para>
1437                     Interaction that takes place as a part of the
1438                     effect of the method being called is outside the scope
1439                     of this flag, even if it could also be characterized
1440                     as authentication or authorization. For instance, in
1441                     a method call that directs a network management service
1442                     to attempt to connect to a virtual private network,
1443                     this flag should control how the network management
1444                     service makes the decision "is this user allowed to
1445                     change system network configuration?", but it should
1446                     not affect how or whether the network management
1447                     service interacts with the user to obtain the credentials
1448                     that are required for access to the VPN.
1449                   </para>
1450                   <para>
1451                     If a this flag is not set on a method call, and a
1452                     service determines that the requested operation is
1453                     not allowed without interactive authorization, but
1454                     could be allowed after successful interactive
1455                     authorization, it may return the
1456                     <literal>org.freedesktop.DBus.Error.InteractiveAuthorizationRequired</literal>
1457                     error.
1458                   </para>
1459                   <para>
1460                     The absence of this flag does not guarantee that
1461                     interactive authorization will not be applied, since
1462                     existing services that pre-date this flag might
1463                     already use interactive authorization. However,
1464                     existing D-Bus APIs that will use interactive
1465                     authorization should document that the call may take
1466                     longer than usual, and new D-Bus APIs should avoid
1467                     interactive authorization in the absence of this flag.
1468                   </para>
1469                 </entry>
1470               </row>
1471             </tbody>
1472           </tgroup>
1473         </informaltable>
1474       </para>
1475
1476       <sect3 id="message-protocol-header-fields">
1477         <title>Header Fields</title>
1478
1479         <para>
1480           The array at the end of the header contains <firstterm>header
1481           fields</firstterm>, where each field is a 1-byte field code followed
1482           by a field value. A header must contain the required header fields for
1483           its message type, and zero or more of any optional header
1484           fields. Future versions of this protocol specification may add new
1485           fields. Implementations must ignore fields they do not
1486           understand. Implementations must not invent their own header fields;
1487           only changes to this specification may introduce new header fields.
1488         </para>
1489
1490         <para>
1491           Again, if an implementation sees a header field code that it does not
1492           expect, it must ignore that field, as it will be part of a new
1493           (but compatible) version of this specification. This also applies
1494           to known header fields appearing in unexpected messages, for
1495           example: if a signal has a reply serial it must be ignored
1496           even though it has no meaning as of this version of the spec.
1497         </para>
1498
1499         <para>
1500           However, implementations must not send or accept known header fields
1501           with the wrong type stored in the field value. So for example a
1502           message with an <literal>INTERFACE</literal> field of type
1503           <literal>UINT32</literal> would be considered corrupt.
1504         </para>
1505
1506         <para>
1507           Here are the currently-defined header fields:
1508           <informaltable>
1509             <tgroup cols="5">
1510               <thead>
1511                 <row>
1512                   <entry>Conventional Name</entry>
1513                   <entry>Decimal Code</entry>
1514                   <entry>Type</entry>
1515                   <entry>Required In</entry>
1516                   <entry>Description</entry>
1517                 </row>
1518               </thead>
1519               <tbody>
1520                 <row>
1521                   <entry><literal>INVALID</literal></entry>
1522                   <entry>0</entry>
1523                   <entry>N/A</entry>
1524                   <entry>not allowed</entry>
1525                   <entry>Not a valid field name (error if it appears in a message)</entry>
1526                 </row>
1527                 <row>
1528                   <entry><literal>PATH</literal></entry>
1529                   <entry>1</entry>
1530                   <entry><literal>OBJECT_PATH</literal></entry>
1531                   <entry><literal>METHOD_CALL</literal>, <literal>SIGNAL</literal></entry>
1532                   <entry>The object to send a call to,
1533                     or the object a signal is emitted from.
1534                     The special path
1535                     <literal>/org/freedesktop/DBus/Local</literal> is reserved;
1536                     implementations should not send messages with this path,
1537                     and the reference implementation of the bus daemon will
1538                     disconnect any application that attempts to do so.
1539                   </entry>
1540                 </row>
1541                 <row>
1542                   <entry><literal>INTERFACE</literal></entry>
1543                   <entry>2</entry>
1544                   <entry><literal>STRING</literal></entry>
1545                   <entry><literal>SIGNAL</literal></entry>
1546                   <entry>
1547                     The interface to invoke a method call on, or
1548                     that a signal is emitted from. Optional for
1549                     method calls, required for signals.
1550                     The special interface
1551                     <literal>org.freedesktop.DBus.Local</literal> is reserved;
1552                     implementations should not send messages with this
1553                     interface, and the reference implementation of the bus
1554                     daemon will disconnect any application that attempts to
1555                     do so.
1556                   </entry>
1557                 </row>
1558                 <row>
1559                   <entry><literal>MEMBER</literal></entry>
1560                   <entry>3</entry>
1561                   <entry><literal>STRING</literal></entry>
1562                   <entry><literal>METHOD_CALL</literal>, <literal>SIGNAL</literal></entry>
1563                   <entry>The member, either the method name or signal name.</entry>
1564                 </row>
1565                 <row>
1566                   <entry><literal>ERROR_NAME</literal></entry>
1567                   <entry>4</entry>
1568                   <entry><literal>STRING</literal></entry>
1569                   <entry><literal>ERROR</literal></entry>
1570                   <entry>The name of the error that occurred, for errors</entry>
1571                 </row>
1572                 <row>
1573                   <entry><literal>REPLY_SERIAL</literal></entry>
1574                   <entry>5</entry>
1575                   <entry><literal>UINT32</literal></entry>
1576                   <entry><literal>ERROR</literal>, <literal>METHOD_RETURN</literal></entry>
1577                   <entry>The serial number of the message this message is a reply
1578                     to. (The serial number is the second <literal>UINT32</literal> in the header.)</entry>
1579                 </row>
1580                 <row>
1581                   <entry><literal>DESTINATION</literal></entry>
1582                   <entry>6</entry>
1583                   <entry><literal>STRING</literal></entry>
1584                   <entry>optional</entry>
1585                   <entry>The name of the connection this message is intended for.
1586                     Only used in combination with the message bus, see
1587                     <xref linkend="message-bus"/>.</entry>
1588                 </row>
1589                 <row>
1590                   <entry><literal>SENDER</literal></entry>
1591                   <entry>7</entry>
1592                   <entry><literal>STRING</literal></entry>
1593                   <entry>optional</entry>
1594                   <entry>Unique name of the sending connection.
1595                     The message bus fills in this field so it is reliable; the field is
1596                     only meaningful in combination with the message bus.</entry>
1597                 </row>
1598                 <row>
1599                   <entry><literal>SIGNATURE</literal></entry>
1600                   <entry>8</entry>
1601                   <entry><literal>SIGNATURE</literal></entry>
1602                   <entry>optional</entry>
1603                   <entry>The signature of the message body.
1604                   If omitted, it is assumed to be the
1605                   empty signature "" (i.e. the body must be 0-length).</entry>
1606                 </row>
1607                 <row>
1608                   <entry><literal>UNIX_FDS</literal></entry>
1609                   <entry>9</entry>
1610                   <entry><literal>UINT32</literal></entry>
1611                   <entry>optional</entry>
1612                   <entry>The number of Unix file descriptors that
1613                   accompany the message.  If omitted, it is assumed
1614                   that no Unix file descriptors accompany the
1615                   message. The actual file descriptors need to be
1616                   transferred via platform specific mechanism
1617                   out-of-band. They must be sent at the same time as
1618                   part of the message itself. They may not be sent
1619                   before the first byte of the message itself is
1620                   transferred or after the last byte of the message
1621                   itself.</entry>
1622                 </row>
1623               </tbody>
1624             </tgroup>
1625           </informaltable>
1626         </para>
1627       </sect3>
1628     </sect2>
1629
1630     <sect2 id="message-protocol-names">
1631       <title>Valid Names</title>
1632       <para>
1633         The various names in D-Bus messages have some restrictions.
1634       </para>
1635       <para>
1636         There is a <firstterm>maximum name length</firstterm>
1637         of 255 which applies to bus names, interfaces, and members.
1638       </para>
1639       <sect3 id="message-protocol-names-interface">
1640         <title>Interface names</title>
1641         <para>
1642           Interfaces have names with type <literal>STRING</literal>, meaning that
1643           they must be valid UTF-8. However, there are also some
1644           additional restrictions that apply to interface names
1645           specifically:
1646           <itemizedlist>
1647             <listitem><para>Interface names are composed of 1 or more elements separated by
1648                 a period ('.') character. All elements must contain at least
1649                 one character.
1650                 </para>
1651             </listitem>
1652             <listitem><para>Each element must only contain the ASCII characters
1653                 "[A-Z][a-z][0-9]_" and must not begin with a digit.
1654                 </para>
1655             </listitem>
1656
1657             <listitem><para>Interface names must contain at least one '.' (period)
1658               character (and thus at least two elements).
1659               </para></listitem>
1660
1661             <listitem><para>Interface names must not begin with a '.' (period) character.</para></listitem>
1662             <listitem><para>Interface names must not exceed the maximum name length.</para></listitem>
1663           </itemizedlist>
1664         </para>
1665
1666         <para>
1667           Interface names should start with the reversed DNS domain name of
1668           the author of the interface (in lower-case), like interface names
1669           in Java. It is conventional for the rest of the interface name
1670           to consist of words run together, with initial capital letters
1671           on all words ("CamelCase"). Several levels of hierarchy can be used.
1672           It is also a good idea to include the major version of the interface
1673           in the name, and increment it if incompatible changes are made;
1674           this way, a single object can implement several versions of an
1675           interface in parallel, if necessary.
1676         </para>
1677
1678         <para>
1679           For instance, if the owner of <literal>example.com</literal> is
1680           developing a D-Bus API for a music player, they might define
1681           interfaces called <literal>com.example.MusicPlayer1</literal>,
1682           <literal>com.example.MusicPlayer1.Track</literal> and
1683           <literal>com.example.MusicPlayer1.Seekable</literal>.
1684         </para>
1685
1686         <para>
1687           D-Bus does not distinguish between the concepts that would be
1688           called classes and interfaces in Java: either can be identified on
1689           D-Bus by an interface name.
1690         </para>
1691       </sect3>
1692       <sect3 id="message-protocol-names-bus">
1693         <title>Bus names</title>
1694         <para>
1695           Connections have one or more bus names associated with them.
1696           A connection has exactly one bus name that is a <firstterm>unique
1697             connection name</firstterm>. The unique connection name remains
1698           with the connection for its entire lifetime.
1699           A bus name is of type <literal>STRING</literal>,
1700           meaning that it must be valid UTF-8. However, there are also
1701           some additional restrictions that apply to bus names
1702           specifically:
1703           <itemizedlist>
1704             <listitem><para>Bus names that start with a colon (':')
1705                 character are unique connection names. Other bus names
1706                 are called <firstterm>well-known bus names</firstterm>.
1707                 </para>
1708             </listitem>
1709             <listitem><para>Bus names are composed of 1 or more elements separated by
1710                 a period ('.') character. All elements must contain at least
1711                 one character.
1712                 </para>
1713             </listitem>
1714             <listitem><para>Each element must only contain the ASCII characters
1715                 "[A-Z][a-z][0-9]_-". Only elements that are part of a unique
1716                 connection name may begin with a digit, elements in
1717                 other bus names must not begin with a digit.
1718                 </para>
1719             </listitem>
1720
1721             <listitem><para>Bus names must contain at least one '.' (period)
1722               character (and thus at least two elements).
1723               </para></listitem>
1724
1725             <listitem><para>Bus names must not begin with a '.' (period) character.</para></listitem>
1726             <listitem><para>Bus names must not exceed the maximum name length.</para></listitem>
1727           </itemizedlist>
1728         </para>
1729         <para>
1730           Note that the hyphen ('-') character is allowed in bus names but
1731           not in interface names.
1732         </para>
1733
1734         <para>
1735           Like <link linkend="message-protocol-names-interface">interface
1736             names</link>, well-known bus names should start with the
1737           reversed DNS domain name of the author of the interface (in
1738           lower-case), and it is conventional for the rest of the well-known
1739           bus name to consist of words run together, with initial
1740           capital letters. As with interface names, including a version
1741           number in well-known bus names is a good idea; it's possible to
1742           have the well-known bus name for more than one version
1743           simultaneously if backwards compatibility is required.
1744         </para>
1745
1746         <para>
1747           If a well-known bus name implies the presence of a "main" interface,
1748           that "main" interface is often given the same name as
1749           the well-known bus name, and situated at the corresponding object
1750           path. For instance, if the owner of <literal>example.com</literal>
1751           is developing a D-Bus API for a music player, they might define
1752           that any application that takes the well-known name
1753           <literal>com.example.MusicPlayer1</literal> should have an object
1754           at the object path <literal>/com/example/MusicPlayer1</literal>
1755           which implements the interface
1756           <literal>com.example.MusicPlayer1</literal>.
1757         </para>
1758       </sect3>
1759       <sect3 id="message-protocol-names-member">
1760         <title>Member names</title>
1761         <para>
1762           Member (i.e. method or signal) names:
1763           <itemizedlist>
1764             <listitem><para>Must only contain the ASCII characters
1765                 "[A-Z][a-z][0-9]_" and may not begin with a
1766                 digit.</para></listitem>
1767             <listitem><para>Must not contain the '.' (period) character.</para></listitem>
1768             <listitem><para>Must not exceed the maximum name length.</para></listitem>
1769             <listitem><para>Must be at least 1 byte in length.</para></listitem>
1770           </itemizedlist>
1771         </para>
1772
1773         <para>
1774           It is conventional for member names on D-Bus to consist of
1775           capitalized words with no punctuation ("camel-case").
1776           Method names should usually be verbs, such as
1777           <literal>GetItems</literal>, and signal names should usually be
1778           a description of an event, such as <literal>ItemsChanged</literal>.
1779         </para>
1780       </sect3>
1781       <sect3 id="message-protocol-names-error">
1782         <title>Error names</title>
1783         <para>
1784           Error names have the same restrictions as interface names.
1785         </para>
1786
1787         <para>
1788           Error names have the same naming conventions as interface
1789           names, and often contain <literal>.Error.</literal>; for instance,
1790           the owner of <literal>example.com</literal> might define the
1791           errors <literal>com.example.MusicPlayer.Error.FileNotFound</literal>
1792           and <literal>com.example.MusicPlayer.Error.OutOfMemory</literal>.
1793           The errors defined by D-Bus itself, such as
1794           <literal>org.freedesktop.DBus.Error.Failed</literal>, follow a
1795           similar pattern.
1796         </para>
1797       </sect3>
1798     </sect2>
1799
1800     <sect2 id="message-protocol-types">
1801       <title>Message Types</title>
1802       <para>
1803         Each of the message types (<literal>METHOD_CALL</literal>, <literal>METHOD_RETURN</literal>, <literal>ERROR</literal>, and
1804         <literal>SIGNAL</literal>) has its own expected usage conventions and header fields.
1805         This section describes these conventions.
1806       </para>
1807       <sect3 id="message-protocol-types-method">
1808         <title>Method Calls</title>
1809         <para>
1810           Some messages invoke an operation on a remote object.  These are
1811           called method call messages and have the type tag <literal>METHOD_CALL</literal>. Such
1812           messages map naturally to methods on objects in a typical program.
1813         </para>
1814         <para>
1815           A method call message is required to have a <literal>MEMBER</literal> header field
1816           indicating the name of the method. Optionally, the message has an
1817           <literal>INTERFACE</literal> field giving the interface the method is a part of.
1818           Including the <literal>INTERFACE</literal> in all method call
1819           messages is strongly recommended.
1820         </para>
1821         <para>
1822           In the absence of an <literal>INTERFACE</literal> field, if two
1823           or more interfaces on the same object have a method with the same
1824           name, it is undefined which of those methods will be invoked.
1825           Implementations may choose to either return an error, or deliver the
1826           message as though it had an arbitrary one of those interfaces.
1827         </para>
1828         <para>
1829           In some situations (such as the well-known system bus), messages
1830           are filtered through an access-control list external to the
1831           remote object implementation. If that filter rejects certain
1832           messages by matching their interface, or accepts only messages
1833           to specific interfaces, it must also reject messages that have no
1834           <literal>INTERFACE</literal>: otherwise, malicious
1835           applications could use this to bypass the filter.
1836         </para>
1837         <para>
1838           Method call messages also include a <literal>PATH</literal> field
1839           indicating the object to invoke the method on. If the call is passing
1840           through a message bus, the message will also have a
1841           <literal>DESTINATION</literal> field giving the name of the connection
1842           to receive the message.
1843         </para>
1844         <para>
1845           When an application handles a method call message, it is required to
1846           return a reply. The reply is identified by a <literal>REPLY_SERIAL</literal> header field
1847           indicating the serial number of the <literal>METHOD_CALL</literal> being replied to. The
1848           reply can have one of two types; either <literal>METHOD_RETURN</literal> or <literal>ERROR</literal>.
1849         </para>
1850         <para>
1851           If the reply has type <literal>METHOD_RETURN</literal>, the arguments to the reply message
1852           are the return value(s) or "out parameters" of the method call.
1853           If the reply has type <literal>ERROR</literal>, then an "exception" has been thrown,
1854           and the call fails; no return value will be provided. It makes
1855           no sense to send multiple replies to the same method call.
1856         </para>
1857         <para>
1858           Even if a method call has no return values, a <literal>METHOD_RETURN</literal>
1859           reply is required, so the caller will know the method
1860           was successfully processed.
1861         </para>
1862         <para>
1863           The <literal>METHOD_RETURN</literal> or <literal>ERROR</literal> reply message must have the <literal>REPLY_SERIAL</literal>
1864           header field.
1865         </para>
1866         <para>
1867           If a <literal>METHOD_CALL</literal> message has the flag <literal>NO_REPLY_EXPECTED</literal>,
1868           then as an optimization the application receiving the method
1869           call may choose to omit the reply message (regardless of
1870           whether the reply would have been <literal>METHOD_RETURN</literal> or <literal>ERROR</literal>).
1871           However, it is also acceptable to ignore the <literal>NO_REPLY_EXPECTED</literal>
1872           flag and reply anyway.
1873         </para>
1874         <para>
1875           Unless a message has the flag <literal>NO_AUTO_START</literal>, if the
1876           destination name does not exist then a program to own the destination
1877           name will be started before the message is delivered.  The message
1878           will be held until the new program is successfully started or has
1879           failed to start; in case of failure, an error will be returned. This
1880           flag is only relevant in the context of a message bus, it is ignored
1881           during one-to-one communication with no intermediate bus.
1882         </para>
1883         <sect4 id="message-protocol-types-method-apis">
1884           <title>Mapping method calls to native APIs</title>
1885           <para>
1886             APIs for D-Bus may map method calls to a method call in a specific
1887             programming language, such as C++, or may map a method call written
1888             in an IDL to a D-Bus message.
1889           </para>
1890           <para>
1891             In APIs of this nature, arguments to a method are often termed "in"
1892             (which implies sent in the <literal>METHOD_CALL</literal>), or "out" (which implies
1893             returned in the <literal>METHOD_RETURN</literal>). Some APIs such as CORBA also have
1894             "inout" arguments, which are both sent and received, i.e. the caller
1895             passes in a value which is modified. Mapped to D-Bus, an "inout"
1896             argument is equivalent to an "in" argument, followed by an "out"
1897             argument. You can't pass things "by reference" over the wire, so
1898             "inout" is purely an illusion of the in-process API.
1899           </para>
1900           <para>
1901             Given a method with zero or one return values, followed by zero or more
1902             arguments, where each argument may be "in", "out", or "inout", the
1903             caller constructs a message by appending each "in" or "inout" argument,
1904             in order. "out" arguments are not represented in the caller's message.
1905           </para>
1906           <para>
1907             The recipient constructs a reply by appending first the return value
1908             if any, then each "out" or "inout" argument, in order.
1909             "in" arguments are not represented in the reply message.
1910           </para>
1911           <para>
1912             Error replies are normally mapped to exceptions in languages that have
1913             exceptions.
1914           </para>
1915           <para>
1916             In converting from native APIs to D-Bus, it is perhaps nice to
1917             map D-Bus naming conventions ("FooBar") to native conventions
1918             such as "fooBar" or "foo_bar" automatically. This is OK
1919             as long as you can say that the native API is one that
1920             was specifically written for D-Bus. It makes the most sense
1921             when writing object implementations that will be exported
1922             over the bus. Object proxies used to invoke remote D-Bus
1923             objects probably need the ability to call any D-Bus method,
1924             and thus a magic name mapping like this could be a problem.
1925           </para>
1926           <para>
1927             This specification doesn't require anything of native API bindings;
1928             the preceding is only a suggested convention for consistency
1929             among bindings.
1930           </para>
1931         </sect4>
1932       </sect3>
1933
1934       <sect3 id="message-protocol-types-signal">
1935         <title>Signal Emission</title>
1936         <para>
1937           Unlike method calls, signal emissions have no replies.
1938           A signal emission is simply a single message of type <literal>SIGNAL</literal>.
1939           It must have three header fields: <literal>PATH</literal> giving the object
1940           the signal was emitted from, plus <literal>INTERFACE</literal> and <literal>MEMBER</literal> giving
1941           the fully-qualified name of the signal. The <literal>INTERFACE</literal> header is required
1942           for signals, though it is optional for method calls.
1943         </para>
1944       </sect3>
1945
1946       <sect3 id="message-protocol-types-errors">
1947         <title>Errors</title>
1948         <para>
1949           Messages of type <literal>ERROR</literal> are most commonly replies
1950           to a <literal>METHOD_CALL</literal>, but may be returned in reply
1951           to any kind of message. The message bus for example
1952           will return an <literal>ERROR</literal> in reply to a signal emission if
1953           the bus does not have enough memory to send the signal.
1954         </para>
1955         <para>
1956           An <literal>ERROR</literal> may have any arguments, but if the first
1957           argument is a <literal>STRING</literal>, it must be an error message.
1958           The error message may be logged or shown to the user
1959           in some way.
1960         </para>
1961       </sect3>
1962
1963       <sect3 id="message-protocol-types-notation">
1964         <title>Notation in this document</title>
1965         <para>
1966           This document uses a simple pseudo-IDL to describe particular method
1967           calls and signals. Here is an example of a method call:
1968           <programlisting>
1969             org.freedesktop.DBus.StartServiceByName (in STRING name, in UINT32 flags,
1970                                                      out UINT32 resultcode)
1971           </programlisting>
1972           This means <literal>INTERFACE</literal> = org.freedesktop.DBus, <literal>MEMBER</literal> = StartServiceByName,
1973           <literal>METHOD_CALL</literal> arguments are <literal>STRING</literal> and <literal>UINT32</literal>, <literal>METHOD_RETURN</literal> argument
1974           is <literal>UINT32</literal>. Remember that the <literal>MEMBER</literal> field can't contain any '.' (period)
1975           characters so it's known that the last part of the name in
1976           the "IDL" is the member name.
1977         </para>
1978         <para>
1979           In C++ that might end up looking like this:
1980           <programlisting>
1981             unsigned int org::freedesktop::DBus::StartServiceByName (const char  *name,
1982                                                                      unsigned int flags);
1983           </programlisting>
1984           or equally valid, the return value could be done as an argument:
1985           <programlisting>
1986             void org::freedesktop::DBus::StartServiceByName (const char   *name,
1987                                                              unsigned int  flags,
1988                                                              unsigned int *resultcode);
1989           </programlisting>
1990           It's really up to the API designer how they want to make
1991           this look. You could design an API where the namespace wasn't used
1992           in C++, using STL or Qt, using varargs, or whatever you wanted.
1993         </para>
1994         <para>
1995           Signals are written as follows:
1996           <programlisting>
1997             org.freedesktop.DBus.NameLost (STRING name)
1998           </programlisting>
1999           Signals don't specify "in" vs. "out" because only
2000           a single direction is possible.
2001         </para>
2002         <para>
2003           It isn't especially encouraged to use this lame pseudo-IDL in actual
2004           API implementations; you might use the native notation for the
2005           language you're using, or you might use COM or CORBA IDL, for example.
2006         </para>
2007       </sect3>
2008     </sect2>
2009
2010     <sect2 id="message-protocol-handling-invalid">
2011       <title>Invalid Protocol and Spec Extensions</title>
2012
2013       <para>
2014         For security reasons, the D-Bus protocol should be strictly parsed and
2015         validated, with the exception of defined extension points. Any invalid
2016         protocol or spec violations should result in immediately dropping the
2017         connection without notice to the other end. Exceptions should be
2018         carefully considered, e.g. an exception may be warranted for a
2019         well-understood idiosyncrasy of a widely-deployed implementation.  In
2020         cases where the other end of a connection is 100% trusted and known to
2021         be friendly, skipping validation for performance reasons could also make
2022         sense in certain cases.
2023       </para>
2024
2025       <para>
2026         Generally speaking violations of the "must" requirements in this spec
2027         should be considered possible attempts to exploit security, and violations
2028         of the "should" suggestions should be considered legitimate (though perhaps
2029         they should generate an error in some cases).
2030       </para>
2031
2032       <para>
2033         The following extension points are built in to D-Bus on purpose and must
2034         not be treated as invalid protocol. The extension points are intended
2035         for use by future versions of this spec, they are not intended for third
2036         parties.  At the moment, the only way a third party could extend D-Bus
2037         without breaking interoperability would be to introduce a way to negotiate new
2038         feature support as part of the auth protocol, using EXTENSION_-prefixed
2039         commands. There is not yet a standard way to negotiate features.
2040         <itemizedlist>
2041           <listitem>
2042             <para>
2043               In the authentication protocol (see <xref linkend="auth-protocol"/>) unknown
2044                 commands result in an ERROR rather than a disconnect. This enables
2045                 future extensions to the protocol. Commands starting with EXTENSION_ are
2046                 reserved for third parties.
2047             </para>
2048           </listitem>
2049           <listitem>
2050             <para>
2051               The authentication protocol supports pluggable auth mechanisms.
2052             </para>
2053           </listitem>
2054           <listitem>
2055             <para>
2056               The address format (see <xref linkend="addresses"/>) supports new
2057               kinds of transport.
2058             </para>
2059           </listitem>
2060           <listitem>
2061             <para>
2062               Messages with an unknown type (something other than
2063               <literal>METHOD_CALL</literal>, <literal>METHOD_RETURN</literal>,
2064               <literal>ERROR</literal>, <literal>SIGNAL</literal>) are ignored.
2065               Unknown-type messages must still be well-formed in the same way
2066               as the known messages, however. They still have the normal
2067               header and body.
2068             </para>
2069           </listitem>
2070           <listitem>
2071             <para>
2072               Header fields with an unknown or unexpected field code must be ignored,
2073               though again they must still be well-formed.
2074             </para>
2075           </listitem>
2076           <listitem>
2077             <para>
2078               New standard interfaces (with new methods and signals) can of course be added.
2079             </para>
2080           </listitem>
2081         </itemizedlist>
2082       </para>
2083
2084     </sect2>
2085
2086   </sect1>
2087
2088   <sect1 id="auth-protocol">
2089     <title>Authentication Protocol</title>
2090     <para>
2091       Before the flow of messages begins, two applications must
2092       authenticate. A simple plain-text protocol is used for
2093       authentication; this protocol is a SASL profile, and maps fairly
2094       directly from the SASL specification. The message encoding is
2095       NOT used here, only plain text messages.
2096     </para>
2097     <para>
2098       In examples, "C:" and "S:" indicate lines sent by the client and
2099       server respectively.
2100     </para>
2101     <sect2 id="auth-protocol-overview">
2102       <title>Protocol Overview</title>
2103       <para>
2104         The protocol is a line-based protocol, where each line ends with
2105         \r\n. Each line begins with an all-caps ASCII command name containing
2106         only the character range [A-Z_], a space, then any arguments for the
2107         command, then the \r\n ending the line. The protocol is
2108         case-sensitive. All bytes must be in the ASCII character set.
2109
2110         Commands from the client to the server are as follows:
2111
2112         <itemizedlist>
2113           <listitem><para>AUTH [mechanism] [initial-response]</para></listitem>
2114           <listitem><para>CANCEL</para></listitem>
2115           <listitem><para>BEGIN</para></listitem>
2116           <listitem><para>DATA &lt;data in hex encoding&gt;</para></listitem>
2117           <listitem><para>ERROR [human-readable error explanation]</para></listitem>
2118           <listitem><para>NEGOTIATE_UNIX_FD</para></listitem>
2119         </itemizedlist>
2120
2121         From server to client are as follows:
2122
2123         <itemizedlist>
2124           <listitem><para>REJECTED &lt;space-separated list of mechanism names&gt;</para></listitem>
2125           <listitem><para>OK &lt;GUID in hex&gt;</para></listitem>
2126           <listitem><para>DATA &lt;data in hex encoding&gt;</para></listitem>
2127           <listitem><para>ERROR</para></listitem>
2128           <listitem><para>AGREE_UNIX_FD</para></listitem>
2129         </itemizedlist>
2130       </para>
2131       <para>
2132         Unofficial extensions to the command set must begin with the letters
2133         "EXTENSION_", to avoid conflicts with future official commands.
2134         For example, "EXTENSION_COM_MYDOMAIN_DO_STUFF".
2135       </para>
2136     </sect2>
2137     <sect2 id="auth-nul-byte">
2138       <title>Special credentials-passing nul byte</title>
2139       <para>
2140         Immediately after connecting to the server, the client must send a
2141         single nul byte. This byte may be accompanied by credentials
2142         information on some operating systems that use sendmsg() with
2143         SCM_CREDS or SCM_CREDENTIALS to pass credentials over UNIX domain
2144         sockets. However, the nul byte must be sent even on other kinds of
2145         socket, and even on operating systems that do not require a byte to be
2146         sent in order to transmit credentials. The text protocol described in
2147         this document begins after the single nul byte. If the first byte
2148         received from the client is not a nul byte, the server may disconnect
2149         that client.
2150       </para>
2151       <para>
2152         A nul byte in any context other than the initial byte is an error;
2153         the protocol is ASCII-only.
2154       </para>
2155       <para>
2156         The credentials sent along with the nul byte may be used with the
2157         SASL mechanism EXTERNAL.
2158       </para>
2159     </sect2>
2160     <sect2 id="auth-command-auth">
2161       <title>AUTH command</title>
2162       <para>
2163         If an AUTH command has no arguments, it is a request to list
2164         available mechanisms. The server must respond with a REJECTED
2165         command listing the mechanisms it understands, or with an error.
2166       </para>
2167       <para>
2168         If an AUTH command specifies a mechanism, and the server supports
2169         said mechanism, the server should begin exchanging SASL
2170         challenge-response data with the client using DATA commands.
2171       </para>
2172       <para>
2173         If the server does not support the mechanism given in the AUTH
2174         command, it must send either a REJECTED command listing the mechanisms
2175         it does support, or an error.
2176       </para>
2177       <para>
2178         If the [initial-response] argument is provided, it is intended for use
2179         with mechanisms that have no initial challenge (or an empty initial
2180         challenge), as if it were the argument to an initial DATA command. If
2181         the selected mechanism has an initial challenge and [initial-response]
2182         was provided, the server should reject authentication by sending
2183         REJECTED.
2184       </para>
2185       <para>
2186         If authentication succeeds after exchanging DATA commands,
2187         an OK command must be sent to the client.
2188       </para>
2189       <para>
2190         The first octet received by the server after the \r\n of the BEGIN
2191         command from the client must be the first octet of the
2192         authenticated/encrypted stream of D-Bus messages.
2193       </para>
2194       <para>
2195         If BEGIN is received by the server, the first octet received
2196         by the client after the \r\n of the OK command must be the
2197         first octet of the authenticated/encrypted stream of D-Bus
2198         messages.
2199       </para>
2200     </sect2>
2201     <sect2 id="auth-command-cancel">
2202       <title>CANCEL Command</title>
2203       <para>
2204         At any time up to sending the BEGIN command, the client may send a
2205         CANCEL command. On receiving the CANCEL command, the server must
2206         send a REJECTED command and abort the current authentication
2207         exchange.
2208       </para>
2209     </sect2>
2210     <sect2 id="auth-command-data">
2211       <title>DATA Command</title>
2212       <para>
2213         The DATA command may come from either client or server, and simply
2214         contains a hex-encoded block of data to be interpreted
2215         according to the SASL mechanism in use.
2216       </para>
2217       <para>
2218         Some SASL mechanisms support sending an "empty string";
2219         FIXME we need some way to do this.
2220       </para>
2221     </sect2>
2222     <sect2 id="auth-command-begin">
2223       <title>BEGIN Command</title>
2224       <para>
2225         The BEGIN command acknowledges that the client has received an
2226         OK command from the server, and that the stream of messages
2227         is about to begin.
2228       </para>
2229       <para>
2230         The first octet received by the server after the \r\n of the BEGIN
2231         command from the client must be the first octet of the
2232         authenticated/encrypted stream of D-Bus messages.
2233       </para>
2234     </sect2>
2235     <sect2 id="auth-command-rejected">
2236       <title>REJECTED Command</title>
2237       <para>
2238         The REJECTED command indicates that the current authentication
2239         exchange has failed, and further exchange of DATA is inappropriate.
2240         The client would normally try another mechanism, or try providing
2241         different responses to challenges.
2242       </para><para>
2243         Optionally, the REJECTED command has a space-separated list of
2244         available auth mechanisms as arguments. If a server ever provides
2245         a list of supported mechanisms, it must provide the same list
2246         each time it sends a REJECTED message. Clients are free to
2247         ignore all lists received after the first.
2248       </para>
2249     </sect2>
2250     <sect2 id="auth-command-ok">
2251       <title>OK Command</title>
2252       <para>
2253         The OK command indicates that the client has been
2254         authenticated. The client may now proceed with negotiating
2255         Unix file descriptor passing. To do that it shall send
2256         NEGOTIATE_UNIX_FD to the server.
2257       </para>
2258       <para>
2259         Otherwise, the client must respond to the OK command by
2260         sending a BEGIN command, followed by its stream of messages,
2261         or by disconnecting.  The server must not accept additional
2262         commands using this protocol after the BEGIN command has been
2263         received. Further communication will be a stream of D-Bus
2264         messages (optionally encrypted, as negotiated) rather than
2265         this protocol.
2266       </para>
2267       <para>
2268         If a client sends BEGIN the first octet received by the client
2269         after the \r\n of the OK command must be the first octet of
2270         the authenticated/encrypted stream of D-Bus messages.
2271       </para>
2272       <para>
2273         The OK command has one argument, which is the GUID of the server.
2274         See <xref linkend="addresses"/> for more on server GUIDs.
2275       </para>
2276     </sect2>
2277     <sect2 id="auth-command-error">
2278       <title>ERROR Command</title>
2279       <para>
2280         The ERROR command indicates that either server or client did not
2281         know a command, does not accept the given command in the current
2282         context, or did not understand the arguments to the command. This
2283         allows the protocol to be extended; a client or server can send a
2284         command present or permitted only in new protocol versions, and if
2285         an ERROR is received instead of an appropriate response, fall back
2286         to using some other technique.
2287       </para>
2288       <para>
2289         If an ERROR is sent, the server or client that sent the
2290         error must continue as if the command causing the ERROR had never been
2291         received. However, the the server or client receiving the error
2292         should try something other than whatever caused the error;
2293         if only canceling/rejecting the authentication.
2294       </para>
2295       <para>
2296         If the D-Bus protocol changes incompatibly at some future time,
2297         applications implementing the new protocol would probably be able to
2298         check for support of the new protocol by sending a new command and
2299         receiving an ERROR from applications that don't understand it. Thus the
2300         ERROR feature of the auth protocol is an escape hatch that lets us
2301         negotiate extensions or changes to the D-Bus protocol in the future.
2302       </para>
2303     </sect2>
2304     <sect2 id="auth-command-negotiate-unix-fd">
2305       <title>NEGOTIATE_UNIX_FD Command</title>
2306       <para>
2307         The NEGOTIATE_UNIX_FD command indicates that the client
2308         supports Unix file descriptor passing. This command may only
2309         be sent after the connection is authenticated, i.e. after OK
2310         was received by the client. This command may only be sent on
2311         transports that support Unix file descriptor passing.
2312       </para>
2313       <para>
2314         On receiving NEGOTIATE_UNIX_FD the server must respond with
2315         either AGREE_UNIX_FD or ERROR. It shall respond the former if
2316         the transport chosen supports Unix file descriptor passing and
2317         the server supports this feature. It shall respond the latter
2318         if the transport does not support Unix file descriptor
2319         passing, the server does not support this feature, or the
2320         server decides not to enable file descriptor passing due to
2321         security or other reasons.
2322       </para>
2323     </sect2>
2324     <sect2 id="auth-command-agree-unix-fd">
2325       <title>AGREE_UNIX_FD Command</title>
2326       <para>
2327         The AGREE_UNIX_FD command indicates that the server supports
2328         Unix file descriptor passing. This command may only be sent
2329         after the connection is authenticated, and the client sent
2330         NEGOTIATE_UNIX_FD to enable Unix file descriptor passing. This
2331         command may only be sent on transports that support Unix file
2332         descriptor passing.
2333       </para>
2334       <para>
2335         On receiving AGREE_UNIX_FD the client must respond with BEGIN,
2336         followed by its stream of messages, or by disconnecting.  The
2337         server must not accept additional commands using this protocol
2338         after the BEGIN command has been received. Further
2339         communication will be a stream of D-Bus messages (optionally
2340         encrypted, as negotiated) rather than this protocol.
2341       </para>
2342     </sect2>
2343     <sect2 id="auth-command-future">
2344       <title>Future Extensions</title>
2345       <para>
2346         Future extensions to the authentication and negotiation
2347         protocol are possible. For that new commands may be
2348         introduced. If a client or server receives an unknown command
2349         it shall respond with ERROR and not consider this fatal. New
2350         commands may be introduced both before, and after
2351         authentication, i.e. both before and after the OK command.
2352       </para>
2353     </sect2>
2354     <sect2 id="auth-examples">
2355       <title>Authentication examples</title>
2356
2357       <para>
2358         <figure>
2359           <title>Example of successful magic cookie authentication</title>
2360           <programlisting>
2361             (MAGIC_COOKIE is a made up mechanism)
2362
2363             C: AUTH MAGIC_COOKIE 3138363935333137393635383634
2364             S: OK 1234deadbeef
2365             C: BEGIN
2366           </programlisting>
2367         </figure>
2368         <figure>
2369           <title>Example of finding out mechanisms then picking one</title>
2370           <programlisting>
2371             C: AUTH
2372             S: REJECTED KERBEROS_V4 SKEY
2373             C: AUTH SKEY 7ab83f32ee
2374             S: DATA 8799cabb2ea93e
2375             C: DATA 8ac876e8f68ee9809bfa876e6f9876g8fa8e76e98f
2376             S: OK 1234deadbeef
2377             C: BEGIN
2378           </programlisting>
2379         </figure>
2380         <figure>
2381           <title>Example of client sends unknown command then falls back to regular auth</title>
2382           <programlisting>
2383             C: FOOBAR
2384             S: ERROR
2385             C: AUTH MAGIC_COOKIE 3736343435313230333039
2386             S: OK 1234deadbeef
2387             C: BEGIN
2388           </programlisting>
2389         </figure>
2390         <figure>
2391           <title>Example of server doesn't support initial auth mechanism</title>
2392           <programlisting>
2393             C: AUTH MAGIC_COOKIE 3736343435313230333039
2394             S: REJECTED KERBEROS_V4 SKEY
2395             C: AUTH SKEY 7ab83f32ee
2396             S: DATA 8799cabb2ea93e
2397             C: DATA 8ac876e8f68ee9809bfa876e6f9876g8fa8e76e98f
2398             S: OK 1234deadbeef
2399             C: BEGIN
2400           </programlisting>
2401         </figure>
2402         <figure>
2403           <title>Example of wrong password or the like followed by successful retry</title>
2404           <programlisting>
2405             C: AUTH MAGIC_COOKIE 3736343435313230333039
2406             S: REJECTED KERBEROS_V4 SKEY
2407             C: AUTH SKEY 7ab83f32ee
2408             S: DATA 8799cabb2ea93e
2409             C: DATA 8ac876e8f68ee9809bfa876e6f9876g8fa8e76e98f
2410             S: REJECTED
2411             C: AUTH SKEY 7ab83f32ee
2412             S: DATA 8799cabb2ea93e
2413             C: DATA 8ac876e8f68ee9809bfa876e6f9876g8fa8e76e98f
2414             S: OK 1234deadbeef
2415             C: BEGIN
2416           </programlisting>
2417         </figure>
2418         <figure>
2419           <title>Example of skey cancelled and restarted</title>
2420           <programlisting>
2421             C: AUTH MAGIC_COOKIE 3736343435313230333039
2422             S: REJECTED KERBEROS_V4 SKEY
2423             C: AUTH SKEY 7ab83f32ee
2424             S: DATA 8799cabb2ea93e
2425             C: CANCEL
2426             S: REJECTED
2427             C: AUTH SKEY 7ab83f32ee
2428             S: DATA 8799cabb2ea93e
2429             C: DATA 8ac876e8f68ee9809bfa876e6f9876g8fa8e76e98f
2430             S: OK 1234deadbeef
2431             C: BEGIN
2432           </programlisting>
2433         </figure>
2434         <figure>
2435           <title>Example of successful magic cookie authentication with successful negotiation of Unix FD passing</title>
2436           <programlisting>
2437             (MAGIC_COOKIE is a made up mechanism)
2438
2439             C: AUTH MAGIC_COOKIE 3138363935333137393635383634
2440             S: OK 1234deadbeef
2441             C: NEGOTIATE_UNIX_FD
2442             S: AGREE_UNIX_FD
2443             C: BEGIN
2444           </programlisting>
2445         </figure>
2446         <figure>
2447           <title>Example of successful magic cookie authentication with unsuccessful negotiation of Unix FD passing</title>
2448           <programlisting>
2449             (MAGIC_COOKIE is a made up mechanism)
2450
2451             C: AUTH MAGIC_COOKIE 3138363935333137393635383634
2452             S: OK 1234deadbeef
2453             C: NEGOTIATE_UNIX_FD
2454             S: ERROR
2455             C: BEGIN
2456           </programlisting>
2457         </figure>
2458       </para>
2459     </sect2>
2460     <sect2 id="auth-states">
2461       <title>Authentication state diagrams</title>
2462
2463       <para>
2464         This section documents the auth protocol in terms of
2465         a state machine for the client and the server. This is
2466         probably the most robust way to implement the protocol.
2467       </para>
2468
2469       <sect3 id="auth-states-client">
2470         <title>Client states</title>
2471
2472         <para>
2473           To more precisely describe the interaction between the
2474           protocol state machine and the authentication mechanisms the
2475           following notation is used: MECH(CHALL) means that the
2476           server challenge CHALL was fed to the mechanism MECH, which
2477           returns one of
2478
2479           <itemizedlist>
2480             <listitem>
2481               <para>
2482                 CONTINUE(RESP) means continue the auth conversation
2483                 and send RESP as the response to the server;
2484               </para>
2485             </listitem>
2486
2487             <listitem>
2488               <para>
2489                 OK(RESP) means that after sending RESP to the server
2490                 the client side of the auth conversation is finished
2491                 and the server should return "OK";
2492               </para>
2493             </listitem>
2494
2495             <listitem>
2496               <para>
2497                 ERROR means that CHALL was invalid and could not be
2498                 processed.
2499               </para>
2500             </listitem>
2501           </itemizedlist>
2502
2503           Both RESP and CHALL may be empty.
2504         </para>
2505
2506         <para>
2507           The Client starts by getting an initial response from the
2508           default mechanism and sends AUTH MECH RESP, or AUTH MECH if
2509           the mechanism did not provide an initial response.  If the
2510           mechanism returns CONTINUE, the client starts in state
2511           <emphasis>WaitingForData</emphasis>, if the mechanism
2512           returns OK the client starts in state
2513           <emphasis>WaitingForOK</emphasis>.
2514         </para>
2515
2516         <para>
2517           The client should keep track of available mechanisms and
2518           which it mechanisms it has already attempted. This list is
2519           used to decide which AUTH command to send. When the list is
2520           exhausted, the client should give up and close the
2521           connection.
2522         </para>
2523
2524         <formalpara>
2525           <title><emphasis>WaitingForData</emphasis></title>
2526           <para>
2527             <itemizedlist>
2528               <listitem>
2529                 <para>
2530                   Receive DATA CHALL
2531                   <simplelist>
2532                     <member>
2533                       MECH(CHALL) returns CONTINUE(RESP) &rarr; send
2534                       DATA RESP, goto
2535                       <emphasis>WaitingForData</emphasis>
2536                     </member>
2537
2538                     <member>
2539                       MECH(CHALL) returns OK(RESP) &rarr; send DATA
2540                       RESP, goto <emphasis>WaitingForOK</emphasis>
2541                     </member>
2542
2543                     <member>
2544                       MECH(CHALL) returns ERROR &rarr; send ERROR
2545                       [msg], goto <emphasis>WaitingForData</emphasis>
2546                     </member>
2547                   </simplelist>
2548                 </para>
2549               </listitem>
2550
2551               <listitem>
2552                 <para>
2553                   Receive REJECTED [mechs] &rarr;
2554                   send AUTH [next mech], goto
2555                   WaitingForData or <emphasis>WaitingForOK</emphasis>
2556                 </para>
2557               </listitem>
2558               <listitem>
2559                 <para>
2560                   Receive ERROR &rarr; send
2561                   CANCEL, goto
2562                   <emphasis>WaitingForReject</emphasis>
2563                 </para>
2564               </listitem>
2565               <listitem>
2566                 <para>
2567                   Receive OK &rarr; send
2568                   BEGIN, terminate auth
2569                   conversation, authenticated
2570                 </para>
2571               </listitem>
2572               <listitem>
2573                 <para>
2574                   Receive anything else &rarr; send
2575                   ERROR, goto
2576                   <emphasis>WaitingForData</emphasis>
2577                 </para>
2578               </listitem>
2579             </itemizedlist>
2580           </para>
2581         </formalpara>
2582
2583         <formalpara>
2584           <title><emphasis>WaitingForOK</emphasis></title>
2585           <para>
2586             <itemizedlist>
2587               <listitem>
2588                 <para>
2589                   Receive OK &rarr; send BEGIN, terminate auth
2590                   conversation, <emphasis>authenticated</emphasis>
2591                 </para>
2592               </listitem>
2593               <listitem>
2594                 <para>
2595                   Receive REJECTED [mechs] &rarr; send AUTH [next mech],
2596                   goto <emphasis>WaitingForData</emphasis> or
2597                   <emphasis>WaitingForOK</emphasis>
2598                 </para>
2599               </listitem>
2600
2601               <listitem>
2602                 <para>
2603                   Receive DATA &rarr; send CANCEL, goto
2604                   <emphasis>WaitingForReject</emphasis>
2605                 </para>
2606               </listitem>
2607
2608               <listitem>
2609                 <para>
2610                   Receive ERROR &rarr; send CANCEL, goto
2611                   <emphasis>WaitingForReject</emphasis>
2612                 </para>
2613               </listitem>
2614
2615               <listitem>
2616                 <para>
2617                   Receive anything else &rarr; send ERROR, goto
2618                   <emphasis>WaitingForOK</emphasis>
2619                 </para>
2620               </listitem>
2621             </itemizedlist>
2622           </para>
2623         </formalpara>
2624
2625         <formalpara>
2626           <title><emphasis>WaitingForReject</emphasis></title>
2627           <para>
2628             <itemizedlist>
2629               <listitem>
2630                 <para>
2631                   Receive REJECTED [mechs] &rarr; send AUTH [next mech],
2632                   goto <emphasis>WaitingForData</emphasis> or
2633                   <emphasis>WaitingForOK</emphasis>
2634                 </para>
2635               </listitem>
2636
2637               <listitem>
2638                 <para>
2639                   Receive anything else &rarr; terminate auth
2640                   conversation, disconnect
2641                 </para>
2642               </listitem>
2643             </itemizedlist>
2644           </para>
2645         </formalpara>
2646
2647       </sect3>
2648
2649       <sect3 id="auth-states-server">
2650         <title>Server states</title>
2651
2652         <para>
2653           For the server MECH(RESP) means that the client response
2654           RESP was fed to the the mechanism MECH, which returns one of
2655
2656           <itemizedlist>
2657             <listitem>
2658               <para>
2659                 CONTINUE(CHALL) means continue the auth conversation and
2660                 send CHALL as the challenge to the client;
2661               </para>
2662             </listitem>
2663
2664             <listitem>
2665               <para>
2666                 OK means that the client has been successfully
2667                 authenticated;
2668               </para>
2669             </listitem>
2670
2671             <listitem>
2672               <para>
2673                 REJECTED means that the client failed to authenticate or
2674                 there was an error in RESP.
2675               </para>
2676             </listitem>
2677           </itemizedlist>
2678
2679           The server starts out in state
2680           <emphasis>WaitingForAuth</emphasis>.  If the client is
2681           rejected too many times the server must disconnect the
2682           client.
2683         </para>
2684
2685         <formalpara>
2686           <title><emphasis>WaitingForAuth</emphasis></title>
2687           <para>
2688             <itemizedlist>
2689
2690               <listitem>
2691                 <para>
2692                   Receive AUTH &rarr; send REJECTED [mechs], goto
2693                   <emphasis>WaitingForAuth</emphasis>
2694                 </para>
2695               </listitem>
2696
2697               <listitem>
2698                 <para>
2699                   Receive AUTH MECH RESP
2700
2701                   <simplelist>
2702                     <member>
2703                       MECH not valid mechanism &rarr; send REJECTED
2704                       [mechs], goto
2705                       <emphasis>WaitingForAuth</emphasis>
2706                     </member>
2707
2708                     <member>
2709                       MECH(RESP) returns CONTINUE(CHALL) &rarr; send
2710                       DATA CHALL, goto
2711                       <emphasis>WaitingForData</emphasis>
2712                     </member>
2713
2714                     <member>
2715                       MECH(RESP) returns OK &rarr; send OK, goto
2716                       <emphasis>WaitingForBegin</emphasis>
2717                     </member>
2718
2719                     <member>
2720                       MECH(RESP) returns REJECTED &rarr; send REJECTED
2721                       [mechs], goto
2722                       <emphasis>WaitingForAuth</emphasis>
2723                     </member>
2724                   </simplelist>
2725                 </para>
2726               </listitem>
2727
2728               <listitem>
2729                 <para>
2730                   Receive BEGIN &rarr; terminate
2731                   auth conversation, disconnect
2732                 </para>
2733               </listitem>
2734
2735               <listitem>
2736                 <para>
2737                   Receive ERROR &rarr; send REJECTED [mechs], goto
2738                   <emphasis>WaitingForAuth</emphasis>
2739                 </para>
2740               </listitem>
2741
2742               <listitem>
2743                 <para>
2744                   Receive anything else &rarr; send
2745                   ERROR, goto
2746                   <emphasis>WaitingForAuth</emphasis>
2747                 </para>
2748               </listitem>
2749             </itemizedlist>
2750           </para>
2751         </formalpara>
2752
2753
2754         <formalpara>
2755           <title><emphasis>WaitingForData</emphasis></title>
2756           <para>
2757             <itemizedlist>
2758               <listitem>
2759                 <para>
2760                   Receive DATA RESP
2761                   <simplelist>
2762                     <member>
2763                       MECH(RESP) returns CONTINUE(CHALL) &rarr; send
2764                       DATA CHALL, goto
2765                       <emphasis>WaitingForData</emphasis>
2766                     </member>
2767
2768                     <member>
2769                       MECH(RESP) returns OK &rarr; send OK, goto
2770                       <emphasis>WaitingForBegin</emphasis>
2771                     </member>
2772
2773                     <member>
2774                       MECH(RESP) returns REJECTED &rarr; send REJECTED
2775                       [mechs], goto
2776                       <emphasis>WaitingForAuth</emphasis>
2777                     </member>
2778                   </simplelist>
2779                 </para>
2780               </listitem>
2781
2782               <listitem>
2783                 <para>
2784                   Receive BEGIN &rarr; terminate auth conversation,
2785                   disconnect
2786                 </para>
2787               </listitem>
2788
2789               <listitem>
2790                 <para>
2791                   Receive CANCEL &rarr; send REJECTED [mechs], goto
2792                   <emphasis>WaitingForAuth</emphasis>
2793                 </para>
2794               </listitem>
2795
2796               <listitem>
2797                 <para>
2798                   Receive ERROR &rarr; send REJECTED [mechs], goto
2799                   <emphasis>WaitingForAuth</emphasis>
2800                 </para>
2801               </listitem>
2802
2803               <listitem>
2804                 <para>
2805                   Receive anything else &rarr; send ERROR, goto
2806                   <emphasis>WaitingForData</emphasis>
2807                 </para>
2808               </listitem>
2809             </itemizedlist>
2810           </para>
2811         </formalpara>
2812
2813         <formalpara>
2814           <title><emphasis>WaitingForBegin</emphasis></title>
2815           <para>
2816             <itemizedlist>
2817               <listitem>
2818                 <para>
2819                   Receive BEGIN &rarr; terminate auth conversation,
2820                   client authenticated
2821                 </para>
2822               </listitem>
2823
2824               <listitem>
2825                 <para>
2826                   Receive CANCEL &rarr; send REJECTED [mechs], goto
2827                   <emphasis>WaitingForAuth</emphasis>
2828                 </para>
2829               </listitem>
2830
2831               <listitem>
2832                 <para>
2833                   Receive ERROR &rarr; send REJECTED [mechs], goto
2834                   <emphasis>WaitingForAuth</emphasis>
2835                 </para>
2836               </listitem>
2837
2838               <listitem>
2839                 <para>
2840                   Receive anything else &rarr; send ERROR, goto
2841                   <emphasis>WaitingForBegin</emphasis>
2842                 </para>
2843               </listitem>
2844             </itemizedlist>
2845           </para>
2846         </formalpara>
2847
2848       </sect3>
2849
2850     </sect2>
2851     <sect2 id="auth-mechanisms">
2852       <title>Authentication mechanisms</title>
2853       <para>
2854         This section describes some new authentication mechanisms.
2855         D-Bus also allows any standard SASL mechanism of course.
2856       </para>
2857       <sect3 id="auth-mechanisms-sha">
2858         <title>DBUS_COOKIE_SHA1</title>
2859         <para>
2860           The DBUS_COOKIE_SHA1 mechanism is designed to establish that a client
2861           has the ability to read a private file owned by the user being
2862           authenticated. If the client can prove that it has access to a secret
2863           cookie stored in this file, then the client is authenticated.
2864           Thus the security of DBUS_COOKIE_SHA1 depends on a secure home
2865           directory.
2866         </para>
2867         <para>
2868           Throughout this description, "hex encoding" must output the digits
2869           from a to f in lower-case; the digits A to F must not be used
2870           in the DBUS_COOKIE_SHA1 mechanism.
2871         </para>
2872         <para>
2873           Authentication proceeds as follows:
2874           <itemizedlist>
2875             <listitem>
2876               <para>
2877                 The client sends the username it would like to authenticate
2878                 as, hex-encoded.
2879               </para>
2880             </listitem>
2881             <listitem>
2882               <para>
2883                 The server sends the name of its "cookie context" (see below); a
2884                 space character; the integer ID of the secret cookie the client
2885                 must demonstrate knowledge of; a space character; then a
2886                 randomly-generated challenge string, all of this hex-encoded into
2887                 one, single string.
2888               </para>
2889             </listitem>
2890             <listitem>
2891               <para>
2892                 The client locates the cookie and generates its own
2893                 randomly-generated challenge string. The client then concatenates
2894                 the server's decoded challenge, a ":" character, its own challenge,
2895                 another ":" character, and the cookie. It computes the SHA-1 hash
2896                 of this composite string as a hex digest. It concatenates the
2897                 client's challenge string, a space character, and the SHA-1 hex
2898                 digest, hex-encodes the result and sends it back to the server.
2899               </para>
2900             </listitem>
2901             <listitem>
2902               <para>
2903                 The server generates the same concatenated string used by the
2904                 client and computes its SHA-1 hash. It compares the hash with
2905                 the hash received from the client; if the two hashes match, the
2906                 client is authenticated.
2907               </para>
2908             </listitem>
2909           </itemizedlist>
2910         </para>
2911         <para>
2912           Each server has a "cookie context," which is a name that identifies a
2913           set of cookies that apply to that server. A sample context might be
2914           "org_freedesktop_session_bus". Context names must be valid ASCII,
2915           nonzero length, and may not contain the characters slash ("/"),
2916           backslash ("\"), space (" "), newline ("\n"), carriage return ("\r"),
2917           tab ("\t"), or period ("."). There is a default context,
2918           "org_freedesktop_general" that's used by servers that do not specify
2919           otherwise.
2920         </para>
2921         <para>
2922           Cookies are stored in a user's home directory, in the directory
2923           <filename>~/.dbus-keyrings/</filename>. This directory must
2924           not be readable or writable by other users. If it is,
2925           clients and servers must ignore it. The directory
2926           contains cookie files named after the cookie context.
2927         </para>
2928         <para>
2929           A cookie file contains one cookie per line. Each line
2930           has three space-separated fields:
2931           <itemizedlist>
2932             <listitem>
2933               <para>
2934                 The cookie ID number, which must be a non-negative integer and
2935                 may not be used twice in the same file.
2936               </para>
2937             </listitem>
2938             <listitem>
2939               <para>
2940                 The cookie's creation time, in UNIX seconds-since-the-epoch
2941                 format.
2942               </para>
2943             </listitem>
2944             <listitem>
2945               <para>
2946                 The cookie itself, a hex-encoded random block of bytes. The cookie
2947                 may be of any length, though obviously security increases
2948                 as the length increases.
2949               </para>
2950             </listitem>
2951           </itemizedlist>
2952         </para>
2953         <para>
2954           Only server processes modify the cookie file.
2955           They must do so with this procedure:
2956           <itemizedlist>
2957             <listitem>
2958               <para>
2959                 Create a lockfile name by appending ".lock" to the name of the
2960                 cookie file.  The server should attempt to create this file
2961                 using <literal>O_CREAT | O_EXCL</literal>.  If file creation
2962                 fails, the lock fails. Servers should retry for a reasonable
2963                 period of time, then they may choose to delete an existing lock
2964                 to keep users from having to manually delete a stale
2965                 lock. <footnote><para>Lockfiles are used instead of real file
2966                 locking <literal>fcntl()</literal> because real locking
2967                 implementations are still flaky on network
2968                 filesystems.</para></footnote>
2969               </para>
2970             </listitem>
2971             <listitem>
2972               <para>
2973                 Once the lockfile has been created, the server loads the cookie
2974                 file. It should then delete any cookies that are old (the
2975                 timeout can be fairly short), or more than a reasonable
2976                 time in the future (so that cookies never accidentally
2977                 become permanent, if the clock was set far into the future
2978                 at some point). If no recent keys remain, the
2979                 server may generate a new key.
2980               </para>
2981             </listitem>
2982             <listitem>
2983               <para>
2984                 The pruned and possibly added-to cookie file
2985                 must be resaved atomically (using a temporary
2986                 file which is rename()'d).
2987               </para>
2988             </listitem>
2989             <listitem>
2990               <para>
2991                 The lock must be dropped by deleting the lockfile.
2992               </para>
2993             </listitem>
2994           </itemizedlist>
2995         </para>
2996         <para>
2997           Clients need not lock the file in order to load it,
2998           because servers are required to save the file atomically.
2999         </para>
3000       </sect3>
3001     </sect2>
3002   </sect1>
3003   <sect1 id="addresses">
3004     <title>Server Addresses</title>
3005     <para>
3006       Server addresses consist of a transport name followed by a colon, and
3007       then an optional, comma-separated list of keys and values in the form key=value.
3008       Each value is escaped.
3009     </para>
3010     <para>
3011       For example:
3012       <programlisting>unix:path=/tmp/dbus-test</programlisting>
3013       Which is the address to a unix socket with the path /tmp/dbus-test.
3014     </para>
3015     <para>
3016       Value escaping is similar to URI escaping but simpler.
3017       <itemizedlist>
3018         <listitem>
3019           <para>
3020             The set of optionally-escaped bytes is:
3021             <literal>[0-9A-Za-z_-/.\]</literal>. To escape, each
3022             <emphasis>byte</emphasis> (note, not character) which is not in the
3023             set of optionally-escaped bytes must be replaced with an ASCII
3024             percent (<literal>%</literal>) and the value of the byte in hex.
3025             The hex value must always be two digits, even if the first digit is
3026             zero. The optionally-escaped bytes may be escaped if desired.
3027           </para>
3028         </listitem>
3029         <listitem>
3030           <para>
3031             To unescape, append each byte in the value; if a byte is an ASCII
3032             percent (<literal>%</literal>) character then append the following
3033             hex value instead. It is an error if a <literal>%</literal> byte
3034             does not have two hex digits following. It is an error if a
3035             non-optionally-escaped byte is seen unescaped.
3036           </para>
3037         </listitem>
3038       </itemizedlist>
3039       The set of optionally-escaped bytes is intended to preserve address
3040       readability and convenience.
3041     </para>
3042
3043     <para>
3044       A server may specify a key-value pair with the key <literal>guid</literal>
3045       and the value a hex-encoded 16-byte sequence. <xref linkend="uuids"/>
3046       describes the format of the <literal>guid</literal> field.  If present,
3047       this UUID may be used to distinguish one server address from another. A
3048       server should use a different UUID for each address it listens on. For
3049       example, if a message bus daemon offers both UNIX domain socket and TCP
3050       connections, but treats clients the same regardless of how they connect,
3051       those two connections are equivalent post-connection but should have
3052       distinct UUIDs to distinguish the kinds of connection.
3053     </para>
3054
3055     <para>
3056       The intent of the address UUID feature is to allow a client to avoid
3057       opening multiple identical connections to the same server, by allowing the
3058       client to check whether an address corresponds to an already-existing
3059       connection.  Comparing two addresses is insufficient, because addresses
3060       can be recycled by distinct servers, and equivalent addresses may look
3061       different if simply compared as strings (for example, the host in a TCP
3062       address can be given as an IP address or as a hostname).
3063     </para>
3064
3065     <para>
3066       Note that the address key is <literal>guid</literal> even though the
3067       rest of the API and documentation says "UUID," for historical reasons.
3068     </para>
3069
3070     <para>
3071       [FIXME clarify if attempting to connect to each is a requirement
3072       or just a suggestion]
3073       When connecting to a server, multiple server addresses can be
3074       separated by a semi-colon. The library will then try to connect
3075       to the first address and if that fails, it'll try to connect to
3076       the next one specified, and so forth. For example
3077       <programlisting>unix:path=/tmp/dbus-test;unix:path=/tmp/dbus-test2</programlisting>
3078     </para>
3079
3080     <para>
3081       Some addresses are <firstterm>connectable</firstterm>. A connectable
3082       address is one containing enough information for a client to connect
3083       to it. For instance, <literal>tcp:host=127.0.0.1,port=4242</literal>
3084       is a connectable address. It is not necessarily possible to listen
3085       on every connectable address: for instance, it is not possible to
3086       listen on a <literal>unixexec:</literal> address.
3087     </para>
3088
3089     <para>
3090       Some addresses are <firstterm>listenable</firstterm>. A listenable
3091       address is one containing enough information for a server to listen on
3092       it, producing a connectable address (which may differ from the
3093       original address). Many listenable addresses are not connectable:
3094       for instance, <literal>tcp:host=127.0.0.1</literal>
3095       is listenable, but not connectable (because it does not specify
3096       a port number).
3097     </para>
3098
3099     <para>
3100       Listening on an address that is not connectable will result in a
3101       connectable address that is not the same as the listenable address.
3102       For instance, listening on <literal>tcp:host=127.0.0.1</literal>
3103       might result in the connectable address
3104       <literal>tcp:host=127.0.0.1,port=30958</literal>,
3105       listening on <literal>unix:tmpdir=/tmp</literal>
3106       might result in the connectable address
3107       <literal>unix:abstract=/tmp/dbus-U8OSdmf7</literal>, or
3108       listening on <literal>unix:runtime=yes</literal>
3109       might result in the connectable address
3110       <literal>unix:path=/run/user/1234/bus</literal>.
3111     </para>
3112   </sect1>
3113
3114   <sect1 id="transports">
3115     <title>Transports</title>
3116     <para>
3117       [FIXME we need to specify in detail each transport and its possible arguments]
3118
3119       Current transports include: unix domain sockets (including
3120       abstract namespace on linux), launchd, systemd, TCP/IP, an executed subprocess and a debug/testing transport
3121       using in-process pipes. Future possible transports include one that
3122       tunnels over X11 protocol.
3123     </para>
3124
3125     <sect2 id="transports-unix-domain-sockets">
3126       <title>Unix Domain Sockets</title>
3127       <para>
3128         Unix domain sockets can be either paths in the file system or on Linux
3129         kernels, they can be abstract which are similar to paths but
3130         do not show up in the file system.
3131       </para>
3132
3133       <para>
3134         When a socket is opened by the D-Bus library it truncates the path
3135         name right before the first trailing Nul byte.  This is true for both
3136         normal paths and abstract paths.  Note that this is a departure from
3137         previous versions of D-Bus that would create sockets with a fixed
3138         length path name.  Names which were shorter than the fixed length
3139         would be padded by Nul bytes.
3140       </para>
3141       <para>
3142         Unix domain sockets are not available on Windows.
3143       </para>
3144       <para>
3145         Unix addresses that specify <literal>path</literal> or
3146         <literal>abstract</literal> are both listenable and connectable.
3147         Unix addresses that specify <literal>tmpdir</literal> are only
3148         listenable: the corresponding connectable address will specify
3149         either <literal>path</literal> or <literal>abstract</literal>.
3150         Similarly, Unix addresses that specify <literal>runtime</literal>
3151         are only listenable, and the corresponding connectable address
3152         will specify <literal>path</literal>.
3153       </para>
3154       <sect3 id="transports-unix-domain-sockets-addresses">
3155         <title>Server Address Format</title>
3156         <para>
3157           Unix domain socket addresses are identified by the "unix:" prefix
3158           and support the following key/value pairs:
3159         </para>
3160         <informaltable>
3161          <tgroup cols="3">
3162           <thead>
3163            <row>
3164             <entry>Name</entry>
3165             <entry>Values</entry>
3166             <entry>Description</entry>
3167            </row>
3168           </thead>
3169           <tbody>
3170            <row>
3171             <entry>path</entry>
3172             <entry>(path)</entry>
3173             <entry>path of the unix domain socket. If set, the "tmpdir" and "abstract" key must not be set.</entry>
3174           </row>
3175           <row>
3176             <entry>tmpdir</entry>
3177             <entry>(path)</entry>
3178             <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>
3179           </row>
3180           <row>
3181             <entry>abstract</entry>
3182             <entry>(string)</entry>
3183             <entry>unique string (path) in the abstract namespace. If set, the "path" or "tmpdir" key must not be set. This key is only supported on platforms with "abstract Unix sockets", of which Linux is the only known example.</entry>
3184           </row>
3185           <row>
3186             <entry>runtime</entry>
3187             <entry><literal>yes</literal></entry>
3188             <entry>If given, This key can only be used in server addresses, not in client addresses. If set, its value must be <literal>yes</literal>. This is typically used in an address string like <literal>unix:runtime=yes;unix:tmpdir=/tmp</literal> so that there can be a fallback if <literal>XDG_RUNTIME_DIR</literal> is not set.</entry>
3189           </row>
3190         </tbody>
3191         </tgroup>
3192        </informaltable>
3193        <para>
3194          Exactly one of the keys <literal>path</literal>,
3195          <literal>abstract</literal>, <literal>runtime</literal> or
3196          <literal>tmpdir</literal> must be provided.
3197        </para>
3198       </sect3>
3199     </sect2>
3200     <sect2 id="transports-launchd">
3201       <title>launchd</title>
3202       <para>
3203         launchd is an open-source server management system that replaces init, inetd
3204         and cron on Apple Mac OS X versions 10.4 and above. It provides a common session
3205         bus address for each user and deprecates the X11-enabled D-Bus launcher on OSX.
3206       </para>
3207
3208       <para>
3209         launchd allocates a socket and provides it with the unix path through the
3210         DBUS_LAUNCHD_SESSION_BUS_SOCKET variable in launchd's environment. Every process
3211         spawned by launchd (or dbus-daemon, if it was started by launchd) can access
3212         it through its environment.
3213         Other processes can query for the launchd socket by executing:
3214         $ launchctl getenv DBUS_LAUNCHD_SESSION_BUS_SOCKET
3215         This is normally done by the D-Bus client library so doesn't have to be done
3216         manually.
3217       </para>
3218       <para>
3219         launchd is not available on Microsoft Windows.
3220       </para>
3221       <para>
3222         launchd addresses are listenable and connectable.
3223       </para>
3224       <sect3 id="transports-launchd-addresses">
3225         <title>Server Address Format</title>
3226         <para>
3227           launchd addresses are identified by the "launchd:" prefix
3228           and support the following key/value pairs:
3229         </para>
3230         <informaltable>
3231          <tgroup cols="3">
3232           <thead>
3233            <row>
3234             <entry>Name</entry>
3235             <entry>Values</entry>
3236             <entry>Description</entry>
3237            </row>
3238           </thead>
3239           <tbody>
3240            <row>
3241             <entry>env</entry>
3242             <entry>(environment variable)</entry>
3243             <entry>path of the unix domain socket for the launchd created dbus-daemon.</entry>
3244           </row>
3245         </tbody>
3246         </tgroup>
3247        </informaltable>
3248        <para>
3249          The <literal>env</literal> key is required.
3250        </para>
3251       </sect3>
3252     </sect2>
3253     <sect2 id="transports-systemd">
3254       <title>systemd</title>
3255       <para>
3256         systemd is an open-source server management system that
3257         replaces init and inetd on newer Linux systems. It supports
3258         socket activation. The D-Bus systemd transport is used to acquire
3259         socket activation file descriptors from systemd and use them
3260         as D-Bus transport when the current process is spawned by
3261         socket activation from it.
3262       </para>
3263       <para>
3264         The systemd transport accepts only one or more Unix domain or
3265         TCP streams sockets passed in via socket activation.
3266       </para>
3267       <para>
3268         The systemd transport is not available on non-Linux operating systems.
3269       </para>
3270       <para>
3271         The systemd transport defines no parameter keys.
3272       </para>
3273       <para>
3274         systemd addresses are listenable, but not connectable. The
3275         corresponding connectable address is the <literal>unix</literal>
3276         or <literal>tcp</literal> address of the socket.
3277       </para>
3278     </sect2>
3279     <sect2 id="transports-tcp-sockets">
3280       <title>TCP Sockets</title>
3281       <para>
3282         The tcp transport provides TCP/IP based connections between clients
3283         located on the same or different hosts.
3284       </para>
3285       <para>
3286         Using tcp transport without any additional secure authentification mechanismus
3287         over a network is unsecure.
3288       </para>
3289       <para>
3290         On Windows and most Unix platforms, the TCP stack is unable to transfer
3291         credentials over a TCP connection, so the EXTERNAL authentication
3292         mechanism does not work for this transport.
3293       </para>
3294       <para>
3295         All <literal>tcp</literal> addresses are listenable.
3296         <literal>tcp</literal> addresses in which both
3297         <literal>host</literal> and <literal>port</literal> are
3298         specified, and <literal>port</literal> is non-zero,
3299         are also connectable.
3300       </para>
3301       <sect3 id="transports-tcp-sockets-addresses">
3302         <title>Server Address Format</title>
3303         <para>
3304          TCP/IP socket addresses are identified by the "tcp:" prefix
3305          and support the following key/value pairs:
3306         </para>
3307         <informaltable>
3308          <tgroup cols="3">
3309           <thead>
3310            <row>
3311             <entry>Name</entry>
3312             <entry>Values</entry>
3313             <entry>Description</entry>
3314            </row>
3315           </thead>
3316           <tbody>
3317            <row>
3318             <entry>host</entry>
3319             <entry>(string)</entry>
3320             <entry>DNS name or IP address</entry>
3321           </row>
3322           <row>
3323            <entry>bind</entry>
3324            <entry>(string)</entry>
3325            <entry>Used in a listenable address to configure the interface
3326             on which the server will listen: either the IP address of one of
3327             the local machine's interfaces (most commonly <literal>127.0.0.1
3328             </literal>), or a DNS name that resolves to one of those IP
3329             addresses, or '*' to listen on all interfaces simultaneously.
3330             If not specified, the default is the same value as "host".
3331            </entry>
3332           </row>
3333           <row>
3334            <entry>port</entry>
3335            <entry>(number)</entry>
3336            <entry>The tcp port the server will open. A zero value let the server
3337             choose a free port provided from the underlaying operating system.
3338             libdbus is able to retrieve the real used port from the server.
3339            </entry>
3340           </row>
3341           <row>
3342            <entry>family</entry>
3343            <entry>(string)</entry>
3344            <entry>If set, provide the type of socket family either "ipv4" or "ipv6". If unset, the family is unspecified.</entry>
3345           </row>
3346          </tbody>
3347         </tgroup>
3348        </informaltable>
3349       </sect3>
3350     </sect2>
3351     <sect2 id="transports-nonce-tcp-sockets">
3352       <title>Nonce-secured TCP Sockets</title>
3353       <para>
3354         The nonce-tcp transport provides a secured TCP transport, using a
3355         simple authentication mechanism to ensure that only clients with read
3356         access to a certain location in the filesystem can connect to the server.
3357         The server writes a secret, the nonce, to a file and an incoming client
3358         connection is only accepted if the client sends the nonce right after
3359         the connect. The nonce mechanism requires no setup and is orthogonal to
3360         the higher-level authentication mechanisms described in the
3361         Authentication section.
3362       </para>
3363
3364       <para>
3365         On start, the server generates a random 16 byte nonce and writes it
3366         to a file in the user's temporary directory. The nonce file location
3367         is published as part of the server's D-Bus address using the
3368         "noncefile" key-value pair.
3369
3370         After an accept, the server reads 16 bytes from the socket. If the
3371         read bytes do not match the nonce stored in the nonce file, the
3372         server MUST immediately drop the connection.
3373         If the nonce match the received byte sequence, the client is accepted
3374         and the transport behaves like an unsecured tcp transport.
3375       </para>
3376       <para>
3377         After a successful connect to the server socket, the client MUST read
3378         the nonce from the file published by the server via the noncefile=
3379         key-value pair and send it over the socket. After that, the
3380         transport behaves like an unsecured tcp transport.
3381       </para>
3382       <para>
3383         All nonce-tcp addresses are listenable. nonce-tcp addresses in which
3384         <literal>host</literal>, <literal>port</literal> and
3385         <literal>noncefile</literal> are all specified,
3386         and <literal>port</literal> is nonzero, are also connectable.
3387       </para>
3388       <sect3 id="transports-nonce-tcp-sockets-addresses">
3389         <title>Server Address Format</title>
3390         <para>
3391          Nonce TCP/IP socket addresses uses the "nonce-tcp:" prefix
3392          and support the following key/value pairs:
3393         </para>
3394         <informaltable>
3395          <tgroup cols="3">
3396           <thead>
3397            <row>
3398             <entry>Name</entry>
3399             <entry>Values</entry>
3400             <entry>Description</entry>
3401            </row>
3402           </thead>
3403           <tbody>
3404            <row>
3405             <entry>host</entry>
3406             <entry>(string)</entry>
3407             <entry>DNS name or IP address</entry>
3408           </row>
3409           <row>
3410            <entry>bind</entry>
3411            <entry>(string)</entry>
3412            <entry>The same as for tcp: addresses
3413            </entry>
3414           </row>
3415           <row>
3416            <entry>port</entry>
3417            <entry>(number)</entry>
3418            <entry>The tcp port the server will open. A zero value let the server
3419             choose a free port provided from the underlaying operating system.
3420             libdbus is able to retrieve the real used port from the server.
3421            </entry>
3422           </row>
3423           <row>
3424            <entry>family</entry>
3425            <entry>(string)</entry>
3426            <entry>If set, provide the type of socket family either "ipv4" or "ipv6". If unset, the family is unspecified.</entry>
3427           </row>
3428           <row>
3429            <entry>noncefile</entry>
3430            <entry>(path)</entry>
3431            <entry>File location containing the secret.
3432              This is only meaningful in connectable addresses:
3433              a listening D-Bus server that offers this transport
3434              will always create a new nonce file.</entry>
3435           </row>
3436          </tbody>
3437         </tgroup>
3438        </informaltable>
3439       </sect3>
3440     </sect2>
3441     <sect2 id="transports-exec">
3442       <title>Executed Subprocesses on Unix</title>
3443       <para>
3444         This transport forks off a process and connects its standard
3445         input and standard output with an anonymous Unix domain
3446         socket. This socket is then used for communication by the
3447         transport. This transport may be used to use out-of-process
3448         forwarder programs as basis for the D-Bus protocol.
3449       </para>
3450       <para>
3451         The forked process will inherit the standard error output and
3452         process group from the parent process.
3453       </para>
3454       <para>
3455         Executed subprocesses are not available on Windows.
3456       </para>
3457       <para>
3458         <literal>unixexec</literal> addresses are connectable, but are not
3459         listenable.
3460       </para>
3461       <sect3 id="transports-exec-addresses">
3462         <title>Server Address Format</title>
3463         <para>
3464           Executed subprocess addresses are identified by the "unixexec:" prefix
3465           and support the following key/value pairs:
3466         </para>
3467         <informaltable>
3468          <tgroup cols="3">
3469           <thead>
3470            <row>
3471             <entry>Name</entry>
3472             <entry>Values</entry>
3473             <entry>Description</entry>
3474            </row>
3475           </thead>
3476           <tbody>
3477            <row>
3478             <entry>path</entry>
3479             <entry>(path)</entry>
3480             <entry>Path of the binary to execute, either an absolute
3481             path or a binary name that is searched for in the default
3482             search path of the OS. This corresponds to the first
3483             argument of execlp(). This key is mandatory.</entry>
3484           </row>
3485           <row>
3486             <entry>argv0</entry>
3487             <entry>(string)</entry>
3488             <entry>The program name to use when executing the
3489             binary. If omitted the same value as specified for path=
3490             will be used. This corresponds to the second argument of
3491             execlp().</entry>
3492           </row>
3493           <row>
3494             <entry>argv1, argv2, ...</entry>
3495             <entry>(string)</entry>
3496             <entry>Arguments to pass to the binary. This corresponds
3497             to the third and later arguments of execlp(). If a
3498             specific argvX is not specified no further argvY for Y > X
3499             are taken into account.</entry>
3500           </row>
3501         </tbody>
3502         </tgroup>
3503        </informaltable>
3504       </sect3>
3505     </sect2>
3506    </sect1>
3507    <sect1 id="meta-transports">
3508     <title>Meta Transports</title>
3509     <para>
3510       Meta transports are a kind of transport with special enhancements or
3511       behavior. Currently available meta transports include: autolaunch
3512     </para>
3513
3514     <sect2 id="meta-transports-autolaunch">
3515      <title>Autolaunch</title>
3516      <para>The autolaunch transport provides a way for dbus clients to autodetect
3517        a running dbus session bus and to autolaunch a session bus if not present.
3518      </para>
3519       <para>
3520         On Unix, <literal>autolaunch</literal> addresses are connectable,
3521         but not listenable.
3522       </para>
3523       <para>
3524         On Windows, <literal>autolaunch</literal> addresses are both
3525         connectable and listenable.
3526       </para>
3527
3528      <sect3 id="meta-transports-autolaunch-addresses">
3529        <title>Server Address Format</title>
3530        <para>
3531          Autolaunch addresses uses the "autolaunch:" prefix and support the
3532          following key/value pairs:
3533        </para>
3534        <informaltable>
3535         <tgroup cols="3">
3536          <thead>
3537           <row>
3538            <entry>Name</entry>
3539            <entry>Values</entry>
3540            <entry>Description</entry>
3541           </row>
3542          </thead>
3543          <tbody>
3544           <row>
3545            <entry>scope</entry>
3546            <entry>(string)</entry>
3547            <entry>scope of autolaunch (Windows only)
3548             <itemizedlist>
3549              <listitem>
3550               <para>
3551                "*install-path" - limit session bus to dbus installation path.
3552                The dbus installation path is determined from the location of
3553                the shared dbus library. If the library is located in a 'bin'
3554                subdirectory the installation root is the directory above,
3555                otherwise the directory where the library lives is taken as
3556                installation root.
3557                <programlisting>
3558                    &lt;install-root&gt;/bin/[lib]dbus-1.dll
3559                    &lt;install-root&gt;/[lib]dbus-1.dll
3560                </programlisting>
3561               </para>
3562              </listitem>
3563              <listitem>
3564               <para>
3565                "*user" - limit session bus to the recent user.
3566               </para>
3567              </listitem>
3568              <listitem>
3569               <para>
3570                other values - specify dedicated session bus like "release",
3571                "debug" or other
3572               </para>
3573              </listitem>
3574             </itemizedlist>
3575            </entry>
3576          </row>
3577         </tbody>
3578        </tgroup>
3579       </informaltable>
3580      </sect3>
3581
3582      <sect3 id="meta-transports-autolaunch-windows-implementation">
3583       <title>Windows implementation</title>
3584       <para>
3585         On start, the server opens a platform specific transport, creates a mutex
3586         and a shared memory section containing the related session bus address.
3587         This mutex will be inspected by the dbus client library to detect a
3588         running dbus session bus. The access to the mutex and the shared memory
3589         section are protected by global locks.
3590       </para>
3591       <para>
3592        In the recent implementation the autolaunch transport uses a tcp transport
3593        on localhost with a port choosen from the operating system. This detail may
3594        change in the future.
3595       </para>
3596       <para>
3597         Disclaimer: The recent implementation is in an early state and may not
3598         work in all cirumstances and/or may have security issues. Because of this
3599         the implementation is not documentated yet.
3600       </para>
3601      </sect3>
3602     </sect2>
3603    </sect1>
3604
3605   <sect1 id="uuids">
3606     <title>UUIDs</title>
3607     <para>
3608       A working D-Bus implementation uses universally-unique IDs in two places.
3609       First, each server address has a UUID identifying the address,
3610       as described in <xref linkend="addresses"/>. Second, each operating
3611       system kernel instance running a D-Bus client or server has a UUID
3612       identifying that kernel, retrieved by invoking the method
3613       org.freedesktop.DBus.Peer.GetMachineId() (see <xref
3614       linkend="standard-interfaces-peer"/>).
3615     </para>
3616     <para>
3617       The term "UUID" in this document is intended literally, i.e. an
3618       identifier that is universally unique. It is not intended to refer to
3619       RFC4122, and in fact the D-Bus UUID is not compatible with that RFC.
3620     </para>
3621     <para>
3622       The UUID must contain 128 bits of data and be hex-encoded.  The
3623       hex-encoded string may not contain hyphens or other non-hex-digit
3624       characters, and it must be exactly 32 characters long.  To generate a
3625       UUID, the current reference implementation concatenates 96 bits of random
3626       data followed by the 32-bit time in seconds since the UNIX epoch (in big
3627       endian byte order).
3628     </para>
3629     <para>
3630       It would also be acceptable and probably better to simply generate 128
3631       bits of random data, as long as the random number generator is of high
3632       quality. The timestamp could conceivably help if the random bits are not
3633       very random. With a quality random number generator, collisions are
3634       extremely unlikely even with only 96 bits, so it's somewhat academic.
3635     </para>
3636     <para>
3637       Implementations should, however, stick to random data for the first 96 bits
3638       of the UUID.
3639     </para>
3640   </sect1>
3641
3642   <sect1 id="standard-interfaces">
3643     <title>Standard Interfaces</title>
3644     <para>
3645       See <xref linkend="message-protocol-types-notation"/> for details on
3646        the notation used in this section. There are some standard interfaces
3647       that may be useful across various D-Bus applications.
3648     </para>
3649     <sect2 id="standard-interfaces-peer">
3650       <title><literal>org.freedesktop.DBus.Peer</literal></title>
3651       <para>
3652         The <literal>org.freedesktop.DBus.Peer</literal> interface
3653         has two methods:
3654         <programlisting>
3655           org.freedesktop.DBus.Peer.Ping ()
3656           org.freedesktop.DBus.Peer.GetMachineId (out STRING machine_uuid)
3657         </programlisting>
3658       </para>
3659       <para>
3660         On receipt of the <literal>METHOD_CALL</literal> message
3661         <literal>org.freedesktop.DBus.Peer.Ping</literal>, an application should do
3662         nothing other than reply with a <literal>METHOD_RETURN</literal> as
3663         usual.  It does not matter which object path a ping is sent to.  The
3664         reference implementation handles this method automatically.
3665       </para>
3666       <para>
3667         On receipt of the <literal>METHOD_CALL</literal> message
3668         <literal>org.freedesktop.DBus.Peer.GetMachineId</literal>, an application should
3669         reply with a <literal>METHOD_RETURN</literal> containing a hex-encoded
3670         UUID representing the identity of the machine the process is running on.
3671         This UUID must be the same for all processes on a single system at least
3672         until that system next reboots. It should be the same across reboots
3673         if possible, but this is not always possible to implement and is not
3674         guaranteed.
3675         It does not matter which object path a GetMachineId is sent to.  The
3676         reference implementation handles this method automatically.
3677       </para>
3678       <para>
3679         The UUID is intended to be per-instance-of-the-operating-system, so may represent
3680         a virtual machine running on a hypervisor, rather than a physical machine.
3681         Basically if two processes see the same UUID, they should also see the same
3682         shared memory, UNIX domain sockets, process IDs, and other features that require
3683         a running OS kernel in common between the processes.
3684       </para>
3685       <para>
3686         The UUID is often used where other programs might use a hostname. Hostnames
3687         can change without rebooting, however, or just be "localhost" - so the UUID
3688         is more robust.
3689       </para>
3690       <para>
3691         <xref linkend="uuids"/> explains the format of the UUID.
3692       </para>
3693     </sect2>
3694
3695     <sect2 id="standard-interfaces-introspectable">
3696       <title><literal>org.freedesktop.DBus.Introspectable</literal></title>
3697       <para>
3698         This interface has one method:
3699         <programlisting>
3700           org.freedesktop.DBus.Introspectable.Introspect (out STRING xml_data)
3701         </programlisting>
3702       </para>
3703       <para>
3704         Objects instances may implement
3705         <literal>Introspect</literal> which returns an XML description of
3706         the object, including its interfaces (with signals and methods), objects
3707         below it in the object path tree, and its properties.
3708       </para>
3709       <para>
3710         <xref linkend="introspection-format"/> describes the format of this XML string.
3711       </para>
3712     </sect2>
3713     <sect2 id="standard-interfaces-properties">
3714       <title><literal>org.freedesktop.DBus.Properties</literal></title>
3715       <para>
3716         Many native APIs will have a concept of object <firstterm>properties</firstterm>
3717         or <firstterm>attributes</firstterm>. These can be exposed via the
3718         <literal>org.freedesktop.DBus.Properties</literal> interface.
3719       </para>
3720       <para>
3721         <programlisting>
3722               org.freedesktop.DBus.Properties.Get (in STRING interface_name,
3723                                                    in STRING property_name,
3724                                                    out VARIANT value);
3725               org.freedesktop.DBus.Properties.Set (in STRING interface_name,
3726                                                    in STRING property_name,
3727                                                    in VARIANT value);
3728               org.freedesktop.DBus.Properties.GetAll (in STRING interface_name,
3729                                                       out DICT&lt;STRING,VARIANT&gt; props);
3730         </programlisting>
3731       </para>
3732       <para>
3733         It is conventional to give D-Bus properties names consisting of
3734         capitalized words without punctuation ("CamelCase"), like
3735         <link linkend="message-protocol-names-member">member names</link>.
3736         For instance, the GObject property
3737         <literal>connection-status</literal> or the Qt property
3738         <literal>connectionStatus</literal> could be represented on D-Bus
3739         as <literal>ConnectionStatus</literal>.
3740       </para>
3741       <para>
3742         Strictly speaking, D-Bus property names are not required to follow
3743         the same naming restrictions as member names, but D-Bus property
3744         names that would not be valid member names (in particular,
3745         GObject-style dash-separated property names) can cause interoperability
3746         problems and should be avoided.
3747       </para>
3748       <para>
3749         The available properties and whether they are writable can be determined
3750         by calling <literal>org.freedesktop.DBus.Introspectable.Introspect</literal>,
3751         see <xref linkend="standard-interfaces-introspectable"/>.
3752       </para>
3753       <para>
3754         An empty string may be provided for the interface name; in this case,
3755         if there are multiple properties on an object with the same name,
3756         the results are undefined (picking one by according to an arbitrary
3757         deterministic rule, or returning an error, are the reasonable
3758         possibilities).
3759       </para>
3760       <para>
3761         If one or more properties change on an object, the
3762         <literal>org.freedesktop.DBus.Properties.PropertiesChanged</literal>
3763         signal may be emitted (this signal was added in 0.14):
3764       </para>
3765       <para>
3766         <programlisting>
3767               org.freedesktop.DBus.Properties.PropertiesChanged (STRING interface_name,
3768                                                                  DICT&lt;STRING,VARIANT&gt; changed_properties,
3769                                                                  ARRAY&lt;STRING&gt; invalidated_properties);
3770         </programlisting>
3771       </para>
3772       <para>
3773         where <literal>changed_properties</literal> is a dictionary
3774         containing the changed properties with the new values and
3775         <literal>invalidated_properties</literal> is an array of
3776         properties that changed but the value is not conveyed.
3777       </para>
3778       <para>
3779         Whether the <literal>PropertiesChanged</literal> signal is
3780         supported can be determined by calling
3781         <literal>org.freedesktop.DBus.Introspectable.Introspect</literal>. Note
3782         that the signal may be supported for an object but it may
3783         differ how whether and how it is used on a per-property basis
3784         (for e.g. performance or security reasons). Each property (or
3785         the parent interface) must be annotated with the
3786         <literal>org.freedesktop.DBus.Property.EmitsChangedSignal</literal>
3787         annotation to convey this (usually the default value
3788         <literal>true</literal> is sufficient meaning that the
3789         annotation does not need to be used). See <xref
3790         linkend="introspection-format"/> for details on this
3791         annotation.
3792       </para>
3793     </sect2>
3794
3795     <sect2 id="standard-interfaces-objectmanager">
3796       <title><literal>org.freedesktop.DBus.ObjectManager</literal></title>
3797       <para>
3798         An API can optionally make use of this interface for one or
3799         more sub-trees of objects. The root of each sub-tree implements
3800         this interface so other applications can get all objects,
3801         interfaces and properties in a single method call.  It is
3802         appropriate to use this interface if users of the tree of
3803         objects are expected to be interested in all interfaces of all
3804         objects in the tree; a more granular API should be used if
3805         users of the objects are expected to be interested in a small
3806         subset of the objects, a small subset of their interfaces, or
3807         both.
3808       </para>
3809       <para>
3810         The method that applications can use to get all objects and
3811         properties is <literal>GetManagedObjects</literal>:
3812       </para>
3813       <para>
3814         <programlisting>
3815           org.freedesktop.DBus.ObjectManager.GetManagedObjects (out DICT&lt;OBJPATH,DICT&lt;STRING,DICT&lt;STRING,VARIANT&gt;&gt;&gt; objpath_interfaces_and_properties);
3816         </programlisting>
3817       </para>
3818       <para>
3819         The return value of this method is a dict whose keys are
3820         object paths. All returned object paths are children of the
3821         object path implementing this interface, i.e. their object
3822         paths start with the ObjectManager's object path plus '/'.
3823       </para>
3824       <para>
3825         Each value is a dict whose keys are interfaces names.  Each
3826         value in this inner dict is the same dict that would be
3827         returned by the <link
3828         linkend="standard-interfaces-properties">org.freedesktop.DBus.Properties.GetAll()</link>
3829         method for that combination of object path and interface. If
3830         an interface has no properties, the empty dict is returned.
3831       </para>
3832       <para>
3833         Changes are emitted using the following two signals:
3834       </para>
3835       <para>
3836         <programlisting>
3837           org.freedesktop.DBus.ObjectManager.InterfacesAdded (OBJPATH object_path,
3838                                                               DICT&lt;STRING,DICT&lt;STRING,VARIANT&gt;&gt; interfaces_and_properties);
3839           org.freedesktop.DBus.ObjectManager.InterfacesRemoved (OBJPATH object_path,
3840                                                                 ARRAY&lt;STRING&gt; interfaces);
3841         </programlisting>
3842       </para>
3843       <para>
3844         The <literal>InterfacesAdded</literal> signal is emitted when
3845         either a new object is added or when an existing object gains
3846         one or more interfaces. The
3847         <literal>InterfacesRemoved</literal> signal is emitted
3848         whenever an object is removed or it loses one or more
3849         interfaces. The second parameter of the
3850         <literal>InterfacesAdded</literal> signal contains a dict with
3851         the interfaces and properties (if any) that have been added to
3852         the given object path. Similarly, the second parameter of the
3853         <literal>InterfacesRemoved</literal> signal contains an array
3854         of the interfaces that were removed. Note that changes on
3855         properties on existing interfaces are not reported using this
3856         interface - an application should also monitor the existing <link
3857         linkend="standard-interfaces-properties">PropertiesChanged</link>
3858         signal on each object.
3859       </para>
3860       <para>
3861         Applications SHOULD NOT export objects that are children of an
3862         object (directly or otherwise) implementing this interface but
3863         which are not returned in the reply from the
3864         <literal>GetManagedObjects()</literal> method of this
3865         interface on the given object.
3866       </para>
3867       <para>
3868         The intent of the <literal>ObjectManager</literal> interface
3869         is to make it easy to write a robust client
3870         implementation. The trivial client implementation only needs
3871         to make two method calls:
3872       </para>
3873       <para>
3874         <programlisting>
3875           org.freedesktop.DBus.AddMatch (bus_proxy,
3876                                          "type='signal',name='org.example.App',path_namespace='/org/example/App'");
3877           objects = org.freedesktop.DBus.ObjectManager.GetManagedObjects (app_proxy);
3878         </programlisting>
3879       </para>
3880       <para>
3881         on the message bus and the remote application's
3882         <literal>ObjectManager</literal>, respectively. Whenever a new
3883         remote object is created (or an existing object gains a new
3884         interface), the <literal>InterfacesAdded</literal> signal is
3885         emitted, and since this signal contains all properties for the
3886         interfaces, no calls to the
3887         <literal>org.freedesktop.Properties</literal> interface on the
3888         remote object are needed. Additionally, since the initial
3889         <literal>AddMatch()</literal> rule already includes signal
3890         messages from the newly created child object, no new
3891         <literal>AddMatch()</literal> call is needed.
3892       </para>
3893
3894       <para>
3895         <emphasis>
3896           The <literal>org.freedesktop.DBus.ObjectManager</literal>
3897           interface was added in version 0.17 of the D-Bus
3898           specification.
3899         </emphasis>
3900       </para>
3901     </sect2>
3902   </sect1>
3903
3904   <sect1 id="introspection-format">
3905     <title>Introspection Data Format</title>
3906     <para>
3907       As described in <xref linkend="standard-interfaces-introspectable"/>,
3908       objects may be introspected at runtime, returning an XML string
3909       that describes the object. The same XML format may be used in
3910       other contexts as well, for example as an "IDL" for generating
3911       static language bindings.
3912     </para>
3913     <para>
3914       Here is an example of introspection data:
3915       <programlisting>
3916         &lt;!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
3917          "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd"&gt;
3918         &lt;node name="/com/example/sample_object"&gt;
3919           &lt;interface name="com.example.SampleInterface"&gt;
3920             &lt;method name="Frobate"&gt;
3921               &lt;arg name="foo" type="i" direction="in"/&gt;
3922               &lt;arg name="bar" type="s" direction="out"/&gt;
3923               &lt;arg name="baz" type="a{us}" direction="out"/&gt;
3924               &lt;annotation name="org.freedesktop.DBus.Deprecated" value="true"/&gt;
3925             &lt;/method&gt;
3926             &lt;method name="Bazify"&gt;
3927               &lt;arg name="bar" type="(iiu)" direction="in"/&gt;
3928               &lt;arg name="bar" type="v" direction="out"/&gt;
3929             &lt;/method&gt;
3930             &lt;method name="Mogrify"&gt;
3931               &lt;arg name="bar" type="(iiav)" direction="in"/&gt;
3932             &lt;/method&gt;
3933             &lt;signal name="Changed"&gt;
3934               &lt;arg name="new_value" type="b"/&gt;
3935             &lt;/signal&gt;
3936             &lt;property name="Bar" type="y" access="readwrite"/&gt;
3937           &lt;/interface&gt;
3938           &lt;node name="child_of_sample_object"/&gt;
3939           &lt;node name="another_child_of_sample_object"/&gt;
3940        &lt;/node&gt;
3941       </programlisting>
3942     </para>
3943     <para>
3944       A more formal DTD and spec needs writing, but here are some quick notes.
3945       <itemizedlist>
3946         <listitem>
3947           <para>
3948             Only the root &lt;node&gt; element can omit the node name, as it's
3949             known to be the object that was introspected.  If the root
3950             &lt;node&gt; does have a name attribute, it must be an absolute
3951             object path. If child &lt;node&gt; have object paths, they must be
3952             relative.
3953           </para>
3954         </listitem>
3955         <listitem>
3956           <para>
3957             If a child &lt;node&gt; has any sub-elements, then they
3958             must represent a complete introspection of the child.
3959             If a child &lt;node&gt; is empty, then it may or may
3960             not have sub-elements; the child must be introspected
3961             in order to find out. The intent is that if an object
3962             knows that its children are "fast" to introspect
3963             it can go ahead and return their information, but
3964             otherwise it can omit it.
3965           </para>
3966         </listitem>
3967         <listitem>
3968           <para>
3969             The direction element on &lt;arg&gt; may be omitted,
3970             in which case it defaults to "in" for method calls
3971             and "out" for signals. Signals only allow "out"
3972             so while direction may be specified, it's pointless.
3973           </para>
3974         </listitem>
3975         <listitem>
3976           <para>
3977             The possible directions are "in" and "out",
3978             unlike CORBA there is no "inout"
3979           </para>
3980         </listitem>
3981         <listitem>
3982           <para>
3983             The possible property access flags are
3984             "readwrite", "read", and "write"
3985           </para>
3986         </listitem>
3987         <listitem>
3988           <para>
3989             Multiple interfaces can of course be listed for
3990             one &lt;node&gt;.
3991           </para>
3992         </listitem>
3993         <listitem>
3994           <para>
3995             The "name" attribute on arguments is optional.
3996           </para>
3997         </listitem>
3998       </itemizedlist>
3999     </para>
4000     <para>
4001         Method, interface, property, and signal elements may have
4002         "annotations", which are generic key/value pairs of metadata.
4003         They are similar conceptually to Java's annotations and C# attributes.
4004         Well-known annotations:
4005      </para>
4006      <informaltable>
4007        <tgroup cols="3">
4008          <thead>
4009            <row>
4010              <entry>Name</entry>
4011              <entry>Values (separated by ,)</entry>
4012              <entry>Description</entry>
4013            </row>
4014          </thead>
4015          <tbody>
4016            <row>
4017              <entry>org.freedesktop.DBus.Deprecated</entry>
4018              <entry>true,false</entry>
4019              <entry>Whether or not the entity is deprecated; defaults to false</entry>
4020            </row>
4021            <row>
4022              <entry>org.freedesktop.DBus.GLib.CSymbol</entry>
4023              <entry>(string)</entry>
4024              <entry>The C symbol; may be used for methods and interfaces</entry>
4025            </row>
4026            <row>
4027              <entry>org.freedesktop.DBus.Method.NoReply</entry>
4028              <entry>true,false</entry>
4029              <entry>If set, don't expect a reply to the method call; defaults to false.</entry>
4030            </row>
4031            <row>
4032              <entry>org.freedesktop.DBus.Property.EmitsChangedSignal</entry>
4033              <entry>true,invalidates,const,false</entry>
4034              <entry>
4035                <para>
4036                  If set to <literal>false</literal>, the
4037                  <literal>org.freedesktop.DBus.Properties.PropertiesChanged</literal>
4038                  signal, see <xref
4039                  linkend="standard-interfaces-properties"/> is not
4040                  guaranteed to be emitted if the property changes.
4041                </para>
4042                <para>
4043                  If set to <literal>const</literal> the property never
4044                  changes value during the lifetime of the object it
4045                  belongs to, and hence the signal is never emitted for
4046                  it.
4047                </para>
4048                <para>
4049                  If set to <literal>invalidates</literal> the signal
4050                  is emitted but the value is not included in the
4051                  signal.
4052                </para>
4053                <para>
4054                  If set to <literal>true</literal> the signal is
4055                  emitted with the value included.
4056                </para>
4057                <para>
4058                  The value for the annotation defaults to
4059                  <literal>true</literal> if the enclosing interface
4060                  element does not specify the annotation. Otherwise it
4061                  defaults to the value specified in the enclosing
4062                  interface element.
4063                </para>
4064                <para>
4065                  This annotation is intended to be used by code
4066                  generators to implement client-side caching of
4067                  property values. For all properties for which the
4068                  annotation is set to <literal>const</literal>,
4069                  <literal>invalidates</literal> or
4070                  <literal>true</literal> the client may
4071                  unconditionally cache the values as the properties
4072                  don't change or notifications are generated for them
4073                  if they do.
4074                </para>
4075              </entry>
4076            </row>
4077          </tbody>
4078        </tgroup>
4079      </informaltable>
4080   </sect1>
4081   <sect1 id="message-bus">
4082     <title>Message Bus Specification</title>
4083     <sect2 id="message-bus-overview">
4084       <title>Message Bus Overview</title>
4085       <para>
4086         The message bus accepts connections from one or more applications.
4087         Once connected, applications can exchange messages with other
4088         applications that are also connected to the bus.
4089       </para>
4090       <para>
4091         In order to route messages among connections, the message bus keeps a
4092         mapping from names to connections. Each connection has one
4093         unique-for-the-lifetime-of-the-bus name automatically assigned.
4094         Applications may request additional names for a connection. Additional
4095         names are usually "well-known names" such as
4096         "com.example.TextEditor". When a name is bound to a connection,
4097         that connection is said to <firstterm>own</firstterm> the name.
4098       </para>
4099       <para>
4100         The bus itself owns a special name,
4101         <literal>org.freedesktop.DBus</literal>, with an object
4102         located at <literal>/org/freedesktop/DBus</literal> that
4103         implements the <literal>org.freedesktop.DBus</literal>
4104         interface. This service allows applications to make
4105         administrative requests of the bus itself. For example,
4106         applications can ask the bus to assign a name to a connection.
4107       </para>
4108       <para>
4109         Each name may have <firstterm>queued owners</firstterm>.  When an
4110         application requests a name for a connection and the name is already in
4111         use, the bus will optionally add the connection to a queue waiting for
4112         the name. If the current owner of the name disconnects or releases
4113         the name, the next connection in the queue will become the new owner.
4114       </para>
4115
4116       <para>
4117         This feature causes the right thing to happen if you start two text
4118         editors for example; the first one may request "com.example.TextEditor",
4119         and the second will be queued as a possible owner of that name. When
4120         the first exits, the second will take over.
4121       </para>
4122
4123       <para>
4124         Applications may send <firstterm>unicast messages</firstterm> to
4125         a specific recipient or to the message bus itself, or
4126         <firstterm>broadcast messages</firstterm> to all interested recipients.
4127         See <xref linkend="message-bus-routing"/> for details.
4128       </para>
4129     </sect2>
4130
4131     <sect2 id="message-bus-names">
4132       <title>Message Bus Names</title>
4133       <para>
4134         Each connection has at least one name, assigned at connection time and
4135         returned in response to the
4136         <literal>org.freedesktop.DBus.Hello</literal> method call.  This
4137         automatically-assigned name is called the connection's <firstterm>unique
4138         name</firstterm>.  Unique names are never reused for two different
4139         connections to the same bus.
4140       </para>
4141       <para>
4142         Ownership of a unique name is a prerequisite for interaction with
4143         the message bus. It logically follows that the unique name is always
4144         the first name that an application comes to own, and the last
4145         one that it loses ownership of.
4146       </para>
4147       <para>
4148         Unique connection names must begin with the character ':' (ASCII colon
4149         character); bus names that are not unique names must not begin
4150         with this character. (The bus must reject any attempt by an application
4151         to manually request a name beginning with ':'.) This restriction
4152         categorically prevents "spoofing"; messages sent to a unique name
4153         will always go to the expected connection.
4154       </para>
4155       <para>
4156         When a connection is closed, all the names that it owns are deleted (or
4157         transferred to the next connection in the queue if any).
4158       </para>
4159       <para>
4160         A connection can request additional names to be associated with it using
4161         the <literal>org.freedesktop.DBus.RequestName</literal> message. <xref
4162         linkend="message-protocol-names-bus"/> describes the format of a valid
4163         name. These names can be released again using the
4164         <literal>org.freedesktop.DBus.ReleaseName</literal> message.
4165       </para>
4166
4167       <sect3 id="bus-messages-request-name">
4168         <title><literal>org.freedesktop.DBus.RequestName</literal></title>
4169         <para>
4170           As a method:
4171           <programlisting>
4172             UINT32 RequestName (in STRING name, in UINT32 flags)
4173           </programlisting>
4174           Message arguments:
4175           <informaltable>
4176             <tgroup cols="3">
4177               <thead>
4178                 <row>
4179                   <entry>Argument</entry>
4180                   <entry>Type</entry>
4181                   <entry>Description</entry>
4182                 </row>
4183               </thead>
4184               <tbody>
4185                 <row>
4186                   <entry>0</entry>
4187                   <entry>STRING</entry>
4188                   <entry>Name to request</entry>
4189                 </row>
4190                 <row>
4191                   <entry>1</entry>
4192                   <entry>UINT32</entry>
4193                   <entry>Flags</entry>
4194                 </row>
4195               </tbody>
4196             </tgroup>
4197           </informaltable>
4198           Reply arguments:
4199           <informaltable>
4200             <tgroup cols="3">
4201               <thead>
4202                 <row>
4203                   <entry>Argument</entry>
4204                   <entry>Type</entry>
4205                   <entry>Description</entry>
4206                 </row>
4207               </thead>
4208               <tbody>
4209                 <row>
4210                   <entry>0</entry>
4211                   <entry>UINT32</entry>
4212                   <entry>Return value</entry>
4213                 </row>
4214               </tbody>
4215             </tgroup>
4216           </informaltable>
4217         </para>
4218         <para>
4219           This method call should be sent to
4220           <literal>org.freedesktop.DBus</literal> and asks the message bus to
4221           assign the given name to the method caller. Each name maintains a
4222           queue of possible owners, where the head of the queue is the primary
4223           or current owner of the name. Each potential owner in the queue
4224           maintains the DBUS_NAME_FLAG_ALLOW_REPLACEMENT and
4225           DBUS_NAME_FLAG_DO_NOT_QUEUE settings from its latest RequestName
4226           call.  When RequestName is invoked the following occurs:
4227           <itemizedlist>
4228             <listitem>
4229               <para>
4230                 If the method caller is currently the primary owner of the name,
4231                 the DBUS_NAME_FLAG_ALLOW_REPLACEMENT and DBUS_NAME_FLAG_DO_NOT_QUEUE
4232                 values are updated with the values from the new RequestName call,
4233                 and nothing further happens.
4234               </para>
4235             </listitem>
4236
4237             <listitem>
4238               <para>
4239                 If the current primary owner (head of the queue) has
4240                 DBUS_NAME_FLAG_ALLOW_REPLACEMENT set, and the RequestName
4241                 invocation has the DBUS_NAME_FLAG_REPLACE_EXISTING flag, then
4242                 the caller of RequestName replaces the current primary owner at
4243                 the head of the queue and the current primary owner moves to the
4244                 second position in the queue. If the caller of RequestName was
4245                 in the queue previously its flags are updated with the values from
4246                 the new RequestName in addition to moving it to the head of the queue.
4247               </para>
4248             </listitem>
4249
4250             <listitem>
4251               <para>
4252                 If replacement is not possible, and the method caller is
4253                 currently in the queue but not the primary owner, its flags are
4254                 updated with the values from the new RequestName call.
4255               </para>
4256             </listitem>
4257
4258             <listitem>
4259               <para>
4260                 If replacement is not possible, and the method caller is
4261                 currently not in the queue, the method caller is appended to the
4262                 queue.
4263               </para>
4264             </listitem>
4265
4266             <listitem>
4267               <para>
4268                 If any connection in the queue has DBUS_NAME_FLAG_DO_NOT_QUEUE
4269                 set and is not the primary owner, it is removed from the
4270                 queue. This can apply to the previous primary owner (if it
4271                 was replaced) or the method caller (if it updated the
4272                 DBUS_NAME_FLAG_DO_NOT_QUEUE flag while still stuck in the
4273                 queue, or if it was just added to the queue with that flag set).
4274               </para>
4275             </listitem>
4276           </itemizedlist>
4277         </para>
4278         <para>
4279           Note that DBUS_NAME_FLAG_REPLACE_EXISTING results in "jumping the
4280           queue," even if another application already in the queue had specified
4281           DBUS_NAME_FLAG_REPLACE_EXISTING.  This comes up if a primary owner
4282           that does not allow replacement goes away, and the next primary owner
4283           does allow replacement. In this case, queued items that specified
4284           DBUS_NAME_FLAG_REPLACE_EXISTING <emphasis>do not</emphasis>
4285           automatically replace the new primary owner. In other words,
4286           DBUS_NAME_FLAG_REPLACE_EXISTING is not saved, it is only used at the
4287           time RequestName is called. This is deliberate to avoid an infinite loop
4288           anytime two applications are both DBUS_NAME_FLAG_ALLOW_REPLACEMENT
4289           and DBUS_NAME_FLAG_REPLACE_EXISTING.
4290         </para>
4291         <para>
4292           The flags argument contains any of the following values logically ORed
4293           together:
4294
4295           <informaltable>
4296             <tgroup cols="3">
4297               <thead>
4298                 <row>
4299                   <entry>Conventional Name</entry>
4300                   <entry>Value</entry>
4301                   <entry>Description</entry>
4302                 </row>
4303               </thead>
4304               <tbody>
4305                 <row>
4306                   <entry>DBUS_NAME_FLAG_ALLOW_REPLACEMENT</entry>
4307                   <entry>0x1</entry>
4308                   <entry>
4309
4310                     If an application A specifies this flag and succeeds in
4311                     becoming the owner of the name, and another application B
4312                     later calls RequestName with the
4313                     DBUS_NAME_FLAG_REPLACE_EXISTING flag, then application A
4314                     will lose ownership and receive a
4315                     <literal>org.freedesktop.DBus.NameLost</literal> signal, and
4316                     application B will become the new owner. If DBUS_NAME_FLAG_ALLOW_REPLACEMENT
4317                     is not specified by application A, or DBUS_NAME_FLAG_REPLACE_EXISTING
4318                     is not specified by application B, then application B will not replace
4319                     application A as the owner.
4320
4321                   </entry>
4322                 </row>
4323                 <row>
4324                   <entry>DBUS_NAME_FLAG_REPLACE_EXISTING</entry>
4325                   <entry>0x2</entry>
4326                   <entry>
4327
4328                     Try to replace the current owner if there is one. If this
4329                     flag is not set the application will only become the owner of
4330                     the name if there is no current owner. If this flag is set,
4331                     the application will replace the current owner if
4332                     the current owner specified DBUS_NAME_FLAG_ALLOW_REPLACEMENT.
4333
4334                   </entry>
4335                 </row>
4336                 <row>
4337                   <entry>DBUS_NAME_FLAG_DO_NOT_QUEUE</entry>
4338                   <entry>0x4</entry>
4339                   <entry>
4340
4341                     Without this flag, if an application requests a name that is
4342                     already owned, the application will be placed in a queue to
4343                     own the name when the current owner gives it up. If this
4344                     flag is given, the application will not be placed in the
4345                     queue, the request for the name will simply fail.  This flag
4346                     also affects behavior when an application is replaced as
4347                     name owner; by default the application moves back into the
4348                     waiting queue, unless this flag was provided when the application
4349                     became the name owner.
4350
4351                   </entry>
4352                 </row>
4353               </tbody>
4354             </tgroup>
4355           </informaltable>
4356
4357           The return code can be one of the following values:
4358
4359           <informaltable>
4360             <tgroup cols="3">
4361               <thead>
4362                 <row>
4363                   <entry>Conventional Name</entry>
4364                   <entry>Value</entry>
4365                   <entry>Description</entry>
4366                 </row>
4367               </thead>
4368               <tbody>
4369                 <row>
4370                   <entry>DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER</entry>
4371                   <entry>1</entry> <entry>The caller is now the primary owner of
4372                   the name, replacing any previous owner. Either the name had no
4373                   owner before, or the caller specified
4374                   DBUS_NAME_FLAG_REPLACE_EXISTING and the current owner specified
4375                   DBUS_NAME_FLAG_ALLOW_REPLACEMENT.</entry>
4376                 </row>
4377                 <row>
4378                   <entry>DBUS_REQUEST_NAME_REPLY_IN_QUEUE</entry>
4379                   <entry>2</entry>
4380
4381                   <entry>The name already had an owner,
4382                     DBUS_NAME_FLAG_DO_NOT_QUEUE was not specified, and either
4383                     the current owner did not specify
4384                     DBUS_NAME_FLAG_ALLOW_REPLACEMENT or the requesting
4385                     application did not specify DBUS_NAME_FLAG_REPLACE_EXISTING.
4386                     </entry>
4387                 </row>
4388                 <row>
4389                   <entry>DBUS_REQUEST_NAME_REPLY_EXISTS</entry> <entry>3</entry>
4390                   <entry>The name already has an owner,
4391                   DBUS_NAME_FLAG_DO_NOT_QUEUE was specified, and either
4392                   DBUS_NAME_FLAG_ALLOW_REPLACEMENT was not specified by the
4393                   current owner, or DBUS_NAME_FLAG_REPLACE_EXISTING was not
4394                   specified by the requesting application.</entry>
4395                 </row>
4396                 <row>
4397                   <entry>DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER</entry>
4398                   <entry>4</entry>
4399                   <entry>The application trying to request ownership of a name is already the owner of it.</entry>
4400                 </row>
4401               </tbody>
4402             </tgroup>
4403           </informaltable>
4404         </para>
4405        </sect3>
4406
4407        <sect3 id="bus-messages-release-name">
4408         <title><literal>org.freedesktop.DBus.ReleaseName</literal></title>
4409         <para>
4410           As a method:
4411           <programlisting>
4412             UINT32 ReleaseName (in STRING name)
4413           </programlisting>
4414           Message arguments:
4415           <informaltable>
4416             <tgroup cols="3">
4417               <thead>
4418                 <row>
4419                   <entry>Argument</entry>
4420                   <entry>Type</entry>
4421                   <entry>Description</entry>
4422                 </row>
4423               </thead>
4424               <tbody>
4425                 <row>
4426                   <entry>0</entry>
4427                   <entry>STRING</entry>
4428                   <entry>Name to release</entry>
4429                 </row>
4430               </tbody>
4431             </tgroup>
4432           </informaltable>
4433           Reply arguments:
4434           <informaltable>
4435             <tgroup cols="3">
4436               <thead>
4437                 <row>
4438                   <entry>Argument</entry>
4439                   <entry>Type</entry>
4440                   <entry>Description</entry>
4441                 </row>
4442               </thead>
4443               <tbody>
4444                 <row>
4445                   <entry>0</entry>
4446                   <entry>UINT32</entry>
4447                   <entry>Return value</entry>
4448                 </row>
4449               </tbody>
4450             </tgroup>
4451           </informaltable>
4452         </para>
4453         <para>
4454           This method call should be sent to
4455           <literal>org.freedesktop.DBus</literal> and asks the message bus to
4456           release the method caller's claim to the given name. If the caller is
4457           the primary owner, a new primary owner will be selected from the
4458           queue if any other owners are waiting. If the caller is waiting in
4459           the queue for the name, the caller will removed from the queue and
4460           will not be made an owner of the name if it later becomes available.
4461           If there are no other owners in the queue for the name, it will be
4462           removed from the bus entirely.
4463
4464           The return code can be one of the following values:
4465
4466           <informaltable>
4467             <tgroup cols="3">
4468               <thead>
4469                 <row>
4470                   <entry>Conventional Name</entry>
4471                   <entry>Value</entry>
4472                   <entry>Description</entry>
4473                 </row>
4474               </thead>
4475               <tbody>
4476                 <row>
4477                   <entry>DBUS_RELEASE_NAME_REPLY_RELEASED</entry>
4478                   <entry>1</entry> <entry>The caller has released his claim on
4479                   the given name. Either the caller was the primary owner of
4480                   the name, and the name is now unused or taken by somebody
4481                   waiting in the queue for the name, or the caller was waiting
4482                   in the queue for the name and has now been removed from the
4483                   queue.</entry>
4484                 </row>
4485                 <row>
4486                   <entry>DBUS_RELEASE_NAME_REPLY_NON_EXISTENT</entry>
4487                   <entry>2</entry>
4488                   <entry>The given name does not exist on this bus.</entry>
4489                 </row>
4490                 <row>
4491                   <entry>DBUS_RELEASE_NAME_REPLY_NOT_OWNER</entry>
4492                   <entry>3</entry>
4493                   <entry>The caller was not the primary owner of this name,
4494                   and was also not waiting in the queue to own this name.</entry>
4495                 </row>
4496               </tbody>
4497             </tgroup>
4498           </informaltable>
4499         </para>
4500        </sect3>
4501
4502        <sect3 id="bus-messages-list-queued-owners">
4503         <title><literal>org.freedesktop.DBus.ListQueuedOwners</literal></title>
4504         <para>
4505           As a method:
4506           <programlisting>
4507             ARRAY of STRING ListQueuedOwners (in STRING name)
4508           </programlisting>
4509           Message arguments:
4510           <informaltable>
4511             <tgroup cols="3">
4512               <thead>
4513                 <row>
4514                   <entry>Argument</entry>
4515                   <entry>Type</entry>
4516                   <entry>Description</entry>
4517                 </row>
4518               </thead>
4519               <tbody>
4520                 <row>
4521                   <entry>0</entry>
4522                   <entry>STRING</entry>
4523                   <entry>The well-known bus name to query, such as
4524                     <literal>com.example.cappuccino</literal></entry>
4525                 </row>
4526               </tbody>
4527             </tgroup>
4528           </informaltable>
4529           Reply arguments:
4530           <informaltable>
4531             <tgroup cols="3">
4532               <thead>
4533                 <row>
4534                   <entry>Argument</entry>
4535                   <entry>Type</entry>
4536                   <entry>Description</entry>
4537                 </row>
4538               </thead>
4539               <tbody>
4540                 <row>
4541                   <entry>0</entry>
4542                   <entry>ARRAY of STRING</entry>
4543                   <entry>The unique bus names of connections currently queued
4544                     for the name</entry>
4545                 </row>
4546               </tbody>
4547             </tgroup>
4548           </informaltable>
4549         </para>
4550         <para>
4551           This method call should be sent to
4552           <literal>org.freedesktop.DBus</literal> and lists the connections
4553           currently queued for a bus name (see
4554           <xref linkend="term-queued-owner"/>).
4555         </para>
4556        </sect3>
4557     </sect2>
4558
4559     <sect2 id="message-bus-routing">
4560       <title>Message Bus Message Routing</title>
4561
4562       <para>
4563         Messages may have a <literal>DESTINATION</literal> field (see <xref
4564           linkend="message-protocol-header-fields"/>), resulting in a
4565         <firstterm>unicast message</firstterm>.  If the
4566         <literal>DESTINATION</literal> field is present, it specifies a message
4567         recipient by name. Method calls and replies normally specify this field.
4568         The message bus must send messages (of any type) with the
4569         <literal>DESTINATION</literal> field set to the specified recipient,
4570         regardless of whether the recipient has set up a match rule matching
4571         the message.
4572       </para>
4573
4574       <para>
4575         When the message bus receives a signal, if the
4576         <literal>DESTINATION</literal> field is absent, it is considered to
4577         be a <firstterm>broadcast signal</firstterm>, and is sent to all
4578         applications with <firstterm>message matching rules</firstterm> that
4579         match the message. Most signal messages are broadcasts, and
4580         no other message types currently defined in this specification
4581         may be broadcast.
4582       </para>
4583
4584       <para>
4585         Unicast signal messages (those with a <literal>DESTINATION</literal>
4586         field) are not commonly used, but they are treated like any unicast
4587         message: they are delivered to the specified receipient,
4588         regardless of its match rules.  One use for unicast signals is to
4589         avoid a race condition in which a signal is emitted before the intended
4590         recipient can call <xref linkend="bus-messages-add-match"/> to
4591         receive that signal: if the signal is sent directly to that recipient
4592         using a unicast message, it does not need to add a match rule at all,
4593         and there is no race condition.  Another use for unicast signals,
4594         on message buses whose security policy prevents eavesdropping, is to
4595         send sensitive information which should only be visible to one
4596         recipient.
4597       </para>
4598
4599       <para>
4600         When the message bus receives a method call, if the
4601         <literal>DESTINATION</literal> field is absent, the call is taken to be
4602         a standard one-to-one message and interpreted by the message bus
4603         itself. For example, sending an
4604         <literal>org.freedesktop.DBus.Peer.Ping</literal> message with no
4605         <literal>DESTINATION</literal> will cause the message bus itself to
4606         reply to the ping immediately; the message bus will not make this
4607         message visible to other applications.
4608       </para>
4609
4610       <para>
4611         Continuing the <literal>org.freedesktop.DBus.Peer.Ping</literal> example, if
4612         the ping message were sent with a <literal>DESTINATION</literal> name of
4613         <literal>com.yoyodyne.Screensaver</literal>, then the ping would be
4614         forwarded, and the Yoyodyne Corporation screensaver application would be
4615         expected to reply to the ping.
4616       </para>
4617
4618       <para>
4619         Message bus implementations may impose a security policy which
4620         prevents certain messages from being sent or received.
4621         When a method call message cannot be sent or received due to a security
4622         policy, the message bus should send an error reply, unless the
4623         original message had the <literal>NO_REPLY</literal> flag.
4624       </para>
4625
4626       <sect3 id="message-bus-routing-eavesdropping">
4627         <title>Eavesdropping</title>
4628         <para>
4629           Receiving a unicast message whose <literal>DESTINATION</literal>
4630           indicates a different recipient is called
4631           <firstterm>eavesdropping</firstterm>. On a message bus which acts as
4632           a security boundary (like the standard system bus), the security
4633           policy should usually prevent eavesdropping, since unicast messages
4634           are normally kept private and may contain security-sensitive
4635           information.
4636         </para>
4637
4638         <para>
4639           Eavesdropping is mainly useful for debugging tools, such as
4640           the <literal>dbus-monitor</literal> tool in the reference
4641           implementation of D-Bus. Tools which eavesdrop on the message bus
4642           should be careful to avoid sending a reply or error in response to
4643           messages intended for a different client.
4644         </para>
4645
4646         <para>
4647           Clients may attempt to eavesdrop by adding match rules
4648           (see <xref linkend="message-bus-routing-match-rules"/>) containing
4649           the <literal>eavesdrop='true'</literal> match. If the message bus'
4650           security policy does not allow eavesdropping, the match rule can
4651           still be added, but will not have any practical effect. For
4652           compatibility with older message bus implementations, if adding such
4653           a match rule results in an error reply, the client may fall back to
4654           adding the same rule with the <literal>eavesdrop</literal> match
4655           omitted.
4656         </para>
4657
4658         <para>
4659           Eavesdropping interacts poorly with buses with non-trivial
4660           access control restrictions. The
4661           <xref linkend="bus-messages-become-monitor"/> method provides
4662           an alternative way to monitor buses.
4663         </para>
4664       </sect3>
4665
4666       <sect3 id="message-bus-routing-match-rules">
4667         <title>Match Rules</title>
4668         <para>
4669           An important part of the message bus routing protocol is match
4670           rules. Match rules describe the messages that should be sent to a
4671           client, based on the contents of the message.  Broadcast signals
4672           are only sent to clients which have a suitable match rule: this
4673           avoids waking up client processes to deal with signals that are
4674           not relevant to that client.
4675         </para>
4676         <para>
4677           Messages that list a client as their <literal>DESTINATION</literal>
4678           do not need to match the client's match rules, and are sent to that
4679           client regardless. As a result, match rules are mainly used to
4680           receive a subset of broadcast signals.
4681         </para>
4682         <para>
4683           Match rules can also be used for eavesdropping
4684           (see <xref linkend="message-bus-routing-eavesdropping"/>),
4685           if the security policy of the message bus allows it.
4686         </para>
4687         <para>
4688           Match rules are added using the AddMatch bus method
4689           (see <xref linkend="bus-messages-add-match"/>).  Rules are
4690           specified as a string of comma separated key/value pairs.
4691           Excluding a key from the rule indicates a wildcard match.
4692           For instance excluding the the member from a match rule but
4693           adding a sender would let all messages from that sender through.
4694           An example of a complete rule would be
4695           "type='signal',sender='org.freedesktop.DBus',interface='org.freedesktop.DBus',member='Foo',path='/bar/foo',destination=':452345.34',arg2='bar'"
4696         </para>
4697         <para>
4698           Within single quotes (ASCII apostrophe, U+0027), a backslash
4699           (U+005C) represents itself, and an apostrophe ends the quoted
4700           section. Outside single quotes, \' (backslash, apostrophe)
4701           represents an apostrophe, and any backslash not followed by
4702           an apostrophe represents itself. For instance, the match rules
4703           <literal>arg0=''\''',arg1='\',arg2=',',arg3='\\'</literal> and
4704           <literal>arg0=\',arg1=\,arg2=',',arg3=\\</literal>
4705           both match messages where the arguments are a 1-character string
4706           containing an apostrophe, a 1-character string containing a
4707           backslash, a 1-character string containing a comma, and a
4708           2-character string containing two backslashes<footnote>
4709             <para>
4710               This idiosyncratic quoting style is based on the rules for
4711               escaping items to appear inside single-quoted strings
4712               in POSIX <literal>/bin/sh</literal>, but please
4713               note that backslashes that are not inside single quotes have
4714               different behaviour. This syntax does not offer any way to
4715               represent an apostrophe inside single quotes (it is necessary
4716               to leave the single-quoted section, backslash-escape the
4717               apostrophe and re-enter single quotes), or to represent a
4718               comma outside single quotes (it is necessary to wrap it in
4719               a single-quoted section).
4720             </para>
4721           </footnote>.
4722         </para>
4723         <para>
4724           The following table describes the keys that can be used to create
4725           a match rule.
4726           <informaltable>
4727             <tgroup cols="3">
4728               <thead>
4729                 <row>
4730                   <entry>Key</entry>
4731                   <entry>Possible Values</entry>
4732                   <entry>Description</entry>
4733                 </row>
4734               </thead>
4735               <tbody>
4736                 <row>
4737                   <entry><literal>type</literal></entry>
4738                   <entry>'signal', 'method_call', 'method_return', 'error'</entry>
4739                   <entry>Match on the message type.  An example of a type match is type='signal'</entry>
4740                 </row>
4741                 <row>
4742                   <entry><literal>sender</literal></entry>
4743                   <entry>A bus or unique name (see <xref linkend="term-bus-name"/>
4744                   and <xref linkend="term-unique-name"/> respectively)
4745                   </entry>
4746                   <entry>Match messages sent by a particular sender.  An example of a sender match
4747                   is sender='org.freedesktop.Hal'</entry>
4748                 </row>
4749                 <row>
4750                   <entry><literal>interface</literal></entry>
4751                   <entry>An interface name (see <xref linkend="message-protocol-names-interface"/>)</entry>
4752                   <entry>Match messages sent over or to a particular interface.  An example of an
4753                   interface match is interface='org.freedesktop.Hal.Manager'.
4754                   If a message omits the interface header, it must not match any rule
4755                   that specifies this key.</entry>
4756                 </row>
4757                 <row>
4758                   <entry><literal>member</literal></entry>
4759                   <entry>Any valid method or signal name</entry>
4760                   <entry>Matches messages which have the give method or signal name. An example of
4761                   a member match is member='NameOwnerChanged'</entry>
4762                 </row>
4763                 <row>
4764                   <entry><literal>path</literal></entry>
4765                   <entry>An object path (see <xref linkend="message-protocol-marshaling-object-path"/>)</entry>
4766                   <entry>Matches messages which are sent from or to the given object. An example of a
4767                   path match is path='/org/freedesktop/Hal/Manager'</entry>
4768                 </row>
4769                 <row>
4770                   <entry><literal>path_namespace</literal></entry>
4771                   <entry>An object path</entry>
4772                   <entry>
4773                     <para>
4774                       Matches messages which are sent from or to an
4775                       object for which the object path is either the
4776                       given value, or that value followed by one or
4777                       more path components.
4778                     </para>
4779
4780                     <para>
4781                       For example,
4782                       <literal>path_namespace='/com/example/foo'</literal>
4783                       would match signals sent by
4784                       <literal>/com/example/foo</literal>
4785                       or by
4786                       <literal>/com/example/foo/bar</literal>,
4787                       but not by
4788                       <literal>/com/example/foobar</literal>.
4789                     </para>
4790
4791                     <para>
4792                       Using both <literal>path</literal> and
4793                       <literal>path_namespace</literal> in the same match
4794                       rule is not allowed.
4795                     </para>
4796
4797                     <para>
4798                       <emphasis>
4799                         This match key was added in version 0.16 of the
4800                         D-Bus specification and implemented by the bus
4801                         daemon in dbus 1.5.0 and later.
4802                       </emphasis>
4803                     </para>
4804                 </entry>
4805                 </row>
4806                 <row>
4807                   <entry><literal>destination</literal></entry>
4808                   <entry>A unique name (see <xref linkend="term-unique-name"/>)</entry>
4809                   <entry>Matches messages which are being sent to the given unique name. An
4810                   example of a destination match is destination=':1.0'</entry>
4811                 </row>
4812                 <row>
4813                   <entry><literal>arg[0, 1, 2, 3, ...]</literal></entry>
4814                   <entry>Any string</entry>
4815                   <entry>Arg matches are special and are used for further restricting the
4816                   match based on the arguments in the body of a message. Only arguments of type
4817                   STRING can be matched in this way. An example of an argument match
4818                   would be arg3='Foo'. Only argument indexes from 0 to 63 should be
4819                   accepted.</entry>
4820                 </row>
4821                 <row>
4822                   <entry><literal>arg[0, 1, 2, 3, ...]path</literal></entry>
4823                   <entry>Any string</entry>
4824                   <entry>
4825                     <para>Argument path matches provide a specialised form of wildcard matching for
4826                       path-like namespaces. They can match arguments whose type is either STRING or
4827                       OBJECT_PATH. As with normal argument matches,
4828                       if the argument is exactly equal to the string given in the match
4829                       rule then the rule is satisfied. Additionally, there is also a
4830                       match when either the string given in the match rule or the
4831                       appropriate message argument ends with '/' and is a prefix of the
4832                       other. An example argument path match is arg0path='/aa/bb/'. This
4833                       would match messages with first arguments of '/', '/aa/',
4834                       '/aa/bb/', '/aa/bb/cc/' and '/aa/bb/cc'. It would not match
4835                       messages with first arguments of '/aa/b', '/aa' or even '/aa/bb'.</para>
4836
4837                     <para>This is intended for monitoring “directories” in file system-like
4838                       hierarchies, as used in the <citetitle>dconf</citetitle> configuration
4839                       system. An application interested in all nodes in a particular hierarchy would
4840                       monitor <literal>arg0path='/ca/example/foo/'</literal>. Then the service could
4841                       emit a signal with zeroth argument <literal>"/ca/example/foo/bar"</literal> to
4842                       represent a modification to the “bar” property, or a signal with zeroth
4843                       argument <literal>"/ca/example/"</literal> to represent atomic modification of
4844                       many properties within that directory, and the interested application would be
4845                       notified in both cases.</para>
4846                     <para>
4847                       <emphasis>
4848                         This match key was added in version 0.12 of the
4849                         D-Bus specification, implemented for STRING
4850                         arguments by the bus daemon in dbus 1.2.0 and later,
4851                         and implemented for OBJECT_PATH arguments in dbus 1.5.0
4852                         and later.
4853                       </emphasis>
4854                     </para>
4855                   </entry>
4856                 </row>
4857                 <row>
4858                   <entry><literal>arg0namespace</literal></entry>
4859                   <entry>Like a bus name, except that the string is not
4860                     required to contain a '.' (period)</entry>
4861                   <entry>
4862                     <para>Match messages whose first argument is of type STRING, and is a bus name
4863                       or interface name within the specified namespace. This is primarily intended
4864                       for watching name owner changes for a group of related bus names, rather than
4865                       for a single name or all name changes.</para>
4866
4867                     <para>Because every valid interface name is also a valid
4868                       bus name, this can also be used for messages whose
4869                       first argument is an interface name.</para>
4870
4871                     <para>For example, the match rule
4872                       <literal>member='NameOwnerChanged',arg0namespace='com.example.backend'</literal>
4873                       matches name owner changes for bus names such as
4874                       <literal>com.example.backend.foo</literal>,
4875                       <literal>com.example.backend.foo.bar</literal>, and
4876                       <literal>com.example.backend</literal> itself.</para>
4877
4878                     <para>See also <xref linkend='bus-messages-name-owner-changed'/>.</para>
4879                     <para>
4880                       <emphasis>
4881                         This match key was added in version 0.16 of the
4882                         D-Bus specification and implemented by the bus
4883                         daemon in dbus 1.5.0 and later.
4884                       </emphasis>
4885                     </para>
4886                   </entry>
4887                 </row>
4888                 <row>
4889                   <entry><literal>eavesdrop</literal></entry>
4890                   <entry><literal>'true'</literal>, <literal>'false'</literal></entry>
4891                   <entry>Since D-Bus 1.5.6, match rules do not
4892                     match messages which have a <literal>DESTINATION</literal>
4893                     field unless the match rule specifically
4894                     requests this
4895                     (see <xref linkend="message-bus-routing-eavesdropping"/>)
4896                     by specifying <literal>eavesdrop='true'</literal>
4897                     in the match rule.  <literal>eavesdrop='false'</literal>
4898                     restores the default behaviour. Messages are
4899                     delivered to their <literal>DESTINATION</literal>
4900                     regardless of match rules, so this match does not
4901                     affect normal delivery of unicast messages.
4902                     If the message bus has a security policy which forbids
4903                     eavesdropping, this match may still be used without error,
4904                     but will not have any practical effect.
4905                     In older versions of D-Bus, this match was not allowed
4906                     in match rules, and all match rules behaved as if
4907                     <literal>eavesdrop='true'</literal> had been used.
4908                   </entry>
4909                 </row>
4910               </tbody>
4911             </tgroup>
4912           </informaltable>
4913         </para>
4914       </sect3>
4915     </sect2>
4916     <sect2 id="message-bus-starting-services">
4917       <title>Message Bus Starting Services</title>
4918       <para>
4919         The message bus can start applications on behalf of other applications.
4920         In CORBA terms, this would be called <firstterm>activation</firstterm>.
4921         An application that can be started in this way is called a
4922         <firstterm>service</firstterm>.
4923       </para>
4924       <para>
4925         With D-Bus, starting a service is normally done by name. That is,
4926         applications ask the message bus to start some program that will own a
4927         well-known name, such as <literal>com.example.TextEditor</literal>.
4928         This implies a contract documented along with the name
4929         <literal>com.example.TextEditor</literal> for which object
4930         the owner of that name will provide, and what interfaces those
4931         objects will have.
4932       </para>
4933       <para>
4934         To find an executable corresponding to a particular name, the bus daemon
4935         looks for <firstterm>service description files</firstterm>.  Service
4936         description files define a mapping from names to executables. Different
4937         kinds of message bus will look for these files in different places, see
4938         <xref linkend="message-bus-types"/>.
4939       </para>
4940       <para>
4941         Service description files have the ".service" file
4942         extension. The message bus will only load service description files
4943         ending with .service; all other files will be ignored.  The file format
4944         is similar to that of <ulink
4945         url="http://standards.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html">desktop
4946         entries</ulink>. All service description files must be in UTF-8
4947         encoding. To ensure that there will be no name collisions, service files
4948         must be namespaced using the same mechanism as messages and service
4949         names.
4950       </para>
4951
4952       <para>
4953         On the well-known system bus, the name of a service description file
4954         must be its well-known name plus <literal>.service</literal>,
4955         for instance
4956         <literal>com.example.ConfigurationDatabase.service</literal>.
4957       </para>
4958
4959       <para>
4960         On the well-known session bus, services should follow the same
4961         service description file naming convention as on the system bus,
4962         but for backwards compatibility they are not required to do so.
4963       </para>
4964
4965       <para>
4966         [FIXME the file format should be much better specified than "similar to
4967         .desktop entries" esp. since desktop entries are already
4968         badly-specified. ;-)]
4969         These sections from the specification apply to service files as well:
4970
4971         <itemizedlist>
4972           <listitem><para>General syntax</para></listitem>
4973           <listitem><para>Comment format</para></listitem>
4974         </itemizedlist>
4975
4976         Service description files must contain a
4977         <literal>D-BUS Service</literal> group with at least the keys
4978         <literal>Name</literal> (the well-known name of the service)
4979         and <literal>Exec</literal> (the command to be executed).
4980
4981         <figure>
4982           <title>Example service description file</title>
4983           <programlisting>
4984             # Sample service description file
4985             [D-BUS Service]
4986             Name=com.example.ConfigurationDatabase
4987             Exec=/usr/bin/sample-configd
4988           </programlisting>
4989         </figure>
4990       </para>
4991
4992       <para>
4993         Additionally, service description files for the well-known system
4994         bus on Unix must contain a <literal>User</literal> key, whose value
4995         is the name of a user account (e.g. <literal>root</literal>).
4996         The system service will be run as that user.
4997       </para>
4998
4999       <para>
5000         When an application asks to start a service by name, the bus daemon tries to
5001         find a service that will own that name. It then tries to spawn the
5002         executable associated with it. If this fails, it will report an
5003         error.
5004       </para>
5005
5006       <para>
5007         On the well-known system bus, it is not possible for two .service files
5008         in the same directory to offer the same service, because they are
5009         constrained to have names that match the service name.
5010       </para>
5011
5012       <para>
5013         On the well-known session bus, if two .service files in the same
5014         directory offer the same service name, the result is undefined.
5015         Distributors should avoid this situation, for instance by naming
5016         session services' .service files according to their service name.
5017       </para>
5018
5019       <para>
5020         If two .service files in different directories offer the same
5021         service name, the one in the higher-priority directory is used:
5022         for instance, on the system bus, .service files in
5023         /usr/local/share/dbus-1/system-services take precedence over those
5024         in /usr/share/dbus-1/system-services.
5025       </para>
5026       <para>
5027         The executable launched will have the environment variable
5028         <literal>DBUS_STARTER_ADDRESS</literal> set to the address of the
5029         message bus so it can connect and request the appropriate names.
5030       </para>
5031       <para>
5032         The executable being launched may want to know whether the message bus
5033         starting it is one of the well-known message buses (see <xref
5034         linkend="message-bus-types"/>). To facilitate this, the bus must also set
5035         the <literal>DBUS_STARTER_BUS_TYPE</literal> environment variable if it is one
5036         of the well-known buses. The currently-defined values for this variable
5037         are <literal>system</literal> for the systemwide message bus,
5038         and <literal>session</literal> for the per-login-session message
5039         bus. The new executable must still connect to the address given
5040         in <literal>DBUS_STARTER_ADDRESS</literal>, but may assume that the
5041         resulting connection is to the well-known bus.
5042       </para>
5043       <para>
5044         [FIXME there should be a timeout somewhere, either specified
5045         in the .service file, by the client, or just a global value
5046         and if the client being activated fails to connect within that
5047         timeout, an error should be sent back.]
5048       </para>
5049
5050       <sect3 id="message-bus-starting-services-scope">
5051         <title>Message Bus Service Scope</title>
5052         <para>
5053           The "scope" of a service is its "per-", such as per-session,
5054           per-machine, per-home-directory, or per-display. The reference
5055           implementation doesn't yet support starting services in a different
5056           scope from the message bus itself. So e.g. if you start a service
5057           on the session bus its scope is per-session.
5058         </para>
5059         <para>
5060           We could add an optional scope to a bus name. For example, for
5061           per-(display,session pair), we could have a unique ID for each display
5062           generated automatically at login and set on screen 0 by executing a
5063           special "set display ID" binary. The ID would be stored in a
5064           <literal>_DBUS_DISPLAY_ID</literal> property and would be a string of
5065           random bytes. This ID would then be used to scope names.
5066           Starting/locating a service could be done by ID-name pair rather than
5067           only by name.
5068         </para>
5069         <para>
5070           Contrast this with a per-display scope. To achieve that, we would
5071           want a single bus spanning all sessions using a given display.
5072           So we might set a <literal>_DBUS_DISPLAY_BUS_ADDRESS</literal>
5073           property on screen 0 of the display, pointing to this bus.
5074         </para>
5075       </sect3>
5076     </sect2>
5077
5078     <sect2 id="message-bus-types">
5079       <title>Well-known Message Bus Instances</title>
5080       <para>
5081         Two standard message bus instances are defined here, along with how
5082         to locate them and where their service files live.
5083       </para>
5084       <sect3 id="message-bus-types-login">
5085         <title>Login session message bus</title>
5086         <para>
5087           Each time a user logs in, a <firstterm>login session message
5088             bus</firstterm> may be started. All applications in the user's login
5089           session may interact with one another using this message bus.
5090         </para>
5091         <para>
5092           The address of the login session message bus is given
5093           in the <literal>DBUS_SESSION_BUS_ADDRESS</literal> environment
5094           variable. If that variable is not set, applications may
5095           also try to read the address from the X Window System root
5096           window property <literal>_DBUS_SESSION_BUS_ADDRESS</literal>.
5097           The root window property must have type <literal>STRING</literal>.
5098           The environment variable should have precedence over the
5099           root window property.
5100         </para>
5101         <para>The address of the login session message bus is given in the
5102         <literal>DBUS_SESSION_BUS_ADDRESS</literal> environment variable. If
5103         DBUS_SESSION_BUS_ADDRESS is not set, or if it's set to the string
5104         "autolaunch:", the system should use platform-specific methods of
5105         locating a running D-Bus session server, or starting one if a running
5106         instance cannot be found. Note that this mechanism is not recommended
5107         for attempting to determine if a daemon is running. It is inherently
5108         racy to attempt to make this determination, since the bus daemon may
5109         be started just before or just after the determination is made.
5110         Therefore, it is recommended that applications do not try to make this
5111         determination for their functionality purposes, and instead they
5112         should attempt to start the server.</para>
5113
5114         <sect4 id="message-bus-types-login-x-windows">
5115           <title>X Windowing System</title>
5116           <para>
5117             For the X Windowing System, the application must locate the
5118             window owner of the selection represented by the atom formed by
5119             concatenating:
5120             <itemizedlist>
5121               <listitem>
5122                 <para>the literal string "_DBUS_SESSION_BUS_SELECTION_"</para>
5123               </listitem>
5124
5125               <listitem>
5126                 <para>the current user's username</para>
5127               </listitem>
5128
5129               <listitem>
5130                 <para>the literal character '_' (underscore)</para>
5131               </listitem>
5132
5133               <listitem>
5134                 <para>the machine's ID</para>
5135               </listitem>
5136             </itemizedlist>
5137           </para>
5138
5139           <para>
5140             The following properties are defined for the window that owns
5141             this X selection:
5142             <informaltable frame="all">
5143               <tgroup cols="2">
5144                 <tbody>
5145                   <row>
5146                     <entry>
5147                       <para>Atom</para>
5148                     </entry>
5149
5150                     <entry>
5151                       <para>meaning</para>
5152                     </entry>
5153                   </row>
5154
5155                   <row>
5156                     <entry>
5157                       <para>_DBUS_SESSION_BUS_ADDRESS</para>
5158                     </entry>
5159
5160                     <entry>
5161                       <para>the actual address of the server socket</para>
5162                     </entry>
5163                   </row>
5164
5165                   <row>
5166                     <entry>
5167                       <para>_DBUS_SESSION_BUS_PID</para>
5168                     </entry>
5169
5170                     <entry>
5171                       <para>the PID of the server process</para>
5172                     </entry>
5173                   </row>
5174                 </tbody>
5175               </tgroup>
5176             </informaltable>
5177           </para>
5178
5179           <para>
5180             At least the _DBUS_SESSION_BUS_ADDRESS property MUST be
5181             present in this window.
5182           </para>
5183
5184           <para>
5185             If the X selection cannot be located or if reading the
5186             properties from the window fails, the implementation MUST conclude
5187             that there is no D-Bus server running and proceed to start a new
5188             server. (See below on concurrency issues)
5189           </para>
5190
5191           <para>
5192             Failure to connect to the D-Bus server address thus obtained
5193             MUST be treated as a fatal connection error and should be reported
5194             to the application.
5195           </para>
5196
5197           <para>
5198             As an alternative, an implementation MAY find the information
5199             in the following file located in the current user's home directory,
5200             in subdirectory .dbus/session-bus/:
5201             <itemizedlist>
5202               <listitem>
5203                 <para>the machine's ID</para>
5204               </listitem>
5205
5206               <listitem>
5207                 <para>the literal character '-' (dash)</para>
5208               </listitem>
5209
5210               <listitem>
5211                 <para>the X display without the screen number, with the
5212                 following prefixes removed, if present: ":", "localhost:"
5213                 ."localhost.localdomain:". That is, a display of
5214                 "localhost:10.0" produces just the number "10"</para>
5215               </listitem>
5216             </itemizedlist>
5217           </para>
5218
5219           <para>
5220             The contents of this file NAME=value assignment pairs and
5221             lines starting with # are comments (no comments are allowed
5222             otherwise). The following variable names are defined:
5223             <informaltable
5224               frame="all">
5225               <tgroup cols="2">
5226                 <tbody>
5227                   <row>
5228                     <entry>
5229                       <para>Variable</para>
5230                     </entry>
5231
5232                     <entry>
5233                       <para>meaning</para>
5234                     </entry>
5235                   </row>
5236
5237                   <row>
5238                     <entry>
5239                       <para>DBUS_SESSION_BUS_ADDRESS</para>
5240                     </entry>
5241
5242                     <entry>
5243                       <para>the actual address of the server socket</para>
5244                     </entry>
5245                   </row>
5246
5247                   <row>
5248                     <entry>
5249                       <para>DBUS_SESSION_BUS_PID</para>
5250                     </entry>
5251
5252                     <entry>
5253                       <para>the PID of the server process</para>
5254                     </entry>
5255                   </row>
5256
5257                   <row>
5258                     <entry>
5259                       <para>DBUS_SESSION_BUS_WINDOWID</para>
5260                     </entry>
5261
5262                     <entry>
5263                       <para>the window ID</para>
5264                     </entry>
5265                   </row>
5266                 </tbody>
5267               </tgroup>
5268             </informaltable>
5269           </para>
5270
5271           <para>
5272             At least the DBUS_SESSION_BUS_ADDRESS variable MUST be present
5273             in this file.
5274           </para>
5275
5276           <para>
5277             Failure to open this file MUST be interpreted as absence of a
5278             running server. Therefore, the implementation MUST proceed to
5279             attempting to launch a new bus server if the file cannot be
5280             opened.
5281           </para>
5282
5283           <para>
5284             However, success in opening this file MUST NOT lead to the
5285             conclusion that the server is running. Thus, a failure to connect to
5286             the bus address obtained by the alternative method MUST NOT be
5287             considered a fatal error. If the connection cannot be established,
5288             the implementation MUST proceed to check the X selection settings or
5289             to start the server on its own.
5290           </para>
5291
5292           <para>
5293             If the implementation concludes that the D-Bus server is not
5294             running it MUST attempt to start a new server and it MUST also
5295             ensure that the daemon started as an effect of the "autolaunch"
5296             mechanism provides the lookup mechanisms described above, so
5297             subsequent calls can locate the newly started server. The
5298             implementation MUST also ensure that if two or more concurrent
5299             initiations happen, only one server remains running and all other
5300             initiations are able to obtain the address of this server and
5301             connect to it. In other words, the implementation MUST ensure that
5302             the X selection is not present when it attempts to set it, without
5303             allowing another process to set the selection between the
5304             verification and the setting (e.g., by using XGrabServer /
5305             XungrabServer).
5306           </para>
5307         </sect4>
5308         <sect4>
5309           <title></title>
5310           <para>
5311             On Unix systems, the session bus should search for .service files
5312             in <literal>$XDG_DATA_DIRS/dbus-1/services</literal> as defined
5313             by the
5314             <ulink url="http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html">XDG Base Directory Specification</ulink>.
5315             Implementations may also search additional locations, which
5316             should be searched with lower priority than anything in
5317             XDG_DATA_HOME, XDG_DATA_DIRS or their respective defaults;
5318             for example, the reference implementation also
5319             looks in <literal>${datadir}/dbus-1/services</literal> as
5320             set at compile time.
5321           </para>
5322           <para>
5323             As described in the XDG Base Directory Specification, software
5324             packages should install their session .service files to their
5325             configured <literal>${datadir}/dbus-1/services</literal>,
5326             where <literal>${datadir}</literal> is as defined by the GNU
5327             coding standards. System administrators or users can arrange
5328             for these service files to be read by setting XDG_DATA_DIRS or by
5329             symlinking them into the default locations.
5330           </para>
5331         </sect4>
5332       </sect3>
5333       <sect3 id="message-bus-types-system">
5334         <title>System message bus</title>
5335         <para>
5336           A computer may have a <firstterm>system message bus</firstterm>,
5337           accessible to all applications on the system. This message bus may be
5338           used to broadcast system events, such as adding new hardware devices,
5339           changes in the printer queue, and so forth.
5340         </para>
5341         <para>
5342           The address of the system message bus is given
5343           in the <literal>DBUS_SYSTEM_BUS_ADDRESS</literal> environment
5344           variable. If that variable is not set, applications should try
5345           to connect to the well-known address
5346           <literal>unix:path=/var/run/dbus/system_bus_socket</literal>.
5347           <footnote>
5348             <para>
5349               The D-Bus reference implementation actually honors the
5350               <literal>$(localstatedir)</literal> configure option
5351               for this address, on both client and server side.
5352             </para>
5353           </footnote>
5354         </para>
5355         <para>
5356           On Unix systems, the system bus should default to searching
5357           for .service files in
5358           <literal>/usr/local/share/dbus-1/system-services</literal>,
5359           <literal>/usr/share/dbus-1/system-services</literal> and
5360           <literal>/lib/dbus-1/system-services</literal>, with that order
5361           of precedence. It may also search other implementation-specific
5362           locations, but should not vary these locations based on environment
5363           variables.
5364           <footnote>
5365             <para>
5366               The system bus is security-sensitive and is typically executed
5367               by an init system with a clean environment. Its launch helper
5368               process is particularly security-sensitive, and specifically
5369               clears its own environment.
5370             </para>
5371           </footnote>
5372         </para>
5373         <para>
5374           Software packages should install their system .service
5375           files to their configured
5376           <literal>${datadir}/dbus-1/system-services</literal>,
5377           where <literal>${datadir}</literal> is as defined by the GNU
5378           coding standards. System administrators can arrange
5379           for these service files to be read by editing the system bus'
5380           configuration file or by symlinking them into the default
5381           locations.
5382         </para>
5383       </sect3>
5384     </sect2>
5385
5386     <sect2 id="message-bus-messages">
5387       <title>Message Bus Messages</title>
5388       <para>
5389         The special message bus name <literal>org.freedesktop.DBus</literal>
5390         responds to a number of additional messages.
5391       </para>
5392
5393       <sect3 id="bus-messages-hello">
5394         <title><literal>org.freedesktop.DBus.Hello</literal></title>
5395         <para>
5396           As a method:
5397           <programlisting>
5398             STRING Hello ()
5399           </programlisting>
5400           Reply arguments:
5401           <informaltable>
5402             <tgroup cols="3">
5403               <thead>
5404                 <row>
5405                   <entry>Argument</entry>
5406                   <entry>Type</entry>
5407                   <entry>Description</entry>
5408                 </row>
5409               </thead>
5410               <tbody>
5411                 <row>
5412                   <entry>0</entry>
5413                   <entry>STRING</entry>
5414                   <entry>Unique name assigned to the connection</entry>
5415                 </row>
5416               </tbody>
5417             </tgroup>
5418           </informaltable>
5419         </para>
5420         <para>
5421           Before an application is able to send messages to other applications
5422           it must send the <literal>org.freedesktop.DBus.Hello</literal> message
5423           to the message bus to obtain a unique name. If an application without
5424           a unique name tries to send a message to another application, or a
5425           message to the message bus itself that isn't the
5426           <literal>org.freedesktop.DBus.Hello</literal> message, it will be
5427           disconnected from the bus.
5428         </para>
5429         <para>
5430           There is no corresponding "disconnect" request; if a client wishes to
5431           disconnect from the bus, it simply closes the socket (or other
5432           communication channel).
5433         </para>
5434       </sect3>
5435       <sect3 id="bus-messages-list-names">
5436         <title><literal>org.freedesktop.DBus.ListNames</literal></title>
5437         <para>
5438           As a method:
5439           <programlisting>
5440             ARRAY of STRING ListNames ()
5441           </programlisting>
5442           Reply arguments:
5443           <informaltable>
5444             <tgroup cols="3">
5445               <thead>
5446                 <row>
5447                   <entry>Argument</entry>
5448                   <entry>Type</entry>
5449                   <entry>Description</entry>
5450                 </row>
5451               </thead>
5452               <tbody>
5453                 <row>
5454                   <entry>0</entry>
5455                   <entry>ARRAY of STRING</entry>
5456                   <entry>Array of strings where each string is a bus name</entry>
5457                 </row>
5458               </tbody>
5459             </tgroup>
5460           </informaltable>
5461         </para>
5462         <para>
5463           Returns a list of all currently-owned names on the bus.
5464         </para>
5465       </sect3>
5466       <sect3 id="bus-messages-list-activatable-names">
5467         <title><literal>org.freedesktop.DBus.ListActivatableNames</literal></title>
5468         <para>
5469           As a method:
5470           <programlisting>
5471             ARRAY of STRING ListActivatableNames ()
5472           </programlisting>
5473           Reply arguments:
5474           <informaltable>
5475             <tgroup cols="3">
5476               <thead>
5477                 <row>
5478                   <entry>Argument</entry>
5479                   <entry>Type</entry>
5480                   <entry>Description</entry>
5481                 </row>
5482               </thead>
5483               <tbody>
5484                 <row>
5485                   <entry>0</entry>
5486                   <entry>ARRAY of STRING</entry>
5487                   <entry>Array of strings where each string is a bus name</entry>
5488                 </row>
5489               </tbody>
5490             </tgroup>
5491           </informaltable>
5492         </para>
5493         <para>
5494           Returns a list of all names that can be activated on the bus.
5495         </para>
5496       </sect3>
5497       <sect3 id="bus-messages-name-exists">
5498         <title><literal>org.freedesktop.DBus.NameHasOwner</literal></title>
5499         <para>
5500           As a method:
5501           <programlisting>
5502             BOOLEAN NameHasOwner (in STRING name)
5503           </programlisting>
5504           Message arguments:
5505           <informaltable>
5506             <tgroup cols="3">
5507               <thead>
5508                 <row>
5509                   <entry>Argument</entry>
5510                   <entry>Type</entry>
5511                   <entry>Description</entry>
5512                 </row>
5513               </thead>
5514               <tbody>
5515                 <row>
5516                   <entry>0</entry>
5517                   <entry>STRING</entry>
5518                   <entry>Name to check</entry>
5519                 </row>
5520               </tbody>
5521             </tgroup>
5522           </informaltable>
5523           Reply arguments:
5524           <informaltable>
5525             <tgroup cols="3">
5526               <thead>
5527                 <row>
5528                   <entry>Argument</entry>
5529                   <entry>Type</entry>
5530                   <entry>Description</entry>
5531                 </row>
5532               </thead>
5533               <tbody>
5534                 <row>
5535                   <entry>0</entry>
5536                   <entry>BOOLEAN</entry>
5537                   <entry>Return value, true if the name exists</entry>
5538                 </row>
5539               </tbody>
5540             </tgroup>
5541           </informaltable>
5542         </para>
5543         <para>
5544           Checks if the specified name exists (currently has an owner).
5545         </para>
5546       </sect3>
5547
5548       <sect3 id="bus-messages-name-owner-changed">
5549         <title><literal>org.freedesktop.DBus.NameOwnerChanged</literal></title>
5550         <para>
5551           This is a signal:
5552           <programlisting>
5553             NameOwnerChanged (STRING name, STRING old_owner, STRING new_owner)
5554           </programlisting>
5555           Message arguments:
5556           <informaltable>
5557             <tgroup cols="3">
5558               <thead>
5559                 <row>
5560                   <entry>Argument</entry>
5561                   <entry>Type</entry>
5562                   <entry>Description</entry>
5563                 </row>
5564               </thead>
5565               <tbody>
5566                 <row>
5567                   <entry>0</entry>
5568                   <entry>STRING</entry>
5569                   <entry>Name with a new owner</entry>
5570                 </row>
5571                 <row>
5572                   <entry>1</entry>
5573                   <entry>STRING</entry>
5574                   <entry>Old owner or empty string if none</entry>
5575                 </row>
5576                 <row>
5577                   <entry>2</entry>
5578                   <entry>STRING</entry>
5579                   <entry>New owner or empty string if none</entry>
5580                 </row>
5581               </tbody>
5582             </tgroup>
5583           </informaltable>
5584         </para>
5585         <para>
5586           This signal indicates that the owner of a name has changed.
5587           It's also the signal to use to detect the appearance of
5588           new names on the bus.
5589         </para>
5590       </sect3>
5591       <sect3 id="bus-messages-name-lost">
5592         <title><literal>org.freedesktop.DBus.NameLost</literal></title>
5593         <para>
5594           This is a signal:
5595           <programlisting>
5596             NameLost (STRING name)
5597           </programlisting>
5598           Message arguments:
5599           <informaltable>
5600             <tgroup cols="3">
5601               <thead>
5602                 <row>
5603                   <entry>Argument</entry>
5604                   <entry>Type</entry>
5605                   <entry>Description</entry>
5606                 </row>
5607               </thead>
5608               <tbody>
5609                 <row>
5610                   <entry>0</entry>
5611                   <entry>STRING</entry>
5612                   <entry>Name which was lost</entry>
5613                 </row>
5614               </tbody>
5615             </tgroup>
5616           </informaltable>
5617         </para>
5618         <para>
5619           This signal is sent to a specific application when it loses
5620           ownership of a name.
5621         </para>
5622       </sect3>
5623
5624       <sect3 id="bus-messages-name-acquired">
5625         <title><literal>org.freedesktop.DBus.NameAcquired</literal></title>
5626         <para>
5627           This is a signal:
5628           <programlisting>
5629             NameAcquired (STRING name)
5630           </programlisting>
5631           Message arguments:
5632           <informaltable>
5633             <tgroup cols="3">
5634               <thead>
5635                 <row>
5636                   <entry>Argument</entry>
5637                   <entry>Type</entry>
5638                   <entry>Description</entry>
5639                 </row>
5640               </thead>
5641               <tbody>
5642                 <row>
5643                   <entry>0</entry>
5644                   <entry>STRING</entry>
5645                   <entry>Name which was acquired</entry>
5646                 </row>
5647               </tbody>
5648             </tgroup>
5649           </informaltable>
5650         </para>
5651         <para>
5652           This signal is sent to a specific application when it gains
5653           ownership of a name.
5654         </para>
5655       </sect3>
5656
5657       <sect3 id="bus-messages-start-service-by-name">
5658         <title><literal>org.freedesktop.DBus.StartServiceByName</literal></title>
5659         <para>
5660           As a method:
5661           <programlisting>
5662             UINT32 StartServiceByName (in STRING name, in UINT32 flags)
5663           </programlisting>
5664           Message arguments:
5665           <informaltable>
5666             <tgroup cols="3">
5667               <thead>
5668                 <row>
5669                   <entry>Argument</entry>
5670                   <entry>Type</entry>
5671                   <entry>Description</entry>
5672                 </row>
5673               </thead>
5674               <tbody>
5675                 <row>
5676                   <entry>0</entry>
5677                   <entry>STRING</entry>
5678                   <entry>Name of the service to start</entry>
5679                 </row>
5680                 <row>
5681                   <entry>1</entry>
5682                   <entry>UINT32</entry>
5683                   <entry>Flags (currently not used)</entry>
5684                 </row>
5685               </tbody>
5686             </tgroup>
5687           </informaltable>
5688         Reply arguments:
5689         <informaltable>
5690           <tgroup cols="3">
5691             <thead>
5692               <row>
5693                 <entry>Argument</entry>
5694                 <entry>Type</entry>
5695                 <entry>Description</entry>
5696               </row>
5697             </thead>
5698             <tbody>
5699               <row>
5700                 <entry>0</entry>
5701                 <entry>UINT32</entry>
5702                 <entry>Return value</entry>
5703               </row>
5704             </tbody>
5705           </tgroup>
5706         </informaltable>
5707           Tries to launch the executable associated with a name. For more information, see <xref linkend="message-bus-starting-services"/>.
5708
5709         </para>
5710         <para>
5711           The return value can be one of the following values:
5712           <informaltable>
5713             <tgroup cols="3">
5714               <thead>
5715                 <row>
5716                   <entry>Identifier</entry>
5717                   <entry>Value</entry>
5718                   <entry>Description</entry>
5719                 </row>
5720               </thead>
5721               <tbody>
5722                 <row>
5723                   <entry>DBUS_START_REPLY_SUCCESS</entry>
5724                   <entry>1</entry>
5725                   <entry>The service was successfully started.</entry>
5726                 </row>
5727                 <row>
5728                   <entry>DBUS_START_REPLY_ALREADY_RUNNING</entry>
5729                   <entry>2</entry>
5730                   <entry>A connection already owns the given name.</entry>
5731                 </row>
5732               </tbody>
5733              </tgroup>
5734            </informaltable>
5735         </para>
5736
5737       </sect3>
5738
5739       <sect3 id="bus-messages-update-activation-environment">
5740         <title><literal>org.freedesktop.DBus.UpdateActivationEnvironment</literal></title>
5741         <para>
5742           As a method:
5743           <programlisting>
5744             UpdateActivationEnvironment (in ARRAY of DICT&lt;STRING,STRING&gt; environment)
5745           </programlisting>
5746           Message arguments:
5747           <informaltable>
5748             <tgroup cols="3">
5749               <thead>
5750                 <row>
5751                   <entry>Argument</entry>
5752                   <entry>Type</entry>
5753                   <entry>Description</entry>
5754                 </row>
5755               </thead>
5756               <tbody>
5757                 <row>
5758                   <entry>0</entry>
5759                   <entry>ARRAY of DICT&lt;STRING,STRING&gt;</entry>
5760                   <entry>Environment to add or update</entry>
5761                 </row>
5762               </tbody>
5763             </tgroup>
5764             </informaltable>
5765             Normally, session bus activated services inherit the environment of the bus daemon.  This method adds to or modifies that environment when activating services.
5766         </para>
5767         <para>
5768           Some bus instances, such as the standard system bus, may disable access to this method for some or all callers.
5769         </para>
5770         <para>
5771           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.
5772         </para>
5773
5774       </sect3>
5775
5776       <sect3 id="bus-messages-get-name-owner">
5777         <title><literal>org.freedesktop.DBus.GetNameOwner</literal></title>
5778         <para>
5779           As a method:
5780           <programlisting>
5781             STRING GetNameOwner (in STRING name)
5782           </programlisting>
5783           Message arguments:
5784           <informaltable>
5785             <tgroup cols="3">
5786               <thead>
5787                 <row>
5788                   <entry>Argument</entry>
5789                   <entry>Type</entry>
5790                   <entry>Description</entry>
5791                 </row>
5792               </thead>
5793               <tbody>
5794                 <row>
5795                   <entry>0</entry>
5796                   <entry>STRING</entry>
5797                   <entry>Name to get the owner of</entry>
5798                 </row>
5799               </tbody>
5800             </tgroup>
5801           </informaltable>
5802         Reply arguments:
5803         <informaltable>
5804           <tgroup cols="3">
5805             <thead>
5806               <row>
5807                 <entry>Argument</entry>
5808                 <entry>Type</entry>
5809                 <entry>Description</entry>
5810               </row>
5811             </thead>
5812             <tbody>
5813               <row>
5814                 <entry>0</entry>
5815                 <entry>STRING</entry>
5816                 <entry>Return value, a unique connection name</entry>
5817               </row>
5818             </tbody>
5819           </tgroup>
5820         </informaltable>
5821         Returns the unique connection name of the primary owner of the name
5822         given. If the requested name doesn't have an owner, returns a
5823         <literal>org.freedesktop.DBus.Error.NameHasNoOwner</literal> error.
5824        </para>
5825       </sect3>
5826
5827       <sect3 id="bus-messages-get-connection-unix-user">
5828         <title><literal>org.freedesktop.DBus.GetConnectionUnixUser</literal></title>
5829         <para>
5830           As a method:
5831           <programlisting>
5832             UINT32 GetConnectionUnixUser (in STRING bus_name)
5833           </programlisting>
5834           Message arguments:
5835           <informaltable>
5836             <tgroup cols="3">
5837               <thead>
5838                 <row>
5839                   <entry>Argument</entry>
5840                   <entry>Type</entry>
5841                   <entry>Description</entry>
5842                 </row>
5843               </thead>
5844               <tbody>
5845                 <row>
5846                   <entry>0</entry>
5847                   <entry>STRING</entry>
5848                   <entry>Unique or well-known bus name of the connection to
5849                     query, such as <literal>:12.34</literal> or
5850                     <literal>com.example.tea</literal></entry>
5851                 </row>
5852               </tbody>
5853             </tgroup>
5854           </informaltable>
5855         Reply arguments:
5856         <informaltable>
5857           <tgroup cols="3">
5858             <thead>
5859               <row>
5860                 <entry>Argument</entry>
5861                 <entry>Type</entry>
5862                 <entry>Description</entry>
5863               </row>
5864             </thead>
5865             <tbody>
5866               <row>
5867                 <entry>0</entry>
5868                 <entry>UINT32</entry>
5869                 <entry>Unix user ID</entry>
5870               </row>
5871             </tbody>
5872           </tgroup>
5873         </informaltable>
5874         Returns the Unix user ID of the process connected to the server. If
5875         unable to determine it (for instance, because the process is not on the
5876         same machine as the bus daemon), an error is returned.
5877        </para>
5878       </sect3>
5879
5880       <sect3 id="bus-messages-get-connection-unix-process-id">
5881         <title><literal>org.freedesktop.DBus.GetConnectionUnixProcessID</literal></title>
5882         <para>
5883           As a method:
5884           <programlisting>
5885             UINT32 GetConnectionUnixProcessID (in STRING bus_name)
5886           </programlisting>
5887           Message arguments:
5888           <informaltable>
5889             <tgroup cols="3">
5890               <thead>
5891                 <row>
5892                   <entry>Argument</entry>
5893                   <entry>Type</entry>
5894                   <entry>Description</entry>
5895                 </row>
5896               </thead>
5897               <tbody>
5898                 <row>
5899                   <entry>0</entry>
5900                   <entry>STRING</entry>
5901                   <entry>Unique or well-known bus name of the connection to
5902                     query, such as <literal>:12.34</literal> or
5903                     <literal>com.example.tea</literal></entry>
5904                 </row>
5905               </tbody>
5906             </tgroup>
5907           </informaltable>
5908         Reply arguments:
5909         <informaltable>
5910           <tgroup cols="3">
5911             <thead>
5912               <row>
5913                 <entry>Argument</entry>
5914                 <entry>Type</entry>
5915                 <entry>Description</entry>
5916               </row>
5917             </thead>
5918             <tbody>
5919               <row>
5920                 <entry>0</entry>
5921                 <entry>UINT32</entry>
5922                 <entry>Unix process id</entry>
5923               </row>
5924             </tbody>
5925           </tgroup>
5926         </informaltable>
5927         Returns the Unix process ID of the process connected to the server. If
5928         unable to determine it (for instance, because the process is not on the
5929         same machine as the bus daemon), an error is returned.
5930        </para>
5931       </sect3>
5932
5933       <sect3 id="bus-messages-get-connection-credentials">
5934         <title><literal>org.freedesktop.DBus.GetConnectionCredentials</literal></title>
5935         <para>
5936           As a method:
5937           <programlisting>
5938             DICT&lt;STRING,VARIANT&gt; GetConnectionCredentials (in STRING bus_name)
5939           </programlisting>
5940           Message arguments:
5941           <informaltable>
5942             <tgroup cols="3">
5943               <thead>
5944                 <row>
5945                   <entry>Argument</entry>
5946                   <entry>Type</entry>
5947                   <entry>Description</entry>
5948                 </row>
5949               </thead>
5950               <tbody>
5951                 <row>
5952                   <entry>0</entry>
5953                   <entry>STRING</entry>
5954                   <entry>Unique or well-known bus name of the connection to
5955                     query, such as <literal>:12.34</literal> or
5956                     <literal>com.example.tea</literal></entry>
5957                 </row>
5958               </tbody>
5959             </tgroup>
5960           </informaltable>
5961         Reply arguments:
5962         <informaltable>
5963           <tgroup cols="3">
5964             <thead>
5965               <row>
5966                 <entry>Argument</entry>
5967                 <entry>Type</entry>
5968                 <entry>Description</entry>
5969               </row>
5970             </thead>
5971             <tbody>
5972               <row>
5973                 <entry>0</entry>
5974                 <entry>DICT&lt;STRING,VARIANT&gt;</entry>
5975                 <entry>Credentials</entry>
5976               </row>
5977             </tbody>
5978           </tgroup>
5979         </informaltable>
5980       </para>
5981
5982       <para>
5983         Returns as many credentials as possible for the process connected to
5984         the server. If unable to determine certain credentials (for instance,
5985         because the process is not on the same machine as the bus daemon,
5986         or because this version of the bus daemon does not support a
5987         particular security framework), or if the values of those credentials
5988         cannot be represented as documented here, then those credentials
5989         are omitted.
5990       </para>
5991
5992       <para>
5993         Keys in the returned dictionary not containing "." are defined
5994         by this specification. Bus daemon implementors supporting
5995         credentials frameworks not mentioned in this document should either
5996         contribute patches to this specification, or use keys containing
5997         "." and starting with a reversed domain name.
5998         <informaltable>
5999           <tgroup cols="3">
6000             <thead>
6001               <row>
6002                 <entry>Key</entry>
6003                 <entry>Value type</entry>
6004                 <entry>Value</entry>
6005               </row>
6006             </thead>
6007             <tbody>
6008               <row>
6009                 <entry>UnixUserID</entry>
6010                 <entry>UINT32</entry>
6011                 <entry>The numeric Unix user ID, as defined by POSIX</entry>
6012               </row>
6013               <row>
6014                 <entry>ProcessID</entry>
6015                 <entry>UINT32</entry>
6016                 <entry>The numeric process ID, on platforms that have
6017                   this concept. On Unix, this is the process ID defined by
6018                   POSIX.</entry>
6019               </row>
6020               <row>
6021                 <entry>WindowsSID</entry>
6022                 <entry>STRING</entry>
6023                 <entry>The Windows security identifier in its string form,
6024                 e.g. "S-1-5-21-3623811015-3361044348-30300820-1013" for
6025                 a domain or local computer user or "S-1-5-18" for the
6026                 LOCAL_SYSTEM user</entry>
6027               </row>
6028
6029               <row>
6030                 <entry>LinuxSecurityLabel</entry>
6031                 <entry>ARRAY of BYTE</entry>
6032                 <entry>
6033                   <para>On Linux systems, the security label that would result
6034                     from the SO_PEERSEC getsockopt call. The array contains
6035                     the non-zero bytes of the security label in an unspecified
6036                     ASCII-compatible encoding<footnote>
6037                       <para>It could be ASCII or UTF-8, but could also be
6038                         ISO Latin-1 or any other encoding.</para>
6039                     </footnote>, followed by a single zero byte.</para>
6040                   <para>
6041                     For example, the SELinux context
6042                     <literal>system_u:system_r:init_t:s0</literal>
6043                     (a string of length 27) would be encoded as 28 bytes
6044                     ending with ':', 's', '0', '\x00'.<footnote>
6045                       <para>Note that this is not the same as the older
6046                         GetConnectionSELinuxContext method, which does
6047                         not append the zero byte. Always appending the
6048                         zero byte allows callers to read the string
6049                         from the message payload without copying.</para>
6050                     </footnote>
6051                   </para>
6052                   <para>
6053                     On SELinux systems this is the SELinux context, as output
6054                     by <literal>ps -Z</literal> or <literal>ls -Z</literal>.
6055                     Typical values might include
6056                     <literal>system_u:system_r:init_t:s0</literal>,
6057                     <literal>unconfined_u:unconfined_r:unconfined_t:s0-s0:c0.c1023</literal>,
6058                     or
6059                     <literal>unconfined_u:unconfined_r:chrome_sandbox_t:s0-s0:c0.c1023</literal>.
6060                   </para>
6061                   <para>
6062                     On Smack systems, this is the Smack label.
6063                     Typical values might include
6064                     <literal>_</literal>, <literal>*</literal>,
6065                     <literal>User</literal>, <literal>System</literal>
6066                     or <literal>System::Shared</literal>.
6067                   </para>
6068                   <para>
6069                     On AppArmor systems, this is the AppArmor context,
6070                     a composite string encoding the AppArmor label (one or more
6071                     profiles) and the enforcement mode.
6072                     Typical values might include <literal>unconfined</literal>,
6073                     <literal>/usr/bin/firefox (enforce)</literal> or
6074                     <literal>user1 (complain)</literal>.
6075                   </para>
6076                 </entry>
6077               </row>
6078               <row>
6079                 <entry>SmackLabel</entry>
6080                 <entry>STRING</entry>
6081                 <entry>The Smack label of the process at the time when it connected
6082                   to D-Bus, on platforms that have this concept.</entry>
6083               </row>
6084             </tbody>
6085           </tgroup>
6086         </informaltable>
6087        </para>
6088
6089         <para>
6090           This method was added in D-Bus 1.7 to reduce the round-trips
6091           required to list a process's credentials. In older versions, calling
6092           this method will fail: applications should recover by using the
6093           separate methods such as
6094           <xref linkend="bus-messages-get-connection-unix-user"/>
6095           instead.
6096         </para>
6097       </sect3>
6098
6099       <sect3 id="bus-messages-get-adt-audit-session-data">
6100         <title><literal>org.freedesktop.DBus.GetAdtAuditSessionData</literal></title>
6101         <para>
6102           As a method:
6103           <programlisting>
6104             ARRAY of BYTE GetAdtAuditSessionData (in STRING bus_name)
6105           </programlisting>
6106           Message arguments:
6107           <informaltable>
6108             <tgroup cols="3">
6109               <thead>
6110                 <row>
6111                   <entry>Argument</entry>
6112                   <entry>Type</entry>
6113                   <entry>Description</entry>
6114                 </row>
6115               </thead>
6116               <tbody>
6117                 <row>
6118                   <entry>0</entry>
6119                   <entry>STRING</entry>
6120                   <entry>Unique or well-known bus name of the connection to
6121                     query, such as <literal>:12.34</literal> or
6122                     <literal>com.example.tea</literal></entry>
6123                 </row>
6124               </tbody>
6125             </tgroup>
6126           </informaltable>
6127           Reply arguments:
6128           <informaltable>
6129             <tgroup cols="3">
6130               <thead>
6131                 <row>
6132                   <entry>Argument</entry>
6133                   <entry>Type</entry>
6134                   <entry>Description</entry>
6135                 </row>
6136               </thead>
6137               <tbody>
6138                 <row>
6139                   <entry>0</entry>
6140                   <entry>ARRAY of BYTE</entry>
6141                   <entry>auditing data as returned by
6142                     adt_export_session_data()</entry>
6143                 </row>
6144               </tbody>
6145             </tgroup>
6146           </informaltable>
6147           Returns auditing data used by Solaris ADT, in an unspecified
6148           binary format. If you know what this means, please contribute
6149           documentation via the D-Bus bug tracking system.
6150           This method is on the core DBus interface for historical reasons;
6151           the same information should be made available via
6152           <xref linkend="bus-messages-get-connection-credentials"/>
6153           in future.
6154         </para>
6155       </sect3>
6156
6157       <sect3 id="bus-messages-get-connection-selinux-security-context">
6158         <title><literal>org.freedesktop.DBus.GetConnectionSELinuxSecurityContext</literal></title>
6159         <para>
6160           As a method:
6161           <programlisting>
6162             ARRAY of BYTE GetConnectionSELinuxSecurityContext (in STRING bus_name)
6163           </programlisting>
6164           Message arguments:
6165           <informaltable>
6166             <tgroup cols="3">
6167               <thead>
6168                 <row>
6169                   <entry>Argument</entry>
6170                   <entry>Type</entry>
6171                   <entry>Description</entry>
6172                 </row>
6173               </thead>
6174               <tbody>
6175                 <row>
6176                   <entry>0</entry>
6177                   <entry>STRING</entry>
6178                   <entry>Unique or well-known bus name of the connection to
6179                     query, such as <literal>:12.34</literal> or
6180                     <literal>com.example.tea</literal></entry>
6181                 </row>
6182               </tbody>
6183             </tgroup>
6184           </informaltable>
6185           Reply arguments:
6186           <informaltable>
6187             <tgroup cols="3">
6188               <thead>
6189                 <row>
6190                   <entry>Argument</entry>
6191                   <entry>Type</entry>
6192                   <entry>Description</entry>
6193                 </row>
6194               </thead>
6195               <tbody>
6196                 <row>
6197                   <entry>0</entry>
6198                   <entry>ARRAY of BYTE</entry>
6199                   <entry>some sort of string of bytes, not necessarily UTF-8,
6200                     not including '\0'</entry>
6201                 </row>
6202               </tbody>
6203             </tgroup>
6204           </informaltable>
6205           Returns the security context used by SELinux, in an unspecified
6206           format. If you know what this means, please contribute
6207           documentation via the D-Bus bug tracking system.
6208           This method is on the core DBus interface for historical reasons;
6209           the same information should be made available via
6210           <xref linkend="bus-messages-get-connection-credentials"/>
6211           in future.
6212         </para>
6213       </sect3>
6214
6215
6216       <sect3 id="bus-messages-add-match">
6217         <title><literal>org.freedesktop.DBus.AddMatch</literal></title>
6218         <para>
6219           As a method:
6220           <programlisting>
6221             AddMatch (in STRING rule)
6222           </programlisting>
6223           Message arguments:
6224           <informaltable>
6225             <tgroup cols="3">
6226               <thead>
6227                 <row>
6228                   <entry>Argument</entry>
6229                   <entry>Type</entry>
6230                   <entry>Description</entry>
6231                 </row>
6232               </thead>
6233               <tbody>
6234                 <row>
6235                   <entry>0</entry>
6236                   <entry>STRING</entry>
6237                   <entry>Match rule to add to the connection</entry>
6238                 </row>
6239               </tbody>
6240             </tgroup>
6241           </informaltable>
6242         Adds a match rule to match messages going through the message bus (see <xref linkend='message-bus-routing-match-rules'/>).
6243         If the bus does not have enough resources the <literal>org.freedesktop.DBus.Error.OOM</literal>
6244         error is returned.
6245        </para>
6246       </sect3>
6247       <sect3 id="bus-messages-remove-match">
6248         <title><literal>org.freedesktop.DBus.RemoveMatch</literal></title>
6249         <para>
6250           As a method:
6251           <programlisting>
6252             RemoveMatch (in STRING rule)
6253           </programlisting>
6254           Message arguments:
6255           <informaltable>
6256             <tgroup cols="3">
6257               <thead>
6258                 <row>
6259                   <entry>Argument</entry>
6260                   <entry>Type</entry>
6261                   <entry>Description</entry>
6262                 </row>
6263               </thead>
6264               <tbody>
6265                 <row>
6266                   <entry>0</entry>
6267                   <entry>STRING</entry>
6268                   <entry>Match rule to remove from the connection</entry>
6269                 </row>
6270               </tbody>
6271             </tgroup>
6272           </informaltable>
6273         Removes the first rule that matches (see <xref linkend='message-bus-routing-match-rules'/>).
6274         If the rule is not found the <literal>org.freedesktop.DBus.Error.MatchRuleNotFound</literal>
6275         error is returned.
6276        </para>
6277       </sect3>
6278
6279       <sect3 id="bus-messages-get-id">
6280         <title><literal>org.freedesktop.DBus.GetId</literal></title>
6281         <para>
6282           As a method:
6283           <programlisting>
6284             GetId (out STRING id)
6285           </programlisting>
6286         Reply arguments:
6287         <informaltable>
6288           <tgroup cols="3">
6289             <thead>
6290               <row>
6291                 <entry>Argument</entry>
6292                 <entry>Type</entry>
6293                 <entry>Description</entry>
6294               </row>
6295             </thead>
6296             <tbody>
6297               <row>
6298                 <entry>0</entry>
6299                 <entry>STRING</entry>
6300                 <entry>Unique ID identifying the bus daemon</entry>
6301               </row>
6302             </tbody>
6303           </tgroup>
6304         </informaltable>
6305         Gets the unique ID of the bus. The unique ID here is shared among all addresses the
6306         bus daemon is listening on (TCP, UNIX domain socket, etc.) and its format is described in
6307         <xref linkend="uuids"/>. Each address the bus is listening on also has its own unique
6308         ID, as described in <xref linkend="addresses"/>. The per-bus and per-address IDs are not related.
6309         There is also a per-machine ID, described in <xref linkend="standard-interfaces-peer"/> and returned
6310         by org.freedesktop.DBus.Peer.GetMachineId().
6311         For a desktop session bus, the bus ID can be used as a way to uniquely identify a user's session.
6312         </para>
6313       </sect3>
6314
6315       <sect3 id="bus-messages-become-monitor">
6316         <title><literal>org.freedesktop.DBus.Monitoring.BecomeMonitor</literal></title>
6317         <para>
6318           As a method:
6319           <programlisting>
6320             BecomeMonitor (in ARRAY of STRING rule, in UINT32 flags)
6321           </programlisting>
6322           Message arguments:
6323           <informaltable>
6324             <tgroup cols="3">
6325               <thead>
6326                 <row>
6327                   <entry>Argument</entry>
6328                   <entry>Type</entry>
6329                   <entry>Description</entry>
6330                 </row>
6331               </thead>
6332               <tbody>
6333                 <row>
6334                   <entry>0</entry>
6335                   <entry>ARRAY of STRING</entry>
6336                   <entry>Match rules to add to the connection</entry>
6337                 </row>
6338                 <row>
6339                   <entry>1</entry>
6340                   <entry>UINT32</entry>
6341                   <entry>Not used, must be 0</entry>
6342                 </row>
6343               </tbody>
6344             </tgroup>
6345           </informaltable>
6346         </para>
6347
6348         <para>
6349           Converts the connection into a <emphasis>monitor
6350             connection</emphasis> which can be used as a debugging/monitoring
6351           tool. Only a user who is privileged on this
6352           bus (by some implementation-specific definition) may create
6353           monitor connections<footnote>
6354             <para>
6355               In the reference implementation,
6356               the default configuration is that each user (identified by
6357               numeric user ID) may monitor their own session bus,
6358               and the root user (user ID zero) may monitor the
6359               system bus.
6360             </para>
6361           </footnote>.
6362        </para>
6363
6364        <para>
6365          Monitor connections lose all their bus names, including the unique
6366          connection name, and all their match rules. Sending messages on a
6367          monitor connection is not allowed: applications should use a private
6368          connection for monitoring.
6369        </para>
6370
6371        <para>
6372          Monitor connections may receive all messages, even messages that
6373          should only have gone to some other connection ("eavesdropping").
6374          The first argument is a list of match rules, which replace any
6375          match rules that were previously active for this connection.
6376          These match rules are always treated as if they contained the
6377          special <literal>eavesdrop='true'</literal> member.
6378        </para>
6379
6380        <para>
6381          As a special case, an empty list of match rules (which would
6382          otherwise match nothing, making the monitor useless) is treated
6383          as a shorthand for matching all messages.
6384        </para>
6385
6386        <para>
6387          The second argument might be used for flags to influence the
6388          behaviour of the monitor connection in future D-Bus versions.
6389        </para>
6390
6391        <para>
6392          Message bus implementations should attempt to minimize the
6393          side-effects of monitoring — in particular, unlike ordinary
6394          eavesdropping, monitoring the system bus does not require the
6395          access control rules to be relaxed, which would change the set
6396          of messages that can be delivered to their (non-monitor)
6397          destinations. However, it is unavoidable that monitoring
6398          will increase the message bus's resource consumption. In
6399          edge cases where there was barely enough time or memory without
6400          monitoring, this might result in message deliveries failing
6401          when they would otherwise have succeeded.
6402        </para>
6403       </sect3>
6404
6405     </sect2>
6406
6407   </sect1>
6408 <!--
6409   <appendix id="implementation-notes">
6410     <title>Implementation notes</title>
6411     <sect1 id="implementation-notes-subsection">
6412       <title></title>
6413       <para>
6414       </para>
6415     </sect1>
6416   </appendix>
6417 -->
6418
6419   <glossary><title>Glossary</title>
6420     <para>
6421       This glossary defines some of the terms used in this specification.
6422     </para>
6423
6424     <glossentry id="term-bus-name"><glossterm>Bus Name</glossterm>
6425       <glossdef>
6426         <para>
6427           The message bus maintains an association between names and
6428           connections. (Normally, there's one connection per application.)  A
6429           bus name is simply an identifier used to locate connections. For
6430           example, the hypothetical <literal>com.yoyodyne.Screensaver</literal>
6431           name might be used to send a message to a screensaver from Yoyodyne
6432           Corporation.  An application is said to <firstterm>own</firstterm> a
6433           name if the message bus has associated the application's connection
6434           with the name.  Names may also have <firstterm>queued
6435           owners</firstterm> (see <xref linkend="term-queued-owner"/>).
6436             The bus assigns a unique name to each connection,
6437             see <xref linkend="term-unique-name"/>. Other names
6438               can be thought of as "well-known names" and are
6439               used to find applications that offer specific functionality.
6440         </para>
6441
6442         <para>
6443           See <xref linkend="message-protocol-names-bus"/> for details of
6444           the syntax and naming conventions for bus names.
6445         </para>
6446       </glossdef>
6447     </glossentry>
6448
6449     <glossentry id="term-message"><glossterm>Message</glossterm>
6450       <glossdef>
6451         <para>
6452           A message is the atomic unit of communication via the D-Bus
6453           protocol. It consists of a <firstterm>header</firstterm> and a
6454           <firstterm>body</firstterm>; the body is made up of
6455           <firstterm>arguments</firstterm>.
6456         </para>
6457       </glossdef>
6458     </glossentry>
6459
6460     <glossentry id="term-message-bus"><glossterm>Message Bus</glossterm>
6461       <glossdef>
6462         <para>
6463           The message bus is a special application that forwards
6464           or routes messages between a group of applications
6465           connected to the message bus. It also manages
6466           <firstterm>names</firstterm> used for routing
6467           messages.
6468         </para>
6469       </glossdef>
6470     </glossentry>
6471
6472     <glossentry id="term-name"><glossterm>Name</glossterm>
6473       <glossdef>
6474         <para>
6475           See <xref linkend="term-bus-name"/>. "Name" may
6476             also be used to refer to some of the other names
6477             in D-Bus, such as interface names.
6478         </para>
6479       </glossdef>
6480     </glossentry>
6481
6482     <glossentry id="namespace"><glossterm>Namespace</glossterm>
6483       <glossdef>
6484         <para>
6485           Used to prevent collisions when defining new interfaces, bus names
6486           etc. The convention used is the same one Java uses for defining
6487           classes: a reversed domain name.
6488           See <xref linkend="message-protocol-names-bus"/>,
6489           <xref linkend="message-protocol-names-interface"/>,
6490           <xref linkend="message-protocol-names-error"/>,
6491           <xref linkend="message-protocol-marshaling-object-path"/>.
6492         </para>
6493       </glossdef>
6494     </glossentry>
6495
6496     <glossentry id="term-object"><glossterm>Object</glossterm>
6497       <glossdef>
6498         <para>
6499           Each application contains <firstterm>objects</firstterm>, which have
6500           <firstterm>interfaces</firstterm> and
6501           <firstterm>methods</firstterm>. Objects are referred to by a name,
6502           called a <firstterm>path</firstterm>.
6503         </para>
6504       </glossdef>
6505     </glossentry>
6506
6507     <glossentry id="one-to-one"><glossterm>One-to-One</glossterm>
6508       <glossdef>
6509         <para>
6510           An application talking directly to another application, without going
6511           through a message bus. One-to-one connections may be "peer to peer" or
6512           "client to server." The D-Bus protocol has no concept of client
6513           vs. server after a connection has authenticated; the flow of messages
6514           is symmetrical (full duplex).
6515         </para>
6516       </glossdef>
6517     </glossentry>
6518
6519     <glossentry id="term-path"><glossterm>Path</glossterm>
6520       <glossdef>
6521         <para>
6522           Object references (object names) in D-Bus are organized into a
6523           filesystem-style hierarchy, so each object is named by a path. As in
6524           LDAP, there's no difference between "files" and "directories"; a path
6525           can refer to an object, while still having child objects below it.
6526         </para>
6527       </glossdef>
6528     </glossentry>
6529
6530     <glossentry id="term-queued-owner"><glossterm>Queued Name Owner</glossterm>
6531       <glossdef>
6532         <para>
6533           Each bus name has a primary owner; messages sent to the name go to the
6534           primary owner. However, certain names also maintain a queue of
6535           secondary owners "waiting in the wings." If the primary owner releases
6536           the name, then the first secondary owner in the queue automatically
6537           becomes the new owner of the name.
6538         </para>
6539       </glossdef>
6540     </glossentry>
6541
6542     <glossentry id="term-service"><glossterm>Service</glossterm>
6543       <glossdef>
6544         <para>
6545           A service is an executable that can be launched by the bus daemon.
6546           Services normally guarantee some particular features, for example they
6547           may guarantee that they will request a specific name such as
6548           "com.example.Screensaver", have a singleton object
6549           "/com/example/Application", and that object will implement the
6550           interface "com.example.Screensaver.Control".
6551         </para>
6552       </glossdef>
6553     </glossentry>
6554
6555     <glossentry id="term-service-description-files"><glossterm>Service Description Files</glossterm>
6556       <glossdef>
6557         <para>
6558           ".service files" tell the bus about service applications that can be
6559           launched (see <xref linkend="term-service"/>). Most importantly they
6560           provide a mapping from bus names to services that will request those
6561             names when they start up.
6562         </para>
6563       </glossdef>
6564     </glossentry>
6565
6566     <glossentry id="term-unique-name"><glossterm>Unique Connection Name</glossterm>
6567       <glossdef>
6568         <para>
6569           The special name automatically assigned to each connection by the
6570           message bus. This name will never change owner, and will be unique
6571           (never reused during the lifetime of the message bus).
6572           It will begin with a ':' character.
6573         </para>
6574       </glossdef>
6575     </glossentry>
6576
6577   </glossary>
6578 </article>