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 - s - (read/write)</h3>
 102         <p>Global %wpa_supplicant debugging level. Possible values are
 103         "msgdump" (verbose debugging), "debug" (debugging),
 104         "info" (informative), "warning" (warnings), and "error" (errors).</p>
 105       </li>
 106
 107       <li>
 108         <h3>DebugTimestamp - b - (read/write)</h3>
 109         <p>Global %wpa_supplicant debugging parameter. Determines if timestamps are shown in debug logs.</p>
 110       </li>
 111
 112       <li>
 113         <h3>DebugShowKeys - b - (read/write)</h3>
 114         <p>Global %wpa_supplicant debugging parameter. Determines if secrets are shown in debug logs.</p>
 115       </li>
 116
 117       <li>
 118         <h3>Interfaces - ao - (read)</h3>
 119         <p>An array with paths to D-Bus objects representing controlled interfaces each.</p>
 120       </li>
 121
 122       <li>
 123         <h3>EapMethods - as - (read)</h3>
 124         <p>An array with supported EAP methods names.</p>
 125       </li>
 126     </ul>
 127
 128 \subsection dbus_main_signals Signals
 129
 130     <ul>
 131       <li>
 132         <h3>InterfaceAdded ( o : interface, a{sv} : properties )</h3>
 133         <p>A new interface was added to %wpa_supplicant.</p>
 134         <h4>Arguments</h4>
 135         <dl>
 136           <dt>o : interface</dt>
 137           <dd>A D-Bus path to an object representing the added interface</dd>
 138         </dl>
 139         <dl>
 140           <dt>a{sv} : properties</dt>
 141           <dd>A dictionary containing properties of added interface.</dd>
 142         </dl>
 143       </li>
 144
 145       <li>
 146         <h3>InterfaceRemoved ( o : interface )</h3>
 147         <p>An interface was removed from %wpa_supplicant.</p>
 148         <h4>Arguments</h4>
 149         <dl>
 150           <dt>o : interface</dt>
 151           <dd>A D-Bus path to an object representing the removed interface</dd>
 152         </dl>
 153       </li>
 154
 155       <li>
 156         <h3>PropertiesChanged ( a{sv} : properties )</h3>
 157         <p>Some properties have changed.</p>
 158         <h4>Arguments</h4>
 159         <dl>
 160           <dt>a{sv} : properties</dt>
 161           <dd>A dictionary with pairs of properties names which have changed and theirs new values. Possible dictionary keys are: "DebugParams"</dd>
 162         </dl>
 163       </li>
 164     </ul>
 165
 166
 167 \section dbus_interface fi.w1.wpa_supplicant1.Interface
 168
 169 Interface implemented by objects related to network interface added to
 170 %wpa_supplicant, i.e., returned by
 171 fi.w1.wpa_supplicant1.CreateInterface.
 172
 173 \subsection dbus_interface_methods Methods
 174
 175     <ul>
 176       <li>
 177         <h3>Scan ( a{sv} : args ) --> nothing</h3>
 178         <p>Triggers a scan.</p>
 179         <h4>Arguments</h4>
 180         <dl>
 181           <dt>a{sv} : args</dt>
 182           <dd>
 183             A dictionary with arguments describing scan type:
 184             <table>
 185               <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th>
 186               <tr><td>Type</td><td>s</td><td>Type of the scan. Possible values: "active", "passive"</td><td>Yes</td>
 187               <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>
 188               <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>
 189               <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>
 190             </table>
 191           </dd>
 192         </dl>
 193         <h4>Possible errors</h4>
 194         <dl>
 195           <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
 196           <dd>Invalid entries were found in the passed argument.</dd>
 197         </dl>
 198       </li>
 199
 200       <li>
 201         <h3>Disconnect ( ) --> nothing</h3>
 202         <p>Disassociates the interface from current network.</p>
 203         <h4>Possible errors</h4>
 204         <dl>
 205           <dt>fi.w1.wpa_supplicant1.NotConnected</dt>
 206           <dd>Interface is not connected to any network.</dd>
 207         </dl>
 208       </li>
 209
 210       <li>
 211         <h3>AddNetwork ( a{sv} : args ) --> o : network</h3>
 212         <p>Adds a new network to the interface.</p>
 213         <h4>Arguments</h4>
 214         <dl>
 215           <dt>a{sv} : args</dt>
 216           <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>
 217         </dl>
 218         <h4>Returns</h4>
 219         <dl>
 220           <dt>o : network</dt>
 221           <dd>A D-Bus path to an object representing a configured network</dd>
 222         </dl>
 223         <h4>Possible errors</h4>
 224         <dl>
 225           <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
 226           <dd>Invalid entries were found in the passed argument.</dd>
 227           <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
 228           <dd>Adding network failed for an unknown reason.</dd>
 229         </dl>
 230       </li>
 231
 232       <li>
 233         <h3>RemoveNetwork ( o : network ) --> nothing</h3>
 234         <p>Removes a configured network from the interface.</p>
 235         <h4>Arguments</h4>
 236         <dl>
 237           <dt>o : network</dt>
 238           <dd>A D-Bus path to an object representing a configured network returned by fi.w1.wpa_supplicant1.Interface.AddNetwork</dd>
 239         </dl>
 240         <h4>Possible errors</h4>
 241         <dl>
 242           <dt>fi.w1.wpa_supplicant1.NetworkUnknown</dt>
 243           <dd>A passed path doesn't point to any network object.</dd>
 244           <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
 245           <dd>A passed path doesn't point to any network object.</dd>
 246           <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
 247           <dd>Removing network failed for an unknown reason.</dd>
 248         </dl>
 249       </li>
 250
 251       <li>
 252         <h3>SelectNetwork ( o : network ) --> nothing</h3>
 253         <p>Attempt association with a configured network.</p>
 254         <h4>Arguments</h4>
 255         <dl>
 256           <dt>o : network</dt>
 257           <dd>A D-Bus path to an object representing a configured network returned by fi.w1.wpa_supplicant1.Interface.AddNetwork</dd>
 258         </dl>
 259         <h4>Possible errors</h4>
 260         <dl>
 261           <dt>fi.w1.wpa_supplicant1.NetworkUnknown</dt>
 262           <dd>A passed path doesn't point to any network object.</dd>
 263           <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
 264           <dd>A passed path doesn't point to any network object.</dd>
 265         </dl>
 266       </li>
 267
 268       <li>
 269         <h3>AddBlob ( s : name, ay : data ) --> nothing</h3>
 270         <p>Adds a blob to the interface.</p>
 271         <h4>Arguments</h4>
 272         <dl>
 273           <dt>s : name</dt>
 274           <dd>A name of a blob</dd>
 275           <dt>ay : data</dt>
 276           <dd>A blob data</dd>
 277         </dl>
 278         <h4>Possible errors</h4>
 279         <dl>
 280           <dt>fi.w1.wpa_supplicant1.BlobExists</dt>
 281           <dd>A blob with the specified name already exists.</dd>
 282         </dl>
 283       </li>
 284
 285       <li>
 286         <h3>RemoveBlob ( s : name ) --> nothing</h3>
 287         <p>Removes the blob from the interface.</p>
 288         <h4>Arguments</h4>
 289         <dl>
 290           <dt>s : name</dt>
 291           <dd>A name of the blob to remove</dd>
 292         </dl>
 293         <h4>Possible errors</h4>
 294         <dl>
 295           <dt>fi.w1.wpa_supplicant1.BlobUnknown</dt>
 296           <dd>A blob with the specified name doesn't exist.</dd>
 297         </dl>
 298       </li>
 299
 300       <li>
 301         <h3>GetBlob ( s : name ) --> ay : data</h3>
 302         <p>Returns the blob data of a previously added blob.</p>
 303         <h4>Arguments</h4>
 304         <dl>
 305           <dt>s : name</dt>
 306           <dd>A name of the blob</dd>
 307         </dl>
 308         <h4>Returns</h4>
 309         <dl>
 310           <dt>ay : data</dt>
 311           <dd>A blob data</dd>
 312         </dl>
 313         <h4>Possible errors</h4>
 314         <dl>
 315           <dt>fi.w1.wpa_supplicant1.BlobUnknown</dt>
 316           <dd>A blob with the specified name doesn't exist.</dd>
 317         </dl>
 318       </li>
 319       <li>
 320         <h3>AutoScan ( s : arg ) --> nothing</h3>
 321         <p>Set autoscan parameters for the interface.</p>
 322         <h4>Arguments</h4>
 323         <dl>
 324           <dt>s : arg</dt>
 325           <dd>Autoscan parameter line or empty to unset autoscan.</dd>
 326         </dl>
 327         <h4>Possible errors</h4>
 328         <dl>
 329           <dt>fi.w1.wpa_supplicant1.NoMemory</dt>
 330           <dd>Needed memory was not possible to get allocated.</dd>
 331           <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
 332           <dd>Invalid entries were found in the passed argument.</dd>
 333         </dl>
 334        </li>
 335     </ul>
 336
 337 \subsection dbus_interface_properties Properties
 338
 339     <ul>
 340       <li>
 341         <h3>Capabilities - a{sv} - (read)</h3>
 342         <p>Capabilities of the interface. Dictionary contains following entries:</p>
 343         <table>
 344           <tr><th>Key</th><th>Value type</th><th>Description</th>
 345           <tr><td>Pairwise</td><td>as</td><td>Possible array elements: "ccmp", "tkip", "none"</td>
 346           <tr><td>Group</td><td>as</td><td>Possible array elements: "ccmp", "tkip", "wep104", "wep40"</td>
 347           <tr><td>KeyMgmt</td><td>as</td><td>Possible array elements: "wpa-psk", "wpa-ft-psk", "wpa-psk-sha256", "wpa-eap", "wpa-ft-eap", "wpa-eap-sha256", "ieee8021x", "wpa-none", "wps", "none"</td>
 348           <tr><td>Protocol</td><td>as</td><td>Possible array elements: "rsn", "wpa"</td>
 349           <tr><td>AuthAlg</td><td>as</td><td>Possible array elements: "open", "shared", "leap"</td>
 350           <tr><td>Scan</td><td>as</td><td>Possible array elements: "active", "passive", "ssid"</td>
 351           <tr><td>Modes</td><td>as</td><td>Possible array elements: "infrastructure", "ad-hoc", "ap"</td>
 352         </table>
 353       </li>
 354
 355       <li>
 356         <h3>State - s - (read)</h3>
 357         <p>A state of the interface. Possible values are: return "disconnected", "inactive", "scanning", "authenticating", "associating", "associated", "4way_handshake", "group_handshake", "completed","unknown".</p>
 358       </li>
 359
 360       <li>
 361         <h3>Scanning - b - (read)</h3>
 362         <p>Determines if the interface is already scanning or not</p>
 363       </li>
 364
 365       <li>
 366         <h3>ApScan - u - (read/write)</h3>
 367         <p>Identical to ap_scan entry in %wpa_supplicant configuration file. Possible values are 0, 1 or 2.</p>
 368       </li>
 369
 370       <li>
 371         <h3>BSSExpireAge - u - (read/write)</h3>
 372         <p>Identical to bss_expiration_age entry in %wpa_supplicant configuration file.</p>
 373       </li>
 374
 375       <li>
 376         <h3>BSSExpireCount - u - (read/write)</h3>
 377         <p>Identical to bss_expiration_scan_count entry in %wpa_supplicant configuration file.</p>
 378       </li>
 379
 380       <li>
 381         <h3>Country - s - (read/write)</h3>
 382         <p>Identical to country entry in %wpa_supplicant configuration file.</p>
 383       </li>
 384
 385       <li>
 386         <h3>Ifname - s - (read)</h3>
 387         <p>Name of network interface controlled by the interface, e.g., wlan0.</p>
 388       </li>
 389
 390       <li>
 391         <h3>BridgeIfname - s - (read)</h3>
 392         <p>Name of bridge network interface controlled by the interface, e.g., br0.</p>
 393       </li>
 394
 395       <li>
 396         <h3>Driver - s - (read)</h3>
 397         <p>Name of driver used by the interface, e.g., nl80211.</p>
 398       </li>
 399
 400       <li>
 401         <h3>CurrentBSS - o - (read)</h3>
 402         <p>Path to D-Bus object representing BSS which %wpa_supplicant is associated with, or "/" if is not associated at all.</p>
 403       </li>
 404
 405       <li>
 406         <h3>CurrentNetwork - o - (read)</h3>
 407         <p>Path to D-Bus object representing configured network which %wpa_supplicant uses at the moment, or "/" if doesn't use any.</p>
 408       </li>
 409
 410       <li>
 411         <h3>Blobs - as - (read)</h3>
 412         <p>List of blobs names added to the Interface.</p>
 413       </li>
 414
 415       <li>
 416         <h3>BSSs - ao - (read)</h3>
 417         <p>List of D-Bus objects paths representing BSSs known to the interface, i.e., scan results.</p>
 418       </li>
 419
 420       <li>
 421         <h3>Networks - ao - (read)</h3>
 422         <p>List of D-Bus objects paths representing configured networks.</p>
 423       </li>
 424
 425       <li>
 426         <h3>FastReauth - b - (read/write)</h3>
 427         <p>Identical to fast_reauth entry in %wpa_supplicant configuration file.</p>
 428       </li>
 429
 430       <li>
 431         <h3>ScanInterval - i - (read/write)</h3>
 432         <p>Time (in seconds) between scans for a suitable AP. Must be >= 0.</p>
 433       </li>
 434     </ul>
 435
 436 \subsection dbus_interface_signals Signals
 437
 438     <ul>
 439       <li>
 440         <h3>ScanDone ( b : success )</h3>
 441         <p>Scanning finished. </p>
 442         <h4>Arguments</h4>
 443         <dl>
 444           <dt>s : success</dt>
 445           <dd>Determines if scanning was successful. If so, results are available.</dd>
 446         </dl>
 447       </li>
 448
 449       <li>
 450         <h3>BSSAdded ( o : BSS, a{sv} : properties )</h3>
 451         <p>Interface became aware of a new BSS.</p>
 452         <h4>Arguments</h4>
 453         <dl>
 454           <dt>o : BSS</dt>
 455           <dd>A D-Bus path to an object representing the new BSS.</dd>
 456         </dl>
 457         <dl>
 458           <dt>a{sv} : properties</dt>
 459           <dd>A dictionary containing properties of added BSS.</dd>
 460         </dl>
 461       </li>
 462
 463       <li>
 464         <h3>BSSRemoved ( o : BSS )</h3>
 465         <p>BSS disappeared.</p>
 466         <h4>Arguments</h4>
 467         <dl>
 468           <dt>o : BSS</dt>
 469           <dd>A D-Bus path to an object representing the BSS.</dd>
 470         </dl>
 471       </li>
 472
 473       <li>
 474         <h3>BlobAdded ( s : blobName )</h3>
 475         <p>A new blob has been added to the interface.</p>
 476         <h4>Arguments</h4>
 477         <dl>
 478           <dt>s : blobName</dt>
 479           <dd>A name of the added blob.</dd>
 480         </dl>
 481       </li>
 482
 483       <li>
 484         <h3>BlobRemoved ( s : blobName )</h3>
 485         <p>A blob has been removed from the interface.</p>
 486         <h4>Arguments</h4>
 487         <dl>
 488           <dt>s : blobName</dt>
 489           <dd>A name of the removed blob.</dd>
 490         </dl>
 491       </li>
 492
 493       <li>
 494         <h3>NetworkAdded ( o : network, a{sv} : properties )</h3>
 495         <p>A new network has been added to the interface.</p>
 496         <h4>Arguments</h4>
 497         <dl>
 498           <dt>o : network</dt>
 499           <dd>A D-Bus path to an object representing the added network.</dd>
 500         </dl>
 501         <dl>
 502           <dt>a{sv} : properties</dt>
 503           <dd>A dictionary containing properties of added network.</dd>
 504         </dl>
 505       </li>
 506
 507       <li>
 508         <h3>NetworkRemoved ( o : network )</h3>
 509         <p>The network has been removed from the interface.</p>
 510         <h4>Arguments</h4>
 511         <dl>
 512           <dt>o : network</dt>
 513           <dd>A D-Bus path to an object representing the removed network.</dd>
 514         </dl>
 515       </li>
 516
 517       <li>
 518         <h3>NetworkSelected ( o : network )</h3>
 519         <p>The network has been selected.</p>
 520         <h4>Arguments</h4>
 521         <dl>
 522           <dt>o : network</dt>
 523           <dd>A D-Bus path to an object representing the selected network.</dd>
 524         </dl>
 525       </li>
 526
 527       <li>
 528         <h3>PropertiesChanged ( a{sv} : properties )</h3>
 529         <p>Some properties have changed.</p>
 530         <h4>Arguments</h4>
 531         <dl>
 532           <dt>a{sv} : properties</dt>
 533           <dd>A dictionary with pairs of properties names which have changed and theirs new values. Possible dictionary keys are: "ApScan", "Scanning", "State", "CurrentBSS", "CurrentNetwork"</dd>
 534         </dl>
 535       </li>
 536     </ul>
 537
 538
 539 \section dbus_wps fi.w1.wpa_supplicant1.Interface.WPS
 540
 541 Interface implemented by objects related to network interface added to
 542 %wpa_supplicant, i.e., returned by fi.w1.wpa_supplicant1.CreateInterface.
 543
 544 \subsection dbus_wps_methods Methods
 545
 546     <ul>
 547       <li>
 548         <h3>Start ( a{sv} : args ) --> a{sv} : output</h3>
 549         <p>Starts WPS configuration.</p>
 550         <h4>Arguments</h4>
 551         <dl>
 552           <dt>a{sv} : args</dt>
 553           <dd>
 554             A dictionary with arguments used to start WPS configuration. The dictionary may contain the following entries:
 555             <table>
 556               <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th>
 557               <tr><td>Role</td><td>s</td><td>The device's role. Possible values are "enrollee" and "registrar".</td><td>Yes</td>
 558               <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>
 559               <tr><td>Pin</td><td>s</td><td>WPS Pin.</td><td>Yes, for registrar role; otherwise optional</td>
 560               <tr><td>Bssid</td><td>ay</td><td></td><td>No</td>
 561             </table>
 562           </dd>
 563         </dl>
 564         <h4>Returns</h4>
 565         <dl>
 566           <dt>a{sv} : output</dt>
 567           <dd>
 568             <table>
 569               <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th>
 570               <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>
 571             </table>
 572           </dd>
 573         </dl>
 574         <h4>Possible errors</h4>
 575         <dl>
 576           <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
 577           <dd>Starting WPS configuration failed for an unknown reason.</dd>
 578           <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
 579           <dd>Invalid entries were found in the passed argument.</dd>
 580         </dl>
 581       </li>
 582     </ul>
 583
 584 \subsection dbus_wps_properties Properties
 585
 586     <ul>
 587       <li>
 588         <h3>ProcessCredentials - b - (read/write)</h3>
 589         <p>Determines if the interface will process the credentials (credentials_processed configuration file parameter).</p>
 590       </li>
 591     </ul>
 592
 593 \subsection dbus_wps_signals Signals
 594
 595     <ul>
 596       <li>
 597         <h3>Event ( s : name, a{sv} : args )</h3>
 598         <p>WPS event occurred.</p>
 599         <h4>Arguments</h4>
 600         <dl>
 601           <dt>s : event</dt>
 602           <dd>Event type. Possible values are: "success, "fail" and "m2d"</dd>
 603           <dt>a{sv} : args</dt>
 604           <dd>
 605             Event arguments. Empty for success event, one entry ( "msg" : i ) for fail event and following entries for m2d event:
 606             <table>
 607               <tr><th>config_methods</th><th>Value type</th>
 608               <tr><td>manufacturer</td><td>q</td>
 609               <tr><td>model_name</td><td>ay</td>
 610               <tr><td>model_number</td><td>ay</td>
 611               <tr><td>serial_number</td><td>ay</td>
 612               <tr><td>dev_name</td><td>ay</td>
 613               <tr><td>primary_dev_type</td><td>ay</td>
 614               <tr><td>config_error</td><td>q</td>
 615               <tr><td>dev_password_id</td><td>q</td>
 616             </table>
 617           </dd>
 618         </dl>
 619       </li>
 620
 621       <li>
 622         <h3>Credentials ( a{sv} : credentials )</h3>
 623         <p>WPS credentials. Dictionary contains:</p>
 624         <table>
 625           <tr><th>Key</th><th>Value type</th><th>Description</th>
 626           <tr><td>BSSID</td><td>ay</td><td></td>
 627           <tr><td>SSID</td><td>s</td><td></td>
 628           <tr><td>AuthType</td><td>as</td><td>Possible array elements: "open", "shared", "wpa-psk", "wpa-eap", "wpa2-eap", "wpa2-psk"</td>
 629           <tr><td>EncrType</td><td>as</td><td>Possible array elements: "none", "wep", "tkip", "aes"</td>
 630           <tr><td>Key</td><td>ay</td><td>Key data</td>
 631           <tr><td>KeyIndex</td><td>u</td><td>Key index</td>
 632         </table>
 633       </li>
 634
 635       <li>
 636         <h3>PropertiesChanged ( a{sv} : properties )</h3>
 637         <p>Some properties have changed.</p>
 638         <h4>Arguments</h4>
 639         <dl>
 640           <dt>a{sv} : properties</dt>
 641           <dd>A dictionary with pairs of properties names which have changed and theirs new values. Possible dictionary keys are: "ProcessCredentials"</dd>
 642         </dl>
 643       </li>
 644     </ul>
 645
 646
 647 \section dbus_bss fi.w1.wpa_supplicant1.BSS
 648
 649 Interface implemented by objects representing a scanned BSSs, i.e.,
 650 scan results.
 651
 652 \subsection dbus_bss_properties Properties
 653
 654     <ul>
 655       <li>
 656         <h3>BSSID - ay - (read)</h3>
 657         <p>BSSID of the BSS.</p>
 658       </li>
 659       <li>
 660         <h3>SSID - ay - (read)</h3>
 661         <p>SSID of the BSS.</p>
 662       </li>
 663       <li>
 664         <h3>WPA - a{sv} - (read)</h3>
 665         <p>WPA information of the BSS. Empty dictionary indicates no WPA support. Dictionary entries are:</p>
 666         <table>
 667           <tr><td>KeyMgmt</td><td>as</td><td>Key management suite. Possible array elements: "wpa-psk", "wpa-eap", "wpa-none"</td>
 668           <tr><td>Pairwise</td><td>as</td><td>Pairwise cipher suites. Possible array elements: "ccmp", "tkip"</td>
 669           <tr><td>Group</td><td>s</td><td>Group cipher suite. Possible values are: "ccmp", "tkip", "wep104", "wep40"</td>
 670         </table>
 671       </li>
 672       <li>
 673         <h3>RSN - a{sv} - (read)</h3>
 674         <p>RSN information of the BSS. Empty dictionary indicates no RSN support. Dictionary entries are:</p>
 675         <table>
 676           <tr><td>KeyMgmt</td><td>as</td><td>Key management suite. Possible array elements: "wpa-psk", "wpa-eap", "wpa-ft-psk", "wpa-ft-eap", "wpa-psk-sha256", "wpa-eap-sha256",</td>
 677           <tr><td>Pairwise</td><td>as</td><td>Pairwise cipher suites. Possible array elements: "ccmp", "tkip"</td>
 678           <tr><td>Group</td><td>s</td><td>Group cipher suite. Possible values are: "ccmp", "tkip", "wep104", "wep40"</td>
 679           <tr><td>MgmtGroup</td><td>s</td><td>Mangement frames cipher suite. Possible values are: "aes128cmac"</td>
 680         </table>
 681       </li>
 682       <li>
 683         <h3>IEs - ay - (read)</h3>
 684         <p>All IEs of the BSS as a chain of TLVs</p>
 685       </li>
 686       <li>
 687         <h3>Privacy - b - (read)</h3>
 688         <p>Indicates if BSS supports privacy.</p>
 689       </li>
 690       <li>
 691         <h3>Mode - s - (read)</h3>
 692         <p>Describes mode of the BSS. Possible values are: "ad-hoc" and "infrastructure".</p>
 693       </li>
 694       <li>
 695         <h3>Frequency - q - (read)</h3>
 696         <p>Frequency of the BSS in MHz.</p>
 697       </li>
 698       <li>
 699         <h3>Rates - au - (read)</h3>
 700         <p>Descending ordered array of rates supported by the BSS in bits per second.</p>
 701       </li>
 702       <li>
 703         <h3>Signal - n - (read)</h3>
 704         <p>Signal strength of the BSS.</p>
 705       </li>
 706     </ul>
 707
 708 \subsection dbus_bss_signals Signals
 709
 710     <ul>
 711       <li>
 712         <h3>PropertiesChanged ( a{sv} : properties )</h3>
 713         <p>Some properties have changed.</p>
 714         <h4>Arguments</h4>
 715         <dl>
 716           <dt>a{sv} : properties</dt>
 717           <dd>A dictionary with pairs of properties names which have changed and theirs new values.</dd>
 718         </dl>
 719       </li>
 720     </ul>
 721
 722
 723 \section dbus_network fi.w1.wpa_supplicant1.Network
 724
 725 Interface implemented by objects representing configured networks,
 726 i.e., returned by fi.w1.wpa_supplicant1.Interface.AddNetwork.
 727
 728 \subsection dbus_network_properties Properties
 729
 730     <ul>
 731       <li>
 732         <h3>Enabled - b - (read/write)</h3>
 733         <p>Determines if the configured network is enabled or not.</p>
 734       </li>
 735
 736       <li>
 737         <h3>Properties - a{sv} - (read)</h3>
 738         <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.
 739       </li>
 740     </ul>
 741
 742 \subsection dbus_network_signals Signals
 743
 744     <ul>
 745       <li>
 746         <h3>PropertiesChanged ( a{sv} : properties )</h3>
 747         <p>Some properties have changed.</p>
 748         <h4>Arguments</h4>
 749         <dl>
 750           <dt>a{sv} : properties</dt>
 751           <dd>A dictionary with pairs of properties names which have changed and theirs new values. Possible dictionary keys are: "Enabled"</dd>
 752         </dl>
 753       </li>
 754     </ul>
 755
 756 */