wallet, test: update `gethdkeys` functional test
What the developer wrote
Authored by rkrux
wallet, test: update `gethdkeys` functional test
Update the `test_ranged_multisig` test case to verify the partial
xprv fix in the `gethdkeys` RPC. Also, update some existing variable
names.
What changed, and why it matters
This commit only changes a test file. It updates an existing functional test for the gethdkeys RPC to verify a previously fixed bug where private extended keys (xprv) were incorrectly returned for keys that did not belong to the wallet. There are no changes to production wallet code, so this does not introduce or fix a live security issue on its own.
No action required. Reviewers may want to confirm the corresponding production fix for gethdkeys is already merged and that this test adequately covers the partial xprv regression.
Security signals we found
Test-only change
Verifies xprv privacy boundary in gethdkeys RPC
Confirms external xpubs in multisig descriptors are not leaked with private material
Evidence from the diff
The diff modifies test/functional/wallet_gethdkeys.py. It renames variables for clarity and expands test_ranged_multisig to assert that: (1) the wallet’s own HD key reports has_private=true and includes the xprv only when private=True is requested; (2) an external xpub used in a multisig descriptor reports has_private=false and never includes an xprv; (3) the imported multisig descriptor appears under both keys. This is a regression/verification test for the partial xprv fix in gethdkeys, not a patch to the RPC implementation.
Changed components
test/functional/wallet_gethdkeys.pyInspect captured patch +33 / −17
diff --git a/test/functional/wallet_gethdkeys.py b/test/functional/wallet_gethdkeys.py
index 93256279..d25ed4ed 100755
--- a/test/functional/wallet_gethdkeys.py
+++ b/test/functional/wallet_gethdkeys.py
@@ -10,6 +10,7 @@ from test_framework.util import (
assert_equal,
assert_raises_rpc_error,
assert_not_equal,
+ assert_greater_than,
)
from test_framework.wallet_util import WalletUnlock
@@ -130,31 +131,46 @@ class WalletGetHDKeyTest(BitcoinTestFramework):
def test_ranged_multisig(self):
self.log.info("HD keys of a multisig appear in gethdkeys")
+
def_wallet = self.nodes[0].get_wallet_rpc(self.default_wallet_name)
+ outside_wallet_xpub = def_wallet.gethdkeys()[0]["xpub"]
+
self.nodes[0].createwallet("ranged_multisig")
wallet = self.nodes[0].get_wallet_rpc("ranged_multisig")
- xpub1 = wallet.gethdkeys()[0]["xpub"]
- xprv1 = wallet.gethdkeys(private=True)[0]["xprv"]
- xpub2 = def_wallet.gethdkeys()[0]["xpub"]
+ hdkeys_info = wallet.gethdkeys(private=True)
+ assert_equal(len(hdkeys_info), 1)
+ within_wallet_xprv = hdkeys_info[0]["xprv"]
+ within_wallet_xpub = hdkeys_info[0]["xpub"]
- prv_multi_desc = descsum_create(f"wsh(multi(2,{xprv1}/*,{xpub2}/*))")
- pub_multi_desc = descsum_create(f"wsh(multi(2,{xpub1}/*,{xpub2}/*))")
+ prv_multi_desc = descsum_create(f"wsh(multi(2,{within_wallet_xprv}/*,{outside_wallet_xpub}/*))")
+ pub_multi_desc = descsum_create(f"wsh(multi(2,{within_wallet_xpub}/*,{outside_wallet_xpub}/*))")
assert_equal(wallet.importdescriptors([{"desc": prv_multi_desc, "timestamp": "now"}])[0]["success"], True)
- xpub_info = wallet.gethdkeys()
- assert_equal(len(xpub_info), 2)
- for x in xpub_info:
- if x["xpub"] == xpub1:
- found_desc = next((d for d in xpub_info[0]["descriptors"] if d["desc"] == pub_multi_desc), None)
- assert found_desc is not None
+ rpcs_req_resp = [[False, wallet.gethdkeys()], [True, wallet.gethdkeys(private=True)]]
+ for rpc_req_resp in rpcs_req_resp:
+ requested_private, hdkeys_response = rpc_req_resp
+ assert_equal(len(hdkeys_response), 2)
+
+ for hdkeys_info in hdkeys_response:
+ if hdkeys_info["xpub"] == within_wallet_xpub:
+ assert_equal(hdkeys_info["has_private"], True)
+ if requested_private:
+ assert_equal(hdkeys_info["xprv"], within_wallet_xprv)
+ else:
+ assert_equal("xprv" not in hdkeys_info, True)
+ assert_greater_than(len(hdkeys_info["descriptors"]), 1) # within wallet xpub by default is part of multiple descriptors
+ found_desc = next((d for d in hdkeys_info["descriptors"] if d["desc"] == pub_multi_desc), None)
+ elif hdkeys_info["xpub"] == outside_wallet_xpub:
+ assert_equal(hdkeys_info["has_private"], False)
+ assert_equal("xprv" not in hdkeys_info, True)
+ assert_equal(len(hdkeys_info["descriptors"]), 1) # outside wallet xpub is part of only the imported descriptor
+ found_desc = hdkeys_info["descriptors"][0]
+ else:
+ assert False
+
+ assert_equal(found_desc["desc"], pub_multi_desc)
assert_equal(found_desc["active"], False)
- elif x["xpub"] == xpub2:
- assert_equal(len(x["descriptors"]), 1)
- assert_equal(x["descriptors"][0]["desc"], pub_multi_desc)
- assert_equal(x["descriptors"][0]["active"], False)
- else:
- assert False
def test_mixed_multisig(self):
self.log.info("Non-HD keys of a multisig do not appear in gethdkeys")
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.