eshard/scaredPython framework for performing side-channel analysis attacks (e.g., CPA) on public datasets, designed for educational use and hands-on practice in cryptographic hardware security.
scared is a side-channel analysis framework maintained by eShard team.
Scared need python 3.11, 3.12 or 3.13 and Numpy>=2
You can install scared, depending on your setup:
pipcondacondaYou just have to run:
conda install -c eshard scared
pipPython wheels are available from Pypi, just run:
pip install scared
To install from sources, you will need to run:
pip install .
from the source folder.
If you are planning to contribute, see CONTRIBUTING.md to install the library in development mode and run the test suite.
Start using scared by doing a cool thing:
# First import the lib
import scared
import numpy as np
# Define a selection function
@scared.attack_selection_function
def first_add_key(plaintext, guesses):
res = np.empty((plaintext.shape[0], len(guesses), plaintext.shape[1]), dtype='uint8')
for i, guess in enumerate(guesses):
res[:, i, :] = np.bitwise_xor(plaintext, guess)
return res
# Create an analysis CPA
a = scared.CPAAttack(
selection_function=first_add_key,
model=scared.HammingWeight(),
discriminant=scared.maxabs)
# Load some traces, for example a dpa v2 subset
ths = scared.traces.read_ths_from_ets_file('dpa_v2.ets')
# Create a container for your ths
container = scared.Container(ths)
# Run!
a.run(container)
To go further and learn all about scared, please go to the full documentation. You can also have an interactive introduction to scared by launching these notebooks with Binder.
All contributions, starting with feedbacks, are welcomed. Please read CONTRIBUTING.md if you wish to contribute to the project.
This library is licensed under LGPL V3 license. See the LICENSE file for details.
It is mainly intended for non-commercial use, by academics, students or professional willing to learn the basics of side-channel analysis.
If you wish to use this library in a commercial or industrial context, eShard provides commercial licenses under fees. Contact us!
See AUTHORS for the list of contributors to the project.
Binary builds (wheels on pypi and conda builds) are available for the following platforms and Python version.
Platforms:
Python version: