Skip to content

Backport fix for deriving public keys from private ones to version3 #1627

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: version3
Choose a base branch
from
Open

Backport fix for deriving public keys from private ones to version3 #1627

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1f4914f
Test for depth overflow when deriving extended keys
Apr 1, 2025
bbb4442
Add failing tests when deriving public from invalid extended private key
Apr 1, 2025
68a0458
Guard deriving public from invalid extended private key
Apr 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/wallet/hd_private.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,9 @@ hd_key hd_private::to_hd_key() const

hd_public hd_private::to_public() const
{
if (!valid_) {
return {};
}
return hd_public(((hd_public)*this).to_hd_key(),
hd_public::to_prefix(lineage_.prefixes));
}
Expand Down
108 changes: 108 additions & 0 deletions test/wallet/hd_private.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,4 +130,112 @@ BOOST_AUTO_TEST_CASE(hd_private__derive_public__long_seed__expected)
BOOST_REQUIRE_EQUAL(m0xH1yH2_pub.encoded(), "xpub6FnCn6nSzZAw5Tw7cgR9bi15UV96gLZhjDstkXXxvCLsUXBGXPdSnLFbdpq8p9HmGsApME5hQTZ3emM2rnY5agb9rXpVGyy3bdW6EEgAtqt");
}

BOOST_AUTO_TEST_CASE(hd_private__constructor__null_key_decodes_to_invalid__expected)
{
// the 11...14rcJhr is a serialization of a null key;
static const auto null_encoded = "1111111111111111111111111111111111111111111111111111111111111111111111111111114rcJhr";
const hd_private xprv_null(null_encoded);

BOOST_REQUIRE(!xprv_null);
}

BOOST_AUTO_TEST_CASE(hd_private__to_public__fails_from_invalid_private__expected)
{
// the 11...14rcJhr is a serialization of a null key;
static const auto xprv_invalid_encoded = "1111111111111111111111111111111111111111111111111111111111111111111111111111114rcJhr";
const hd_private xprv_invalid(xprv_invalid_encoded);

BOOST_REQUIRE(!xprv_invalid);
BOOST_REQUIRE(!xprv_invalid.to_public());
}

BOOST_AUTO_TEST_CASE(hd_private__derive_private__must_not_overflow_depth__expected)
{
// xprv_254_depth was created from "xprv9s21ZrQH143K3QTDL4LXw2F7HEK3wJUD2nW2nRk4stbPy6cq3jPPqjiChkVvvNKmPGJxWUtg6LnF5kejMRNNU3TGtRBeJgk33yuGBxrMPHi"
// by manually setting the depth to 254
static const auto xprv_254_encoded = "xprvJ6xRbBsatSpgzr9c3hYbM2RohnAcHiiN74vQWqdRPx914xeq41t3u4rPXTsNxd5kvLSnqpsMx1cMx8cytMM5RbS7G54nwC5p5P5MQFSjf36";
const hd_private xprv_254(xprv_254_encoded);


const auto xprv_255 = xprv_254.derive_private(14);
const auto xprv_256 = xprv_255.derive_private(70);

BOOST_REQUIRE_EQUAL(xprv_254.lineage().depth, 254);
BOOST_REQUIRE(xprv_254);
// the maximal valid depth is 255
BOOST_REQUIRE_EQUAL(xprv_255.lineage().depth, 255);
BOOST_REQUIRE(xprv_255);

// depth overflows uint from 255 to 0
BOOST_REQUIRE_EQUAL(xprv_256.lineage().depth, 0);
// which creates invalid keys
BOOST_REQUIRE(!xprv_256);
}

BOOST_AUTO_TEST_CASE(hd_private__derive_private__hardened_must_not_overflow_depth__expected)
{
// xprv_254_depth was created from "xprv9s21ZrQH143K3QTDL4LXw2F7HEK3wJUD2nW2nRk4stbPy6cq3jPPqjiChkVvvNKmPGJxWUtg6LnF5kejMRNNU3TGtRBeJgk33yuGBxrMPHi"
// by manually setting the depth to 254
static const auto xprv254_encoded = "xprvJ6xRbBsatSpgzr9c3hYbM2RohnAcHiiN74vQWqdRPx914xeq41t3u4rPXTsNxd5kvLSnqpsMx1cMx8cytMM5RbS7G54nwC5p5P5MQFSjf36";
const hd_private xprv_254(xprv254_encoded);

const auto xprv_255 = xprv_254.derive_private(1337 + hd_first_hardened_key);
const auto xprv_256 = xprv_255.derive_private(8887 + hd_first_hardened_key);

BOOST_REQUIRE_EQUAL(xprv_254.lineage().depth, 254);
BOOST_REQUIRE(xprv_254);
// the maximal valid depth is 255
BOOST_REQUIRE_EQUAL(xprv_255.lineage().depth, 255);
BOOST_REQUIRE(xprv_255);

// depth overflows uint from 255 to 0
BOOST_REQUIRE_EQUAL(xprv_256.lineage().depth, 0);
// which creates invalid keys
BOOST_REQUIRE(!xprv_256);
}

