tests/hwsim/wpasupplicant.py

   1 # Python class for controlling wpa_supplicant
   2 # Copyright (c) 2013-2014, Jouni Malinen <j@w1.fi>
   3 #
   4 # This software may be distributed under the terms of the BSD license.
   5 # See README for more details.
   6
   7 import os
   8 import time
   9 import logging
  10 import binascii
  11 import re
  12 import struct
  13 import subprocess
  14 import wpaspy
  15
  16 logger = logging.getLogger()
  17 wpas_ctrl = '/var/run/wpa_supplicant'
  18
  19 class WpaSupplicant:
  20     def __init__(self, ifname=None, global_iface=None):
  21         self.group_ifname = None
  22         self.gctrl_mon = None
  23         if ifname:
  24             self.set_ifname(ifname)
  25         else:
  26             self.ifname = None
  27
  28         self.global_iface = global_iface
  29         if global_iface:
  30             self.global_ctrl = wpaspy.Ctrl(global_iface)
  31             self.global_mon = wpaspy.Ctrl(global_iface)
  32             self.global_mon.attach()
  33         else:
  34             self.global_mon = None
  35
  36     def close_ctrl(self):
  37         if self.global_mon:
  38             self.global_mon.detach()
  39             self.global_mon = None
  40             self.global_ctrl = None
  41         self.remove_ifname()
  42
  43     def set_ifname(self, ifname):
  44         self.ifname = ifname
  45         self.ctrl = wpaspy.Ctrl(os.path.join(wpas_ctrl, ifname))
  46         self.mon = wpaspy.Ctrl(os.path.join(wpas_ctrl, ifname))
  47         self.mon.attach()
  48
  49     def remove_ifname(self):
  50         if self.ifname:
  51             self.mon.detach()
  52             self.mon = None
  53             self.ctrl = None
  54             self.ifname = None
  55
  56     def interface_add(self, ifname, config="", driver="nl80211",
  57                       drv_params=None, br_ifname=None, create=False,
  58                       set_ifname=True, all_params=False, if_type=None):
  59         try:
  60             groups = subprocess.check_output(["id"])
  61             group = "admin" if "(admin)" in groups else "adm"
  62         except Exception, e:
  63             group = "admin"
  64         cmd = "INTERFACE_ADD " + ifname + "\t" + config + "\t" + driver + "\tDIR=/var/run/wpa_supplicant GROUP=" + group
  65         if drv_params:
  66             cmd = cmd + '\t' + drv_params
  67         if br_ifname:
  68             if not drv_params:
  69                 cmd += '\t'
  70             cmd += '\t' + br_ifname
  71         if create:
  72             if not br_ifname:
  73                 cmd += '\t'
  74                 if not drv_params:
  75                     cmd += '\t'
  76             cmd += '\tcreate'
  77             if if_type:
  78                 cmd += '\t' + if_type
  79         if all_params and not create:
  80             if not br_ifname:
  81                 cmd += '\t'
  82                 if not drv_params:
  83                     cmd += '\t'
  84             cmd += '\t'
  85         if "FAIL" in self.global_request(cmd):
  86             raise Exception("Failed to add a dynamic wpa_supplicant interface")
  87         if not create and set_ifname:
  88             self.set_ifname(ifname)
  89
  90     def interface_remove(self, ifname):
  91         self.remove_ifname()
  92         self.global_request("INTERFACE_REMOVE " + ifname)
  93
  94     def request(self, cmd, timeout=10):
  95         logger.debug(self.ifname + ": CTRL: " + cmd)
  96         return self.ctrl.request(cmd, timeout=timeout)
  97
  98     def global_request(self, cmd):
  99         if self.global_iface is None:
 100             self.request(cmd)
 101         else:
 102             ifname = self.ifname or self.global_iface
 103             logger.debug(ifname + ": CTRL(global): " + cmd)
 104             return self.global_ctrl.request(cmd)
 105
 106     def group_request(self, cmd):
 107         if self.group_ifname and self.group_ifname != self.ifname:
 108             logger.debug(self.group_ifname + ": CTRL: " + cmd)
 109             gctrl = wpaspy.Ctrl(os.path.join(wpas_ctrl, self.group_ifname))
 110             return gctrl.request(cmd)
 111         return self.request(cmd)
 112
 113     def ping(self):
 114         return "PONG" in self.request("PING")
 115
 116     def global_ping(self):
 117         return "PONG" in self.global_request("PING")
 118
 119     def reset(self):
 120         self.dump_monitor()
 121         res = self.request("FLUSH")
 122         if not "OK" in res:
 123             logger.info("FLUSH to " + self.ifname + " failed: " + res)
 124         self.global_request("REMOVE_NETWORK all")
 125         self.global_request("SET p2p_add_cli_chan 0")
 126         self.global_request("SET p2p_no_go_freq ")
 127         self.global_request("SET p2p_pref_chan ")
 128         self.global_request("SET p2p_no_group_iface 1")
 129         self.global_request("SET p2p_go_intent 7")
 130         self.global_request("P2P_FLUSH")
 131         self.request("SET ignore_old_scan_res 0")
 132         if self.gctrl_mon:
 133             try:
 134                 self.gctrl_mon.detach()
 135             except:
 136                 pass
 137             self.gctrl_mon = None
 138         self.group_ifname = None
 139         self.dump_monitor()
 140
 141         iter = 0
 142         while iter < 60:
 143             state1 = self.get_driver_status_field("scan_state")
 144             p2pdev = "p2p-dev-" + self.ifname
 145             state2 = self.get_driver_status_field("scan_state", ifname=p2pdev)
 146             states = str(state1) + " " + str(state2)
 147             if "SCAN_STARTED" in states or "SCAN_REQUESTED" in states:
 148                 logger.info(self.ifname + ": Waiting for scan operation to complete before continuing")
 149                 time.sleep(1)
 150             else:
 151                 break
 152             iter = iter + 1
 153         if iter == 60:
 154             logger.error(self.ifname + ": Driver scan state did not clear")
 155             print "Trying to clear cfg80211/mac80211 scan state"
 156             try:
 157                 cmd = ["ifconfig", self.ifname, "down"]
 158                 subprocess.call(cmd)
 159             except subprocess.CalledProcessError, e:
 160                 logger.info("ifconfig failed: " + str(e.returncode))
 161                 logger.info(e.output)
 162             try:
 163                 cmd = ["ifconfig", self.ifname, "up"]
 164                 subprocess.call(cmd)
 165             except subprocess.CalledProcessError, e:
 166                 logger.info("ifconfig failed: " + str(e.returncode))
 167                 logger.info(e.output)
 168         if iter > 0:
 169             # The ongoing scan could have discovered BSSes or P2P peers
 170             logger.info("Run FLUSH again since scan was in progress")
 171             self.request("FLUSH")
 172             self.dump_monitor()
 173
 174         if not self.ping():
 175             logger.info("No PING response from " + self.ifname + " after reset")
 176
 177     def add_network(self):
 178         id = self.request("ADD_NETWORK")
 179         if "FAIL" in id:
 180             raise Exception("ADD_NETWORK failed")
 181         return int(id)
 182
 183     def remove_network(self, id):
 184         id = self.request("REMOVE_NETWORK " + str(id))
 185         if "FAIL" in id:
 186             raise Exception("REMOVE_NETWORK failed")
 187         return None
 188
 189     def get_network(self, id, field):
 190         res = self.request("GET_NETWORK " + str(id) + " " + field)
 191         if res == "FAIL\n":
 192             return None
 193         return res
 194
 195     def set_network(self, id, field, value):
 196         res = self.request("SET_NETWORK " + str(id) + " " + field + " " + value)
 197         if "FAIL" in res:
 198             raise Exception("SET_NETWORK failed")
 199         return None
 200
 201     def set_network_quoted(self, id, field, value):
 202         res = self.request("SET_NETWORK " + str(id) + " " + field + ' "' + value + '"')
 203         if "FAIL" in res:
 204             raise Exception("SET_NETWORK failed")
 205         return None
 206
 207     def list_networks(self, p2p=False):
 208         if p2p:
 209             res = self.global_request("LIST_NETWORKS")
 210         else:
 211             res = self.request("LIST_NETWORKS")
 212         lines = res.splitlines()
 213         networks = []
 214         for l in lines:
 215             if "network id" in l:
 216                 continue
 217             [id,ssid,bssid,flags] = l.split('\t')
 218             network = {}
 219             network['id'] = id
 220             network['ssid'] = ssid
 221             network['bssid'] = bssid
 222             network['flags'] = flags
 223             networks.append(network)
 224         return networks
 225
 226     def hs20_enable(self, auto_interworking=False):
 227         self.request("SET interworking 1")
 228         self.request("SET hs20 1")
 229         if auto_interworking:
 230             self.request("SET auto_interworking 1")
 231         else:
 232             self.request("SET auto_interworking 0")
 233
 234     def interworking_add_network(self, bssid):
 235         id = self.request("INTERWORKING_ADD_NETWORK " + bssid)
 236         if "FAIL" in id or "OK" in id:
 237             raise Exception("INTERWORKING_ADD_NETWORK failed")
 238         return int(id)
 239
 240     def add_cred(self):
 241         id = self.request("ADD_CRED")
 242         if "FAIL" in id:
 243             raise Exception("ADD_CRED failed")
 244         return int(id)
 245
 246     def remove_cred(self, id):
 247         id = self.request("REMOVE_CRED " + str(id))
 248         if "FAIL" in id:
 249             raise Exception("REMOVE_CRED failed")
 250         return None
 251
 252     def set_cred(self, id, field, value):
 253         res = self.request("SET_CRED " + str(id) + " " + field + " " + value)
 254         if "FAIL" in res:
 255             raise Exception("SET_CRED failed")
 256         return None
 257
 258     def set_cred_quoted(self, id, field, value):
 259         res = self.request("SET_CRED " + str(id) + " " + field + ' "' + value + '"')
 260         if "FAIL" in res:
 261             raise Exception("SET_CRED failed")
 262         return None
 263
 264     def get_cred(self, id, field):
 265         return self.request("GET_CRED " + str(id) + " " + field)
 266
 267     def add_cred_values(self, params):
 268         id = self.add_cred()
 269
 270         quoted = [ "realm", "username", "password", "domain", "imsi",
 271                    "excluded_ssid", "milenage", "ca_cert", "client_cert",
 272                    "private_key", "domain_suffix_match", "provisioning_sp",
 273                    "roaming_partner", "phase1", "phase2" ]
 274         for field in quoted:
 275             if field in params:
 276                 self.set_cred_quoted(id, field, params[field])
 277
 278         not_quoted = [ "eap", "roaming_consortium", "priority",
 279                        "required_roaming_consortium", "sp_priority",
 280                        "max_bss_load", "update_identifier", "req_conn_capab",
 281                        "min_dl_bandwidth_home", "min_ul_bandwidth_home",
 282                        "min_dl_bandwidth_roaming", "min_ul_bandwidth_roaming" ]
 283         for field in not_quoted:
 284             if field in params:
 285                 self.set_cred(id, field, params[field])
 286
 287         return id;
 288
 289     def select_network(self, id, freq=None):
 290         if freq:
 291             extra = " freq=" + str(freq)
 292         else:
 293             extra = ""
 294         id = self.request("SELECT_NETWORK " + str(id) + extra)
 295         if "FAIL" in id:
 296             raise Exception("SELECT_NETWORK failed")
 297         return None
 298
 299     def mesh_group_add(self, id):
 300         id = self.request("MESH_GROUP_ADD " + str(id))
 301         if "FAIL" in id:
 302             raise Exception("MESH_GROUP_ADD failed")
 303         return None
 304
 305     def mesh_group_remove(self):
 306         id = self.request("MESH_GROUP_REMOVE " + str(self.ifname))
 307         if "FAIL" in id:
 308             raise Exception("MESH_GROUP_REMOVE failed")
 309         return None
 310
 311     def connect_network(self, id, timeout=10):
 312         self.dump_monitor()
 313         self.select_network(id)
 314         self.wait_connected(timeout=timeout)
 315         self.dump_monitor()
 316
 317     def get_status(self, extra=None):
 318         if extra:
 319             extra = "-" + extra
 320         else:
 321             extra = ""
 322         res = self.request("STATUS" + extra)
 323         lines = res.splitlines()
 324         vals = dict()
 325         for l in lines:
 326             try:
 327                 [name,value] = l.split('=', 1)
 328                 vals[name] = value
 329             except ValueError, e:
 330                 logger.info(self.ifname + ": Ignore unexpected STATUS line: " + l)
 331         return vals
 332
 333     def get_status_field(self, field, extra=None):
 334         vals = self.get_status(extra)
 335         if field in vals:
 336             return vals[field]
 337         return None
 338
 339     def get_group_status(self, extra=None):
 340         if extra:
 341             extra = "-" + extra
 342         else:
 343             extra = ""
 344         res = self.group_request("STATUS" + extra)
 345         lines = res.splitlines()
 346         vals = dict()
 347         for l in lines:
 348             try:
 349                 [name,value] = l.split('=', 1)
 350             except ValueError:
 351                 logger.info(self.ifname + ": Ignore unexpected status line: " + l)
 352                 continue
 353             vals[name] = value
 354         return vals
 355
 356     def get_group_status_field(self, field, extra=None):
 357         vals = self.get_group_status(extra)
 358         if field in vals:
 359             return vals[field]
 360         return None
 361
 362     def get_driver_status(self, ifname=None):
 363         if ifname is None:
 364             res = self.request("STATUS-DRIVER")
 365         else:
 366             res = self.global_request("IFNAME=%s STATUS-DRIVER" % ifname)
 367             if res.startswith("FAIL"):
 368                 return dict()
 369         lines = res.splitlines()
 370         vals = dict()
 371         for l in lines:
 372             try:
 373                 [name,value] = l.split('=', 1)
 374             except ValueError:
 375                 logger.info(self.ifname + ": Ignore unexpected status-driver line: " + l)
 376                 continue
 377             vals[name] = value
 378         return vals
 379
 380     def get_driver_status_field(self, field, ifname=None):
 381         vals = self.get_driver_status(ifname)
 382         if field in vals:
 383             return vals[field]
 384         return None
 385
 386     def get_mcc(self):
 387         mcc = int(self.get_driver_status_field('capa.num_multichan_concurrent'))
 388         return 1 if mcc < 2 else mcc
 389
 390     def get_mib(self):
 391         res = self.request("MIB")
 392         lines = res.splitlines()
 393         vals = dict()
 394         for l in lines:
 395             try:
 396                 [name,value] = l.split('=', 1)
 397                 vals[name] = value
 398             except ValueError, e:
 399                 logger.info(self.ifname + ": Ignore unexpected MIB line: " + l)
 400         return vals
 401
 402     def p2p_dev_addr(self):
 403         return self.get_status_field("p2p_device_address")
 404
 405     def p2p_interface_addr(self):
 406         return self.get_group_status_field("address")
 407
 408     def own_addr(self):
 409         try:
 410             res = self.p2p_interface_addr()
 411         except:
 412             res = self.p2p_dev_addr()
 413         return res
 414
 415     def p2p_listen(self):
 416         return self.global_request("P2P_LISTEN")
 417
 418     def p2p_ext_listen(self, period, interval):
 419         return self.global_request("P2P_EXT_LISTEN %d %d" % (period, interval))
 420
 421     def p2p_cancel_ext_listen(self):
 422         return self.global_request("P2P_EXT_LISTEN")
 423
 424     def p2p_find(self, social=False, progressive=False, dev_id=None,
 425                  dev_type=None, delay=None, freq=None):
 426         cmd = "P2P_FIND"
 427         if social:
 428             cmd = cmd + " type=social"
 429         elif progressive:
 430             cmd = cmd + " type=progressive"
 431         if dev_id:
 432             cmd = cmd + " dev_id=" + dev_id
 433         if dev_type:
 434             cmd = cmd + " dev_type=" + dev_type
 435         if delay:
 436             cmd = cmd + " delay=" + str(delay)
 437         if freq:
 438             cmd = cmd + " freq=" + str(freq)
 439         return self.global_request(cmd)
 440
 441     def p2p_stop_find(self):
 442         return self.global_request("P2P_STOP_FIND")
 443
 444     def wps_read_pin(self):
 445         self.pin = self.request("WPS_PIN get").rstrip("\n")
 446         if "FAIL" in self.pin:
 447             raise Exception("Could not generate PIN")
 448         return self.pin
 449
 450     def peer_known(self, peer, full=True):
 451         res = self.global_request("P2P_PEER " + peer)
 452         if peer.lower() not in res.lower():
 453             return False
 454         if not full:
 455             return True
 456         return "[PROBE_REQ_ONLY]" not in res
 457
 458     def discover_peer(self, peer, full=True, timeout=15, social=True,
 459                       force_find=False, freq=None):
 460         logger.info(self.ifname + ": Trying to discover peer " + peer)
 461         if not force_find and self.peer_known(peer, full):
 462             return True
 463         self.p2p_find(social, freq=freq)
 464         count = 0
 465         while count < timeout * 4:
 466             time.sleep(0.25)
 467             count = count + 1
 468             if self.peer_known(peer, full):
 469                 return True
 470         return False
 471
 472     def get_peer(self, peer):
 473         res = self.global_request("P2P_PEER " + peer)
 474         if peer.lower() not in res.lower():
 475             raise Exception("Peer information not available")
 476         lines = res.splitlines()
 477         vals = dict()
 478         for l in lines:
 479             if '=' in l:
 480                 [name,value] = l.split('=', 1)
 481                 vals[name] = value
 482         return vals
 483
 484     def group_form_result(self, ev, expect_failure=False, go_neg_res=None):
 485         if expect_failure:
 486             if "P2P-GROUP-STARTED" in ev:
 487                 raise Exception("Group formation succeeded when expecting failure")
 488             exp = r'<.>(P2P-GO-NEG-FAILURE) status=([0-9]*)'
 489             s = re.split(exp, ev)
 490             if len(s) < 3:
 491                 return None
 492             res = {}
 493             res['result'] = 'go-neg-failed'
 494             res['status'] = int(s[2])
 495             return res
 496
 497         if "P2P-GROUP-STARTED" not in ev:
 498             raise Exception("No P2P-GROUP-STARTED event seen")
 499
 500         exp = r'<.>(P2P-GROUP-STARTED) ([^ ]*) ([^ ]*) ssid="(.*)" freq=([0-9]*) ((?:psk=.*)|(?:passphrase=".*")) go_dev_addr=([0-9a-f:]*) ip_addr=([0-9.]*) ip_mask=([0-9.]*) go_ip_addr=([0-9.]*)'
 501         s = re.split(exp, ev)
 502         if len(s) < 11:
 503             exp = r'<.>(P2P-GROUP-STARTED) ([^ ]*) ([^ ]*) ssid="(.*)" freq=([0-9]*) ((?:psk=.*)|(?:passphrase=".*")) go_dev_addr=([0-9a-f:]*)'
 504             s = re.split(exp, ev)
 505             if len(s) < 8:
 506                 raise Exception("Could not parse P2P-GROUP-STARTED")
 507         res = {}
 508         res['result'] = 'success'
 509         res['ifname'] = s[2]
 510         self.group_ifname = s[2]
 511         try:
 512             self.gctrl_mon = wpaspy.Ctrl(os.path.join(wpas_ctrl, self.group_ifname))
 513             self.gctrl_mon.attach()
 514         except:
 515             logger.debug("Could not open monitor socket for group interface")
 516             self.gctrl_mon = None
 517         res['role'] = s[3]
 518         res['ssid'] = s[4]
 519         res['freq'] = s[5]
 520         if "[PERSISTENT]" in ev:
 521             res['persistent'] = True
 522         else:
 523             res['persistent'] = False
 524         p = re.match(r'psk=([0-9a-f]*)', s[6])
 525         if p:
 526             res['psk'] = p.group(1)
 527         p = re.match(r'passphrase="(.*)"', s[6])
 528         if p:
 529             res['passphrase'] = p.group(1)
 530         res['go_dev_addr'] = s[7]
 531
 532         if len(s) > 8 and len(s[8]) > 0:
 533             res['ip_addr'] = s[8]
 534         if len(s) > 9:
 535             res['ip_mask'] = s[9]
 536         if len(s) > 10:
 537             res['go_ip_addr'] = s[10]
 538
 539         if go_neg_res:
 540             exp = r'<.>(P2P-GO-NEG-SUCCESS) role=(GO|client) freq=([0-9]*)'
 541             s = re.split(exp, go_neg_res)
 542             if len(s) < 4:
 543                 raise Exception("Could not parse P2P-GO-NEG-SUCCESS")
 544             res['go_neg_role'] = s[2]
 545             res['go_neg_freq'] = s[3]
 546
 547         return res
 548
 549     def p2p_go_neg_auth(self, peer, pin, method, go_intent=None,
 550                         persistent=False, freq=None, freq2=None,
 551                         max_oper_chwidth=None, ht40=False, vht=False):
 552         if not self.discover_peer(peer):
 553             raise Exception("Peer " + peer + " not found")
 554         self.dump_monitor()
 555         if pin:
 556             cmd = "P2P_CONNECT " + peer + " " + pin + " " + method + " auth"
 557         else:
 558             cmd = "P2P_CONNECT " + peer + " " + method + " auth"
 559         if go_intent:
 560             cmd = cmd + ' go_intent=' + str(go_intent)
 561         if freq:
 562             cmd = cmd + ' freq=' + str(freq)
 563         if freq2:
 564             cmd = cmd + ' freq2=' + str(freq2)
 565         if max_oper_chwidth:
 566             cmd = cmd + ' max_oper_chwidth=' + str(max_oper_chwidth)
 567         if ht40:
 568             cmd = cmd + ' ht40'
 569         if vht:
 570             cmd = cmd + ' vht'
 571         if persistent:
 572             cmd = cmd + " persistent"
 573         if "OK" in self.global_request(cmd):
 574             return None
 575         raise Exception("P2P_CONNECT (auth) failed")
 576
 577     def p2p_go_neg_auth_result(self, timeout=1, expect_failure=False):
 578         go_neg_res = None
 579         ev = self.wait_global_event(["P2P-GO-NEG-SUCCESS",
 580                                      "P2P-GO-NEG-FAILURE"], timeout);
 581         if ev is None:
 582             if expect_failure:
 583                 return None
 584             raise Exception("Group formation timed out")
 585         if "P2P-GO-NEG-SUCCESS" in ev:
 586             go_neg_res = ev
 587             ev = self.wait_global_event(["P2P-GROUP-STARTED"], timeout);
 588             if ev is None:
 589                 if expect_failure:
 590                     return None
 591                 raise Exception("Group formation timed out")
 592         self.dump_monitor()
 593         return self.group_form_result(ev, expect_failure, go_neg_res)
 594
 595     def p2p_go_neg_init(self, peer, pin, method, timeout=0, go_intent=None,
 596                         expect_failure=False, persistent=False,
 597                         persistent_id=None, freq=None, provdisc=False,
 598                         wait_group=True, freq2=None, max_oper_chwidth=None,
 599                         ht40=False, vht=False):
 600         if not self.discover_peer(peer):
 601             raise Exception("Peer " + peer + " not found")
 602         self.dump_monitor()
 603         if pin:
 604             cmd = "P2P_CONNECT " + peer + " " + pin + " " + method
 605         else:
 606             cmd = "P2P_CONNECT " + peer + " " + method
 607         if go_intent:
 608             cmd = cmd + ' go_intent=' + str(go_intent)
 609         if freq:
 610             cmd = cmd + ' freq=' + str(freq)
 611         if freq2:
 612             cmd = cmd + ' freq2=' + str(freq2)
 613         if max_oper_chwidth:
 614             cmd = cmd + ' max_oper_chwidth=' + str(max_oper_chwidth)
 615         if ht40:
 616             cmd = cmd + ' ht40'
 617         if vht:
 618             cmd = cmd + ' vht'
 619         if persistent:
 620             cmd = cmd + " persistent"
 621         elif persistent_id:
 622             cmd = cmd + " persistent=" + persistent_id
 623         if provdisc:
 624             cmd = cmd + " provdisc"
 625         if "OK" in self.global_request(cmd):
 626             if timeout == 0:
 627                 self.dump_monitor()
 628                 return None
 629             go_neg_res = None
 630             ev = self.wait_global_event(["P2P-GO-NEG-SUCCESS",
 631                                          "P2P-GO-NEG-FAILURE"], timeout)
 632             if ev is None:
 633                 if expect_failure:
 634                     return None
 635                 raise Exception("Group formation timed out")
 636             if "P2P-GO-NEG-SUCCESS" in ev:
 637                 if not wait_group:
 638                     return ev
 639                 go_neg_res = ev
 640                 ev = self.wait_global_event(["P2P-GROUP-STARTED"], timeout)
 641                 if ev is None:
 642                     if expect_failure:
 643                         return None
 644                     raise Exception("Group formation timed out")
 645             self.dump_monitor()
 646             return self.group_form_result(ev, expect_failure, go_neg_res)
 647         raise Exception("P2P_CONNECT failed")
 648
 649     def wait_event(self, events, timeout=10):
 650         start = os.times()[4]
 651         while True:
 652             while self.mon.pending():
 653                 ev = self.mon.recv()
 654                 logger.debug(self.ifname + ": " + ev)
 655                 for event in events:
 656                     if event in ev:
 657                         return ev
 658             now = os.times()[4]
 659             remaining = start + timeout - now
 660             if remaining <= 0:
 661                 break
 662             if not self.mon.pending(timeout=remaining):
 663                 break
 664         return None
 665
 666     def wait_global_event(self, events, timeout):
 667         if self.global_iface is None:
 668             self.wait_event(events, timeout)
 669         else:
 670             start = os.times()[4]
 671             while True:
 672                 while self.global_mon.pending():
 673                     ev = self.global_mon.recv()
 674                     logger.debug(self.ifname + "(global): " + ev)
 675                     for event in events:
 676                         if event in ev:
 677                             return ev
 678                 now = os.times()[4]
 679                 remaining = start + timeout - now
 680                 if remaining <= 0:
 681                     break
 682                 if not self.global_mon.pending(timeout=remaining):
 683                     break
 684         return None
 685
 686     def wait_group_event(self, events, timeout=10):
 687         if self.group_ifname and self.group_ifname != self.ifname:
 688             if self.gctrl_mon is None:
 689                 return None
 690             start = os.times()[4]
 691             while True:
 692                 while self.gctrl_mon.pending():
 693                     ev = self.gctrl_mon.recv()
 694                     logger.debug(self.group_ifname + ": " + ev)
 695                     for event in events:
 696                         if event in ev:
 697                             return ev
 698                 now = os.times()[4]
 699                 remaining = start + timeout - now
 700                 if remaining <= 0:
 701                     break
 702                 if not self.gctrl_mon.pending(timeout=remaining):
 703                     break
 704             return None
 705
 706         return self.wait_event(events, timeout)
 707
 708     def wait_go_ending_session(self):
 709         if self.gctrl_mon:
 710             try:
 711                 self.gctrl_mon.detach()
 712             except:
 713                 pass
 714             self.gctrl_mon = None
 715         ev = self.wait_global_event(["P2P-GROUP-REMOVED"], timeout=3)
 716         if ev is None:
 717             raise Exception("Group removal event timed out")
 718         if "reason=GO_ENDING_SESSION" not in ev:
 719             raise Exception("Unexpected group removal reason")
 720
 721     def dump_monitor(self):
 722         count_iface = 0
 723         count_global = 0
 724         while self.mon.pending():
 725             ev = self.mon.recv()
 726             logger.debug(self.ifname + ": " + ev)
 727             count_iface += 1
 728         while self.global_mon and self.global_mon.pending():
 729             ev = self.global_mon.recv()
 730             logger.debug(self.ifname + "(global): " + ev)
 731             count_global += 1
 732         return (count_iface, count_global)
 733
 734     def remove_group(self, ifname=None):
 735         if self.gctrl_mon:
 736             try:
 737                 self.gctrl_mon.detach()
 738             except:
 739                 pass
 740             self.gctrl_mon = None
 741         if ifname is None:
 742             ifname = self.group_ifname if self.group_ifname else self.ifname
 743         if "OK" not in self.global_request("P2P_GROUP_REMOVE " + ifname):
 744             raise Exception("Group could not be removed")
 745         self.group_ifname = None
 746
 747     def p2p_start_go(self, persistent=None, freq=None, no_event_clear=False):
 748         self.dump_monitor()
 749         cmd = "P2P_GROUP_ADD"
 750         if persistent is None:
 751             pass
 752         elif persistent is True:
 753             cmd = cmd + " persistent"
 754         else:
 755             cmd = cmd + " persistent=" + str(persistent)
 756         if freq:
 757             cmd = cmd + " freq=" + str(freq)
 758         if "OK" in self.global_request(cmd):
 759             ev = self.wait_global_event(["P2P-GROUP-STARTED"], timeout=5)
 760             if ev is None:
 761                 raise Exception("GO start up timed out")
 762             if not no_event_clear:
 763                 self.dump_monitor()
 764             return self.group_form_result(ev)
 765         raise Exception("P2P_GROUP_ADD failed")
 766
 767     def p2p_go_authorize_client(self, pin):
 768         cmd = "WPS_PIN any " + pin
 769         if "FAIL" in self.group_request(cmd):
 770             raise Exception("Failed to authorize client connection on GO")
 771         return None
 772
 773     def p2p_go_authorize_client_pbc(self):
 774         cmd = "WPS_PBC"
 775         if "FAIL" in self.group_request(cmd):
 776             raise Exception("Failed to authorize client connection on GO")
 777         return None
 778
 779     def p2p_connect_group(self, go_addr, pin, timeout=0, social=False,
 780                           freq=None):
 781         self.dump_monitor()
 782         if not self.discover_peer(go_addr, social=social, freq=freq):
 783             if social or not self.discover_peer(go_addr, social=social):
 784                 raise Exception("GO " + go_addr + " not found")
 785         self.dump_monitor()
 786         cmd = "P2P_CONNECT " + go_addr + " " + pin + " join"
 787         if freq:
 788             cmd += " freq=" + str(freq)
 789         if "OK" in self.global_request(cmd):
 790             if timeout == 0:
 791                 self.dump_monitor()
 792                 return None
 793             ev = self.wait_global_event(["P2P-GROUP-STARTED"], timeout)
 794             if ev is None:
 795                 raise Exception("Joining the group timed out")
 796             self.dump_monitor()
 797             return self.group_form_result(ev)
 798         raise Exception("P2P_CONNECT(join) failed")
 799
 800     def tdls_setup(self, peer):
 801         cmd = "TDLS_SETUP " + peer
 802         if "FAIL" in self.group_request(cmd):
 803             raise Exception("Failed to request TDLS setup")
 804         return None
 805
 806     def tdls_teardown(self, peer):
 807         cmd = "TDLS_TEARDOWN " + peer
 808         if "FAIL" in self.group_request(cmd):
 809             raise Exception("Failed to request TDLS teardown")
 810         return None
 811
 812     def tdls_link_status(self, peer):
 813         cmd = "TDLS_LINK_STATUS " + peer
 814         ret = self.group_request(cmd)
 815         if "FAIL" in ret:
 816             raise Exception("Failed to request TDLS link status")
 817         return ret
 818
 819     def tspecs(self):
 820         """Return (tsid, up) tuples representing current tspecs"""
 821         res = self.request("WMM_AC_STATUS")
 822         tspecs = re.findall(r"TSID=(\d+) UP=(\d+)", res)
 823         tspecs = [tuple(map(int, tspec)) for tspec in tspecs]
 824
 825         logger.debug("tspecs: " + str(tspecs))
 826         return tspecs
 827
 828     def add_ts(self, tsid, up, direction="downlink", expect_failure=False,
 829                extra=None):
 830         params = {
 831             "sba": 9000,
 832             "nominal_msdu_size": 1500,
 833             "min_phy_rate": 6000000,
 834             "mean_data_rate": 1500,
 835         }
 836         cmd = "WMM_AC_ADDTS %s tsid=%d up=%d" % (direction, tsid, up)
 837         for (key, value) in params.iteritems():
 838             cmd += " %s=%d" % (key, value)
 839         if extra:
 840             cmd += " " + extra
 841
 842         if self.request(cmd).strip() != "OK":
 843             raise Exception("ADDTS failed (tsid=%d up=%d)" % (tsid, up))
 844
 845         if expect_failure:
 846             ev = self.wait_event(["TSPEC-REQ-FAILED"], timeout=2)
 847             if ev is None:
 848                 raise Exception("ADDTS failed (time out while waiting failure)")
 849             if "tsid=%d" % (tsid) not in ev:
 850                 raise Exception("ADDTS failed (invalid tsid in TSPEC-REQ-FAILED")
 851             return
 852
 853         ev = self.wait_event(["TSPEC-ADDED"], timeout=1)
 854         if ev is None:
 855             raise Exception("ADDTS failed (time out)")
 856         if "tsid=%d" % (tsid) not in ev:
 857             raise Exception("ADDTS failed (invalid tsid in TSPEC-ADDED)")
 858
 859         if not (tsid, up) in self.tspecs():
 860             raise Exception("ADDTS failed (tsid not in tspec list)")
 861
 862     def del_ts(self, tsid):
 863         if self.request("WMM_AC_DELTS %d" % (tsid)).strip() != "OK":
 864             raise Exception("DELTS failed")
 865
 866         ev = self.wait_event(["TSPEC-REMOVED"], timeout=1)
 867         if ev is None:
 868             raise Exception("DELTS failed (time out)")
 869         if "tsid=%d" % (tsid) not in ev:
 870             raise Exception("DELTS failed (invalid tsid in TSPEC-REMOVED)")
 871
 872         tspecs = [(t, u) for (t, u) in self.tspecs() if t == tsid]
 873         if tspecs:
 874             raise Exception("DELTS failed (still in tspec list)")
 875
 876     def connect(self, ssid=None, ssid2=None, **kwargs):
 877         logger.info("Connect STA " + self.ifname + " to AP")
 878         id = self.add_network()
 879         if ssid:
 880             self.set_network_quoted(id, "ssid", ssid)
 881         elif ssid2:
 882             self.set_network(id, "ssid", ssid2)
 883
 884         quoted = [ "psk", "identity", "anonymous_identity", "password",
 885                    "ca_cert", "client_cert", "private_key",
 886                    "private_key_passwd", "ca_cert2", "client_cert2",
 887                    "private_key2", "phase1", "phase2", "domain_suffix_match",
 888                    "altsubject_match", "subject_match", "pac_file", "dh_file",
 889                    "bgscan", "ht_mcs", "id_str", "openssl_ciphers",
 890                    "domain_match" ]
 891         for field in quoted:
 892             if field in kwargs and kwargs[field]:
 893                 self.set_network_quoted(id, field, kwargs[field])
 894
 895         not_quoted = [ "proto", "key_mgmt", "ieee80211w", "pairwise",
 896                        "group", "wep_key0", "wep_key1", "wep_key2", "wep_key3",
 897                        "wep_tx_keyidx", "scan_freq", "freq_list", "eap",
 898                        "eapol_flags", "fragment_size", "scan_ssid", "auth_alg",
 899                        "wpa_ptk_rekey", "disable_ht", "disable_vht", "bssid",
 900                        "disable_max_amsdu", "ampdu_factor", "ampdu_density",
 901                        "disable_ht40", "disable_sgi", "disable_ldpc",
 902                        "ht40_intolerant", "update_identifier", "mac_addr",
 903                        "erp", "bg_scan_period", "bssid_blacklist",
 904                        "bssid_whitelist", "mem_only_psk", "eap_workaround" ]
 905         for field in not_quoted:
 906             if field in kwargs and kwargs[field]:
 907                 self.set_network(id, field, kwargs[field])
 908
 909         if "raw_psk" in kwargs and kwargs['raw_psk']:
 910             self.set_network(id, "psk", kwargs['raw_psk'])
 911         if "password_hex" in kwargs and kwargs['password_hex']:
 912             self.set_network(id, "password", kwargs['password_hex'])
 913         if "peerkey" in kwargs and kwargs['peerkey']:
 914             self.set_network(id, "peerkey", "1")
 915         if "okc" in kwargs and kwargs['okc']:
 916             self.set_network(id, "proactive_key_caching", "1")
 917         if "ocsp" in kwargs and kwargs['ocsp']:
 918             self.set_network(id, "ocsp", str(kwargs['ocsp']))
 919         if "only_add_network" in kwargs and kwargs['only_add_network']:
 920             return id
 921         if "wait_connect" not in kwargs or kwargs['wait_connect']:
 922             if "eap" in kwargs:
 923                 self.connect_network(id, timeout=20)
 924             else:
 925                 self.connect_network(id)
 926         else:
 927             self.dump_monitor()
 928             self.select_network(id)
 929         return id
 930
 931     def scan(self, type=None, freq=None, no_wait=False, only_new=False):
 932         if type:
 933             cmd = "SCAN TYPE=" + type
 934         else:
 935             cmd = "SCAN"
 936         if freq:
 937             cmd = cmd + " freq=" + str(freq)
 938         if only_new:
 939             cmd += " only_new=1"
 940         if not no_wait:
 941             self.dump_monitor()
 942         if not "OK" in self.request(cmd):
 943             raise Exception("Failed to trigger scan")
 944         if no_wait:
 945             return
 946         ev = self.wait_event(["CTRL-EVENT-SCAN-RESULTS"], 15)
 947         if ev is None:
 948             raise Exception("Scan timed out")
 949
 950     def scan_for_bss(self, bssid, freq=None, force_scan=False, only_new=False):
 951         if not force_scan and self.get_bss(bssid) is not None:
 952             return
 953         for i in range(0, 10):
 954             self.scan(freq=freq, type="ONLY", only_new=only_new)
 955             if self.get_bss(bssid) is not None:
 956                 return
 957         raise Exception("Could not find BSS " + bssid + " in scan")
 958
 959     def flush_scan_cache(self, freq=2417):
 960         self.request("BSS_FLUSH 0")
 961         self.scan(freq=freq, only_new=True)
 962         res = self.request("SCAN_RESULTS")
 963         if len(res.splitlines()) > 1:
 964             self.request("BSS_FLUSH 0")
 965             self.scan(freq=2422, only_new=True)
 966             res = self.request("SCAN_RESULTS")
 967             if len(res.splitlines()) > 1:
 968                 logger.info("flush_scan_cache: Could not clear all BSS entries. These remain:\n" + res)
 969
 970     def roam(self, bssid, fail_test=False):
 971         self.dump_monitor()
 972         if "OK" not in self.request("ROAM " + bssid):
 973             raise Exception("ROAM failed")
 974         if fail_test:
 975             ev = self.wait_event(["CTRL-EVENT-CONNECTED"], timeout=1)
 976             if ev is not None:
 977                 raise Exception("Unexpected connection")
 978             self.dump_monitor()
 979             return
 980         self.wait_connected(timeout=10, error="Roaming with the AP timed out")
 981         self.dump_monitor()
 982
 983     def roam_over_ds(self, bssid, fail_test=False):
 984         self.dump_monitor()
 985         if "OK" not in self.request("FT_DS " + bssid):
 986             raise Exception("FT_DS failed")
 987         if fail_test:
 988             ev = self.wait_event(["CTRL-EVENT-CONNECTED"], timeout=1)
 989             if ev is not None:
 990                 raise Exception("Unexpected connection")
 991             self.dump_monitor()
 992             return
 993         self.wait_connected(timeout=10, error="Roaming with the AP timed out")
 994         self.dump_monitor()
 995
 996     def wps_reg(self, bssid, pin, new_ssid=None, key_mgmt=None, cipher=None,
 997                 new_passphrase=None, no_wait=False):
 998         self.dump_monitor()
 999         if new_ssid:
