pythonbeid 0.1.0__py3-none-any.whl

pythonbeid/card_reader.py

@@ -0,0 +1,232 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+Card Reader Script
+
+This script reads information from a smart card using a card reader. It can retrieve card information, address, and optionally photo data.
+
+Dependencies:
+- pyscard (python-smartcard)
+
+Usage:
+    Run the script and it will attempt to read the card information and print it.
+
+Author:
+    Your Name (youremail@example.com)
+"""
+
+from datetime import datetime
+from pprint import pprint
+from smartcard.System import readers
+from smartcard.Exceptions import NoCardException, CardConnectionException
+
+MAP_MOIS = {
+    "JANV": "01", "JAN": "01",
+    "FEVR": "02", "FEV": "02",
+    "MARS": "03", "MAR": "03",
+    "AVRI": "04", "AVR": "04",
+    "MAI": "05",
+    "JUIN": "06",
+    "JUIL": "07",
+    "AOUT": "08", "AOU": "08",
+    "SEPT": "09", "SEP": "09",
+    "OCTO": "10", "OCT": "10",
+    "NOVE": "11", "NOV": "11",
+    "DECE": "12", "DEC": "12"
+}
+
+ID = [0x3F, 0x00, 0xDF, 0x01, 0x40, 0x31]
+ADDRESS = [0x3F, 0x00, 0xDF, 0x01, 0x40, 0x33]
+PHOTO = [0x3F, 0x00, 0xDF, 0x01, 0x40, 0x35]
+
+class CardReader:
+    """
+    A class to read information from a smart card using a card reader.
+    
+    Methods
+    -------
+    read_informations(photo=False)
+        Reads card information, including optional photo data.
+    """
+
+    def __init__(self) -> None:
+        """
+        Initializes the CardReader by connecting to the first available card reader.
+        """
+        try:
+            self._cnx = readers()[0].createConnection()
+            self._cnx.connect()
+        except IndexError:
+            raise RuntimeError("Pas de lecteur disponible")
+        except NoCardException:
+            raise RuntimeError("Pas de carte disponible")
+        except CardConnectionException as e:
+            raise RuntimeError(f"Erreur de connexion à la carte: {e}")
+
+    def _send_apdu(self, apdu):
+        """
+        Sends an APDU command to the card and returns the response.
+        
+        Parameters
+        ----------
+        apdu : list
+            The APDU command to send.
+        
+        Returns
+        -------
+        tuple
+            The response data, SW1, and SW2 status bytes.
+        """
+        response, sw1, sw2 = self._cnx.transmit(apdu)
+        return response, sw1, sw2
+
+    def _read_data(self, file_id):
+        """
+        Reads data from the card file specified by the file_id.
+        
+        Parameters
+        ----------
+        file_id : list
+            The file identifier to select and read.
+        
+        Returns
+        -------
+        tuple
+            The data read from the file, SW1, and SW2 status bytes.
+        """
+        cmd = [0x00, 0xA4, 0x08, 0x0C, len(file_id)] + file_id
+        _, sw1, sw2 = self._send_apdu(cmd)
+        if sw1 == 0x6C:
+            cmd = [0x00, 0xB0, 0x00, 0x00, sw2]
+        else:
+            cmd = [0x00, 0xB0, 0x00, 0x00, 256]
+        data, sw1, sw2 = self._send_apdu(cmd)
+        if sw1 == 0x6C:
+            cmd = [0x00, 0xB0, 0x00, 0x00, sw2]
+            data, sw1, sw2 = self._send_apdu(cmd)
+        return data, sw1, sw2
+
+    def _parse_information(self, data, num_info_limit):
+        """
+        Parses the information from the raw data read from the card.
+        
+        Parameters
+        ----------
+        data : list
+            The raw data read from the card.
+        num_info_limit : int
+            The number of information fields to parse.
+        
+        Returns
+        -------
+        list
+            The parsed information fields as strings.
+        """
+        idx = 0
+        infos = []
+        while len(infos) <= num_info_limit:
+            num_info = data[idx]
+            idx += 1
+            len_info = data[idx]
+            idx += 1
+            chaine_bytes = data[idx:idx + len_info]
+            idx += len_info
+            try:
+                infos.append(bytes(chaine_bytes).decode("utf-8"))
+            except UnicodeDecodeError:
+                infos.append("")
+        return infos
+
+    def _parse_date(self, date_str):
+        """
+        Parses a date string in the format 'DD MON YYYY'.
+        
+        Parameters
+        ----------
+        date_str : str
+            The date string to parse.
+        
+        Returns
+        -------
+        datetime
+            The parsed date as a datetime object.
+        """
+        jour, mois, annee = date_str.split()
+        mois = MAP_MOIS.get(mois, "01")
+        return datetime.strptime(f"{jour}/{mois}/{annee}", "%d/%m/%Y")
+
+    def read_informations(self, photo=False):
+        """
+        Reads and returns the card information, including optional photo data.
+        
+        Parameters
+        ----------
+        photo : bool, optional
+            Whether to read the photo data (default is False).
+        
+        Returns
+        -------
+        dict
+            The card information including number, validity dates, personal details, and optionally the photo.
+        """
+        data, sw1, sw2 = self._read_data(ID)
+        infos = self._parse_information(data, 12)
+
+        informations = {
+            "num_carte": infos[0],
+            "debut_val": datetime.strptime(infos[2], "%d.%m.%Y"),
+            "fin_val": datetime.strptime(infos[3], "%d.%m.%Y"),
+            "commune_delivrance": infos[4],
+            "num_nat": infos[5],
+            "nom": infos[6],
+            "prenoms": infos[7],
+            "suffixe": infos[8],
+            "nationalite": infos[9],
+            "lieu_naissance": infos[10],
+            "date_naissance": self._parse_date(infos[11]),
+            "sexe": infos[12],
+        }
+
+        data, sw1, sw2 = self._read_data(ADDRESS)
+        address_infos = self._parse_information(data, 2)
+
+        informations["adresse"] = address_infos[0]
+        informations["code_postal"] = address_infos[1]
+        informations["localite"] = address_infos[2]
+
+        if photo:
+            photo_data = self._read_photo()
+            informations["photo"] = photo_data
+
+        for attribute, value in informations.items():
+            setattr(self, attribute, value)
+
+        return informations
+
+    def _read_photo(self):
+        """
+        Reads the photo data from the card.
+        
+        Returns
+        -------
+        bytearray
+            The photo data as a bytearray.
+        """
+        data, sw1, sw2 = self._read_data(PHOTO)
+        photo_bytes = []
+        offset = 0
+        while sw1 == 0x90:
+            cmd = [0x00, 0xB0, offset, 0x00, 256]
+            data, sw1, sw2 = self._send_apdu(cmd)
+            photo_bytes.extend(data)
+            offset += 1
+        if sw1 == 0x6C:
+            offset -= 1
+            cmd = [0x00, 0xB0, offset, 0x00, sw2]
+            data, sw1, sw2 = self._send_apdu(cmd)
+            photo_bytes.extend(data)
+        return bytearray(photo_bytes)
+
+if __name__ == '__main__':
+    cr = CardReader()
+    pprint(cr.read_informations(False))

pythonbeid-0.1.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Fabien Toune
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pythonbeid-0.1.0.dist-info/METADATA

@@ -0,0 +1,74 @@
+Metadata-Version: 2.1
+Name: pythonbeid
+Version: 0.1.0
+Summary: Un module pour lire les informations des cartes d'identité belges
+Home-page: https://github.com/Lapin-Blanc/pythonbeid
+Author: Fabien Toune
+Author-email: fabien.toune@gmail.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyscard
+
+
+# PythonBEID
+
+PythonBEID est un module Python pour lire les informations essentielles des cartes d'identité belge à l'aide d'un lecteur de cartes et de la bibliothèque `pyscard`.
+
+## Installation
+
+Vous pouvez installer ce module via pip :
+
+```bash
+pip install pythonbeid
+```
+
+## Utilisation
+
+Voici un exemple simple d'utilisation du module `pythonbeid` pour lire les informations d'une carte :
+
+```python
+from pythonbeid.card_reader import CardReader
+from pprint import pprint
+
+def main():
+    try:
+        cr = CardReader()
+        informations = cr.read_informations(photo=False)
+        pprint(informations)
+    except RuntimeError as e:
+        print(f"Erreur: {e}")
+
+if __name__ == "__main__":
+    main()
+```
+
+## Dépendances
+
+Ce module nécessite la bibliothèque suivante :
+- `pyscard`
+
+Vous pouvez installer les dépendances avec pip :
+
+```bash
+pip install -r requirements.txt
+```
+
+## Tests
+
+Les tests unitaires sont situés dans le répertoire `tests`. Vous pouvez exécuter les tests avec `unittest` :
+
+```bash
+python -m unittest discover -s tests
+```
+
+## Contribuer
+
+Les contributions et améliorations sont les bienvenues !
+
+## Licence
+
+Ce projet est sous licence MIT. Voir le fichier `LICENSE` pour plus de détails.

pythonbeid-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+pythonbeid/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pythonbeid/card_reader.py,sha256=DBdVrwTPfxdk6cOsA3iVq1myY3K1oQo0Zfs_c-KlLZw,7062
+tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/test_card_reader.py,sha256=S-WhbD8ldB_bdlELJ58LFxjW1Sybj2oKzsujFM97v3Y,300
+pythonbeid-0.1.0.dist-info/LICENSE,sha256=8xOq3W-9w8IgGAWBbKMFTcX3fMQCV4YmgQsvC14CTPE,1090
+pythonbeid-0.1.0.dist-info/METADATA,sha256=69kVEGb-4w3iibDYGV02DiLHzo4LtUyylCWzj-YDPKo,1804
+pythonbeid-0.1.0.dist-info/WHEEL,sha256=cpQTJ5IWu9CdaPViMhC9YzF8gZuS5-vlfoFihTBC86A,91
+pythonbeid-0.1.0.dist-info/top_level.txt,sha256=nwijJKuYdePBeJE_Z_Wy3dUL-h0iF2IgL5SbsVt2-AQ,17
+pythonbeid-0.1.0.dist-info/RECORD,,

pythonbeid-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (70.1.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pythonbeid-0.1.0.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+pythonbeid
+tests

tests/test_card_reader.py

@@ -0,0 +1,11 @@
+import unittest
+from pythonbeid.card_reader import CardReader
+
+class TestCardReader(unittest.TestCase):
+    def test_read_informations(self):
+        cr = CardReader()
+        info = cr.read_informations()
+        self.assertIsNotNone(info)
+
+if __name__ == '__main__':
+    unittest.main()