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