refuse an extended private key in place of an xpub in imported wallet files, and use the public key of a private hdkey in a scanned output descriptor
What changed, and why it matters
This commit fixes a security issue in Sparrow Wallet where wallet import files or QR scans that were supposed to contain only public extended keys (xpubs) could accidentally or maliciously contain private extended keys (xprvs). The wallet now rejects xprvs in those places and, when scanning output descriptors, derives the public key from any private key instead of using the private key directly. This prevents private key material from being loaded into watch-only or multisig wallet setups where it does not belong.
Users should upgrade to the Sparrow Wallet release containing this commit. Avoid importing wallet files or QR descriptors from untrusted sources, and verify that any exported wallet configuration files contain only xpubs, not xprvs.
Security signals we found
Rejection of extended private keys where extended public keys are expected
Public-key derivation from private HD keys in scanned output descriptors
Addition of defensive validation helper across multiple wallet import formats
New unit test asserting ImportException on xprv-in-xpub field
Evidence from the diff
The patch adds a new default method getExtendedPublicKey(String) in FileImport that calls ExtendedKey.fromDescriptor() and throws ImportException if the parsed key is not pubkey-only. Multiple wallet import parsers (CaravanMultisig, CoboVaultSinglesig, ColdcardMultisig, ColdcardSinglesig, Electrum) are updated to use this helper instead of ExtendedKey.fromDescriptor() directly. In QRScanDialog, getOutputDescriptor now calls a new getExtendedPublicKey(CryptoHDKey) helper that derives the public key from a private HD key before constructing the deterministic key, ensuring output descriptors never carry private key bytes. A test is added verifying ColdcardMultisig import rejects an xprv substituted for an xpub.
Changed components
Sparrow Wallet wallet import parsers (CaravanMultisig, CoboVaultSinglesig, ColdcardMultisig, ColdcardSinglesig, Electrum)QRScanDialog output descriptor scanningFileImport interfaceInspect captured patch +52 / −29
### src/main/java/com/sparrowwallet/sparrow/control/QRScanDialog.java
@@ -578,25 +578,30 @@ private ExtendedKey getExtendedKey(CryptoHDKey cryptoHDKey) {
if(cryptoHDKey.isPrivateKey()) {
DeterministicKey prvKey = HDKeyDerivation.createMasterPrivKeyFromBytes(Arrays.copyOfRange(cryptoHDKey.getKey(), 1, 33), cryptoHDKey.getChainCode(), List.of(ChildNumber.ZERO));
return new ExtendedKey(prvKey, new byte[4], ChildNumber.ZERO);
- } else {
- ChildNumber lastChild = ChildNumber.ZERO;
- int depth = 1;
- byte[] parentFingerprint = new byte[4];
- if(cryptoHDKey.getOrigin() != null) {
- if(!cryptoHDKey.getOrigin().getComponents().isEmpty()) {
- PathComponent lastComponent = cryptoHDKey.getOrigin().getComponents().get(cryptoHDKey.getOrigin().getComponents().size() - 1);
- if(lastComponent instanceof IndexPathComponent indexPathComponent) {
- lastChild = new ChildNumber(indexPathComponent.getIndex(), indexPathComponent.isHardened());
- }
- depth = cryptoHDKey.getOrigin().getComponents().size();
- }
- if(cryptoHDKey.getParentFingerprint() != null) {
- parentFingerprint = cryptoHDKey.getParentFingerprint();
+ }
+
+ return getExtendedPublicKey(cryptoHDKey);
+ }
+
+ private ExtendedKey getExtendedPublicKey(CryptoHDKey cryptoHDKey) {
+ byte[] publicKey = cryptoHDKey.isPrivateKey() ? ECKey.fromPrivate(new BigInteger(1, cryptoHDKey.getKey())).getPubKey() : cryptoHDKey.getKey();
+ ChildNumber lastChild = ChildNumber.ZERO;
+ int depth = 1;
+ byte[] parentFingerprint = new byte[4];
+ if(cryptoHDKey.getOrigin() != null) {
+ if(!cryptoHDKey.getOrigin().getComponents().isEmpty()) {
+ PathComponent lastComponent = cryptoHDKey.getOrigin().getComponents().get(cryptoHDKey.getOrigin().getComponents().size() - 1);
+ if(lastComponent instanceof IndexPathComponent indexPathComponent) {
+ lastChild = new ChildNumber(indexPathComponent.getIndex(), indexPathComponent.isHardened());
}
+ depth = cryptoHDKey.getOrigin().getComponents().size();
+ }
+ if(cryptoHDKey.getParentFingerprint() != null) {
+ parentFingerprint = cryptoHDKey.getParentFingerprint();
}
- DeterministicKey pubKey = new DeterministicKey(List.of(lastChild), cryptoHDKey.getChainCode(), cryptoHDKey.getKey(), depth, parentFingerprint);
- return new ExtendedKey(pubKey, parentFingerprint, lastChild);
}
+ DeterministicKey pubKey = new DeterministicKey(List.of(lastChild), cryptoHDKey.getChainCode(), publicKey, depth, parentFingerprint);
+ return new ExtendedKey(pubKey, parentFingerprint, lastChild);
}
private ECKey getKey(CryptoHDKey cryptoHDKey) {
@@ -618,7 +623,7 @@ private OutputDescriptor getOutputDescriptor(CryptoOutput cryptoOutput) {
Map<ExtendedKey, KeyDerivation> extendedPublicKeys = new LinkedHashMap<>();
Map<ExtendedKey, String> extendedPublicKeyLabels = new LinkedHashMap<>();
for(CryptoHDKey cryptoHDKey : multiKey.getHdKeys()) {
- ExtendedKey extendedKey = getExtendedKey(cryptoHDKey);
+ ExtendedKey extendedKey = getExtendedPublicKey(cryptoHDKey);
KeyDerivation keyDerivation = getKeyDerivation(cryptoHDKey.getOrigin());
if(extendedPublicKeys.put(extendedKey, keyDerivation) != null) {
throw new IllegalArgumentException("Duplicate extended keys are not supported");
@@ -631,7 +636,7 @@ private OutputDescriptor getOutputDescriptor(CryptoOutput cryptoOutput) {
} else if(cryptoOutput.getEcKey() != null) {
throw new IllegalArgumentException("EC keys are currently unsupported");
} else if(cryptoOutput.getHdKey() != null) {
- ExtendedKey extendedKey = getExtendedKey(cryptoOutput.getHdKey());
+ ExtendedKey extendedKey = getExtendedPublicKey(cryptoOutput.getHdKey());
KeyDerivation keyDerivation = getKeyDerivation(cryptoOutput.getHdKey().getOrigin());
return new OutputDescriptor(scriptType, extendedKey, keyDerivation, cryptoOutput.getHdKey().getName());
}
### src/main/java/com/sparrowwallet/sparrow/io/CaravanMultisig.java
@@ -2,7 +2,6 @@
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
-import com.sparrowwallet.drongo.ExtendedKey;
import com.sparrowwallet.drongo.KeyDerivation;
import com.sparrowwallet.drongo.Network;
import com.sparrowwallet.drongo.policy.Policy;
@@ -66,7 +65,7 @@ public Wallet importWallet(InputStream inputStream, String password) throws Impo
keystore.setKeyDerivation(new KeyDerivation(extKey.xfp, scriptType.getDefaultDerivationPath()));
}
- keystore.setExtendedPublicKey(ExtendedKey.fromDescriptor(extKey.xpub));
+ keystore.setExtendedPublicKey(getExtendedPublicKey(extKey.xpub));
WalletModel walletModel = WalletModel.fromType(extKey.method);
if(walletModel == null) {
### src/main/java/com/sparrowwallet/sparrow/io/CoboVaultSinglesig.java
@@ -53,7 +53,7 @@ public Keystore getKeystore(PolicyType policyType, ScriptType scriptType, InputS
keystore.setSource(KeystoreSource.HW_AIRGAPPED);
keystore.setWalletModel(getWalletModel());
keystore.setKeyDerivation(new KeyDerivation(coboKeystore.MasterFingerprint.toLowerCase(Locale.ROOT), "m/" + coboKeystore.AccountKeyPath, true));
- keystore.setExtendedPublicKey(ExtendedKey.fromDescriptor(coboKeystore.ExtPubKey));
+ keystore.setExtendedPublicKey(getExtendedPublicKey(coboKeystore.ExtPubKey));
ExtendedKey.Header header = ExtendedKey.Header.fromExtendedKey(coboKeystore.ExtPubKey);
if(header.getDefaultScriptType() != scriptType) {
### src/main/java/com/sparrowwallet/sparrow/io/ColdcardMultisig.java
@@ -81,16 +81,16 @@ public Keystore getKeystoreMultisig(PolicyType policyType, ScriptType scriptType
throw new ImportException("This wallet's script type (" + scriptType + ") does not match the " + getName() + " script type (" + header.getDefaultScriptType() + ")");
}
keystore.setKeyDerivation(new KeyDerivation(cck.xfp, cck.path, true));
- keystore.setExtendedPublicKey(ExtendedKey.fromDescriptor(cck.xpub));
+ keystore.setExtendedPublicKey(getExtendedPublicKey(cck.xpub));
} else if(scriptType.equals(ScriptType.P2SH)) {
keystore.setKeyDerivation(new KeyDerivation(cck.xfp, cck.p2sh_deriv, true));
- keystore.setExtendedPublicKey(ExtendedKey.fromDescriptor(cck.p2sh));
+ keystore.setExtendedPublicKey(getExtendedPublicKey(cck.p2sh));
} else if(scriptType.equals(ScriptType.P2SH_P2WSH)) {
keystore.setKeyDerivation(new KeyDerivation(cck.xfp, cck.p2wsh_p2sh_deriv != null ? cck.p2wsh_p2sh_deriv : cck.p2sh_p2wsh_deriv, true));
- keystore.setExtendedPublicKey(ExtendedKey.fromDescriptor(cck.p2wsh_p2sh != null ? cck.p2wsh_p2sh : cck.p2sh_p2wsh));
+ keystore.setExtendedPublicKey(getExtendedPublicKey(cck.p2wsh_p2sh != null ? cck.p2wsh_p2sh : cck.p2sh_p2wsh));
} else if(scriptType.equals(ScriptType.P2WSH)) {
keystore.setKeyDerivation(new KeyDerivation(cck.xfp, cck.p2wsh_deriv, true));
- keystore.setExtendedPublicKey(ExtendedKey.fromDescriptor(cck.p2wsh));
+ keystore.setExtendedPublicKey(getExtendedPublicKey(cck.p2wsh));
} else {
throw new ImportException("Correct derivation not found for script type: " + scriptType);
}
@@ -185,7 +185,7 @@ public Wallet importWallet(InputStream inputStream, String password) throws Impo
keystore.setSource(KeystoreSource.HW_AIRGAPPED);
keystore.setWalletModel(WalletModel.COLDCARD);
keystore.setKeyDerivation(new KeyDerivation(key, derivation, true));
- keystore.setExtendedPublicKey(ExtendedKey.fromDescriptor(value));
+ keystore.setExtendedPublicKey(getExtendedPublicKey(value));
wallet.makeLabelsUnique(keystore);
wallet.getKeystores().add(keystore);
}
### src/main/java/com/sparrowwallet/sparrow/io/ColdcardSinglesig.java
@@ -3,7 +3,6 @@
import com.google.gson.Gson;
import com.google.gson.JsonElement;
import com.google.gson.reflect.TypeToken;
-import com.sparrowwallet.drongo.ExtendedKey;
import com.sparrowwallet.drongo.KeyDerivation;
import com.sparrowwallet.drongo.policy.Policy;
import com.sparrowwallet.drongo.policy.PolicyType;
@@ -96,7 +95,7 @@ public Keystore getKeystore(PolicyType policyType, ScriptType scriptType, InputS
keystore.setSource(KeystoreSource.HW_AIRGAPPED);
keystore.setWalletModel(getWalletModel());
keystore.setKeyDerivation(new KeyDerivation(masterFingerprint, ck.deriv, true));
- keystore.setExtendedPublicKey(ExtendedKey.fromDescriptor(ck.xpub));
+ keystore.setExtendedPublicKey(getExtendedPublicKey(ck.xpub));
return keystore;
}
### src/main/java/com/sparrowwallet/sparrow/io/Electrum.java
@@ -134,7 +134,7 @@ public Wallet importWallet(InputStream inputStream, String password) throws Impo
for(ElectrumKeystore ek : ew.keystores.values()) {
Keystore keystore = new Keystore();
- ExtendedKey xPub = ExtendedKey.fromDescriptor(ek.xpub);
+ ExtendedKey xPub = getExtendedPublicKey(ek.xpub);
String derivationPath = ek.derivation;
if(derivationPath == null) {
derivationPath = "m/0";
### src/main/java/com/sparrowwallet/sparrow/io/FileImport.java
@@ -1,7 +1,18 @@
package com.sparrowwallet.sparrow.io;
+import com.sparrowwallet.drongo.ExtendedKey;
+
import java.io.File;
public interface FileImport extends ImportExport {
boolean isEncrypted(File file);
+
+ default ExtendedKey getExtendedPublicKey(String extendedPublicKey) throws ImportException {
+ ExtendedKey extendedKey = ExtendedKey.fromDescriptor(extendedPublicKey);
+ if(!extendedKey.getKey().isPubKeyOnly()) {
+ throw new ImportException("The file contains an extended private key where an extended public key was expected.");
+ }
+
+ return extendedKey;
+ }
}
### src/test/java/com/sparrowwallet/sparrow/io/ColdcardMultisigTest.java
@@ -95,6 +95,15 @@ public void importWalletPolicyVariants() throws Exception {
Assertions.assertThrows(ImportException.class, () -> importEdited("Format: P2WSH", "Format: P2WSH\nFormat: P2SH"));
}
+ @Test
+ public void importWalletRefusesExtendedPrivateKey() {
+ String xpub = "xpub6FMGmJccz6dqLo9TMmXYPpZ7HUDm71RHHSTXqTUgkyP9TZmF2uexoB7qttEBtHaotopPwfAVfKfwmdEjCGabVpND1m7ix2AW2LxPuNfLZhi";
+ String xprv = "xprv9uHRZZhk6KAJC1avXpDAp4MDc3sQKNxDiPvvkX8Br5ngLNv1TxvUxt4cV1rGL5hj6KCesnDYUhd7oWgT11eZG7XnxHrnYeSvkzY7d2bhkJ7";
+ ImportException e = Assertions.assertThrows(ImportException.class, () -> importEdited(xpub, xprv));
+ Throwable cause = e.getCause() == null ? e : e.getCause();
+ Assertions.assertTrue(cause.getMessage().contains("extended private key"));
+ }
+
@Test
public void importWallet2() throws ImportException {
Network.set(Network.TESTNET);Why this scored 60/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.