Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Merkle-tree cryptographic library for generation and validation of Proofs

Project description

pymerkle: Merkle-tree cryptographic library for generation and validation of Proofs

Build Status codecov Docs Status PyPI version Python >= 3.6

Complete documentation found at pymerkle.readthedocs.org

Merkle-trees employ cryptography to efficiently preserve data consistency across peer-to-peer networks and distributed systems.

Pymerkle provides a class for binary balanced Merkle-trees (with possibly odd number of leaves), capable of generating Merkle-proofs (audit and consistency proofs) along with performing inclusion-tests. It supports almost all combinations of hash functions (including SHA3 variations) and encoding types, with defense against second-preimage attack by default enabled. It further provides flexible mechanisms, allowing for leveraged validation of existence and integrity of encrypted data.

It is a zero dependency library (with the inessential exception of tqdm for displaying progress bars).

Installation

pip3 install pymerkle

Usage

See Usage

Security

Enhanced security of the present implementation relies on the tree's topology as well as the standard refinement of the encoding process.

Defense against second-preimage attack

Defense against second-preimage attack consists in the following security measures:

  • Before computing the hash of a leaf, prepend the corresponding record with 0x00

  • Before computing the hash of any interior node, prepend both of its parents' hashes with 0x01

Refer to test_security.py to see how to perform second-preimage attacks against the present implementation. In order to disable defense (say, for testing purposes), set security equal to False at construction.

Defense against denial-of-service attacks

In contrast to the bitcoin specification for Merkle-trees, lonely leaves are not duplicated in order for the tree to remain binary. Instead, creating bifurcation nodes at the rightmost branch allows the tree to remain both binary and balanced upon any update (see Tree structure below). As a consequence, the present implementation is structurally invulnerable to denial-of-service attacks exploiting the vulnerability described here (reported as CVE-2012-2459).

Tree structure

Contrary to other implementations, the present Merkle-tree remains always binary balanced, with all nodes except for the exterior ones (leaves) having two parents. This is attained as follows: upon appending a block of new leaves, instead of promoting a lonely leaf to the next level or duplicating it, a bifurcation node is created so that trees with the same number of leaves have identical structure independently of their growing strategy. This standardization is further crucial for:

  • fast generation of consistency proofs (based on additive decompositions in decreasing powers of 2)
  • fast recalculation of the root-hash after appending a new leaf, since only the hashes at the tree's right-most branch need be recalculated
  • storage efficiency, since the height as well as total number of nodes with respect to the tree's length is constrained to the minimum.

The topology turns out to be identical with that of a binary Sekura tree, depicted in Section 5.4 of this paper. Follow the straightforward algorithm of the .update method for further insight.

Note: Due to the binary balanced structure of the present implementation, the consistency proof algorithm significantly deviates from that exposed in RFC 6912.

Validation

Validation of a Merkle-proof presupposes correct configuration of the client’s hashing machinery, so that the latter coincides with that of the server. In the nomenclature of the present implementation, this amounts to knowledge of the tree’s hash algorithm, encoding type, raw-bytes mode and security mode, which are inscribed in the header of any proof. The client’s machinery is automatically configured from these parameters by just feeding the proof into any of the available validation mechanisms.

Proof validation is agnostic of whether a Merkle-proof has been the result of an audit or a consistency proof request. Audit proofs and consistency proofs share identical structure, so that both kinds are instances of the same class.

Development

pip install -r dev-requirements.txt

Tests

You need to have installed pytest. From inside the project's root directory type

./runtests

to run all tests against the limited set of encoding types UTF-8, UTF-16 and UTF-32 (108 combinations in total). To run tests against all possible hash types, encoding types, raw-bytes modes and security modes (3240 combinations in total), run

./runtests --extended

Benchmarks

python benchmarks

from inside the project's root directory.

Documentation

Run

./dev/build-docs

from inside the projects root dir to build the documentation (found at ./docs/build/index.html)

License: GPLv3+

This is free software and you are welcome to redistribute it.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

See LICENSE for more details.

Project details


Download files

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

Files for pymerkle, version 2.0.2
Filename, size File type Python version Upload date Hashes
Filename, size pymerkle-2.0.2-py3-none-any.whl (92.3 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size pymerkle-2.0.2.tar.gz (44.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page