mirror of
https://github.com/bitcoin/bitcoin.git
synced 2024-11-19 09:53:47 +01:00
Merge bitcoin/bitcoin#28363: doc: Add offline signing tutorial
3c208cc05eAdd offline signing tutorial (Brandon Odiwuor) Pull request description: This PR adds offline signing tutorial. Fixes https://github.com/bitcoin/bitcoin/issues/9492 Although there currently exists tutorials on external-signer and on multisig implemented on #24519 . The external-signer tutorial assumes a connected device and the multisig tutorial is only for multisig transactions and does not include using an offline wallet - The tutorial uses signet(instead of regtest) to be as close as possible to mainnet ACKs for top commit: achow101: ACK3c208cc05ewillcl-ark: ACK3c208cc05epinheadmz: ACK3c208cc05eZero-1729: ACK3c208cc05eTree-SHA512: c1686043d9e9ed440e78d219a6b18d58d62efd05bdd535e74194d8cc2db0a91e94c6c619106453120a137e47220cf3ab27af3214e861f4e5cc419a73a8704dd6
This commit is contained in:
Andrew Chow
commit
4cebad4833
@ -79,6 +79,7 @@ The Bitcoin repo's [root README](/README.md) contains relevant information on th
|
||||
- [Init Scripts (systemd/upstart/openrc)](init.md)
|
||||
- [Managing Wallets](managing-wallets.md)
|
||||
- [Multisig Tutorial](multisig-tutorial.md)
|
||||
- [Offline Signing Tutorial](offline-signing-tutorial.md)
|
||||
- [P2P bad ports definition and list](p2p-bad-ports.md)
|
||||
- [PSBT support](psbt.md)
|
||||
- [Reduce Memory](reduce-memory.md)
|
||||
|
||||
255
doc/offline-signing-tutorial.md
Normal file
255
doc/offline-signing-tutorial.md
Normal file
@ -0,0 +1,255 @@
|
||||
# Offline Signing Tutorial
|
||||
|
||||
This tutorial will describe how to use two instances of Bitcoin Core, one online and one offline, to greatly increase security by not having private keys reside on a networked device.
|
||||
|
||||
Maintaining an air-gap between private keys and any network connections drastically reduces the opportunity for those keys to be exfiltrated from the user.
|
||||
|
||||
This workflow uses [Partially Signed Bitcoin Transactions](https://github.com/bitcoin/bitcoin/blob/master/doc/psbt.md) (PSBTs) to transfer the transaction to and from the offline wallet for signing using the private keys.
|
||||
|
||||
> [!NOTE]
|
||||
> While this tutorial demonstrates the process using `signet` network, you should omit the `-signet` flag in the provided commands when working with `mainnet`.
|
||||
|
||||
## Overview
|
||||
In this tutorial we have two hosts, both running Bitcoin v25.0
|
||||
|
||||
* `offline` host which is disconnected from all networks (internet, Tor, wifi, bluetooth etc.) and does not have, or need, a copy of the blockchain.
|
||||
* `online` host which is a regular online node with a synced blockchain.
|
||||
|
||||
We are going to first create an `offline_wallet` on the offline host. We will then create a `watch_only_wallet` on the online host using public key descriptors exported from the `offline_wallet`. Next we will receive some coins into the wallet. In order to spend these coins we'll create an unsigned PSBT using the `watch_only_wallet`, sign the PSBT using the private keys in the `offline_wallet`, and finally broadcast the signed PSBT using the online host.
|
||||
|
||||
### Requirements
|
||||
- [jq](https://jqlang.github.io/jq/) installation - This tutorial uses jq to process certain fields from JSON RPC responses, but this convenience is optional.
|
||||
|
||||
### Create and Prepare the `offline_wallet`
|
||||
|
||||
1. On the offline machine create a wallet named `offline_wallet` secured by a wallet `passphrase`. This wallet will contain private keys and must remain unconnected to any networks at all times.
|
||||
|
||||
```sh
|
||||
[offline]$ ./src/bitcoin-cli -signet -named createwallet \
|
||||
wallet_name="offline_wallet" \
|
||||
passphrase="** enter passphrase **"
|
||||
|
||||
{
|
||||
"name": "offline_wallet"
|
||||
}
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> The use of a passphrase is crucial to encrypt the wallet.dat file. This encryption ensures that even if an unauthorized individual gains access to the offline host, they won't be able to access the wallet's contents. Further details about securing your wallet can be found in [Managing the Wallet](https://github.com/bitcoin/bitcoin/blob/master/doc/managing-wallets.md#12-encrypting-the-wallet)
|
||||
|
||||
2. Export the public key-only descriptors from the offline host to a JSON file named `descriptors.json`. We use `jq` here to extract the `.descriptors` field from the full RPC response.
|
||||
|
||||
```sh
|
||||
[offline]$ ./src/bitcoin-cli -signet -rpcwallet="offline_wallet" listdescriptors \
|
||||
| jq -r '.descriptors' \
|
||||
>> /path/to/descriptors.json
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> The `descriptors.json` file will be transferred to the online machine (e.g. using a USB flash drive) where it can be imported to create a related watch-only wallet.
|
||||
|
||||
### Create the online `watch_only_wallet`
|
||||
|
||||
1. On the online machine create a blank watch-only wallet which has private keys disabled and is named `watch_only_wallet`. This is achieved by using the `createwallet` options: `disable_private_keys=true, blank=true`.
|
||||
|
||||
The `watch_only_wallet` wallet will be used to track and validate incoming transactions, create unsigned PSBTs when spending coins, and broadcast signed and finalized PSBTs.
|
||||
|
||||
> [!NOTE]
|
||||
> `disable_private_keys` indicates that the wallet should refuse to import private keys, i.e. will be a dedicated watch-only wallet.
|
||||
|
||||
```sh
|
||||
[online]$ ./src/bitcoin-cli -signet -named createwallet \
|
||||
wallet_name="watch_only_wallet" \
|
||||
disable_private_keys=true
|
||||
|
||||
{
|
||||
"name": "watch_only_wallet"
|
||||
}
|
||||
```
|
||||
|
||||
2. Import the `offline_wallet`s public key descriptors to the online `watch_only_wallet` using the `descriptors.json` file created on the offline wallet.
|
||||
|
||||
```sh
|
||||
[online]$ ./src/bitcoin-cli -signet -rpcwallet="watch_only_wallet" importdescriptors "$(cat /path/to/descriptors.json)"
|
||||
|
||||
[
|
||||
{
|
||||
"success": true
|
||||
},
|
||||
{
|
||||
"success": true
|
||||
},
|
||||
{
|
||||
"success": true
|
||||
},
|
||||
{
|
||||
"success": true
|
||||
},
|
||||
{
|
||||
"success": true
|
||||
},
|
||||
{
|
||||
"success": true
|
||||
},
|
||||
{
|
||||
"success": true
|
||||
},
|
||||
{
|
||||
"success": true
|
||||
}
|
||||
]
|
||||
```
|
||||
> [!NOTE]
|
||||
> Multiple success values indicate that multiple descriptors, for different address types, have been successfully imported. This allows generating different address types on the `watch_only_wallet`.
|
||||
|
||||
### Fund the `offline_wallet`
|
||||
|
||||
At this point, it's important to understand that both the `offline_wallet` and online `watch_only_wallet` share the same public keys. As a result, they generate the same addresses. Transactions can be created using either wallet, but valid signatures can only be added by the `offline_wallet` as only it has the private keys.
|
||||
|
||||
1. Generate an address to receive coins. You can use _either_ the `offline_wallet` or the online `watch_only_wallet` to generate this address, as they will produce the same addresses. For the sake of this guide, we'll use the online `watch_only_wallet` to generate the address.
|
||||
|
||||
```sh
|
||||
[online]$ ./src/bitcoin-cli -signet -rpcwallet="watch_only_wallet" getnewaddress
|
||||
|
||||
tb1qtu5qgc6ddhmqm5yqjvhg83qgk2t4ewajg0h6yh
|
||||
```
|
||||
|
||||
2. Visit a faucet like https://signet.bc-2.jp and enter your address from the previous command to receive a small amount of signet coins to this address.
|
||||
|
||||
3. Confirm that coins were received using the online `watch_only_wallet`. Note that the transaction may take a few moments before being received on your local node, depending on its connectivity. Just re-run the command periodically until the transaction is received.
|
||||
|
||||
```sh
|
||||
[online]$ ./src/bitcoin-cli -signet -rpcwallet="watch_only_wallet" listunspent
|
||||
|
||||
[
|
||||
{
|
||||
"txid": "0f3953dfc3eb8e753cd1633151837c5b9953992914ff32b7de08c47f1f29c762",
|
||||
"vout": 1,
|
||||
"address": "tb1qtu5qgc6ddhmqm5yqjvhg83qgk2t4ewajg0h6yh",
|
||||
"label": "",
|
||||
"scriptPubKey": "00145f2804634d6df60dd080932e83c408b2975cbbb2",
|
||||
"amount": 0.01000000,
|
||||
"confirmations": 4,
|
||||
"spendable": true,
|
||||
"solvable": true,
|
||||
"desc": "wpkh([306c734f/84h/1h/0h/0/0]025932ccee7590158f7e08bb36290d135d30a0b045163da896e1cd7645ec4223a9)#xytvyr4a",
|
||||
"parent_descs": [
|
||||
"wpkh([306c734f/84h/1h/0h]tpubDCJnY92ib4Zu3qd6wrBXEjG436tQdA2tDiJU2iSJYjkNS1darssPWKaBfojhjUF5vMLBcxbN2r93pmFMz2zyTEZuNx9JDo9rWqoHhATW3Uz/0/*)#7mh08dkg"
|
||||
],
|
||||
"safe": true
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
### Create and Export an Unsigned PSBT
|
||||
|
||||
1. Get a destination address for the transaction. In this tutorial we'll be sending funds to the address `tb1q9k5w0nhnhyeh78snpxh0t5t7c3lxdeg3erez32`, but if you don't need the coins for further testing you could send the coins back to the faucet.
|
||||
|
||||
2. Create a funded but unsigned PSBT to the destination address with the online `watch_only_wallet` by using `send [{"address":amount},...]` and export the unsigned PSBT to a file `funded_psbt.txt` for easy portability to the `offline_wallet` for signing:
|
||||
|
||||
```sh
|
||||
[online]$ ./src/bitcoin-cli -signet -rpcwallet="watch_only_wallet" send \
|
||||
'{"tb1q9k5w0nhnhyeh78snpxh0t5t7c3lxdeg3erez32": 0.009}' \
|
||||
| jq -r '.psbt' \
|
||||
>> /path/to/funded_psbt.txt
|
||||
|
||||
[online]$ cat /path/to/funded_psbt.txt
|
||||
|
||||
cHNidP8BAHECAAAAAWLHKR9/xAjetzL/FCmZU5lbfINRMWPRPHWO68PfUzkPAQAAAAD9////AoA4AQAAAAAAFgAULajnzvO5M38eEwmu9dF+xH5m5RGs0g0AAAAAABYAFMaT0f/Wp2DCZzL6dkJ3GhWj4Y9vAAAAAAABAHECAAAAAY+dRPEBrGopkw4ugSzS9npzJDEIrE/bq1XXI0KbYnYrAQAAAAD+////ArKaXgAAAAAAFgAUwEc4LdoxSjbWo/2Ue+HS+QjwfiBAQg8AAAAAABYAFF8oBGNNbfYN0ICTLoPECLKXXLuyYW8CAAEBH0BCDwAAAAAAFgAUXygEY01t9g3QgJMug8QIspdcu7IiBgJZMszudZAVj34IuzYpDRNdMKCwRRY9qJbhzXZF7EIjqRgwbHNPVAAAgAEAAIAAAACAAAAAAAAAAAAAACICA7BlBnyAR4F2UkKuSX9MFhYCsn6j//z9i7lHDm1O0CU0GDBsc09UAACAAQAAgAAAAIABAAAAAAAAAAA=
|
||||
```
|
||||
> [!NOTE]
|
||||
> Leaving the `input` array empty in the above `walletcreatefundedpsbt` command is permitted and will cause the wallet to automatically select appropriate inputs for the transaction.
|
||||
|
||||
### Decode and Analyze the Unsigned PSBT
|
||||
|
||||
Decode and analyze the unsigned PSBT on the `offline_wallet` using the `funded_psbt.txt` file:
|
||||
|
||||
```sh
|
||||
[offline]$ ./src/bitcoin-cli -signet decodepsbt $(cat /path/to/funded_psbt.txt)
|
||||
|
||||
{
|
||||
...
|
||||
}
|
||||
|
||||
[offline]$ ./src/bitcoin-cli -signet analyzepsbt $(cat /path/to/funded_psbt.txt)
|
||||
|
||||
{
|
||||
"inputs": [
|
||||
{
|
||||
"has_utxo": true,
|
||||
"is_final": false,
|
||||
"next": "signer",
|
||||
"missing": {
|
||||
"signatures": [
|
||||
"5f2804634d6df60dd080932e83c408b2975cbbb2"
|
||||
]
|
||||
}
|
||||
}
|
||||
],
|
||||
"estimated_vsize": 141,
|
||||
"estimated_feerate": 0.00100000,
|
||||
"fee": 0.00014100,
|
||||
"next": "signer"
|
||||
}
|
||||
```
|
||||
|
||||
Notice that the analysis of the PSBT shows that "signatures" are missing and should be provided by the private key corresponding to the public key hash (hash160) "5f2804634d6df60dd080932e83c408b2975cbbb2"
|
||||
|
||||
### Process and Sign the PSBT
|
||||
|
||||
1. Unlock the `offline_wallet` with the Passphrase:
|
||||
|
||||
Use the walletpassphrase command to unlock the `offline_wallet` with the passphrase. You should specify the passphrase and a timeout (in seconds) for how long you want the wallet to remain unlocked.
|
||||
|
||||
```sh
|
||||
[offline]$ ./src/bitcoin-cli -signet -rpcwallet="offline_wallet" walletpassphrase "** enter passphrase **" 60
|
||||
```
|
||||
|
||||
2. Process, sign and finalize the PSBT on the `offline_wallet` using the `walletprocesspsbt` command, saving the output to a file `final_psbt.txt`.
|
||||
|
||||
```sh
|
||||
[offline]$ ./src/bitcoin-cli -signet -rpcwallet="offline_wallet" walletprocesspsbt \
|
||||
$(cat /path/to/funded_psbt.txt) \
|
||||
| jq -r .hex \
|
||||
>> /path/to/final_psbt.txt
|
||||
```
|
||||
|
||||
### Broadcast the Signed and Finalized PSBT
|
||||
Broadcast the funded, signed and finalized PSBT `final_psbt.txt` using `sendrawtransaction` with an online node:
|
||||
|
||||
```sh
|
||||
[online]$ ./src/bitcoin-cli -signet sendrawtransaction $(cat /path/to/final_psbt.txt)
|
||||
|
||||
c2430a0e46df472b04b0ca887bbcd5c4abf7b2ce2eb71de981444a80e2b96d52
|
||||
```
|
||||
|
||||
### Confirm Wallet Balance
|
||||
|
||||
Confirm the updated balance of the offline wallet using the `watch_only_wallet`.
|
||||
|
||||
```sh
|
||||
[online]$ ./src/bitcoin-cli -signet -rpcwallet="watch_only_wallet" getbalances
|
||||
|
||||
{
|
||||
"mine": {
|
||||
"trusted": 0.00085900,
|
||||
"untrusted_pending": 0.00000000,
|
||||
"immature": 0.00000000
|
||||
},
|
||||
"lastprocessedblock": {
|
||||
"hash": "0000003065c0669fff27edb4a71928cb48e5a6cfcdf06f491a83fd86822d18a6",
|
||||
"height": 159592
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
You can also show transactions related to the wallet using `listtransactions`
|
||||
|
||||
```sh
|
||||
[online]$ ./src/bitcoin-cli -signet -rpcwallet="watch_only_wallet" listtransactions
|
||||
|
||||
{
|
||||
...
|
||||
}
|
||||
```
|
||||
Loading…
Reference in New Issue
Block a user