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