aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJ08nY2023-10-02 18:34:54 +0200
committerJ08nY2023-10-02 18:41:48 +0200
commitb02be86f1e3dc1add26aded8f2ffc3350917d6fb (patch)
tree6aceeed000a83de98275215a7db2dc5d0ae87e05
parentd59c701bc9a69491d43a3262c4d435946a063d89 (diff)
downloadpyecsca-b02be86f1e3dc1add26aded8f2ffc3350917d6fb.tar.gz
pyecsca-b02be86f1e3dc1add26aded8f2ffc3350917d6fb.tar.zst
pyecsca-b02be86f1e3dc1add26aded8f2ffc3350917d6fb.zip
-rw-r--r--README.md11
-rw-r--r--docs/index.rst16
-rw-r--r--pyproject.toml3
3 files changed, 17 insertions, 13 deletions
diff --git a/README.md b/README.md
index c774280..473790c 100644
--- a/README.md
+++ b/README.md
@@ -59,19 +59,18 @@ It is currently in an alpha stage of development and thus only provides:
*pyecsca* contains data from the [Explicit-Formulas Database](https://www.hyperelliptic.org/EFD/index.html) by Daniel J. Bernstein and Tanja Lange.
-The data was partially changed, to make working with it easier.
+The data was partially changed, to make working with it easier. It is available on Github at [crocs-muni/efd](https://github.com/crocs-muni/efd).
-It also supports working with [Riscure](https://www.riscure.com) Inspector trace sets, which are of a proprietary format.
+It uses [ChipWhisperer](https://chipwhisperer.com) as one of its targets. It also supports working with [Riscure](https://www.riscure.com) Inspector
+trace sets, which are of a proprietary format.
### Testing & Development
See the [Makefile](Makefile) for tests, performance measurement, codestyle and type checking commands.
Use [black](https://github.com/psf/black) for code-formatting.
- - [nose2](https://nose2.readthedocs.io)
- - [green](https://github.com/CleanCut/green)
+ - [pytest](https://pytest.org)
- [mypy](http://mypy-lang.org/)
- - [parameterized](https://github.com/wolever/parameterized)
- [flake8](https://flake8.pycqa.org/)
- [coverage](https://coverage.readthedocs.io/)
- [interrogate](https://interrogate.readthedocs.io/)
@@ -112,5 +111,7 @@ Use [black](https://github.com/psf/black) for code-formatting.
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+Thanks alot to contributors: Tomas Jusko, Andrej Batora, Vojtech Suchanek and
+to ChipWhisperer/NewAE.
*Development was supported by the Masaryk University grant [MUNI/C/1701/2018](https://www.muni.cz/en/research/projects/46834).*
diff --git a/docs/index.rst b/docs/index.rst
index ac46e02..e3448a5 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -154,8 +154,9 @@ Requirements
- gmpy2_ (and also GMP library)
*pyecsca* contains data from the `Explicit-Formulas Database`_ by Daniel J. Bernstein and Tanja Lange.
+ The data was partially changed, to make working with it easier. It is available on Github at `crocs-muni/efd`_.
- It also supports working with Riscure_ Inspector trace sets, which are of a proprietary format.
+ It uses `ChipWhisperer`_ as one of its targets. It also supports working with Riscure_ Inspector trace sets, which are of a proprietary format.
.. dropdown:: Testing & Development
@@ -163,9 +164,7 @@ Requirements
See the Makefile for tests, performance measurement, codestyle and type checking commands.
Use black_ for code-formatting.
- - nose2_
- - green_
- - parameterized_
+ - pytest_
- mypy_
- flake8_
- coverage_
@@ -210,6 +209,9 @@ License
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+Thanks alot to contributors: Tomas Jusko, Andrej Batora, Vojtech Suchanek and
+to ChipWhisperer/NewAE.
+
Development was supported by the Masaryk University grant `MUNI/C/1707/2018 <https://www.muni.cz/en/research/projects/46834>`_.
.. _Numpy: https://www.numpy.org
@@ -232,9 +234,7 @@ Development was supported by the Masaryk University grant `MUNI/C/1707/2018 <htt
.. _pyscard: https://pyscard.sourceforge.io/
.. _leia: https://pypi.org/project/smartleia/
.. _gmpy2: https://gmpy2.readthedocs.io/
-.. _nose2: https://nose2.readthedocs.io
-.. _green: https://github.com/CleanCut/green
-.. _parameterized: https://github.com/wolever/parameterized
+.. _pytest: https://pytest.org
.. _mypy: http://mypy-lang.org/
.. _flake8: https://flake8.pycqa.org/
.. _coverage: https://coverage.readthedocs.io/
@@ -248,4 +248,6 @@ Development was supported by the Masaryk University grant `MUNI/C/1707/2018 <htt
.. _sphinx-paramlinks: https://pypi.org/project/sphinx-paramlinks/
.. _sphinx-design: https://pypi.org/project/sphinx_design/
.. _Explicit-Formulas Database: https://www.hyperelliptic.org/EFD/index.html
+.. _crocs-muni/efd: https://github.com/crocs-muni/efd
+.. _ChipWhisperer: https://chipwhisperer.com
.. _Riscure: https://www.riscure.com/
diff --git a/pyproject.toml b/pyproject.toml
index 4a056c9..b95284c 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -8,7 +8,8 @@
authors = [
{ name = "Jan Jancar", email = "johny@neuromancer.sk" },
{ name = "Tomas Jusko" },
- { name = "Andrej Batora"}
+ { name = "Andrej Batora" },
+ { name = "Vojtech Suchanek" }
]
description = "Python Elliptic Curve cryptography Side Channel Analysis toolkit."
readme = "README.md"