Cross-platform Python CFFI bindings for libsecp256k1

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for Ofekmeister from gravatar.com Ofekmeister

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Ofek Lev
  • Tags secp256k1, elliptic curves, bitcoin, ethereum, cryptocurrency
Classifiers

Project description

https://img.shields.io/pypi/v/coincurve.svg?style=flat-square https://img.shields.io/travis/ofek/coincurve.svg?branch=master&style=flat-square https://img.shields.io/pypi/pyversions/coincurve.svg?style=flat-square https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square

This library provides well-tested Python CFFI bindings for libsecp256k1, the heavily optimized C library used by Bitcoin Core for operations on elliptic curve secp256k1.

Coincurve replaces secp256k1-py.

New features include:

  • Cleaner API

  • Uses newest version of libsecp256k1

  • Support for Windows

  • Linux, macOS, and Windows all have binary packages for both 64 and 32-bit architectures

  • Linux & macOS use GMP for faster computation

  • Endomorphism optimization is enabled

  • A global context is used by default, drastically increasing performance

  • Fixed ECDH

  • A fix to remove CFFI warnings

  • Implements a fix for https://bugs.python.org/issue28150 to support Python 3.6+ on macOS

Installation

Coincurve is distributed on PyPI and is available on Linux/macOS and Windows and supports Python 2.7/3.5+ and PyPy3.5-v5.7.1+.

$ pip install coincurve

If you are on a system that doesn’t have a precompiled binary wheel (e.g. FreeBSD) then pip will fetch source to build yourself. You must have the necessary packages.

On Debian/Ubuntu for example the necessary packages are:

  • build-essential

  • automake

  • pkg-config

  • libtool

  • libffi-dev

  • libgmp-dev

API

Coincurve provides a simple API.

coincurve.verify_signature

verify_signature(signature, message, public_key, hasher=sha256, context=GLOBAL_CONTEXT)

Verifies some message was signed by the owner of a public key.

  • Parameters:

    • signature (bytes) - The signature to verify.

    • message (bytes) - The message that was supposedly signed.

    • public_key (bytes) - A public key in compressed or uncompressed form.

    • hasher - The hash function to use. hasher(message) must return 32 bytes.

    • context (coincurve.Context)

  • Returns: bool

coincurve.PrivateKey

All instances have a public_key of type coincurve.PublicKey

PrivateKey(secret=None, context=GLOBAL_CONTEXT)

  • Parameters:

    • secret (bytes) - The secret to use.

    • context (coincurve.Context)

Methods

classmethod from_hex(hexed, context=GLOBAL_CONTEXT)

classmethod from_int(num, context=GLOBAL_CONTEXT)

classmethod from_pem(pem, context=GLOBAL_CONTEXT)

classmethod from_der(der, context=GLOBAL_CONTEXT)

sign(message, hasher=sha256)

  • Parameters:

    • message (bytes) - The message to sign.

    • hasher - The hash function to use. hasher(message) must return 32 bytes.

  • Returns: bytes. 71 <= len(signature) <= 72

sign_recoverable(message, hasher=sha256)

  • Parameters:

    • message (bytes) - The message to sign.

    • hasher - The hash function to use. hasher(message) must return 32 bytes.

  • Returns: bytes

ecdh(public_key)

Computes a Diffie-Hellman secret in constant time.

  • Parameters:

    • public_key (bytes) - Another party’s public key in compressed or uncompressed form.

  • Returns: bytes

add(scalar, update=False)

  • Parameters:

    • scalar (bytes) - The scalar to add.

    • update - If True, will update and return self.

  • Returns: coincurve.PrivateKey

multiply(scalar, update=False)

  • Parameters:

    • scalar (bytes) - The scalar to multiply.

    • update - If True, will update and return self.

  • Returns: coincurve.PrivateKey

to_hex()

to_int()

to_pem()

to_der()

coincurve.PublicKey

PublicKey(data, context=GLOBAL_CONTEXT)

  • Parameters:

    • data (bytes) - The public key in compressed or uncompressed form.

    • context (coincurve.Context)

Methods

classmethod from_secret(secret, context=GLOBAL_CONTEXT)

classmethod from_valid_secret(secret, context=GLOBAL_CONTEXT)

