SCALib

SCALib: A Side-Channel Analysis Library - Published in JOSS (2023)

https://github.com/simple-crypto/scalib

Science Score: 100.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 11 DOI reference(s) in README and JOSS metadata
✓
Academic publication links
Links to: joss.theoj.org
✓
Committers with academic emails
1 of 11 committers (9.1%) from academic institutions
○
Institutional organization owner
✓
JOSS paper metadata
Published in Journal of Open Source Software

Scientific Fields

Artificial Intelligence and Machine Learning Computer Science - 83% confidence

Last synced: 4 months ago · JSON representation ·

Repository

Side-Channel Analysis Library

Basic Info

Host: GitHub
Owner: simple-crypto
License: agpl-3.0
Language: C++
Default Branch: main
Size: 4.03 MB

Statistics

Stars: 96
Watchers: 7
Forks: 24
Open Issues: 12
Releases: 27

Created over 4 years ago · Last pushed 5 months ago

Metadata Files

Readme Changelog Contributing License Citation

README.rst

======
SCALib
======

.. image:: https://badge.fury.io/py/scalib.svg
    :target: https://pypi.org/project/scalib/
    :alt: PyPI
.. image:: https://readthedocs.org/projects/scalib/badge/?version=stable
    :target: https://scalib.readthedocs.io/en/stable/
    :alt: Documentation Status
.. image:: https://img.shields.io/matrix/scalib:matrix.org
    :target: https://matrix.to/#/#scalib:matrix.org
    :alt: Matrix room
.. image:: https://joss.theoj.org/papers/10.21105/joss.05196/status.svg
   :target: https://doi.org/10.21105/joss.05196
   :alt: JOSS paper

The Side-Channel Analysis Library (SCALib) is a Python library that
contains state-of-the-art tools for side-channel security evaluation.

- **Documentation**: https://scalib.readthedocs.io/
- **Examples**: `examples/ `_
- **Chat**: `https://matrix.to/#/#scalib:matrix.org `
- **Source code**: https://github.com/simple-crypto/SCALib
- **Bug reports/feature requests**: https://github.com/simple-crypto/SCALib/issues/new/choose
- **Contributing**: https://scalib.readthedocs.io/en/stable/source/contributing.html


SCALib focuses on

- simple interface,
- state-of-the art algorithms,
- excellent performance (see `benchmarks `_).

SCALib should be useful for any side-channel practitioner who wants to
evaluate, but not necessarily attack, protected or non-protected
implementations.
See the documentation_ for the list of implemented tools.

.. _documentation: https://scalib.readthedocs.io/en/stable

Install
=======

SCALib is on PyPi! Simple install:

.. code-block::

    pip install scalib

We provide pre-built wheels for any recent python on Linux and Windows (x86).
Be sure to use a **recent pip**.
For other plateforms, this will build SCALib (see below for dependencies).

Local build
-----------

To get **best performance**, you want to build locally (this will optimize
SCALib for your CPU).

**Depdendencies:**

- ``python >= 3.10``,
- a C/C++ compiler for your platform,
- ``clang``,
- the latest stable release of the `rust toolchain `_.

To install from source:

.. code-block::

    git clone https://github.com/simple-crypto/SCALib
    pip install ./SCALib

See `CONTRIBUTING.rst `__ for advanced build configuration.

Usage
=====

See `API documentation `_,
`example `_ and
`real-world usages `_.


Alternatives
============

If your needs are not covered by SCALib, you might be more lucky with
`lascar `_ or `scared `_.

Please also let us know your needs by opening a 
`feature request `_.

Versioning policy
=================

SCALib uses `semantic versioning `_, see the `CHANGELOG
`_ for breaking changes and novelties.

About us
========
SCALib was initiated by Olivier Bronchain and Gaëtan Cassiers during their PhD
at UCLouvain. It is now developed as a project of
`SIMPLE-Crypto `_ and maintained by Gaëtan Cassiers (@cassiersg).

Contributions and Issues
========================

Contributions welcome !

Please file a **bug report** for any issue you encounter (even bad documentation is
a bug !), and let us know your **suggestions** (open a `github issue
`_, `chat
`_ and `email
`_ work too).
We also welcome code contributions, see `CONTRIBUTING.rst `_.

You can also come discuss on `matrix `_
(announcements, questions, community support, open discussion, etc.).

All code contributions are subject to the Contributor License Agreement (`CLA
`_) of SIMPLE-Crypto, which ensures
a thriving future for open-source hardware security.


