doc/dbus.doxygen

   1 /**
   2 \page dbus %wpa_supplicant D-Bus API
   3
   4 This section documents the %wpa_supplicant D-Bus API. Every D-Bus
   5 interface implemented by %wpa_supplicant is described here including
   6 their methods, signals, and properties with arguments, returned
   7 values, and possible errors.
   8
   9 Interfaces:
  10 - \ref dbus_main
  11 - \ref dbus_interface
  12 - \ref dbus_wps
  13 - \ref dbus_bss
  14 - \ref dbus_network
  15
  16
  17 \section dbus_main fi.w1.wpa_supplicant1
  18
  19 Interface implemented by the main %wpa_supplicant D-Bus object
  20 registered in the bus with fi.w1.wpa_supplicant1 name.
  21
  22 \subsection dbus_main_methods Methods
  23
  24     <ul>
  25       <li>
  26         <h3>CreateInterface ( a{sv} : args ) --> o : interface</h3>
  27         <p>Registers a wireless interface in %wpa_supplicant.</p>
  28         <h4>Arguments</h4>
  29         <dl>
  30           <dt>a{sv} : args</dt>
  31           <dd>
  32             A dictionary with arguments used to add the interface to %wpa_supplicant. The dictionary may contain the following entries:
  33             <table>
  34               <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th>
  35               <tr><td>Ifname</td><td>s</td><td>Name of the network interface to control, e.g., wlan0</td><td>Yes</td>
  36               <tr><td>Bridge_ifname</td><td>s</td><td>Name of the bridge interface to control, e.g., br0</td><td>No</td>
  37               <tr><td>Driver</td><td>s</td><td>Driver name which the interface uses, e.g., nl80211</td><td>No</td>
  38             </table>
  39           </dd>
  40         </dl>
  41         <h4>Returns</h4>
  42         <dl>
  43           <dt>o : interface</dt>
  44           <dd>A D-Bus path to object representing created interface</dd>
  45         </dl>
  46         <h4>Possible errors</h4>
  47         <dl>
  48           <dt>fi.w1.wpa_supplicant1.InterfaceExists</dt>
  49           <dd>%wpa_supplicant already controls this interface.</dd>
  50           <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
  51           <dd>Creating interface failed for an unknown reason.</dd>
  52           <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
  53           <dd>Invalid entries were found in the passed argument.</dd>
  54         </dl>
  55       </li>
  56
  57       <li>
  58         <h3>RemoveInterface ( o : interface ) --> nothing</h3>
  59         <p>Deregisters a wireless interface from %wpa_supplicant.</p>
  60         <h4>Arguments</h4>
  61         <dl>
  62           <dt>o : interface</dt>
  63           <dd>A D-Bus path to an object representing an interface to remove returned by CreateInterface</dd>
  64         </dl>
  65         <h4>Possible errors</h4>
  66         <dl>
  67           <dt>fi.w1.wpa_supplicant1.InterfaceUnknown</dt>
  68           <dd>Object pointed by the path doesn't exist or doesn't represent an interface.</dd>
  69           <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
  70           <dd>Removing interface failed for an unknown reason.</dd>
  71         </dl>
  72       </li>
  73
  74       <li>
  75         <h3>GetInterface ( s : ifname ) --> o : interface</h3>
  76         <p>Returns a D-Bus path to an object related to an interface which %wpa_supplicant already controls.</p>
  77         <h4>Arguments</h4>
  78         <dl>
  79           <dt>s : ifname</dt>
  80           <dd>Name of the network interface, e.g., wlan0</dd>
  81         </dl>
  82         <h4>Returns</h4>
  83         <dl>
  84           <dt>o : interface</dt>
  85           <dd>A D-Bus path to an object representing an interface</dd>
  86         </dl>
  87         <h4>Possible errors</h4>
  88         <dl>
  89           <dt>fi.w1.wpa_supplicant1.InterfaceUnknown</dt>
  90           <dd>An interface with the passed name in not controlled by %wpa_supplicant.</dd>
  91           <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
  92           <dd>Getting an interface object path failed for an unknown reason.</dd>
  93         </dl>
  94       </li>
  95     </ul>
  96
  97 \subsection dbus_main_properties Properties
  98
  99     <ul>
 100       <li>
 101         <h3>DebugLevel - y - (read/write)</h3>
 102         <p>Global %wpa_supplicant debuging level. Possible values are 0, 1, 2, 3 and 4</p>
 103       </li>
 104
 105       <li>
 106         <h3>DebugTimestamp - b - (read/write)</h3>
 107         <p>Global %wpa_supplicant debuging parameter. Determines if timestamps are shown in debug logs.</p>
 108       </li>
 109
 110       <li>
 111         <h3>DebugShowKeys - b - (read/write)</h3>
 112         <p>Global %wpa_supplicant debuging parameter. Determines if secrets are shown in debug logs.</p>
 113       </li>
 114
 115       <li>
 116         <h3>Interfaces - ao - (read)</h3>
 117         <p>An array with paths to D-Bus objects representing controlled interfaces each.</p>
 118       </li>
 119
 120       <li>
 121         <h3>EapMethods - as - (read)</h3>
 122         <p>An array with supported EAP methods names.</p>
 123       </li>
 124     </ul>
 125
 126 \subsection dbus_main_signals Signals
 127
 128     <ul>
 129       <li>
 130         <h3>InterfaceAdded ( o : interface, a{sv} : properties )</h3>
 131         <p>A new interface was added to %wpa_supplicant.</p>
 132         <h4>Arguments</h4>
 133         <dl>
 134           <dt>o : interface</dt>
 135           <dd>A D-Bus path to an object representing the added interface</dd>
 136         </dl>
 137         <dl>
 138           <dt>a{sv} : properties</dt>
 139           <dd>A dictionary containing properties of added interface.</dd>
 140         </dl>
 141       </li>
 142
 143       <li>
 144         <h3>InterfaceRemoved ( o : interface )</h3>
 145         <p>An interface was removed from %wpa_supplicant.</p>
 146         <h4>Arguments</h4>
 147         <dl>
 148           <dt>o : interface</dt>
 149           <dd>A D-Bus path to an object representing the removed interface</dd>
 150         </dl>
 151       </li>
 152
 153       <li>
 154         <h3>PropertiesChanged ( a{sv} : properties )</h3>
 155         <p>Some properties have changed.</p>
 156         <h4>Arguments</h4>
 157         <dl>
 158           <dt>a{sv} : properties</dt>
 159           <dd>A dictionary with pairs of properties names which have changed and theirs new values. Possible dictionary keys are: "DebugParams"</dd>
 160         </dl>
 161       </li>
 162     </ul>
 163
 164
 165 \section dbus_interface fi.w1.wpa_supplicant1.Interface
 166
 167 Interface implemented by objects related to network interface added to
 168 %wpa_supplicant, i.e., returned by
 169 fi.w1.wpa_supplicant1.CreateInterface.
 170
 171 \subsection dbus_interface_methods Methods
 172
 173     <ul>
 174       <li>
 175         <h3>Scan ( a{sv} : args ) --> nothing</h3>
 176         <p>Triggers a scan.</p>
 177         <h4>Arguments</h4>
 178         <dl>
 179           <dt>a{sv} : args</dt>
 180           <dd>
 181             A dictionary with arguments describing scan type:
 182             <table>
 183               <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th>
 184               <tr><td>Type</td><td>s</td><td>Type of the scan. Possible values: "active", "passive"</td><td>Yes</td>
 185               <tr><td>SSIDs</td><td>aay</td><td>Array of SSIDs to scan for (applies only if scan type is active)</td><td>No</td>
 186               <tr><td>IEs</td><td>aay</td><td>Information elements to used in active scan (applies only if scan type is active)</td><td>No</td>
 187               <tr><td>Channels</td><td>a(uu)</td><td>Array of frequencies to scan in form of (center, width) in MHz.</td><td>No</td>
 188             </table>
 189           </dd>
 190         </dl>
 191         <h4>Possible errors</h4>
 192         <dl>
 193           <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
 194           <dd>Invalid entries were found in the passed argument.</dd>
 195         </dl>
 196       </li>
 197
 198       <li>
 199         <h3>Disconnect ( ) --> nothing</h3>
 200         <p>Disassociates the interface from current network.</p>
 201         <h4>Possible errors</h4>
 202         <dl>
 203           <dt>fi.w1.wpa_supplicant1.Interface.NotConnected</dt>
 204           <dd>Interface is not connected to any network.</dd>
 205         </dl>
 206       </li>
 207
 208       <li>
 209         <h3>AddNetwork ( a{sv} : args ) --> o : network</h3>
 210         <p>Adds a new network to the interface.</p>
 211         <h4>Arguments</h4>
 212         <dl>
 213           <dt>a{sv} : args</dt>
 214           <dd>A dictionary with network configuration. Dictionary entries are equivalent to entries in the "network" block in %wpa_supplicant configuration file. Entry values should be appropriate type to the entry, e.g., an entry with key "frequency" should have value type int.</dd>
 215         </dl>
 216         <h4>Returns</h4>
 217         <dl>
 218           <dt>o : network</dt>
 219           <dd>A D-Bus path to an object representing a configured network</dd>
 220         </dl>
 221         <h4>Possible errors</h4>
 222         <dl>
 223           <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
 224           <dd>Invalid entries were found in the passed argument.</dd>
 225           <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
 226           <dd>Adding network failed for an unknown reason.</dd>
 227         </dl>
 228       </li>
 229
 230       <li>
 231         <h3>RemoveNetwork ( o : network ) --> nothing</h3>
 232         <p>Removes a configured network from the interface.</p>
 233         <h4>Arguments</h4>
 234         <dl>
 235           <dt>o : network</dt>
 236           <dd>A D-Bus path to an object representing a configured network returned by fi.w1.wpa_supplicant1.Interface.AddNetwork</dd>
 237         </dl>
 238         <h4>Possible errors</h4>
 239         <dl>
 240           <dt>fi.w1.wpa_supplicant1.Interface.NetworkUnknown</dt>
 241           <dd>A passed path doesn't point to any network object.</dd>
 242           <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
 243           <dd>A passed path doesn't point to any network object.</dd>
 244           <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
 245           <dd>Removing network failed for an unknown reason.</dd>
 246         </dl>
 247       </li>
 248
 249       <li>
 250         <h3>SelectNetwork ( o : network ) --> nothing</h3>
 251         <p>Attempt association with a configured network.</p>
 252         <h4>Arguments</h4>
 253         <dl>
 254           <dt>o : network</dt>
 255           <dd>A D-Bus path to an object representing a configured network returned by fi.w1.wpa_supplicant1.Interface.AddNetwork</dd>
 256         </dl>
 257         <h4>Possible errors</h4>
 258         <dl>
 259           <dt>fi.w1.wpa_supplicant1.Interface.NetworkUnknown</dt>
 260           <dd>A passed path doesn't point to any network object.</dd>
 261           <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
 262           <dd>A passed path doesn't point to any network object.</dd>
 263         </dl>
 264       </li>
 265
 266       <li>
 267         <h3>AddBlob ( s : name, ay : data ) --> nothing</h3>
 268         <p>Adds a blob to the interface.</p>
 269         <h4>Arguments</h4>
 270         <dl>
 271           <dt>s : name</dt>
 272           <dd>A name of a blob</dd>
 273           <dt>ay : data</dt>
 274           <dd>A blob data</dd>
 275         </dl>
 276         <h4>Possible errors</h4>
 277         <dl>
 278           <dt>fi.w1.wpa_supplicant1.Interface.BlobExists</dt>
 279           <dd>A blob with the specified name already exists.</dd>
 280         </dl>
 281       </li>
 282
 283       <li>
 284         <h3>RemoveBlob ( s : name ) --> nothing</h3>
 285         <p>Removes the blob from the interface.</p>
 286         <h4>Arguments</h4>
 287         <dl>
 288           <dt>s : name</dt>
 289           <dd>A name of the blob to remove</dd>
 290         </dl>
 291         <h4>Possible errors</h4>
 292         <dl>
 293           <dt>fi.w1.wpa_supplicant1.Interface.BlobUnknown</dt>
 294           <dd>A blob with the specified name doesn't exist.</dd>
 295         </dl>
 296       </li>
 297
 298       <li>
 299         <h3>GetBlob ( s : name ) --> ay : data</h3>
 300         <p>Returns the blob data of a previously added blob.</p>
 301         <h4>Arguments</h4>
 302         <dl>
 303           <dt>s : name</dt>
 304           <dd>A name of the blob</dd>
 305         </dl>
 306         <h4>Returns</h4>
 307         <dl>
 308           <dt>ay : data</dt>
 309           <dd>A blob data</dd>
 310         </dl>
 311         <h4>Possible errors</h4>
 312         <dl>
 313           <dt>fi.w1.wpa_supplicant1.Interface.BlobUnknown</dt>
 314           <dd>A blob with the specified name doesn't exist.</dd>
 315         </dl>
 316       </li>
 317     </ul>
 318
 319 \subsection dbus_interface_properties Properties
 320
 321     <ul>
 322       <li>
 323         <h3>Capabilities - a{sv} - (read)</h3>
 324         <p>Capabilities of the interface. Dictionary contains following entries:</p>
 325         <table>
 326           <tr><th>Key</th><th>Value type</th><th>Description</th>
 327           <tr><td>Pairwise</td><td>as</td><td>Possible array elements: "ccmp", "tkip", "none"</td>
 328           <tr><td>Group</td><td>as</td><td>Possible array elements: "ccmp", "tkip", "wep104", "wep40"</td>
 329           <tr><td>KeyMgmt</td><td>as</td><td>Possible array elements: "wpa-psk", "wpa-eap", "ieee8021x", "wpa-none", "wps", "none"</td>
 330           <tr><td>Protocol</td><td>as</td><td>Possible array elements: "rsn", "wpa"</td>
 331           <tr><td>AuthAlg</td><td>as</td><td>Possible array elements: "open", "shared", "leap"</td>
 332           <tr><td>Scan</td><td>as</td><td>Possible array elements: "active", "passive", "ssid"</td>
 333           <tr><td>Modes</td><td>as</td><td>Possible array elements: "infrastructure", "ad-hoc", "ap"</td>
 334         </table>
 335       </li>
 336
 337       <li>
 338         <h3>State - s - (read)</h3>
 339         <p>A state of the interface. Possible values are: return "disconnected", "inactive", "scanning", "authenticating", "associating", "associated", "4way_handshake", "group_handshake", "completed","unknown".</p>
 340       </li>
 341
 342       <li>
 343         <h3>Scanning - b - (read)</h3>
 344         <p>Determines if the interface is already scanning or not</p>
 345       </li>
 346
 347       <li>
 348         <h3>ApScan - u - (read/write)</h3>
 349         <p>Identical to ap_scan entry in %wpa_supplicant configuration file. Possible values are 0, 1 or 2.</p>
 350       </li>
 351
 352       <li>
 353         <h3>Ifname - s - (read)</h3>
 354         <p>Name of network interface controlled by the interface, e.g., wlan0.</p>
 355       </li>
 356
 357       <li>
 358         <h3>BridgeIfname - s - (read)</h3>
 359         <p>Name of bridge network interface controlled by the interface, e.g., br0.</p>
 360       </li>
 361
 362       <li>
 363         <h3>Driver - s - (read)</h3>
 364         <p>Name of driver used by the interface, e.g., nl80211.</p>
 365       </li>
 366
 367       <li>
 368         <h3>CurrentBSS - o - (read)</h3>
 369         <p>Path to D-Bus object representing BSS which %wpa_supplicant is associated with, or "/" if is not associated at all.</p>
 370       </li>
 371
 372       <li>
 373         <h3>CurrentNetwork - o - (read)</h3>
 374         <p>Path to D-Bus object representing configured network which %wpa_supplicant uses at the moment, or "/" if doesn't use any.</p>
 375       </li>
 376
 377       <li>
 378         <h3>Blobs - as - (read)</h3>
 379         <p>List of blobs names added to the Interface.</p>
 380       </li>
 381
 382       <li>
 383         <h3>BSSs - ao - (read)</h3>
 384         <p>List of D-Bus objects paths representing BSSs known to the interface, i.e., scan results.</p>
 385       </li>
 386
 387       <li>
 388         <h3>Networks - ao - (read)</h3>
 389         <p>List of D-Bus objects paths representing configured networks.</p>
 390       </li>
 391     </ul>
 392
 393 \subsection dbus_interface_signals Signals
 394
 395     <ul>
 396       <li>
 397         <h3>ScanDone ( b : success )</h3>
 398         <p>Scanning finished. </p>
 399         <h4>Arguments</h4>
 400         <dl>
 401           <dt>s : success</dt>
 402           <dd>Determines if scanning was successful. If so, results are available.</dd>
 403         </dl>
 404       </li>
 405
 406       <li>
 407         <h3>StateChanged ( s : newState, s : oldState )</h3>
 408         <p>Interface state has changed.</p>
 409         <h4>Arguments</h4>
 410         <dl>
 411           <dt>s : newState</dt>
 412           <dd>A state which the interface goes to</dd>
 413           <dt>s : oldState</dt>
 414           <dd>A state which the interface goes from</dd>
 415         </dl>
 416       </li>
 417
 418       <li>
 419         <h3>BSSAdded ( o : BSS, a{sv} : properties )</h3>
 420         <p>Interface became aware of a new BSS.</p>
 421         <h4>Arguments</h4>
 422         <dl>
 423           <dt>o : BSS</dt>
 424           <dd>A D-Bus path to an object representing the new BSS.</dd>
 425         </dl>
 426         <dl>
 427           <dt>a{sv} : properties</dt>
 428           <dd>A dictionary containing properties of added BSS.</dd>
 429         </dl>
 430       </li>
 431
 432       <li>
 433         <h3>BSSRemoved ( o : BSS )</h3>
 434         <p>BSS disappeared.</p>
 435         <h4>Arguments</h4>
 436         <dl>
 437           <dt>o : BSS</dt>
 438           <dd>A D-Bus path to an object representing the BSS.</dd>
 439         </dl>
 440       </li>
 441
 442       <li>
 443         <h3>BlobAdded ( s : blobName )</h3>
 444         <p>A new blob has been added to the interface.</p>
 445         <h4>Arguments</h4>
 446         <dl>
 447           <dt>s : blobName</dt>
 448           <dd>A name of the added blob.</dd>
 449         </dl>
 450       </li>
 451
 452       <li>
 453         <h3>BlobRemoved ( s : blobName )</h3>
 454         <p>A blob has been removed from the interface.</p>
 455         <h4>Arguments</h4>
 456         <dl>
 457           <dt>s : blobName</dt>
 458           <dd>A name of the removed blob.</dd>
 459         </dl>
 460       </li>
 461
 462       <li>
 463         <h3>NetworkAdded ( o : network, a{sv} : properties )</h3>
 464         <p>A new network has been added to the interface.</p>
 465         <h4>Arguments</h4>
 466         <dl>
 467           <dt>o : network</dt>
 468           <dd>A D-Bus path to an object representing the added network.</dd>
 469         </dl>
 470         <dl>
 471           <dt>a{sv} : properties</dt>
 472           <dd>A dictionary containing properties of added network.</dd>
 473         </dl>
 474       </li>
 475
 476       <li>
 477         <h3>NetworkRemoved ( o : network )</h3>
 478         <p>The network has been removed from the interface.</p>
 479         <h4>Arguments</h4>
 480         <dl>
 481           <dt>o : network</dt>
 482           <dd>A D-Bus path to an object representing the removed network.</dd>
 483         </dl>
 484       </li>
 485
 486       <li>
 487         <h3>NetworkSelected ( o : network )</h3>
 488         <p>The network has been selected.</p>
 489         <h4>Arguments</h4>
 490         <dl>
 491           <dt>o : network</dt>
 492           <dd>A D-Bus path to an object representing the selected network.</dd>
 493         </dl>
 494       </li>
 495
 496       <li>
 497         <h3>PropertiesChanged ( a{sv} : properties )</h3>
 498         <p>Some properties have changed.</p>
 499         <h4>Arguments</h4>
 500         <dl>
 501           <dt>a{sv} : properties</dt>
 502           <dd>A dictionary with pairs of properties names which have changed and theirs new values. Possible dictionary keys are: "ApScan", "Scanning", "CurrentBSS", "CurrentNetwork"</dd>
 503         </dl>
 504       </li>
 505     </ul>
 506
 507
 508 \section dbus_wps fi.w1.wpa_supplicant1.Interface.WPS
 509
 510 Interface implemented by objects related to network interface added to
 511 &wpa_supplicant, i.e., returned by fi.w1.wpa_supplicant1.CreateInterface.
 512
 513 \subsection dbus_wps_methods Methods
 514
 515     <ul>
 516       <li>
 517         <h3>Start ( a{sv} : args ) --> a{sv} : output</h3>
 518         <p>Starts WPS configuration.</p>
 519         <h4>Arguments</h4>
 520         <dl>
 521           <dt>a{sv} : args</dt>
 522           <dd>
 523             A dictionary with arguments used to start WPS configuration. The dictionary may contain the following entries:
 524             <table>
 525               <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th>
 526               <tr><td>Role</td><td>s</td><td>The device's role. Possible values are "enrollee" and "registrar".</td><td>Yes</td>
 527               <tr><td>Type</td><td>s</td><td>WPS authentication type. Applies only for enrollee role. Possible values are "pin" and "pbc".</td><td>Yes, for enrollee role; otherwise no</td>
 528               <tr><td>Pin</td><td>s</td><td>WPS Pin.</td><td>Yes, for registrar role; otherwise optional</td>
 529               <tr><td>Bssid</td><td>ay</td><td></td><td>No</td>
 530             </table>
 531           </dd>
 532         </dl>
 533         <h4>Returns</h4>
 534         <dl>
 535           <dt>a{sv} : output</dt>
 536           <dd>
 537             <table>
 538               <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th>
 539               <tr><td>Pin</td><td>s</td><td>Newly generated PIN, if not specified for enrollee role and pin authentication type.</td><td>No</td>
 540             </table>
 541           </dd>
 542         </dl>
 543         <h4>Possible errors</h4>
 544         <dl>
 545           <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
 546           <dd>Starting WPS configuration failed for an unknown reason.</dd>
 547           <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
 548           <dd>Invalid entries were found in the passed argument.</dd>
 549         </dl>
 550       </li>
 551     </ul>
 552
 553 \subsection dbus_wps_properties Properties
 554
 555     <ul>
 556       <li>
 557         <h3>ProcessCredentials - b - (read/write)</h3>
 558         <p>Determines if the interface will process the credentials (credentials_processed configuration file parameter).</p>
 559       </li>
 560     </ul>
 561
 562 \subsection dbus_wps_signals Signals
 563
 564     <ul>
 565       <li>
 566         <h3>Event ( s : name, a{sv} : args )</h3>
 567         <p>WPS event occurred.</p>
 568         <h4>Arguments</h4>
 569         <dl>
 570           <dt>s : event</dt>
 571           <dd>Event type. Possible values are: "success, "fail" and "m2d"</dd>
 572           <dt>a{sv} : args</dt>
 573           <dd>
 574             Event arguments. Empty for success event, one entry ( "msg" : i ) for fail event and following entries for m2d event:
 575             <table>
 576               <tr><th>config_methods</th><th>Value type</th>
 577               <tr><td>manufacturer</td><td>q</td>
 578               <tr><td>model_name</td><td>ay</td>
 579               <tr><td>model_number</td><td>ay</td>
 580               <tr><td>serial_number</td><td>ay</td>
 581               <tr><td>dev_name</td><td>ay</td>
 582               <tr><td>primary_dev_type</td><td>ay</td>
 583               <tr><td>config_error</td><td>q</td>
 584               <tr><td>dev_password_id</td><td>q</td>
 585             </table>
 586           </dd>
 587         </dl>
 588       </li>
 589
 590       <li>
 591         <h3>Credentials ( a{sv} : credentials )</h3>
 592         <p>WPS credentials. Dictionary contains:</p>
 593         <table>
 594           <tr><th>Key</th><th>Value type</th><th>Description</th>
 595           <tr><td>BSSID</td><td>ay</td><td></td>
 596           <tr><td>SSID</td><td>s</td><td></td>
 597           <tr><td>AuthType</td><td>as</td><td>Possible array elements: "open", "shared", "wpa-psk", "wpa-eap", "wpa2-eap", "wpa2-psk"</td>
 598           <tr><td>EncrType</td><td>as</td><td>Possible array elements: "none", "wep", "tkip", "aes"</td>
 599           <tr><td>Key</td><td>ay</td><td>Key data</td>
 600           <tr><td>KeyIndex</td><td>u</td><td>Key index</td>
 601         </table>
 602       </li>
 603
 604       <li>
 605         <h3>PropertiesChanged ( a{sv} : properties )</h3>
 606         <p>Some properties have changed.</p>
 607         <h4>Arguments</h4>
 608         <dl>
 609           <dt>a{sv} : properties</dt>
 610           <dd>A dictionary with pairs of properties names which have changed and theirs new values. Possible dictionary keys are: "ProcessCredentials"</dd>
 611         </dl>
 612       </li>
 613     </ul>
 614
 615
 616 \section dbus_bss fi.w1.wpa_supplicant1.Interface.BSS
 617
 618 Interface implemented by objects representing a scanned BSSs, i.e.,
 619 scan results.
 620
 621 \subsection dbus_bss_properties Properties
 622
 623     <ul>
 624       <li>
 625         <h3>BSSID - ay - (read)</h3>
 626         <p>BSSID of the BSS.</p>
 627       </li>
 628       <li>
 629         <h3>SSID - ay - (read)</h3>
 630         <p>SSID of the BSS.</p>
 631       </li>
 632       <li>
 633         <h3>WPAIE - ay - (read)</h3>
 634         <p>WPA information element of the BSS. The second byte contain number of bytes following it.</p>
 635       </li>
 636       <li>
 637         <h3>RSNIE - ay - (read)</h3>
 638         <p>RSN information element of the BSS. The second byte contain number of bytes following it.</p>
 639       </li>
 640       <li>
 641         <h3>WPSIE - ay - (read)</h3>
 642         <p>WPS information element of the BSS. The second byte contain number of bytes following it.</p>
 643       </li>
 644       <li>
 645         <h3>Privacy - b - (read)</h3>
 646         <p>Indicates if BSS supports privacy.</p>
 647       </li>
 648       <li>
 649         <h3>Mode - s - (read)</h3>
 650         <p>Describes mode of the BSS. Possible values are: "ad-hoc" and "infrastructure".</p>
 651       </li>
 652       <li>
 653         <h3>Frequency - q - (read)</h3>
 654         <p>Frequency of the BSS in MHz.</p>
 655       </li>
 656       <li>
 657         <h3>MaxRate - q - (read)</h3>
 658         <p>Maximal data rate of the BSS in bits per second.</p>
 659       </li>
 660       <li>
 661         <h3>Signal - n - (read)</h3>
 662         <p>Signal strength of the BSS.</p>
 663       </li>
 664     </ul>
 665
 666
 667 \section dbus_network fi.w1.wpa_supplicant1.Interface.Network
 668
 669 Interface implemented by objects representing configured networks,
 670 i.e., returned by fi.w1.wpa_supplicant1.Interface.AddNetwork.
 671
 672 \subsection dbus_network_properties Properties
 673
 674     <ul>
 675       <li>
 676         <h3>Enabled - b - (read/write)</h3>
 677         <p>Determines if the configured network is enabled or not.</p>
 678       </li>
 679
 680       <li>
 681         <h3>Properties - a{sv} - (read)</h3>
 682         <p>Properties of the configured network. Dictionary contains entries from "network" block of %wpa_supplicant configuration file. All values are string type, e.g., frequency is "2437", not 2437.
 683       </li>
 684     </ul>
 685
 686 \subsection dbus_network_signals Signals
 687
 688     <ul>
 689       <li>
 690         <h3>PropertiesChanged ( a{sv} : properties )</h3>
 691         <p>Some properties have changed.</p>
 692         <h4>Arguments</h4>
 693         <dl>
 694           <dt>a{sv} : properties</dt>
 695           <dd>A dictionary with pairs of properties names which have changed and theirs new values. Possible dictionary keys are: "Enabled"</dd>
 696         </dl>
 697       </li>
 698     </ul>
 699
 700 */