1000             self.request("WPS_REG " + bssid + " " + pin + " " +
1001                          new_ssid.encode("hex") + " " + key_mgmt + " " +
1002                          cipher + " " + new_passphrase.encode("hex"))
1003             if no_wait:
1004                 return
1005             ev = self.wait_event(["WPS-SUCCESS"], timeout=15)
1006         else:
1007             self.request("WPS_REG " + bssid + " " + pin)
1008             if no_wait:
1009                 return
1010             ev = self.wait_event(["WPS-CRED-RECEIVED"], timeout=15)
1011             if ev is None:
1012                 raise Exception("WPS cred timed out")
1013             ev = self.wait_event(["WPS-FAIL"], timeout=15)
1014         if ev is None:
1015             raise Exception("WPS timed out")
1016         self.wait_connected(timeout=15)
1017
1018     def relog(self):
1019         self.global_request("RELOG")
1020
1021     def wait_completed(self, timeout=10):
1022         for i in range(0, timeout * 2):
1023             if self.get_status_field("wpa_state") == "COMPLETED":
1024                 return
1025             time.sleep(0.5)
1026         raise Exception("Timeout while waiting for COMPLETED state")
1027
1028     def get_capability(self, field):
1029         res = self.request("GET_CAPABILITY " + field)
1030         if "FAIL" in res:
1031             return None
1032         return res.split(' ')
1033
1034     def get_bss(self, bssid, ifname=None):
1035         if not ifname or ifname == self.ifname:
1036             res = self.request("BSS " + bssid)
1037         elif ifname == self.group_ifname:
1038             res = self.group_request("BSS " + bssid)
1039         else:
1040             return None
1041
1042         if "FAIL" in res:
1043             return None
1044         lines = res.splitlines()
1045         vals = dict()
1046         for l in lines:
1047             [name,value] = l.split('=', 1)
1048             vals[name] = value
1049         if len(vals) == 0:
1050             return None
1051         return vals
1052
1053     def get_pmksa(self, bssid):
1054         res = self.request("PMKSA")
1055         lines = res.splitlines()
1056         for l in lines:
1057             if bssid not in l:
1058                 continue
1059             vals = dict()
1060             [index,aa,pmkid,expiration,opportunistic] = l.split(' ')
1061             vals['index'] = index
1062             vals['pmkid'] = pmkid
1063             vals['expiration'] = expiration
1064             vals['opportunistic'] = opportunistic
1065             return vals
1066         return None
1067
1068     def get_sta(self, addr, info=None, next=False):
1069         cmd = "STA-NEXT " if next else "STA "
1070         if addr is None:
1071             res = self.request("STA-FIRST")
1072         elif info:
1073             res = self.request(cmd + addr + " " + info)
1074         else:
1075             res = self.request(cmd + addr)
1076         lines = res.splitlines()
1077         vals = dict()
1078         first = True
1079         for l in lines:
1080             if first:
1081                 vals['addr'] = l
1082                 first = False
1083             else:
1084                 [name,value] = l.split('=', 1)
1085                 vals[name] = value
1086         return vals
1087
1088     def mgmt_rx(self, timeout=5):
1089         ev = self.wait_event(["MGMT-RX"], timeout=timeout)
1090         if ev is None:
1091             return None
1092         msg = {}
1093         items = ev.split(' ')
1094         field,val = items[1].split('=')
1095         if field != "freq":
1096             raise Exception("Unexpected MGMT-RX event format: " + ev)
1097         msg['freq'] = val
1098         frame = binascii.unhexlify(items[4])
1099         msg['frame'] = frame
1100
1101         hdr = struct.unpack('<HH6B6B6BH', frame[0:24])
1102         msg['fc'] = hdr[0]
1103         msg['subtype'] = (hdr[0] >> 4) & 0xf
1104         hdr = hdr[1:]
1105         msg['duration'] = hdr[0]
1106         hdr = hdr[1:]
1107         msg['da'] = "%02x:%02x:%02x:%02x:%02x:%02x" % hdr[0:6]
1108         hdr = hdr[6:]
1109         msg['sa'] = "%02x:%02x:%02x:%02x:%02x:%02x" % hdr[0:6]
1110         hdr = hdr[6:]
1111         msg['bssid'] = "%02x:%02x:%02x:%02x:%02x:%02x" % hdr[0:6]
1112         hdr = hdr[6:]
1113         msg['seq_ctrl'] = hdr[0]
1114         msg['payload'] = frame[24:]
1115
1116         return msg
1117
1118     def wait_connected(self, timeout=10, error="Connection timed out"):
1119         ev = self.wait_event(["CTRL-EVENT-CONNECTED"], timeout=timeout)
1120         if ev is None:
1121             raise Exception(error)
1122         return ev
1123
1124     def wait_disconnected(self, timeout=10, error="Disconnection timed out"):
1125         ev = self.wait_event(["CTRL-EVENT-DISCONNECTED"], timeout=timeout)
1126         if ev is None:
1127             raise Exception(error)
1128         return ev
1129
1130     def get_group_ifname(self):
1131         return self.group_ifname if self.group_ifname else self.ifname
1132
1133     def get_config(self):
1134         res = self.request("DUMP")
1135         if res.startswith("FAIL"):
1136             raise Exception("DUMP failed")
1137         lines = res.splitlines()
1138         vals = dict()
1139         for l in lines:
1140             [name,value] = l.split('=', 1)
1141             vals[name] = value
1142         return vals
1143
1144     def asp_provision(self, peer, adv_id, adv_mac, session_id, session_mac,
1145                       method="1000", info="", status=None, cpt=None, role=None):
1146         if status is None:
1147             cmd = "P2P_ASP_PROVISION"
1148             params = "info='%s' method=%s" % (info, method)
1149         else:
1150             cmd = "P2P_ASP_PROVISION_RESP"
1151             params = "status=%d" % status
1152
1153         if role is not None:
1154             params += " role=" + role
1155         if cpt is not None:
1156             params += " cpt=" + cpt
1157
1158         if "OK" not in self.global_request("%s %s adv_id=%s adv_mac=%s session=%d session_mac=%s %s" %
1159                                            (cmd, peer, adv_id, adv_mac, session_id, session_mac, params)):
1160             raise Exception("%s request failed" % cmd)