scared 0.8.8

scared is a side-channel analysis framework.

SCAred

scared is a side-channel analysis framework.

Getting started

Requirements

Scared need python 3.6, 3.7 or 3.8.

You can install scared, depending on your setup:

• from source
• with pip
• with conda

At time of writing, we highly recommend to install scared with conda if you want to use it with python 3.8

Install with conda

Conda builds are available for linux-x64 and osx-64 platforms. If your system isn't yet supported, build contributions are welcome!).

You just have to run:

conda install -c eshard scared

Install with pip

Binary builds are available from Pypi for most Linux platforms and OS X. If your environment has a binary build available, just run:

pip install scared

If no wheel is available for your setup, you'll also need:

• setuptools 0.40 or greater (just run pip install -U pip setuptools)
• a C compiler to compile C extension
• for Python 3.8 only, a llvmlite working installation (see install from source documentation)

and then run pip install scared.

Install from source

To install from source, you will need:

• setuptools 0.40 or greater (just run pip install -U pip setuptools)
• a C compiler to compile C extension
• for Python 3.8 only, a llvmlite working installation (see install from source documentation, or install it with conda)

You 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.

Make a first cool thing

Start using scared by doing a cool thing:

# First import the lib
import scared

# 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('dpa_v2.ets')

# Create a container for your ths
container = scared.Container(ths)

# Run!
a.run(container)

Documentation

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.

Contributing

All contributions, starting with feedbacks, are welcomed. Please read CONTRIBUTING.md if you wish to contribute to the project.

License

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!

Authors

See AUTHORS for the list of contributors to the project.

Binary builds available

Binary builds (wheels on pypi and conda builds) are available for the following platforms and Python version.

Platforms:

• Linux x86 64
• Macosx x86 64

Python version:

• 3.6
• 3.7
• 3.8 from conda, or buy building from sources.