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