What changed, and why it matters
This commit upgrades the Flyway database-migration library inside Sparrow Wallet from version 9.22.3 to 13.12.1 and rewrites the wallet-file validation code. The old validator inspected raw bytes of the H2 database file for suspicious keywords. The new validator parses the H2 file structure directly, checks that only expected internal map types and SQL DDL statements are present, and adds extra guards such as disabling Flyway placeholder replacement and rejecting account names containing a double quote. The change appears to be a hardening effort against malicious wallet files rather than a routine dependency bump.
Treat this commit as a security-hardening change. Review the new VALID_SCHEMA_DDL_PATTERN for completeness, ensure the allow-listed H2 data types cover all legitimate wallet states, and verify that Flyway 13.x does not introduce behavior changes that could break existing wallet migrations. Run the expanded DbPersistenceTest suite and consider fuzzing crafted wallet files against the new validator.
Security signals we found
Major dependency upgrade with accompanying defensive-code rewrite
Replacement of negative-pattern DDL filtering with strict positive-pattern DDL allow-list
Addition of H2 MVStore type-registry and undo-log validation
Disabling of Flyway placeholder replacement to prevent placeholder injection
Schema/account-name quote rejection before Flyway schema configuration
JDBC URL injection pattern tightened from ;\w+= to ;
Removal of broad Java object deserialization serializer already present
Evidence from the diff
The patch replaces a byte/regex-based H2 store validator with a structured MVStore parser. It now opens the wallet file read-only, validates the type registry against an allow-list, scans undo logs, reconstructs the meta table’s DDL statements, and matches each statement against a strict positive regex. It also removes a broad –add-reads JPMS workaround for Flyway, adds a schema-name quote check before Flyway configuration, and disables placeholder replacement. A test is added for loading an analyzed wallet with child wallets, including a non-ASCII account name.
Changed components
Sparrow Wallet database persistence layer (DbPersistence.java)Flyway database migration integrationH2 MVStore wallet file validationGradle build dependency and verification metadataInspect captured patch +316 / −69
### build.gradle
@@ -57,7 +57,7 @@ dependencies {
implementation('org.jdbi:jdbi3-sqlobject:3.51.0') {
exclude group: 'org.slf4j'
}
- implementation('org.flywaydb:flyway-core:9.22.3')
+ implementation('org.flywaydb:flyway-core:13.12.1')
implementation('org.fxmisc.richtext:richtextfx:0.11.7')
implementation('no.tornado:tornadofx-controls:1.0.4')
implementation('com.google.zxing:javase:3.5.4') {
@@ -176,8 +176,7 @@ application {
"--add-opens=javafx.graphics/javafx.scene.input=com.sparrowwallet.sparrow",
"--add-opens=java.base/java.net=com.sparrowwallet.sparrow",
"--add-opens=java.smartcardio/sun.security.smartcardio=com.sparrowwallet.sparrow",
- "--add-reads=kotlin.stdlib=kotlinx.coroutines.core",
- "--add-reads=org.flywaydb.core=java.desktop"]
+ "--add-reads=kotlin.stdlib=kotlinx.coroutines.core"]
if(os.macOsX) {
applicationDefaultJvmArgs += ["-Dprism.lcdtext=false", "-Dprism.maxTextureSize=8192", "-Xdock:name=Sparrow"]
@@ -270,8 +269,7 @@ jlink {
"--add-reads=com.sparrowwallet.merged.module=org.bouncycastle.provider",
"--add-reads=com.sparrowwallet.merged.module=kotlin.stdlib",
"--add-reads=com.sparrowwallet.merged.module=org.reactfx.reactfx",
- "--add-reads=kotlin.stdlib=kotlinx.coroutines.core",
- "--add-reads=org.flywaydb.core=java.desktop"]
+ "--add-reads=kotlin.stdlib=kotlinx.coroutines.core"]
if(os.windows) {
jvmArgs.addAll(["-Djavax.accessibility.assistive_technologies", "-Djavax.accessibility.screen_magnifier_present=false"])
### gradle/verification-keyring.keys
@@ -1097,6 +1097,47 @@ zc0mylSOyg+E1ZLP0GVRV0KiErGf989rF9XFQvOVGvgKHQ6C88JAQrTHWrw228B8
=Zchs
-----END PGP PUBLIC KEY BLOCK-----
+pub F3D1600878E85A3D
+sub 1C9F436B883DCCF6
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+
+xsFNBGAhOxEBEADdB5Jy2sSOndOMCTyk8IFIJYPogjXtN7CnyIlqr4jEB5G87TJf
+m7OxB95aIVS1vSA5ghCm88N1mKtW6jyYjgLFQbbyD9/X3ShVZjh8B2R4atL93SSK
+ppfSrQE3+EohYzu/X5agtzMhg4VplfY67yBUFXEqTucXpYumKLctrYtOUgDCgs4s
+4BixyAidsUxP9Uet2CsBiK7jlIe21EQz60QGvQ81pDaerwCxUsxtd4Fps+gSm6cY
+7Q+CrJRmV+rGpOt2f9NAyGdqqy71tjd5e7VC6GHyDxiB4xnDKQDGpfiMtGnxHPfe
+OaeYriCWQPpUIw7dg4eTVHKXlJ4FAc6W3Qdl0mlNKNIFizhcNxrie2FbLNxZYV+G
+B3GkDZt5Oas1O/iWcQt2QcalwTJWBY35kSl+uZilDAeU94vzuu1SQCZqmTtH82oa
+xp4eD4fqP5dB3qH/alao8IVlNRmbrEdbg2fZg4xVVmm+CF+gPnxswZRIptY2rsbb
+oEM8dWxakT5zvjox+v5J+qmEkE5WLlL/DlokOnJlAjJ3fkq6qGengQNjlrMIZjcL
+olHfr8gbYD2u4A7Dz9hls4fDz8OGqzHkSbNYm9hO9q5AWnqAWcSLPHkJ3mim91AW
+enWzfqoxNNR6L02mDvippqpfEoFTgqmZvYun8r1qTU5UaQnz3Od7QAf72wARAQAB
+zsFNBGAhOxEBEADJSkJ3U5vrwpDYr4k2L1Cawqh9/02nAuazvNbl2ocjVHaDD51H
+Jlm2DxwNg8obelCuVK1Iklc8MLO0BcRILu3AKCK/6sVzy75r3oTH6yjZtOCWiPbm
+xXHxUjmyOrZW+ICaUy29PnXag3owpWz2dEE1xllDLAgs0zl9lWZGFvq94epBWfrj
+0vd0KL61ubwfLAhG+KekPpUz3MwiT1kt96epBlkTtUGsH+u/RtGeDhbr8vdP9AX7
+JHr/UMZLGCajKy+70yFYCIfFBnu8veTldTVo05/fTNk5ADJOBZjcINkS0NGnpKmg
+L7xmQI8362Irg6mKihWLUb/2DBpGya/Rp0j8Qw9OspsJGMHUo7rTHSm462noWXvj
+q2nNmu8Vb3Xj4JVJsIWTaoDdODJ/eRnrTci/eMS6lcoaVX3Yp5oatdF8/2X9ZoR5
+Pg1HYDRyiibZvGrZS5UAp0o7ajqit7l0Jlc9Md0nIkalD1rcSTqAWA2TUWyYCKBb
+4ec5v/9uw8rg672VcbVUoWb+gEIxN9hJfijyrW4CGMdRpTr68tEivgliYLDcSvLY
+ZKRUldIKKpMntOtUKyUbSfwlJUKux6Hx2Ysi41zQD2mfg6/Mw6JhTa4lvbGrX9D6
+HxS2ct7o76O5uXWSDR5ATwmQsYug3OgVKIEo0UvKHogQFCWNlMwR6/Zy8wARAQAB
+wsF2BBgBCAAgFiEEDTXT9gB4ZVEmkI6K89FgCHjoWj0FAmAhOxECGwwACgkQ89Fg
+CHjoWj12GRAAnQ5g/B+KyCaGPokZcGh+KnieuUaS7txeS5fAzN40utUJA/JxwoG7
+AselbZ68QQIzG6XgNsFa5fEpJcC3o+mkjlVMvaNxPWRlLO7TMZ9N0AldwSCXdRLr
+Ebx8Uw1omXvC5d80QfknD1sDikPZhAGLPLK0PfM4DxUbLedxweDLALWt2C1BpnPK
+F26jQN4ZBrUBcLlXtkPOrAcxmCXsyS1yh+iM5hNK+s+CJ98tMlDw1U6oMXuW8lp9
+DloJXL7y11ftCPNr7vf4J/KbafBkKTP6AZpl7lJQ1k/1hZxE+Wk2bSgRuq03wbs2
+SudBw2xLDx0hl6JT60pCadWvN/hhpWGyqOYZRAY7BxrHYEMLhx0fYwHH9d/aagTH
+ipeYz+3S6C++C3pFXpa00geg8ytpg/KC8d+6rRr13lCfbV50O7nQ74rAXBx/4e8l
+6W3pRG5mX+00Z+WAPY9epujtHDT/94DmXZaJ35WeqSwUocXFUvJ2B6R7srxtuyPI
+uXlSJ8z+T2R5az0Jk2T7CqltUx/wQadosFq3jsvl+RtnBimwYIiS1UreX5mVbBZi
+GpTlaFNhxfdXW1XmmfGz+31CPxEIzHA5kbJzzaB/ofX3IjRSQB+rpxetnGCXKncl
+UUyruTMY5XMGD/VGCOLweOotdxJF6J5yWErznxlExP5YBIHvIQljCyU=
+=mqgl
+-----END PGP PUBLIC KEY BLOCK-----
+
pub F6665E960DA9AF2A
uid Jurgen Doll <admedfx@gmail.com>
### gradle/verification-metadata.xml
@@ -865,6 +865,12 @@
<sha512 value="f76e9b3ed394a06e6279392f92aec7b13d64309ce210c15a87a5cfdffd234b5f95958336db69d5ed80134cf7e7c89959cdccd524bb22d70d1792bb23ca3fe5f1" origin="Generated by Gradle"/>
</artifact>
</component>
+ <component group="io.netty" name="netty-bom" version="4.2.19.Final">
+ <artifact name="netty-bom-4.2.19.Final.pom">
+ <pgp value="0D35D3F60078655126908E8AF3D1600878E85A3D"/>
+ <sha512 value="ba98d7ccb91dedc37fd5ad3cb520806bf3f77b2b0a2329b8db66c3f385a021df06d09a725ab3d9e15b703bcf1e081f156bbd0ac28c2ac942687bfc84ceaaaaff" origin="Generated by Gradle"/>
+ </artifact>
+ </component>
<component group="io.opentelemetry" name="opentelemetry-bom" version="1.55.0">
<artifact name="opentelemetry-bom-1.55.0.module">
<sha512 value="60088608e69ac1abb28c765e726c5ee364f88bd016b42b24483b2f4b5eedafb6c6494155b125639a38b2cd1adf8c67d5ce9475ccde383885d1f817dcf2e1fccc" origin="Generated by Gradle"/>
@@ -874,6 +880,11 @@
<sha512 value="1b8f6769c9cb18dc5d1f48e02ac2af342ae3f95843510cd92030ecf51f68c4aecc6b2b84c114647065dcf2432d99618f340751c439b3d28b8a605750db6742a1" origin="Generated by Gradle"/>
</artifact>
</component>
+ <component group="io.opentelemetry" name="opentelemetry-bom" version="1.67.0">
+ <artifact name="opentelemetry-bom-1.67.0.pom">
+ <sha512 value="88ed8cc5255161c5b446f350507c114439dc753be16131c3fc1a7f19909ec0eb1c6c1cdd27e7879c32ec75e9fc0c0c0a47eb46ac154c5adca3593c72fd159fe2" origin="Generated by Gradle"/>
+ </artifact>
+ </component>
<component group="io.reactivex.rxjava2" name="rxjava" version="2.2.21">
<artifact name="rxjava-2.2.21.jar">
<sha512 value="df3a051d3b01337c7d229b8f33a06931389d5251766e15422aaee74b3894420abbf4c93775ebda4f7068e1c7a3ac17041aafaacb30b6dc94ebf7d62a46cfdce6" origin="Generated by Gradle"/>
@@ -1077,6 +1088,14 @@
<sha512 value="fd3753fd4c6718365f92979b4fc771d10e8cd6b3bd98aba71df5f8b66aa60d7a4b510859e4120f1c3223df2d68751d2a4700dec69e4d8b439cb4603bcb0c306f" origin="Generated by Gradle"/>
</artifact>
</component>
+ <component group="org.flywaydb" name="flyway-core" version="13.12.1">
+ <artifact name="flyway-core-13.12.1.jar">
+ <sha512 value="9950a94f092e61c761ecbf36380382283bd9178a93eea06f2fc6286b16a56b933d3c99bdb20b535735cb29b94ff9207479fbb4c8202ff0e9433dd915d5695291" origin="Generated by Gradle"/>
+ </artifact>
+ <artifact name="flyway-core-13.12.1.pom">
+ <sha512 value="25327913c710a49ae117f8342d2cd882b5084574de64229badcb304500f79b4622b9a63f2f4cebceee4d13e8b7567273b01041a29bf9fba1cd662ac9908390d9" origin="Generated by Gradle"/>
+ </artifact>
+ </component>
<component group="org.flywaydb" name="flyway-core" version="9.22.3">
<artifact name="flyway-core-9.22.3.jar">
<sha512 value="6f248a7d5a0f9cc3deed78f1eb7a2513c81e8394e2e234127285a0a02e952868954a003aec79db7142cfc50ecae02dbb36df075d23558aac26507863cbeaa889" origin="Generated by Gradle"/>
@@ -1085,6 +1104,11 @@
<sha512 value="00b208b2b81f2fd3acd9475af592a6bfe3c91333d114416b7399206591ff87d5a1413e6410ff20974db3ca6bdbe47ddc0e4b27cc51b16b3c7a4e624e3027d02d" origin="Generated by Gradle"/>
</artifact>
</component>
+ <component group="org.flywaydb" name="flyway-parent" version="13.12.1">
+ <artifact name="flyway-parent-13.12.1.pom">
+ <sha512 value="831dd45ebc3ecbfefd16d179cf769f5b28125d56473da41c0b302fbc5883f80810b1a8b25b02222c1ee19bf40afa8604fd9483c507712cddf780b9e31d38d3d9" origin="Generated by Gradle"/>
+ </artifact>
+ </component>
<component group="org.flywaydb" name="flyway-parent" version="9.22.3">
<artifact name="flyway-parent-9.22.3.pom">
<sha512 value="beb12916d42d97af347474b442cb1e4dbc5bd119036c53c030809c591ead9ed64df90a4265d2ad06a921f6692c98c962bc814414c89e2d56c87a8f97ca1b6036" origin="Generated by Gradle"/>
### src/main/java/com/sparrowwallet/sparrow/io/db/DbPersistence.java
@@ -22,14 +22,28 @@
import org.flywaydb.core.api.exception.FlywayValidateException;
import org.h2.api.JavaObjectSerializer;
import org.h2.mvstore.Cursor;
+import org.h2.mvstore.DataUtils;
import org.h2.mvstore.MVMap;
import org.h2.mvstore.MVStore;
import org.h2.mvstore.MVStoreException;
import org.h2.mvstore.WriteBuffer;
+import org.h2.mvstore.db.ValueDataType;
+import org.h2.mvstore.tx.TransactionStore;
+import org.h2.mvstore.tx.VersionedValueType;
+import org.h2.mvstore.type.BasicDataType;
import org.h2.mvstore.type.DataType;
import org.h2.mvstore.type.LongDataType;
+import org.h2.mvstore.type.MetaType;
+import org.h2.mvstore.type.StringDataType;
+import org.h2.result.RowFactory;
+import org.h2.result.SearchRow;
import org.h2.tools.ChangeFileEncryption;
import org.h2.util.JdbcUtils;
+import org.h2.value.CompareMode;
+import org.h2.value.TypeInfo;
+import org.h2.value.Typed;
+import org.h2.value.Value;
+import org.h2.value.VersionedValue;
import org.jdbi.v3.core.Jdbi;
import org.jdbi.v3.core.h2.H2DatabasePlugin;
import org.jdbi.v3.sqlobject.SqlObjectPlugin;
@@ -67,11 +81,36 @@ public class DbPersistence implements Persistence {
private static final String H2_USER = "sa";
private static final String H2_PASSWORD = "";
public static final String MIGRATION_RESOURCES_DIR = "com/sparrowwallet/sparrow/sql/";
- private static final Pattern JDBC_URL_INJECTION_PATTERN = Pattern.compile(";\\w+=");
+ private static final Pattern JDBC_URL_INJECTION_PATTERN = Pattern.compile(";");
private static final String H2_META_TABLE_MAP = "table.0";
- private static final Pattern INVALID_SCHEMA_DDL_PATTERN = Pattern.compile("LINKED\\s+TABLE|CREATE\\s+(?:FORCE\\s+|OR\\s+REPLACE\\s+)*(?:TRIGGER|ALIAS|AGGREGATE)"
- + "|\\bENGINE\\s+[\"'\\w]|\\b(?:FILE_READ|FILE_WRITE|CSVWRITE|CSVREAD|RUNSCRIPT|LINK_SCHEMA)\\b", Pattern.CASE_INSENSITIVE);
- private static final Pattern WALLET_SCHEMA_IDENTIFIER_PATTERN = Pattern.compile("\"wallet_[^\"\\x00-\\x1f]*\"");
+ private static final Typed[] H2_META_TABLE_COLUMNS = {TypeInfo.TYPE_INTEGER, TypeInfo.TYPE_INTEGER, TypeInfo.TYPE_INTEGER, TypeInfo.TYPE_VARCHAR};
+ private static final int H2_META_TABLE_SQL_COLUMN = 3;
+ private static final String H2_TYPE_REGISTRY_MAP = "_";
+ private static final String H2_PREPARED_TRANSACTIONS_MAP = "openTransactions";
+ private static final String H2_TABLE_MAP_PREFIX = "table.";
+ private static final String H2_INDEX_MAP_PREFIX = "index.";
+ private static final String H2_ROW_DATA_TYPE = "org.h2.mvstore.db.RowDataType$Factory";
+ private static final String H2_VALUE_DATA_TYPE = "org.h2.mvstore.db.ValueDataType$Factory";
+ private static final String H2_VERSIONED_VALUE_TYPE = "org.h2.mvstore.tx.VersionedValueType$Factory";
+ private static final Set<String> VALID_STORE_DATA_TYPES = Set.of(H2_ROW_DATA_TYPE, H2_VALUE_DATA_TYPE, H2_VERSIONED_VALUE_TYPE, "org.h2.mvstore.db.NullValueDataType",
+ "org.h2.mvstore.type.LongDataType", "org.h2.mvstore.type.ByteArrayDataType", "org.h2.mvstore.db.LobStorageMap$BlobMeta$Type", "org.h2.mvstore.db.LobStorageMap$BlobReference$Type");
+ private static final int MAX_DATA_TYPE_NAME_LENGTH = 256;
+ private static final String DDL_NAME = "(?:\"[^\"]*+\"|U&\"(?:[^\"\\\\]|\\\\\\\\|\\\\(?!00[2-6]|007[0-9a-eA-E])[0-9a-fA-F]{4}|\\\\\\+(?:0[1-9a-fA-F]|10)[0-9a-fA-F]{4})*+\")";
+ private static final String DDL_OBJECT = DDL_NAME + "\\." + DDL_NAME;
+ private static final String DDL_COLUMNS = "\\(" + DDL_NAME + "(?:, " + DDL_NAME + ")*+\\)";
+ private static final String DDL_INDEX_COLUMNS = "\\(" + DDL_NAME + "(?: NULLS FIRST)?(?:, " + DDL_NAME + "(?: NULLS FIRST)?)*+\\)";
+ private static final String DDL_TYPE = "(?:INTEGER|BIGINT|BOOLEAN|TIMESTAMP|DOUBLE PRECISION ARRAY|BINARY\\(\\d+\\)|(?:CHARACTER|BINARY) VARYING(?:\\(\\d+\\))?)";
+ private static final String DDL_COLUMN = DDL_NAME + " " + DDL_TYPE + "(?: DEFAULT (?:\\d+|CURRENT_TIMESTAMP)| GENERATED BY DEFAULT AS IDENTITY SEQUENCE " + DDL_OBJECT + ")?"
+ + "(?: SELECTIVITY \\d+)?(?: NOT NULL)?";
+ private static final String DDL_CONSTRAINT = "ALTER TABLE " + DDL_OBJECT + " ADD CONSTRAINT " + DDL_OBJECT;
+ private static final Pattern VALID_SCHEMA_DDL_PATTERN = Pattern.compile("SET CREATE_BUILD \\d+"
+ + "|CREATE USER IF NOT EXISTS " + DDL_NAME + " SALT '[0-9a-f]*' HASH '[0-9a-f]*' ADMIN"
+ + "|CREATE SCHEMA IF NOT EXISTS " + DDL_NAME + " AUTHORIZATION " + DDL_NAME
+ + "|CREATE SEQUENCE " + DDL_OBJECT + " START WITH \\d+(?: RESTART WITH \\d+)? BELONGS_TO_TABLE"
+ + "|CREATE CACHED TABLE " + DDL_OBJECT + "\\(\n " + DDL_COLUMN + "(?:,\n " + DDL_COLUMN + ")*+\n\\)"
+ + "|CREATE (?:PRIMARY KEY|(?:UNIQUE )?INDEX) " + DDL_OBJECT + " ON " + DDL_OBJECT + DDL_INDEX_COLUMNS
+ + "|" + DDL_CONSTRAINT + " (?:PRIMARY KEY|UNIQUE)" + DDL_COLUMNS + "(?: INDEX " + DDL_OBJECT + ")?"
+ + "|" + DDL_CONSTRAINT + " FOREIGN KEY" + DDL_COLUMNS + "(?: INDEX " + DDL_OBJECT + ")? REFERENCES " + DDL_OBJECT + DDL_COLUMNS + " NOCHECK");
private static final Map<String, String> VALID_COLUMN_DEFAULTS = Map.of("UTXOMIXDATA.MIXESDONE", "0", "FLYWAY_SCHEMA_HISTORY.INSTALLED_ON", "CURRENT_TIMESTAMP");
private static final String H2_BASE_TABLE_CLASS = "org.h2.mvstore.db.MVTable";
private static final String H2_ALLOWED_CLASSES_PROPERTY = "h2.allowedClasses";
@@ -108,7 +147,6 @@ public WalletAndKey loadWallet(Storage storage, CharSequence password, ECKey alr
ECKey encryptionKey = getEncryptionKey(password, storage.getWalletFile(), alreadyDerivedKey);
try {
- validateStore(storage, encryptionKey);
validateSchema(storage, MASTER_SCHEMA, encryptionKey);
migrate(storage, MASTER_SCHEMA, encryptionKey);
validateSchema(storage, MASTER_SCHEMA, encryptionKey);
@@ -448,53 +486,103 @@ private void cleanAndAddWallet(Storage storage, Wallet wallet, String password)
}
}
- private void validateStore(Storage storage, ECKey encryptionKey) throws StorageException {
- File walletFile = storage.getWalletFile();
+ private void validateStore(File walletFile, String filePassword) throws StorageException {
if(!walletFile.exists()) {
return;
}
- String filePassword = getFilePassword(encryptionKey);
- MVStore.Builder builder = new MVStore.Builder().fileName(walletFile.getAbsolutePath()).readOnly();
- if(filePassword != null) {
- builder.encryptionKey(filePassword.toCharArray());
- }
-
boolean storeOpened = false;
- byte[] metaPayload = null;
- try(MVStore store = builder.open()) {
- storeOpened = true;
- if(store.getMapNames().contains(H2_META_TABLE_MAP)) {
- ByteArrayOutputStream payload = new ByteArrayOutputStream();
- PageCapture capture = new PageCapture(payload);
- MVMap<Long, Object> metaTable = store.openMap(H2_META_TABLE_MAP, new MVMap.Builder<Long, Object>().keyType(LongDataType.INSTANCE).valueType(capture));
- Cursor<Long, Object> cursor = metaTable.cursor(null);
- while(cursor.hasNext()) {
- cursor.next();
+ List<String> schemaDdl = null;
+ try {
+ try(MVStore store = openValidationStore(walletFile, filePassword)) {
+ storeOpened = true;
+ if(store.hasData(H2_PREPARED_TRANSACTIONS_MAP)) {
+ throw new StorageException("This is not a valid wallet file.\n\nWallet file contains unexpected database objects.");
}
- metaPayload = payload.toByteArray();
+ if(store.hasMap(H2_TYPE_REGISTRY_MAP)) {
+ MVMap<String, String> typeRegistry = store.openMap(H2_TYPE_REGISTRY_MAP, new MVMap.Builder<String, String>().keyType(StringDataType.INSTANCE).valueType(new DataTypeNames()));
+ Cursor<String, String> registryCursor = typeRegistry.cursor(null);
+ while(registryCursor.hasNext()) {
+ registryCursor.next();
+ }
+ }
+ }
+
+ try(MVStore store = openValidationStore(walletFile, filePassword)) {
+ if(store.getMapNames().contains(H2_META_TABLE_MAP)) {
+ int metaTableId = DataUtils.parseHexInt(store.getMetaMap().get(DataUtils.META_NAME + H2_META_TABLE_MAP));
+ UndoRecords undoRecords = null;
+ for(String mapName : new ArrayList<>(store.getMapNames())) {
+ if(mapName.startsWith(TransactionStore.UNDO_LOG_NAME_PREFIX) && store.hasData(mapName)) {
+ if(undoRecords == null) {
+ undoRecords = new UndoRecords(store);
+ }
+ Cursor<Long, Integer> undoCursor = store.openMap(mapName, new MVMap.Builder<Long, Integer>().keyType(LongDataType.INSTANCE).valueType(undoRecords)).cursor(null);
+ while(undoCursor.hasNext()) {
+ undoCursor.next();
+ }
+ }
+ }
+
+ MVMap.Builder<Long, VersionedValue<?>> metaTableBuilder = new MVMap.Builder<>();
+ if(undoRecords != null && undoRecords.mapIds.contains(metaTableId)) {
+ metaTableBuilder.keyType((DataType)undoRecords.getKeyType(metaTableId)).valueType((DataType)undoRecords.getValueType(metaTableId));
+ } else {
+ RowFactory rowFactory = RowFactory.getDefaultRowFactory().createRowFactory(null, CompareMode.getInstance(null, 0), null, H2_META_TABLE_COLUMNS, null, false);
+ metaTableBuilder.keyType(LongDataType.INSTANCE).valueType((DataType)new VersionedValueType<>(rowFactory.getRowDataType()));
+ }
+ MVMap<Long, VersionedValue<?>> metaTable = store.openMap(H2_META_TABLE_MAP, metaTableBuilder);
+ List<String> statements = new ArrayList<>();
+ Cursor<Long, VersionedValue<?>> cursor = metaTable.cursor(null);
+ while(cursor.hasNext()) {
+ cursor.next();
+ for(Object value : Arrays.asList(cursor.getValue().getCurrentValue(), cursor.getValue().getCommittedValue())) {
+ if(value != null) {
+ Value sql = ((SearchRow)value).getValue(H2_META_TABLE_SQL_COLUMN);
+ statements.add(sql != null && sql.getValueType() == Value.VARCHAR ? sql.getString() : null);
+ }
+ }
+ }
+
+ schemaDdl = statements;
+ }
}
} catch(MVStoreException e) {
- if(metaPayload != null) {
+ if(schemaDdl != null) {
log.warn("Error closing wallet file store after validation", e);
} else if(!storeOpened) {
log.debug("Could not open wallet file store for validation, deferring to standard open", e);
return;
} else {
+ log.error("Error validating wallet file", e);
throw new StorageException("This is not a valid wallet file.\n\nWallet file could not be validated.");
}
+ } catch(RuntimeException e) {
+ log.error("Error validating wallet file", e);
+ throw new StorageException("This is not a valid wallet file.\n\nWallet file could not be validated.");
}
- if(metaPayload == null) {
+ if(schemaDdl == null) {
throw new StorageException("This is not a valid wallet file.\n\nWallet file could not be validated.");
}
- String rawDdl = new String(metaPayload, StandardCharsets.ISO_8859_1);
- String schemaDdl = WALLET_SCHEMA_IDENTIFIER_PATTERN.matcher(rawDdl).replaceAll(" ").replaceAll("[^A-Za-z0-9_]", " ");
- if(INVALID_SCHEMA_DDL_PATTERN.matcher(schemaDdl).find()) {
- throw new StorageException("This is not a valid wallet file.\n\nWallet file contains unexpected database objects.");
+ for(String statement : schemaDdl) {
+ if(statement == null || !VALID_SCHEMA_DDL_PATTERN.matcher(statement).matches()) {
+ String loggedStatement = statement == null ? null : statement.replaceAll("'[^']*'", "'?'");
+ log.error("Wallet file contains unexpected statement: " + (loggedStatement != null && loggedStatement.length() > 1000 ? loggedStatement.substring(0, 1000) + "..." : loggedStatement));
+ throw new StorageException("This is not a valid wallet file.\n\nWallet file contains unexpected database objects.");
+ }
+ }
+ }
+
+ private MVStore openValidationStore(File walletFile, String filePassword) {
+ MVStore.Builder builder = new MVStore.Builder().fileName(walletFile.getAbsolutePath()).readOnly();
+ if(filePassword != null) {
+ builder.encryptionKey(filePassword.toCharArray());
}
+
+ return builder.open();
}
private void migrate(Storage storage, String schema, ECKey encryptionKey) throws StorageException {
@@ -882,7 +970,12 @@ private Jdbi getJdbi(Storage storage, String password) throws StorageException {
}
private Flyway getFlyway(Storage storage, String schema, String password, File resourcesDir) throws StorageException {
- return Flyway.configure().cleanDisabled(false).dataSource(getDataSource(storage, password)).locations("filesystem:" + resourcesDir.getAbsolutePath()).schemas(schema).failOnMissingLocations(true).load();
+ if(schema.contains("\"")) {
+ throw new StorageException("This is not a valid wallet file.\n\nWallet file contains an invalid account name.");
+ }
+
+ return Flyway.configure().cleanDisabled(false).dataSource(getDataSource(storage, password)).locations("filesystem:" + resourcesDir.getAbsolutePath()).schemas(schema)
+ .placeholderReplacement(false).failOnMissingLocations(true).load();
}
//Flyway does not support JPMS yet, so the migration files are extracted to a temp dir in order to avoid classloader encapsulation issues
@@ -918,6 +1011,7 @@ private HikariDataSource getDataSource(Storage storage, String password) throws
private HikariDataSource createDataSource(File walletFile, String password) throws StorageException {
try {
+ validateStore(walletFile, password);
Class.forName("org.h2.Driver");
HikariConfig config = new HikariConfig();
config.setJdbcUrl(getUrl(walletFile, password));
@@ -1114,76 +1208,138 @@ public String toString() {
}
}
- private static class NoDeserializationSerializer implements JavaObjectSerializer {
- @Override
- public byte[] serialize(Object obj) {
- throw new UnsupportedOperationException("Serialization of Java objects is not supported in wallet files.");
+ private static class UndoRecords extends BasicDataType<Integer> {
+ private final MVStore store;
+ private final MVMap<String, DataType<?>> typeRegistry;
+ private final Set<Integer> mapIds = new HashSet<>();
+
+ public UndoRecords(MVStore store) {
+ this.store = store;
+ this.typeRegistry = store.openMap(H2_TYPE_REGISTRY_MAP, new MVMap.Builder<String, DataType<?>>().keyType(StringDataType.INSTANCE).valueType(new MetaType<>(null, store.backgroundExceptionHandler)));
}
@Override
- public Object deserialize(byte[] bytes) {
- throw new UnsupportedOperationException("Deserialization of Java objects is not supported in wallet files.");
+ public Integer read(ByteBuffer buff) {
+ int mapId = DataUtils.readVarInt(buff);
+ if(mapId >= 0) {
+ String mapName = store.getMapName(mapId);
+ if(mapName == null || !(mapName.startsWith(H2_TABLE_MAP_PREFIX) || mapName.startsWith(H2_INDEX_MAP_PREFIX))) {
+ throw new IllegalArgumentException("Unexpected undo log map " + mapName);
+ }
+
+ getKeyType(mapId).read(buff);
+ if(buff.get() == 1) {
+ getValueType(mapId).read(buff);
+ }
+ mapIds.add(mapId);
+ }
+
+ return mapId;
}
- }
- private static class PageCapture implements DataType<Object> {
- private final ByteArrayOutputStream payload;
+ public DataType<?> getKeyType(int mapId) {
+ return getDataType(mapId, "key", new ValueDataType());
+ }
- public PageCapture(ByteArrayOutputStream payload) {
- this.payload = payload;
+ public DataType<?> getValueType(int mapId) {
+ return getDataType(mapId, "val", new VersionedValueType<>(new ValueDataType()));
}
- private void capture(ByteBuffer buffer) {
- int remaining = buffer.remaining();
- if(remaining > 0) {
- byte[] bytes = new byte[remaining];
- buffer.get(bytes);
- payload.write(bytes, 0, bytes.length);
+ private DataType<?> getDataType(int mapId, String configKey, DataType<?> defaultType) {
+ String typeKey = DataUtils.parseMap(store.getMetaMap().get(DataUtils.META_MAP + Integer.toHexString(mapId))).get(configKey);
+ if(typeKey == null) {
+ return defaultType;
}
+
+ DataType<?> dataType = typeRegistry.get(typeKey);
+ if(dataType == null) {
+ throw new IllegalArgumentException("Unknown data type " + typeKey);
+ }
+
+ return dataType;
}
@Override
- public Object read(ByteBuffer buffer) {
- capture(buffer);
- return null;
+ public int getMemory(Integer obj) {
+ return 0;
}
@Override
- public void read(ByteBuffer buffer, Object storage, int len) {
- capture(buffer);
+ public void write(WriteBuffer buff, Integer obj) {
+ throw new UnsupportedOperationException();
}
@Override
- public void write(WriteBuffer buffer, Object obj) {
+ public Integer[] createStorage(int size) {
+ return new Integer[size];
}
+ }
+ private static class DataTypeNames extends BasicDataType<String> {
@Override
- public void write(WriteBuffer buffer, Object storage, int len) {
+ public String read(ByteBuffer buff) {
+ return readDataType(buff, false);
+ }
+
+ private static String readDataType(ByteBuffer buff, boolean nested) {
+ int length = DataUtils.readVarInt(buff);
+ if(length < 0 || length > MAX_DATA_TYPE_NAME_LENGTH) {
+ throw new IllegalArgumentException("Invalid data type name length " + length);
+ }
+
+ String className = DataUtils.readString(buff, length);
+ if(!VALID_STORE_DATA_TYPES.contains(className) || (nested && className.equals(H2_VERSIONED_VALUE_TYPE))) {
+ throw new IllegalArgumentException("Unexpected data type " + className);
+ }
+
+ if(className.equals(H2_ROW_DATA_TYPE)) {
+ DataUtils.readVarInt(buff);
+ skipIntArray(buff);
+ skipIntArray(buff);
+ buff.get();
+ } else if(className.equals(H2_VALUE_DATA_TYPE)) {
+ skipIntArray(buff);
+ DataUtils.readVarInt(buff);
+ skipIntArray(buff);
+ buff.get();
+ } else if(className.equals(H2_VERSIONED_VALUE_TYPE)) {
+ readDataType(buff, true);
+ }
+
+ return className;
+ }
+
+ private static void skipIntArray(ByteBuffer buff) {
+ for(int i = DataUtils.readVarInt(buff) - 1; i > 0; i--) {
+ DataUtils.readVarInt(buff);
+ }
}
@Override
- public int compare(Object a, Object b) {
+ public int getMemory(String obj) {
return 0;
}
@Override
- public int binarySearch(Object key, Object storage, int size, int initialGuess) {
- return 0;
+ public void write(WriteBuffer buff, String obj) {
+ throw new UnsupportedOperationException();
}
@Override
- public int getMemory(Object obj) {
- return 0;
+ public String[] createStorage(int size) {
+ return new String[size];
}
+ }
+ private static class NoDeserializationSerializer implements JavaObjectSerializer {
@Override
- public boolean isMemoryEstimationAllowed() {
- return false;
+ public byte[] serialize(Object obj) {
+ throw new UnsupportedOperationException("Serialization of Java objects is not supported in wallet files.");
}
@Override
- public Object[] createStorage(int size) {
- return new Object[size];
+ public Object deserialize(byte[] bytes) {
+ throw new UnsupportedOperationException("Deserialization of Java objects is not supported in wallet files.");
}
}
}
### src/test/java/com/sparrowwallet/sparrow/io/DbPersistenceTest.java
@@ -10,6 +10,7 @@
import com.sparrowwallet.drongo.protocol.Sha256Hash;
import com.sparrowwallet.drongo.wallet.Keystore;
import com.sparrowwallet.drongo.wallet.KeystoreSource;
+import com.sparrowwallet.drongo.wallet.StandardAccount;
import com.sparrowwallet.drongo.wallet.Wallet;
import com.sparrowwallet.drongo.wallet.WalletModel;
import org.junit.jupiter.api.AfterEach;
@@ -115,6 +116,33 @@ public void domainRejected() throws Exception {
assertRejected(buildWalletFile("create domain wallet_master.dm as int default 0"));
}
+ @Test
+ public void analyzedWalletWithChildWalletsLoads() throws Exception {
+ Storage storage = createUnencryptedWallet("Savings");
+ Wallet wallet = createWallet("Savings");
+ storage.saveWallet(wallet);
+ storage.saveWallet(wallet.addChildWallet(StandardAccount.ACCOUNT_1));
+ Wallet namedAccount = wallet.addChildWallet(StandardAccount.ACCOUNT_2);
+ namedAccount.setName("Épargne");
+ storage.saveWallet(namedAccount);
+ storage.closeAndWait();
+
+ String path = storage.getWalletFile().getAbsolutePath();
+ String url = "jdbc:h2:" + path.substring(0, path.length() - ".mv.db".length()) + ";DATABASE_TO_UPPER=false;DB_CLOSE_ON_EXIT=FALSE";
+ try(Connection connection = DriverManager.getConnection(url, "sa", ""); Statement statement = connection.createStatement()) {
+ statement.execute("ANALYZE");
+ }
+
+ Storage loaded = new Storage(PersistenceType.DB, storage.getWalletFile());
+ try {
+ Wallet loadedWallet = loaded.loadUnencryptedWallet().getWallet();
+ Assertions.assertTrue(loadedWallet.isValid());
+ Assertions.assertEquals(2, loadedWallet.getChildWallets().size());
+ } finally {
+ loaded.closeAndWait();
+ }
+ }
+
private static final String TEST_XPUB = "xpub6BrhGFTWPd3DXo8s2BPxHHzCmBCyj8QvamcEUaq8EDwnwXpvvcU9LzpJqENHcqHkqwTn2vPhynGVoEqj3PAB3NxnYZrvCsSfoCniJKaggdy";
private Wallet createWallet(String walletName) {Why this scored 57/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.