{ "info": { "author": "Stark Bank", "author_email": "developers@starkbank.com", "bugtrack_url": null, "classifiers": [], "description": "## A lightweight and fast pure Python ECDSA\n\n### Overview\n\nWe tried other Python libraries such as [python-ecdsa], [fast-ecdsa] and others less famous ones, but we didn't find anything that suit our needs. The fist one was pure Python, but it was too slow. The second one mixed Python and C and it was really fast, but we were unable to use it in our current infrastructure that required pure Python code.\n\n[python-ecdsa]: https://github.com/warner/python-ecdsa\n[fast-ecdsa]: https://github.com/AntonKueltz/fastecdsa\n\nFor this reason, we decided to create something simple, compatible with OpenSSL and fast using some elegant math as Jacobian Coordinates to speed up the ECDSA. Starkbank-EDCSA is fully compatible with Python2 and Python3.\n\n### Curves\n\nWe currently support `secp256k1`, but it's super easy to add more curves to the project. Just add them on `curve.py`\n\n### Speed\n\nWe ran a test on a MAC Pro i7 2017. We ran the library 100 times and got the average time displayed bellow:\n\n| Library | sign | verify |\n| ------------------ |:-------------:| -------:|\n| [python-ecdsa] | 121.3ms | 65.1ms |\n| [fast-ecdsa] | 0.1ms | 0.2ms |\n| starkbank-ecdsa | 4.1ms | 7.8ms |\n\nSo our pure Python code cannot compete with C based libraries, but it's `6x faster` to verify and `23x faster` to sign then other pure Python libraries.\n\n### Sample Code\n\nHow sign a json message for [Stark Bank]:\n\n```python\nfrom json import dumps\nfrom ellipticcurve.ecdsa import Ecdsa\nfrom ellipticcurve.privateKey import PrivateKey\n\n# Generate privateKey from PEM string\nprivateKey = PrivateKey.fromPem(\"\"\"\n -----BEGIN EC PARAMETERS-----\n BgUrgQQACg==\n -----END EC PARAMETERS-----\n -----BEGIN EC PRIVATE KEY-----\n MHQCAQEEIODvZuS34wFbt0X53+P5EnSj6tMjfVK01dD1dgDH02RzoAcGBSuBBAAK\n oUQDQgAE/nvHu/SQQaos9TUljQsUuKI15Zr5SabPrbwtbfT/408rkVVzq8vAisbB\n RmpeRREXj5aog/Mq8RrdYy75W9q/Ig==\n -----END EC PRIVATE KEY-----\n\"\"\")\n\n# Create message from json\nmessage = dumps({\n \"transfers\": [\n {\n \"amount\": 100000000,\n \"taxId\": \"594.739.480-42\",\n \"name\": \"Daenerys Targaryen Stormborn\",\n \"bankCode\": \"341\",\n \"branchCode\": \"2201\",\n \"accountNumber\": \"76543-8\",\n \"tags\": [\"daenerys\", \"targaryen\", \"transfer-1-external-id\"]\n }\n ]\n})\n\nsignature = Ecdsa.sign(message, privateKey)\n\n# Generate Signature in base64. This result can be sent to Stark Bank in header as Digital-Signature parameter\nprint(signature.toBase64())\n\n# To double check if message matches the signature\npublicKey = privateKey.publicKey()\n\nprint(Ecdsa.verify(message, signature, publicKey))\n```\n\nSimple use:\n\n```python\nfrom ellipticcurve.ecdsa import Ecdsa\nfrom ellipticcurve.privateKey import PrivateKey\n\n# Generate new Keys\nprivateKey = PrivateKey()\npublicKey = privateKey.publicKey()\n\nmessage = \"My test message\"\n\n# Generate Signature\nsignature = Ecdsa.sign(message, privateKey)\n\n# Verify if signature is valid\nprint(Ecdsa.verify(message, signature, publicKey))\n```\n\n### OpenSSL\n\nThis library is compatible with OpenSSL, so you can use it to generate keys:\n\n```\nopenssl ecparam -name secp256k1 -genkey -out privateKey.pem\nopenssl ec -in privateKey.pem -pubout -out publicKey.pem\n```\n\nCreate a message.txt file and sign it:\n\n```\nopenssl dgst -sha256 -sign privateKey.pem -out signatureDer.txt message.txt\n```\n\nIt's time to verify:\n\n```python\nfrom ellipticcurve.ecdsa import Ecdsa\nfrom ellipticcurve.signature import Signature\nfrom ellipticcurve.publicKey import PublicKey\nfrom ellipticcurve.utils.file import File\n\npublicKeyPem = File.read(\"publicKey.pem\")\nsignatureDer = File.read(\"signatureDer.txt\", \"rb\")\nmessage = File.read(\"message.txt\")\n\npublicKeyPem = File.read(\"publicKey.pem\")\n\npublicKey = PublicKey.fromPem(publicKeyPem)\nsignature = Signature.fromDer(signatureDer)\n\nprint(Ecdsa.verify(message, signature, publicKey))\n```\n\nYou can also verify it on terminal:\n\n```\nopenssl dgst -sha256 -verify publicKey.pem -signature signatureDer.txt message.txt\n```\n\nNOTE: If you want to create a Digital Signature to use in the [Stark Bank], you need to convert the binary signature to base64.\n\n```\nopenssl base64 -in signatureDer.txt -out signatureBase64.txt\n```\n\nWith this library, you can do it:\n\n```python\nfrom ellipticcurve.signature import Signature\nfrom ellipticcurve.utils.file import File\nsignatureDer = File.read(\"signatureDer.txt\", \"rb\")\n\nsignature = Signature.fromDer(signatureDer)\n\nprint(signature.toBase64())\n```\n\n[Stark Bank]: https://starkbank.com\n\n### How to install\n\n```\npip install starkbank-ecdsa\n```\n\n### Run all unit tests\n\n```\npython3 -m unittest discover\npython2 -m unittest discover\n```", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/starkbank/ecdsa-python.git", "keywords": "ecdsa,elliptic curve,elliptic,curve,stark bank,starkbank,cryptograph", "license": "MIT License", "maintainer": "", "maintainer_email": "", "name": "starkbank-ecdsa", "package_url": "https://pypi.org/project/starkbank-ecdsa/", "platform": "", "project_url": "https://pypi.org/project/starkbank-ecdsa/", "project_urls": { "Homepage": "https://github.com/starkbank/ecdsa-python.git" }, "release_url": "https://pypi.org/project/starkbank-ecdsa/0.1.7/", "requires_dist": null, "requires_python": "", "summary": "A lightweight and fast pure python ECDSA library", "version": "0.1.7" }, "last_serial": 5925249, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "8f5c30e196004444624238df57286857", "sha256": "d6de618fe29e907edc53d8ba76638d9e9c8a00f04765d88099ce4252136a2e3e" }, "downloads": -1, "filename": "starkbank-ecdsa-0.1.tar.gz", "has_sig": false, "md5_digest": "8f5c30e196004444624238df57286857", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7199, "upload_time": "2018-09-02T02:17:38", "url": "https://files.pythonhosted.org/packages/b3/03/ca542978c2b36594b17bcb11862a981e967d43677738632035578975d629/starkbank-ecdsa-0.1.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "8797c9090f79273a9946a6d260c4993e", "sha256": "6e94252370a6d2bcf3fa8e6a3f02695e145accec258130a31bc4d6a6c162c476" }, "downloads": -1, "filename": "starkbank-ecdsa-0.1.1.tar.gz", "has_sig": false, "md5_digest": "8797c9090f79273a9946a6d260c4993e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7281, "upload_time": "2018-09-03T01:11:43", "url": "https://files.pythonhosted.org/packages/2c/d0/2409a36d1bb1f41b0d0bfc7e0d7ad9c29099f5a59c0ea4f04a16096b5ab6/starkbank-ecdsa-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "6bf2792f6c9b48a89ae04ab889bcf7b1", "sha256": "5b452b5060b936a2fb4fe8b27a2de70183ebd9fd6c36a62e4a6084ec16e1bb97" }, "downloads": -1, "filename": "starkbank-ecdsa-0.1.2.tar.gz", "has_sig": false, "md5_digest": "6bf2792f6c9b48a89ae04ab889bcf7b1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7915, "upload_time": "2018-12-28T21:57:28", "url": "https://files.pythonhosted.org/packages/42/2c/9d102d18b89320304b850753e02075c4d74e9f0156f785217fe6895aa419/starkbank-ecdsa-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "0e5c1d78e0bb9167f263f49a38e61439", "sha256": "b11d03172b39c77f311fef4923c4c5aae062d916b9f94219dc5901945a0eb6d2" }, "downloads": -1, "filename": "starkbank-ecdsa-0.1.3.tar.gz", "has_sig": false, "md5_digest": "0e5c1d78e0bb9167f263f49a38e61439", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8399, "upload_time": "2019-01-02T22:33:18", "url": "https://files.pythonhosted.org/packages/25/1e/d70f172164c4db65b12f30fae62d291f7bffb4c762b42b4fb32e36351638/starkbank-ecdsa-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "069eab2ca8e78a8680c2240ec3663da6", "sha256": "fe9cabadbcc4fd2216b8efb2403c19b64b1aa00a59f45d4375b500c490a5cbce" }, "downloads": -1, "filename": "starkbank-ecdsa-0.1.4.tar.gz", "has_sig": false, "md5_digest": "069eab2ca8e78a8680c2240ec3663da6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9909, "upload_time": "2019-01-20T05:19:54", "url": "https://files.pythonhosted.org/packages/f8/62/0e68d90789724beb36e3413a6d4f12e91c000b2bf45939376652697e3437/starkbank-ecdsa-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "6eb11e8a43e726b9f09df07f5333bdbc", "sha256": "c65649e3abcd591eb36488ee1169d4d0f8b132290f224ed239d18fb24b3eb1c1" }, "downloads": -1, "filename": "starkbank-ecdsa-0.1.5.tar.gz", "has_sig": false, "md5_digest": "6eb11e8a43e726b9f09df07f5333bdbc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12577, "upload_time": "2019-04-24T19:40:03", "url": "https://files.pythonhosted.org/packages/41/a6/55e2b0aa630fc3b08551301f27d714510b5275feca68b098a8c609184805/starkbank-ecdsa-0.1.5.tar.gz" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "69b7494c7552d869234aaa252227d9b5", "sha256": "298a1206462408f3f73b46ae9c3c8836b6c386632e01548ba6a9e2119e21ea8a" }, "downloads": -1, "filename": "starkbank-ecdsa-0.1.6.tar.gz", "has_sig": false, "md5_digest": "69b7494c7552d869234aaa252227d9b5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12998, "upload_time": "2019-09-12T00:37:06", "url": "https://files.pythonhosted.org/packages/da/e0/b3082af02266b9eee9b4596aee0fb02d19784d855971976396f838149f1b/starkbank-ecdsa-0.1.6.tar.gz" } ], "0.1.7": [ { "comment_text": "", "digests": { "md5": "4031d73cf2df7cfc2081e0aee4fd69cc", "sha256": "f78cdc4fa651d6848f77fe270be8786ac08c7698f78c534b7159334b30703e62" }, "downloads": -1, "filename": "starkbank-ecdsa-0.1.7.tar.gz", "has_sig": false, "md5_digest": "4031d73cf2df7cfc2081e0aee4fd69cc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12229, "upload_time": "2019-10-03T20:11:57", "url": "https://files.pythonhosted.org/packages/fc/62/ba4e3989de47a8548aa515a1f86b36c783a82bdb690f07157fd0c12b6615/starkbank-ecdsa-0.1.7.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "4031d73cf2df7cfc2081e0aee4fd69cc", "sha256": "f78cdc4fa651d6848f77fe270be8786ac08c7698f78c534b7159334b30703e62" }, "downloads": -1, "filename": "starkbank-ecdsa-0.1.7.tar.gz", "has_sig": false, "md5_digest": "4031d73cf2df7cfc2081e0aee4fd69cc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12229, "upload_time": "2019-10-03T20:11:57", "url": "https://files.pythonhosted.org/packages/fc/62/ba4e3989de47a8548aa515a1f86b36c783a82bdb690f07157fd0c12b6615/starkbank-ecdsa-0.1.7.tar.gz" } ] }