Skip to main content

eshard scared Python library.

Project description

SCAred

pipeline status PyPI version Conda installer Latest Conda release

scared is a side-channel analysis framework maintained by eShard team.

Getting started

Requirements

Scared need python 3.7, 3.8, 3.9 or 3.10.

You can install scared, depending on your setup:

  • from source
  • with pip
  • with conda

Install with conda

You just have to run:

conda install -c eshard scared

Install with pip

Python wheels are available from Pypi, just run:

pip install scared

Install from sources

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.

Make a first cool thing

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)

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scared-1.1.8.tar.gz (117.2 kB view details)

Uploaded Source

Built Distribution

scared-1.1.8-py3-none-any.whl (86.4 kB view details)

Uploaded Python 3

File details

Details for the file scared-1.1.8.tar.gz.

File metadata

  • Download URL: scared-1.1.8.tar.gz
  • Upload date:
  • Size: 117.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for scared-1.1.8.tar.gz
Algorithm Hash digest
SHA256 434071a45b7b05f33585dabd8c91350082f627e793d0e197c32a91800b30f211
MD5 228122bfa1da08e0945f220d35643805
BLAKE2b-256 da635794094e7c80319dd394dc3e6b5132dd0efb71b6f862a3ff7ebf286f2a82

See more details on using hashes here.

File details

Details for the file scared-1.1.8-py3-none-any.whl.

File metadata

  • Download URL: scared-1.1.8-py3-none-any.whl
  • Upload date:
  • Size: 86.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for scared-1.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 c1be37cd86b2fd7fd93f39187375d616253ef77357db8252416634620eb4abe1
MD5 848e66e534f947b130d05dc232b9497d
BLAKE2b-256 90ef9db766250859f2e6dd9322c951ec2fff0637accf001c0f4a7a315a3fe049

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page