Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shadowy-pycoder/bitcoin_message_tool
Bitcoin message signing/verification tool
https://github.com/shadowy-pycoder/bitcoin_message_tool
bitcoin cli-app ecdsa ecdsa-signature
Last synced: 3 months ago
JSON representation
Bitcoin message signing/verification tool
- Host: GitHub
- URL: https://github.com/shadowy-pycoder/bitcoin_message_tool
- Owner: shadowy-pycoder
- License: mit
- Created: 2023-01-27T13:11:05.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-02-28T03:18:55.000Z (11 months ago)
- Last Synced: 2024-10-10T16:31:58.459Z (3 months ago)
- Topics: bitcoin, cli-app, ecdsa, ecdsa-signature
- Language: Python
- Homepage:
- Size: 107 KB
- Stars: 4
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: code_of_conduct.md
Awesome Lists containing this project
README
Bitcoin Message Tool
======
Bitcoin Message Tool
A lightweight CLI tool for signing and verification of bitcoin messages.
Bitcoin message is the most straightforward and natural way to prove ownership over
a given address without revealing any confidential information.
This tool closely follows specification described in BIP137:
Please note that "since this format includes P2PKH keys, it is backwards compatible,
but keep in mind some software has checks for ranges of headers and will report the newer
segwit header types as errors."
More info: https://github.com/bitcoin/bips/blob/master/bip-0137.mediawiki
Installation
------------
To install with pip, run:
pip install bitcoin-message-tool
Quickstart Guide
----------------
Usage:
python -m bitcoin_message_tool -h
or
python bmt.py -h
usage: python3 bmt.py [-h] {sign,verify} ...
Bitcoin message signing/verification tool
positional arguments:
{sign,verify}
options:
-h, --help show this help message and exit
Message signing:
python bmt.py sign -h
usage: python3 sign [-h] -p -a {p2pkh,p2wpkh-p2sh,p2wpkh} -m [MESSAGE ...] [-d] [-e] [-v]
options:
-h, --help show this help message and exit
Sign messsage:
-p, --privkey private key in wallet import format (WIF)
-a {p2pkh,p2wpkh-p2sh,p2wpkh}, --addr_type {p2pkh,p2wpkh-p2sh,p2wpkh}
type of bitcoin address
-m [MESSAGE ...], --message [MESSAGE ...]
Message to sign
-d, --deterministic sign deterministtically (RFC6979)
-e, --electrum create Electrum-like signature
-v, --verbose print prettified message
Example 1:
Non-deterministic signature for compressed private key and p2pkh address
$python bmt.py sign -p -a p2pkh -m ECDSA is the most fun I have ever experienced
PrivateKey(WIF):
Output:
Bitcoin address: 175A5YsPUdM71mnNCC3i8faxxYJgBonjWL
Message: ECDSA is the most fun I have ever experienced
Signature: IBuc5GXSJCr6m7KevsBAoCiX8ToOjW2CDZMr6PCEbiHwQJ237LZTj/REbDHI1/yelY6uBWEWXiOWoGnajlgvO/A=
Example 2:
Deterministic signature for compressed private key and p2pkh address
$python bmt.py sign -p -a p2pkh -m ECDSA is the most fun I have ever experienced -d
PrivateKey(WIF):
Output:
Bitcoin address: 175A5YsPUdM71mnNCC3i8faxxYJgBonjWL
Message: ECDSA is the most fun I have ever experienced
Signature: HyiLDcQQ1p2bKmyqM0e5oIBQtKSZds4kJQ+VbZWpr0kYA6Qkam2MlUeTr+lm1teUGHuLapfa43JjyrRqdSA0pxs=
Example 3:
Deterministic signature for compressed private key and p2pkh address (verbose mode)
$python bmt.py sign -p -a p2pkh -m ECDSA is the most fun I have ever experienced -d -v
PrivateKey(WIF):
Output:
-----BEGIN BITCOIN SIGNED MESSAGE-----
ECDSA is the most fun I have ever experienced
-----BEGIN BITCOIN SIGNATURE-----
175A5YsPUdM71mnNCC3i8faxxYJgBonjWL
HyiLDcQQ1p2bKmyqM0e5oIBQtKSZds4kJQ+VbZWpr0kYA6Qkam2MlUeTr+lm1teUGHuLapfa43JjyrRqdSA0pxs=
-----END BITCOIN SIGNATURE-----
Example 4:
Uncompressed private keys can't produce addresses other than 'p2pkh'
python bmt.py sign -p -m ECDSA is the most fun I have ever experienced -a 'p2wpkh' -d -v
PrivateKey(WIF):
Output:
Traceback (most recent call last):
...
PrivateKeyError: ('Need WIF-compressed private key for this address type:', 'p2wpkh')
Message verification:
python bmt.py verify -h
usage: python3 verify [-h] -a ADDRESS -m [MESSAGE ...] -s SIGNATURE [-e] [-v] [-r]
options:
-h, --help show this help message and exit
Verify messsage:
-a ADDRESS, --address ADDRESS
specify bitcoin address
-m [MESSAGE ...], --message [MESSAGE ...]
Message to verify
-s SIGNATURE, --signature SIGNATURE
bitcoin signature in base64 format
-e, --electrum verify Electrum-like signature
-v, --verbose print full message
-r, --recpub recover public key
Example 1:
Standard message verification
python bmt.py verify -a 175A5YsPUdM71mnNCC3i8faxxYJgBonjWL \
> -m ECDSA is the most fun I have ever experienced \
> -s HyiLDcQQ1p2bKmyqM0e5oIBQtKSZds4kJQ+VbZWpr0kYA6Qkam2MlUeTr+lm1teUGHuLapfa43JjyrRqdSA0pxs=
Output:
True
Example 2:
Message verification in verbose mode
python bmt.py verify -a 175A5YsPUdM71mnNCC3i8faxxYJgBonjWL \
> -m ECDSA is the most fun I have ever experienced \
> -s HyiLDcQQ1p2bKmyqM0e5oIBQtKSZds4kJQ+VbZWpr0kYA6Qkam2MlUeTr+lm1teUGHuLapfa43JjyrRqdSA0pxs= \
> -v
Output:
True
Message verified to be from 175A5YsPUdM71mnNCC3i8faxxYJgBonjWL
Example 3:
Display a recovered public key
python bmt.py verify -a 175A5YsPUdM71mnNCC3i8faxxYJgBonjWL \
> -m ECDSA is the most fun I have ever experienced \
> -s HyiLDcQQ1p2bKmyqM0e5oIBQtKSZds4kJQ+VbZWpr0kYA6Qkam2MlUeTr+lm1teUGHuLapfa43JjyrRqdSA0pxs= \
> --recpub
Output:
True
024aeaf55040fa16de37303d13ca1dde85f4ca9baa36e2963a27a1c0c1165fe2b1
Example 4:
Error message
python bmt.py verify -a 175A5YsPUdM71mnNCC3i8faxxYJgBonjWL \
> -m ECDSA is the most fun I have ever experienced \
> -s HyiLDcQQ1p2bKmyqM0e5oIBQtKSZds4kJQ+VbZWpr0kYA6Qkam2MlUeTr+lm1teUGHuLaffa43Jj= -v -r \
Output:
Traceback (most recent call last):
...
SignatureError: ('Signature must be 65 bytes long:', 57)
Contribute
----------
If you'd like to contribute to bitcoin_message_signer, check out https://github.com/shadowy-pycoder/bitcoin_message_tool