Sam Leffler | 6969d1d | 2010-03-15 16:07:11 -0700 | [diff] [blame] | 1 | # Copyright (c) 2010 The Chromium OS Authors. All rights reserved. |
| 2 | # Use of this source code is governed by a BSD-style license that can be |
| 3 | # found in the LICENSE file. |
| 4 | |
Christopher Wiley | 14796b3 | 2013-04-03 14:53:33 -0700 | [diff] [blame] | 5 | import logging |
Christopher Wiley | 3166e43 | 2013-08-06 09:53:12 -0700 | [diff] [blame] | 6 | import random |
Christopher Wiley | 14796b3 | 2013-04-03 14:53:33 -0700 | [diff] [blame] | 7 | import re |
Christopher Wiley | 3166e43 | 2013-08-06 09:53:12 -0700 | [diff] [blame] | 8 | import string |
Christopher Wiley | 1defc24 | 2013-09-18 10:28:37 -0700 | [diff] [blame] | 9 | import time |
Christopher Wiley | 14796b3 | 2013-04-03 14:53:33 -0700 | [diff] [blame] | 10 | |
Paul Stewart | c9628b3 | 2010-08-11 13:03:51 -0700 | [diff] [blame] | 11 | from autotest_lib.client.common_lib import error |
Paul Stewart | 2ee7fdf | 2011-05-19 16:29:23 -0700 | [diff] [blame] | 12 | from autotest_lib.server import site_linux_system |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 13 | from autotest_lib.server.cros import wifi_test_utils |
Christopher Wiley | 99d42c9 | 2013-07-09 16:40:16 -0700 | [diff] [blame] | 14 | from autotest_lib.server.cros.network import hostap_config |
Sam Leffler | 19bb0a7 | 2010-04-12 08:51:08 -0700 | [diff] [blame] | 15 | |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 16 | def isLinuxRouter(host): |
| 17 | """Check if host is a linux router. |
| 18 | |
| 19 | @param host Host object representing the remote machine. |
| 20 | @return True iff remote system is a Linux system. |
| 21 | |
| 22 | """ |
| 23 | router_uname = host.run('uname').stdout |
Sam Leffler | 19bb0a7 | 2010-04-12 08:51:08 -0700 | [diff] [blame] | 24 | return re.search('Linux', router_uname) |
| 25 | |
Christopher Wiley | 1febd6a | 2013-06-03 13:59:48 -0700 | [diff] [blame] | 26 | |
Paul Stewart | 2ee7fdf | 2011-05-19 16:29:23 -0700 | [diff] [blame] | 27 | class LinuxRouter(site_linux_system.LinuxSystem): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 28 | """Linux/mac80211-style WiFi Router support for WiFiTest class. |
Sam Leffler | 6969d1d | 2010-03-15 16:07:11 -0700 | [diff] [blame] | 29 | |
| 30 | This class implements test methods/steps that communicate with a |
| 31 | router implemented with Linux/mac80211. The router must |
| 32 | be pre-configured to enable ssh access and have a mac80211-based |
| 33 | wireless device. We also assume hostapd 0.7.x and iw are present |
| 34 | and any necessary modules are pre-loaded. |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 35 | |
Sam Leffler | 6969d1d | 2010-03-15 16:07:11 -0700 | [diff] [blame] | 36 | """ |
| 37 | |
Christopher Wiley | 3166e43 | 2013-08-06 09:53:12 -0700 | [diff] [blame] | 38 | KNOWN_TEST_PREFIX = 'network_WiFi' |
Christopher Wiley | 1defc24 | 2013-09-18 10:28:37 -0700 | [diff] [blame] | 39 | STARTUP_POLLING_INTERVAL_SECONDS = 0.5 |
| 40 | STARTUP_TIMEOUT_SECONDS = 10 |
Christopher Wiley | 3166e43 | 2013-08-06 09:53:12 -0700 | [diff] [blame] | 41 | SUFFIX_LETTERS = string.ascii_lowercase + string.digits |
Christopher Wiley | b1ade0a | 2013-09-16 13:09:55 -0700 | [diff] [blame^] | 42 | SUBNET_PREFIX_OCTETS = (192, 168) |
Sam Leffler | 6969d1d | 2010-03-15 16:07:11 -0700 | [diff] [blame] | 43 | |
Paul Stewart | 51b0f38 | 2013-06-12 09:03:02 -0700 | [diff] [blame] | 44 | def get_capabilities(self): |
| 45 | """@return iterable object of AP capabilities for this system.""" |
| 46 | caps = set() |
| 47 | try: |
| 48 | self.cmd_send_management_frame = wifi_test_utils.must_be_installed( |
| 49 | self.router, '/usr/bin/send_management_frame') |
| 50 | caps.add(self.CAPABILITY_SEND_MANAGEMENT_FRAME) |
| 51 | except error.TestFail: |
| 52 | pass |
| 53 | return super(LinuxRouter, self).get_capabilities().union(caps) |
| 54 | |
| 55 | |
Christopher Wiley | 3166e43 | 2013-08-06 09:53:12 -0700 | [diff] [blame] | 56 | def __init__(self, host, params, test_name): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 57 | """Build a LinuxRouter. |
| 58 | |
| 59 | @param host Host object representing the remote machine. |
| 60 | @param params dict of settings from site_wifitest based tests. |
Christopher Wiley | 3166e43 | 2013-08-06 09:53:12 -0700 | [diff] [blame] | 61 | @param test_name string name of this test. Used in SSID creation. |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 62 | |
| 63 | """ |
| 64 | site_linux_system.LinuxSystem.__init__(self, host, params, 'router') |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 65 | self._remove_interfaces() |
Paul Stewart | 2ee7fdf | 2011-05-19 16:29:23 -0700 | [diff] [blame] | 66 | |
Wade Guthrie | 24d1e31 | 2012-04-24 16:53:40 -0700 | [diff] [blame] | 67 | # Router host. |
| 68 | self.router = host |
| 69 | |
Christopher Wiley | 4bca01e | 2013-09-13 13:36:39 -0700 | [diff] [blame] | 70 | self.cmd_dhcpd = params.get('cmd_dhcpd', '/usr/sbin/dhcpd') |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 71 | self.cmd_hostapd = wifi_test_utils.must_be_installed( |
| 72 | host, params.get('cmd_hostapd', '/usr/sbin/hostapd')) |
| 73 | self.cmd_hostapd_cli = params.get('cmd_hostapd_cli', |
| 74 | '/usr/sbin/hostapd_cli') |
| 75 | self.dhcpd_conf = '/tmp/dhcpd.%s.conf' |
| 76 | self.dhcpd_leases = '/tmp/dhcpd.leases' |
Nebojsa Sabovic | 138ff91 | 2010-04-06 15:47:42 -0700 | [diff] [blame] | 77 | |
Nebojsa Sabovic | 4cc2ce9 | 2010-04-21 15:08:01 -0700 | [diff] [blame] | 78 | # hostapd configuration persists throughout the test, subsequent |
| 79 | # 'config' commands only modify it. |
Christopher Wiley | 3166e43 | 2013-08-06 09:53:12 -0700 | [diff] [blame] | 80 | self.ssid_prefix = test_name |
| 81 | if self.ssid_prefix.startswith(self.KNOWN_TEST_PREFIX): |
| 82 | # Many of our tests start with an uninteresting prefix. |
| 83 | # Remove it so we can have more unique bytes. |
| 84 | self.ssid_prefix = self.ssid_prefix[len(self.KNOWN_TEST_PREFIX):] |
| 85 | self.ssid_prefix = self.ssid_prefix.lstrip('_') |
| 86 | self.ssid_prefix += '_' |
| 87 | |
Paul Stewart | d5aafa9 | 2013-03-24 19:06:14 -0700 | [diff] [blame] | 88 | self.default_config = { |
Paul Stewart | d5aafa9 | 2013-03-24 19:06:14 -0700 | [diff] [blame] | 89 | 'hw_mode': 'g', |
| 90 | 'ctrl_interface': '/tmp/hostapd-test.control', |
| 91 | 'logger_syslog': '-1', |
| 92 | 'logger_syslog_level': '0' |
| 93 | } |
Nebojsa Sabovic | 4cc2ce9 | 2010-04-21 15:08:01 -0700 | [diff] [blame] | 94 | self.hostapd = { |
| 95 | 'configured': False, |
Paul Stewart | 326badb | 2012-12-18 14:18:54 -0800 | [diff] [blame] | 96 | 'config_file': "/tmp/hostapd-test-%s.conf", |
| 97 | 'log_file': "/tmp/hostapd-test-%s.log", |
Christopher Wiley | 1defc24 | 2013-09-18 10:28:37 -0700 | [diff] [blame] | 98 | 'pid_file': "/tmp/hostapd-test-%s.pid", |
Paul Stewart | f854d2e | 2011-05-04 13:19:18 -0700 | [diff] [blame] | 99 | 'log_count': 0, |
Nebojsa Sabovic | 4cc2ce9 | 2010-04-21 15:08:01 -0700 | [diff] [blame] | 100 | 'driver': "nl80211", |
Paul Stewart | d5aafa9 | 2013-03-24 19:06:14 -0700 | [diff] [blame] | 101 | 'conf': self.default_config.copy() |
Nebojsa Sabovic | 4cc2ce9 | 2010-04-21 15:08:01 -0700 | [diff] [blame] | 102 | } |
Paul Stewart | c2b3de8 | 2011-03-03 14:45:31 -0800 | [diff] [blame] | 103 | self.station = { |
| 104 | 'configured': False, |
Christopher Wiley | 3166e43 | 2013-08-06 09:53:12 -0700 | [diff] [blame] | 105 | 'conf': {}, |
Paul Stewart | c2b3de8 | 2011-03-03 14:45:31 -0800 | [diff] [blame] | 106 | } |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 107 | self.local_servers = [] |
Paul Stewart | 548cf45 | 2012-11-27 17:46:23 -0800 | [diff] [blame] | 108 | self.hostapd_instances = [] |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 109 | self.force_local_server = "force_local_server" in params |
| 110 | self.dhcp_low = 1 |
| 111 | self.dhcp_high = 128 |
Paul Stewart | f05d7fd | 2011-04-06 16:19:37 -0700 | [diff] [blame] | 112 | |
Paul Stewart | 548cf45 | 2012-11-27 17:46:23 -0800 | [diff] [blame] | 113 | # Kill hostapd and dhcp server if already running. |
Thieu Le | 7b23a54 | 2012-01-27 15:54:48 -0800 | [diff] [blame] | 114 | self.kill_hostapd() |
Paul Stewart | 548cf45 | 2012-11-27 17:46:23 -0800 | [diff] [blame] | 115 | self.stop_dhcp_servers() |
Nebojsa Sabovic | 4cc2ce9 | 2010-04-21 15:08:01 -0700 | [diff] [blame] | 116 | |
Nebojsa Sabovic | bc245c6 | 2010-04-28 16:58:50 -0700 | [diff] [blame] | 117 | # Place us in the US by default |
| 118 | self.router.run("%s reg set US" % self.cmd_iw) |
Sam Leffler | 6969d1d | 2010-03-15 16:07:11 -0700 | [diff] [blame] | 119 | |
Paul Stewart | f05d7fd | 2011-04-06 16:19:37 -0700 | [diff] [blame] | 120 | |
Christopher Wiley | f4bc88b | 2013-08-29 16:45:15 -0700 | [diff] [blame] | 121 | def close(self): |
| 122 | """Close global resources held by this system.""" |
| 123 | self.destroy() |
| 124 | super(LinuxRouter, self).close() |
| 125 | |
| 126 | |
Sam Leffler | 6969d1d | 2010-03-15 16:07:11 -0700 | [diff] [blame] | 127 | def create(self, params): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 128 | """Create a wifi device of the specified type. |
Christopher Wiley | 14796b3 | 2013-04-03 14:53:33 -0700 | [diff] [blame] | 129 | |
| 130 | @param params dict containing the device type under key 'type'. |
| 131 | |
| 132 | """ |
| 133 | self.create_wifi_device(params['type']) |
| 134 | |
| 135 | |
| 136 | def create_wifi_device(self, device_type='hostap'): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 137 | """Create a wifi device of the specified type. |
Christopher Wiley | 14796b3 | 2013-04-03 14:53:33 -0700 | [diff] [blame] | 138 | |
| 139 | Defaults to creating a hostap managed device. |
| 140 | |
| 141 | @param device_type string device type. |
| 142 | |
| 143 | """ |
Sam Leffler | 6969d1d | 2010-03-15 16:07:11 -0700 | [diff] [blame] | 144 | # |
| 145 | # AP mode is handled entirely by hostapd so we only |
| 146 | # have to setup others (mapping the bsd type to what |
| 147 | # iw wants) |
| 148 | # |
| 149 | # map from bsd types to iw types |
Christopher Wiley | 14796b3 | 2013-04-03 14:53:33 -0700 | [diff] [blame] | 150 | self.apmode = device_type in ('ap', 'hostap') |
Paul Stewart | c2b3de8 | 2011-03-03 14:45:31 -0800 | [diff] [blame] | 151 | if not self.apmode: |
Christopher Wiley | 14796b3 | 2013-04-03 14:53:33 -0700 | [diff] [blame] | 152 | self.station['type'] = device_type |
Paul Stewart | 2ee7fdf | 2011-05-19 16:29:23 -0700 | [diff] [blame] | 153 | self.phytype = { |
Christopher Wiley | 14796b3 | 2013-04-03 14:53:33 -0700 | [diff] [blame] | 154 | 'sta' : 'managed', |
| 155 | 'monitor' : 'monitor', |
| 156 | 'adhoc' : 'adhoc', |
| 157 | 'ibss' : 'ibss', |
| 158 | 'ap' : 'managed', # NB: handled by hostapd |
| 159 | 'hostap' : 'managed', # NB: handled by hostapd |
| 160 | 'mesh' : 'mesh', |
| 161 | 'wds' : 'wds', |
| 162 | }[device_type] |
Nebojsa Sabovic | 4cc2ce9 | 2010-04-21 15:08:01 -0700 | [diff] [blame] | 163 | |
Sam Leffler | 6969d1d | 2010-03-15 16:07:11 -0700 | [diff] [blame] | 164 | |
Christopher Wiley | d89b528 | 2013-04-10 15:21:26 -0700 | [diff] [blame] | 165 | def destroy(self, params={}): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 166 | """Destroy a previously created device. |
| 167 | |
| 168 | @param params dict of site_wifitest parameters. |
| 169 | |
| 170 | """ |
Nebojsa Sabovic | 4cc2ce9 | 2010-04-21 15:08:01 -0700 | [diff] [blame] | 171 | self.deconfig(params) |
Paul Stewart | d5aafa9 | 2013-03-24 19:06:14 -0700 | [diff] [blame] | 172 | self.hostapd['conf'] = self.default_config.copy() |
Nebojsa Sabovic | 4cc2ce9 | 2010-04-21 15:08:01 -0700 | [diff] [blame] | 173 | |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 174 | |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 175 | def has_local_server(self): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 176 | """@return True iff this router has local servers configured.""" |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 177 | return bool(self.local_servers) |
Sam Leffler | 6969d1d | 2010-03-15 16:07:11 -0700 | [diff] [blame] | 178 | |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 179 | |
Paul Stewart | 9e3ff0b | 2011-08-17 20:35:19 -0700 | [diff] [blame] | 180 | def cleanup(self, params): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 181 | """Clean up any resources in use. |
| 182 | |
| 183 | @param params dict of site_wifitest parameters. |
| 184 | |
| 185 | """ |
Paul Stewart | 9e3ff0b | 2011-08-17 20:35:19 -0700 | [diff] [blame] | 186 | # For linux, this is a no-op |
| 187 | pass |
| 188 | |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 189 | |
Paul Stewart | 548cf45 | 2012-11-27 17:46:23 -0800 | [diff] [blame] | 190 | def start_hostapd(self, conf, params): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 191 | """Start a hostapd instance described by conf. |
| 192 | |
| 193 | @param conf dict of hostapd configuration parameters. |
| 194 | @param params dict of site_wifitest parameters. |
| 195 | |
| 196 | """ |
Christopher Wiley | 7d414cc | 2013-04-17 17:26:32 -0700 | [diff] [blame] | 197 | logging.info('Starting hostapd with parameters: %r', conf) |
Paul Stewart | 548cf45 | 2012-11-27 17:46:23 -0800 | [diff] [blame] | 198 | # Figure out the correct interface. |
Paul Stewart | 326badb | 2012-12-18 14:18:54 -0800 | [diff] [blame] | 199 | interface = self._get_wlanif(self.hostapd['frequency'], |
| 200 | self.phytype, |
| 201 | mode=conf.get('hw_mode', 'b')) |
| 202 | |
| 203 | conf_file = self.hostapd['config_file'] % interface |
| 204 | log_file = self.hostapd['log_file'] % interface |
Christopher Wiley | 1defc24 | 2013-09-18 10:28:37 -0700 | [diff] [blame] | 205 | pid_file = self.hostapd['pid_file'] % interface |
Paul Stewart | 326badb | 2012-12-18 14:18:54 -0800 | [diff] [blame] | 206 | conf['interface'] = interface |
Paul Stewart | 548cf45 | 2012-11-27 17:46:23 -0800 | [diff] [blame] | 207 | |
| 208 | # Generate hostapd.conf. |
| 209 | self._pre_config_hook(conf) |
| 210 | self.router.run("cat <<EOF >%s\n%s\nEOF\n" % |
| 211 | (conf_file, '\n'.join( |
| 212 | "%s=%s" % kv for kv in conf.iteritems()))) |
| 213 | |
| 214 | # Run hostapd. |
| 215 | logging.info("Starting hostapd...") |
Christopher Wiley | 1defc24 | 2013-09-18 10:28:37 -0700 | [diff] [blame] | 216 | self.router.run('rm %s' % log_file, ignore_status=True) |
| 217 | self.router.run('rm %s' % pid_file, ignore_status=True) |
Paul Stewart | 548cf45 | 2012-11-27 17:46:23 -0800 | [diff] [blame] | 218 | self._pre_start_hook(params) |
Christopher Wiley | 1defc24 | 2013-09-18 10:28:37 -0700 | [diff] [blame] | 219 | self.router.run("%s -dd -B -t -f %s -P %s %s" % |
| 220 | (self.cmd_hostapd, log_file, pid_file, conf_file)) |
| 221 | pid = int(self.router.run('cat %s' % pid_file).stdout) |
| 222 | |
| 223 | # Wait for confirmation that the router came up. |
| 224 | logging.info('Waiting for hostapd to startup.') |
| 225 | start_time = time.time() |
| 226 | while time.time() - start_time < self.STARTUP_TIMEOUT_SECONDS: |
| 227 | success = self.router.run( |
| 228 | 'grep "Completing interface initialization" %s' % log_file, |
| 229 | ignore_status=True).exit_status == 0 |
| 230 | if success: |
| 231 | break |
| 232 | |
| 233 | # A common failure is to request an invalid router configuration. |
| 234 | # Detect this and exit early if we see it. |
| 235 | bad_config = self.router.run( |
| 236 | 'grep "Interface initialization failed" %s' % log_file, |
| 237 | ignore_status=True).exit_status == 0 |
| 238 | if bad_config: |
| 239 | raise error.TestFail('hostapd failed to initialize AP ' |
| 240 | 'interface.') |
| 241 | |
| 242 | early_exit = self.router.run('kill -0 %d' % pid, |
| 243 | ignore_status=True).exit_status |
| 244 | if early_exit: |
| 245 | raise error.TestFail('hostapd process terminated.') |
| 246 | |
| 247 | time.sleep(self.STARTUP_POLLING_INTERVAL_SECONDS) |
| 248 | else: |
| 249 | raise error.TestFail('Timed out while waiting for hostapd ' |
| 250 | 'to start.') |
Paul Stewart | 548cf45 | 2012-11-27 17:46:23 -0800 | [diff] [blame] | 251 | |
| 252 | self.hostapd_instances.append({ |
| 253 | 'conf_file': conf_file, |
| 254 | 'log_file': log_file, |
Christopher Wiley | 1defc24 | 2013-09-18 10:28:37 -0700 | [diff] [blame] | 255 | 'interface': interface, |
| 256 | 'pid_file': pid_file |
Paul Stewart | 548cf45 | 2012-11-27 17:46:23 -0800 | [diff] [blame] | 257 | }) |
| 258 | |
Christopher Wiley | 1febd6a | 2013-06-03 13:59:48 -0700 | [diff] [blame] | 259 | |
Paul Stewart | 326badb | 2012-12-18 14:18:54 -0800 | [diff] [blame] | 260 | def _kill_process_instance(self, process, instance=None, wait=0): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 261 | """Kill a process on the router. |
| 262 | |
Paul Stewart | 326badb | 2012-12-18 14:18:54 -0800 | [diff] [blame] | 263 | Kills program named |process|, optionally only a specific |
| 264 | |instance|. If |wait| is specified, we makes sure |process| exits |
| 265 | before returning. |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 266 | |
| 267 | @param process string name of process to kill. |
| 268 | @param instance string instance of process to kill. |
| 269 | @param wait int timeout in seconds to wait for. |
| 270 | |
Thieu Le | 7b23a54 | 2012-01-27 15:54:48 -0800 | [diff] [blame] | 271 | """ |
Paul Stewart | 2173781 | 2012-12-06 11:03:32 -0800 | [diff] [blame] | 272 | if instance: |
Paul Stewart | 326badb | 2012-12-18 14:18:54 -0800 | [diff] [blame] | 273 | search_arg = '-f "%s.*%s"' % (process, instance) |
Paul Stewart | 2173781 | 2012-12-06 11:03:32 -0800 | [diff] [blame] | 274 | else: |
Paul Stewart | 326badb | 2012-12-18 14:18:54 -0800 | [diff] [blame] | 275 | search_arg = process |
Paul Stewart | 2173781 | 2012-12-06 11:03:32 -0800 | [diff] [blame] | 276 | |
Paul Stewart | 326badb | 2012-12-18 14:18:54 -0800 | [diff] [blame] | 277 | cmd = "pkill %s >/dev/null 2>&1" % search_arg |
| 278 | |
| 279 | if wait: |
| 280 | cmd += (" && while pgrep %s &> /dev/null; do sleep 1; done" % |
| 281 | search_arg) |
| 282 | self.router.run(cmd, timeout=wait, ignore_status=True) |
| 283 | else: |
| 284 | self.router.run(cmd, ignore_status=True) |
| 285 | |
Christopher Wiley | 1febd6a | 2013-06-03 13:59:48 -0700 | [diff] [blame] | 286 | |
Paul Stewart | 326badb | 2012-12-18 14:18:54 -0800 | [diff] [blame] | 287 | def kill_hostapd_instance(self, instance): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 288 | """Kills a hostapd instance. |
| 289 | |
| 290 | @param instance string instance to kill. |
| 291 | |
| 292 | """ |
Paul Stewart | 326badb | 2012-12-18 14:18:54 -0800 | [diff] [blame] | 293 | self._kill_process_instance('hostapd', instance, 30) |
Thieu Le | 7b23a54 | 2012-01-27 15:54:48 -0800 | [diff] [blame] | 294 | |
Christopher Wiley | 1febd6a | 2013-06-03 13:59:48 -0700 | [diff] [blame] | 295 | |
Paul Stewart | 2173781 | 2012-12-06 11:03:32 -0800 | [diff] [blame] | 296 | def kill_hostapd(self): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 297 | """Kill all hostapd instances.""" |
Paul Stewart | 2173781 | 2012-12-06 11:03:32 -0800 | [diff] [blame] | 298 | self.kill_hostapd_instance(None) |
| 299 | |
Christopher Wiley | 7d414cc | 2013-04-17 17:26:32 -0700 | [diff] [blame] | 300 | |
| 301 | def __get_default_hostap_config(self): |
| 302 | """@return dict of default options for hostapd.""" |
| 303 | conf = self.hostapd['conf'] |
| 304 | # default RTS and frag threshold to ``off'' |
| 305 | conf['rts_threshold'] = '2347' |
| 306 | conf['fragm_threshold'] = '2346' |
| 307 | conf['driver'] = self.hostapd['driver'] |
Christopher Wiley | 0ff28ab | 2013-08-12 13:23:04 -0700 | [diff] [blame] | 308 | conf['ssid'] = self._build_ssid('') |
Christopher Wiley | 7d414cc | 2013-04-17 17:26:32 -0700 | [diff] [blame] | 309 | return conf |
| 310 | |
| 311 | |
Christopher Wiley | 0ff28ab | 2013-08-12 13:23:04 -0700 | [diff] [blame] | 312 | def _build_ssid(self, suffix): |
Christopher Wiley | 3166e43 | 2013-08-06 09:53:12 -0700 | [diff] [blame] | 313 | unique_salt = ''.join([random.choice(self.SUFFIX_LETTERS) |
| 314 | for x in range(5)]) |
| 315 | return (self.ssid_prefix + unique_salt + suffix)[-32:] |
| 316 | |
| 317 | |
Christopher Wiley | 7d414cc | 2013-04-17 17:26:32 -0700 | [diff] [blame] | 318 | def hostap_configure(self, configuration, multi_interface=None): |
| 319 | """Build up a hostapd configuration file and start hostapd. |
| 320 | |
| 321 | Also setup a local server if this router supports them. |
| 322 | |
| 323 | @param configuration HosetapConfig object. |
| 324 | @param multi_interface bool True iff multiple interfaces allowed. |
| 325 | |
| 326 | """ |
| 327 | if multi_interface is None and (self.hostapd['configured'] or |
| 328 | self.station['configured']): |
| 329 | self.deconfig() |
| 330 | # Start with the default hostapd config parameters. |
| 331 | conf = self.__get_default_hostap_config() |
Christopher Wiley | 3166e43 | 2013-08-06 09:53:12 -0700 | [diff] [blame] | 332 | conf['ssid'] = (configuration.ssid or |
Christopher Wiley | 0ff28ab | 2013-08-12 13:23:04 -0700 | [diff] [blame] | 333 | self._build_ssid(configuration.ssid_suffix)) |
Christopher Wiley | 9b40620 | 2013-05-06 14:07:49 -0700 | [diff] [blame] | 334 | if configuration.bssid: |
| 335 | conf['bssid'] = configuration.bssid |
Christopher Wiley | 7d414cc | 2013-04-17 17:26:32 -0700 | [diff] [blame] | 336 | conf['channel'] = configuration.channel |
| 337 | self.hostapd['frequency'] = configuration.frequency |
| 338 | conf['hw_mode'] = configuration.hw_mode |
| 339 | if configuration.hide_ssid: |
| 340 | conf['ignore_broadcast_ssid'] = 1 |
| 341 | if configuration.is_11n: |
| 342 | conf['ieee80211n'] = 1 |
Christopher Wiley | 32fbb7a | 2013-09-18 14:30:50 -0700 | [diff] [blame] | 343 | conf['ht_capab'] = configuration.hostapd_ht_capabilities |
Christopher Wiley | 7d414cc | 2013-04-17 17:26:32 -0700 | [diff] [blame] | 344 | if configuration.wmm_enabled: |
| 345 | conf['wmm_enabled'] = 1 |
| 346 | if configuration.require_ht: |
| 347 | conf['require_ht'] = 1 |
Christopher Wiley | 9fa7c63 | 2013-05-01 11:58:06 -0700 | [diff] [blame] | 348 | if configuration.beacon_interval: |
| 349 | conf['beacon_int'] = configuration.beacon_interval |
Christopher Wiley | a51258e | 2013-05-03 13:05:06 -0700 | [diff] [blame] | 350 | if configuration.dtim_period: |
| 351 | conf['dtim_period'] = configuration.dtim_period |
Christopher Wiley | e1235b6 | 2013-05-03 15:09:34 -0700 | [diff] [blame] | 352 | if configuration.frag_threshold: |
| 353 | conf['fragm_threshold'] = configuration.frag_threshold |
Christopher Wiley | ebdc27d | 2013-06-28 14:35:41 -0700 | [diff] [blame] | 354 | if configuration.pmf_support: |
| 355 | conf['ieee80211w'] = configuration.pmf_support |
Paul Stewart | 4ae471e | 2013-09-04 15:42:35 -0700 | [diff] [blame] | 356 | if configuration.obss_interval: |
| 357 | conf['obss_interval'] = configuration.obss_interval |
Christopher Wiley | b8921c7 | 2013-06-13 09:51:47 -0700 | [diff] [blame] | 358 | conf.update(configuration.get_security_hostapd_conf()) |
Christopher Wiley | a89706d | 2013-06-12 13:20:58 -0700 | [diff] [blame] | 359 | |
Christopher Wiley | 7d414cc | 2013-04-17 17:26:32 -0700 | [diff] [blame] | 360 | self.start_hostapd(conf, {}) |
| 361 | # Configure transmit power |
| 362 | tx_power_params = {'interface': conf['interface']} |
| 363 | # TODO(wiley) support for setting transmit power |
| 364 | self.set_txpower(tx_power_params) |
| 365 | if self.force_local_server: |
| 366 | self.start_local_server(conf['interface']) |
| 367 | self._post_start_hook({}) |
| 368 | logging.info('AP configured.') |
| 369 | self.hostapd['configured'] = True |
| 370 | |
| 371 | |
Paul Stewart | c2b3de8 | 2011-03-03 14:45:31 -0800 | [diff] [blame] | 372 | def hostap_config(self, params): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 373 | """Configure the AP per test requirements. |
Sam Leffler | 6969d1d | 2010-03-15 16:07:11 -0700 | [diff] [blame] | 374 | |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 375 | @param params dict of site_wifitest parameters. |
| 376 | |
| 377 | """ |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 378 | # keep parameter modifications local-only |
| 379 | orig_params = params |
| 380 | params = params.copy() |
| 381 | |
Paul Stewart | 45338d2 | 2010-10-21 10:57:02 -0700 | [diff] [blame] | 382 | multi_interface = 'multi_interface' in params |
| 383 | if multi_interface: |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 384 | # remove non-hostapd config item from params |
Paul Stewart | 45338d2 | 2010-10-21 10:57:02 -0700 | [diff] [blame] | 385 | params.pop('multi_interface') |
Paul Stewart | c2b3de8 | 2011-03-03 14:45:31 -0800 | [diff] [blame] | 386 | elif self.hostapd['configured'] or self.station['configured']: |
Christopher Wiley | d89b528 | 2013-04-10 15:21:26 -0700 | [diff] [blame] | 387 | self.deconfig() |
Nebojsa Sabovic | 4cc2ce9 | 2010-04-21 15:08:01 -0700 | [diff] [blame] | 388 | |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 389 | local_server = params.pop('local_server', False) |
| 390 | |
Christopher Wiley | 7d414cc | 2013-04-17 17:26:32 -0700 | [diff] [blame] | 391 | conf = self.__get_default_hostap_config() |
Paul Stewart | c2b3de8 | 2011-03-03 14:45:31 -0800 | [diff] [blame] | 392 | tx_power_params = {} |
| 393 | htcaps = set() |
Nebojsa Sabovic | 4cc2ce9 | 2010-04-21 15:08:01 -0700 | [diff] [blame] | 394 | |
Paul Stewart | c2b3de8 | 2011-03-03 14:45:31 -0800 | [diff] [blame] | 395 | for k, v in params.iteritems(): |
| 396 | if k == 'ssid': |
| 397 | conf['ssid'] = v |
| 398 | elif k == 'ssid_suffix': |
Christopher Wiley | 0ff28ab | 2013-08-12 13:23:04 -0700 | [diff] [blame] | 399 | conf['ssid'] = self._build_ssid(v) |
Paul Stewart | c2b3de8 | 2011-03-03 14:45:31 -0800 | [diff] [blame] | 400 | elif k == 'channel': |
| 401 | freq = int(v) |
Paul Stewart | 2ee7fdf | 2011-05-19 16:29:23 -0700 | [diff] [blame] | 402 | self.hostapd['frequency'] = freq |
Nebojsa Sabovic | 4cc2ce9 | 2010-04-21 15:08:01 -0700 | [diff] [blame] | 403 | |
Paul Stewart | c2b3de8 | 2011-03-03 14:45:31 -0800 | [diff] [blame] | 404 | # 2.4GHz |
| 405 | if freq <= 2484: |
| 406 | # Make sure hw_mode is set |
| 407 | if conf.get('hw_mode') == 'a': |
Nebojsa Sabovic | 4cc2ce9 | 2010-04-21 15:08:01 -0700 | [diff] [blame] | 408 | conf['hw_mode'] = 'g' |
Paul Stewart | c2b3de8 | 2011-03-03 14:45:31 -0800 | [diff] [blame] | 409 | |
| 410 | # Freq = 5 * chan + 2407, except channel 14 |
| 411 | if freq == 2484: |
| 412 | conf['channel'] = 14 |
| 413 | else: |
| 414 | conf['channel'] = (freq - 2407) / 5 |
| 415 | # 5GHz |
Sam Leffler | 6969d1d | 2010-03-15 16:07:11 -0700 | [diff] [blame] | 416 | else: |
Paul Stewart | c2b3de8 | 2011-03-03 14:45:31 -0800 | [diff] [blame] | 417 | # Make sure hw_mode is set |
| 418 | conf['hw_mode'] = 'a' |
| 419 | # Freq = 5 * chan + 4000 |
| 420 | if freq < 5000: |
| 421 | conf['channel'] = (freq - 4000) / 5 |
| 422 | # Freq = 5 * chan + 5000 |
| 423 | else: |
| 424 | conf['channel'] = (freq - 5000) / 5 |
Sam Leffler | 6969d1d | 2010-03-15 16:07:11 -0700 | [diff] [blame] | 425 | |
Paul Stewart | c2b3de8 | 2011-03-03 14:45:31 -0800 | [diff] [blame] | 426 | elif k == 'country': |
| 427 | conf['country_code'] = v |
| 428 | elif k == 'dotd': |
| 429 | conf['ieee80211d'] = 1 |
| 430 | elif k == '-dotd': |
| 431 | conf['ieee80211d'] = 0 |
| 432 | elif k == 'mode': |
| 433 | if v == '11a': |
| 434 | conf['hw_mode'] = 'a' |
| 435 | elif v == '11g': |
| 436 | conf['hw_mode'] = 'g' |
| 437 | elif v == '11b': |
| 438 | conf['hw_mode'] = 'b' |
| 439 | elif v == '11n': |
| 440 | conf['ieee80211n'] = 1 |
| 441 | elif k == 'bintval': |
| 442 | conf['beacon_int'] = v |
| 443 | elif k == 'dtimperiod': |
| 444 | conf['dtim_period'] = v |
| 445 | elif k == 'rtsthreshold': |
| 446 | conf['rts_threshold'] = v |
| 447 | elif k == 'fragthreshold': |
| 448 | conf['fragm_threshold'] = v |
| 449 | elif k == 'shortpreamble': |
| 450 | conf['preamble'] = 1 |
| 451 | elif k == 'authmode': |
| 452 | if v == "open": |
| 453 | conf['auth_algs'] = 1 |
| 454 | elif v == "shared": |
| 455 | conf['auth_algs'] = 2 |
| 456 | elif k == 'hidessid': |
| 457 | conf['ignore_broadcast_ssid'] = 1 |
| 458 | elif k == 'wme': |
| 459 | conf['wmm_enabled'] = 1 |
| 460 | elif k == '-wme': |
| 461 | conf['wmm_enabled'] = 0 |
| 462 | elif k == 'deftxkey': |
| 463 | conf['wep_default_key'] = v |
| 464 | elif k == 'ht20': |
| 465 | htcaps.add('') # NB: ensure 802.11n setup below |
| 466 | conf['wmm_enabled'] = 1 |
| 467 | elif k == 'ht40': |
| 468 | htcaps.add('[HT40-]') |
| 469 | htcaps.add('[HT40+]') |
| 470 | conf['wmm_enabled'] = 1 |
Paul Stewart | c1df8d6 | 2011-04-07 14:28:15 -0700 | [diff] [blame] | 471 | elif k in ('ht40+', 'ht40-'): |
| 472 | htcaps.add('[%s]' % k.upper()) |
| 473 | conf['wmm_enabled'] = 1 |
Paul Stewart | c2b3de8 | 2011-03-03 14:45:31 -0800 | [diff] [blame] | 474 | elif k == 'shortgi': |
| 475 | htcaps.add('[SHORT-GI-20]') |
| 476 | htcaps.add('[SHORT-GI-40]') |
| 477 | elif k == 'pureg': |
| 478 | pass # TODO(sleffler) need hostapd support |
| 479 | elif k == 'puren': |
| 480 | pass # TODO(sleffler) need hostapd support |
| 481 | elif k == 'protmode': |
| 482 | pass # TODO(sleffler) need hostapd support |
| 483 | elif k == 'ht': |
| 484 | htcaps.add('') # NB: ensure 802.11n setup below |
| 485 | elif k == 'htprotmode': |
| 486 | pass # TODO(sleffler) need hostapd support |
| 487 | elif k == 'rifs': |
| 488 | pass # TODO(sleffler) need hostapd support |
| 489 | elif k == 'wepmode': |
| 490 | pass # NB: meaningless for hostapd; ignore |
| 491 | elif k == '-ampdu': |
| 492 | pass # TODO(sleffler) need hostapd support |
| 493 | elif k == 'txpower': |
| 494 | tx_power_params['power'] = v |
Nebojsa Sabovic | 60ae146 | 2010-05-07 16:14:45 -0700 | [diff] [blame] | 495 | else: |
Paul Stewart | c2b3de8 | 2011-03-03 14:45:31 -0800 | [diff] [blame] | 496 | conf[k] = v |
Nebojsa Sabovic | 60ae146 | 2010-05-07 16:14:45 -0700 | [diff] [blame] | 497 | |
Paul Stewart | c2b3de8 | 2011-03-03 14:45:31 -0800 | [diff] [blame] | 498 | # Aggregate ht_capab. |
| 499 | if htcaps: |
| 500 | conf['ieee80211n'] = 1 |
| 501 | conf['ht_capab'] = ''.join(htcaps) |
Nebojsa Sabovic | 4cc2ce9 | 2010-04-21 15:08:01 -0700 | [diff] [blame] | 502 | |
Paul Stewart | 548cf45 | 2012-11-27 17:46:23 -0800 | [diff] [blame] | 503 | self.start_hostapd(conf, orig_params) |
Paul Stewart | 1ae854b | 2011-02-08 15:10:14 -0800 | [diff] [blame] | 504 | |
Paul Stewart | c2b3de8 | 2011-03-03 14:45:31 -0800 | [diff] [blame] | 505 | # Configure transmit power |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 506 | tx_power_params['interface'] = conf['interface'] |
Paul Stewart | c2b3de8 | 2011-03-03 14:45:31 -0800 | [diff] [blame] | 507 | self.set_txpower(tx_power_params) |
Nebojsa Sabovic | 138ff91 | 2010-04-06 15:47:42 -0700 | [diff] [blame] | 508 | |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 509 | if self.force_local_server or local_server is not False: |
| 510 | self.start_local_server(conf['interface']) |
Sam Leffler | 6969d1d | 2010-03-15 16:07:11 -0700 | [diff] [blame] | 511 | |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 512 | self._post_start_hook(orig_params) |
| 513 | |
| 514 | logging.info("AP configured.") |
Nebojsa Sabovic | 4cc2ce9 | 2010-04-21 15:08:01 -0700 | [diff] [blame] | 515 | self.hostapd['configured'] = True |
Sam Leffler | 6969d1d | 2010-03-15 16:07:11 -0700 | [diff] [blame] | 516 | |
Christopher Wiley | 1febd6a | 2013-06-03 13:59:48 -0700 | [diff] [blame] | 517 | |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 518 | @staticmethod |
| 519 | def ip_addr(netblock, idx): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 520 | """Simple IPv4 calculator. |
| 521 | |
| 522 | Takes host address in "IP/bits" notation and returns netmask, broadcast |
| 523 | address as well as integer offsets into the address range. |
| 524 | |
| 525 | @param netblock string host address in "IP/bits" notation. |
| 526 | @param idx string describing what to return. |
| 527 | @return string containing something you hopefully requested. |
| 528 | |
Paul Stewart | f05d7fd | 2011-04-06 16:19:37 -0700 | [diff] [blame] | 529 | """ |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 530 | addr_str,bits = netblock.split('/') |
Paul Stewart | f05d7fd | 2011-04-06 16:19:37 -0700 | [diff] [blame] | 531 | addr = map(int, addr_str.split('.')) |
| 532 | mask_bits = (-1 << (32-int(bits))) & 0xffffffff |
| 533 | mask = [(mask_bits >> s) & 0xff for s in range(24, -1, -8)] |
Paul Stewart | 5977da9 | 2011-06-01 19:14:08 -0700 | [diff] [blame] | 534 | if idx == 'local': |
| 535 | return addr_str |
| 536 | elif idx == 'netmask': |
Paul Stewart | f05d7fd | 2011-04-06 16:19:37 -0700 | [diff] [blame] | 537 | return '.'.join(map(str, mask)) |
| 538 | elif idx == 'broadcast': |
| 539 | offset = [m ^ 0xff for m in mask] |
| 540 | else: |
| 541 | offset = [(idx >> s) & 0xff for s in range(24, -1, -8)] |
| 542 | return '.'.join(map(str, [(a & m) + o |
| 543 | for a, m, o in zip(addr, mask, offset)])) |
| 544 | |
| 545 | |
Christopher Wiley | 1febd6a | 2013-06-03 13:59:48 -0700 | [diff] [blame] | 546 | def ibss_configure(self, config): |
| 547 | """Configure a station based AP in IBSS mode. |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 548 | |
Christopher Wiley | 1febd6a | 2013-06-03 13:59:48 -0700 | [diff] [blame] | 549 | Extract relevant configuration objects from |config| despite not |
| 550 | actually being a hostap managed endpoint. |
| 551 | |
| 552 | @param config HostapConfig object. |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 553 | |
| 554 | """ |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 555 | if self.station['configured'] or self.hostapd['configured']: |
Christopher Wiley | d89b528 | 2013-04-10 15:21:26 -0700 | [diff] [blame] | 556 | self.deconfig() |
Christopher Wiley | 1febd6a | 2013-06-03 13:59:48 -0700 | [diff] [blame] | 557 | interface = self._get_wlanif(config.frequency, self.phytype, |
| 558 | config.hw_mode) |
Christopher Wiley | 3166e43 | 2013-08-06 09:53:12 -0700 | [diff] [blame] | 559 | self.station['conf']['ssid'] = (config.ssid or |
Christopher Wiley | 0ff28ab | 2013-08-12 13:23:04 -0700 | [diff] [blame] | 560 | self._build_ssid(config.ssid_suffix)) |
Paul Stewart | c2b3de8 | 2011-03-03 14:45:31 -0800 | [diff] [blame] | 561 | # Connect the station |
Christopher Wiley | 1febd6a | 2013-06-03 13:59:48 -0700 | [diff] [blame] | 562 | self.router.run('%s link set %s up' % (self.cmd_ip, interface)) |
Christopher Wiley | 3166e43 | 2013-08-06 09:53:12 -0700 | [diff] [blame] | 563 | self.router.run('%s dev %s ibss join %s %d' % ( |
| 564 | self.cmd_iw, interface, self.station['conf']['ssid'], |
| 565 | config.frequency)) |
Christopher Wiley | 1febd6a | 2013-06-03 13:59:48 -0700 | [diff] [blame] | 566 | # Always start a local server. |
| 567 | self.start_local_server(interface) |
| 568 | # Remember that this interface is up. |
Paul Stewart | c2b3de8 | 2011-03-03 14:45:31 -0800 | [diff] [blame] | 569 | self.station['configured'] = True |
| 570 | self.station['interface'] = interface |
| 571 | |
| 572 | |
Paul Stewart | 2bd823b | 2012-11-21 15:03:37 -0800 | [diff] [blame] | 573 | def local_server_address(self, index): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 574 | """Get the local server address for an interface. |
| 575 | |
| 576 | When we multiple local servers, we give them static IP addresses |
Christopher Wiley | b1ade0a | 2013-09-16 13:09:55 -0700 | [diff] [blame^] | 577 | like 192.168.*.254. |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 578 | |
| 579 | @param index int describing which local server this is for. |
| 580 | |
| 581 | """ |
Christopher Wiley | b1ade0a | 2013-09-16 13:09:55 -0700 | [diff] [blame^] | 582 | return '%d.%d.%d.%d' % (self.SUBNET_PREFIX_OCTETS + (index, 254)) |
Paul Stewart | 2bd823b | 2012-11-21 15:03:37 -0800 | [diff] [blame] | 583 | |
Christopher Wiley | 1febd6a | 2013-06-03 13:59:48 -0700 | [diff] [blame] | 584 | |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 585 | def start_local_server(self, interface): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 586 | """Start a local server on an interface. |
| 587 | |
| 588 | @param interface string (e.g. wlan0) |
| 589 | |
| 590 | """ |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 591 | logging.info("Starting up local server...") |
| 592 | |
| 593 | if len(self.local_servers) >= 256: |
| 594 | raise error.TestFail('Exhausted available local servers') |
| 595 | |
Paul Stewart | 2bd823b | 2012-11-21 15:03:37 -0800 | [diff] [blame] | 596 | netblock = '%s/24' % self.local_server_address(len(self.local_servers)) |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 597 | |
| 598 | params = {} |
| 599 | params['netblock'] = netblock |
| 600 | params['subnet'] = self.ip_addr(netblock, 0) |
| 601 | params['netmask'] = self.ip_addr(netblock, 'netmask') |
| 602 | params['dhcp_range'] = ' '.join( |
| 603 | (self.ip_addr(netblock, self.dhcp_low), |
| 604 | self.ip_addr(netblock, self.dhcp_high))) |
mukesh agrawal | 05c455a | 2011-10-12 13:40:27 -0700 | [diff] [blame] | 605 | params['interface'] = interface |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 606 | |
| 607 | params['ip_params'] = ("%s broadcast %s dev %s" % |
| 608 | (netblock, |
| 609 | self.ip_addr(netblock, 'broadcast'), |
| 610 | interface)) |
| 611 | self.local_servers.append(params) |
| 612 | |
| 613 | self.router.run("%s addr flush %s" % |
| 614 | (self.cmd_ip, interface)) |
| 615 | self.router.run("%s addr add %s" % |
| 616 | (self.cmd_ip, params['ip_params'])) |
| 617 | self.router.run("%s link set %s up" % |
| 618 | (self.cmd_ip, interface)) |
Paul Stewart | 548cf45 | 2012-11-27 17:46:23 -0800 | [diff] [blame] | 619 | self.start_dhcp_server(interface) |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 620 | |
Christopher Wiley | 1febd6a | 2013-06-03 13:59:48 -0700 | [diff] [blame] | 621 | |
Paul Stewart | 548cf45 | 2012-11-27 17:46:23 -0800 | [diff] [blame] | 622 | def start_dhcp_server(self, interface): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 623 | """Start a dhcp server on an interface. |
| 624 | |
| 625 | @param interface string (e.g. wlan0) |
| 626 | |
| 627 | """ |
Paul Stewart | 326badb | 2012-12-18 14:18:54 -0800 | [diff] [blame] | 628 | conf_file = self.dhcpd_conf % interface |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 629 | dhcp_conf = '\n'.join(map( |
| 630 | lambda server_conf: \ |
| 631 | "subnet %(subnet)s netmask %(netmask)s {\n" \ |
| 632 | " range %(dhcp_range)s;\n" \ |
| 633 | "}" % server_conf, |
| 634 | self.local_servers)) |
| 635 | self.router.run("cat <<EOF >%s\n%s\nEOF\n" % |
Paul Stewart | 326badb | 2012-12-18 14:18:54 -0800 | [diff] [blame] | 636 | (conf_file, |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 637 | '\n'.join(('ddns-update-style none;', dhcp_conf)))) |
| 638 | self.router.run("touch %s" % self.dhcpd_leases) |
| 639 | |
| 640 | self.router.run("pkill dhcpd >/dev/null 2>&1", ignore_status=True) |
| 641 | self.router.run("%s -q -cf %s -lf %s" % |
Paul Stewart | 326badb | 2012-12-18 14:18:54 -0800 | [diff] [blame] | 642 | (self.cmd_dhcpd, conf_file, self.dhcpd_leases)) |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 643 | |
| 644 | |
Paul Stewart | 326badb | 2012-12-18 14:18:54 -0800 | [diff] [blame] | 645 | def stop_dhcp_server(self, instance=None): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 646 | """Stop a dhcp server on the router. |
| 647 | |
| 648 | @param instance string instance to kill. |
| 649 | |
| 650 | """ |
Paul Stewart | 326badb | 2012-12-18 14:18:54 -0800 | [diff] [blame] | 651 | self._kill_process_instance('dhcpd', instance, 0) |
| 652 | |
Christopher Wiley | 1febd6a | 2013-06-03 13:59:48 -0700 | [diff] [blame] | 653 | |
Paul Stewart | 548cf45 | 2012-11-27 17:46:23 -0800 | [diff] [blame] | 654 | def stop_dhcp_servers(self): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 655 | """Stop all dhcp servers on the router.""" |
Paul Stewart | 326badb | 2012-12-18 14:18:54 -0800 | [diff] [blame] | 656 | self.stop_dhcp_server(None) |
Paul Stewart | 548cf45 | 2012-11-27 17:46:23 -0800 | [diff] [blame] | 657 | |
| 658 | |
Paul Stewart | c2b3de8 | 2011-03-03 14:45:31 -0800 | [diff] [blame] | 659 | def config(self, params): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 660 | """Configure an AP based on site_wifitest parameters. |
| 661 | |
| 662 | @param params dict of site_wifitest parameters. |
| 663 | |
| 664 | """ |
Paul Stewart | c2b3de8 | 2011-03-03 14:45:31 -0800 | [diff] [blame] | 665 | if self.apmode: |
| 666 | self.hostap_config(params) |
| 667 | else: |
Christopher Wiley | 1febd6a | 2013-06-03 13:59:48 -0700 | [diff] [blame] | 668 | config = hostap_config.HostapConfig( |
Christopher Wiley | 1febd6a | 2013-06-03 13:59:48 -0700 | [diff] [blame] | 669 | frequency=int(params.get('channel', None))) |
| 670 | self.ibss_configure(config) |
Paul Stewart | c2b3de8 | 2011-03-03 14:45:31 -0800 | [diff] [blame] | 671 | |
| 672 | |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 673 | def get_wifi_ip(self, ap_num): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 674 | """Return IP address on the WiFi subnet of a local server on the router. |
| 675 | |
| 676 | If no local servers are configured (e.g. for an RSPro), a TestFail will |
| 677 | be raised. |
| 678 | |
| 679 | @param ap_num int which local server to get an address from. |
| 680 | |
| 681 | """ |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 682 | if self.local_servers: |
| 683 | return self.ip_addr(self.local_servers[ap_num]['netblock'], |
| 684 | 'local') |
| 685 | else: |
| 686 | raise error.TestFail("No IP address assigned") |
Paul Stewart | 5977da9 | 2011-06-01 19:14:08 -0700 | [diff] [blame] | 687 | |
| 688 | |
Paul Stewart | 17350be | 2012-12-14 13:34:54 -0800 | [diff] [blame] | 689 | def get_hostapd_mac(self, ap_num): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 690 | """Return the MAC address of an AP in the test. |
| 691 | |
| 692 | @param ap_num int index of local server to read the MAC address from. |
| 693 | @return string MAC address like 00:11:22:33:44:55. |
| 694 | |
| 695 | """ |
Paul Stewart | 17350be | 2012-12-14 13:34:54 -0800 | [diff] [blame] | 696 | instance = self.hostapd_instances[ap_num] |
| 697 | interface = instance['interface'] |
| 698 | result = self.router.run('%s addr show %s' % (self.cmd_ip, interface)) |
| 699 | # Example response: |
| 700 | # 1: eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 UP qlen 1000 |
| 701 | # link/ether 99:88:77:66:55:44 brd ff:ff:ff:ff:ff:ff |
| 702 | # inet 10.0.0.1/8 brd 10.255.255.255 scope global eth0 |
| 703 | # inet6 fe80::6a7f:74ff:fe66:5544/64 scope link |
| 704 | # we want the MAC address after the "link/ether" above. |
| 705 | parts = result.stdout.split(' ') |
| 706 | return parts[parts.index('link/ether') + 1] |
| 707 | |
| 708 | |
Christopher Wiley | d89b528 | 2013-04-10 15:21:26 -0700 | [diff] [blame] | 709 | def deconfig(self, params={}): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 710 | """De-configure the AP (will also bring wlan down). |
Sam Leffler | 6969d1d | 2010-03-15 16:07:11 -0700 | [diff] [blame] | 711 | |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 712 | @param params dict of parameters from site_wifitest. |
| 713 | |
| 714 | """ |
Paul Stewart | c2b3de8 | 2011-03-03 14:45:31 -0800 | [diff] [blame] | 715 | if not self.hostapd['configured'] and not self.station['configured']: |
Nebojsa Sabovic | 4cc2ce9 | 2010-04-21 15:08:01 -0700 | [diff] [blame] | 716 | return |
Sam Leffler | 6969d1d | 2010-03-15 16:07:11 -0700 | [diff] [blame] | 717 | |
Paul Stewart | c2b3de8 | 2011-03-03 14:45:31 -0800 | [diff] [blame] | 718 | if self.hostapd['configured']: |
Paul Stewart | 326badb | 2012-12-18 14:18:54 -0800 | [diff] [blame] | 719 | local_servers = [] |
Paul Stewart | 2173781 | 2012-12-06 11:03:32 -0800 | [diff] [blame] | 720 | if 'instance' in params: |
| 721 | instances = [ self.hostapd_instances.pop(params['instance']) ] |
Paul Stewart | 326badb | 2012-12-18 14:18:54 -0800 | [diff] [blame] | 722 | for server in self.local_servers: |
| 723 | if server['interface'] == instances[0]['interface']: |
| 724 | local_servers = [server] |
| 725 | self.local_servers.remove(server) |
| 726 | break |
Paul Stewart | 2173781 | 2012-12-06 11:03:32 -0800 | [diff] [blame] | 727 | else: |
| 728 | instances = self.hostapd_instances |
| 729 | self.hostapd_instances = [] |
Paul Stewart | 326badb | 2012-12-18 14:18:54 -0800 | [diff] [blame] | 730 | local_servers = self.local_servers |
| 731 | self.local_servers = [] |
Paul Stewart | 64cc429 | 2011-06-01 10:59:36 -0700 | [diff] [blame] | 732 | |
Paul Stewart | 2173781 | 2012-12-06 11:03:32 -0800 | [diff] [blame] | 733 | for instance in instances: |
| 734 | if 'silent' in params: |
| 735 | # Deconfigure without notifying DUT. Remove the interface |
| 736 | # hostapd uses to send beacon and DEAUTH packets. |
| 737 | self._remove_interface(instance['interface'], True) |
| 738 | |
Paul Stewart | 326badb | 2012-12-18 14:18:54 -0800 | [diff] [blame] | 739 | self.kill_hostapd_instance(instance['conf_file']) |
Paul Stewart | 548cf45 | 2012-11-27 17:46:23 -0800 | [diff] [blame] | 740 | self.router.get_file(instance['log_file'], |
| 741 | 'debug/hostapd_router_%d_%s.log' % |
| 742 | (self.hostapd['log_count'], |
| 743 | instance['interface'])) |
| 744 | self._release_wlanif(instance['interface']) |
| 745 | # self.router.run("rm -f %(log_file)s %(conf_file)s" % instance) |
Paul Stewart | f854d2e | 2011-05-04 13:19:18 -0700 | [diff] [blame] | 746 | self.hostapd['log_count'] += 1 |
Paul Stewart | c2b3de8 | 2011-03-03 14:45:31 -0800 | [diff] [blame] | 747 | if self.station['configured']: |
Christopher Wiley | 05262d6 | 2013-04-17 17:53:59 -0700 | [diff] [blame] | 748 | local_servers = self.local_servers |
| 749 | self.local_servers = [] |
Paul Stewart | c2b3de8 | 2011-03-03 14:45:31 -0800 | [diff] [blame] | 750 | if self.station['type'] == 'ibss': |
| 751 | self.router.run("%s dev %s ibss leave" % |
| 752 | (self.cmd_iw, self.station['interface'])) |
| 753 | else: |
| 754 | self.router.run("%s dev %s disconnect" % |
| 755 | (self.cmd_iw, self.station['interface'])) |
| 756 | self.router.run("%s link set %s down" % (self.cmd_ip, |
| 757 | self.station['interface'])) |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 758 | |
Paul Stewart | 326badb | 2012-12-18 14:18:54 -0800 | [diff] [blame] | 759 | for server in local_servers: |
| 760 | self.stop_dhcp_server(server['interface']) |
| 761 | self.router.run("%s addr del %s" % |
| 762 | (self.cmd_ip, server['ip_params']), |
| 763 | ignore_status=True) |
Nebojsa Sabovic | 4cc2ce9 | 2010-04-21 15:08:01 -0700 | [diff] [blame] | 764 | |
| 765 | self.hostapd['configured'] = False |
Paul Stewart | c2b3de8 | 2011-03-03 14:45:31 -0800 | [diff] [blame] | 766 | self.station['configured'] = False |
Paul Stewart | 7cb1f06 | 2010-06-10 15:46:20 -0700 | [diff] [blame] | 767 | |
| 768 | |
Paul Stewart | 17350be | 2012-12-14 13:34:54 -0800 | [diff] [blame] | 769 | def verify_pmksa_auth(self, params): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 770 | """Verify that the PMKSA auth was cached on a hostapd instance. |
| 771 | |
| 772 | @param params dict with optional key 'instance' (defaults to 0). |
| 773 | |
| 774 | """ |
Paul Stewart | 17350be | 2012-12-14 13:34:54 -0800 | [diff] [blame] | 775 | instance_num = params.get('instance', 0) |
| 776 | instance = self.hostapd_instances[instance_num] |
| 777 | pmksa_match = 'PMK from PMKSA cache - skip IEEE 802.1X.EAP' |
| 778 | self.router.run('grep -q "%s" %s' % (pmksa_match, instance['log_file'])) |
| 779 | |
| 780 | |
Paul Stewart | 7cb1f06 | 2010-06-10 15:46:20 -0700 | [diff] [blame] | 781 | def get_ssid(self): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 782 | """@return string ssid for the network stemming from this router.""" |
Christopher Wiley | 1febd6a | 2013-06-03 13:59:48 -0700 | [diff] [blame] | 783 | if self.hostapd['configured']: |
| 784 | return self.hostapd['conf']['ssid'] |
| 785 | |
Christopher Wiley | 3166e43 | 2013-08-06 09:53:12 -0700 | [diff] [blame] | 786 | if not 'ssid' in self.station['conf']: |
| 787 | raise error.TestFail('Requested ssid of an unconfigured AP.') |
| 788 | |
Christopher Wiley | 1febd6a | 2013-06-03 13:59:48 -0700 | [diff] [blame] | 789 | return self.station['conf']['ssid'] |
Paul Stewart | 98022e2 | 2010-10-22 10:33:14 -0700 | [diff] [blame] | 790 | |
| 791 | |
| 792 | def set_txpower(self, params): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 793 | """Set the transmission power for an interface. |
| 794 | |
| 795 | Assumes that we want to refer to the first hostapd instance unless |
| 796 | 'interface' is defined in params. Sets the transmission power to |
| 797 | 'auto' if 'power' is not defined in params. |
| 798 | |
| 799 | @param params dict of parameters as described above. |
| 800 | |
| 801 | """ |
Paul Stewart | 548cf45 | 2012-11-27 17:46:23 -0800 | [diff] [blame] | 802 | interface = params.get('interface', |
| 803 | self.hostapd_instances[0]['interface']) |
| 804 | power = params.get('power', 'auto') |
Paul Stewart | 98022e2 | 2010-10-22 10:33:14 -0700 | [diff] [blame] | 805 | self.router.run("%s dev %s set txpower %s" % |
Paul Stewart | 548cf45 | 2012-11-27 17:46:23 -0800 | [diff] [blame] | 806 | (self.cmd_iw, interface, power)) |
Paul Stewart | aa52e8c | 2011-05-24 08:46:23 -0700 | [diff] [blame] | 807 | |
| 808 | |
| 809 | def deauth(self, params): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 810 | """Deauthenticates a client described in params. |
| 811 | |
| 812 | @param params dict containing a key 'client'. |
| 813 | |
| 814 | """ |
Paul Stewart | aa52e8c | 2011-05-24 08:46:23 -0700 | [diff] [blame] | 815 | self.router.run('%s -p%s deauthenticate %s' % |
| 816 | (self.cmd_hostapd_cli, |
| 817 | self.hostapd['conf']['ctrl_interface'], |
| 818 | params['client'])) |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 819 | |
| 820 | |
Paul Stewart | 51b0f38 | 2013-06-12 09:03:02 -0700 | [diff] [blame] | 821 | def send_management_frame(self, frame_type, instance=0): |
| 822 | """Injects a management frame into an active hostapd session. |
| 823 | |
| 824 | @param frame_type string the type of frame to send. |
| 825 | @param instance int indicating which hostapd instance to inject into. |
| 826 | |
| 827 | """ |
| 828 | hostap_interface = self.hostapd_instances[instance]['interface'] |
| 829 | interface = self._get_wlanif(0, 'monitor', same_phy_as=hostap_interface) |
| 830 | self.router.run("%s link set %s up" % (self.cmd_ip, interface)) |
| 831 | self.router.run('%s %s %s' % |
| 832 | (self.cmd_send_management_frame, interface, frame_type)) |
| 833 | self._release_wlanif(interface) |
| 834 | |
| 835 | |
Paul Stewart | 2553694 | 2013-08-15 17:33:42 -0700 | [diff] [blame] | 836 | def detect_client_deauth(self, client_mac, instance=0): |
| 837 | """Detects whether hostapd has logged a deauthentication from |
| 838 | |client_mac|. |
| 839 | |
| 840 | @param client_mac string the MAC address of the client to detect. |
| 841 | @param instance int indicating which hostapd instance to query. |
| 842 | |
| 843 | """ |
| 844 | interface = self.hostapd_instances[instance]['interface'] |
| 845 | deauth_msg = "%s: deauthentication: STA=%s" % (interface, client_mac) |
| 846 | log_file = self.hostapd_instances[instance]['log_file'] |
| 847 | result = self.router.run("grep -qi '%s' %s" % (deauth_msg, log_file), |
| 848 | ignore_status=True) |
| 849 | return result.exit_status == 0 |
| 850 | |
| 851 | |
Paul Stewart | 4ae471e | 2013-09-04 15:42:35 -0700 | [diff] [blame] | 852 | def detect_client_coexistence_report(self, client_mac, instance=0): |
| 853 | """Detects whether hostapd has logged an action frame from |
| 854 | |client_mac| indicating information about 20/40MHz BSS coexistence. |
| 855 | |
| 856 | @param client_mac string the MAC address of the client to detect. |
| 857 | @param instance int indicating which hostapd instance to query. |
| 858 | |
| 859 | """ |
| 860 | coex_msg = ('nl80211: MLME event frame - hexdump(len=.*): ' |
| 861 | '.. .. .. .. .. .. .. .. .. .. %s ' |
| 862 | '.. .. .. .. .. .. .. .. 04 00.*48 01 ..' % |
| 863 | ' '.join(client_mac.split(':'))) |
| 864 | log_file = self.hostapd_instances[instance]['log_file'] |
| 865 | result = self.router.run("grep -qi '%s' %s" % (coex_msg, log_file), |
| 866 | ignore_status=True) |
| 867 | return result.exit_status == 0 |
| 868 | |
| 869 | |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 870 | def _pre_config_hook(self, config): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 871 | """Hook for subclasses. |
| 872 | |
| 873 | Run after gathering configuration parameters, |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 874 | but before writing parameters to config file. |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 875 | |
| 876 | @param config dict containing hostapd config parameters. |
| 877 | |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 878 | """ |
| 879 | pass |
| 880 | |
| 881 | |
| 882 | def _pre_start_hook(self, params): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 883 | """Hook for subclasses. |
| 884 | |
| 885 | Run after generating hostapd config file, but before starting hostapd. |
| 886 | |
| 887 | @param params dict parameters from site_wifitest. |
| 888 | |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 889 | """ |
| 890 | pass |
| 891 | |
| 892 | |
| 893 | def _post_start_hook(self, params): |
Christopher Wiley | f99e6cc | 2013-04-19 10:12:43 -0700 | [diff] [blame] | 894 | """Hook for subclasses run after starting hostapd. |
| 895 | |
| 896 | @param params dict parameters from site_wifitest. |
| 897 | |
| 898 | """ |
mukesh agrawal | fe0e85b | 2011-08-09 14:24:15 -0700 | [diff] [blame] | 899 | pass |