upgraded readme, added setup.py and support for 3.5

.travis.yml

@@ -0,0 +1,20 @@
+dist: trusty
+sudo: required
+language: python
+python:
+  - "3.4"
+  - "3.5"
+# command to install dependencies
+before_install:
+  - sudo apt-get -qq update
+  - sudo apt-get install -y libnfc5 debhelper python3-all python3-setuptools
+install: 
+  - python3 setup.py install
+  - pip install codecov
+  - pip install stdeb
+# command to run tests
+script:
+  - nosetests --with-coverage
+after_success:
+  - bash <(curl -s https://codecov.io/bash)
+  - python3 setup.py --command-packages=stdeb.command bdist_deb

README → README.md

@@ -1,24 +1,37 @@
-Pynfc - Python bindings for libnfc
-==================================
+# Pynfc - Python bindings for libnfc
 
-Requirements
-------------
+## Requirements
 
-libnfc >= 1.7.0
-python >= 2.6 < 3.0
+* libnfc >= 1.7.0
+* python >= 2.6 < 3.5 (tested with 2.7 and 3.5)
 
-Building
---------
+## Building
 
 The bindings are constructed at runtime using ctypes.  Just ensure the library is correctly installed.
 
-Examples
---------
+## Instalation
 
-There is an example program included for conducting simple mifare authentication:
+```
+sudo apt-get install -y libnfc5 debhelper python3-all python3-setuptools
+git clone git@github.com:ppatrik/pynfc.git
+cd pynfc
+python3 setup.py install
+```
+
+Now you can import pynfc in your projects
+
+```py
+import pynfc as nfc;
+```
 
-python mifareauth.py
+## Examples
 
+### Mifareauth
+
+There is an example program included for conducting simple mifare authentication:
+
+```bash
+> python mifareauth.py
 Example output (bulk of the raw hex excised for space):
 
 Connect to reader: True
@@ -33,11 +46,19 @@ T -> R: A2 7F 33 EE
 TR == Next(TN, 96): True
 R -> T: 8F A4 FA D1
 T -> R: CA 9E 73 93
+```
 
 This indicates that it successfully authenticated to the requested block.
 
-Documentation
--------------
+### NTags
+```bash
+python -m pynfc.ntag_read
+```
+
+This will test whether can do password protection and remove the password all together in the end.
+
+
+## Documentation
 
 The pynfc bindings should offer an intuitive, yet pythonic way of calling the standard libnfc API.
 
@@ -48,3 +69,4 @@ As much as possible all libnfc commands are mirrored in the created nfc object.
 Please note whilst this does implement the full range of features found in libnfc, their use in python may be difficult or tricky to use.
 Pynfc requires much more development and time dedicated to it, before it will be useful as a production tool.
 
+The NTagReadWrite class offers a more Pythonic and high-level interface, geared towards NXP NTags 213, 215 and 216 but should be extendable/generalized to other tag types as well. 

pynfc/__init__.py

@@ -0,0 +1,2 @@
+from .ntag_read import *
+from .pynfc import *

src/mifareauth.py → pynfc/mifareauth.py

@@ -15,19 +15,24 @@
 #
 #  You should have received a copy of the GNU General Public License
 #  along with this program; if not, write to the Free Software
-#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+# 02110-1301, USA.
 
 import time
 import logging
 import ctypes
 import string
 import nfc
+import binascii
+
 
 def hex_dump(string):
     """Dumps data as hexstrings"""
     return ' '.join(["%0.2X" % ord(x) for x in string])
 
-### NFC device setup
+# NFC device setup
+
+
 class NFCReader(object):
     MC_AUTH_A = 0x60
     MC_AUTH_B = 0x61
@@ -54,13 +59,18 @@ def __init__(self, logger):
 
     def run(self):
         """Starts the looping thread"""
+        # import ipdb; ipdb.set_trace()
+        # break 119
+        # break 240
+        # break 208
         self.__context = ctypes.pointer(nfc.nfc_context())
         nfc.nfc_init(ctypes.byref(self.__context))
         loop = True
         try:
             self._clean_card()
             conn_strings = (nfc.nfc_connstring * 10)()
-            devices_found = nfc.nfc_list_devices(self.__context, conn_strings, 10)
+            devices_found = nfc.nfc_list_devices(
+                self.__context, conn_strings, 10)
             if devices_found >= 1:
                 self.__device = nfc.nfc_open(self.__context, conn_strings[0])
                 try:
@@ -74,7 +84,7 @@ def run(self):
                 time.sleep(5)
         except (KeyboardInterrupt, SystemExit):
             loop = False
-        except IOError, e:
+        except IOError as e:
             self.log("Exception: " + str(e))
             loop = True  # not str(e).startswith("NFC Error whilst polling")
         # except Exception, e:
@@ -104,12 +114,16 @@ def _poll_loop(self):
         if res < 0:
             raise IOError("NFC Error whilst polling")
         elif res >= 1:
+            print("_poll_loop: res = {}. nt.nti.nai.szUidLen = {}".format(res, nt.nti.nai.szUidLen))
             uid = None
-            if nt.nti.nai.szUidLen == 4:
-                uid = "".join([chr(nt.nti.nai.abtUid[i]) for i in range(4)])
+            uidLen = 7
+            if nt.nti.nai.szUidLen == uidLen:
+                # uid = "".join([chr(nt.nti.nai.abtUid[i]) for i in range(uidLen)])
+                uid = bytearray([nt.nti.nai.abtUid[i] for i in range(uidLen)])
+                print("_poll_loop: uid = {}".format(binascii.hexlify(uid)))
             if uid:
-                if not ((self._card_uid and self._card_present and uid == self._card_uid) and \
-                                    time.mktime(time.gmtime()) <= self._card_last_seen + self.card_timeout):
+                if not ((self._card_uid and self._card_present and uid == self._card_uid) and
+                        time.mktime(time.gmtime()) <= self._card_last_seen + self.card_timeout):
                     self._setup_device()
                     self.read_card(uid)
             self._card_uid = uid
@@ -128,8 +142,9 @@ def select_card(self):
            Returns the UID of the card selected
         """
         nt = nfc.nfc_target()
-        _ = nfc.nfc_initiator_select_passive_target(self.__device, self.__modulations[0], None, 0, ctypes.byref(nt))
-        uid = "".join([chr(nt.nti.nai.abtUid[i]) for i in range(nt.nti.nai.szUidLen)])
+        _ = nfc.nfc_initiator_select_passive_target(
+            self.__device, self.__modulations[0], None, 0, ctypes.byref(nt))
+        uid = bytearray([nt.nti.nai.abtUid[i] for i in range(nt.nti.nai.szUidLen)])
         return uid
 
     def _setup_device(self):
@@ -168,7 +183,8 @@ def __write_block(self, block, data):
         if nfc.nfc_device_set_property_bool(self.__device, nfc.NP_EASY_FRAMING, True) < 0:
             raise Exception("Error setting Easy Framing property")
         if len(data) > 16:
-            raise ValueError("Data value to be written cannot be more than 16 characters.")
+            raise ValueError(
+                "Data value to be written cannot be more than 16 characters.")
         abttx = (ctypes.c_uint8 * 18)()
         abttx[0] = self.MC_WRITE
         abttx[1] = block
@@ -178,34 +194,35 @@ def __write_block(self, block, data):
         return nfc.nfc_initiator_transceive_bytes(self.__device, ctypes.pointer(abttx), len(abttx),
                                                   ctypes.pointer(abtrx), len(abtrx), 0)
 
-    def _authenticate(self, block, uid, key = "\xff\xff\xff\xff\xff\xff", use_b_key = False):
+    def _authenticate(self, block, uid, key="\xff\xff\xff\xff\xff\xff", use_b_key=False):
         """Authenticates to a particular block using a specified key"""
         if nfc.nfc_device_set_property_bool(self.__device, nfc.NP_EASY_FRAMING, True) < 0:
             raise Exception("Error setting Easy Framing property")
         abttx = (ctypes.c_uint8 * 12)()
         abttx[0] = self.MC_AUTH_A if not use_b_key else self.MC_AUTH_B
         abttx[1] = block
         for i in range(6):
-            abttx[i + 2] = ord(key[i])
+            abttx[i + 2] = key[i]
         for i in range(4):
-            abttx[i + 8] = ord(uid[i])
+            abttx[i + 8] = uid[i]
         abtrx = (ctypes.c_uint8 * 250)()
-        return nfc.nfc_initiator_transceive_bytes(self.__device, ctypes.pointer(abttx), len(abttx),
+        transceived = nfc.nfc_initiator_transceive_bytes(self.__device, ctypes.pointer(abttx), len(abttx),
                                                   ctypes.pointer(abtrx), len(abtrx), 0)
+        return transceived
 
-    def auth_and_read(self, block, uid, key = "\xff\xff\xff\xff\xff\xff"):
+    def auth_and_read(self, block, uid, key="\xff\xff\xff\xff\xff\xff"):
         """Authenticates and then reads a block
 
            Returns '' if the authentication failed
         """
         # Reselect the card so that we can reauthenticate
-        self.select_card()
+        # self.select_card()
         res = self._authenticate(block, uid, key)
         if res >= 0:
             return self._read_block(block)
         return ''
 
-    def auth_and_write(self, block, uid, data, key = "\xff\xff\xff\xff\xff\xff"):
+    def auth_and_write(self, block, uid, data, key="\xff\xff\xff\xff\xff\xff"):
         """Authenticates and then writes a block
 
         """
@@ -217,14 +234,19 @@ def auth_and_write(self, block, uid, data, key = "\xff\xff\xff\xff\xff\xff"):
 
     def read_card(self, uid):
         """Takes a uid, reads the card and return data for use in writing the card"""
-        key = "\xff\xff\xff\xff\xff\xff"
-        print "Reading card", uid.encode("hex")
+        key = bytearray([0xff] * 6)
+        # print("Reading card", uid.encode("hex"))
         self._card_uid = self.select_card()
         self._authenticate(0x00, uid, key)
         block = 0
+
+        all_data = []
         for block in range(64):
             data = self.auth_and_read(block, uid, key)
-            print block, data.encode("hex"), "".join([ x if x in string.printable else "." for x in data])
+            # print(block, data.encode("hex"), "".join(
+            #     [x if x in string.printable else "." for x in data]))
+            all_data += [data]
+        print("read_card: '{}'".format(''.join(all_data)))
 
     def write_card(self, uid, data):
         """Accepts data of the recently read card with UID uid, and writes any changes necessary to it"""