tests/hwsim/test_ap_hs20.py

   1 # Hotspot 2.0 tests
   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 binascii
   8 import struct
   9 import time
  10 import subprocess
  11 import logging
  12 logger = logging.getLogger()
  13 import os
  14 import os.path
  15 import socket
  16 import subprocess
  17
  18 import hostapd
  19 from wlantest import Wlantest
  20 from wpasupplicant import WpaSupplicant
  21
  22 def hs20_ap_params(ssid="test-hs20"):
  23     params = hostapd.wpa2_params(ssid=ssid)
  24     params['wpa_key_mgmt'] = "WPA-EAP"
  25     params['ieee80211w'] = "1"
  26     params['ieee8021x'] = "1"
  27     params['auth_server_addr'] = "127.0.0.1"
  28     params['auth_server_port'] = "1812"
  29     params['auth_server_shared_secret'] = "radius"
  30     params['interworking'] = "1"
  31     params['access_network_type'] = "14"
  32     params['internet'] = "1"
  33     params['asra'] = "0"
  34     params['esr'] = "0"
  35     params['uesa'] = "0"
  36     params['venue_group'] = "7"
  37     params['venue_type'] = "1"
  38     params['venue_name'] = [ "eng:Example venue", "fin:Esimerkkipaikka" ]
  39     params['roaming_consortium'] = [ "112233", "1020304050", "010203040506",
  40                                      "fedcba" ]
  41     params['domain_name'] = "example.com,another.example.com"
  42     params['nai_realm'] = [ "0,example.com,13[5:6],21[2:4][5:7]",
  43                             "0,another.example.com" ]
  44     params['hs20'] = "1"
  45     params['hs20_wan_metrics'] = "01:8000:1000:80:240:3000"
  46     params['hs20_conn_capab'] = [ "1:0:2", "6:22:1", "17:5060:0" ]
  47     params['hs20_operating_class'] = "5173"
  48     params['anqp_3gpp_cell_net'] = "244,91"
  49     return params
  50
  51 def check_auto_select(dev, bssid):
  52     dev.scan_for_bss(bssid, freq="2412")
  53     dev.request("INTERWORKING_SELECT auto freq=2412")
  54     ev = dev.wait_event(["CTRL-EVENT-CONNECTED"], timeout=15)
  55     if ev is None:
  56         raise Exception("Connection timed out")
  57     if bssid not in ev:
  58         raise Exception("Connected to incorrect network")
  59     dev.request("REMOVE_NETWORK all")
  60
  61 def interworking_select(dev, bssid, type=None, no_match=False, freq=None):
  62     dev.dump_monitor()
  63     if bssid and freq and not no_match:
  64         dev.scan_for_bss(bssid, freq=freq)
  65     freq_extra = " freq=" + freq if freq else ""
  66     dev.request("INTERWORKING_SELECT" + freq_extra)
  67     ev = dev.wait_event(["INTERWORKING-AP", "INTERWORKING-NO-MATCH"],
  68                         timeout=15)
  69     if ev is None:
  70         raise Exception("Network selection timed out");
  71     if no_match:
  72         if "INTERWORKING-NO-MATCH" not in ev:
  73             raise Exception("Unexpected network match")
  74         return
  75     if "INTERWORKING-NO-MATCH" in ev:
  76         logger.info("Matching network not found - try again")
  77         dev.dump_monitor()
  78         dev.request("INTERWORKING_SELECT" + freq_extra)
  79         ev = dev.wait_event(["INTERWORKING-AP", "INTERWORKING-NO-MATCH"],
  80                             timeout=15)
  81         if ev is None:
  82             raise Exception("Network selection timed out");
  83         if "INTERWORKING-NO-MATCH" in ev:
  84             raise Exception("Matching network not found")
  85     if bssid and bssid not in ev:
  86         raise Exception("Unexpected BSSID in match")
  87     if type and "type=" + type not in ev:
  88         raise Exception("Network type not recognized correctly")
  89
  90 def check_sp_type(dev, sp_type):
  91     type = dev.get_status_field("sp_type")
  92     if type is None:
  93         raise Exception("sp_type not available")
  94     if type != sp_type:
  95         raise Exception("sp_type did not indicate home network")
  96
  97 def hlr_auc_gw_available():
  98     if not os.path.exists("/tmp/hlr_auc_gw.sock"):
  99         logger.info("No hlr_auc_gw available");
 100         return False
 101     if not os.path.exists("../../hostapd/hlr_auc_gw"):
 102         logger.info("No hlr_auc_gw available");
 103         return False
 104     return True
 105
 106 def interworking_ext_sim_connect(dev, bssid, method):
 107     dev.request("INTERWORKING_CONNECT " + bssid)
 108     interworking_ext_sim_auth(dev, method)
 109
 110 def interworking_ext_sim_auth(dev, method):
 111     ev = dev.wait_event(["CTRL-EVENT-EAP-METHOD"], timeout=15)
 112     if ev is None:
 113         raise Exception("Network connected timed out")
 114     if "(" + method + ")" not in ev:
 115         raise Exception("Unexpected EAP method selection")
 116
 117     ev = dev.wait_event(["CTRL-REQ-SIM"], timeout=15)
 118     if ev is None:
 119         raise Exception("Wait for external SIM processing request timed out")
 120     p = ev.split(':', 2)
 121     if p[1] != "GSM-AUTH":
 122         raise Exception("Unexpected CTRL-REQ-SIM type")
 123     id = p[0].split('-')[3]
 124     rand = p[2].split(' ')[0]
 125
 126     res = subprocess.check_output(["../../hostapd/hlr_auc_gw",
 127                                    "-m",
 128                                    "auth_serv/hlr_auc_gw.milenage_db",
 129                                    "GSM-AUTH-REQ 232010000000000 " + rand])
 130     if "GSM-AUTH-RESP" not in res:
 131         raise Exception("Unexpected hlr_auc_gw response")
 132     resp = res.split(' ')[2].rstrip()
 133
 134     dev.request("CTRL-RSP-SIM-" + id + ":GSM-AUTH:" + resp)
 135     ev = dev.wait_event(["CTRL-EVENT-CONNECTED"], timeout=15)
 136     if ev is None:
 137         raise Exception("Connection timed out")
 138
 139 def interworking_connect(dev, bssid, method):
 140     dev.request("INTERWORKING_CONNECT " + bssid)
 141     interworking_auth(dev, method)
 142
 143 def interworking_auth(dev, method):
 144     ev = dev.wait_event(["CTRL-EVENT-EAP-METHOD"], timeout=15)
 145     if ev is None:
 146         raise Exception("Network connected timed out")
 147     if "(" + method + ")" not in ev:
 148         raise Exception("Unexpected EAP method selection")
 149
 150     ev = dev.wait_event(["CTRL-EVENT-CONNECTED"], timeout=15)
 151     if ev is None:
 152         raise Exception("Connection timed out")
 153
 154 def check_probe_resp(wt, bssid_unexpected, bssid_expected):
 155     if bssid_unexpected:
 156         count = wt.get_bss_counter("probe_response", bssid_unexpected)
 157         if count > 0:
 158             raise Exception("Unexpected Probe Response frame from AP")
 159
 160     if bssid_expected:
 161         count = wt.get_bss_counter("probe_response", bssid_expected)
 162         if count == 0:
 163             raise Exception("No Probe Response frame from AP")
 164
 165 def test_ap_anqp_sharing(dev, apdev):
 166     """ANQP sharing within ESS and explicit unshare"""
 167     bssid = apdev[0]['bssid']
 168     params = hs20_ap_params()
 169     params['hessid'] = bssid
 170     hostapd.add_ap(apdev[0]['ifname'], params)
 171
 172     bssid2 = apdev[1]['bssid']
 173     params = hs20_ap_params()
 174     params['hessid'] = bssid
 175     params['nai_realm'] = [ "0,example.com,13[5:6],21[2:4][5:7]" ]
 176     hostapd.add_ap(apdev[1]['ifname'], params)
 177
 178     dev[0].hs20_enable()
 179     id = dev[0].add_cred_values({ 'realm': "example.com", 'username': "test",
 180                                   'password': "secret",
 181                                   'domain': "example.com" })
 182     logger.info("Normal network selection with shared ANQP results")
 183     dev[0].scan_for_bss(bssid, freq="2412")
 184     dev[0].scan_for_bss(bssid2, freq="2412")
 185     interworking_select(dev[0], None, "home", freq="2412")
 186     dev[0].dump_monitor()
 187
 188     res1 = dev[0].get_bss(bssid)
 189     res2 = dev[0].get_bss(bssid2)
 190     if res1['anqp_nai_realm'] != res2['anqp_nai_realm']:
 191         raise Exception("ANQP results were not shared between BSSes")
 192
 193     logger.info("Explicit ANQP request to unshare ANQP results")
 194     dev[0].request("ANQP_GET " + bssid + " 263")
 195     ev = dev[0].wait_event(["RX-ANQP"], timeout=5)
 196     if ev is None:
 197         raise Exception("ANQP operation timed out")
 198
 199     dev[0].request("ANQP_GET " + bssid2 + " 263")
 200     ev = dev[0].wait_event(["RX-ANQP"], timeout=5)
 201     if ev is None:
 202         raise Exception("ANQP operation timed out")
 203
 204     res1 = dev[0].get_bss(bssid)
 205     res2 = dev[0].get_bss(bssid2)
 206     if res1['anqp_nai_realm'] == res2['anqp_nai_realm']:
 207         raise Exception("ANQP results were not unshared")
 208
 209 def test_ap_nai_home_realm_query(dev, apdev):
 210     """NAI Home Realm Query"""
 211     bssid = apdev[0]['bssid']
 212     params = hs20_ap_params()
 213     params['nai_realm'] = [ "0,example.com,13[5:6],21[2:4][5:7]",
 214                             "0,another.example.org" ]
 215     hostapd.add_ap(apdev[0]['ifname'], params)
 216
 217     dev[0].scan(freq="2412")
 218     dev[0].request("HS20_GET_NAI_HOME_REALM_LIST " + bssid + " realm=example.com")
 219     ev = dev[0].wait_event(["RX-ANQP"], timeout=5)
 220     if ev is None:
 221         raise Exception("ANQP operation timed out")
 222     nai1 = dev[0].get_bss(bssid)['anqp_nai_realm']
 223     dev[0].dump_monitor()
 224
 225     dev[0].request("ANQP_GET " + bssid + " 263")
 226     ev = dev[0].wait_event(["RX-ANQP"], timeout=5)
 227     if ev is None:
 228         raise Exception("ANQP operation timed out")
 229     nai2 = dev[0].get_bss(bssid)['anqp_nai_realm']
 230
 231     if len(nai1) >= len(nai2):
 232         raise Exception("Unexpected NAI Realm list response lengths")
 233     if "example.com".encode('hex') not in nai1:
 234         raise Exception("Home realm not reported")
 235     if "example.org".encode('hex') in nai1:
 236         raise Exception("Non-home realm reported")
 237     if "example.com".encode('hex') not in nai2:
 238         raise Exception("Home realm not reported in wildcard query")
 239     if "example.org".encode('hex') not in nai2:
 240         raise Exception("Non-home realm not reported in wildcard query ")
 241
 242     cmds = [ "foo",
 243              "00:11:22:33:44:55 123",
 244              "00:11:22:33:44:55 qq" ]
 245     for cmd in cmds:
 246         if "FAIL" not in dev[0].request("HS20_GET_NAI_HOME_REALM_LIST " + cmd):
 247             raise Exception("Invalid HS20_GET_NAI_HOME_REALM_LIST accepted: " + cmd)
 248
 249     dev[0].dump_monitor()
 250     if "OK" not in dev[0].request("HS20_GET_NAI_HOME_REALM_LIST " + bssid):
 251         raise Exception("HS20_GET_NAI_HOME_REALM_LIST failed")
 252     ev = dev[0].wait_event(["GAS-QUERY-DONE"], timeout=10)
 253     if ev is None:
 254         raise Exception("ANQP operation timed out")
 255     ev = dev[0].wait_event(["RX-ANQP"], timeout=0.1)
 256     if ev is not None:
 257         raise Exception("Unexpected ANQP response: " + ev)
 258
 259     dev[0].dump_monitor()
 260     if "OK" not in dev[0].request("HS20_GET_NAI_HOME_REALM_LIST " + bssid + " 01000b6578616d706c652e636f6d"):
 261         raise Exception("HS20_GET_NAI_HOME_REALM_LIST failed")
 262     ev = dev[0].wait_event(["RX-ANQP"], timeout=10)
 263     if ev is None:
 264         raise Exception("No ANQP response")
 265     if "NAI Realm list" not in ev:
 266         raise Exception("Missing NAI Realm list: " + ev)
 267
 268     dev[0].add_cred_values({ 'realm': "example.com", 'username': "test",
 269                              'password': "secret",
 270                              'domain': "example.com" })
 271     dev[0].dump_monitor()
 272     if "OK" not in dev[0].request("HS20_GET_NAI_HOME_REALM_LIST " + bssid):
 273         raise Exception("HS20_GET_NAI_HOME_REALM_LIST failed")
 274     ev = dev[0].wait_event(["RX-ANQP"], timeout=10)
 275     if ev is None:
 276         raise Exception("No ANQP response")
 277     if "NAI Realm list" not in ev:
 278         raise Exception("Missing NAI Realm list: " + ev)
 279
 280 def test_ap_interworking_scan_filtering(dev, apdev):
 281     """Interworking scan filtering with HESSID and access network type"""
 282     try:
 283         return _test_ap_interworking_scan_filtering(dev, apdev)
 284     finally:
 285         dev[0].request("SET hessid 00:00:00:00:00:00")
 286         dev[0].request("SET access_network_type 15")
 287
 288 def _test_ap_interworking_scan_filtering(dev, apdev):
 289     bssid = apdev[0]['bssid']
 290     params = hs20_ap_params()
 291     ssid = "test-hs20-ap1"
 292     params['ssid'] = ssid
 293     params['hessid'] = bssid
 294     hostapd.add_ap(apdev[0]['ifname'], params)
 295
 296     bssid2 = apdev[1]['bssid']
 297     params = hs20_ap_params()
 298     ssid2 = "test-hs20-ap2"
 299     params['ssid'] = ssid2
 300     params['hessid'] = bssid2
 301     params['access_network_type'] = "1"
 302     del params['venue_group']
 303     del params['venue_type']
 304     hostapd.add_ap(apdev[1]['ifname'], params)
 305
 306     dev[0].hs20_enable()
 307
 308     wt = Wlantest()
 309     wt.flush()
 310
 311     logger.info("Check probe request filtering based on HESSID")
 312
 313     dev[0].request("SET hessid " + bssid2)
 314     dev[0].scan(freq="2412")
 315     time.sleep(0.03)
 316     check_probe_resp(wt, bssid, bssid2)
 317
 318     logger.info("Check probe request filtering based on access network type")
 319
 320     wt.clear_bss_counters(bssid)
 321     wt.clear_bss_counters(bssid2)
 322     dev[0].request("SET hessid 00:00:00:00:00:00")
 323     dev[0].request("SET access_network_type 14")
 324     dev[0].scan(freq="2412")
 325     time.sleep(0.03)
 326     check_probe_resp(wt, bssid2, bssid)
 327
 328     wt.clear_bss_counters(bssid)
 329     wt.clear_bss_counters(bssid2)
 330     dev[0].request("SET hessid 00:00:00:00:00:00")
 331     dev[0].request("SET access_network_type 1")
 332     dev[0].scan(freq="2412")
 333     time.sleep(0.03)
 334     check_probe_resp(wt, bssid, bssid2)
 335
 336     logger.info("Check probe request filtering based on HESSID and ANT")
 337
 338     wt.clear_bss_counters(bssid)
 339     wt.clear_bss_counters(bssid2)
 340     dev[0].request("SET hessid " + bssid)
 341     dev[0].request("SET access_network_type 14")
 342     dev[0].scan(freq="2412")
 343     time.sleep(0.03)
 344     check_probe_resp(wt, bssid2, bssid)
 345
 346     wt.clear_bss_counters(bssid)
 347     wt.clear_bss_counters(bssid2)
 348     dev[0].request("SET hessid " + bssid2)
 349     dev[0].request("SET access_network_type 14")
 350     dev[0].scan(freq="2412")
 351     time.sleep(0.03)
 352     check_probe_resp(wt, bssid, None)
 353     check_probe_resp(wt, bssid2, None)
 354
 355     wt.clear_bss_counters(bssid)
 356     wt.clear_bss_counters(bssid2)
 357     dev[0].request("SET hessid " + bssid)
 358     dev[0].request("SET access_network_type 1")
 359     dev[0].scan(freq="2412")
 360     time.sleep(0.03)
 361     check_probe_resp(wt, bssid, None)
 362     check_probe_resp(wt, bssid2, None)
 363
 364 def test_ap_hs20_select(dev, apdev):
 365     """Hotspot 2.0 network selection"""
 366     bssid = apdev[0]['bssid']
 367     params = hs20_ap_params()
 368     params['hessid'] = bssid
 369     hostapd.add_ap(apdev[0]['ifname'], params)
 370
 371     dev[0].hs20_enable()
 372     id = dev[0].add_cred_values({ 'realm': "example.com", 'username': "test",
 373                                   'password': "secret",
 374                                   'domain': "example.com" })
 375     interworking_select(dev[0], bssid, "home")
 376
 377     dev[0].remove_cred(id)
 378     id = dev[0].add_cred_values({ 'realm': "example.com", 'username': "test",
 379                                   'password': "secret",
 380                                   'domain': "no.match.example.com" })
 381     interworking_select(dev[0], bssid, "roaming", freq="2412")
 382
 383     dev[0].set_cred_quoted(id, "realm", "no.match.example.com");
 384     interworking_select(dev[0], bssid, no_match=True, freq="2412")
 385
 386     res = dev[0].request("SCAN_RESULTS")
 387     if "[HS20]" not in res:
 388         raise Exception("HS20 flag missing from scan results: " + res)
 389
 390     bssid2 = apdev[1]['bssid']
 391     params = hs20_ap_params()
 392     params['nai_realm'] = [ "0,example.org,21" ]
 393     params['hessid'] = bssid2
 394     params['domain_name'] = "example.org"
 395     hostapd.add_ap(apdev[1]['ifname'], params)
 396     dev[0].remove_cred(id)
 397     id = dev[0].add_cred_values({ 'realm': "example.org", 'username': "test",
 398                                   'password': "secret",
 399                                   'domain': "example.org" })
 400     interworking_select(dev[0], bssid2, "home", freq="2412")
 401
 402 def hs20_simulated_sim(dev, ap, method):
 403     bssid = ap['bssid']
 404     params = hs20_ap_params()
 405     params['hessid'] = bssid
 406     params['anqp_3gpp_cell_net'] = "555,444"
 407     params['domain_name'] = "wlan.mnc444.mcc555.3gppnetwork.org"
 408     hostapd.add_ap(ap['ifname'], params)
 409
 410     dev.hs20_enable()
 411     dev.add_cred_values({ 'imsi': "555444-333222111", 'eap': method,
 412                           'milenage': "5122250214c33e723a5dd523fc145fc0:981d464c7c52eb6e5036234984ad0bcf:000000000123"})
 413     interworking_select(dev, "home", freq="2412")
 414     interworking_connect(dev, bssid, method)
 415     check_sp_type(dev, "home")
 416
 417 def test_ap_hs20_sim(dev, apdev):
 418     """Hotspot 2.0 with simulated SIM and EAP-SIM"""
 419     if not hlr_auc_gw_available():
 420         return "skip"
 421     hs20_simulated_sim(dev[0], apdev[0], "SIM")
 422     dev[0].request("INTERWORKING_SELECT auto freq=2412")
 423     ev = dev[0].wait_event(["INTERWORKING-ALREADY-CONNECTED"], timeout=15)
 424     if ev is None:
 425         raise Exception("Timeout on already-connected event")
 426
 427 def test_ap_hs20_aka(dev, apdev):
 428     """Hotspot 2.0 with simulated USIM and EAP-AKA"""
 429     if not hlr_auc_gw_available():
 430         return "skip"
 431     hs20_simulated_sim(dev[0], apdev[0], "AKA")
 432
 433 def test_ap_hs20_aka_prime(dev, apdev):
 434     """Hotspot 2.0 with simulated USIM and EAP-AKA'"""
 435     if not hlr_auc_gw_available():
 436         return "skip"
 437     hs20_simulated_sim(dev[0], apdev[0], "AKA'")
 438
 439 def test_ap_hs20_ext_sim(dev, apdev):
 440     """Hotspot 2.0 with external SIM processing"""
 441     if not hlr_auc_gw_available():
 442         return "skip"
 443     bssid = apdev[0]['bssid']
 444     params = hs20_ap_params()
 445     params['hessid'] = bssid
 446     params['anqp_3gpp_cell_net'] = "232,01"
 447     params['domain_name'] = "wlan.mnc001.mcc232.3gppnetwork.org"
 448     hostapd.add_ap(apdev[0]['ifname'], params)
 449
 450     dev[0].hs20_enable()
 451     try:
 452         dev[0].request("SET external_sim 1")
 453         dev[0].add_cred_values({ 'imsi': "23201-0000000000", 'eap': "SIM" })
 454         interworking_select(dev[0], "home", freq="2412")
 455         interworking_ext_sim_connect(dev[0], bssid, "SIM")
 456         check_sp_type(dev[0], "home")
 457     finally:
 458         dev[0].request("SET external_sim 0")
 459
 460 def test_ap_hs20_ext_sim_roaming(dev, apdev):
 461     """Hotspot 2.0 with external SIM processing in roaming network"""
 462     if not hlr_auc_gw_available():
 463         return "skip"
 464     bssid = apdev[0]['bssid']
 465     params = hs20_ap_params()
 466     params['hessid'] = bssid
 467     params['anqp_3gpp_cell_net'] = "244,91;310,026;232,01;234,56"
 468     params['domain_name'] = "wlan.mnc091.mcc244.3gppnetwork.org"
 469     hostapd.add_ap(apdev[0]['ifname'], params)
 470
 471     dev[0].hs20_enable()
 472     try:
 473         dev[0].request("SET external_sim 1")
 474         dev[0].add_cred_values({ 'imsi': "23201-0000000000", 'eap': "SIM" })
 475         interworking_select(dev[0], "roaming", freq="2412")
 476         interworking_ext_sim_connect(dev[0], bssid, "SIM")
 477         check_sp_type(dev[0], "roaming")
 478     finally:
 479         dev[0].request("SET external_sim 0")
 480
 481 def test_ap_hs20_username(dev, apdev):
 482     """Hotspot 2.0 connection in username/password credential"""
 483     bssid = apdev[0]['bssid']
 484     params = hs20_ap_params()
 485     params['hessid'] = bssid
 486     params['disable_dgaf'] = '1'
 487     hostapd.add_ap(apdev[0]['ifname'], params)
 488
 489     dev[0].hs20_enable()
 490     id = dev[0].add_cred_values({ 'realm': "example.com",
 491                                   'username': "hs20-test",
 492                                   'password': "password",
 493                                   'ca_cert': "auth_serv/ca.pem",
 494                                   'domain': "example.com",
 495                                   'update_identifier': "1234" })
 496     interworking_select(dev[0], bssid, "home", freq="2412")
 497     interworking_connect(dev[0], bssid, "TTLS")
 498     check_sp_type(dev[0], "home")
 499     status = dev[0].get_status()
 500     if status['pairwise_cipher'] != "CCMP":
 501         raise Exception("Unexpected pairwise cipher")
 502     if status['hs20'] != "2":
 503         raise Exception("Unexpected HS 2.0 support indication")
 504
 505     dev[1].connect("test-hs20", key_mgmt="WPA-EAP", eap="TTLS",
 506                    identity="hs20-test", password="password",
 507                    ca_cert="auth_serv/ca.pem", phase2="auth=MSCHAPV2",
 508                    scan_freq="2412")
 509
 510 def test_ap_hs20_connect_api(dev, apdev):
 511     """Hotspot 2.0 connection with connect API"""
 512     bssid = apdev[0]['bssid']
 513     params = hs20_ap_params()
 514     params['hessid'] = bssid
 515     params['disable_dgaf'] = '1'
 516     hostapd.add_ap(apdev[0]['ifname'], params)
 517
 518     wpas = WpaSupplicant(global_iface='/tmp/wpas-wlan5')
 519     wpas.interface_add("wlan5", drv_params="force_connect_cmd=1")
 520     wpas.hs20_enable()
 521     wpas.flush_scan_cache()
 522     id = wpas.add_cred_values({ 'realm': "example.com",
 523                                   'username': "hs20-test",
 524                                   'password': "password",
 525                                   'ca_cert': "auth_serv/ca.pem",
 526                                   'domain': "example.com",
 527                                   'update_identifier': "1234" })
 528     interworking_select(wpas, bssid, "home", freq="2412")
 529     interworking_connect(wpas, bssid, "TTLS")
 530     check_sp_type(wpas, "home")
 531     status = wpas.get_status()
 532     if status['pairwise_cipher'] != "CCMP":
 533         raise Exception("Unexpected pairwise cipher")
 534     if status['hs20'] != "2":
 535         raise Exception("Unexpected HS 2.0 support indication")
 536
 537 def test_ap_hs20_auto_interworking(dev, apdev):
 538     """Hotspot 2.0 connection with auto_interworking=1"""
 539     bssid = apdev[0]['bssid']
 540     params = hs20_ap_params()
 541     params['hessid'] = bssid
 542     params['disable_dgaf'] = '1'
 543     hostapd.add_ap(apdev[0]['ifname'], params)
 544
 545     dev[0].hs20_enable(auto_interworking=True)
 546     id = dev[0].add_cred_values({ 'realm': "example.com",
 547                                   'username': "hs20-test",
 548                                   'password': "password",
 549                                   'ca_cert': "auth_serv/ca.pem",
 550                                   'domain': "example.com",
 551                                   'update_identifier': "1234" })
 552     dev[0].request("REASSOCIATE")
 553     ev = dev[0].wait_event(["CTRL-EVENT-CONNECTED"], timeout=15)
 554     if ev is None:
 555         raise Exception("Connection timed out")
 556     check_sp_type(dev[0], "home")
 557     status = dev[0].get_status()
 558     if status['pairwise_cipher'] != "CCMP":
 559         raise Exception("Unexpected pairwise cipher")
 560     if status['hs20'] != "2":
 561         raise Exception("Unexpected HS 2.0 support indication")
 562
 563 def test_ap_hs20_auto_interworking_no_cred_match(dev, apdev):
 564     """Hotspot 2.0 connection with auto_interworking=1 but no cred match"""
 565     bssid = apdev[0]['bssid']
 566     params = { "ssid": "test" }
 567     hostapd.add_ap(apdev[0]['ifname'], params)
 568
 569     dev[0].hs20_enable(auto_interworking=True)
 570     dev[0].add_cred_values({ 'realm': "example.com",
 571                              'username': "hs20-test",
 572                              'password': "password",
 573                              'ca_cert': "auth_serv/ca.pem",
 574                              'domain': "example.com" })
 575
 576     id = dev[0].connect("test", psk="12345678", only_add_network=True)
 577     dev[0].request("ENABLE_NETWORK %s" % id)
 578     logger.info("Verify that scanning continues when there is partial network block match")
 579     for i in range(0, 2):
 580         ev = dev[0].wait_event(["CTRL-EVENT-SCAN-RESULTS"], 10)
 581         if ev is None:
 582             raise Exception("Scan timed out")
 583         logger.info("Scan completed")
 584
 585 def eap_test(dev, ap, eap_params, method, user):
 586     bssid = ap['bssid']
 587     params = hs20_ap_params()
 588     params['nai_realm'] = [ "0,example.com," + eap_params ]
 589     hostapd.add_ap(ap['ifname'], params)
 590
 591     dev.hs20_enable()
 592     dev.add_cred_values({ 'realm': "example.com",
 593                           'username': user,
 594                           'password': "password" })
 595     interworking_select(dev, bssid, freq="2412")
 596     interworking_connect(dev, bssid, method)
 597
 598 def test_ap_hs20_eap_unknown(dev, apdev):
 599     """Hotspot 2.0 connection with unknown EAP method"""
 600     bssid = apdev[0]['bssid']
 601     params = hs20_ap_params()
 602     params['nai_realm'] = "0,example.com,99"
 603     hostapd.add_ap(apdev[0]['ifname'], params)
 604
 605     dev[0].hs20_enable()
 606     dev[0].add_cred_values(default_cred())
 607     interworking_select(dev[0], None, no_match=True, freq="2412")
 608
 609 def test_ap_hs20_eap_peap_mschapv2(dev, apdev):
 610     """Hotspot 2.0 connection with PEAP/MSCHAPV2"""
 611     eap_test(dev[0], apdev[0], "25[3:26]", "PEAP", "user")
 612
 613 def test_ap_hs20_eap_peap_default(dev, apdev):
 614     """Hotspot 2.0 connection with PEAP/MSCHAPV2 (as default)"""
 615     eap_test(dev[0], apdev[0], "25", "PEAP", "user")
 616
 617 def test_ap_hs20_eap_peap_gtc(dev, apdev):
 618     """Hotspot 2.0 connection with PEAP/GTC"""
 619     eap_test(dev[0], apdev[0], "25[3:6]", "PEAP", "user")
 620
 621 def test_ap_hs20_eap_peap_unknown(dev, apdev):
 622     """Hotspot 2.0 connection with PEAP/unknown"""
 623     bssid = apdev[0]['bssid']
 624     params = hs20_ap_params()
 625     params['nai_realm'] = "0,example.com,25[3:99]"
 626     hostapd.add_ap(apdev[0]['ifname'], params)
 627
 628     dev[0].hs20_enable()
 629     dev[0].add_cred_values(default_cred())
 630     interworking_select(dev[0], None, no_match=True, freq="2412")
 631
 632 def test_ap_hs20_eap_ttls_chap(dev, apdev):
 633     """Hotspot 2.0 connection with TTLS/CHAP"""
 634     eap_test(dev[0], apdev[0], "21[2:2]", "TTLS", "chap user")
 635
 636 def test_ap_hs20_eap_ttls_mschap(dev, apdev):
 637     """Hotspot 2.0 connection with TTLS/MSCHAP"""
 638     eap_test(dev[0], apdev[0], "21[2:3]", "TTLS", "mschap user")
 639
 640 def test_ap_hs20_eap_ttls_eap_mschapv2(dev, apdev):
 641     """Hotspot 2.0 connection with TTLS/EAP-MSCHAPv2"""
 642     eap_test(dev[0], apdev[0], "21[3:26][6:7][99:99]", "TTLS", "user")
 643
 644 def test_ap_hs20_eap_ttls_eap_unknown(dev, apdev):
 645     """Hotspot 2.0 connection with TTLS/EAP-unknown"""
 646     bssid = apdev[0]['bssid']
 647     params = hs20_ap_params()
 648     params['nai_realm'] = "0,example.com,21[3:99]"
 649     hostapd.add_ap(apdev[0]['ifname'], params)
 650
 651     dev[0].hs20_enable()
 652     dev[0].add_cred_values(default_cred())
 653     interworking_select(dev[0], None, no_match=True, freq="2412")
 654
 655 def test_ap_hs20_eap_ttls_eap_unsupported(dev, apdev):
 656     """Hotspot 2.0 connection with TTLS/EAP-OTP(unsupported)"""
 657     bssid = apdev[0]['bssid']
 658     params = hs20_ap_params()
 659     params['nai_realm'] = "0,example.com,21[3:5]"
 660     hostapd.add_ap(apdev[0]['ifname'], params)
 661
 662     dev[0].hs20_enable()
 663     dev[0].add_cred_values(default_cred())
 664     interworking_select(dev[0], None, no_match=True, freq="2412")
 665
 666 def test_ap_hs20_eap_ttls_unknown(dev, apdev):
 667     """Hotspot 2.0 connection with TTLS/unknown"""
 668     bssid = apdev[0]['bssid']
 669     params = hs20_ap_params()
 670     params['nai_realm'] = "0,example.com,21[2:5]"
 671     hostapd.add_ap(apdev[0]['ifname'], params)
 672
 673     dev[0].hs20_enable()
 674     dev[0].add_cred_values(default_cred())
 675     interworking_select(dev[0], None, no_match=True, freq="2412")
 676
 677 def test_ap_hs20_eap_fast_mschapv2(dev, apdev):
 678     """Hotspot 2.0 connection with FAST/EAP-MSCHAPV2"""
 679     eap_test(dev[0], apdev[0], "43[3:26]", "FAST", "user")
 680
 681 def test_ap_hs20_eap_fast_gtc(dev, apdev):
 682     """Hotspot 2.0 connection with FAST/EAP-GTC"""
 683     eap_test(dev[0], apdev[0], "43[3:6]", "FAST", "user")
 684
 685 def test_ap_hs20_eap_tls(dev, apdev):
 686     """Hotspot 2.0 connection with EAP-TLS"""
 687     bssid = apdev[0]['bssid']
 688     params = hs20_ap_params()
 689     params['nai_realm'] = [ "0,example.com,13[5:6]" ]
 690     hostapd.add_ap(apdev[0]['ifname'], params)
 691
 692     dev[0].hs20_enable()
 693     dev[0].add_cred_values({ 'realm': "example.com",
 694                              'username': "certificate-user",
 695                              'ca_cert': "auth_serv/ca.pem",
 696                              'client_cert': "auth_serv/user.pem",
 697                              'private_key': "auth_serv/user.key"})
 698     interworking_select(dev[0], bssid, freq="2412")
 699     interworking_connect(dev[0], bssid, "TLS")
 700
 701 def test_ap_hs20_eap_cert_unknown(dev, apdev):
 702     """Hotspot 2.0 connection with certificate, but unknown EAP method"""
 703     bssid = apdev[0]['bssid']
 704     params = hs20_ap_params()
 705     params['nai_realm'] = [ "0,example.com,99[5:6]" ]
 706     hostapd.add_ap(apdev[0]['ifname'], params)
 707
 708     dev[0].hs20_enable()
 709     dev[0].add_cred_values({ 'realm': "example.com",
 710                              'username': "certificate-user",
 711                              'ca_cert': "auth_serv/ca.pem",
 712                              'client_cert': "auth_serv/user.pem",
 713                              'private_key': "auth_serv/user.key"})
 714     interworking_select(dev[0], None, no_match=True, freq="2412")
 715
 716 def test_ap_hs20_eap_cert_unsupported(dev, apdev):
 717     """Hotspot 2.0 connection with certificate, but unsupported TTLS"""
 718     bssid = apdev[0]['bssid']
 719     params = hs20_ap_params()
 720     params['nai_realm'] = [ "0,example.com,21[5:6]" ]
 721     hostapd.add_ap(apdev[0]['ifname'], params)
 722
 723     dev[0].hs20_enable()
 724     dev[0].add_cred_values({ 'realm': "example.com",
 725                              'username': "certificate-user",
 726                              'ca_cert': "auth_serv/ca.pem",
 727                              'client_cert': "auth_serv/user.pem",
 728                              'private_key': "auth_serv/user.key"})
 729     interworking_select(dev[0], None, no_match=True, freq="2412")
 730
 731 def test_ap_hs20_eap_invalid_cred(dev, apdev):
 732     """Hotspot 2.0 connection with invalid cred configuration"""
 733     bssid = apdev[0]['bssid']
 734     params = hs20_ap_params()
 735     hostapd.add_ap(apdev[0]['ifname'], params)
 736
 737     dev[0].hs20_enable()
 738     dev[0].add_cred_values({ 'realm': "example.com",
 739                              'username': "certificate-user",
 740                              'client_cert': "auth_serv/user.pem" })
 741     interworking_select(dev[0], None, no_match=True, freq="2412")
 742
 743 def test_ap_hs20_nai_realms(dev, apdev):
 744     """Hotspot 2.0 connection and multiple NAI realms and TTLS/PAP"""
 745     bssid = apdev[0]['bssid']
 746     params = hs20_ap_params()
 747     params['hessid'] = bssid
 748     params['nai_realm'] = [ "0,no.match.here;example.com;no.match.here.either,21[2:1][5:7]" ]
 749     hostapd.add_ap(apdev[0]['ifname'], params)
 750
 751     dev[0].hs20_enable()
 752     id = dev[0].add_cred_values({ 'realm': "example.com",
 753                                   'username': "pap user",
 754                                   'password': "password",
 755                                   'domain': "example.com" })
 756     interworking_select(dev[0], bssid, "home", freq="2412")
 757     interworking_connect(dev[0], bssid, "TTLS")
 758     check_sp_type(dev[0], "home")
 759
 760 def test_ap_hs20_roaming_consortium(dev, apdev):
 761     """Hotspot 2.0 connection based on roaming consortium match"""
 762     bssid = apdev[0]['bssid']
 763     params = hs20_ap_params()
 764     params['hessid'] = bssid
 765     hostapd.add_ap(apdev[0]['ifname'], params)
 766
 767     dev[0].hs20_enable()
 768     for consortium in [ "112233", "1020304050", "010203040506", "fedcba" ]:
 769         id = dev[0].add_cred_values({ 'username': "user",
 770                                       'password': "password",
 771                                       'domain': "example.com",
 772                                       'roaming_consortium': consortium,
 773                                       'eap': "PEAP" })
 774         interworking_select(dev[0], bssid, "home", freq="2412")
 775         interworking_connect(dev[0], bssid, "PEAP")
 776         check_sp_type(dev[0], "home")
 777         dev[0].request("INTERWORKING_SELECT auto freq=2412")
 778         ev = dev[0].wait_event(["INTERWORKING-ALREADY-CONNECTED"], timeout=15)
 779         if ev is None:
 780             raise Exception("Timeout on already-connected event")
 781         dev[0].remove_cred(id)
 782
 783 def test_ap_hs20_username_roaming(dev, apdev):
 784     """Hotspot 2.0 connection in username/password credential (roaming)"""
 785     bssid = apdev[0]['bssid']
 786     params = hs20_ap_params()
 787     params['nai_realm'] = [ "0,example.com,13[5:6],21[2:4][5:7]",
 788                             "0,roaming.example.com,21[2:4][5:7]",
 789                             "0,another.example.com" ]
 790     params['domain_name'] = "another.example.com"
 791     params['hessid'] = bssid
 792     hostapd.add_ap(apdev[0]['ifname'], params)
 793
 794     dev[0].hs20_enable()
 795     id = dev[0].add_cred_values({ 'realm': "roaming.example.com",
 796                                   'username': "hs20-test",
 797                                   'password': "password",
 798                                   'domain': "example.com" })
 799     interworking_select(dev[0], bssid, "roaming", freq="2412")
 800     interworking_connect(dev[0], bssid, "TTLS")
 801     check_sp_type(dev[0], "roaming")
 802
 803 def test_ap_hs20_username_unknown(dev, apdev):
 804     """Hotspot 2.0 connection in username/password credential (no domain in cred)"""
 805     bssid = apdev[0]['bssid']
 806     params = hs20_ap_params()
 807     params['hessid'] = bssid
 808     hostapd.add_ap(apdev[0]['ifname'], params)
 809
 810     dev[0].hs20_enable()
 811     id = dev[0].add_cred_values({ 'realm': "example.com",
 812                                   'username': "hs20-test",
 813                                   'password': "password" })
 814     interworking_select(dev[0], bssid, "unknown", freq="2412")
 815     interworking_connect(dev[0], bssid, "TTLS")
 816     check_sp_type(dev[0], "unknown")
 817
 818 def test_ap_hs20_username_unknown2(dev, apdev):
 819     """Hotspot 2.0 connection in username/password credential (no domain advertized)"""
 820     bssid = apdev[0]['bssid']
 821     params = hs20_ap_params()
 822     params['hessid'] = bssid
 823     del params['domain_name']
 824     hostapd.add_ap(apdev[0]['ifname'], params)
 825
 826     dev[0].hs20_enable()
 827     id = dev[0].add_cred_values({ 'realm': "example.com",
 828                                   'username': "hs20-test",
 829                                   'password': "password",
 830                                   'domain': "example.com" })
 831     interworking_select(dev[0], bssid, "unknown", freq="2412")
 832     interworking_connect(dev[0], bssid, "TTLS")
 833     check_sp_type(dev[0], "unknown")
 834
 835 def test_ap_hs20_gas_while_associated(dev, apdev):
 836     """Hotspot 2.0 connection with GAS query while associated"""
 837     bssid = apdev[0]['bssid']
 838     params = hs20_ap_params()
 839     params['hessid'] = bssid
 840     hostapd.add_ap(apdev[0]['ifname'], params)
 841
 842     dev[0].hs20_enable()
 843     id = dev[0].add_cred_values({ 'realm': "example.com",
 844                                   'username': "hs20-test",
 845                                   'password': "password",
 846                                   'domain': "example.com" })
 847     interworking_select(dev[0], bssid, "home", freq="2412")
 848     interworking_connect(dev[0], bssid, "TTLS")
 849
 850     logger.info("Verifying GAS query while associated")
 851     dev[0].request("FETCH_ANQP")
 852     for i in range(0, 6):
 853         ev = dev[0].wait_event(["RX-ANQP"], timeout=5)
 854         if ev is None:
 855             raise Exception("Operation timed out")
 856
 857 def test_ap_hs20_gas_while_associated_with_pmf(dev, apdev):
 858     """Hotspot 2.0 connection with GAS query while associated and using PMF"""
 859     try:
 860         _test_ap_hs20_gas_while_associated_with_pmf(dev, apdev)
 861     finally:
 862         dev[0].request("SET pmf 0")
 863
 864 def _test_ap_hs20_gas_while_associated_with_pmf(dev, apdev):
 865     bssid = apdev[0]['bssid']
 866     params = hs20_ap_params()
 867     params['hessid'] = bssid
 868     hostapd.add_ap(apdev[0]['ifname'], params)
 869
 870     bssid2 = apdev[1]['bssid']
 871     params = hs20_ap_params()
 872     params['hessid'] = bssid2
 873     params['nai_realm'] = [ "0,no-match.example.org,13[5:6],21[2:4][5:7]" ]
 874     hostapd.add_ap(apdev[1]['ifname'], params)
 875
 876     dev[0].hs20_enable()
 877     dev[0].request("SET pmf 2")
 878     id = dev[0].add_cred_values({ 'realm': "example.com",
 879                                   'username': "hs20-test",
 880                                   'password': "password",
 881                                   'domain': "example.com" })
 882     interworking_select(dev[0], bssid, "home", freq="2412")
 883     interworking_connect(dev[0], bssid, "TTLS")
 884
 885     logger.info("Verifying GAS query while associated")
 886     dev[0].request("FETCH_ANQP")
 887     for i in range(0, 2 * 6):
 888         ev = dev[0].wait_event(["RX-ANQP"], timeout=5)
 889         if ev is None:
 890             raise Exception("Operation timed out")
 891
 892 def test_ap_hs20_gas_frag_while_associated(dev, apdev):
 893     """Hotspot 2.0 connection with fragmented GAS query while associated"""
 894     bssid = apdev[0]['bssid']
 895     params = hs20_ap_params()
 896     params['hessid'] = bssid
 897     hostapd.add_ap(apdev[0]['ifname'], params)
 898     hapd = hostapd.Hostapd(apdev[0]['ifname'])
 899     hapd.set("gas_frag_limit", "50")
 900
 901     dev[0].hs20_enable()
 902     id = dev[0].add_cred_values({ 'realm': "example.com",
 903                                   'username': "hs20-test",
 904                                   'password': "password",
 905                                   'domain': "example.com" })
 906     interworking_select(dev[0], bssid, "home", freq="2412")
 907     interworking_connect(dev[0], bssid, "TTLS")
 908
 909     logger.info("Verifying GAS query while associated")
 910     dev[0].request("FETCH_ANQP")
 911     for i in range(0, 6):
 912         ev = dev[0].wait_event(["RX-ANQP"], timeout=5)
 913         if ev is None:
 914             raise Exception("Operation timed out")
 915
 916 def test_ap_hs20_multiple_connects(dev, apdev):
 917     """Hotspot 2.0 connection through multiple network selections"""
 918     bssid = apdev[0]['bssid']
 919     params = hs20_ap_params()
 920     params['hessid'] = bssid
 921     hostapd.add_ap(apdev[0]['ifname'], params)
 922
 923     dev[0].hs20_enable()
 924     values = { 'realm': "example.com",
 925                'username': "hs20-test",
 926                'password': "password",
 927                'domain': "example.com" }
 928     id = dev[0].add_cred_values(values)
 929
 930     dev[0].scan_for_bss(bssid, freq="2412")
 931
 932     for i in range(0, 3):
 933         logger.info("Starting Interworking network selection")
 934         dev[0].request("INTERWORKING_SELECT auto freq=2412")
 935         while True:
 936             ev = dev[0].wait_event(["INTERWORKING-NO-MATCH",
 937                                     "INTERWORKING-ALREADY-CONNECTED",
 938                                     "CTRL-EVENT-CONNECTED"], timeout=15)
 939             if ev is None:
 940                 raise Exception("Connection timed out")
 941             if "INTERWORKING-NO-MATCH" in ev:
 942                 raise Exception("Matching AP not found")
 943             if "CTRL-EVENT-CONNECTED" in ev:
 944                 break
 945             if i == 2 and "INTERWORKING-ALREADY-CONNECTED" in ev:
 946                 break
 947         if i == 0:
 948             dev[0].request("DISCONNECT")
 949         dev[0].dump_monitor()
 950
 951     networks = dev[0].list_networks()
 952     if len(networks) > 1:
 953         raise Exception("Duplicated network block detected")
 954
 955 def test_ap_hs20_disallow_aps(dev, apdev):
 956     """Hotspot 2.0 connection and disallow_aps"""
 957     bssid = apdev[0]['bssid']
 958     params = hs20_ap_params()
 959     params['hessid'] = bssid
 960     hostapd.add_ap(apdev[0]['ifname'], params)
 961
 962     dev[0].hs20_enable()
 963     values = { 'realm': "example.com",
 964                'username': "hs20-test",
 965                'password': "password",
 966                'domain': "example.com" }
 967     id = dev[0].add_cred_values(values)
 968
 969     dev[0].scan_for_bss(bssid, freq="2412")
 970
 971     logger.info("Verify disallow_aps bssid")
 972     dev[0].request("SET disallow_aps bssid " + bssid.translate(None, ':'))
 973     dev[0].request("INTERWORKING_SELECT auto")
 974     ev = dev[0].wait_event(["INTERWORKING-NO-MATCH"], timeout=15)
 975     if ev is None:
 976         raise Exception("Network selection timed out")
 977     dev[0].dump_monitor()
 978
 979     logger.info("Verify disallow_aps ssid")
 980     dev[0].request("SET disallow_aps ssid 746573742d68733230")
 981     dev[0].request("INTERWORKING_SELECT auto freq=2412")
 982     ev = dev[0].wait_event(["INTERWORKING-NO-MATCH"], timeout=15)
 983     if ev is None:
 984         raise Exception("Network selection timed out")
 985     dev[0].dump_monitor()
 986
 987     logger.info("Verify disallow_aps clear")
 988     dev[0].request("SET disallow_aps ")
 989     interworking_select(dev[0], bssid, "home", freq="2412")
 990
 991     dev[0].request("SET disallow_aps bssid " + bssid.translate(None, ':'))
 992     ret = dev[0].request("INTERWORKING_CONNECT " + bssid)
 993     if "FAIL" not in ret:
 994         raise Exception("INTERWORKING_CONNECT to disallowed BSS not rejected")
 995
 996     if "FAIL" not in dev[0].request("INTERWORKING_CONNECT foo"):
 997         raise Exception("Invalid INTERWORKING_CONNECT not rejected")
 998     if "FAIL" not in dev[0].request("INTERWORKING_CONNECT 00:11:22:33:44:55"):
 999         raise Exception("Invalid INTERWORKING_CONNECT not rejected")
