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