Python Elliptic Curve cryptography Side-Channel Analysis toolkit.

For more info, see the .

Functionality

pyecsca aims to fill a gap in SCA tooling for Elliptic Curve Cryptography, it focuses on black-box implementations of ECC and presents a way to extract implementation information about a black-box implementation of ECC through side-channels. The main goal of pyecsca is to be able to reverse engineer the curve model, coordinate system, addition formulas, scalar multiplier and even finite-field implementation details.

It currently provides:

• Enumeration of millions of possible ECC implementation configurations (see notebook/configuration_space)
• Simulation and execution tracing of key generation, ECDH and ECDSA (see notebook/simulation)
• Synthesis of C implementations of ECC for embedded devices, given any implementation configuration (see notebook/codegen), CPU-level simulation of implementations (see notebook/simulator)
• Trace acquisition using PicoScope/ChipWhisperer oscilloscopes (see notebook/measurement)
• Trace processing capabilities, e.g. signal-processing, filtering, averaging, cutting, aligning (pyecsca.sca)
• Trace visualization using holoviews and datashader (see notebook/visualization)
• Communication via PCSC/LEIA with a smartcard target (see notebook/smartcards)

pyecsca consists of three packages:

• the core: https://github.com/J08nY/pyecsca
• the codegen package: https://github.com/J08nY/pyecsca-codegen
• the notebook package: https://github.com/J08nY/pyecsca-notebook

Requirements

• Numpy
• Scipy
• sympy
• pandas
• atpublic
• fastdtw
• asn1crypto
• h5py
• holoviews
• bokeh
• datashader
• matplotlib
• xarray
• astunparse
• numba
• Optionally:
  • Oscilloscope support:
    • picosdk
    • picoscope
    • chipwhisperer
  • Smartcard support:
    • pyscard
  • LEIA support:
    • smartleia
  • Faster arithmetic:
    • gmpy2 (and also GMP library)
    • cypari2 (and also PARI library)

pyecsca contains data from the Explicit-Formulas Database by Daniel J. Bernstein and Tanja Lange. The data was partially changed, to make working with it easier. It is available on Github at crocs-muni/efd.

It uses ChipWhisperer as one of its targets. It also supports working with Riscure Inspector trace sets, which are of a proprietary format.

Testing & Development

See the Makefile for tests, performance measurement, codestyle and type checking commands. Use black for code-formatting.

• pytest
• mypy
• flake8
• coverage
• interrogate
• pyinstrument
• pre-commit at .pre-commit-config.yaml
• black

Docs

• sphinx
• sphinx-autodoc-typehints
• nbsphinx
• sphinx-paramlinks
• sphinx-design

License

MIT License

Copyright (c) 2018-2024 Jan Jancar

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.

Thanks alot to contributors: Tomas Jusko, Andrej Batora, Vojtech Suchanek and to ChipWhisperer/NewAE.

Development was supported by the Masaryk University grant MUNI/C/1701/2018.