1000
1001 def policy_test(dev, ap, values, only_one=True):
1002     dev.dump_monitor()
1003     if ap:
1004         logger.info("Verify network selection to AP " + ap['ifname'])
1005         bssid = ap['bssid']
1006         dev.scan_for_bss(bssid, freq="2412")
1007     else:
1008         logger.info("Verify network selection")
1009         bssid = None
1010     dev.hs20_enable()
1011     id = dev.add_cred_values(values)
1012     dev.request("INTERWORKING_SELECT auto freq=2412")
1013     events = []
1014     while True:
1015         ev = dev.wait_event(["INTERWORKING-AP", "INTERWORKING-NO-MATCH",
1016                              "INTERWORKING-BLACKLISTED",
1017                              "INTERWORKING-SELECTED"], timeout=15)
1018         if ev is None:
1019             raise Exception("Network selection timed out")
1020         events.append(ev)
1021         if "INTERWORKING-NO-MATCH" in ev:
1022             raise Exception("Matching AP not found")
1023         if bssid and only_one and "INTERWORKING-AP" in ev and bssid not in ev:
1024             raise Exception("Unexpected AP claimed acceptable")
1025         if "INTERWORKING-SELECTED" in ev:
1026             if bssid and bssid not in ev:
1027                 raise Exception("Selected incorrect BSS")
1028             break
1029
1030     ev = dev.wait_event(["CTRL-EVENT-CONNECTED"], timeout=15)
1031     if ev is None:
1032         raise Exception("Connection timed out")
1033     if bssid and bssid not in ev:
1034         raise Exception("Connected to incorrect BSS")
1035
1036     conn_bssid = dev.get_status_field("bssid")
1037     if bssid and conn_bssid != bssid:
1038         raise Exception("bssid information points to incorrect BSS")
1039
1040     dev.remove_cred(id)
1041     dev.dump_monitor()
1042     return events
1043
1044 def default_cred(domain=None):
1045     cred = { 'realm': "example.com",
1046              'username': "hs20-test",
1047              'password': "password" }
1048     if domain:
1049         cred['domain'] = domain
1050     return cred
1051
1052 def test_ap_hs20_prefer_home(dev, apdev):
1053     """Hotspot 2.0 required roaming consortium"""
1054     params = hs20_ap_params()
1055     params['domain_name'] = "example.org"
1056     hostapd.add_ap(apdev[0]['ifname'], params)
1057
1058     params = hs20_ap_params()
1059     params['ssid'] = "test-hs20-other"
1060     params['domain_name'] = "example.com"
1061     hostapd.add_ap(apdev[1]['ifname'], params)
1062
1063     values = default_cred()
1064     values['domain'] = "example.com"
1065     policy_test(dev[0], apdev[1], values, only_one=False)
1066     values['domain'] = "example.org"
1067     policy_test(dev[0], apdev[0], values, only_one=False)
1068
1069 def test_ap_hs20_req_roaming_consortium(dev, apdev):
1070     """Hotspot 2.0 required roaming consortium"""
1071     params = hs20_ap_params()
1072     hostapd.add_ap(apdev[0]['ifname'], params)
1073
1074     params = hs20_ap_params()
1075     params['ssid'] = "test-hs20-other"
1076     params['roaming_consortium'] = [ "223344" ]
1077     hostapd.add_ap(apdev[1]['ifname'], params)
1078
1079     values = default_cred()
1080     values['required_roaming_consortium'] = "223344"
1081     policy_test(dev[0], apdev[1], values)
1082     values['required_roaming_consortium'] = "112233"
1083     policy_test(dev[0], apdev[0], values)
1084
1085     id = dev[0].add_cred()
1086     dev[0].set_cred(id, "required_roaming_consortium", "112233")
1087     dev[0].set_cred(id, "required_roaming_consortium", "112233445566778899aabbccddeeff")
1088
1089     for val in [ "", "1", "11", "1122", "1122334", "112233445566778899aabbccddeeff00" ]:
1090         if "FAIL" not in dev[0].request('SET_CRED {} required_roaming_consortium {}'.format(id, val)):
1091             raise Exception("Invalid roaming consortium value accepted: " + val)
1092
1093 def test_ap_hs20_excluded_ssid(dev, apdev):
1094     """Hotspot 2.0 exclusion based on SSID"""
1095     params = hs20_ap_params()
1096     params['roaming_consortium'] = [ "223344" ]
1097     params['anqp_3gpp_cell_net'] = "555,444"
1098     hostapd.add_ap(apdev[0]['ifname'], params)
1099
1100     params = hs20_ap_params()
1101     params['ssid'] = "test-hs20-other"
1102     params['roaming_consortium'] = [ "223344" ]
1103     params['anqp_3gpp_cell_net'] = "555,444"
1104     hostapd.add_ap(apdev[1]['ifname'], params)
1105
1106     values = default_cred()
1107     values['excluded_ssid'] = "test-hs20"
1108     events = policy_test(dev[0], apdev[1], values)
1109     ev = [e for e in events if "INTERWORKING-BLACKLISTED " + apdev[0]['bssid'] in e]
1110     if len(ev) != 1:
1111         raise Exception("Excluded network not reported")
1112     values['excluded_ssid'] = "test-hs20-other"
1113     events = policy_test(dev[0], apdev[0], values)
1114     ev = [e for e in events if "INTERWORKING-BLACKLISTED " + apdev[1]['bssid'] in e]
1115     if len(ev) != 1:
1116         raise Exception("Excluded network not reported")
1117
1118     values = default_cred()
1119     values['roaming_consortium'] = "223344"
1120     values['eap'] = "TTLS"
1121     values['phase2'] = "auth=MSCHAPV2"
1122     values['excluded_ssid'] = "test-hs20"
1123     events = policy_test(dev[0], apdev[1], values)
1124     ev = [e for e in events if "INTERWORKING-BLACKLISTED " + apdev[0]['bssid'] in e]
1125     if len(ev) != 1:
1126         raise Exception("Excluded network not reported")
1127
1128     values = { 'imsi': "555444-333222111", 'eap': "SIM",
1129                'milenage': "5122250214c33e723a5dd523fc145fc0:981d464c7c52eb6e5036234984ad0bcf:000000000123",
1130                'excluded_ssid': "test-hs20" }
1131     events = policy_test(dev[0], apdev[1], values)
1132     ev = [e for e in events if "INTERWORKING-BLACKLISTED " + apdev[0]['bssid'] in e]
1133     if len(ev) != 1:
1134         raise Exception("Excluded network not reported")
1135
1136 def test_ap_hs20_roam_to_higher_prio(dev, apdev):
1137     """Hotspot 2.0 and roaming from current to higher priority network"""
1138     bssid = apdev[0]['bssid']
1139     params = hs20_ap_params(ssid="test-hs20-visited")
1140     params['domain_name'] = "visited.example.org"
1141     hostapd.add_ap(apdev[0]['ifname'], params)
1142
1143     dev[0].hs20_enable()
1144     id = dev[0].add_cred_values({ 'realm': "example.com",
1145                                   'username': "hs20-test",
1146                                   'password': "password",
1147                                   'domain': "example.com" })
1148     logger.info("Connect to the only network option")
1149     interworking_select(dev[0], bssid, "roaming", freq="2412")
1150     dev[0].dump_monitor()
1151     interworking_connect(dev[0], bssid, "TTLS")
1152
1153     logger.info("Start another AP (home operator) and reconnect")
1154     bssid2 = apdev[1]['bssid']
1155     params = hs20_ap_params(ssid="test-hs20-home")
1156     params['domain_name'] = "example.com"
1157     hostapd.add_ap(apdev[1]['ifname'], params)
1158
1159     dev[0].scan_for_bss(bssid2, freq="2412", force_scan=True)
1160     dev[0].request("INTERWORKING_SELECT auto freq=2412")
1161     ev = dev[0].wait_event(["INTERWORKING-NO-MATCH",
1162                             "INTERWORKING-ALREADY-CONNECTED",
1163                             "CTRL-EVENT-CONNECTED"], timeout=15)
1164     if ev is None:
1165         raise Exception("Connection timed out")
1166     if "INTERWORKING-NO-MATCH" in ev:
1167         raise Exception("Matching AP not found")
1168     if "INTERWORKING-ALREADY-CONNECTED" in ev:
1169         raise Exception("Unexpected AP selected")
1170     if bssid2 not in ev:
1171         raise Exception("Unexpected BSSID after reconnection")
1172
1173 def test_ap_hs20_domain_suffix_match(dev, apdev):
1174     """Hotspot 2.0 and domain_suffix_match"""
1175     bssid = apdev[0]['bssid']
1176     params = hs20_ap_params()
1177     hostapd.add_ap(apdev[0]['ifname'], params)
1178
1179     dev[0].hs20_enable()
1180     id = dev[0].add_cred_values({ 'realm': "example.com",
1181                                   'username': "hs20-test",
1182                                   'password': "password",
1183                                   'domain': "example.com",
1184                                   'domain_suffix_match': "w1.fi" })
1185     interworking_select(dev[0], bssid, "home", freq="2412")
1186     dev[0].dump_monitor()
1187     interworking_connect(dev[0], bssid, "TTLS")
1188     dev[0].request("REMOVE_NETWORK all")
1189     dev[0].dump_monitor()
1190
1191     dev[0].set_cred_quoted(id, "domain_suffix_match", "no-match.example.com")
1192     interworking_select(dev[0], bssid, "home", freq="2412")
1193     dev[0].dump_monitor()
1194     dev[0].request("INTERWORKING_CONNECT " + bssid)
1195     ev = dev[0].wait_event(["CTRL-EVENT-EAP-TLS-CERT-ERROR"])
1196     if ev is None:
1197         raise Exception("TLS certificate error not reported")
1198     if "Domain suffix mismatch" not in ev:
1199         raise Exception("Domain suffix mismatch not reported")
1200
1201 def test_ap_hs20_roaming_partner_preference(dev, apdev):
1202     """Hotspot 2.0 and roaming partner preference"""
1203     params = hs20_ap_params()
1204     params['domain_name'] = "roaming.example.org"
1205     hostapd.add_ap(apdev[0]['ifname'], params)
1206
1207     params = hs20_ap_params()
1208     params['ssid'] = "test-hs20-other"
1209     params['domain_name'] = "roaming.example.net"
1210     hostapd.add_ap(apdev[1]['ifname'], params)
1211
1212     logger.info("Verify default vs. specified preference")
1213     values = default_cred()
1214     values['roaming_partner'] = "roaming.example.net,1,127,*"
1215     policy_test(dev[0], apdev[1], values, only_one=False)
1216     values['roaming_partner'] = "roaming.example.net,1,129,*"
1217     policy_test(dev[0], apdev[0], values, only_one=False)
1218
1219     logger.info("Verify partial FQDN match")
1220     values['roaming_partner'] = "example.net,0,0,*"
1221     policy_test(dev[0], apdev[1], values, only_one=False)
1222     values['roaming_partner'] = "example.net,0,255,*"
1223     policy_test(dev[0], apdev[0], values, only_one=False)
1224
1225 def test_ap_hs20_max_bss_load(dev, apdev):
1226     """Hotspot 2.0 and maximum BSS load"""
1227     params = hs20_ap_params()
1228     params['bss_load_test'] = "12:200:20000"
1229     hostapd.add_ap(apdev[0]['ifname'], params)
1230
1231     params = hs20_ap_params()
1232     params['ssid'] = "test-hs20-other"
1233     params['bss_load_test'] = "5:20:10000"
1234     hostapd.add_ap(apdev[1]['ifname'], params)
1235
1236     logger.info("Verify maximum BSS load constraint")
1237     values = default_cred()
1238     values['domain'] = "example.com"
1239     values['max_bss_load'] = "100"
1240     events = policy_test(dev[0], apdev[1], values, only_one=False)
1241
1242     ev = [e for e in events if "INTERWORKING-AP " + apdev[0]['bssid'] in e]
1243     if len(ev) != 1 or "over_max_bss_load=1" not in ev[0]:
1244         raise Exception("Maximum BSS Load case not noticed")
1245     ev = [e for e in events if "INTERWORKING-AP " + apdev[1]['bssid'] in e]
1246     if len(ev) != 1 or "over_max_bss_load=1" in ev[0]:
1247         raise Exception("Maximum BSS Load case reported incorrectly")
1248
1249     logger.info("Verify maximum BSS load does not prevent connection")
1250     values['max_bss_load'] = "1"
1251     events = policy_test(dev[0], None, values)
1252
1253     ev = [e for e in events if "INTERWORKING-AP " + apdev[0]['bssid'] in e]
1254     if len(ev) != 1 or "over_max_bss_load=1" not in ev[0]:
1255         raise Exception("Maximum BSS Load case not noticed")
1256     ev = [e for e in events if "INTERWORKING-AP " + apdev[1]['bssid'] in e]
1257     if len(ev) != 1 or "over_max_bss_load=1" not in ev[0]:
1258         raise Exception("Maximum BSS Load case not noticed")
1259
1260 def test_ap_hs20_max_bss_load2(dev, apdev):
1261     """Hotspot 2.0 and maximum BSS load with one AP not advertising"""
1262     params = hs20_ap_params()
1263     params['bss_load_test'] = "12:200:20000"
1264     hostapd.add_ap(apdev[0]['ifname'], params)
1265
1266     params = hs20_ap_params()
1267     params['ssid'] = "test-hs20-other"
1268     hostapd.add_ap(apdev[1]['ifname'], params)
1269
1270     logger.info("Verify maximum BSS load constraint with AP advertisement")
1271     values = default_cred()
1272     values['domain'] = "example.com"
1273     values['max_bss_load'] = "100"
1274     events = policy_test(dev[0], apdev[1], values, only_one=False)
1275
1276     ev = [e for e in events if "INTERWORKING-AP " + apdev[0]['bssid'] in e]
1277     if len(ev) != 1 or "over_max_bss_load=1" not in ev[0]:
1278         raise Exception("Maximum BSS Load case not noticed")
1279     ev = [e for e in events if "INTERWORKING-AP " + apdev[1]['bssid'] in e]
1280     if len(ev) != 1 or "over_max_bss_load=1" in ev[0]:
1281         raise Exception("Maximum BSS Load case reported incorrectly")
1282
1283 def test_ap_hs20_multi_cred_sp_prio(dev, apdev):
1284     """Hotspot 2.0 multi-cred sp_priority"""
1285     try:
1286         return _test_ap_hs20_multi_cred_sp_prio(dev, apdev)
1287     finally:
1288         dev[0].request("SET external_sim 0")
1289
1290 def _test_ap_hs20_multi_cred_sp_prio(dev, apdev):
1291     if not hlr_auc_gw_available():
1292         return "skip"
1293     bssid = apdev[0]['bssid']
1294     params = hs20_ap_params()
1295     params['hessid'] = bssid
1296     del params['domain_name']
1297     params['anqp_3gpp_cell_net'] = "232,01"
1298     hostapd.add_ap(apdev[0]['ifname'], params)
1299
1300     dev[0].hs20_enable()
1301     dev[0].scan_for_bss(bssid, freq="2412")
1302     dev[0].request("SET external_sim 1")
1303     id1 = dev[0].add_cred_values({ 'imsi': "23201-0000000000", 'eap': "SIM",
1304                                    'provisioning_sp': "example.com",
1305                                    'sp_priority' :"1" })
1306     id2 = dev[0].add_cred_values({ 'realm': "example.com",
1307                                    'username': "hs20-test",
1308                                    'password': "password",
1309                                    'domain': "example.com",
1310                                    'provisioning_sp': "example.com",
1311                                    'sp_priority': "2" })
1312     dev[0].dump_monitor()
1313     dev[0].scan_for_bss(bssid, freq="2412")
1314     dev[0].request("INTERWORKING_SELECT auto freq=2412")
1315     interworking_ext_sim_auth(dev[0], "SIM")
1316     check_sp_type(dev[0], "unknown")
1317     dev[0].request("REMOVE_NETWORK all")
1318
1319     dev[0].set_cred(id1, "sp_priority", "2")
1320     dev[0].set_cred(id2, "sp_priority", "1")
1321     dev[0].dump_monitor()
1322     dev[0].request("INTERWORKING_SELECT auto freq=2412")
1323     interworking_auth(dev[0], "TTLS")
1324     check_sp_type(dev[0], "unknown")
1325
1326 def test_ap_hs20_multi_cred_sp_prio2(dev, apdev):
1327     """Hotspot 2.0 multi-cred sp_priority with two BSSes"""
1328     try:
1329         return _test_ap_hs20_multi_cred_sp_prio2(dev, apdev)
1330     finally:
1331         dev[0].request("SET external_sim 0")
1332
1333 def _test_ap_hs20_multi_cred_sp_prio2(dev, apdev):
1334     if not hlr_auc_gw_available():
1335         return "skip"
1336     bssid = apdev[0]['bssid']
1337     params = hs20_ap_params()
1338     params['hessid'] = bssid
1339     del params['nai_realm']
1340     del params['domain_name']
1341     params['anqp_3gpp_cell_net'] = "232,01"
1342     hostapd.add_ap(apdev[0]['ifname'], params)
1343
1344     bssid2 = apdev[1]['bssid']
1345     params = hs20_ap_params()
1346     params['ssid'] = "test-hs20-other"
1347     params['hessid'] = bssid2
1348     del params['domain_name']
1349     del params['anqp_3gpp_cell_net']
1350     hostapd.add_ap(apdev[1]['ifname'], params)
1351
1352     dev[0].hs20_enable()
1353     dev[0].request("SET external_sim 1")
1354     id1 = dev[0].add_cred_values({ 'imsi': "23201-0000000000", 'eap': "SIM",
1355                                    'provisioning_sp': "example.com",
1356                                    'sp_priority': "1" })
1357     id2 = dev[0].add_cred_values({ 'realm': "example.com",
1358                                    'username': "hs20-test",
1359                                    'password': "password",
1360                                    'domain': "example.com",
1361                                    'provisioning_sp': "example.com",
1362                                    'sp_priority': "2" })
1363     dev[0].dump_monitor()
1364     dev[0].scan_for_bss(bssid, freq="2412")
1365     dev[0].scan_for_bss(bssid2, freq="2412")
1366     dev[0].request("INTERWORKING_SELECT auto freq=2412")
1367     interworking_ext_sim_auth(dev[0], "SIM")
1368     check_sp_type(dev[0], "unknown")
1369     conn_bssid = dev[0].get_status_field("bssid")
1370     if conn_bssid != bssid:
1371         raise Exception("Connected to incorrect BSS")
1372     dev[0].request("REMOVE_NETWORK all")
1373
1374     dev[0].set_cred(id1, "sp_priority", "2")
1375     dev[0].set_cred(id2, "sp_priority", "1")
1376     dev[0].dump_monitor()
1377     dev[0].request("INTERWORKING_SELECT auto freq=2412")
1378     interworking_auth(dev[0], "TTLS")
1379     check_sp_type(dev[0], "unknown")
1380     conn_bssid = dev[0].get_status_field("bssid")
1381     if conn_bssid != bssid2:
1382         raise Exception("Connected to incorrect BSS")
1383
1384 def check_conn_capab_selection(dev, type, missing):
1385     dev.request("INTERWORKING_SELECT freq=2412")
1386     ev = dev.wait_event(["INTERWORKING-AP"])
1387     if ev is None:
1388         raise Exception("Network selection timed out");
1389     if "type=" + type not in ev:
1390         raise Exception("Unexpected network type")
1391     if missing and "conn_capab_missing=1" not in ev:
1392         raise Exception("conn_capab_missing not reported")
1393     if not missing and "conn_capab_missing=1" in ev:
1394         raise Exception("conn_capab_missing reported unexpectedly")
1395
1396 def conn_capab_cred(domain=None, req_conn_capab=None):
1397     cred = default_cred(domain=domain)
1398     if req_conn_capab:
1399         cred['req_conn_capab'] = req_conn_capab
1400     return cred
1401
1402 def test_ap_hs20_req_conn_capab(dev, apdev):
1403     """Hotspot 2.0 network selection with req_conn_capab"""
1404     bssid = apdev[0]['bssid']
1405     params = hs20_ap_params()
1406     hostapd.add_ap(apdev[0]['ifname'], params)
1407
1408     dev[0].hs20_enable()
1409     dev[0].scan_for_bss(bssid, freq="2412")
1410     logger.info("Not used in home network")
1411     values = conn_capab_cred(domain="example.com", req_conn_capab="6:1234")
1412     id = dev[0].add_cred_values(values)
1413     check_conn_capab_selection(dev[0], "home", False)
1414
1415     logger.info("Used in roaming network")
1416     dev[0].remove_cred(id)
1417     values = conn_capab_cred(domain="example.org", req_conn_capab="6:1234")
1418     id = dev[0].add_cred_values(values)
1419     check_conn_capab_selection(dev[0], "roaming", True)
1420
1421     logger.info("Verify that req_conn_capab does not prevent connection if no other network is available")
1422     check_auto_select(dev[0], bssid)
1423
1424     logger.info("Additional req_conn_capab checks")
1425
1426     dev[0].remove_cred(id)
1427     values = conn_capab_cred(domain="example.org", req_conn_capab="1:0")
1428     id = dev[0].add_cred_values(values)
1429     check_conn_capab_selection(dev[0], "roaming", True)
1430
1431     dev[0].remove_cred(id)
1432     values = conn_capab_cred(domain="example.org", req_conn_capab="17:5060")
1433     id = dev[0].add_cred_values(values)
1434     check_conn_capab_selection(dev[0], "roaming", True)
1435
1436     bssid2 = apdev[1]['bssid']
1437     params = hs20_ap_params(ssid="test-hs20b")
1438     params['hs20_conn_capab'] = [ "1:0:2", "6:22:1", "17:5060:0", "50:0:1" ]
1439     hostapd.add_ap(apdev[1]['ifname'], params)
1440
1441     dev[0].remove_cred(id)
1442     values = conn_capab_cred(domain="example.org", req_conn_capab="50")
1443     id = dev[0].add_cred_values(values)
1444     dev[0].set_cred(id, "req_conn_capab", "6:22")
1445     dev[0].scan_for_bss(bssid2, freq="2412")
1446     dev[0].request("INTERWORKING_SELECT freq=2412")
1447     for i in range(0, 2):
1448         ev = dev[0].wait_event(["INTERWORKING-AP"])
1449         if ev is None:
1450             raise Exception("Network selection timed out");
1451         if bssid in ev and "conn_capab_missing=1" not in ev:
1452             raise Exception("Missing protocol connection capability not reported")
1453         if bssid2 in ev and "conn_capab_missing=1" in ev:
1454             raise Exception("Protocol connection capability not reported correctly")
1455
1456 def test_ap_hs20_req_conn_capab_and_roaming_partner_preference(dev, apdev):
1457     """Hotspot 2.0 and req_conn_capab with roaming partner preference"""
1458     bssid = apdev[0]['bssid']
1459     params = hs20_ap_params()
1460     params['domain_name'] = "roaming.example.org"
1461     params['hs20_conn_capab'] = [ "1:0:2", "6:22:1", "17:5060:0", "50:0:1" ]
1462     hostapd.add_ap(apdev[0]['ifname'], params)
1463
1464     bssid2 = apdev[1]['bssid']
1465     params = hs20_ap_params(ssid="test-hs20-b")
1466     params['domain_name'] = "roaming.example.net"
1467     hostapd.add_ap(apdev[1]['ifname'], params)
1468
1469     values = default_cred()
1470     values['roaming_partner'] = "roaming.example.net,1,127,*"
1471     id = dev[0].add_cred_values(values)
1472     check_auto_select(dev[0], bssid2)
1473
1474     dev[0].set_cred(id, "req_conn_capab", "50")
1475     check_auto_select(dev[0], bssid)
1476
1477     dev[0].remove_cred(id)
1478     id = dev[0].add_cred_values(values)
1479     dev[0].set_cred(id, "req_conn_capab", "51")
1480     check_auto_select(dev[0], bssid2)
1481
1482 def check_bandwidth_selection(dev, type, below):
1483     dev.request("INTERWORKING_SELECT freq=2412")
1484     ev = dev.wait_event(["INTERWORKING-AP"])
1485     if ev is None:
1486         raise Exception("Network selection timed out");
1487     if "type=" + type not in ev:
1488         raise Exception("Unexpected network type")
1489     if below and "below_min_backhaul=1" not in ev:
1490         raise Exception("below_min_backhaul not reported")
1491     if not below and "below_min_backhaul=1" in ev:
1492         raise Exception("below_min_backhaul reported unexpectedly")
1493
1494 def bw_cred(domain=None, dl_home=None, ul_home=None, dl_roaming=None, ul_roaming=None):
1495     cred = default_cred(domain=domain)
1496     if dl_home:
1497         cred['min_dl_bandwidth_home'] = str(dl_home)
1498     if ul_home:
1499         cred['min_ul_bandwidth_home'] = str(ul_home)
1500     if dl_roaming:
1501         cred['min_dl_bandwidth_roaming'] = str(dl_roaming)
1502     if ul_roaming:
1503         cred['min_ul_bandwidth_roaming'] = str(ul_roaming)
1504     return cred
1505
1506 def test_ap_hs20_min_bandwidth_home(dev, apdev):
1507     """Hotspot 2.0 network selection with min bandwidth (home)"""
1508     bssid = apdev[0]['bssid']
1509     params = hs20_ap_params()
1510     hostapd.add_ap(apdev[0]['ifname'], params)
1511
1512     dev[0].hs20_enable()
1513     dev[0].scan_for_bss(bssid, freq="2412")
1514     values = bw_cred(domain="example.com", dl_home=5490, ul_home=58)
1515     id = dev[0].add_cred_values(values)
1516     check_bandwidth_selection(dev[0], "home", False)
1517     dev[0].remove_cred(id)
1518
1519     values = bw_cred(domain="example.com", dl_home=5491, ul_home=58)
1520     id = dev[0].add_cred_values(values)
1521     check_bandwidth_selection(dev[0], "home", True)
1522     dev[0].remove_cred(id)
1523
1524     values = bw_cred(domain="example.com", dl_home=5490, ul_home=59)
1525     id = dev[0].add_cred_values(values)
1526     check_bandwidth_selection(dev[0], "home", True)
1527     dev[0].remove_cred(id)
1528
1529     values = bw_cred(domain="example.com", dl_home=5491, ul_home=59)
1530     id = dev[0].add_cred_values(values)
1531     check_bandwidth_selection(dev[0], "home", True)
1532     check_auto_select(dev[0], bssid)
1533
1534     bssid2 = apdev[1]['bssid']
1535     params = hs20_ap_params(ssid="test-hs20-b")
1536     params['hs20_wan_metrics'] = "01:8000:1000:1:1:3000"
1537     hostapd.add_ap(apdev[1]['ifname'], params)
1538
1539     check_auto_select(dev[0], bssid2)
1540
1541 def test_ap_hs20_min_bandwidth_roaming(dev, apdev):
1542     """Hotspot 2.0 network selection with min bandwidth (roaming)"""
1543     bssid = apdev[0]['bssid']
1544     params = hs20_ap_params()
1545     hostapd.add_ap(apdev[0]['ifname'], params)
1546
1547     dev[0].hs20_enable()
1548     dev[0].scan_for_bss(bssid, freq="2412")
1549     values = bw_cred(domain="example.org", dl_roaming=5490, ul_roaming=58)
1550     id = dev[0].add_cred_values(values)
1551     check_bandwidth_selection(dev[0], "roaming", False)
1552     dev[0].remove_cred(id)
1553
1554     values = bw_cred(domain="example.org", dl_roaming=5491, ul_roaming=58)
1555     id = dev[0].add_cred_values(values)
1556     check_bandwidth_selection(dev[0], "roaming", True)
1557     dev[0].remove_cred(id)
1558
1559     values = bw_cred(domain="example.org", dl_roaming=5490, ul_roaming=59)
1560     id = dev[0].add_cred_values(values)
1561     check_bandwidth_selection(dev[0], "roaming", True)
1562     dev[0].remove_cred(id)
1563
1564     values = bw_cred(domain="example.org", dl_roaming=5491, ul_roaming=59)
1565     id = dev[0].add_cred_values(values)
1566     check_bandwidth_selection(dev[0], "roaming", True)
1567     check_auto_select(dev[0], bssid)
1568
1569     bssid2 = apdev[1]['bssid']
1570     params = hs20_ap_params(ssid="test-hs20-b")
1571     params['hs20_wan_metrics'] = "01:8000:1000:1:1:3000"
1572     hostapd.add_ap(apdev[1]['ifname'], params)
1573
1574     check_auto_select(dev[0], bssid2)
1575
1576 def test_ap_hs20_min_bandwidth_and_roaming_partner_preference(dev, apdev):
1577     """Hotspot 2.0 and minimum bandwidth with roaming partner preference"""
1578     bssid = apdev[0]['bssid']
1579     params = hs20_ap_params()
1580     params['domain_name'] = "roaming.example.org"
1581     params['hs20_wan_metrics'] = "01:8000:1000:1:1:3000"
1582     hostapd.add_ap(apdev[0]['ifname'], params)
1583
1584     bssid2 = apdev[1]['bssid']
1585     params = hs20_ap_params(ssid="test-hs20-b")
1586     params['domain_name'] = "roaming.example.net"
1587     hostapd.add_ap(apdev[1]['ifname'], params)
1588
1589     values = default_cred()
1590     values['roaming_partner'] = "roaming.example.net,1,127,*"
1591     id = dev[0].add_cred_values(values)
1592     check_auto_select(dev[0], bssid2)
1593
1594     dev[0].set_cred(id, "min_dl_bandwidth_roaming", "6000")
1595     check_auto_select(dev[0], bssid)
1596
1597     dev[0].set_cred(id, "min_dl_bandwidth_roaming", "10000")
1598     check_auto_select(dev[0], bssid2)
1599
1600 def test_ap_hs20_min_bandwidth_no_wan_metrics(dev, apdev):
1601     """Hotspot 2.0 network selection with min bandwidth but no WAN Metrics"""
1602     bssid = apdev[0]['bssid']
1603     params = hs20_ap_params()
1604     del params['hs20_wan_metrics']
1605     hostapd.add_ap(apdev[0]['ifname'], params)
1606
1607     dev[0].hs20_enable()
1608     dev[0].scan_for_bss(bssid, freq="2412")
1609     values = bw_cred(domain="example.com", dl_home=10000, ul_home=10000,
1610                      dl_roaming=10000, ul_roaming=10000)
1611     dev[0].add_cred_values(values)
1612     check_bandwidth_selection(dev[0], "home", False)
1613
1614 def test_ap_hs20_deauth_req_ess(dev, apdev):
1615     """Hotspot 2.0 connection and deauthentication request for ESS"""
1616     try:
1617         _test_ap_hs20_deauth_req_ess(dev, apdev)
1618     finally:
1619         dev[0].request("SET pmf 0")
1620
1621 def _test_ap_hs20_deauth_req_ess(dev, apdev):
1622     dev[0].request("SET pmf 2")
1623     eap_test(dev[0], apdev[0], "21[3:26]", "TTLS", "user")
1624     dev[0].dump_monitor()
1625     addr = dev[0].p2p_interface_addr()
1626     hapd = hostapd.Hostapd(apdev[0]['ifname'])
1627     hapd.request("HS20_DEAUTH_REQ " + addr + " 1 120 http://example.com/")
1628     ev = dev[0].wait_event(["HS20-DEAUTH-IMMINENT-NOTICE"])
1629     if ev is None:
1630         raise Exception("Timeout on deauth imminent notice")
1631     if "1 120 http://example.com/" not in ev:
1632         raise Exception("Unexpected deauth imminent notice: " + ev)
1633     hapd.request("DEAUTHENTICATE " + addr)
1634     ev = dev[0].wait_event(["CTRL-EVENT-DISCONNECTED"])
1635     if ev is None:
1636         raise Exception("Timeout on disconnection")
1637     if "[TEMP-DISABLED]" not in dev[0].list_networks()[0]['flags']:
1638         raise Exception("Network not marked temporarily disabled")
1639     ev = dev[0].wait_event(["SME: Trying to authenticate",
1640                             "Trying to associate",
1641                             "CTRL-EVENT-CONNECTED"], timeout=5)
1642     if ev is not None:
1643         raise Exception("Unexpected connection attempt")
1644
1645 def test_ap_hs20_deauth_req_bss(dev, apdev):
1646     """Hotspot 2.0 connection and deauthentication request for BSS"""
1647     try:
1648         _test_ap_hs20_deauth_req_bss(dev, apdev)
1649     finally:
1650         dev[0].request("SET pmf 0")
1651
1652 def _test_ap_hs20_deauth_req_bss(dev, apdev):
1653     dev[0].request("SET pmf 2")
1654     eap_test(dev[0], apdev[0], "21[3:26]", "TTLS", "user")
1655     dev[0].dump_monitor()
1656     addr = dev[0].p2p_interface_addr()
1657     hapd = hostapd.Hostapd(apdev[0]['ifname'])
1658     hapd.request("HS20_DEAUTH_REQ " + addr + " 0 120 http://example.com/")
1659     ev = dev[0].wait_event(["HS20-DEAUTH-IMMINENT-NOTICE"])
1660     if ev is None:
1661         raise Exception("Timeout on deauth imminent notice")
1662     if "0 120 http://example.com/" not in ev:
1663         raise Exception("Unexpected deauth imminent notice: " + ev)
1664     hapd.request("DEAUTHENTICATE " + addr + " reason=4")
1665     ev = dev[0].wait_event(["CTRL-EVENT-DISCONNECTED"])
1666     if ev is None:
1667         raise Exception("Timeout on disconnection")
1668     if "reason=4" not in ev:
1669         raise Exception("Unexpected disconnection reason")
1670     if "[TEMP-DISABLED]" not in dev[0].list_networks()[0]['flags']:
1671         raise Exception("Network not marked temporarily disabled")
1672     ev = dev[0].wait_event(["SME: Trying to authenticate",
1673                             "Trying to associate",
1674                             "CTRL-EVENT-CONNECTED"], timeout=5)
1675     if ev is not None:
1676         raise Exception("Unexpected connection attempt")
1677
1678 def test_ap_hs20_deauth_req_from_radius(dev, apdev):
1679     """Hotspot 2.0 connection and deauthentication request from RADIUS"""
1680     try:
1681         _test_ap_hs20_deauth_req_from_radius(dev, apdev)
1682     finally:
1683         dev[0].request("SET pmf 0")
1684
1685 def _test_ap_hs20_deauth_req_from_radius(dev, apdev):
1686     bssid = apdev[0]['bssid']
1687     params = hs20_ap_params()
1688     params['nai_realm'] = [ "0,example.com,21[2:4]" ]
1689     params['hs20_deauth_req_timeout'] = "2"
1690     hostapd.add_ap(apdev[0]['ifname'], params)
1691
1692     dev[0].request("SET pmf 2")
1693     dev[0].hs20_enable()
1694     dev[0].add_cred_values({ 'realm': "example.com",
1695                              'username': "hs20-deauth-test",
1696                              'password': "password" })
1697     interworking_select(dev[0], bssid, freq="2412")
1698     interworking_connect(dev[0], bssid, "TTLS")
1699     ev = dev[0].wait_event(["HS20-DEAUTH-IMMINENT-NOTICE"], timeout=5)
1700     if ev is None:
1701         raise Exception("Timeout on deauth imminent notice")
1702     if " 1 100" not in ev:
1703         raise Exception("Unexpected deauth imminent contents")
1704     ev = dev[0].wait_event(["CTRL-EVENT-DISCONNECTED"], timeout=3)
1705     if ev is None:
1706         raise Exception("Timeout on disconnection")
1707
1708 def test_ap_hs20_remediation_required(dev, apdev):
1709     """Hotspot 2.0 connection and remediation required from RADIUS"""
1710     try:
1711         _test_ap_hs20_remediation_required(dev, apdev)
1712     finally:
1713         dev[0].request("SET pmf 0")
1714
1715 def _test_ap_hs20_remediation_required(dev, apdev):
1716     bssid = apdev[0]['bssid']
1717     params = hs20_ap_params()
1718     params['nai_realm'] = [ "0,example.com,21[2:4]" ]
1719     hostapd.add_ap(apdev[0]['ifname'], params)
1720
1721     dev[0].request("SET pmf 1")
1722     dev[0].hs20_enable()
1723     dev[0].add_cred_values({ 'realm': "example.com",
1724                              'username': "hs20-subrem-test",
1725                              'password': "password" })
1726     interworking_select(dev[0], bssid, freq="2412")
1727     interworking_connect(dev[0], bssid, "TTLS")
1728     ev = dev[0].wait_event(["HS20-SUBSCRIPTION-REMEDIATION"], timeout=5)
1729     if ev is None:
1730         raise Exception("Timeout on subscription remediation notice")
1731     if " 1 https://example.com/" not in ev:
1732         raise Exception("Unexpected subscription remediation event contents")
1733
1734 def test_ap_hs20_remediation_required_ctrl(dev, apdev):
1735     """Hotspot 2.0 connection and subrem from ctrl_iface"""
1736     try:
1737         _test_ap_hs20_remediation_required_ctrl(dev, apdev)
1738     finally:
1739         dev[0].request("SET pmf 0")
1740
1741 def _test_ap_hs20_remediation_required_ctrl(dev, apdev):
1742     bssid = apdev[0]['bssid']
1743     addr = dev[0].p2p_dev_addr()
1744     params = hs20_ap_params()
1745     params['nai_realm'] = [ "0,example.com,21[2:4]" ]
1746     hapd = hostapd.add_ap(apdev[0]['ifname'], params)
1747
1748     dev[0].request("SET pmf 1")
1749     dev[0].hs20_enable()
1750     dev[0].add_cred_values(default_cred())
1751     interworking_select(dev[0], bssid, freq="2412")
1752     interworking_connect(dev[0], bssid, "TTLS")
1753
1754     hapd.request("HS20_WNM_NOTIF " + addr + " https://example.com/")
1755     ev = dev[0].wait_event(["HS20-SUBSCRIPTION-REMEDIATION"], timeout=5)
1756     if ev is None:
1757         raise Exception("Timeout on subscription remediation notice")
1758     if " 1 https://example.com/" not in ev:
1759         raise Exception("Unexpected subscription remediation event contents")
1760
1761     hapd.request("HS20_WNM_NOTIF " + addr)
1762     ev = dev[0].wait_event(["HS20-SUBSCRIPTION-REMEDIATION"], timeout=5)
1763     if ev is None:
1764         raise Exception("Timeout on subscription remediation notice")
1765     if not ev.endswith("HS20-SUBSCRIPTION-REMEDIATION "):
1766         raise Exception("Unexpected subscription remediation event contents: " + ev)
1767
1768     if "FAIL" not in hapd.request("HS20_WNM_NOTIF "):
1769         raise Exception("Unexpected HS20_WNM_NOTIF success")
1770     if "FAIL" not in hapd.request("HS20_WNM_NOTIF foo"):
1771         raise Exception("Unexpected HS20_WNM_NOTIF success")
1772     if "FAIL" not in hapd.request("HS20_WNM_NOTIF " + addr + " https://12345678923456789842345678456783456712345678923456789842345678456783456712345678923456789842345678456783456712345678923456789842345678456783456712345678923456789842345678456783456712345678923456789842345678456783456712345678923456789842345678456783456712345678927.very.long.example.com/"):
1773         raise Exception("Unexpected HS20_WNM_NOTIF success")
1774
1775 def test_ap_hs20_session_info(dev, apdev):
1776     """Hotspot 2.0 connection and session information from RADIUS"""
1777     try:
1778         _test_ap_hs20_session_info(dev, apdev)
1779     finally:
1780         dev[0].request("SET pmf 0")
1781
1782 def _test_ap_hs20_session_info(dev, apdev):
1783     bssid = apdev[0]['bssid']
1784     params = hs20_ap_params()
1785     params['nai_realm'] = [ "0,example.com,21[2:4]" ]
1786     hostapd.add_ap(apdev[0]['ifname'], params)
1787
1788     dev[0].request("SET pmf 1")
1789     dev[0].hs20_enable()
1790     dev[0].add_cred_values({ 'realm': "example.com",
1791                              'username': "hs20-session-info-test",
1792                              'password': "password" })
1793     interworking_select(dev[0], bssid, freq="2412")
1794     interworking_connect(dev[0], bssid, "TTLS")
1795     ev = dev[0].wait_event(["ESS-DISASSOC-IMMINENT"], timeout=10)
1796     if ev is None:
1797         raise Exception("Timeout on ESS disassociation imminent notice")
1798     if " 1 59904 https://example.com/" not in ev:
1799         raise Exception("Unexpected ESS disassociation imminent event contents")
1800     ev = dev[0].wait_event(["CTRL-EVENT-SCAN-STARTED"])
1801     if ev is None:
1802         raise Exception("Scan not started")
1803     ev = dev[0].wait_event(["CTRL-EVENT-SCAN-RESULTS"], timeout=30)
1804     if ev is None:
1805         raise Exception("Scan not completed")
1806
1807 def test_ap_hs20_osen(dev, apdev):
1808     """Hotspot 2.0 OSEN connection"""
1809     params = { 'ssid': "osen",
1810                'osen': "1",
1811                'auth_server_addr': "127.0.0.1",
1812                'auth_server_port': "1812",
1813                'auth_server_shared_secret': "radius" }
1814     hostapd.add_ap(apdev[0]['ifname'], params)
1815
1816     dev[1].connect("osen", key_mgmt="NONE", scan_freq="2412",
1817                    wait_connect=False)
1818     dev[2].connect("osen", key_mgmt="NONE", wep_key0='"hello"',
1819                    scan_freq="2412", wait_connect=False)
1820     dev[0].connect("osen", proto="OSEN", key_mgmt="OSEN", pairwise="CCMP",
1821                    group="GTK_NOT_USED",
1822                    eap="WFA-UNAUTH-TLS", identity="osen@example.com",
1823                    ca_cert="auth_serv/ca.pem",
1824                    scan_freq="2412")
1825
1826     wpas = WpaSupplicant(global_iface='/tmp/wpas-wlan5')
1827     wpas.interface_add("wlan5", drv_params="force_connect_cmd=1")
1828     wpas.connect("osen", proto="OSEN", key_mgmt="OSEN", pairwise="CCMP",
1829                  group="GTK_NOT_USED",
1830                  eap="WFA-UNAUTH-TLS", identity="osen@example.com",
1831                  ca_cert="auth_serv/ca.pem",
1832                  scan_freq="2412")
1833     wpas.request("DISCONNECT")
1834
1835 def test_ap_hs20_network_preference(dev, apdev):
1836     """Hotspot 2.0 network selection with preferred home network"""
1837     bssid = apdev[0]['bssid']
1838     params = hs20_ap_params()
1839     hostapd.add_ap(apdev[0]['ifname'], params)
1840
1841     dev[0].hs20_enable()
1842     values = { 'realm': "example.com",
1843                'username': "hs20-test",
1844                'password': "password",
1845                'domain': "example.com" }
1846     dev[0].add_cred_values(values)
1847
1848     id = dev[0].add_network()
1849     dev[0].set_network_quoted(id, "ssid", "home")
1850     dev[0].set_network_quoted(id, "psk", "12345678")
1851     dev[0].set_network(id, "priority", "1")
1852     dev[0].request("ENABLE_NETWORK %s no-connect" % id)
1853
1854     dev[0].scan_for_bss(bssid, freq="2412")
1855     dev[0].request("INTERWORKING_SELECT auto freq=2412")
1856     ev = dev[0].wait_event(["CTRL-EVENT-CONNECTED"], timeout=15)
1857     if ev is None:
1858         raise Exception("Connection timed out")
1859     if bssid not in ev:
1860         raise Exception("Unexpected network selected")
1861
1862     bssid2 = apdev[1]['bssid']
1863     params = hostapd.wpa2_params(ssid="home", passphrase="12345678")
1864     hostapd.add_ap(apdev[1]['ifname'], params)
1865
1866     dev[0].scan_for_bss(bssid2, freq="2412")
1867     dev[0].request("INTERWORKING_SELECT auto freq=2412")
1868     ev = dev[0].wait_event(["CTRL-EVENT-CONNECTED",
1869                             "INTERWORKING-ALREADY-CONNECTED" ], timeout=15)
1870     if ev is None:
1871         raise Exception("Connection timed out")
1872     if "INTERWORKING-ALREADY-CONNECTED" in ev:
1873         raise Exception("No roam to higher priority network")
1874     if bssid2 not in ev:
1875         raise Exception("Unexpected network selected")
1876
1877 def test_ap_hs20_network_preference2(dev, apdev):
1878     """Hotspot 2.0 network selection with preferred credential"""
1879     bssid2 = apdev[1]['bssid']
1880     params = hostapd.wpa2_params(ssid="home", passphrase="12345678")
1881     hostapd.add_ap(apdev[1]['ifname'], params)
1882
1883     dev[0].hs20_enable()
1884     values = { 'realm': "example.com",
1885                'username': "hs20-test",
1886                'password': "password",
1887                'domain': "example.com",
1888                'priority': "1" }
1889     dev[0].add_cred_values(values)
1890
1891     id = dev[0].add_network()
1892     dev[0].set_network_quoted(id, "ssid", "home")
1893     dev[0].set_network_quoted(id, "psk", "12345678")
1894     dev[0].request("ENABLE_NETWORK %s no-connect" % id)
1895
1896     dev[0].scan_for_bss(bssid2, freq="2412")
1897     dev[0].request("INTERWORKING_SELECT auto freq=2412")
1898     ev = dev[0].wait_event(["CTRL-EVENT-CONNECTED"], timeout=15)
1899     if ev is None:
1900         raise Exception("Connection timed out")
1901     if bssid2 not in ev:
1902         raise Exception("Unexpected network selected")
1903
1904     bssid = apdev[0]['bssid']
1905     params = hs20_ap_params()
1906     hostapd.add_ap(apdev[0]['ifname'], params)
1907
1908     dev[0].scan_for_bss(bssid, freq="2412")
1909     dev[0].request("INTERWORKING_SELECT auto freq=2412")
1910     ev = dev[0].wait_event(["CTRL-EVENT-CONNECTED",
1911                             "INTERWORKING-ALREADY-CONNECTED" ], timeout=15)
1912     if ev is None:
1913         raise Exception("Connection timed out")
1914     if "INTERWORKING-ALREADY-CONNECTED" in ev:
1915         raise Exception("No roam to higher priority network")
1916     if bssid not in ev:
1917         raise Exception("Unexpected network selected")
1918
1919 def test_ap_hs20_network_preference3(dev, apdev):
1920     """Hotspot 2.0 network selection with two credential (one preferred)"""
1921     bssid = apdev[0]['bssid']
1922     params = hs20_ap_params()
1923     hostapd.add_ap(apdev[0]['ifname'], params)
1924
1925     bssid2 = apdev[1]['bssid']
1926     params = hs20_ap_params(ssid="test-hs20b")
1927     params['nai_realm'] = "0,example.org,13[5:6],21[2:4][5:7]"
1928     hostapd.add_ap(apdev[1]['ifname'], params)
1929
1930     dev[0].hs20_enable()
1931     values = { 'realm': "example.com",
1932                'username': "hs20-test",
1933                'password': "password",
1934                'priority': "1" }
1935     dev[0].add_cred_values(values)
1936     values = { 'realm': "example.org",
1937                'username': "hs20-test",
1938                'password': "password" }
1939     id = dev[0].add_cred_values(values)
1940
1941     dev[0].scan_for_bss(bssid, freq="2412")
1942     dev[0].scan_for_bss(bssid2, freq="2412")
1943     dev[0].request("INTERWORKING_SELECT auto freq=2412")
1944     ev = dev[0].wait_event(["CTRL-EVENT-CONNECTED"], timeout=15)
1945     if ev is None:
1946         raise Exception("Connection timed out")
1947     if bssid not in ev:
1948         raise Exception("Unexpected network selected")
1949
1950     dev[0].set_cred(id, "priority", "2")
1951     dev[0].request("INTERWORKING_SELECT auto freq=2412")
1952     ev = dev[0].wait_event(["CTRL-EVENT-CONNECTED",
1953                             "INTERWORKING-ALREADY-CONNECTED" ], timeout=15)
1954     if ev is None:
1955         raise Exception("Connection timed out")
1956     if "INTERWORKING-ALREADY-CONNECTED" in ev:
1957         raise Exception("No roam to higher priority network")
1958     if bssid2 not in ev:
1959         raise Exception("Unexpected network selected")
1960
1961 def test_ap_hs20_network_preference4(dev, apdev):
1962     """Hotspot 2.0 network selection with username vs. SIM credential"""
1963     bssid = apdev[0]['bssid']
1964     params = hs20_ap_params()
1965     hostapd.add_ap(apdev[0]['ifname'], params)
1966
1967     bssid2 = apdev[1]['bssid']
1968     params = hs20_ap_params(ssid="test-hs20b")
1969     params['hessid'] = bssid2
1970     params['anqp_3gpp_cell_net'] = "555,444"
1971     params['domain_name'] = "wlan.mnc444.mcc555.3gppnetwork.org"
1972     hostapd.add_ap(apdev[1]['ifname'], params)
1973
1974     dev[0].hs20_enable()
1975     values = { 'realm': "example.com",
1976                'username': "hs20-test",
1977                'password': "password",
1978                'priority': "1" }
1979     dev[0].add_cred_values(values)
1980     values = { 'imsi': "555444-333222111",
1981                'eap': "SIM",
1982                'milenage': "5122250214c33e723a5dd523fc145fc0:981d464c7c52eb6e5036234984ad0bcf:000000000123" }
1983     id = dev[0].add_cred_values(values)
1984
1985     dev[0].scan_for_bss(bssid, freq="2412")
1986     dev[0].scan_for_bss(bssid2, freq="2412")
1987     dev[0].request("INTERWORKING_SELECT auto freq=2412")
1988     ev = dev[0].wait_event(["CTRL-EVENT-CONNECTED"], timeout=15)
1989     if ev is None:
1990         raise Exception("Connection timed out")
1991     if bssid not in ev:
1992         raise Exception("Unexpected network selected")
1993
1994     dev[0].set_cred(id, "priority", "2")
1995     dev[0].request("INTERWORKING_SELECT auto freq=2412")
1996     ev = dev[0].wait_event(["CTRL-EVENT-CONNECTED",
1997                             "INTERWORKING-ALREADY-CONNECTED" ], timeout=15)
1998     if ev is None:
1999         raise Exception("Connection timed out")
2000     if "INTERWORKING-ALREADY-CONNECTED" in ev:
2001         raise Exception("No roam to higher priority network")
2002     if bssid2 not in ev:
2003         raise Exception("Unexpected network selected")
2004
2005 def test_ap_hs20_fetch_osu(dev, apdev):
2006     """Hotspot 2.0 OSU provider and icon fetch"""
2007     bssid = apdev[0]['bssid']
2008     params = hs20_ap_params()
2009     params['hs20_icon'] = "128:80:zxx:image/png:w1fi_logo:w1fi_logo.png"
2010     params['osu_ssid'] = '"HS 2.0 OSU open"'
2011     params['osu_method_list'] = "1"
2012     params['osu_friendly_name'] = [ "eng:Test OSU", "fin:Testi-OSU" ]
2013     params['osu_icon'] = "w1fi_logo"
2014     params['osu_service_desc'] = [ "eng:Example services", "fin:Esimerkkipalveluja" ]
2015     params['osu_server_uri'] = "https://example.com/osu/"
2016     hostapd.add_ap(apdev[0]['ifname'], params)
2017
2018     bssid2 = apdev[1]['bssid']
2019     params = hs20_ap_params(ssid="test-hs20b")
2020     params['hessid'] = bssid2
2021     params['hs20_icon'] = "128:80:zxx:image/png:w1fi_logo:w1fi_logo.png"
2022     params['osu_ssid'] = '"HS 2.0 OSU OSEN"'
2023     params['osu_method_list'] = "0"
2024     params['osu_nai'] = "osen@example.com"
2025     params['osu_friendly_name'] = [ "eng:Test2 OSU", "fin:Testi2-OSU" ]
2026     params['osu_icon'] = "w1fi_logo"
2027     params['osu_service_desc'] = [ "eng:Example services2", "fin:Esimerkkipalveluja2" ]
2028     params['osu_server_uri'] = "https://example.org/osu/"
2029     hostapd.add_ap(apdev[1]['ifname'], params)
2030
2031     with open("w1fi_logo.png", "r") as f:
2032         orig_logo = f.read()
2033     dev[0].hs20_enable()
2034     dir = "/tmp/osu-fetch"
2035     if os.path.isdir(dir):
2036        files = [ f for f in os.listdir(dir) if f.startswith("osu-") ]
2037        for f in files:
2038            os.remove(dir + "/" + f)
2039     else:
2040         try:
2041             os.makedirs(dir)
2042         except:
2043             pass
2044     try:
2045         dev[1].scan_for_bss(bssid, freq="2412")
2046         dev[0].request("SET osu_dir " + dir)
2047         dev[0].request("FETCH_OSU")
2048         if "FAIL" not in dev[1].request("HS20_ICON_REQUEST foo w1fi_logo"):
2049             raise Exception("Invalid HS20_ICON_REQUEST accepted")
2050         if "OK" not in dev[1].request("HS20_ICON_REQUEST " + bssid + " w1fi_logo"):
2051             raise Exception("HS20_ICON_REQUEST failed")
2052         icons = 0
2053         while True:
2054             ev = dev[0].wait_event(["OSU provider fetch completed",
2055                                     "RX-HS20-ANQP-ICON"], timeout=15)
2056             if ev is None:
2057                 raise Exception("Timeout on OSU fetch")
2058             if "OSU provider fetch completed" in ev:
2059                 break
2060             if "RX-HS20-ANQP-ICON" in ev:
2061                 with open(ev.split(' ')[1], "r") as f:
2062                     logo = f.read()
2063                     if logo == orig_logo:
2064                         icons += 1
2065
2066         with open(dir + "/osu-providers.txt", "r") as f:
2067             prov = f.read()
2068         if "OSU-PROVIDER " + bssid not in prov:
2069             raise Exception("Missing OSU_PROVIDER")
2070         if "OSU-PROVIDER " + bssid2 not in prov:
2071             raise Exception("Missing OSU_PROVIDER")
2072     finally:
2073         files = [ f for f in os.listdir(dir) if f.startswith("osu-") ]
2074         for f in files:
2075             os.remove(dir + "/" + f)
2076         os.rmdir(dir)
2077
2078     if icons != 2:
2079         raise Exception("Unexpected number of icons fetched")
2080
2081     ev = dev[1].wait_event(["GAS-QUERY-START"], timeout=5)
2082     if ev is None:
2083         raise Exception("Timeout on GAS-QUERY-DONE")
2084     ev = dev[1].wait_event(["GAS-QUERY-DONE"], timeout=5)
2085     if ev is None:
2086         raise Exception("Timeout on GAS-QUERY-DONE")
2087     if "freq=2412 status_code=0 result=SUCCESS" not in ev:
2088         raise Exception("Unexpected GAS-QUERY-DONE: " + ev)
2089     ev = dev[1].wait_event(["RX-HS20-ANQP"], timeout=15)
2090     if ev is None:
2091         raise Exception("Timeout on icon fetch")
2092     if "Icon Binary File" not in ev:
2093         raise Exception("Unexpected ANQP element")
2094
2095 def test_ap_hs20_ft(dev, apdev):
2096     """Hotspot 2.0 connection with FT"""
2097     bssid = apdev[0]['bssid']
2098     params = hs20_ap_params()
2099     params['wpa_key_mgmt'] = "FT-EAP"
2100     params['nas_identifier'] = "nas1.w1.fi"
2101     params['r1_key_holder'] = "000102030405"
2102     params["mobility_domain"] = "a1b2"
2103     params["reassociation_deadline"] = "1000"
2104     hostapd.add_ap(apdev[0]['ifname'], params)
2105
2106     dev[0].hs20_enable()
2107     id = dev[0].add_cred_values({ 'realm': "example.com",
2108                                   'username': "hs20-test",
2109                                   'password': "password",
2110                                   'ca_cert': "auth_serv/ca.pem",
2111                                   'domain': "example.com",
2112                                   'update_identifier': "1234" })
2113     interworking_select(dev[0], bssid, "home", freq="2412")
2114     interworking_connect(dev[0], bssid, "TTLS")
2115
2116 def test_ap_hs20_remediation_sql(dev, apdev, params):
2117     """Hotspot 2.0 connection and remediation required using SQLite for user DB"""
2118     try:
2119         import sqlite3
2120     except ImportError:
2121         return "skip"
2122     dbfile = os.path.join(params['logdir'], "eap-user.db")
2123     try:
2124         os.remove(dbfile)
2125     except:
2126         pass
2127     con = sqlite3.connect(dbfile)
2128     with con:
2129         cur = con.cursor()
2130         cur.execute("CREATE TABLE users(identity TEXT PRIMARY KEY, methods TEXT, password TEXT, remediation TEXT, phase2 INTEGER)")
2131         cur.execute("CREATE TABLE wildcards(identity TEXT PRIMARY KEY, methods TEXT)")
2132         cur.execute("INSERT INTO users(identity,methods,password,phase2,remediation) VALUES ('user-mschapv2','TTLS-MSCHAPV2','password',1,'user')")
2133         cur.execute("INSERT INTO wildcards(identity,methods) VALUES ('','TTLS,TLS')")
2134         cur.execute("CREATE TABLE authlog(timestamp TEXT, session TEXT, nas_ip TEXT, username TEXT, note TEXT)")
2135
2136     try:
2137         params = { "ssid": "as", "beacon_int": "2000",
2138                    "radius_server_clients": "auth_serv/radius_clients.conf",
2139                    "radius_server_auth_port": '18128',
2140                    "eap_server": "1",
2141                    "eap_user_file": "sqlite:" + dbfile,
2142                    "ca_cert": "auth_serv/ca.pem",
2143                    "server_cert": "auth_serv/server.pem",
2144                    "private_key": "auth_serv/server.key",
2145                    "subscr_remediation_url": "https://example.org/",
2146                    "subscr_remediation_method": "1" }
2147         hostapd.add_ap(apdev[1]['ifname'], params)
2148
2149         bssid = apdev[0]['bssid']
2150         params = hs20_ap_params()
2151         params['auth_server_port'] = "18128"
2152         hostapd.add_ap(apdev[0]['ifname'], params)
2153
2154         dev[0].request("SET pmf 1")
2155         dev[0].hs20_enable()
2156         id = dev[0].add_cred_values({ 'realm': "example.com",
2157                                       'username': "user-mschapv2",
2158                                       'password': "password",
2159                                       'ca_cert': "auth_serv/ca.pem" })
2160         interworking_select(dev[0], bssid, freq="2412")
2161         interworking_connect(dev[0], bssid, "TTLS")
2162         ev = dev[0].wait_event(["HS20-SUBSCRIPTION-REMEDIATION"], timeout=5)
2163         if ev is None:
2164             raise Exception("Timeout on subscription remediation notice")
2165         if " 1 https://example.org/" not in ev:
2166             raise Exception("Unexpected subscription remediation event contents")
2167
2168         with con:
2169             cur = con.cursor()
2170             cur.execute("SELECT * from authlog")
2171             rows = cur.fetchall()
2172             if len(rows) < 1:
2173                 raise Exception("No authlog entries")
2174
2175     finally:
2176         os.remove(dbfile)
2177         dev[0].request("SET pmf 0")
2178
2179 def test_ap_hs20_external_selection(dev, apdev):
2180     """Hotspot 2.0 connection using external network selection and creation"""
2181     bssid = apdev[0]['bssid']
2182     params = hs20_ap_params()
2183     params['hessid'] = bssid
2184     params['disable_dgaf'] = '1'
2185     hostapd.add_ap(apdev[0]['ifname'], params)
2186
2187     dev[0].hs20_enable()
2188     dev[0].connect("test-hs20", proto="RSN", key_mgmt="WPA-EAP", eap="TTLS",
2189                    identity="hs20-test", password="password",
2190                    ca_cert="auth_serv/ca.pem", phase2="auth=MSCHAPV2",
2191                    scan_freq="2412", update_identifier="54321")
2192     if dev[0].get_status_field("hs20") != "2":
2193         raise Exception("Unexpected hs20 indication")
2194
2195 def test_ap_hs20_random_mac_addr(dev, apdev):
2196     """Hotspot 2.0 connection with random MAC address"""
2197     bssid = apdev[0]['bssid']
2198     params = hs20_ap_params()
2199     params['hessid'] = bssid
2200     params['disable_dgaf'] = '1'
2201     hapd = hostapd.add_ap(apdev[0]['ifname'], params)
2202
2203     wpas = WpaSupplicant(global_iface='/tmp/wpas-wlan5')
2204     wpas.interface_add("wlan5")
2205     addr = wpas.p2p_interface_addr()
2206     wpas.request("SET mac_addr 1")
2207     wpas.request("SET preassoc_mac_addr 1")
2208     wpas.request("SET rand_addr_lifetime 60")
2209     wpas.hs20_enable()
2210     wpas.flush_scan_cache()
2211     id = wpas.add_cred_values({ 'realm': "example.com",
2212                                   'username': "hs20-test",
2213                                   'password': "password",
2214                                   'ca_cert': "auth_serv/ca.pem",
2215                                   'domain': "example.com",
2216                                   'update_identifier': "1234" })
2217     interworking_select(wpas, bssid, "home", freq="2412")
2218     interworking_connect(wpas, bssid, "TTLS")
2219     addr1 = wpas.get_driver_status_field("addr")
2220     if addr == addr1:
2221         raise Exception("Did not use random MAC address")
2222
2223     sta = hapd.get_sta(addr)
2224     if sta['addr'] != "FAIL":
2225         raise Exception("Unexpected STA association with permanent address")
2226     sta = hapd.get_sta(addr1)
2227     if sta['addr'] != addr1:
2228         raise Exception("STA association with random address not found")
2229
2230 def test_ap_hs20_multi_network_and_cred_removal(dev, apdev):
2231     """Multiple networks and cred removal"""
2232     bssid = apdev[0]['bssid']
2233     params = hs20_ap_params()
2234     params['nai_realm'] = [ "0,example.com,25[3:26]"]
2235     hapd = hostapd.add_ap(apdev[0]['ifname'], params)
2236
2237     dev[0].add_network()
2238     dev[0].hs20_enable()
2239     id = dev[0].add_cred_values({ 'realm': "example.com",
2240                                   'username': "user",
2241                                   'password': "password" })
2242     interworking_select(dev[0], bssid, freq="2412")
2243     interworking_connect(dev[0], bssid, "PEAP")
2244     dev[0].add_network()
2245
2246     dev[0].request("DISCONNECT")
2247     ev = dev[0].wait_event(["CTRL-EVENT-DISCONNECTED"])
2248     if ev is None:
2249         raise Exception("Timeout on disconnection")
2250
2251     hapd.disable()
2252     hapd.set("ssid", "another ssid")
2253     hapd.enable()
2254
2255     interworking_select(dev[0], bssid, freq="2412")
2256     interworking_connect(dev[0], bssid, "PEAP")
2257     dev[0].add_network()
2258     if len(dev[0].list_networks()) != 5:
2259         raise Exception("Unexpected number of networks prior to remove_crec")
2260
2261     dev[0].dump_monitor()
2262     dev[0].remove_cred(id)
2263     if len(dev[0].list_networks()) != 3:
2264         raise Exception("Unexpected number of networks after to remove_crec")
2265     ev = dev[0].wait_event(["CTRL-EVENT-DISCONNECTED"])
2266     if ev is None:
2267         raise Exception("Timeout on disconnection")
2268
2269 def _test_ap_hs20_proxyarp(dev, apdev):
2270     bssid = apdev[0]['bssid']
2271     params = hs20_ap_params()
2272     params['hessid'] = bssid
2273     params['disable_dgaf'] = '0'
2274     params['proxy_arp'] = '1'
2275     hapd = hostapd.add_ap(apdev[0]['ifname'], params, no_enable=True)
2276     if "OK" in hapd.request("ENABLE"):
2277         raise Exception("Incomplete hostapd configuration was accepted")
2278     hapd.set("ap_isolate", "1")
2279     if "OK" in hapd.request("ENABLE"):
2280         raise Exception("Incomplete hostapd configuration was accepted")
2281     hapd.set('bridge', 'ap-br0')
2282     hapd.dump_monitor()
2283     try:
2284         hapd.enable()
2285     except:
2286         # For now, do not report failures due to missing kernel support
2287         logger.info("Could not start hostapd - assume proxyarp not supported in kernel version")
2288         return "skip"
2289     ev = hapd.wait_event(["AP-ENABLED", "AP-DISABLED"], timeout=10)
2290     if ev is None:
2291         raise Exception("AP startup timed out")
2292     if "AP-ENABLED" not in ev:
2293         raise Exception("AP startup failed")
2294
2295     dev[0].hs20_enable()
2296     subprocess.call(['brctl', 'setfd', 'ap-br0', '0'])
2297     subprocess.call(['ip', 'link', 'set', 'dev', 'ap-br0', 'up'])
2298
2299     id = dev[0].add_cred_values({ 'realm': "example.com",
2300                                   'username': "hs20-test",
2301                                   'password': "password",
2302                                   'ca_cert': "auth_serv/ca.pem",
2303                                   'domain': "example.com",
2304                                   'update_identifier': "1234" })
2305     interworking_select(dev[0], bssid, "home", freq="2412")
2306     interworking_connect(dev[0], bssid, "TTLS")
2307
2308     dev[1].connect("test-hs20", key_mgmt="WPA-EAP", eap="TTLS",
2309                    identity="hs20-test", password="password",
2310                    ca_cert="auth_serv/ca.pem", phase2="auth=MSCHAPV2",
2311                    scan_freq="2412")
2312     time.sleep(0.1)
2313
2314     addr0 = dev[0].p2p_interface_addr()
2315     addr1 = dev[1].p2p_interface_addr()
2316
2317     src_ll_opt0 = "\x01\x01" + binascii.unhexlify(addr0.replace(':',''))
2318     src_ll_opt1 = "\x01\x01" + binascii.unhexlify(addr1.replace(':',''))
2319
2320     pkt = build_ns(src_ll=addr0, ip_src="aaaa:bbbb:cccc::2",
2321                    ip_dst="ff02::1:ff00:2", target="aaaa:bbbb:cccc::2",
2322                    opt=src_ll_opt0)
2323     if "OK" not in dev[0].request("DATA_TEST_FRAME " + binascii.hexlify(pkt)):
2324         raise Exception("DATA_TEST_FRAME failed")
2325
2326     pkt = build_ns(src_ll=addr1, ip_src="aaaa:bbbb:dddd::2",
2327                    ip_dst="ff02::1:ff00:2", target="aaaa:bbbb:dddd::2",
2328                    opt=src_ll_opt1)
2329     if "OK" not in dev[1].request("DATA_TEST_FRAME " + binascii.hexlify(pkt)):
2330         raise Exception("DATA_TEST_FRAME failed")
2331
2332     pkt = build_ns(src_ll=addr1, ip_src="aaaa:bbbb:eeee::2",
2333                    ip_dst="ff02::1:ff00:2", target="aaaa:bbbb:eeee::2",
2334                    opt=src_ll_opt1)
2335     if "OK" not in dev[1].request("DATA_TEST_FRAME " + binascii.hexlify(pkt)):
2336         raise Exception("DATA_TEST_FRAME failed")
2337
2338     matches = get_permanent_neighbors("ap-br0")
2339     logger.info("After connect: " + str(matches))
2340     if len(matches) != 3:
2341         raise Exception("Unexpected number of neighbor entries after connect")
2342     if 'aaaa:bbbb:cccc::2 dev ap-br0 lladdr 02:00:00:00:00:00 PERMANENT' not in matches:
2343         raise Exception("dev0 addr missing")
2344     if 'aaaa:bbbb:dddd::2 dev ap-br0 lladdr 02:00:00:00:01:00 PERMANENT' not in matches:
2345         raise Exception("dev1 addr(1) missing")
2346     if 'aaaa:bbbb:eeee::2 dev ap-br0 lladdr 02:00:00:00:01:00 PERMANENT' not in matches:
2347         raise Exception("dev1 addr(2) missing")
2348     dev[0].request("DISCONNECT")
2349     dev[1].request("DISCONNECT")
2350     time.sleep(0.5)
2351     matches = get_permanent_neighbors("ap-br0")
2352     logger.info("After disconnect: " + str(matches))
2353     if len(matches) > 0:
2354         raise Exception("Unexpected neighbor entries after disconnect")
2355
2356 def test_ap_hs20_proxyarp(dev, apdev):
2357     """Hotspot 2.0 and ProxyARP"""
2358     res = None
2359     try:
2360         res = _test_ap_hs20_proxyarp(dev, apdev)
2361     finally:
2362         subprocess.call(['ip', 'link', 'set', 'dev', 'ap-br0', 'down'],
2363                         stderr=open('/dev/null', 'w'))
2364         subprocess.call(['brctl', 'delbr', 'ap-br0'],
2365                         stderr=open('/dev/null', 'w'))
2366
2367     return res
2368
2369 def _test_ap_hs20_proxyarp_dgaf(dev, apdev, disabled):
2370     bssid = apdev[0]['bssid']
2371     params = hs20_ap_params()
2372     params['hessid'] = bssid
2373     params['disable_dgaf'] = '1' if disabled else '0'
2374     params['proxy_arp'] = '1'
2375     params['ap_isolate'] = '1'
2376     params['bridge'] = 'ap-br0'
2377     hapd = hostapd.add_ap(apdev[0]['ifname'], params, no_enable=True)
2378     try:
2379         hapd.enable()
2380     except:
2381         # For now, do not report failures due to missing kernel support
2382         logger.info("Could not start hostapd - assume proxyarp not supported in kernel version")
2383         return "skip"
2384     ev = hapd.wait_event(["AP-ENABLED"], timeout=10)
2385     if ev is None:
2386         raise Exception("AP startup timed out")
2387
2388     dev[0].hs20_enable()
2389     subprocess.call(['brctl', 'setfd', 'ap-br0', '0'])
2390     subprocess.call(['ip', 'link', 'set', 'dev', 'ap-br0', 'up'])
2391
2392     id = dev[0].add_cred_values({ 'realm': "example.com",
2393                                   'username': "hs20-test",
2394                                   'password': "password",
2395                                   'ca_cert': "auth_serv/ca.pem",
2396                                   'domain': "example.com",
2397                                   'update_identifier': "1234" })
2398     interworking_select(dev[0], bssid, "home", freq="2412")
2399     interworking_connect(dev[0], bssid, "TTLS")
2400
2401     dev[1].connect("test-hs20", key_mgmt="WPA-EAP", eap="TTLS",
2402                    identity="hs20-test", password="password",
2403                    ca_cert="auth_serv/ca.pem", phase2="auth=MSCHAPV2",
2404                    scan_freq="2412")
2405     time.sleep(0.1)
2406
2407     addr0 = dev[0].p2p_interface_addr()
2408
2409     src_ll_opt0 = "\x01\x01" + binascii.unhexlify(addr0.replace(':',''))
2410
2411     pkt = build_ns(src_ll=addr0, ip_src="aaaa:bbbb:cccc::2",
2412                    ip_dst="ff02::1:ff00:2", target="aaaa:bbbb:cccc::2",
2413                    opt=src_ll_opt0)
2414     if "OK" not in dev[0].request("DATA_TEST_FRAME " + binascii.hexlify(pkt)):
2415         raise Exception("DATA_TEST_FRAME failed")
2416
2417     pkt = build_ra(src_ll=apdev[0]['bssid'], ip_src="aaaa:bbbb:cccc::33",
2418                    ip_dst="ff01::1")
2419     if "OK" not in hapd.request("DATA_TEST_FRAME ifname=ap-br0 " + binascii.hexlify(pkt)):
2420         raise Exception("DATA_TEST_FRAME failed")
2421
2422     pkt = build_na(src_ll=apdev[0]['bssid'], ip_src="aaaa:bbbb:cccc::44",
2423                    ip_dst="ff01::1", target="aaaa:bbbb:cccc::55")
2424     if "OK" not in hapd.request("DATA_TEST_FRAME ifname=ap-br0 " + binascii.hexlify(pkt)):
2425         raise Exception("DATA_TEST_FRAME failed")
2426
2427     pkt = build_dhcp_ack(dst_ll="ff:ff:ff:ff:ff:ff", src_ll=bssid,
2428                          ip_src="192.168.1.1", ip_dst="255.255.255.255",
2429                          yiaddr="192.168.1.123", chaddr=addr0)
2430     if "OK" not in hapd.request("DATA_TEST_FRAME ifname=ap-br0 " + binascii.hexlify(pkt)):
2431         raise Exception("DATA_TEST_FRAME failed")
2432     # another copy for additional code coverage
2433     pkt = build_dhcp_ack(dst_ll=addr0, src_ll=bssid,
2434                          ip_src="192.168.1.1", ip_dst="255.255.255.255",
2435                          yiaddr="192.168.1.123", chaddr=addr0)
2436     if "OK" not in hapd.request("DATA_TEST_FRAME ifname=ap-br0 " + binascii.hexlify(pkt)):
2437         raise Exception("DATA_TEST_FRAME failed")
2438
2439     matches = get_permanent_neighbors("ap-br0")
2440     logger.info("After connect: " + str(matches))
2441     if len(matches) != 2:
2442         raise Exception("Unexpected number of neighbor entries after connect")
2443     if 'aaaa:bbbb:cccc::2 dev ap-br0 lladdr 02:00:00:00:00:00 PERMANENT' not in matches:
2444         raise Exception("dev0 addr missing")
2445     if '192.168.1.123 dev ap-br0 lladdr 02:00:00:00:00:00 PERMANENT' not in matches:
2446         raise Exception("dev0 IPv4 addr missing")
2447     dev[0].request("DISCONNECT")
2448     dev[1].request("DISCONNECT")
2449     time.sleep(0.5)
2450     matches = get_permanent_neighbors("ap-br0")
2451     logger.info("After disconnect: " + str(matches))
2452     if len(matches) > 0:
2453         raise Exception("Unexpected neighbor entries after disconnect")
2454
2455 def test_ap_hs20_proxyarp_disable_dgaf(dev, apdev):
2456     """Hotspot 2.0 and ProxyARP with DGAF disabled"""
2457     res = None
2458     try:
2459         res = _test_ap_hs20_proxyarp_dgaf(dev, apdev, True)
2460     finally:
2461         subprocess.call(['ip', 'link', 'set', 'dev', 'ap-br0', 'down'],
2462                         stderr=open('/dev/null', 'w'))
2463         subprocess.call(['brctl', 'delbr', 'ap-br0'],
2464                         stderr=open('/dev/null', 'w'))
2465
2466     return res
2467
2468 def test_ap_hs20_proxyarp_enable_dgaf(dev, apdev):
2469     """Hotspot 2.0 and ProxyARP with DGAF enabled"""
2470     res = None
2471     try:
2472         res = _test_ap_hs20_proxyarp_dgaf(dev, apdev, False)
2473     finally:
2474         subprocess.call(['ip', 'link', 'set', 'dev', 'ap-br0', 'down'],
2475                         stderr=open('/dev/null', 'w'))
2476         subprocess.call(['brctl', 'delbr', 'ap-br0'],
2477                         stderr=open('/dev/null', 'w'))
2478
2479     return res
2480
2481 def ip_checksum(buf):
2482     sum = 0
2483     if len(buf) & 0x01:
2484         buf += '\0x00'
2485     for i in range(0, len(buf), 2):
2486         val, = struct.unpack('H', buf[i:i+2])
2487         sum += val
2488     while (sum >> 16):
2489         sum = (sum & 0xffff) + (sum >> 16)
2490     return struct.pack('H', ~sum & 0xffff)
2491
2492 def build_icmpv6(ipv6_addrs, type, code, payload):
2493     start = struct.pack("BB", type, code)
2494     end = payload
2495     icmp = start + '\x00\x00' + end
2496     pseudo = ipv6_addrs + struct.pack(">LBBBB", len(icmp), 0, 0, 0, 58)
2497     csum = ip_checksum(pseudo + icmp)
2498     return start + csum + end
2499
2500 def build_ra(src_ll, ip_src, ip_dst, cur_hop_limit=0, router_lifetime=0,
2501              reachable_time=0, retrans_timer=0, opt=None):
2502     link_mc = binascii.unhexlify("3333ff000002")
2503     _src_ll = binascii.unhexlify(src_ll.replace(':',''))
2504     proto = '\x86\xdd'
2505     ehdr = link_mc + _src_ll + proto
2506     _ip_src = socket.inet_pton(socket.AF_INET6, ip_src)
2507     _ip_dst = socket.inet_pton(socket.AF_INET6, ip_dst)
2508
2509     adv = struct.pack('>BBHLL', cur_hop_limit, 0, router_lifetime,
2510                       reachable_time, retrans_timer)
2511     if opt:
2512         payload = adv + opt
2513     else:
2514         payload = adv
2515     icmp = build_icmpv6(_ip_src + _ip_dst, 134, 0, payload)
2516
2517     ipv6 = struct.pack('>BBBBHBB', 0x60, 0, 0, 0, len(icmp), 58, 255)
2518     ipv6 += _ip_src + _ip_dst
2519
2520     return ehdr + ipv6 + icmp
2521
2522 def build_ns(src_ll, ip_src, ip_dst, target, opt=None):
2523     link_mc = binascii.unhexlify("3333ff000002")
2524     _src_ll = binascii.unhexlify(src_ll.replace(':',''))
2525     proto = '\x86\xdd'
2526     ehdr = link_mc + _src_ll + proto
2527     _ip_src = socket.inet_pton(socket.AF_INET6, ip_src)
2528     _ip_dst = socket.inet_pton(socket.AF_INET6, ip_dst)
2529
2530     reserved = '\x00\x00\x00\x00'
2531     _target = socket.inet_pton(socket.AF_INET6, target)
2532     if opt:
2533         payload = reserved + _target + opt
2534     else:
2535         payload = reserved + _target
2536     icmp = build_icmpv6(_ip_src + _ip_dst, 135, 0, payload)
2537
2538     ipv6 = struct.pack('>BBBBHBB', 0x60, 0, 0, 0, len(icmp), 58, 255)
2539     ipv6 += _ip_src + _ip_dst
2540
2541     return ehdr + ipv6 + icmp
2542
2543 def build_na(src_ll, ip_src, ip_dst, target, opt=None):
2544     link_mc = binascii.unhexlify("3333ff000002")
2545     _src_ll = binascii.unhexlify(src_ll.replace(':',''))
2546     proto = '\x86\xdd'
2547     ehdr = link_mc + _src_ll + proto
2548     _ip_src = socket.inet_pton(socket.AF_INET6, ip_src)
2549     _ip_dst = socket.inet_pton(socket.AF_INET6, ip_dst)
2550
2551     reserved = '\x00\x00\x00\x00'
2552     _target = socket.inet_pton(socket.AF_INET6, target)
2553     if opt:
2554         payload = reserved + _target + opt
2555     else:
2556         payload = reserved + _target
2557     icmp = build_icmpv6(_ip_src + _ip_dst, 136, 0, payload)
2558
2559     ipv6 = struct.pack('>BBBBHBB', 0x60, 0, 0, 0, len(icmp), 58, 255)
2560     ipv6 += _ip_src + _ip_dst
2561
2562     return ehdr + ipv6 + icmp
2563
2564 def build_dhcp_ack(dst_ll, src_ll, ip_src, ip_dst, yiaddr, chaddr,
2565                    subnet_mask="255.255.255.0", truncated_opt=False,
2566                    wrong_magic=False, force_tot_len=None, no_dhcp=False):
2567     _dst_ll = binascii.unhexlify(dst_ll.replace(':',''))
2568     _src_ll = binascii.unhexlify(src_ll.replace(':',''))
2569     proto = '\x08\x00'
2570     ehdr = _dst_ll + _src_ll + proto
2571     _ip_src = socket.inet_pton(socket.AF_INET, ip_src)
2572     _ip_dst = socket.inet_pton(socket.AF_INET, ip_dst)
2573     _subnet_mask = socket.inet_pton(socket.AF_INET, subnet_mask)
2574
2575     _ciaddr = '\x00\x00\x00\x00'
2576     _yiaddr = socket.inet_pton(socket.AF_INET, yiaddr)
2577     _siaddr = '\x00\x00\x00\x00'
2578     _giaddr = '\x00\x00\x00\x00'
2579     _chaddr = binascii.unhexlify(chaddr.replace(':','') + "00000000000000000000")
2580     payload = struct.pack('>BBBBL3BB', 2, 1, 6, 0, 12345, 0, 0, 0, 0)
2581     payload += _ciaddr + _yiaddr + _siaddr + _giaddr + _chaddr + 192*'\x00'
2582     # magic
2583     if wrong_magic:
2584         payload += '\x63\x82\x53\x00'
2585     else:
2586         payload += '\x63\x82\x53\x63'
2587     if truncated_opt:
2588         payload += '\x22\xff\x00'
2589     # Option: DHCP Message Type = ACK
2590     payload += '\x35\x01\x05'
2591     # Pad Option
2592     payload += '\x00'
2593     # Option: Subnet Mask
2594     payload += '\x01\x04' + _subnet_mask
2595     # Option: Time Offset
2596     payload += struct.pack('>BBL', 2, 4, 0)
2597     # End Option
2598     payload += '\xff'
2599     # Pad Option
2600     payload += '\x00\x00\x00\x00'
2601
2602     if no_dhcp:
2603         payload = struct.pack('>BBBBL3BB', 2, 1, 6, 0, 12345, 0, 0, 0, 0)
2604         payload += _ciaddr + _yiaddr + _siaddr + _giaddr + _chaddr + 192*'\x00'
2605
2606     udp = struct.pack('>HHHH', 67, 68, 8 + len(payload), 0) + payload
2607
2608     if force_tot_len:
2609         tot_len = force_tot_len
2610     else:
2611         tot_len = 20 + len(udp)
2612     start = struct.pack('>BBHHBBBB', 0x45, 0, tot_len, 0, 0, 0, 128, 17)
2613     ipv4 = start + '\x00\x00' + _ip_src + _ip_dst
2614     csum = ip_checksum(ipv4)
2615     ipv4 = start + csum + _ip_src + _ip_dst
2616
2617     return ehdr + ipv4 + udp
2618
2619 def build_arp(dst_ll, src_ll, opcode, sender_mac, sender_ip,
2620               target_mac, target_ip):
2621     _dst_ll = binascii.unhexlify(dst_ll.replace(':',''))
2622     _src_ll = binascii.unhexlify(src_ll.replace(':',''))
2623     proto = '\x08\x06'
2624     ehdr = _dst_ll + _src_ll + proto
2625
2626     _sender_mac = binascii.unhexlify(sender_mac.replace(':',''))
2627     _sender_ip = socket.inet_pton(socket.AF_INET, sender_ip)
2628     _target_mac = binascii.unhexlify(target_mac.replace(':',''))
2629     _target_ip = socket.inet_pton(socket.AF_INET, target_ip)
2630
2631     arp = struct.pack('>HHBBH', 1, 0x0800, 6, 4, opcode)
2632     arp += _sender_mac + _sender_ip
2633     arp += _target_mac + _target_ip
2634
2635     return ehdr + arp
2636
2637 def send_arp(dev, dst_ll="ff:ff:ff:ff:ff:ff", src_ll=None, opcode=1,
2638              sender_mac=None, sender_ip="0.0.0.0",
2639              target_mac="00:00:00:00:00:00", target_ip="0.0.0.0",
2640              hapd_bssid=None):
2641     if hapd_bssid:
2642         if src_ll is None:
2643             src_ll = hapd_bssid
2644         if sender_mac is None:
2645             sender_mac = hapd_bssid
2646         cmd = "DATA_TEST_FRAME ifname=ap-br0 "
2647     else:
2648         if src_ll is None:
2649             src_ll = dev.p2p_interface_addr()
2650         if sender_mac is None:
2651             sender_mac = dev.p2p_interface_addr()
2652         cmd = "DATA_TEST_FRAME "
2653
2654     pkt = build_arp(dst_ll="ff:ff:ff:ff:ff:ff", src_ll=src_ll, opcode=opcode,
2655                     sender_mac=sender_mac, sender_ip=sender_ip,
2656                     target_mac=target_mac, target_ip=target_ip)
2657     if "OK" not in dev.request(cmd + binascii.hexlify(pkt)):
2658         raise Exception("DATA_TEST_FRAME failed")
2659
2660 def get_permanent_neighbors(ifname):
2661     cmd = subprocess.Popen(['ip', 'nei'], stdout=subprocess.PIPE)
2662     res = cmd.stdout.read()
2663     cmd.stdout.close()
2664     return [ line for line in res.splitlines() if "PERMANENT" in line and ifname in line ]
2665
2666 def _test_proxyarp_open(dev, apdev, params):
2667     cap_br = os.path.join(params['logdir'], "proxyarp_open.ap-br0.pcap")
2668     cap_dev0 = os.path.join(params['logdir'], "proxyarp_open.%s.pcap" % dev[0].ifname)
2669     cap_dev1 = os.path.join(params['logdir'], "proxyarp_open.%s.pcap" % dev[1].ifname)
2670
2671     bssid = apdev[0]['bssid']
2672     params = { 'ssid': 'open' }
2673     params['proxy_arp'] = '1'
2674     hapd = hostapd.add_ap(apdev[0]['ifname'], params, no_enable=True)
2675     hapd.set("ap_isolate", "1")
2676     hapd.set('bridge', 'ap-br0')
2677     hapd.dump_monitor()
2678     try:
2679         hapd.enable()
2680     except:
2681         # For now, do not report failures due to missing kernel support
2682         logger.info("Could not start hostapd - assume proxyarp not supported in kernel version")
2683         return "skip"
2684     ev = hapd.wait_event(["AP-ENABLED", "AP-DISABLED"], timeout=10)
2685     if ev is None:
2686         raise Exception("AP startup timed out")
2687     if "AP-ENABLED" not in ev:
2688         raise Exception("AP startup failed")
2689
2690     subprocess.call(['brctl', 'setfd', 'ap-br0', '0'])
2691     subprocess.call(['ip', 'link', 'set', 'dev', 'ap-br0', 'up'])
2692
2693     cmd = {}
2694     cmd[0] = subprocess.Popen(['tcpdump', '-i', 'ap-br0', '-w', cap_br,
2695                                '-s', '2000'], stderr=open('/dev/null', 'w'))
2696     cmd[1] = subprocess.Popen(['tcpdump', '-i', dev[0].ifname, '-w', cap_dev0,
2697                                '-s', '2000'], stderr=open('/dev/null', 'w'))
2698     cmd[2] = subprocess.Popen(['tcpdump', '-i', dev[1].ifname, '-w', cap_dev1,
2699                                '-s', '2000'], stderr=open('/dev/null', 'w'))
2700
2701     dev[0].connect("open", key_mgmt="NONE", scan_freq="2412")
2702     dev[1].connect("open", key_mgmt="NONE", scan_freq="2412")
2703     time.sleep(0.1)
2704
2705     addr0 = dev[0].p2p_interface_addr()
2706     addr1 = dev[1].p2p_interface_addr()
2707
2708     src_ll_opt0 = "\x01\x01" + binascii.unhexlify(addr0.replace(':',''))
2709     src_ll_opt1 = "\x01\x01" + binascii.unhexlify(addr1.replace(':',''))
2710
2711     # DAD NS
2712     pkt = build_ns(src_ll=addr0, ip_src="::", ip_dst="ff02::1:ff00:2",
2713                    target="aaaa:bbbb:cccc::2", opt=src_ll_opt0)
2714     if "OK" not in dev[0].request("DATA_TEST_FRAME " + binascii.hexlify(pkt)):
2715         raise Exception("DATA_TEST_FRAME failed")
2716
2717     pkt = build_ns(src_ll=addr0, ip_src="aaaa:bbbb:cccc::2",
2718                    ip_dst="ff02::1:ff00:2", target="aaaa:bbbb:cccc::2",
2719                    opt=src_ll_opt0)
2720     if "OK" not in dev[0].request("DATA_TEST_FRAME " + binascii.hexlify(pkt)):
2721         raise Exception("DATA_TEST_FRAME failed")
2722     # test frame without source link-layer address option
2723     pkt = build_ns(src_ll=addr0, ip_src="aaaa:bbbb:cccc::2",
2724                    ip_dst="ff02::1:ff00:2", target="aaaa:bbbb:cccc::2")
2725     if "OK" not in dev[0].request("DATA_TEST_FRAME " + binascii.hexlify(pkt)):
2726         raise Exception("DATA_TEST_FRAME failed")
2727     # test frame with bogus option
2728     pkt = build_ns(src_ll=addr0, ip_src="aaaa:bbbb:cccc::2",
2729                    ip_dst="ff02::1:ff00:2", target="aaaa:bbbb:cccc::2",
2730                    opt="\x70\x01\x01\x02\x03\x04\x05\x05")
2731     if "OK" not in dev[0].request("DATA_TEST_FRAME " + binascii.hexlify(pkt)):
2732         raise Exception("DATA_TEST_FRAME failed")
2733     # test frame with truncated source link-layer address option
2734     pkt = build_ns(src_ll=addr0, ip_src="aaaa:bbbb:cccc::2",
2735                    ip_dst="ff02::1:ff00:2", target="aaaa:bbbb:cccc::2",
2736                    opt="\x01\x01\x01\x02\x03\x04")
2737     if "OK" not in dev[0].request("DATA_TEST_FRAME " + binascii.hexlify(pkt)):
2738         raise Exception("DATA_TEST_FRAME failed")
2739     # test frame with foreign source link-layer address option
2740     pkt = build_ns(src_ll=addr0, ip_src="aaaa:bbbb:cccc::2",
2741                    ip_dst="ff02::1:ff00:2", target="aaaa:bbbb:cccc::2",
2742                    opt="\x01\x01\x01\x02\x03\x04\x05\x06")
2743     if "OK" not in dev[0].request("DATA_TEST_FRAME " + binascii.hexlify(pkt)):
2744         raise Exception("DATA_TEST_FRAME failed")
2745
2746     pkt = build_ns(src_ll=addr1, ip_src="aaaa:bbbb:dddd::2",
2747                    ip_dst="ff02::1:ff00:2", target="aaaa:bbbb:dddd::2",
2748                    opt=src_ll_opt1)
2749     if "OK" not in dev[1].request("DATA_TEST_FRAME " + binascii.hexlify(pkt)):
2750         raise Exception("DATA_TEST_FRAME failed")
2751
2752     pkt = build_ns(src_ll=addr1, ip_src="aaaa:bbbb:eeee::2",
2753                    ip_dst="ff02::1:ff00:2", target="aaaa:bbbb:eeee::2",
2754                    opt=src_ll_opt1)
2755     if "OK" not in dev[1].request("DATA_TEST_FRAME " + binascii.hexlify(pkt)):
2756         raise Exception("DATA_TEST_FRAME failed")
2757     # another copy for additional code coverage
2758     if "OK" not in dev[1].request("DATA_TEST_FRAME " + binascii.hexlify(pkt)):
2759         raise Exception("DATA_TEST_FRAME failed")
2760
2761     pkt = build_dhcp_ack(dst_ll="ff:ff:ff:ff:ff:ff", src_ll=bssid,
2762                          ip_src="192.168.1.1", ip_dst="255.255.255.255",
2763                          yiaddr="192.168.1.124", chaddr=addr0)
2764     if "OK" not in hapd.request("DATA_TEST_FRAME ifname=ap-br0 " + binascii.hexlify(pkt)):
2765         raise Exception("DATA_TEST_FRAME failed")
2766     # Change address and verify unicast
2767     pkt = build_dhcp_ack(dst_ll=addr0, src_ll=bssid,
2768                          ip_src="192.168.1.1", ip_dst="255.255.255.255",
2769                          yiaddr="192.168.1.123", chaddr=addr0)
2770     if "OK" not in hapd.request("DATA_TEST_FRAME ifname=ap-br0 " + binascii.hexlify(pkt)):
2771         raise Exception("DATA_TEST_FRAME failed")
2772
2773     # Not-associated client MAC address
2774     pkt = build_dhcp_ack(dst_ll="ff:ff:ff:ff:ff:ff", src_ll=bssid,
2775                          ip_src="192.168.1.1", ip_dst="255.255.255.255",
2776                          yiaddr="192.168.1.125", chaddr="22:33:44:55:66:77")
2777     if "OK" not in hapd.request("DATA_TEST_FRAME ifname=ap-br0 " + binascii.hexlify(pkt)):
2778         raise Exception("DATA_TEST_FRAME failed")
2779
2780     # No IP address
2781     pkt = build_dhcp_ack(dst_ll=addr1, src_ll=bssid,
2782                          ip_src="192.168.1.1", ip_dst="255.255.255.255",
2783                          yiaddr="0.0.0.0", chaddr=addr1)
2784     if "OK" not in hapd.request("DATA_TEST_FRAME ifname=ap-br0 " + binascii.hexlify(pkt)):
2785         raise Exception("DATA_TEST_FRAME failed")
2786
2787     # Zero subnet mask
2788     pkt = build_dhcp_ack(dst_ll=addr1, src_ll=bssid,
2789                          ip_src="192.168.1.1", ip_dst="255.255.255.255",
2790                          yiaddr="192.168.1.126", chaddr=addr1,
2791                          subnet_mask="0.0.0.0")
2792     if "OK" not in hapd.request("DATA_TEST_FRAME ifname=ap-br0 " + binascii.hexlify(pkt)):
2793         raise Exception("DATA_TEST_FRAME failed")
2794
2795     # Truncated option
2796     pkt = build_dhcp_ack(dst_ll=addr1, src_ll=bssid,
2797                          ip_src="192.168.1.1", ip_dst="255.255.255.255",
2798                          yiaddr="192.168.1.127", chaddr=addr1,
2799                          truncated_opt=True)
2800     if "OK" not in hapd.request("DATA_TEST_FRAME ifname=ap-br0 " + binascii.hexlify(pkt)):
2801         raise Exception("DATA_TEST_FRAME failed")
2802
2803     # Wrong magic
2804     pkt = build_dhcp_ack(dst_ll=addr1, src_ll=bssid,
2805                          ip_src="192.168.1.1", ip_dst="255.255.255.255",
2806                          yiaddr="192.168.1.128", chaddr=addr1,
2807                          wrong_magic=True)
2808     if "OK" not in hapd.request("DATA_TEST_FRAME ifname=ap-br0 " + binascii.hexlify(pkt)):
2809         raise Exception("DATA_TEST_FRAME failed")
2810
2811     # Wrong IPv4 total length
2812     pkt = build_dhcp_ack(dst_ll=addr1, src_ll=bssid,
2813                          ip_src="192.168.1.1", ip_dst="255.255.255.255",
2814                          yiaddr="192.168.1.129", chaddr=addr1,
2815                          force_tot_len=1000)
2816     if "OK" not in hapd.request("DATA_TEST_FRAME ifname=ap-br0 " + binascii.hexlify(pkt)):
2817         raise Exception("DATA_TEST_FRAME failed")
2818
2819     # BOOTP
2820     pkt = build_dhcp_ack(dst_ll=addr1, src_ll=bssid,
2821                          ip_src="192.168.1.1", ip_dst="255.255.255.255",
2822                          yiaddr="192.168.1.129", chaddr=addr1,
2823                          no_dhcp=True)
2824     if "OK" not in hapd.request("DATA_TEST_FRAME ifname=ap-br0 " + binascii.hexlify(pkt)):
2825         raise Exception("DATA_TEST_FRAME failed")
2826
2827     matches = get_permanent_neighbors("ap-br0")
2828     logger.info("After connect: " + str(matches))
2829     if len(matches) != 4:
2830         raise Exception("Unexpected number of neighbor entries after connect")
2831     if 'aaaa:bbbb:cccc::2 dev ap-br0 lladdr 02:00:00:00:00:00 PERMANENT' not in matches:
2832         raise Exception("dev0 addr missing")
2833     if 'aaaa:bbbb:dddd::2 dev ap-br0 lladdr 02:00:00:00:01:00 PERMANENT' not in matches:
2834         raise Exception("dev1 addr(1) missing")
2835     if 'aaaa:bbbb:eeee::2 dev ap-br0 lladdr 02:00:00:00:01:00 PERMANENT' not in matches:
2836         raise Exception("dev1 addr(2) missing")
2837     if '192.168.1.123 dev ap-br0 lladdr 02:00:00:00:00:00 PERMANENT' not in matches:
2838         raise Exception("dev0 IPv4 addr missing")
2839
2840     targets = [ "192.168.1.123", "192.168.1.124", "192.168.1.125",
2841                 "192.168.1.126" ]
2842     for target in targets:
2843         send_arp(dev[1], sender_ip="192.168.1.100", target_ip=target)
2844
2845     for target in targets:
2846         send_arp(hapd, hapd_bssid=bssid, sender_ip="192.168.1.101",
2847                  target_ip=target)
2848
2849     # ARP Probe from wireless STA
2850     send_arp(dev[1], target_ip="192.168.1.127")
2851     # ARP Announcement from wireless STA
2852     send_arp(dev[1], sender_ip="192.168.1.127", target_ip="192.168.1.127")
2853     send_arp(dev[1], sender_ip="192.168.1.127", target_ip="192.168.1.127",
2854              opcode=2)
2855
2856     matches = get_permanent_neighbors("ap-br0")
2857     logger.info("After ARP Probe + Announcement: " + str(matches))
2858
2859     # ARP Request for the newly introduced IP address from wireless STA
2860     send_arp(dev[0], sender_ip="192.168.1.123", target_ip="192.168.1.127")
2861
2862     # ARP Request for the newly introduced IP address from bridge
2863     send_arp(hapd, hapd_bssid=bssid, sender_ip="192.168.1.102",
2864              target_ip="192.168.1.127")
2865
2866     # ARP Probe from bridge
2867     send_arp(hapd, hapd_bssid=bssid, target_ip="192.168.1.128")
2868     # ARP Announcement from bridge
2869     send_arp(hapd, hapd_bssid=bssid, sender_ip="129.168.1.128",
2870              target_ip="192.168.1.128")
2871     send_arp(hapd, hapd_bssid=bssid, sender_ip="129.168.1.128",
2872              target_ip="192.168.1.128", opcode=2)
2873
2874     matches = get_permanent_neighbors("ap-br0")
2875     logger.info("After ARP Probe + Announcement: " + str(matches))
2876
2877     # ARP Request for the newly introduced IP address from wireless STA
2878     send_arp(dev[0], sender_ip="192.168.1.123", target_ip="192.168.1.128")
2879
2880     # ARP Request for the newly introduced IP address from bridge
2881     send_arp(hapd, hapd_bssid=bssid, sender_ip="192.168.1.102",
2882              target_ip="192.168.1.128")
2883
2884     # ARP Probe from wireless STA (duplicate address; learned through DHCP)
2885     send_arp(dev[1], target_ip="192.168.1.123")
2886     # ARP Probe from wireless STA (duplicate address; learned through ARP)
2887     send_arp(dev[0], target_ip="192.168.1.127")
2888
2889     # Gratuitous ARP Reply for another STA's IP address
2890     send_arp(dev[0], opcode=2, sender_mac=addr0, sender_ip="192.168.1.127",
2891              target_mac=addr1, target_ip="192.168.1.127")
2892     send_arp(dev[1], opcode=2, sender_mac=addr1, sender_ip="192.168.1.123",
2893              target_mac=addr0, target_ip="192.168.1.123")
2894     # ARP Request to verify previous mapping
2895     send_arp(dev[1], sender_ip="192.168.1.127", target_ip="192.168.1.123")
2896     send_arp(dev[0], sender_ip="192.168.1.123", target_ip="192.168.1.127")
2897
2898     time.sleep(0.1)
2899
2900     dev[0].request("DISCONNECT")
2901     dev[1].request("DISCONNECT")
2902     time.sleep(0.5)
2903     for i in range(3):
2904         cmd[i].terminate()
2905     matches = get_permanent_neighbors("ap-br0")
2906     logger.info("After disconnect: " + str(matches))
2907     if len(matches) > 0:
2908         raise Exception("Unexpected neighbor entries after disconnect")
2909
2910 def test_proxyarp_open(dev, apdev, params):
2911     """ProxyARP with open network"""
2912     res = None
2913     try:
2914         res = _test_proxyarp_open(dev, apdev, params)
2915     finally:
2916         subprocess.call(['ip', 'link', 'set', 'dev', 'ap-br0', 'down'],
2917                         stderr=open('/dev/null', 'w'))
2918         subprocess.call(['brctl', 'delbr', 'ap-br0'],
2919                         stderr=open('/dev/null', 'w'))
2920
2921     return res