pax_global_header00006660000000000000000000000064140263437030014514gustar00rootroot0000000000000052 comment=0874bfa30ff0167a39dafbe61266ce06297c2bd3 smartleia-1.0.1/000077500000000000000000000000001402634370300134745ustar00rootroot00000000000000smartleia-1.0.1/.github/000077500000000000000000000000001402634370300150345ustar00rootroot00000000000000smartleia-1.0.1/.github/workflows/000077500000000000000000000000001402634370300170715ustar00rootroot00000000000000smartleia-1.0.1/.github/workflows/main.yml000066400000000000000000000026701402634370300205450ustar00rootroot00000000000000name: leia-python-package # Run this workflow every time a new commit pushed to your repository on: push jobs: distro_package: runs-on: ubuntu-latest # Debian sid contained, since packages are not in ubuntu yet container: debian:sid steps: # Install dependencies and test - name: test distro package shell: bash run: | apt-get -y update; apt-get -y install python3; apt-get -y install smartleia; apt-get -y install vsmartcard-vpcd vsmartcard-vpicc; python3 -c "import smartleia"; local_python_package: runs-on: ubuntu-latest strategy: matrix: python-version: [3.6, 3.7, 3.8, 3.9] steps: # Checkout repository - name: checkout repository uses: actions/checkout@v2 # Run actions - name: set up Python ${{ matrix.python-version }} uses: actions/setup-python@v2 with: python-version: ${{ matrix.python-version }} # Install dependencies and test - name: tests shell: bash run: | pip install pytest; if [ -f requirements.txt ]; then pip install -r requirements.txt; fi; pip install --user .; # Try to import the installed package python -c "import smartleia"; # Try to launch it python -m smartleia || if [ $? -eq 42 ]; then echo "Success (42 is a legitimate exit code)"; else exit 1; fi smartleia-1.0.1/AUTHORS000066400000000000000000000002271402634370300145450ustar00rootroot00000000000000# This is the list of LEIA's python package significant contributors. Ryad BENADJILA David EL-BAZE Mathieu RENARD Philippe THIERRY Philippe TREBUCHET smartleia-1.0.1/LICENSE.bsd3000066400000000000000000000027461402634370300153440ustar00rootroot00000000000000Copyright (c) 2019, The LEIA Team All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. smartleia-1.0.1/LICENSE.lgpl-2.1+000066400000000000000000000636531402634370300160240ustar00rootroot00000000000000 GNU LESSER GENERAL PUBLIC LICENSE Version 2.1, February 1999 Copyright (C) 1991, 1999 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. [This is the first released version of the Lesser GPL. It also counts as the successor of the GNU Library Public License, version 2, hence the version number 2.1.] Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This license, the Lesser General Public License, applies to some specially designated software packages--typically libraries--of the Free Software Foundation and other authors who decide to use it. You can use it too, but we suggest you first think carefully about whether this license or the ordinary General Public License is the better strategy to use in any particular case, based on the explanations below. When we speak of free software, we are referring to freedom of use, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish); that you receive source code or can get it if you want it; that you can change the software and use pieces of it in new free programs; and that you are informed that you can do these things. To protect your rights, we need to make restrictions that forbid distributors to deny you these rights or to ask you to surrender these rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library or if you modify it. For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link other code with the library, you must provide complete object files to the recipients, so that they can relink them with the library after making changes to the library and recompiling it. And you must show them these terms so they know their rights. We protect your rights with a two-step method: (1) we copyright the library, and (2) we offer you this license, which gives you legal permission to copy, distribute and/or modify the library. To protect each distributor, we want to make it very clear that there is no warranty for the free library. Also, if the library is modified by someone else and passed on, the recipients should know that what they have is not the original version, so that the original author's reputation will not be affected by problems that might be introduced by others. Finally, software patents pose a constant threat to the existence of any free program. We wish to make sure that a company cannot effectively restrict the users of a free program by obtaining a restrictive license from a patent holder. Therefore, we insist that any patent license obtained for a version of the library must be consistent with the full freedom of use specified in this license. Most GNU software, including some libraries, is covered by the ordinary GNU General Public License. This license, the GNU Lesser General Public License, applies to certain designated libraries, and is quite different from the ordinary General Public License. We use this license for certain libraries in order to permit linking those libraries into non-free programs. When a program is linked with a library, whether statically or using a shared library, the combination of the two is legally speaking a combined work, a derivative of the original library. The ordinary General Public License therefore permits such linking only if the entire combination fits its criteria of freedom. The Lesser General Public License permits more lax criteria for linking other code with the library. We call this license the "Lesser" General Public License because it does Less to protect the user's freedom than the ordinary General Public License. It also provides other free software developers Less of an advantage over competing non-free programs. These disadvantages are the reason we use the ordinary General Public License for many libraries. However, the Lesser license provides advantages in certain special circumstances. For example, on rare occasions, there may be a special need to encourage the widest possible use of a certain library, so that it becomes a de-facto standard. To achieve this, non-free programs must be allowed to use the library. A more frequent case is that a free library does the same job as widely used non-free libraries. In this case, there is little to gain by limiting the free library to free software only, so we use the Lesser General Public License. In other cases, permission to use a particular library in non-free programs enables a greater number of people to use a large body of free software. For example, permission to use the GNU C Library in non-free programs enables many more people to use the whole GNU operating system, as well as its variant, the GNU/Linux operating system. Although the Lesser General Public License is Less protective of the users' freedom, it does ensure that the user of a program that is linked with the Library has the freedom and the wherewithal to run that program using a modified version of the Library. The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a "work based on the library" and a "work that uses the library". The former contains code derived from the library, whereas the latter must be combined with the library in order to run. GNU LESSER GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any software library or other program which contains a notice placed by the copyright holder or other authorized party saying it may be distributed under the terms of this Lesser General Public License (also called "this License"). Each licensee is addressed as "you". A "library" means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables. The "Library", below, refers to any such software library or work which has been distributed under these terms. A "work based on the Library" means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term "modification".) "Source code" for a work means the preferred form of the work for making modifications to it. For a library, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the library. Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does. 1. You may copy and distribute verbatim copies of the Library's complete source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and distribute a copy of this License along with the Library. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Library or any portion of it, thus forming a work based on the Library, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) The modified work must itself be a software library. b) You must cause the files modified to carry prominent notices stating that you changed the files and the date of any change. c) You must cause the whole of the work to be licensed at no charge to all third parties under the terms of this License. d) If a facility in the modified Library refers to a function or a table of data to be supplied by an application program that uses the facility, other than as an argument passed when the facility is invoked, then you must make a good faith effort to ensure that, in the event an application does not supply such function or table, the facility still operates, and performs whatever part of its purpose remains meaningful. (For example, a function in a library to compute square roots has a purpose that is entirely well-defined independent of the application. Therefore, Subsection 2d requires that any application-supplied function or table used by this function must be optional: if the application does not supply it, the square root function must still compute square roots.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Library, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Library. In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may opt to apply the terms of the ordinary GNU General Public License instead of this License to a given copy of the Library. To do this, you must alter all the notices that refer to this License, so that they refer to the ordinary GNU General Public License, version 2, instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify that version instead if you wish.) Do not make any other change in these notices. Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy. This option is useful when you wish to copy part of the code of the Library into a program that is not a library. 4. You may copy and distribute the Library (or a portion or derivative of it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange. If distribution of object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code. 5. A program that contains no derivative of any portion of the Library, but is designed to work with the Library by being compiled or linked with it, is called a "work that uses the Library". Such a work, in isolation, is not a derivative work of the Library, and therefore falls outside the scope of this License. However, linking a "work that uses the Library" with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a "work that uses the library". The executable is therefore covered by this License. Section 6 states terms for distribution of such executables. When a "work that uses the Library" uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law. If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.) Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself. 6. As an exception to the Sections above, you may also combine or link a "work that uses the Library" with the Library to produce a work containing portions of the Library, and distribute that work under terms of your choice, provided that the terms permit modification of the work for the customer's own use and reverse engineering for debugging such modifications. You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things: a) Accompany the work with the complete corresponding machine-readable source code for the Library including whatever changes were used in the work (which must be distributed under Sections 1 and 2 above); and, if the work is an executable linked with the Library, with the complete machine-readable "work that uses the Library", as object code and/or source code, so that the user can modify the Library and then relink to produce a modified executable containing the modified Library. (It is understood that the user who changes the contents of definitions files in the Library will not necessarily be able to recompile the application to use the modified definitions.) b) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (1) uses at run time a copy of the library already present on the user's computer system, rather than copying library functions into the executable, and (2) will operate properly with a modified version of the library, if the user installs one, as long as the modified version is interface-compatible with the version that the work was made with. c) Accompany the work with a written offer, valid for at least three years, to give the same user the materials specified in Subsection 6a, above, for a charge no more than the cost of performing this distribution. d) If distribution of the work is made by offering access to copy from a designated place, offer equivalent access to copy the above specified materials from the same place. e) Verify that the user has already received a copy of these materials or that you have already sent this user a copy. For an executable, the required form of the "work that uses the Library" must include any data and utility programs needed for reproducing the executable from it. However, as a special exception, the materials to be distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute. 7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library facilities not covered by this License, and distribute such a combined library, provided that the separate distribution of the work based on the Library and of the other library facilities is otherwise permitted, and provided that you do these two things: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities. This must be distributed under the terms of the Sections above. b) Give prominent notice with the combined library of the fact that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 8. You may not copy, modify, sublicense, link with, or distribute the Library except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, link with, or distribute the Library is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 9. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Library or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Library (or any work based on the Library), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Library or works based on it. 10. Each time you redistribute the Library (or any work based on the Library), the recipient automatically receives a license from the original licensor to copy, distribute, link with or modify the Library subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties with this License. 11. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Library at all. For example, if a patent license would not permit royalty-free redistribution of the Library by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Library. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply, and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 12. If the distribution and/or use of the Library is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Library under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 13. The Free Software Foundation may publish revised and/or new versions of the Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation. 14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Libraries If you develop a new library, and you want it to be of the greatest possible use to the public, we recommend making it free software that everyone can redistribute and change. You can do so by permitting redistribution under these terms (or, alternatively, under the terms of the ordinary General Public License). To apply these terms, attach the following notices to the library. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) 2018 The Wookey team This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Also add information on how to contact you by electronic and paper mail. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the library, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the library `Frob' (a library for tweaking knobs) written by James Random Hacker. , 1 April 1990 Ty Coon, President of Vice That's all there is to it! smartleia-1.0.1/README.md000066400000000000000000000035531402634370300147610ustar00rootroot00000000000000# SmartLeia This repository holds the source of the python package used to drive the LEIA smartcard reader. With it, you will be able to: - Connect to the LEIA board - Choose parameters for the PSS/PTS negotiation - Send APDUs and receive the corresponding responses - Activate the DFU mode to download new firmware - Start a [Virtual SmartCard](https://frankmorgner.github.io/vsmartcard/) client to use LEIA as a real smartcard reader (through pcscd) The smartleia package should be compatible with **Python 3.6 and newer**. ## Installation ### From apt If you use debian or ubuntu, smartleia should be packaged (in the recent versions of the distros). Simply try: ```sh apt install smartleia ``` ### From git You may need to use the last version of python builtin's setuptools to install smartleia from git: ```sh python -m pip install --upgrade pip setuptools wheel ``` ```sh git clone https://github.com/cw-leia/smartleia cd smartleia pip install --user .; ``` ## Using smartleia with PCSC It is possible to use smartleia in a PCSC mode, where it communicates with the PCSC daemon so that you can use your existing tools (such as `opensc`) to communicate with the smartcard transparently. Using this mode will require the installation of `vsmartcard-vpcd` and `vsmartcard-vpicc`, either from the sources in the [vsmartcard](https://github.com/frankmorgner/vsmartcard) repository, or from your distro packages (this should be packaged in recent debian and ubuntu distros): ```sh apt install vsmartcard-vpcd vsmartcard-vpicc ``` Then, you can lauch PCSC daemon in a terminal: ```sh pcscd -fad ``` And launch smartleia in PCSC relay mode: ```sh python3 -m smartleia ``` Of course, you should have your LEIA (or equivalent) board plugged in using USB as well as a smart card present in the connector. PCSC should spot a new ATR if everything went fine. smartleia-1.0.1/setup.py000066400000000000000000000026741402634370300152170ustar00rootroot00000000000000 # -*- coding: utf-8 -*- try: from setuptools import setup except ImportError: from distutils.core import setup import os.path readme = '' here = os.path.abspath(os.path.dirname(__file__)) readme_path = os.path.join(here, 'README.md') if os.path.exists(readme_path): with open(readme_path, 'rb') as stream: readme = stream.read().decode('utf8') setup( long_description=readme, name='smartleia', version='1.0.1', description='Python toolkit for LEIA smartcard reader', python_requires='==3.*,>=3.6.0', project_urls={"documentation": "TODO", "homepage": "TODO", "repository": "TODO"}, author='LEIA Team', author_email='leia@ssi.gouv.fr', license='LGPL-2.1+', packages=['smartleia'], package_dir={"": "."}, package_data={"smartleia": ["*.csv", "*.ipynb"]}, install_requires=['dephell==0.*,>=0.8.3', 'pyserial==3.*,>=3.4.0', 'pytest==5.*,>=5.2.0', 'pytest-csv==2.*,>=2.0.2'], extras_require={"dev": ["black==19.*,>=19.10.0.b0", "bump2version==1.*,>=1.0.0", "coverage==5.*,>=5.1.0", "flake8==3.*,>=3.7.9", "ipython==7.*,>=7.14.0", "mypy==0.*,>=0.770.0", "nbsphinx==0.*,>=0.7.0", "pandoc==1.*,>=1.0.2", "pre-commit==2.*,>=2.3.0", "pylint==2.*,>=2.5.2", "pytest-runner==5.*,>=5.2.0", "recommonmark==0.*,>=0.6.0", "sphinx==3.*,>=3.0.0", "sphinx-autodoc-typehints==1.*,>=1.10.3", "sphinx-rtd-theme==0.*,>=0.5.0", "sphinxcontrib.spelling==5.*,>=5.0.0", "sphinxcontrib.wavedrom==2.*,>=2.1.0"]}, ) smartleia-1.0.1/smartleia/000077500000000000000000000000001402634370300154555ustar00rootroot00000000000000smartleia-1.0.1/smartleia/__init__.py000066400000000000000000001154311402634370300175730ustar00rootroot00000000000000""" Here is detailed the python API of the `smartleia` package. """ import ctypes import threading import time from enum import Enum, IntEnum, IntFlag from typing import List, Optional, Union import serial import serial.tools.list_ports __all__ = [ "TriggerPoints", "T", "Triggers", "TriggerStrategy", "create_APDU_from_bytes", "APDU", "RESP", "ATR", "LEIA", ] __version__ = "1.0.1" name = "smartleia" COMMAND_LEN_SIZE = 4 RESPONSE_LEN_SIZE = 4 TRIGGER_DEPTH = 10 STRATEGY_MAX = 4 # Maximum size of APDU payload size # NOTE: because of firmware SRAM constraints, we only # support this size for now. MAX_APDU_PAYLOAD_SIZE = 16384 ERR_FLAGS = {0x00: "OK", 0x01: "PLATFORM_ERR_CARD_NOT_INSERTED", 0xFF: "UNKNOWN_ERROR"} class LEIAStructure(ctypes.Structure): """ Base structure for exchanging data with LEIA. """ def pack(self): return bytes(self)[:] def unpack(self, by): fit = min(len(by), ctypes.sizeof(self)) ctypes.memmove(ctypes.addressof(self), by, fit) return self def normalized(self): return bytes(self) def __repr__(self): return str(self) def __str__(self): return " ".join(["{:02x}".format(x) for x in self.normalized()]) class ByteStruct(LEIAStructure): _pack_ = 1 _fields_ = [("value", ctypes.c_uint8)] class Timers(LEIAStructure): _pack_ = 1 _fields_ = [ ("delta_t", ctypes.c_uint32), ("delta_t_answer", ctypes.c_uint32), ] def __init__(self, delta_t = 0, delta_t_answer = 0): """ Create a Timers structure. Parameters: delta_t (int) : total time for the APDU. delta_t_answer (int) : answer time for the APDU. """ LEIAStructure.__init__(self, delta_t = 0, delta_t_answer = 0) self.delta_t = self.delta_t_answer = 0 def __str__(self) -> str: return f"""Timers( delta_t={self.delta_t:d} microseconds, delta_t_answer={self.delta_t_answer:d} microseconds, )""" ##### Triggers handling ###### class TriggerPoints(IntFlag): """ Class utility to reference the trigger points available. """ #: Point before getting the ATR. TRIG_GET_ATR_PRE = 1 << 0 #: Point just after the ATR has been received. TRIG_GET_ATR_POST = 1 << 1 #: Point just before sending a simple APDU in T=0. TRIG_PRE_SEND_APDU_SHORT_T0 = 1 << 2 #: Point just before sending a fragmented APDU in T=0. TRIG_PRE_SEND_APDU_FRAGMENTED_T0 = 1 << 3 #: Point just before sending an APDU in T=1. TRIG_PRE_SEND_APDU_T1 = 1 << 4 #: Point just before sending an APDU TRIG_PRE_SEND_APDU = ( TRIG_PRE_SEND_APDU_SHORT_T0 | TRIG_PRE_SEND_APDU_FRAGMENTED_T0 | TRIG_PRE_SEND_APDU_T1 ) #: Point just before receiving a RESP in T=0. TRIG_POST_RESP_T0 = 1 << 6 #: Point just before receiving a RESP in T=1. TRIG_POST_RESP_T1 = 1 << 7 #: Point just before receiving a RESP TRIG_POST_RESP = TRIG_POST_RESP_T0 | TRIG_POST_RESP_T1 #: Point just after sending a byte through the ISO7816 interface. TRIG_IRQ_PUTC = 1 << 8 #: Point juster afted a byte has been received through the ISO7816 interface. TRIG_IRQ_GETC = 1 << 9 class Triggers(Enum): # NOTE: you can improve your trigger strategies here by adding new ones # or existing ones! #: Triggers at the beginning and end of ATR: first trig just before # reading ATR, second trig after we have got the ATR MULTI_TRIG_ATR = [ TriggerPoints.TRIG_GET_ATR_PRE, TriggerPoints.TRIG_GET_ATR_POST, ] # Triggers after the first byte of an APDU has been sent: first trig # just after we have sent our APDU command, second trig when receiving # the first response byte from the card. MULTI_TRIG_AFTER_1ST_BYTE_SEND_APDU = [ TriggerPoints.TRIG_PRE_SEND_APDU, TriggerPoints.TRIG_IRQ_PUTC, ] class TriggerStrategy(LEIAStructure): """ Attributes: delay (int): the delay between event detection and effective trig on GPIO in milliseconds. point_list (list[int]): the list of events to match. """ _pack_ = 1 _fields_ = [ ("size", ctypes.c_uint8), ("delay", ctypes.c_uint32), ("single", ctypes.c_uint8), ("_list", ctypes.c_uint32 * TRIGGER_DEPTH), ("_list_trigged", ctypes.c_uint32 * TRIGGER_DEPTH), ("_cnt_trigged", ctypes.c_uint32 * TRIGGER_DEPTH), ("_event_time", ctypes.c_uint32 * TRIGGER_DEPTH), ("_apply_delay", ctypes.c_uint32 * TRIGGER_DEPTH), ] def __init__(self, delay=0, single=0, point_list=None): if point_list is None: point_list = [] LEIAStructure.__init__(self, size=0, delay=delay, single=single) self.point_list = point_list def _translate_point_list(self, point_list): if isinstance(point_list, Triggers): point_list = point_list.value return list(map(lambda point: TriggerPoints(point).value, point_list)) def __str__(self) -> str: return f"TriggerStrategy(single={self.single}, delay={self.delay}, point_list={self.point_list}, point_list_trigged={self.point_list_trigged}, cnt_list_trigged={self.cnt_list_trigged}, event_time={self.event_time_list})" @property def point_list(self): _point_list = list(self._list)[0 : self.size] try: r = Triggers(_point_list) except Exception: r = list(map(lambda i: TriggerPoints(i), _point_list)) return r @point_list.setter def point_list(self, value): value = self._translate_point_list(value) if not isinstance(value, list): raise Exception("data should be a list") if len(value) > len(self._list): raise Exception("Size of data too high") for i, v in enumerate(value): self._list[i] = value[i] self.size = len(value) @property def point_list_trigged(self): _point_list_trigged = list(self._list_trigged)[0 : self.size] try: r = Triggers(_point_list_trigged) except Exception: r = list(map(lambda i: TriggerPoints(i), _point_list_trigged)) return r @property def cnt_list_trigged(self): _cnt_list_trigged = list(self._cnt_trigged)[0 : self.size] return _cnt_list_trigged @property def event_time_list(self): _event_time_list = list(self._event_time)[0 : self.size] return _event_time_list class SetTriggerStrategy(LEIAStructure): _pack_ = 1 _fields_ = [("index", ctypes.c_uint8), ("strategy", TriggerStrategy)] def __str__(self) -> str: return f"SetTriggerStrategy(index={self.index}, strategy={self.strategy})" class ATR(LEIAStructure): """This class is used to represent an ATR. Attributes: ts (ctypes.c_uint8): Description of `attr1`. t0 (ctypes.c_uint8): Description of `attr2`. ta (ctypes.c_uint8[4]): Description of `attr1`. tb (ctypes.c_uint8[4]): Description of `attr2`. tc (ctypes.c_uint8[4]): Description of `attr1`. td (ctypes.c_uint8[4]): Description of `attr2`. h (ctypes.c_uint8[16]): Description of `attr1`. t_mask (ctypes.c_uint8[4]): Description of `attr2`. h_num (ctypes.c_uint8): Description of `attr1`. tck (ctypes.c_uint8): Description of `attr2`. tck_present (ctypes.c_uint8): Description of `attr1`. D_i_curr (ctypes.c_uint32): Description of `attr2`. F_i_curr (ctypes.c_uint32): Description of `attr1`. f_max_curr (ctypes.c_uint32): Description of `attr2`. T_protocol_curr (ctypes.c_uint8): Description of `attr1`. ifsc (ctypes.c_uint8): Description of `attr2`. """ _pack_ = 1 _fields_ = [ ("ts", ctypes.c_uint8), ("t0", ctypes.c_uint8), ("ta", ctypes.c_uint8 * 4), ("tb", ctypes.c_uint8 * 4), ("tc", ctypes.c_uint8 * 4), ("td", ctypes.c_uint8 * 4), ("h", ctypes.c_uint8 * 16), ("t_mask", ctypes.c_uint8 * 4), ("h_num", ctypes.c_uint8), ("tck", ctypes.c_uint8), ("tck_present", ctypes.c_uint8), ("D_i_curr", ctypes.c_uint32), ("F_i_curr", ctypes.c_uint32), ("f_max_curr", ctypes.c_uint32), ("T_protocol_curr", ctypes.c_uint8), ("ifsc", ctypes.c_uint8), ] def normalized(self) -> bytes: b = b"" b += ctypes.string_at(ctypes.addressof(self), ATR.ts.size + ATR.t0.size) for i in range(0, 4): if self.t_mask[0] & (0x1 << i) != 0: b += ctypes.string_at(ctypes.addressof(self) + ATR.ta.offset + i, 1) if self.t_mask[1] & (0x1 << i) != 0: b += ctypes.string_at(ctypes.addressof(self) + ATR.tb.offset + i, 1) if self.t_mask[2] & (0x1 << i) != 0: b += ctypes.string_at(ctypes.addressof(self) + ATR.tc.offset + i, 1) if self.t_mask[3] & (0x1 << i) != 0: b += ctypes.string_at(ctypes.addressof(self) + ATR.td.offset + i, 1) b += ctypes.string_at(ctypes.addressof(self) + ATR.h.offset, self.h_num) if self.tck_present == 1: b += ctypes.string_at(ctypes.addressof(self) + ATR.tck.offset, 1) return b def pretty_print(self): print("TS = 0x%02x" % self.ts) print("T0 = 0x%02x" % self.t0) for i in range(0, 4): if self.t_mask[0] & (0x1 << i) != 0: print("TA[%d] = 0x%02x" % (i, self.ta[i])) for i in range(0, 4): if self.t_mask[1] & (0x1 << i) != 0: print("TB[%d] = 0x%02x" % (i, self.tb[i])) for i in range(0, 4): if self.t_mask[2] & (0x1 << i) != 0: print("TC[%d] = 0x%02x" % (i, self.tc[i])) for i in range(0, 4): if self.t_mask[3] & (0x1 << i) != 0: print("TD[%d] = 0x%02x" % (i, self.td[i])) for i in range(0, self.h_num): print("H[%d] = 0x%02x" % (i, self.h[i])) if self.tck_present == 1: print("TCK = 0x%02x" % (self.tck)) print("------ Protocol information") print(" Current protocol T = %d" % (self.T_protocol_curr)) print( " Di = %d, Fi = %d, f_max_curr = %d MHz" % (self.D_i_curr, self.F_i_curr, self.f_max_curr) ) print(" IFSC = %d" % (self.ifsc)) return def __str__(self) -> str: return f"""ATR( ts=0x{self.ts:02X}, t0=0x{self.t0:02X}, ta=[0x{self.ta[0]:02X}, 0x{self.ta[1]:02X}, 0x{self.ta[2]:02X}, 0x{self.ta[3]:02X}], tb=[0x{self.tb[0]:02X}, 0x{self.tb[1]:02X}, 0x{self.tb[2]:02X}, 0x{self.tb[3]:02X}], tc=[0x{self.tc[0]:02X}, 0x{self.tc[1]:02X}, 0x{self.tc[2]:02X}, 0x{self.tc[3]:02X}], td=[0x{self.td[0]:02X}, 0x{self.td[1]:02X}, 0x{self.td[2]:02X}, 0x{self.td[3]:02X}], h=[0x{self.h[ 0]:02X}, 0x{self.h[ 1]:02X}, 0x{self.h[ 2]:02X}, 0x{self.h[ 3]:02X}, 0x{self.h[ 4]:02X}, 0x{self.h[ 5]:02X}, 0x{self.h[ 6]:02X}, 0x{self.h[ 7]:02X}, 0x{self.h[ 8]:02X}, 0x{self.h[ 9]:02X}, 0x{self.h[10]:02X}, 0x{self.h[11]:02X}, 0x{self.h[12]:02X}, 0x{self.h[13]:02X}, 0x{self.h[14]:02X}, 0x{self.h[15]:02X}], t_mask=[0x{self.t_mask[0]:02X}, 0x{self.t_mask[1]:02X}, 0x{self.t_mask[2]:02X}, 0x{self.t_mask[3]:02X}], h_num=0x{self.h_num:02X}, tck=0x{self.tck:02X}, tck_present=0x{self.tck_present:02X}, D_i_curr={self.D_i_curr}, F_i_curr={self.F_i_curr}, f_max_curr={self.f_max_curr}, T_protocol_curr={self.T_protocol_curr}, ifsc={self.ifsc} )""" class ResponseSizeStruct(LEIAStructure): """ Attributes: response_size (ctypes.c_uint32): number of bytes of the response. """ _pack_ = 1 _fields_ = [("response_size", ctypes.c_uint32)] class APDU(LEIAStructure): """Object for representing an APDU. Attributes: cla (ctypes.c_uint8): the `CLA` field of the APDU. ins (ctypes.c_uint8): the `INS` field of the APDU. p1 (ctypes.c_uint8): the `P1` field of the APDU. p2 (ctypes.c_uint8): the `P2` field of the APDU. lc (ctypes.c_uint16): the `Lc` field of the APDU. le (ctypes.c_uint32): the `Le` field of the APDU. send_le (ctypes.c_uint8): Description of `attr1`. data (list[int]): the `data` field of the APDU. """ _pack_ = 1 _fields_ = [ ("cla", ctypes.c_uint8), ("ins", ctypes.c_uint8), ("p1", ctypes.c_uint8), ("p2", ctypes.c_uint8), ("lc", ctypes.c_uint16), ("le", ctypes.c_uint32), ("send_le", ctypes.c_uint8), ("_data", ctypes.c_uint8 * MAX_APDU_PAYLOAD_SIZE), ] def __init__( self, cla: int = 0, ins: int = 0, p1: int = 0, p2: int = 0, lc: int = None, le: int = 0, send_le: int = 1, data: Optional[List[int]] = None, ): """ Create an APDU structure. Parameters: cla: the `CLA` field of the APDU. ins: the `INS` field of the APDU. p1: the `P1` field of the APDU. p2: the `P2` field of the APDU. lc: the `Lc` (data length) field of the APDU. le: the `Le` (expected length) field of the APDU. send_le: TODO. data: the list of bytes to send. """ if data is None: data = [] elif hasattr(data, "__iter__"): data = list(data) if lc is None: lc = len(data) LEIAStructure.__init__( self, cla=cla, ins=ins, p1=p1, p2=p2, lc=lc, le=le, send_le=send_le ) self.data = data def pack(self): return LEIAStructure.pack(self)[: APDU._data.offset + self.lc] def __str__(self) -> str: return ( f"APDU(cla={hex(self.cla)}, ins={hex(self.ins)}, p1={hex(self.p1)}, p2={hex(self.p2)}, lc={self.lc}, le={self.le}, send_le={self.send_le}" + (f", data={self.data}" if self.lc != 0 else "") + ")" ) @property def data(self): return list(self._data)[0 : self.lc] @data.setter def data(self, value): if not isinstance(value, list): raise Exception("data should be a list") if len(value) > len(self._data): raise Exception("Size of data too high") for i, v in enumerate(value): self._data[i] = value[i] self.lc = len(value) def normalized(self) -> bytes: b = b"" b += ctypes.string_at(ctypes.addressof(self), APDU.lc.offset) if self.lc != 0: b += ctypes.string_at(ctypes.addressof(self) + APDU.lc.offset, APDU.lc.size) b += ctypes.string_at(ctypes.addressof(self) + APDU._data.offset, self.lc) if self.send_le != 0: b += ctypes.string_at(ctypes.addressof(self) + APDU.le.offset, APDU.le.size) if self.lc == 0 and self.send_le == 0: b += ctypes.string_at(ctypes.addressof(self) + APDU.lc.offset, APDU.lc.size) return b def create_APDU_from_bytes(_bytes) -> APDU: """Create an :class:`APDU` instance from a list of bytes. Example: >>> create_APDU_from_bytes([0x00,0x01,0x02,0x03,0x04,0x05,0x06,0x07,0x08,0x09]) APDU(cla=0x00, ins=0x01, p1=0x02, p2=0x03, lc=0x04, data=[0x05, 0x06, 0x07, 0x08], le=0x09, send_le=1) """ apdu = APDU() apdu.cla, apdu.ins, apdu.p1, apdu.p2 = _bytes[:4] apdu.send_le = 0 if len(_bytes) < 5: raise NotImplementedError( "Error in decoding APDU buffer of size %d is too small" % (len(_bytes)) ) if len(_bytes) == 5: apdu.lc, apdu.le = 0, _bytes[4] apdu.send_le = 1 else: apdu.lc, apdu.le = _bytes[4], 0 if apdu.lc == 0x00 and len(_bytes) >= 8: # This is an extended APDU, try to decode Lc on 16 bits apdu.send_le = 2 apdu.lc = (_bytes[5] << 16) + _bytes[6] # Get the data if len(_bytes) >= (apdu.lc + 7): if apdu.lc >= len(apdu._data): raise NotImplementedError( "Error in decoding extended APDU: buffer %d exceeds LEIA size %d" % (apdu.lc, len(apdu._data)) ) for i in range(apdu.lc): apdu._data[i] = _bytes[7 + i] # Get Le if present if len(_bytes) >= (apdu.lc + 7 + 3): if _bytes[apdu.lc + 7] != 0x00: raise NotImplementedError("Error in decoding extended APDU Le") apdu.le = (_bytes[apdu.lc + 7 + 1] << 16) + _bytes[apdu.lc + 7 + 2] else: # Lc is not present and we have in fact Le on 3 bytes apdu.le = apdu.lc apdu.lc = 0 elif apdu.lc == 0: # Short APDU with no data if len(_bytes) == 6: apdu.le = _bytes[5] apdu.send_le = 1 else: # Should be covered otherwise apdu.le = 0 apdu.send_le = 1 else: # Short APDU with data for i in range(apdu.lc): apdu._data[i] = _bytes[5 + i] if len(_bytes) == 5 + apdu.lc + 1: apdu.le = _bytes[5 + apdu.lc] apdu.send_le = 1 return apdu class RESP(LEIAStructure): """This class is used to represent an RESP. Attributes: sw1 (ctypes.c_uint8): The value of `SW1` field. sw2 (ctypes.c_uint8): The value of `SW2` field. le (ctypes.c_uint32): The length of the data. data (list[byte]): The value of the `data` field. """ _pack_ = 1 _fields_ = [ ("le", ctypes.c_uint32), ("sw1", ctypes.c_uint8), ("sw2", ctypes.c_uint8), ("delta_t", ctypes.c_uint32), ("delta_t_answer", ctypes.c_uint32), ("_data", ctypes.c_uint8 * MAX_APDU_PAYLOAD_SIZE), ] def __init__(self, sw1=0, sw2=0, data=None, delta_t=0, delta_t_answer=0): """ Create an RESP structure. Parameters: le (int): the `Le` field of the RESP. sw1 (int): the `SW1` field of the RESP. sw2 (int): the `SW2` field of the RESP. delta_t (int) : total time for the APDU. delta_t_answer (int) : answer time for the APDU. data (list[int]): the list of bytes received. """ if data is None: data = [] LEIAStructure.__init__( self, sw1=sw1, sw2=sw2, delta_t=delta_t, delta_t_answer=delta_t_answer ) self.data = data def __str__(self) -> str: return ( f"RESP(sw1=0x{self.sw1:02X}, sw2=0x{self.sw2:02X}, le={hex(self.le)}" + (f", data={self.data}" if self.le != 0 else "") + (f")\ndelta_t={self.delta_t:d} microseconds, delta_t_answer={self.delta_t_answer:d} microseconds") ) @property def data(self): return list(self._data)[0 : self.le] @data.setter def data(self, value): if not isinstance(value, list): raise Exception("data should be a list") if len(value) > len(self._data): raise Exception("Size of data too high") for i, v in enumerate(value): self._data[i] = value[i] self.le = len(value) def normalized(self) -> bytes: b = b"" b += ctypes.string_at(ctypes.addressof(self) + RESP._data.offset, self.le) b += ctypes.string_at(ctypes.addressof(self) + RESP.sw1.offset, RESP.sw1.size) b += ctypes.string_at(ctypes.addressof(self) + RESP.sw2.offset, RESP.sw2.size) return b class T(IntEnum): """ ISO7816 protocol selection. """ #: The protocol is negotiated. AUTO = -1 #: The protocol is T=0 T0 = 0 #: The protocol is T=1 T1 = 1 class Mode(IntEnum): """ ISO7816 mode selection. """ # USART mode USART = 0 # Bitbang mode BITBANG = 1 class LEIAMode(LEIAStructure): _pack_ = 1 _fields_ = [ ("mode", ctypes.c_uint8), ] def __init__( self, mode, ): LEIAStructure.__init__( self, mode=mode, ) class ConfigureSmartcardCommand(LEIAStructure): _pack_ = 1 _fields_ = [ ("protocol", ctypes.c_uint8), ("etu", ctypes.c_uint32), ("freq", ctypes.c_uint32), ("negotiate_pts", ctypes.c_uint8), ("negotiate_baudrate", ctypes.c_uint8), ] def __init__( self, protocol=None, etu=None, freq=None, negotiate_pts=True, negotiate_baudrate=True, ): LEIAStructure.__init__( self, protocol=protocol, etu=etu, freq=freq, negotiate_pts=negotiate_pts, negotiate_baudrate=negotiate_baudrate, ) class LEIA: """ This class connects to a LEIA board and provides an access to all the device functionnality. """ USB_VID = 0x3483 USB_PID = 0x0BB9 def __init__( self, device: str = "", serial_factory: Optional[serial.Serial] = None, auto_open=True, ): """ Parameters: device: the serial port to use with LEIA (like /dev/ttyUSB0). Raises: Exception: if no serial port is provided. """ self.reconfigured = False self.pcsc_stop = False self.pcsc_relay_thread = None self.curr_atr = None self.lock = threading.Lock() if serial_factory is None: serial_factory = serial.Serial self.device = device self.serial_factory = serial_factory if auto_open: self.open() def _testWaitingFlag(self): """ Verify the presence of the waiting flag. """ self.ser.read_all() self.ser.write(b" ") time.sleep(0.1) d = self.ser.read() + self.ser.read_all() if len(d) == 0 or d[-1] != 87: # b"W" raise ConnectionError("Can not connect to LEIA.") def _checkAck(self): """ Verify the presence of the acknowledge flag. """ if self.ser.read() != b"R": raise IOError("No response ack received.") def _checkStatus(self): """ Verify the presence of the status flag. """ s = self.read() while s == b"w": # This is a 'wait extension' flag, try to read again s = self.read() if len(s) == 0: raise IOError("No status flag received.") if s == b"U": raise IOError("LEIA firmware do not handle this command.") elif s == b"E": raise IOError("Unkwown error (E).") elif s != b"S": raise IOError("Invalid status flag '{s}' received.") status = self.read() if status == b"": raise IOError("Status not received.") elif status != b"\x00": raise IOError(ERR_FLAGS[ord(status)]) return status def _read_response_size(self): """ Read and parse the "response size" field. """ return ( ResponseSizeStruct().unpack(self.ser.read(RESPONSE_LEN_SIZE)).response_size ) def reset(self): """ Reset LEIA. """ with self.lock: self._testWaitingFlag() self._send_command(b"r") def open(self): """ Open LEIA. """ if not self.device: # Try to find automatically the device possible_ports = [] for port in serial.tools.list_ports.comports(): if port.pid == self.USB_PID and port.vid == self.USB_VID: possible_ports.append(port) if len(possible_ports) > 2: raise RuntimeError( f"Too much {self.USB_VID}/{self.USB_PID} devices found! I don't know which one to use." ) elif len(possible_ports) == 0: raise RuntimeError(f"No {self.USB_VID}/{self.USB_PID} device found") for possible_port in possible_ports: self.device = possible_port.device try: self.ser = self.serial_factory( self.device, timeout=1, baudrate=115200 ) while True: d = self.read_all() if len(d) == 0: break self._testWaitingFlag() self.ser.timeout = 10 except ConnectionError: self.ser.close() except serial.SerialException: pass else: break else: self.ser = self.serial_factory(self.device, timeout=1, baudrate=115200) while True: d = self.read_all() if len(d) == 0: break self._testWaitingFlag() self.ser.timeout = 10 # Set the mode to either USART or BITBANG def set_mode(self, mode: Mode): if mode == Mode.USART: self._send_command(b"e", LEIAMode(Mode.USART)) elif mode == Mode.BITBANG: self._send_command(b"e", LEIAMode(Mode.BITBANG)) else: raise Exception( "Invalid mode for 'set_mode' (e) command." ) # Get the current mode def get_mode(self): self._send_command(b"g") r_size = self._read_response_size() if r_size != 1: raise Exception( "Invalid response size for 'get_mode' (g) command." ) r = self.ser.read(1) if r == b"\x00": mode = Mode.USART elif r == b"\x01": mode = Mode.BITBANG else: mode = None return mode def configure_smartcard( self, protocol_to_use: Optional[T] = None, ETU_to_use: Optional[int] = None, freq_to_use: Optional[int] = None, negotiate_pts: Optional[bool] = True, negotiate_baudrate: Optional[bool] = True, ): """Configure a smartcard connection. Method to configure a smartcard. By default, the smartcard reader will negociate with the smartcard the mode (T=0 or T=1), the ETU and the frequence to use. It is possible to: - force a mode (by setting protocol_to_use to 0 for T=0, and to 1 for T=1) - force an ETU (by setting the ETU_to_use parameter) - force a frequence (by setting the freq_to_use parameter) Example: >>> leia.configure_smartcard(T.T0, ETU_to_use=372) Parameters: protocol_to_use: The protocol to use (0: T=0, 1: T=1). ETU_to_use: The ETU value to force. If None, will be negociated (or default will be used). freq_to_use: The ISO7816 clock frequency to use. If None, will be negociated (or default will be used). negotiate_pts: if LEIA can try to negotiate the PTS. negotiate_baudrate: if LEIA can negotiate the baudrate. There is not impact if `ETU_to_use` and `freq_to_use` are set. """ with self.lock: self._testWaitingFlag() self.reconfigured = True self.curr_atr = None if protocol_to_use is None: protocol_to_use = T.AUTO try: _protocol_to_use = T(protocol_to_use).value + 1 except ValueError: raise NotImplementedError("Unknown protocol value.") if ETU_to_use is None: ETU_to_use = 0 if freq_to_use is None: freq_to_use = 0 negotiate_pts = True if negotiate_pts else False negotiate_baudrate = True if negotiate_baudrate else False # We always try to negotiate a T=1 communication if not specifically asked otherwise # Fallback to auto if this is not possible! if (protocol_to_use == T.AUTO) and (negotiate_pts == True): try: struct = ConfigureSmartcardCommand( T(T.T1).value + 1, ETU_to_use, freq_to_use, negotiate_pts, negotiate_baudrate, ) self._send_command(b"c", struct) except Exception: struct = ConfigureSmartcardCommand( T(T.AUTO).value + 1, ETU_to_use, freq_to_use, negotiate_pts, negotiate_baudrate, ) self._send_command(b"c", struct) else: struct = ConfigureSmartcardCommand( _protocol_to_use, ETU_to_use, freq_to_use, negotiate_pts, negotiate_baudrate, ) self._send_command(b"c", struct) def get_trigger_strategy(self, SID: int) -> TriggerStrategy: """ Returns the strategy N°SID. Parameters: SID: The trigger strategy's ID to get. Returns: TriggerStrategy: The trigger strategy N°SID. """ with self.lock: if SID >= STRATEGY_MAX: raise Exception("get_trigger_strategy: asked SID=%d exceeds STRATEGY_MAX=%d" % (SID, STRATEGY_MAX)) self._send_command(b"o", ByteStruct(SID)) r_size = self._read_response_size() r = TriggerStrategy(TRIGGER_DEPTH).unpack(self.ser.read(r_size)) return r def set_trigger_strategy( self, SID: int, point_list: Union[int, List[int]], delay: int = 0, single: int = 0 ): """ Set and activate a trigger strategy. Parameters: SID: the strategy bank ID to use. point_list: the sequence to match for the trigger. delay: the delay (in milliseconds) between the moment of the detection and the moment where the trigger is actually set high. """ with self.lock: if SID >= STRATEGY_MAX: raise Exception("get_trigger_strategy: asked SID=%d exceeds STRATEGY_MAX=%d" % (SID, STRATEGY_MAX)) if isinstance(point_list, int): size = 1 point_list = [point_list] size = len(point_list) sts = SetTriggerStrategy(SID, TriggerStrategy(delay = delay, single = single, point_list = point_list)) self._send_command(b"O", sts) def get_timers(self) -> Timers: """ Return the `timers` of the last command. Returns: Timers: The `Timer` object. """ with self.lock: self._send_command(b"m") r_size = self._read_response_size() r = Timers().unpack(self.ser.read(r_size)) return r def get_ATR(self) -> ATR: """ Return the `ATR`. Returns: ATR: The `ATR` object. """ with self.lock: self._send_command(b"t") r_size = self._read_response_size() r = ATR().unpack(self.ser.read(r_size)) return r def is_card_inserted(self) -> bool: """ Return `True` if a smartcard is inserted in LEIA. Returns: `True` if a smartcard is inserted, else `False`. """ with self.lock: self._send_command(b"?") r_size = self._read_response_size() if r_size != 1: raise Exception( "Invalid response size for 'is_card_inserted' (?) command." ) r = self.ser.read(1) return True if r == b"\x01" else False # DFU mode def dfu(self) -> None: """ Reboot LEIA in DFU mode. """ with self.lock: try: self._send_command(b"u") except serial.SerialException: pass # AVR flasher mode def flasher(self) -> None: """ Reboot LEIA in funcard flasher mode. """ with self.lock: try: self._send_command(b"f") except serial.SerialException: pass def smartreader(self) -> None: """ Reboot LEIA in funcard smartreader mode. """ with self.lock: try: self._send_command(b"s") except serial.SerialException: pass def send_APDU(self, apdu: APDU) -> RESP: """ Send an `APDU`. Parameters: apdu: The `APDU` object. Returns: RESP: The `RESP` object. """ with self.lock: self._send_command(b"a", apdu) r_size = self._read_response_size() r = RESP().unpack(self.ser.read(r_size)) return r def _send_command(self, command: bytes, struct: LEIAStructure = None): """ Send a command to LEIA. Parameters: command: the ID of the command. struct: the data of the command. """ self._testWaitingFlag() self.ser.write(command) if struct is not None: compacted = struct.pack() size = len(compacted).to_bytes(COMMAND_LEN_SIZE, byteorder="big") self.ser.write(size) self.ser.write(compacted) else: self.ser.write((0).to_bytes(COMMAND_LEN_SIZE, byteorder="big")) self._checkStatus() self._checkAck() def __getattr__(self, attr): if hasattr(self.ser, attr): return getattr(self.ser, attr) raise AttributeError(f"no attribute '{attr}'") # Handle connection with a virtual smart card reader # on localhost or elsewhere on the network def _pcsc_relay_thread(self, host, port): # noqa: C901 import binascii import socket import struct print("Starting LEIA PCSC relay for host %s:%d" % (host, port)) while not self.pcsc_stop: if not self.is_card_inserted(): self.curr_atr = None time.sleep(0.5) s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) try: s.connect((host, port)) except Exception as e: print( "Error: cannot connect to %s:%d. Is PCSCD running with virtual smartcard readers?" % (host, port) ) raise (e) s.settimeout(10) while ( self.is_card_inserted() and not self.reconfigured and not self.pcsc_stop ): # Now wait for data to come # Get the comrand data = b"" while len(data) != 2: if self.pcsc_stop: break try: data += s.recv(1) except socket.timeout: pass if self.pcsc_stop: break length = struct.unpack("!H", data)[0] if length == 1: # We received a Power Off, Power On, Reset or Get ATR command data = s.recv(1) if data == b"\x00": # print("Received Power Off command!") pass elif data == b"\x01": # print("Received Power On command!") pass elif data == b"\x02": # print("Received Reset command!") pass elif data == b"\x04": # print("Received Get ATR command!") # Format our length if not self.is_card_inserted(): # print("Card not inserted!") s.sendall(b"\x00\x00") else: if self.curr_atr is None: self.curr_atr = self.get_ATR() if self.curr_atr.ts == 0x00: # Card not configured, configure it try: self.configure_smartcard() except Exception: pass self.curr_atr = self.get_ATR() # Send the ATR length = struct.pack("!H", len(self.curr_atr.normalized())) s.sendall(length + self.curr_atr.normalized()) else: print( "LEIA PCSC relay error: received unknown command %s" % binascii.hexlify(data) ) else: # We received an APDU # print("Received APDU command of size %d!" % length) data = s.recv(length) # Format and send the APDU apdu = create_APDU_from_bytes(data) r = self.send_APDU(apdu) # If we have a 61XX response, handle the GET_RESPONSE here! if r.sw1 == 0x61: r = self.send_APDU( APDU( cla=apdu.cla, ins=0xC0, p1=0x00, p2=0x00, le=r.sw2, send_le=1, ) ) # If we have a 6Cxx (wrong length), adapt the APDU if r.sw1 == 0x6C: apdu.le = r.sw2 apdu.send_le = 1 r = self.send_APDU(apdu) # If we have 67XX, adapt the APDU if r.sw1 == 0x67: apdu.le = 0x00 apdu.send_le = 1 r = self.send_APDU(apdu) # Format the response and send it length = struct.pack("!H", len(r.normalized())) s.sendall(length + r.normalized()) s.close() self.reconfigured = False self.pcsc_stop = False print("End of the relay.") def pcsc_relay(self, host="127.0.0.1", port=0x8C7B): self.pcsc_relay_thread = threading.Thread( name="LEIA PCSC relay", target=self._pcsc_relay_thread, args=(host, port) ) self.pcsc_relay_thread.daemon = True self.pcsc_relay_thread.start() def pcsc_relay_stop(self): self.pcsc_stop = True smartleia-1.0.1/smartleia/__main__.py000066400000000000000000000030111402634370300175420ustar00rootroot00000000000000import code import sys import smartleia as sl leia = None def t0(): leia.configure_smartcard(protocol_to_use=0) def t1(): leia.configure_smartcard(protocol_to_use=1) def configure(*args, **kwargs): leia.configure_smartcard(*args, **kwargs) def dfu(): leia.dfu() if __name__ == "__main__": try: leia = sl.LEIA() except: print("Error: are you sure that your LEIA board is connected?") sys.exit(42) try: leia.configure_smartcard() except: print("Error: are you sure that a smartcard is inserted in the LEIA board?") sys.exit(42) try: leia.pcsc_relay() except: print("Error: error in pcsc_relay, is PCSCD running? Launch in a terminal with 'pcscd -fad'") sys.exit(42) code.interact( local=locals(), banner=""" The connection with LEIA is opened and is connected to pcscd through virtualsmartcard. You can change the link with the smartcard with the following commands : configure( protocol_to_use=0, ETU_to_use=..., freq_to_use=..., negotiate_pts=True, negotiate_baudate=True) t0() Equivalent to configure(protocol_to_use=0) t1() Equivalent to configure(protocol_to_use=1) dfu() You have access to leia through the `leia` variable. Type exit() or CTRL-D to exit. """, ) leia.close() sys.exit(0) smartleia-1.0.1/smartleia/test_applet.py000066400000000000000000000162241402634370300203600ustar00rootroot00000000000000import argparse import sys import pytest from smartleia import APDU, LEIA, Mode STEP = 14 parser = argparse.ArgumentParser(description="Run tests on the the LEIA test applet.") parser.add_argument( "--device", type=str, default="", help="the device to use (eg. /dev/ttyACM0)" ) parser.add_argument( "--output-file", default="output.csv", help="the name of the output file" ) parser.add_argument( "-T0", default=False, const=True, action="store_const", help="Do the tests for T=0" ) parser.add_argument( "-T1", default=False, const=True, action="store_const", help="Do the tests for T=1" ) args = parser.parse_args() if args.T0 and args.T1: TEST_T0 = True TEST_T1 = True elif args.T0: TEST_T0 = True TEST_T1 = False elif args.T1: TEST_T0 = False TEST_T1 = True else: TEST_T0 = True TEST_T1 = True reader = LEIA(args.device) #: Set protoctol T=0 @pytest.fixture(scope="function") def mode_t0(): if reader.get_mode() == Mode.BITBANG: # NOTE: for Bitbang mode, due to inherent limitations, we choose # a low frequency of 500 KHz as a conservative choice reader.configure_smartcard(protocol_to_use=0, freq_to_use=500000) else: # NOTE: for T=0, we use a conservative frequency even in USART mode reader.configure_smartcard(protocol_to_use=0, freq_to_use=2800000) #: Set protoctol T=1 @pytest.fixture(scope="function") def mode_t1(): if reader.get_mode() == Mode.BITBANG: # NOTE: for Bitbang mode, due to inherent limitations, we choose # a low frequency of 500 KHz as a conservative choice reader.configure_smartcard(protocol_to_use=1, freq_to_use=500000) else: # NOTE: for T=1 and USART mode, let the firmware decide the # frequency to use reader.configure_smartcard(protocol_to_use=1) #: Select the test applet @pytest.fixture(scope="function") def select_applet(): apdu = APDU( cla=0x00, ins=0xA4, p1=0x04, p2=0x00, lc=0x0A, le=0x00, data=[0x45, 0x75, 0x74, 0x77, 0x74, 0x75, 0x36, 0x41, 0x70, 0x80], send_le=0, ) reader.send_APDU(apdu) ############################################################################################ #: Case 1 is we send an APDU with no data, and we expect a simple 90 00 resp #: with no data def case1(record_property): record_property("case", 1) record_property("extended", False) apdu = APDU(cla=0x00, ins=0x01, p1=0x00, p2=0x00, lc=0x00, le=0x00, send_le=1) print(apdu) record_property("apdu", apdu) resp = reader.send_APDU(apdu) print(resp) record_property("resp", resp) assert hex(resp.sw1) == hex(0x90) assert hex(resp.sw2) == hex(0x00) assert resp.le == 0 if TEST_T0: def test_case1_t0(mode_t0, select_applet, record_property): record_property("T", 0) case1(record_property) if TEST_T1: def test_case1_t1(mode_t1, select_applet, record_property): record_property("T", 1) case1(record_property) ############################################################################################ #: Case 2 is we sned an APDU with no data, and we except a 90 00 resp with #: recv bytes of data. def case2(recv, record_property): record_property("case", 2) record_property("extended", False if recv < 256 else True) # Compute recv on two bytes ab = recv // 256 cd = recv % 256 # Adapt the case where we need an extended APDU send_le = 1 if recv < 256 else 2 # Prepare the APDU apdu = APDU( cla=0x00, ins=0x02, p1=ab, p2=cd, lc=0x0, le=0, send_le=send_le ) # le = recv print(apdu) record_property("apdu", apdu) # Send the APDU and get the response resp = reader.send_APDU(apdu) print(resp) record_property("resp", resp) # Check for 90 00 assert hex(resp.sw1) == hex(0x90) or hex(resp.sw1) == hex(0x6C) assert hex(resp.sw2) == hex(0x00) or ( hex(resp.sw2) == hex(cd) and hex(resp.sw1) == hex(0x6C) ) # If 90 00 check that the length of the response is recv if resp.sw1 == 0x90 and resp.sw2 == 0: assert resp.le == recv else: assert resp.le == 0 # Check each byte of the resp if resp.le == recv: for v in range(recv): assert resp.data[v] == v % 256 if TEST_T0: @pytest.mark.parametrize("recv", range(1, 300, STEP)) def test_case2_t0(mode_t0, select_applet, recv, record_property): record_property("T", 0) case2(recv, record_property) if TEST_T1: @pytest.mark.parametrize("x", range(1, 300, STEP)) def test_case2_t1(mode_t1, select_applet, x, record_property): record_property("T", 1) case2(x, record_property) def case3(send, record_property): record_property("case", 3) apdu = APDU( cla=0x00, ins=0x03, p1=0x00, p2=0x00, lc=send, data=range(send), le=0x00, send_le=0, ) if send >= 256: record_property("extended", True) else: record_property("extended", False) print(apdu) record_property("apdu", apdu) resp = reader.send_APDU(apdu) print(resp) record_property("resp", resp) assert resp.sw1 == 0x90 assert resp.sw2 == 0x00 assert resp.le == 0 if TEST_T0: @pytest.mark.parametrize("send", range(1, 300, STEP)) def test_case3_t0(mode_t0, select_applet, send, record_property): record_property("T", 0) case3(send, record_property) if TEST_T1: @pytest.mark.parametrize("send", range(1, 300, STEP)) def test_case3_t1(mode_t1, select_applet, send, record_property): record_property("T", 1) case3(send, record_property) def case4(send, recv, record_property): record_property("case", 4) ab = recv // 256 cd = recv % 256 send_le = 1 if recv < 256 else 2 apdu = APDU( cla=0x00, ins=0x04, p1=ab, p2=cd, lc=send, le=0, data=range(send), send_le=send_le, ) if send >= 256 or recv >= 256: record_property("extended", True) else: record_property("extended", False) print(apdu) record_property("apdu", apdu) resp = reader.send_APDU(apdu) print(resp) record_property("resp", resp) assert resp.sw1 == 0x90 assert resp.sw2 == 0x00 assert resp.le == recv if TEST_T0: @pytest.mark.parametrize("send", range(1, 300, STEP)) @pytest.mark.parametrize("recv", range(1, 300, STEP)) def test_case4_t0(mode_t0, select_applet, send, recv, record_property): record_property("T", 0) case4(send, recv, record_property) if TEST_T1: @pytest.mark.parametrize("send", range(1, 300, STEP)) @pytest.mark.parametrize("recv", range(1, 300, STEP)) def test_case4_t1(mode_t1, select_applet, send, recv, record_property): record_property("T", 1) case4(send, recv, record_property) def main(output_file="output.csv"): args = [ sys.argv[0], "--csv", output_file, "--csv-columns", "module,doc,success,parameters_as_columns,properties_as_columns", ] pytest.main(args) if __name__ == "__main__": main(args.output_file) smartleia-1.0.1/tests/000077500000000000000000000000001402634370300146365ustar00rootroot00000000000000smartleia-1.0.1/tests/__init__.py000066400000000000000000000000001402634370300167350ustar00rootroot00000000000000smartleia-1.0.1/tests/test_smartleia.py000066400000000000000000000001321402634370300202240ustar00rootroot00000000000000from smartleia import __version__ def test_version(): assert __version__ == "1.0.1"