hostapd.py 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362
  1. # Python class for controlling hostapd
  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. import os
  7. import time
  8. import logging
  9. import binascii
  10. import struct
  11. import wpaspy
  12. logger = logging.getLogger()
  13. hapd_ctrl = '/var/run/hostapd'
  14. hapd_global = '/var/run/hostapd-global'
  15. def mac2tuple(mac):
  16. return struct.unpack('6B', binascii.unhexlify(mac.replace(':','')))
  17. class HostapdGlobal:
  18. def __init__(self):
  19. self.ctrl = wpaspy.Ctrl(hapd_global)
  20. def add(self, ifname):
  21. res = self.ctrl.request("ADD " + ifname + " " + hapd_ctrl)
  22. if not "OK" in res:
  23. raise Exception("Could not add hostapd interface " + ifname)
  24. def add_iface(self, ifname, confname):
  25. res = self.ctrl.request("ADD " + ifname + " config=" + confname)
  26. if not "OK" in res:
  27. raise Exception("Could not add hostapd interface")
  28. def add_bss(self, phy, confname, ignore_error=False):
  29. res = self.ctrl.request("ADD bss_config=" + phy + ":" + confname)
  30. if not "OK" in res:
  31. if not ignore_error:
  32. raise Exception("Could not add hostapd BSS")
  33. def remove(self, ifname):
  34. self.ctrl.request("REMOVE " + ifname, timeout=30)
  35. def relog(self):
  36. self.ctrl.request("RELOG")
  37. def flush(self):
  38. self.ctrl.request("FLUSH")
  39. class Hostapd:
  40. def __init__(self, ifname, bssidx=0):
  41. self.ifname = ifname
  42. self.ctrl = wpaspy.Ctrl(os.path.join(hapd_ctrl, ifname))
  43. self.mon = wpaspy.Ctrl(os.path.join(hapd_ctrl, ifname))
  44. self.mon.attach()
  45. self.bssid = None
  46. self.bssidx = bssidx
  47. def own_addr(self):
  48. if self.bssid is None:
  49. self.bssid = self.get_status_field('bssid[%d]' % self.bssidx)
  50. return self.bssid
  51. def request(self, cmd):
  52. logger.debug(self.ifname + ": CTRL: " + cmd)
  53. return self.ctrl.request(cmd)
  54. def ping(self):
  55. return "PONG" in self.request("PING")
  56. def set(self, field, value):
  57. if not "OK" in self.request("SET " + field + " " + value):
  58. raise Exception("Failed to set hostapd parameter " + field)
  59. def set_defaults(self):
  60. self.set("driver", "nl80211")
  61. self.set("hw_mode", "g")
  62. self.set("channel", "1")
  63. self.set("ieee80211n", "1")
  64. self.set("logger_stdout", "-1")
  65. self.set("logger_stdout_level", "0")
  66. def set_open(self, ssid):
  67. self.set_defaults()
  68. self.set("ssid", ssid)
  69. def set_wpa2_psk(self, ssid, passphrase):
  70. self.set_defaults()
  71. self.set("ssid", ssid)
  72. self.set("wpa_passphrase", passphrase)
  73. self.set("wpa", "2")
  74. self.set("wpa_key_mgmt", "WPA-PSK")
  75. self.set("rsn_pairwise", "CCMP")
  76. def set_wpa_psk(self, ssid, passphrase):
  77. self.set_defaults()
  78. self.set("ssid", ssid)
  79. self.set("wpa_passphrase", passphrase)
  80. self.set("wpa", "1")
  81. self.set("wpa_key_mgmt", "WPA-PSK")
  82. self.set("wpa_pairwise", "TKIP")
  83. def set_wpa_psk_mixed(self, ssid, passphrase):
  84. self.set_defaults()
  85. self.set("ssid", ssid)
  86. self.set("wpa_passphrase", passphrase)
  87. self.set("wpa", "3")
  88. self.set("wpa_key_mgmt", "WPA-PSK")
  89. self.set("wpa_pairwise", "TKIP")
  90. self.set("rsn_pairwise", "CCMP")
  91. def set_wep(self, ssid, key):
  92. self.set_defaults()
  93. self.set("ssid", ssid)
  94. self.set("wep_key0", key)
  95. def enable(self):
  96. if not "OK" in self.request("ENABLE"):
  97. raise Exception("Failed to enable hostapd interface " + self.ifname)
  98. def disable(self):
  99. if not "OK" in self.request("DISABLE"):
  100. raise Exception("Failed to disable hostapd interface " + self.ifname)
  101. def dump_monitor(self):
  102. while self.mon.pending():
  103. ev = self.mon.recv()
  104. logger.debug(self.ifname + ": " + ev)
  105. def wait_event(self, events, timeout):
  106. start = os.times()[4]
  107. while True:
  108. while self.mon.pending():
  109. ev = self.mon.recv()
  110. logger.debug(self.ifname + ": " + ev)
  111. for event in events:
  112. if event in ev:
  113. return ev
  114. now = os.times()[4]
  115. remaining = start + timeout - now
  116. if remaining <= 0:
  117. break
  118. if not self.mon.pending(timeout=remaining):
  119. break
  120. return None
  121. def get_status(self):
  122. res = self.request("STATUS")
  123. lines = res.splitlines()
  124. vals = dict()
  125. for l in lines:
  126. [name,value] = l.split('=', 1)
  127. vals[name] = value
  128. return vals
  129. def get_status_field(self, field):
  130. vals = self.get_status()
  131. if field in vals:
  132. return vals[field]
  133. return None
  134. def get_driver_status(self):
  135. res = self.request("STATUS-DRIVER")
  136. lines = res.splitlines()
  137. vals = dict()
  138. for l in lines:
  139. [name,value] = l.split('=', 1)
  140. vals[name] = value
  141. return vals
  142. def get_driver_status_field(self, field):
  143. vals = self.get_driver_status()
  144. if field in vals:
  145. return vals[field]
  146. return None
  147. def get_config(self):
  148. res = self.request("GET_CONFIG")
  149. lines = res.splitlines()
  150. vals = dict()
  151. for l in lines:
  152. [name,value] = l.split('=', 1)
  153. vals[name] = value
  154. return vals
  155. def mgmt_rx(self, timeout=5):
  156. ev = self.wait_event(["MGMT-RX"], timeout=timeout)
  157. if ev is None:
  158. return None
  159. msg = {}
  160. frame = binascii.unhexlify(ev.split(' ')[1])
  161. msg['frame'] = frame
  162. hdr = struct.unpack('<HH6B6B6BH', frame[0:24])
  163. msg['fc'] = hdr[0]
  164. msg['subtype'] = (hdr[0] >> 4) & 0xf
  165. hdr = hdr[1:]
  166. msg['duration'] = hdr[0]
  167. hdr = hdr[1:]
  168. msg['da'] = "%02x:%02x:%02x:%02x:%02x:%02x" % hdr[0:6]
  169. hdr = hdr[6:]
  170. msg['sa'] = "%02x:%02x:%02x:%02x:%02x:%02x" % hdr[0:6]
  171. hdr = hdr[6:]
  172. msg['bssid'] = "%02x:%02x:%02x:%02x:%02x:%02x" % hdr[0:6]
  173. hdr = hdr[6:]
  174. msg['seq_ctrl'] = hdr[0]
  175. msg['payload'] = frame[24:]
  176. return msg
  177. def mgmt_tx(self, msg):
  178. t = (msg['fc'], 0) + mac2tuple(msg['da']) + mac2tuple(msg['sa']) + mac2tuple(msg['bssid']) + (0,)
  179. hdr = struct.pack('<HH6B6B6BH', *t)
  180. self.request("MGMT_TX " + binascii.hexlify(hdr + msg['payload']))
  181. def get_sta(self, addr, info=None, next=False):
  182. cmd = "STA-NEXT " if next else "STA "
  183. if addr is None:
  184. res = self.request("STA-FIRST")
  185. elif info:
  186. res = self.request(cmd + addr + " " + info)
  187. else:
  188. res = self.request(cmd + addr)
  189. lines = res.splitlines()
  190. vals = dict()
  191. first = True
  192. for l in lines:
  193. if first:
  194. vals['addr'] = l
  195. first = False
  196. else:
  197. [name,value] = l.split('=', 1)
  198. vals[name] = value
  199. return vals
  200. def get_mib(self, param=None):
  201. if param:
  202. res = self.request("MIB " + param)
  203. else:
  204. res = self.request("MIB")
  205. lines = res.splitlines()
  206. vals = dict()
  207. for l in lines:
  208. name_val = l.split('=', 1)
  209. if len(name_val) > 1:
  210. vals[name_val[0]] = name_val[1]
  211. return vals
  212. def add_ap(ifname, params, wait_enabled=True, no_enable=False):
  213. logger.info("Starting AP " + ifname)
  214. hapd_global = HostapdGlobal()
  215. hapd_global.remove(ifname)
  216. hapd_global.add(ifname)
  217. hapd = Hostapd(ifname)
  218. if not hapd.ping():
  219. raise Exception("Could not ping hostapd")
  220. hapd.set_defaults()
  221. fields = [ "ssid", "wpa_passphrase", "nas_identifier", "wpa_key_mgmt",
  222. "wpa",
  223. "wpa_pairwise", "rsn_pairwise", "auth_server_addr",
  224. "acct_server_addr", "osu_server_uri" ]
  225. for field in fields:
  226. if field in params:
  227. hapd.set(field, params[field])
  228. for f,v in params.items():
  229. if f in fields:
  230. continue
  231. if isinstance(v, list):
  232. for val in v:
  233. hapd.set(f, val)
  234. else:
  235. hapd.set(f, v)
  236. if no_enable:
  237. return hapd
  238. hapd.enable()
  239. if wait_enabled:
  240. ev = hapd.wait_event(["AP-ENABLED", "AP-DISABLED"], timeout=30)
  241. if ev is None:
  242. raise Exception("AP startup timed out")
  243. if "AP-ENABLED" not in ev:
  244. raise Exception("AP startup failed")
  245. return hapd
  246. def add_bss(phy, ifname, confname, ignore_error=False):
  247. logger.info("Starting BSS phy=" + phy + " ifname=" + ifname)
  248. hapd_global = HostapdGlobal()
  249. hapd_global.add_bss(phy, confname, ignore_error)
  250. hapd = Hostapd(ifname)
  251. if not hapd.ping():
  252. raise Exception("Could not ping hostapd")
  253. def add_iface(ifname, confname):
  254. logger.info("Starting interface " + ifname)
  255. hapd_global = HostapdGlobal()
  256. hapd_global.add_iface(ifname, confname)
  257. hapd = Hostapd(ifname)
  258. if not hapd.ping():
  259. raise Exception("Could not ping hostapd")
  260. def remove_bss(ifname):
  261. logger.info("Removing BSS " + ifname)
  262. hapd_global = HostapdGlobal()
  263. hapd_global.remove(ifname)
  264. def wpa2_params(ssid=None, passphrase=None):
  265. params = { "wpa": "2",
  266. "wpa_key_mgmt": "WPA-PSK",
  267. "rsn_pairwise": "CCMP" }
  268. if ssid:
  269. params["ssid"] = ssid
  270. if passphrase:
  271. params["wpa_passphrase"] = passphrase
  272. return params
  273. def wpa_params(ssid=None, passphrase=None):
  274. params = { "wpa": "1",
  275. "wpa_key_mgmt": "WPA-PSK",
  276. "wpa_pairwise": "TKIP" }
  277. if ssid:
  278. params["ssid"] = ssid
  279. if passphrase:
  280. params["wpa_passphrase"] = passphrase
  281. return params
  282. def wpa_mixed_params(ssid=None, passphrase=None):
  283. params = { "wpa": "3",
  284. "wpa_key_mgmt": "WPA-PSK",
  285. "wpa_pairwise": "TKIP",
  286. "rsn_pairwise": "CCMP" }
  287. if ssid:
  288. params["ssid"] = ssid
  289. if passphrase:
  290. params["wpa_passphrase"] = passphrase
  291. return params
  292. def radius_params():
  293. params = { "auth_server_addr": "127.0.0.1",
  294. "auth_server_port": "1812",
  295. "auth_server_shared_secret": "radius",
  296. "nas_identifier": "nas.w1.fi" }
  297. return params
  298. def wpa_eap_params(ssid=None):
  299. params = radius_params()
  300. params["wpa"] = "1"
  301. params["wpa_key_mgmt"] = "WPA-EAP"
  302. params["wpa_pairwise"] = "TKIP"
  303. params["ieee8021x"] = "1"
  304. if ssid:
  305. params["ssid"] = ssid
  306. return params
  307. def wpa2_eap_params(ssid=None):
  308. params = radius_params()
  309. params["wpa"] = "2"
  310. params["wpa_key_mgmt"] = "WPA-EAP"
  311. params["rsn_pairwise"] = "CCMP"
  312. params["ieee8021x"] = "1"
  313. if ssid:
  314. params["ssid"] = ssid
  315. return params