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