pyecsca [pɪɛtska]

Python Elliptic Curve cryptography Side-Channel Analysis toolkit.

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

Enumeration of millions of possible ECC implementation configurations (see Configuration space)

Simulation

Simulation and execution tracing of key generation, ECDH and ECDSA (see Simulation)

Code generation

Synthesis of C implementations of ECC for embedded devices, given any implementation configuration (see Code generation), CPU-level emulation of implementations (see Emulation and leakage simulation)

Trace acquisition

Trace acquisition using PicoScope/ChipWhisperer oscilloscopes (see Measurement)

Trace processing

Trace processing capabilities, e.g. signal-processing, filtering, averaging, cutting, aligning (pyecsca.sca package)

Trace visualization

Trace visualization using holoviews and datashader (see Visualization)

Smartcard communication

Communication via PCSC/LEIA with a smartcard target (see Smartcards)

pyecsca consists of three repositories:

Core

The core package contains the core of the functionality, except the code generation and notebooks.

Codegen

The codegen package contains the code generation functionality.

Notebook

The notebook repository contains example notebooks that showcase functionality of the toolkit.

Notebooks

The notebooks below contain a showcase of what is possible using pyecsca and are the best source of documentation on how to use pyecsca.

Notebooks

• Configuration space
• Simulation
• Code generation
• Emulation and leakage simulation
• Measurement
• Visualization
• Smartcards
• Exploration of formulas in open-source ECC libraries
• RPA-based reverse-engineering
• ZVP-based reverse-engineering
• EPA-based reverse engineering

API reference

API reference

• pyecsca.ec package
  • pyecsca.ec.formula package
    • pyecsca.ec.formula.base module
    • pyecsca.ec.formula.code module
    • pyecsca.ec.formula.efd module
    • pyecsca.ec.formula.expand module
    • pyecsca.ec.formula.fake module
    • pyecsca.ec.formula.fliparoo module
    • pyecsca.ec.formula.graph module
    • pyecsca.ec.formula.metrics module
    • pyecsca.ec.formula.partitions module
    • pyecsca.ec.formula.switch_sign module
    • pyecsca.ec.formula.unroll module
  • pyecsca.ec.mult package
    • pyecsca.ec.mult.base module
    • pyecsca.ec.mult.binary module
    • pyecsca.ec.mult.comb module
    • pyecsca.ec.mult.fixed module
    • pyecsca.ec.mult.ladder module
    • pyecsca.ec.mult.naf module
    • pyecsca.ec.mult.window module
  • pyecsca.ec.configuration module
  • pyecsca.ec.context module
  • pyecsca.ec.coordinates module
  • pyecsca.ec.curve module
  • pyecsca.ec.divpoly module
  • pyecsca.ec.error module
  • pyecsca.ec.key_agreement module
  • pyecsca.ec.key_generation module
  • pyecsca.ec.mod module
  • pyecsca.ec.model module
  • pyecsca.ec.op module
  • pyecsca.ec.params module
  • pyecsca.ec.point module
  • pyecsca.ec.scalar module
  • pyecsca.ec.signature module
  • pyecsca.ec.transformations module
• pyecsca.misc package
  • pyecsca.misc.cache module
  • pyecsca.misc.cfg module
  • pyecsca.misc.utils module
• pyecsca.sca package
  • pyecsca.sca.attack package
    • pyecsca.sca.attack.CPA module
    • pyecsca.sca.attack.DPA module
    • pyecsca.sca.attack.leakage_model module
  • pyecsca.sca.re package
    • pyecsca.sca.re.base module
    • pyecsca.sca.re.rpa module
    • pyecsca.sca.re.structural module
    • pyecsca.sca.re.tree module
    • pyecsca.sca.re.zvp module
  • pyecsca.sca.scope package
    • pyecsca.sca.scope.base module
    • pyecsca.sca.scope.chipwhisperer module
    • pyecsca.sca.scope.picoscope_alt module
    • pyecsca.sca.scope.picoscope_sdk module
  • pyecsca.sca.stacked_traces package
    • pyecsca.sca.stacked_traces.combine module
    • pyecsca.sca.stacked_traces.stacked_traces module
  • pyecsca.sca.target package
    • pyecsca.sca.target.ISO7816 module
    • pyecsca.sca.target.PCSC module
    • pyecsca.sca.target.base module
    • pyecsca.sca.target.binary module
    • pyecsca.sca.target.chipwhisperer module
    • pyecsca.sca.target.ectester module
    • pyecsca.sca.target.flash module
    • pyecsca.sca.target.leakage module
    • pyecsca.sca.target.leia module
    • pyecsca.sca.target.serial module
    • pyecsca.sca.target.simpleserial module
  • pyecsca.sca.trace package
    • pyecsca.sca.trace.align module
    • pyecsca.sca.trace.combine module
    • pyecsca.sca.trace.edit module
    • pyecsca.sca.trace.filter module
    • pyecsca.sca.trace.match module
    • pyecsca.sca.trace.plot module
    • pyecsca.sca.trace.process module
    • pyecsca.sca.trace.sampling module
    • pyecsca.sca.trace.test module
    • pyecsca.sca.trace.trace module
  • pyecsca.sca.trace_set package
    • pyecsca.sca.trace_set.base module
    • pyecsca.sca.trace_set.chipwhisperer module
    • pyecsca.sca.trace_set.hdf5 module
    • pyecsca.sca.trace_set.inspector module
    • pyecsca.sca.trace_set.pickle module
• pyecsca.codegen package
  • pyecsca.codegen.templates package
  • pyecsca.codegen.builder module
  • pyecsca.codegen.client module
  • pyecsca.codegen.common module
  • pyecsca.codegen.render module

Miscellaneous

Miscellaneous

• ECC in Libraries
• References

Requirements

General

• 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:

    • leia

  • 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

• black

Docs

• sphinx

• sphinx-autodoc-typehints

• nbsphinx

• sphinx-paramlinks

• sphinx-design

License

MIT 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/1707/2018.