Skip to content

Commit

Permalink
Project update: encryption included
Browse files Browse the repository at this point in the history
  • Loading branch information
manel1874 committed Dec 5, 2023
1 parent e4e0821 commit 5db052a
Show file tree
Hide file tree
Showing 14 changed files with 340 additions and 287 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/lint-test-cover-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
- name: Lint and test module.
run: |
pip install -U .[lint,test]
# python -m pylint tecdsa # Check against linting rules.
# python -m pylint tinysig # Check against linting rules.
python -m pytest # Run tests.
- name: Publish coverage results.
run: |
Expand Down
36 changes: 16 additions & 20 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,42 +1,38 @@
=======
tecdsa
tinysig
=======

Pure-Python implementation of a `threshold ecdsa signature scheme <https://nillion.pub/sum-of-products-lsss-non-interactive.pdf>`__ based on a secure multi-party computation (MPC) `protocol for evaluating arithmetic sum-of-products expressions <https://nillion.pub/sum-of-products-lsss-non-interactive.pdf>`__ via a non-interactive computation phase.
Pure-Python implementation of a `threshold ecdsa signature scheme <https://nillion.pub/threshold-ecdsa-preprocessing-setup.pdf>`__ based on a secure multi-party computation (MPC) `protocol for evaluating arithmetic sum-of-products expressions <https://nillion.pub/sum-of-products-lsss-non-interactive.pdf>`__ via a non-interactive computation phase.

|pypi| |readthedocs| |actions| |coveralls|

.. |pypi| image:: https://badge.fury.io/py/tecdsa.svg
:target: https://badge.fury.io/py/tecdsa
.. |pypi| image:: https://badge.fury.io/py/tinysig.svg
:target: https://badge.fury.io/py/tinysig
:alt: PyPI version and link.

.. |readthedocs| image:: https://readthedocs.org/projects/tecdsa/badge/?version=latest
:target: https://tecdsa.readthedocs.io/en/latest/?badge=latest
.. |readthedocs| image:: https://readthedocs.org/projects/tinysig/badge/?version=latest
:target: https://tinysig.readthedocs.io/en/latest/?badge=latest
:alt: Read the Docs documentation status.

.. |actions| image:: https://github.com/nillion-oss/tecdsa/workflows/lint-test-cover-docs/badge.svg
:target: https://github.com/nillion-oss/tecdsa/actions/workflows/lint-test-cover-docs.yml
.. |actions| image:: https://github.com/nillion-oss/tinysig/workflows/lint-test-cover-docs/badge.svg
:target: https://github.com/nillion-oss/tinysig/actions/workflows/lint-test-cover-docs.yml
:alt: GitHub Actions status.

.. |coveralls| image:: https://coveralls.io/repos/github/nillion-oss/tecdsa/badge.svg?branch=main
:target: https://coveralls.io/github/nillion-oss/tecdsa?branch=main
:alt: Coveralls test coverage summary.

Installation and Usage
----------------------

This library is available as a `package on PyPI <https://pypi.org/project/tecdsa>`__:
This library is available as a `package on PyPI <https://pypi.org/project/tinysig>`__:

.. code-block:: bash
python -m pip install tecdsa
python -m pip install tinysig
The library can be imported in the usual way:

.. code-block:: python
import tecdsa
from tecdsa import *
import tinysig
from tinysig import *
Basic Example
^^^^^^^^^^^^^
Expand Down Expand Up @@ -72,7 +68,7 @@ After defining a message we can sign it as follows:

.. code-block:: python
>>> message = "Let me tell you a great secret about Nillion."
>>> message = "Let me tell you a secret about Nillion."
>>> ecnet.ts_online_protocol(message, client_id)
We run the following to print the signature owned by the client (ID=1):
Expand Down Expand Up @@ -115,19 +111,19 @@ Style conventions are enforced using `Pylint <https://pylint.readthedocs.io>`__:
.. code-block:: bash
python -m pip install .[lint]
python -m pylint src/tecdsa
python -m pylint src/tinysig
Contributions
^^^^^^^^^^^^^
In order to contribute to the source code, open an issue or submit a pull request on the `GitHub page <https://github.com/nillion-oss/tecdsa>`__ for this library.
In order to contribute to the source code, open an issue or submit a pull request on the `GitHub page <https://github.com/nillion-oss/tinysig>`__ for this library.

Versioning
^^^^^^^^^^
The version number format for this library and the changes to the library associated with version number increments conform with `Semantic Versioning 2.0.0 <https://semver.org/#semantic-versioning-200>`__.

Publishing
^^^^^^^^^^
This library can be published as a `package on PyPI <https://pypi.org/project/tecdsa>`__ by a package maintainer. First, install the dependencies required for packaging and publishing:
This library can be published as a `package on PyPI <https://pypi.org/project/tinysig>`__ by a package maintainer. First, install the dependencies required for packaging and publishing:

.. code-block:: bash
Expand Down
Loading

0 comments on commit 5db052a

Please sign in to comment.