3 # Example nfcpy to wpa_supplicant wrapper for P2P NFC operations
4 # Copyright (c) 2012-2013, Jouni Malinen <j@w1.fi>
6 # This software may be distributed under the terms of the BSD license.
7 # See README for more details.
25 wpas_ctrl = '/var/run/wpa_supplicant'
30 include_wps_req = True
31 include_p2p_req = True
42 with open(summary_file, 'a') as f:
45 def success_report(txt):
48 with open(success_file, 'a') as f:
53 if os.path.isdir(wpas_ctrl):
55 ifaces = [os.path.join(wpas_ctrl, i) for i in os.listdir(wpas_ctrl)]
56 except OSError as error:
57 print("Could not find wpa_supplicant: ", error)
61 print("No wpa_supplicant control interface found")
66 if ifname not in ctrl:
69 print("Trying to use control interface " + ctrl)
70 wpas = wpaspy.Ctrl(ctrl)
72 except Exception as e:
77 def wpas_tag_read(message):
81 cmd = "WPS_NFC_TAG_READ " + str(message).encode("hex")
84 cmd = cmd + " freq=" + force_freq
85 if "FAIL" in wpas.request(cmd):
90 def wpas_get_handover_req():
94 res = wpas.request("NFC_GET_HANDOVER_REQ NDEF P2P-CR").rstrip()
97 return res.decode("hex")
99 def wpas_get_handover_req_wps():
100 wpas = wpas_connect()
103 res = wpas.request("NFC_GET_HANDOVER_REQ NDEF WPS-CR").rstrip()
106 return res.decode("hex")
109 def wpas_get_handover_sel(tag=False):
110 wpas = wpas_connect()
114 res = wpas.request("NFC_GET_HANDOVER_SEL NDEF P2P-CR-TAG").rstrip()
116 res = wpas.request("NFC_GET_HANDOVER_SEL NDEF P2P-CR").rstrip()
119 return res.decode("hex")
122 def wpas_get_handover_sel_wps():
123 wpas = wpas_connect()
126 res = wpas.request("NFC_GET_HANDOVER_SEL NDEF WPS-CR");
129 return res.rstrip().decode("hex")
132 def wpas_report_handover(req, sel, type):
133 wpas = wpas_connect()
136 cmd = "NFC_REPORT_HANDOVER " + type + " P2P " + str(req).encode("hex") + " " + str(sel).encode("hex")
139 cmd = cmd + " freq=" + force_freq
140 return wpas.request(cmd)
143 def wpas_report_handover_wsc(req, sel, type):
144 wpas = wpas_connect()
147 cmd = "NFC_REPORT_HANDOVER " + type + " WPS " + str(req).encode("hex") + " " + str(sel).encode("hex")
149 cmd = cmd + " freq=" + force_freq
150 return wpas.request(cmd)
153 def p2p_handover_client(llc):
154 message = nfc.ndef.HandoverRequestMessage(version="1.2")
155 message.nonce = random.randint(0, 0xffff)
157 global include_p2p_req
159 data = wpas_get_handover_req()
161 summary("Could not get handover request carrier record from wpa_supplicant")
163 print("Handover request carrier record from wpa_supplicant: " + data.encode("hex"))
164 datamsg = nfc.ndef.Message(data)
165 message.add_carrier(datamsg[0], "active", datamsg[1:])
167 global include_wps_req
169 print("Handover request (pre-WPS):")
171 print(message.pretty())
172 except Exception as e:
175 data = wpas_get_handover_req_wps()
177 print("Add WPS request in addition to P2P")
178 datamsg = nfc.ndef.Message(data)
179 message.add_carrier(datamsg[0], "active", datamsg[1:])
181 print("Handover request:")
183 print(message.pretty())
184 except Exception as e:
186 print(str(message).encode("hex"))
188 client = nfc.handover.HandoverClient(llc)
190 summary("Trying to initiate NFC connection handover")
192 summary("Connected for handover")
193 except nfc.llcp.ConnectRefused:
194 summary("Handover connection refused")
197 except Exception as e:
198 summary("Other exception: " + str(e))
202 summary("Sending handover request")
204 if not client.send(message):
205 summary("Failed to send handover request")
209 summary("Receiving handover response")
210 message = client._recv()
212 summary("No response received")
215 if message.type != "urn:nfc:wkt:Hs":
216 summary("Response was not Hs - received: " + message.type)
220 print("Received message")
222 print(message.pretty())
223 except Exception as e:
225 print(str(message).encode("hex"))
226 message = nfc.ndef.HandoverSelectMessage(message)
227 summary("Handover select received")
229 print(message.pretty())
230 except Exception as e:
233 for carrier in message.carriers:
234 print("Remote carrier type: " + carrier.type)
235 if carrier.type == "application/vnd.wfa.p2p":
236 print("P2P carrier type match - send to wpa_supplicant")
237 if "OK" in wpas_report_handover(data, carrier.record, "INIT"):
238 success_report("P2P handover reported successfully (initiator)")
240 summary("P2P handover report rejected")
245 print("Done with handover")
248 print("only_one -> stop loop")
250 continue_loop = False
254 print("Trying to exit..")
259 class HandoverServer(nfc.handover.HandoverServer):
260 def __init__(self, llc):
261 super(HandoverServer, self).__init__(llc)
262 self.sent_carrier = None
263 self.ho_server_processing = False
266 # override to avoid parser error in request/response.pretty() in nfcpy
267 # due to new WSC handover format
268 def _process_request(self, request):
269 summary("received handover request {}".format(request.type))
270 response = nfc.ndef.Message("\xd1\x02\x01Hs\x12")
271 if not request.type == 'urn:nfc:wkt:Hr':
272 summary("not a handover request")
275 request = nfc.ndef.HandoverRequestMessage(request)
276 except nfc.ndef.DecodeError as e:
277 summary("error decoding 'Hr' message: {}".format(e))
279 response = self.process_request(request)
280 summary("send handover response {}".format(response.type))
283 def process_request(self, request):
284 self.ho_server_processing = True
286 print("HandoverServer - request received")
288 print("Parsed handover request: " + request.pretty())
289 except Exception as e:
292 sel = nfc.ndef.HandoverSelectMessage(version="1.2")
296 for carrier in request.carriers:
297 print("Remote carrier type: " + carrier.type)
298 if carrier.type == "application/vnd.wfa.p2p":
299 print("P2P carrier type match - add P2P carrier record")
301 self.received_carrier = carrier.record
302 print("Carrier record:")
304 print(carrier.record.pretty())
305 except Exception as e:
307 data = wpas_get_handover_sel()
309 print("Could not get handover select carrier record from wpa_supplicant")
311 print("Handover select carrier record from wpa_supplicant:")
312 print(data.encode("hex"))
313 self.sent_carrier = data
314 if "OK" in wpas_report_handover(self.received_carrier, self.sent_carrier, "RESP"):
315 success_report("P2P handover reported successfully (responder)")
317 summary("P2P handover report rejected")
320 message = nfc.ndef.Message(data);
321 sel.add_carrier(message[0], "active", message[1:])
324 for carrier in request.carriers:
327 print("Remote carrier type: " + carrier.type)
328 if carrier.type == "application/vnd.wfa.wsc":
329 print("WSC carrier type match - add WSC carrier record")
331 self.received_carrier = carrier.record
332 print("Carrier record:")
334 print(carrier.record.pretty())
335 except Exception as e:
337 data = wpas_get_handover_sel_wps()
339 print("Could not get handover select carrier record from wpa_supplicant")
341 print("Handover select carrier record from wpa_supplicant:")
342 print(data.encode("hex"))
343 self.sent_carrier = data
344 if "OK" in wpas_report_handover_wsc(self.received_carrier, self.sent_carrier, "RESP"):
345 success_report("WSC handover reported successfully")
347 summary("WSC handover report rejected")
350 message = nfc.ndef.Message(data);
351 sel.add_carrier(message[0], "active", message[1:])
355 print("Handover select:")
358 except Exception as e:
360 print(str(sel).encode("hex"))
362 summary("Sending handover select")
367 def clear_raw_mode():
368 import sys, tty, termios
369 global prev_tcgetattr, in_raw_mode
372 fd = sys.stdin.fileno()
373 termios.tcsetattr(fd, termios.TCSADRAIN, prev_tcgetattr)
378 import sys, tty, termios, select
379 global prev_tcgetattr, in_raw_mode
380 fd = sys.stdin.fileno()
381 prev_tcgetattr = termios.tcgetattr(fd)
386 [i, o, e] = select.select([fd], [], [], 0.05)
388 ch = sys.stdin.read(1)
390 termios.tcsetattr(fd, termios.TCSADRAIN, prev_tcgetattr)
395 def p2p_tag_read(tag):
397 if len(tag.ndef.message):
398 for record in tag.ndef.message:
399 print("record type " + record.type)
400 if record.type == "application/vnd.wfa.wsc":
401 summary("WPS tag - send to wpa_supplicant")
402 success = wpas_tag_read(tag.ndef.message)
404 if record.type == "application/vnd.wfa.p2p":
405 summary("P2P tag - send to wpa_supplicant")
406 success = wpas_tag_read(tag.ndef.message)
412 success_report("Tag read succeeded")
417 def rdwr_connected_p2p_write(tag):
418 summary("Tag found - writing - " + str(tag))
420 tag.ndef.message = str(p2p_sel_data)
421 success_report("Tag write succeeded")
422 print("Done - remove tag")
426 continue_loop = False
427 global p2p_sel_wait_remove
428 return p2p_sel_wait_remove
430 def wps_write_p2p_handover_sel(clf, wait_remove=True):
431 print("Write P2P handover select")
432 data = wpas_get_handover_sel(tag=True)
434 summary("Could not get P2P handover select from wpa_supplicant")
437 global p2p_sel_wait_remove
438 p2p_sel_wait_remove = wait_remove
440 p2p_sel_data = nfc.ndef.HandoverSelectMessage(version="1.2")
441 message = nfc.ndef.Message(data);
442 p2p_sel_data.add_carrier(message[0], "active", message[1:])
443 print("Handover select:")
445 print(p2p_sel_data.pretty())
446 except Exception as e:
448 print(str(p2p_sel_data).encode("hex"))
450 print("Touch an NFC tag")
451 clf.connect(rdwr={'on-connect': rdwr_connected_p2p_write})
454 def rdwr_connected(tag):
455 global only_one, no_wait
456 summary("Tag connected: " + str(tag))
459 print("NDEF tag: " + tag.type)
461 print(tag.ndef.message.pretty())
462 except Exception as e:
464 success = p2p_tag_read(tag)
465 if only_one and success:
467 continue_loop = False
469 summary("Not an NDEF tag - remove tag")
475 def llcp_worker(llc):
478 print("Starting handover client")
479 p2p_handover_client(llc)
484 print("Wait for handover to complete")
486 print("Wait for handover to complete - press 'i' to initiate ('w' for WPS only, 'p' for P2P only)")
488 global wait_connection
489 while not wait_connection and srv.sent_carrier is None:
490 if srv.ho_server_processing:
495 global include_wps_req, include_p2p_req
498 include_wps_req = True
499 include_p2p_req = True
501 include_wps_req = False
502 include_p2p_req = True
504 include_wps_req = True
505 include_p2p_req = False
509 print("Starting handover client")
510 p2p_handover_client(llc)
514 print("Exiting llcp_worker thread")
516 def llcp_startup(clf, llc):
517 print("Start LLCP server")
519 srv = HandoverServer(llc)
522 def llcp_connected(llc):
523 print("P2P LLCP connected")
524 global wait_connection
525 wait_connection = False
527 if not init_on_touch:
530 if init_on_touch or not no_input:
531 threading.Thread(target=llcp_worker, args=(llc,)).start()
534 def terminate_loop():
539 clf = nfc.ContactlessFrontend()
541 parser = argparse.ArgumentParser(description='nfcpy to wpa_supplicant integration for P2P and WPS NFC operations')
542 parser.add_argument('-d', const=logging.DEBUG, default=logging.INFO,
543 action='store_const', dest='loglevel',
544 help='verbose debug output')
545 parser.add_argument('-q', const=logging.WARNING, action='store_const',
546 dest='loglevel', help='be quiet')
547 parser.add_argument('--only-one', '-1', action='store_true',
548 help='run only one operation and exit')
549 parser.add_argument('--init-on-touch', '-I', action='store_true',
550 help='initiate handover on touch')
551 parser.add_argument('--no-wait', action='store_true',
552 help='do not wait for tag to be removed before exiting')
553 parser.add_argument('--ifname', '-i',
554 help='network interface name')
555 parser.add_argument('--no-wps-req', '-N', action='store_true',
556 help='do not include WPS carrier record in request')
557 parser.add_argument('--no-input', '-a', action='store_true',
558 help='do not use stdout input to initiate handover')
559 parser.add_argument('--tag-read-only', '-t', action='store_true',
560 help='tag read only (do not allow connection handover)')
561 parser.add_argument('--handover-only', action='store_true',
562 help='connection handover only (do not allow tag read)')
563 parser.add_argument('--freq', '-f',
564 help='forced frequency of operating channel in MHz')
565 parser.add_argument('--summary',
566 help='summary file for writing status updates')
567 parser.add_argument('--success',
568 help='success file for writing success update')
569 parser.add_argument('command', choices=['write-p2p-sel'],
571 args = parser.parse_args()
574 only_one = args.only_one
577 no_wait = args.no_wait
580 force_freq = args.freq
582 logging.basicConfig(level=args.loglevel)
585 init_on_touch = args.init_on_touch
590 print("Selected ifname " + ifname)
593 global include_wps_req
594 include_wps_req = False
598 summary_file = args.summary
602 success_file = args.success
608 clf = nfc.ContactlessFrontend()
609 global wait_connection
612 if not clf.open("usb"):
613 print("Could not open connection with an NFC device")
616 if args.command == "write-p2p-sel":
617 wps_write_p2p_handover_sel(clf, wait_remove=not args.no_wait)
622 print("Waiting for a tag or peer to be touched")
623 wait_connection = True
625 if args.tag_read_only:
626 if not clf.connect(rdwr={'on-connect': rdwr_connected}):
628 elif args.handover_only:
629 if not clf.connect(llcp={'on-startup': llcp_startup,
630 'on-connect': llcp_connected},
631 terminate=terminate_loop):
634 if not clf.connect(rdwr={'on-connect': rdwr_connected},
635 llcp={'on-startup': llcp_startup,
636 'on-connect': llcp_connected},
637 terminate=terminate_loop):
639 except Exception as e:
640 print("clf.connect failed")
643 if only_one and srv and srv.success:
646 except KeyboardInterrupt:
653 if __name__ == '__main__':