Citation
========

If you use SCALib in your research, please cite our `software paper `_:

.. code-block::

    Cassiers et al., (2023). SCALib: A Side-Channel Analysis Library. Journal of Open Source Software, 8(86), 5196, https://doi.org/10.21105/joss.05196

Bibtex:

.. code-block::

   @article{scalib,
       doi = {10.21105/joss.05196},
       url = {https://doi.org/10.21105/joss.05196},
       year = {2023},
       publisher = {The Open Journal},
       volume = {8},
       number = {86},
       pages = {5196},
       author = {Gaëtan Cassiers and Olivier Bronchain},
       title = {SCALib: A Side-Channel Analysis Library}, journal = {Journal of Open Source Software}
   }


License
=======
This project is licensed under GNU AFFERO GENERAL PUBLIC LICENSE, Version 3.
See `COPYRIGHT `_ and `COPYING `_ for more information.

For licensing-related matters, please contact info@simple-crypto.dev.

Acknowledgements
================

This work has been funded in part by the Belgian Fund for Scientific Research
(F.R.S.-FNRS) through the Equipment Project SCALAB and individual researchers'
grants, by the European Union (EU) and the Walloon Region through the FEDER
project USERMedia (convention number 501907-379156), and by the European Union
(EU) through the ERC project 724725 (acronym SWORD) and the ERC project
101096871 (acronym BRIDGE).

Owner

Name: simple-crypto
Login: simple-crypto
Kind: organization

Website: https://www.simple-crypto.org
Repositories: 1
Profile: https://github.com/simple-crypto

JOSS Publication

SCALib: A Side-Channel Analysis Library

Published

June 01, 2023

DOI

10.21105/joss.05196

Volume 8, Issue 86, Page 5196

Authors

Gaëtan Cassiers

TU Graz, Austria, UCLouvain, Belgium

Olivier Bronchain

UCLouvain, Belgium

Editor

Nikoleta Glynatsi

Citation (CITATION.cff)

cff-version: "1.2.0"
authors:
- family-names: Cassiers
  given-names: Gaëtan
  orcid: "https://orcid.org/0000-0001-5426-9345"
- family-names: Bronchain
  given-names: Olivier
  orcid: "https://orcid.org/0000-0001-7595-718X"
contact:
- family-names: Cassiers
  given-names: Gaëtan
  orcid: "https://orcid.org/0000-0001-5426-9345"
doi: 10.5281/zenodo.7985686
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Cassiers
    given-names: Gaëtan
    orcid: "https://orcid.org/0000-0001-5426-9345"
  - family-names: Bronchain
    given-names: Olivier
    orcid: "https://orcid.org/0000-0001-7595-718X"
  date-published: 2023-06-01
  doi: 10.21105/joss.05196
  issn: 2475-9066
  issue: 86
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 5196
  title: "SCALib: A Side-Channel Analysis Library"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.05196"
  volume: 8
title: "SCALib: A Side-Channel Analysis Library"

GitHub Events

Total

Create event: 20
Release event: 6
Issues event: 8
Watch event: 19
Delete event: 19
Issue comment event: 14
Push event: 139
Pull request review event: 10
Pull request review comment event: 9
Pull request event: 37
Fork event: 4

Last Year

Create event: 20
Release event: 6
Issues event: 8
Watch event: 19
Delete event: 19
Issue comment event: 14
Push event: 139
Pull request review event: 10
Pull request review comment event: 9
Pull request event: 37
Fork event: 4

Committers

Last synced: 5 months ago

All Time

Total Commits: 783
Total Committers: 11
Avg Commits per committer: 71.182
Development Distribution Score (DDS): 0.586

Past Year

Commits: 131
Committers: 3
Avg Commits per committer: 43.667
Development Distribution Score (DDS): 0.366

Top Committers

Name	Email	Commits
Gaëtan Cassiers	g**s@u**e	324
obronchain	o**n@u**e	285
Gaëtan Cassiers	g**s@i**t	105
cmomin	c**n@u**e	49
Rishub	6****n	12
JulienBeg	5****g	2
Daniel S. Katz	d**z@i**g	2
yann-a	y**n@a**e	1
Loïc Masure	l**e@h**r	1
Bela Lemle	b**2@g**m	1
Balazs Udvarhelyi	b**i@u**e	1

Committer Domains (Top 20 + Academic)

uclouvain.be: 4 aguettaz.me: 1 ieee.org: 1 iaik.tugraz.at: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 56
Total pull requests: 157
Average time to close issues: 4 months
Average time to close pull requests: 14 days
Total issue authors: 16
Total pull request authors: 9
Average comments per issue: 0.98
Average comments per pull request: 0.54
Merged pull requests: 137
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 6
Pull requests: 43
Average time to close issues: about 1 month
Average time to close pull requests: 3 days
Issue authors: 4
Pull request authors: 3
Average comments per issue: 0.5
Average comments per pull request: 0.56
Merged pull requests: 36
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

cassiersg (29)
rishubn (5)
F-Lehmann (4)
JulienBeg (3)
cmomin (2)
Bbalon-a (2)
obronchain (1)
yann-a (1)
LoicMasure (1)
Stian108 (1)
ThorbenMoos (1)
Tilaxx (1)
Cook-hue (1)
j4k0xb (1)
vvasseur (1)

Pull Request Authors

cassiersg (129)
rishubn (22)
cmomin (12)
obronchain (6)
JulienBeg (4)
F-Lehmann (3)
LoicMasure (2)
lemleb (2)
danielskatz (2)

Top Labels

Issue Labels

enhancement (16) good first issue (5) bug (5) help wanted (2) wontfix (2) question (2) documentation (2) new tool (1) postponed (1)

Pull Request Labels

cla-signed (109)

Packages

Total packages: 1
Total downloads:
- pypi 346 last-month

Total dependent packages: 0
Total dependent repositories: 1
Total versions: 27
Total maintainers: 2

pypi.org: scalib

Side-Channel Analysis Library

Homepage: https://github.com/simple-crypto/SCALib
Documentation: https://https://scalib.readthedocs.io/
License: GNU AGPL 3.0
Latest release: 0.6.4
published 7 months ago

Versions: 27
Dependent Packages: 0
Dependent Repositories: 1
Downloads: 346 Last month

Rankings

Stargazers count: 9.0%

Forks count: 9.3%

Dependent packages count: 10.1%

Average: 13.3%

Downloads: 16.3%

Dependent repos count: 21.6%

Maintainers (2)

cassiersg cmomin

Last synced: 4 months ago

Dependencies

src/scalib_ext/Cargo.lock cargo

169 dependencies

src/scalib_ext/scalib/Cargo.toml cargo

criterion 0.3.4 development
ndarray-rand 0.14.0 development
approx 0.4.0
blis-src 0.2.1-alpha.0
crossbeam-utils 0.8.3
hytra 0.1.2
indicatif 0.16.2
itertools 0.10.0
lapacke 0.3.0
lazy_static 1.4.0
matrixmultiply 0.3.1
nalgebra 0.26.1
ndarray 0.15.1
ndarray-stats 0.5.0
num-complex 0.4.0
num-integer 0.1.42
num-traits 0.2.15
numpy 0.13.0
pyo3 0.13.2
rayon 1.5.0
realfft 2.0.1
rustfft 6.0.0

docs/requirements.txt pypi

cpufeature *
ipython >=7.16.0
matplotlib >=3.3.0
numpydoc >=1.1.0
pydata-sphinx-theme >=0.5.2
setuptools-rust >=0.12.1
setuptools_scm >=3.4.3
sphinx >=3.5.3

.github/workflows/ci.yml actions

actions/cache v3 composite
actions/checkout v3 composite
actions/download-artifact v3 composite
actions/setup-python v3 composite
actions/upload-artifact v3 composite
pypa/cibuildwheel v2.12.0 composite
pypa/gh-action-pypi-publish release/v1 composite
softprops/action-gh-release v1 composite

tests/requirements.txt pypi

pytest * test
pytest-cov * test
scikit-learn * test
scipy * test

src/scalib_ext/Cargo.toml cargo

src/scalib_ext/geigen/Cargo.toml cargo

ndarray-rand 0.14 development
rand_xoshiro 0.6 development
cxx 1.0
ndarray 0.15
thiserror 1.0

src/scalib_ext/ranklib/Cargo.toml cargo

src/scalib_ext/ranklib/fuzz/Cargo.toml cargo

src/scalib_ext/scalib-py/Cargo.toml cargo

pyproject.toml pypi

setup.py pypi

SCALib

Science Score: 100.0%

Scientific Fields

Repository

Basic Info

Statistics

Metadata Files

README.rst

Owner

JOSS Publication

SCALib: A Side-Channel Analysis Library

Authors

Editor

Tags

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: scalib

Rankings

Maintainers (2)

Dependencies