pyecsca [pɪɛtska]

https://img.shields.io/badge/-Github-brightgreen?style=flat&logo=github https://img.shields.io/github/license/J08nY/pyecsca?color=brightgreen https://github.com/J08nY/pyecsca/workflows/Test/badge.svg https://github.com/J08nY/pyecsca/workflows/Lint/badge.svg https://img.shields.io/codecov/c/gh/J08nY/pyecsca?color=brightgreen&logo=codecov https://img.shields.io/static/v1?label=mypy&message=No%20issues&color=brightgreen https://deepsource.io/gh/J08nY/pyecsca.svg/?label=active+issues&show_trend=true

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 is currently in an alpha stage of development and thus only provides:
  • Enumeration of millions of possible ECC implementation configurations (see Configuration space)

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

  • Synthesis of C implementations of ECC for embedded devices, given any implementation configuration (see Code generation)

  • Trace acquisition using PicoScope/ChipWhisperer oscilloscopes (see Measurement)

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

  • Trace visualization using holoviews and datashader (see Visualization)

pyecsca consists of three packages:

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.

Requirements

pyecsca contains data from the Explicit-Formulas Database by Daniel J. Bernstein and Tanja Lange.

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.

License

MIT License

Copyright (c) 2018-2021 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.

Development is supported by the Masaryk University grant MUNI/C/1707/2018, this support is very appreciated.