{"id":13818371,"url":"https://github.com/simple-crypto/SCALib","last_synced_at":"2025-05-15T23:31:53.094Z","repository":{"id":38240641,"uuid":"358496791","full_name":"simple-crypto/SCALib","owner":"simple-crypto","description":"Side-Channel Analysis Library","archived":false,"fork":false,"pushed_at":"2025-05-06T14:52:53.000Z","size":4132,"stargazers_count":88,"open_issues_count":11,"forks_count":23,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-05-14T03:45:55.481Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/simple-crypto.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":"CONTRIBUTING.rst","funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-04-16T06:20:50.000Z","updated_at":"2025-05-13T15:40:47.000Z","dependencies_parsed_at":"2024-01-05T00:18:17.193Z","dependency_job_id":"bf95e20e-c1a7-47ed-88ff-1e9720a16495","html_url":"https://github.com/simple-crypto/SCALib","commit_stats":{"total_commits":591,"total_committers":11,"mean_commits":53.72727272727273,"dds":0.5651438240270727,"last_synced_commit":"3c6b78e0b726f764cb8dc5f580abb7ab800c3f0f"},"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simple-crypto%2FSCALib","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simple-crypto%2FSCALib/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simple-crypto%2FSCALib/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simple-crypto%2FSCALib/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/simple-crypto","download_url":"https://codeload.github.com/simple-crypto/SCALib/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254104981,"owners_count":22015572,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-04T07:00:44.377Z","updated_at":"2025-05-15T23:31:53.067Z","avatar_url":"https://github.com/simple-crypto.png","language":"C++","funding_links":[],"categories":["Conference"],"sub_categories":[],"readme":"======\nSCALib\n======\n\n.. image:: https://badge.fury.io/py/scalib.svg\n    :target: https://pypi.org/project/scalib/\n    :alt: PyPI\n.. image:: https://readthedocs.org/projects/scalib/badge/?version=stable\n    :target: https://scalib.readthedocs.io/en/stable/\n    :alt: Documentation Status\n.. image:: https://img.shields.io/matrix/scalib:matrix.org\n    :target: https://matrix.to/#/#scalib:matrix.org\n    :alt: Matrix room\n.. image:: https://joss.theoj.org/papers/10.21105/joss.05196/status.svg\n   :target: https://doi.org/10.21105/joss.05196\n   :alt: JOSS paper\n\nThe Side-Channel Analysis Library (SCALib) is a Python library that\ncontains state-of-the-art tools for side-channel security evaluation.\n\n- **Documentation**: https://scalib.readthedocs.io/\n- **Examples**: `examples/ \u003cexamples/\u003e`_\n- **Chat**: `https://matrix.to/#/#scalib:matrix.org \u003chttps://matrix.to/#/#scalib:matrix.org\u003e`\n- **Source code**: https://github.com/simple-crypto/SCALib\n- **Bug reports/feature requests**: https://github.com/simple-crypto/SCALib/issues/new/choose\n- **Contributing**: https://scalib.readthedocs.io/en/stable/source/contributing.html\n\n\nSCALib focuses on\n\n- simple interface,\n- state-of-the art algorithms,\n- excellent performance (see `benchmarks \u003chttps://github.com/cassiersg/SCABench\u003e`_).\n\nSCALib should be useful for any side-channel practitioner who wants to\nevaluate, but not necessarily attack, protected or non-protected\nimplementations.\nSee the documentation_ for the list of implemented tools.\n\n.. _documentation: https://scalib.readthedocs.io/en/stable\n\nInstall\n=======\n\nSCALib is on PyPi! Simple install:\n\n.. code-block::\n\n    pip install scalib\n\nWe provide pre-built wheels for any recent python on Linux and Windows (x86).\nBe sure to use a **recent pip**.\nFor other plateforms, this will build SCALib (see below for dependencies).\n\nLocal build\n-----------\n\nTo get **best performance**, you want to build locally (this will optimize\nSCALib for your CPU).\n\n**Depdendencies:**\n\n- ``python \u003e= 3.10``,\n- a C/C++ compiler for your platform,\n- ``clang``,\n- the latest stable release of the `rust toolchain \u003chttps://rustup.rs/\u003e`_.\n\nTo install from source:\n\n.. code-block::\n\n    git clone https://github.com/simple-crypto/SCALib\n    pip install ./SCALib\n\nSee `CONTRIBUTING.rst \u003cCONTRIBUTING.rst\u003e`__ for advanced build configuration.\n\nUsage\n=====\n\nSee `API documentation \u003chttps://scalib.readthedocs.io/en/stable/#available-features\u003e`_,\n`example \u003chttps://github.com/simple-crypto/scalib/tree/main/examples\u003e`_ and\n`real-world usages \u003chttps://scalib.readthedocs.io/en/stable/#concrete-evaluations\u003e`_.\n\n\nAlternatives\n============\n\nIf your needs are not covered by SCALib, you might be more lucky with\n`lascar \u003chttps://github.com/Ledger-Donjon/lascar\u003e`_ or `scared \u003chttps://gitlab.com/eshard/scared\u003e`_.\n\nPlease also let us know your needs by opening a \n`feature request \u003chttps://github.com/simple-crypto/SCALib/issues/new?assignees=\u0026labels=\u0026template=feature_request.md\u0026title=\u003e`_.\n\nVersioning policy\n=================\n\nSCALib uses `semantic versioning \u003chttps://semver.org/\u003e`_, see the `CHANGELOG\n\u003cCHANGELOG.rst\u003e`_ for breaking changes and novelties.\n\nAbout us\n========\nSCALib was initiated by Olivier Bronchain and Gaëtan Cassiers during their PhD\nat UCLouvain. It is now developed as a project of\n`SIMPLE-Crypto \u003chttps://www.simple-crypto.dev/\u003e`_ and maintained by Gaëtan Cassiers (@cassiersg).\n\nContributions and Issues\n========================\n\nContributions welcome !\n\nPlease file a **bug report** for any issue you encounter (even bad documentation is\na bug !), and let us know your **suggestions** (open a `github issue\n\u003chttps://github.com/simple-crypto/SCALib/issues/new/choose\u003e`_, `chat\n\u003chttps://matrix.to/#/#scalib:matrix.org\u003e`_ and `email\n\u003cmailto:gaetan.cassiers@uclouvain.be\u003e`_ work too).\nWe also welcome code contributions, see `CONTRIBUTING.rst \u003cCONTRIBUTING.rst\u003e`_.\n\nYou can also come discuss on `matrix \u003chttps://matrix.to/#/#scalib:matrix.org\u003e`_\n(announcements, questions, community support, open discussion, etc.).\n\nAll code contributions are subject to the Contributor License Agreement (`CLA\n\u003chttps://www.simple-crypto.dev/organization\u003e`_) of SIMPLE-Crypto, which ensures\na thriving future for open-source hardware security.\n\n\nCitation\n========\n\nIf you use SCALib in your research, please cite our `software paper \u003chttps://doi.org/10.21105/joss.05196\u003e`_:\n\n.. code-block::\n\n    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\n\nBibtex:\n\n.. code-block::\n\n   @article{scalib,\n       doi = {10.21105/joss.05196},\n       url = {https://doi.org/10.21105/joss.05196},\n       year = {2023},\n       publisher = {The Open Journal},\n       volume = {8},\n       number = {86},\n       pages = {5196},\n       author = {Gaëtan Cassiers and Olivier Bronchain},\n       title = {SCALib: A Side-Channel Analysis Library}, journal = {Journal of Open Source Software}\n   }\n\n\nLicense\n=======\nThis project is licensed under GNU AFFERO GENERAL PUBLIC LICENSE, Version 3.\nSee `COPYRIGHT \u003cCOPYRIGHT\u003e`_ and `COPYING \u003cCOPYING\u003e`_ for more information.\n\nFor licensing-related matters, please contact info@simple-crypto.dev.\n\nAcknowledgements\n================\n\nThis work has been funded in part by the Belgian Fund for Scientific Research\n(F.R.S.-FNRS) through the Equipment Project SCALAB and individual researchers'\ngrants, by the European Union (EU) and the Walloon Region through the FEDER\nproject USERMedia (convention number 501907-379156), and by the European Union\n(EU) through the ERC project 724725 (acronym SWORD) and the ERC project\n101096871 (acronym BRIDGE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimple-crypto%2FSCALib","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimple-crypto%2FSCALib","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimple-crypto%2FSCALib/lists"}