classmethod from_point(x, y, context=GLOBAL_CONTEXT)

classmethod from_signature_and_message(serialized_sig, message, hasher=sha256, context=GLOBAL_CONTEXT)

format(compressed=True)

  • Parameters:

    • compressed (bool)

  • Returns: The public key serialized to bytes.

point()

  • Returns: (x, y)

verify(signature, message, hasher=sha256)

Verifies some message was signed by the owner of this public key.

  • Parameters:

    • signature (bytes) - The signature to verify.

    • message (bytes) - The message that was supposedly signed.

    • hasher - The hash function to use. hasher(message) must return 32 bytes.

  • Returns: bool

add(scalar, update=False)

  • Parameters:

    • scalar (bytes) - The scalar to add.

    • update - If True, will update and return self.

  • Returns: coincurve.PublicKey

multiply(scalar, update=False)

  • Parameters:

    • scalar (bytes) - The scalar to multiply.

    • update - If True, will update and return self.

  • Returns: coincurve.PublicKey

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for Ofekmeister from gravatar.com Ofekmeister

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Ofek Lev
  • Tags secp256k1, elliptic curves, bitcoin, ethereum, cryptocurrency
Classifiers

Release history Release notifications | RSS feed

20.0.0

19.0.1

19.0.0 yanked

Reason this release was yanked:

broken on Windows

18.0.0

17.0.0

16.0.0

15.0.1

15.0.0

14.0.0

13.0.0

13.0.0rc1 pre-release

12.0.0

11.0.0

10.0.0

9.0.0

8.0.2

8.0.2rc3 pre-release

8.0.2rc2 pre-release

8.0.2rc1 pre-release

8.0.0

7.1.0

7.0.0

6.0.0

5.2.0

5.1.0

5.0.1

5.0.0

This version

4.5.1

4.4.1

4.4.0

4.3.0

4.2.0

4.1.3

Download files

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

Source Distribution

coincurve-4.5.1.tar.gz (875.4 kB view hashes)

Uploaded Source

Built Distributions

coincurve-4.5.1-py2.py3-none-win_amd64.whl (255.8 kB view hashes)

Uploaded Python 2 Python 3 Windows x86-64

coincurve-4.5.1-py2.py3-none-win32.whl (270.8 kB view hashes)

Uploaded Python 2 Python 3 Windows x86

coincurve-4.5.1-pp357-pp357-manylinux1_x86_64.whl (206.9 kB view hashes)

Uploaded PyPy

coincurve-4.5.1-cp36-cp36m-manylinux1_x86_64.whl (523.5 kB view hashes)

Uploaded CPython 3.6m

coincurve-4.5.1-cp36-cp36m-manylinux1_i686.whl (531.0 kB view hashes)

Uploaded CPython 3.6m

coincurve-4.5.1-cp36-cp36m-macosx_10_6_intel.whl (154.9 kB view hashes)

Uploaded CPython 3.6m macOS 10.6+ intel

coincurve-4.5.1-cp35-cp35m-manylinux1_x86_64.whl (523.5 kB view hashes)

Uploaded CPython 3.5m

coincurve-4.5.1-cp35-cp35m-manylinux1_i686.whl (531.0 kB view hashes)

Uploaded CPython 3.5m

coincurve-4.5.1-cp35-cp35m-macosx_10_6_intel.whl (154.9 kB view hashes)

Uploaded CPython 3.5m macOS 10.6+ intel

coincurve-4.5.1-cp27-cp27mu-manylinux1_x86_64.whl (526.7 kB view hashes)

Uploaded CPython 2.7mu

coincurve-4.5.1-cp27-cp27mu-manylinux1_i686.whl (534.0 kB view hashes)

Uploaded CPython 2.7mu

coincurve-4.5.1-cp27-cp27m-manylinux1_x86_64.whl (526.7 kB view hashes)

Uploaded CPython 2.7m

coincurve-4.5.1-cp27-cp27m-manylinux1_i686.whl (534.0 kB view hashes)

Uploaded CPython 2.7m

coincurve-4.5.1-cp27-cp27m-macosx_10_6_intel.whl (154.8 kB view hashes)

Uploaded CPython 2.7m macOS 10.6+ intel

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page