BOOST_AUTO_TEST_CASE(hd_private__derive_public__must_not_overflow_depth__expected)
{
// xprv_254_depth was created from "xprv9s21ZrQH143K3QTDL4LXw2F7HEK3wJUD2nW2nRk4stbPy6cq3jPPqjiChkVvvNKmPGJxWUtg6LnF5kejMRNNU3TGtRBeJgk33yuGBxrMPHi"
// by manually setting the depth to 254
static const auto xprv_254_encoded = "xprvJ6xRbBsatSpgzr9c3hYbM2RohnAcHiiN74vQWqdRPx914xeq41t3u4rPXTsNxd5kvLSnqpsMx1cMx8cytMM5RbS7G54nwC5p5P5MQFSjf36";
const hd_private xprv_254(xprv_254_encoded);

const auto xprv_255 = xprv_254.derive_private(14);
const auto xpub_256 = xprv_255.derive_public(70);

BOOST_REQUIRE_EQUAL(xprv_254.lineage().depth, 254);
BOOST_REQUIRE(xprv_254);
// the maximal valid depth is 255
BOOST_REQUIRE_EQUAL(xprv_255.lineage().depth, 255);
BOOST_REQUIRE(xprv_255);

// depth overflows uint from 255 to 0
BOOST_REQUIRE_EQUAL(xpub_256.lineage().depth, 0);
// which creates invalid keys
BOOST_REQUIRE(!xpub_256);
}

BOOST_AUTO_TEST_CASE(hd_private__derive_public__hardened_must_not_overflow_depth__expected)
{
// xprv_254_depth was created from "xprv9s21ZrQH143K3QTDL4LXw2F7HEK3wJUD2nW2nRk4stbPy6cq3jPPqjiChkVvvNKmPGJxWUtg6LnF5kejMRNNU3TGtRBeJgk33yuGBxrMPHi"
// by manually setting the depth to 254
static const auto xprv_254_encoded = "xprvJ6xRbBsatSpgzr9c3hYbM2RohnAcHiiN74vQWqdRPx914xeq41t3u4rPXTsNxd5kvLSnqpsMx1cMx8cytMM5RbS7G54nwC5p5P5MQFSjf36";
const hd_private xprv_254(xprv_254_encoded);

const auto xprv_255 = xprv_254.derive_private(141);
const auto xpub_256 = xprv_255.derive_public(19287 + hd_first_hardened_key);

BOOST_REQUIRE_EQUAL(xprv_254.lineage().depth, 254);
BOOST_REQUIRE(xprv_254);
// the maximal valid depth is 255
BOOST_REQUIRE_EQUAL(xprv_255.lineage().depth, 255);
BOOST_REQUIRE(xprv_255);

// depth overflows uint from 255 to 0
BOOST_REQUIRE_EQUAL(xpub_256.lineage().depth, 0);
// which creates invalid keys
BOOST_REQUIRE(!xpub_256);
}

BOOST_AUTO_TEST_SUITE_END()
32 changes: 32 additions & 0 deletions test/wallet/hd_public.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,36 @@ BOOST_AUTO_TEST_CASE(hd_public__derive_public__long_seed__expected)
BOOST_REQUIRE_EQUAL(m0xH1yH2_pub.encoded(), "xpub6FnCn6nSzZAw5Tw7cgR9bi15UV96gLZhjDstkXXxvCLsUXBGXPdSnLFbdpq8p9HmGsApME5hQTZ3emM2rnY5agb9rXpVGyy3bdW6EEgAtqt");
}

BOOST_AUTO_TEST_CASE(hd_public__constructor__null_key_decodes_to_invalid__expected)
{
// the 11...14rcJhr is a serialization of a null key;
static const auto null_encoded = "1111111111111111111111111111111111111111111111111111111111111111111111111111114rcJhr";
const hd_private xpub_null(null_encoded);

BOOST_REQUIRE(!xpub_null);
}

BOOST_AUTO_TEST_CASE(hd_public__derive_public__must_not_overflow_depth__expected)
{
// xprv_254_depth was created from "xprv9s21ZrQH143K3QTDL4LXw2F7HEK3wJUD2nW2nRk4stbPy6cq3jPPqjiChkVvvNKmPGJxWUtg6LnF5kejMRNNU3TGtRBeJgk33yuGBxrMPHi"
// by manually setting the depth to 254
static const auto xprv_254_encoded = "xprvJ6xRbBsatSpgzr9c3hYbM2RohnAcHiiN74vQWqdRPx914xeq41t3u4rPXTsNxd5kvLSnqpsMx1cMx8cytMM5RbS7G54nwC5p5P5MQFSjf36";
const hd_private xprv_254(xprv_254_encoded);
hd_public xpub_254 = xprv_254.to_public();

const auto xpub_255 = xpub_254.derive_public(1);
const auto xpub_256 = xpub_255.derive_public(0);

BOOST_REQUIRE_EQUAL(xpub_254.lineage().depth, 254);
BOOST_REQUIRE(xpub_254);
// the maximal valid depth is 255
BOOST_REQUIRE_EQUAL(xpub_255.lineage().depth, 255);
BOOST_REQUIRE(xpub_255);

// depth overflows uint from 255 to 0
BOOST_REQUIRE_EQUAL(xpub_256.lineage().depth, 0);
// which creates invalid keys
BOOST_REQUIRE(!xpub_256);
}

BOOST_AUTO_TEST_SUITE_END()
Loading