SQLite Wallet Support

.gitattributes

@@ -1 +1,2 @@
 src/clientversion.cpp export-subst
+depends/patches/sqlite/autosetup-fixup.patch whitespace=-space-before-tab

.github/workflows/ci-master.yml

@@ -239,7 +239,7 @@ jobs:
 
         env PKG_CONFIG_PATH="$(realpath depends/$HOST_TRIPLET/lib/pkgconfig):$PKG_CONFIG_PATH" \
         cmake -G Ninja -DCMAKE_TOOLCHAIN_FILE=$(realpath depends/$HOST_TRIPLET/toolchain.cmake) \
-        -DBUILD_CLI=ON -DBUILD_TESTS=ON -DENABLE_CRASH_HOOKS=ON -DBUILD_GUI=ON \
+        -DBUILD_CLI=ON -DBUILD_TESTS=ON -DENABLE_CRASH_HOOKS=ON -DBUILD_GUI=ON -DENABLE_SQLITE_WALLET=ON \
         -DCMAKE_BUILD_TYPE=${{ matrix.build_type }} \
         $CMAKE_EXTRA_FLAGS \
         -S$(realpath .) -B$(realpath build)
@@ -259,11 +259,55 @@ jobs:
 
         env PKG_CONFIG_PATH="$(realpath depends/$HOST_TRIPLET/lib/pkgconfig):$PKG_CONFIG_PATH" \
         cmake -G Ninja -DCMAKE_TOOLCHAIN_FILE=$(realpath depends/$HOST_TRIPLET/toolchain.cmake) \
-        -DBUILD_CLI=ON -DBUILD_TESTS=OFF -DENABLE_CRASH_HOOKS=ON \
+        -DBUILD_CLI=ON -DBUILD_TESTS=ON -DENABLE_CRASH_HOOKS=ON -DENABLE_SQLITE_WALLET=ON \
         -DCMAKE_BUILD_TYPE=${{ matrix.build_type }} \
         $CMAKE_EXTRA_FLAGS \
         -DBUILD_GUI=ON -S$(realpath .) -B$(realpath build)
         cd build && ninja
+    - name: Build BDB-only Wallet Tests (Windows RelWithDebInfo)
+      if: matrix.is_windows && matrix.build_type == 'RelWithDebInfo'
+      run: |
+        set -exo pipefail
+        export HOST_TRIPLET=$(x86_64-w64-mingw32-gcc -dumpmachine)
+        BDB_JOBS=$(nproc)
+        if [ "$BDB_JOBS" -gt 20 ]; then
+          BDB_JOBS=20
+        fi
+
+        make -C depends -j$BDB_JOBS HOST=$HOST_TRIPLET NO_SQLITE=1
+        test ! -e "depends/$HOST_TRIPLET/include/sqlite3.h"
+        test ! -e "depends/$HOST_TRIPLET/lib/libsqlite3.a"
+
+        env PKG_CONFIG_PATH="$(realpath depends/$HOST_TRIPLET/lib/pkgconfig):$PKG_CONFIG_PATH" \
+        cmake -G Ninja -DCMAKE_TOOLCHAIN_FILE=$(realpath depends/$HOST_TRIPLET/toolchain.cmake) \
+        -DBUILD_CLI=OFF -DBUILD_DAEMON=OFF -DBUILD_GUI=OFF -DBUILD_TESTS=ON \
+        -DENABLE_CRASH_HOOKS=ON -DENABLE_SQLITE_WALLET=OFF -DWITH_BDB=ON \
+        -DCLIENT_VERSION_IS_RELEASE=true -DCMAKE_BUILD_TYPE=${{ matrix.build_type }} \
+        -S$(realpath .) -B$(realpath build-windows-bdb-only)
+        cmake --build build-windows-bdb-only --target test_firo --parallel "$BDB_JOBS"
+
+        BDB_AUDIT_DIR=$(mktemp -d)
+        x86_64-w64-mingw32-ar -t build-windows-bdb-only/lib/libfiro_wallet.a \
+          > "$BDB_AUDIT_DIR/wallet-members"
+        x86_64-w64-mingw32-nm -C build-windows-bdb-only/lib/libfiro_wallet.a \
+          > "$BDB_AUDIT_DIR/wallet-symbols"
+        x86_64-w64-mingw32-objdump -p build-windows-bdb-only/bin/test_firo.exe \
+          > "$BDB_AUDIT_DIR/test-firo-pe"
+        if grep -Eiq 'sqlite\.cpp|win32_file_lifecycle' \
+            "$BDB_AUDIT_DIR/wallet-members"; then
+          echo "BDB-only Windows wallet archive contains a SQLite wallet object"
+          exit 1
+        fi
+        if grep -Eq 'sqlite3_|(^|[^[:alnum:]_])SQLite(Database|Batch)(::|\()|win32_wallet::' \
+            "$BDB_AUDIT_DIR/wallet-symbols"; then
+          echo "BDB-only Windows wallet archive contains a SQLite wallet symbol"
+          exit 1
+        fi
+        if grep -Eiq 'DLL Name:.*sqlite' \
+            "$BDB_AUDIT_DIR/test-firo-pe"; then
+          echo "BDB-only Windows test executable imports SQLite"
+          exit 1
+        fi
     - name: Build Firo (Mac)
       if: matrix.is_mac
       run: |
@@ -279,11 +323,67 @@ jobs:
 
         env PKG_CONFIG_PATH="$(pwd)/depends/$HOST_TRIPLET/lib/pkgconfig:$PKG_CONFIG_PATH" \
         cmake -G Ninja -DCMAKE_TOOLCHAIN_FILE=$(pwd)/depends/$HOST_TRIPLET/toolchain.cmake \
-        -DBUILD_CLI=ON -DBUILD_TESTS=OFF -DENABLE_CRASH_HOOKS=ON -DBUILD_GUI=ON \
+        -DBUILD_CLI=ON -DBUILD_TESTS=ON -DENABLE_CRASH_HOOKS=ON -DBUILD_GUI=ON -DENABLE_SQLITE_WALLET=ON \
         -DCMAKE_BUILD_TYPE=${{ matrix.build_type }} \
         $CMAKE_EXTRA_FLAGS \
         -S$(pwd) -B$(pwd)/build
         cd build && ninja
+    - name: Run Wallet Database Tests (Mac)
+      if: matrix.is_mac
+      run: |
+        set -exo pipefail
+        WALLET_TEST_PARENT=$(mktemp -d)
+        export TMPDIR="$(cd "$WALLET_TEST_PARENT" && pwd -P)"
+        build/bin/test_firo \
+          --run_test=wallet_database_factory_preopen_policy,wallet_database_tests,macos_wallet_permissions_tests \
+          --catch_system_error=no --log_level=message -- DEBUG_LOG_OUT
+    - name: Run BDB-only Wallet Database Tests (Mac RelWithDebInfo)
+      if: matrix.is_mac && matrix.build_type == 'RelWithDebInfo'
+      run: |
+        set -exo pipefail
+        BDB_JOBS=$NJOBS
+        if [ "$BDB_JOBS" -gt 20 ]; then
+          BDB_JOBS=20
+        fi
+        make -C depends -j$BDB_JOBS NO_SQLITE=1
+        export HOST_TRIPLET=$(depends/config.guess)
+        test ! -e "depends/$HOST_TRIPLET/include/sqlite3.h"
+        test ! -e "depends/$HOST_TRIPLET/lib/libsqlite3.a"
+
+        env PKG_CONFIG_PATH="$(pwd)/depends/$HOST_TRIPLET/lib/pkgconfig:$PKG_CONFIG_PATH" \
+        cmake -G Ninja \
+          -DCMAKE_TOOLCHAIN_FILE="$(pwd)/depends/$HOST_TRIPLET/toolchain.cmake" \
+          -DBUILD_CLI=OFF -DBUILD_DAEMON=OFF -DBUILD_GUI=OFF \
+          -DBUILD_TESTS=ON -DENABLE_SQLITE_WALLET=OFF -DWITH_BDB=ON \
+          -DCLIENT_VERSION_IS_RELEASE=true -DCMAKE_BUILD_TYPE=${{ matrix.build_type }} \
+          -S"$(pwd)" -B"$(pwd)/build-mac-bdb-only"
+        cmake --build build-mac-bdb-only --target test_firo --parallel "$BDB_JOBS"
+
+        BDB_AUDIT_DIR=$(mktemp -d)
+        ar -t build-mac-bdb-only/lib/libfiro_wallet.a \
+          > "$BDB_AUDIT_DIR/wallet-members"
+        nm -C build-mac-bdb-only/lib/libfiro_wallet.a \
+          > "$BDB_AUDIT_DIR/wallet-symbols"
+        otool -L build-mac-bdb-only/bin/test_firo \
+          > "$BDB_AUDIT_DIR/test-firo-libraries"
+        if grep -Eiq 'sqlite\.cpp|win32_file_lifecycle' \
+            "$BDB_AUDIT_DIR/wallet-members"; then
+          echo "BDB-only macOS wallet archive contains a SQLite wallet object"
+          exit 1
+        fi
+        if grep -Eq 'sqlite3_|(^|[^[:alnum:]_])SQLite(Database|Batch)(::|\()|win32_wallet::' \
+            "$BDB_AUDIT_DIR/wallet-symbols"; then
+          echo "BDB-only macOS wallet archive contains a SQLite wallet symbol"
+          exit 1
+        fi
+        if grep -qi sqlite "$BDB_AUDIT_DIR/test-firo-libraries"; then
+          echo "BDB-only macOS test executable links SQLite"
+          exit 1
+        fi
+
+        build-mac-bdb-only/bin/test_firo \
+          --run_test=wallet_database_factory_preopen_policy,wallet_database_tests \
+          --catch_system_error=no --log_level=test_suite -- DEBUG_LOG_OUT
     - name: Run Unit Tests
       if: matrix.is_linux
       run: |
@@ -297,6 +397,16 @@ jobs:
         set -exo pipefail
         cp -rf build/bin/* build/src/
         qa/pull-tester/rpc-tests.py -extended
+    - name: Upload Windows SQLite Wallet Test Runtime
+      if: matrix.is_windows && matrix.build_type == 'RelWithDebInfo'
+      uses: actions/upload-artifact@v6
+      with:
+        name: windows-sqlite-wallet-test-runtime-${{ env.COMMIT_HASH }}
+        path: |
+          build/bin/test_firo.exe
+          build-windows-bdb-only/bin/test_firo.exe
+        if-no-files-found: error
+        retention-days: 1
     - name: Prepare Files for Artifact
       run: |
         set -exo pipefail
@@ -330,6 +440,190 @@ jobs:
         name: test-${{ matrix.platform }}-cmake-${{ matrix.build_type }}-logs-${{ env.COMMIT_HASH }}
         path: ${{ env.TEST_LOG_ARTIFACT_DIR }}
 
+  windows-native-sqlite-wallet-tests:
+    name: windows-native-sqlite-wallet-tests-RelWithDebInfo
+    needs: [get-commit-hash, cmake-build]
+    if: ${{ !cancelled() && needs.get-commit-hash.result == 'success' }}
+    runs-on: windows-latest
+    steps:
+      - name: Download Windows SQLite Wallet Test Runtime
+        uses: actions/download-artifact@v7
+        with:
+          name: windows-sqlite-wallet-test-runtime-${{ needs.get-commit-hash.outputs.short_sha }}
+          path: wallet-tests
+      - name: Run SQLite Wallet Tests on Native NTFS
+        shell: pwsh
+        working-directory: wallet-tests
+        run: |
+          $ErrorActionPreference = 'Stop'
+          $testTemp = Join-Path $env:LOCALAPPDATA "FiroSQLiteWalletTests-$PID"
+          New-Item -ItemType Directory -Path $testTemp | Out-Null
+          $currentSid = [System.Security.Principal.WindowsIdentity]::GetCurrent().User
+          $identityBefore = [System.Security.Principal.WindowsIdentity]::GetCurrent()
+          try {
+            $tokenOwnerBefore = $identityBefore.Owner
+          } finally {
+            $identityBefore.Dispose()
+          }
+          $tokenOwnerBeforeCategory = if (
+            $null -ne $tokenOwnerBefore -and
+            $tokenOwnerBefore.Equals($currentSid)
+          ) {
+            'current-user'
+          } else {
+            'non-current-user'
+          }
+
+          Add-Type -TypeDefinition @'
+          using System;
+          using System.ComponentModel;
+          using System.Runtime.InteropServices;
+          using System.Security.Principal;
+          using Microsoft.Win32.SafeHandles;
+
+          public static class FiroTestTokenOwner
+          {
+              private const uint TOKEN_ADJUST_DEFAULT = 0x0080;
+              private const int TOKEN_OWNER_CLASS = 4;
+
+              [StructLayout(LayoutKind.Sequential)]
+              private struct TokenOwner
+              {
+                  public IntPtr Owner;
+              }
+
+              [DllImport("kernel32.dll")]
+              private static extern IntPtr GetCurrentProcess();
+
+              [DllImport("advapi32.dll", SetLastError = true)]
+              private static extern bool OpenProcessToken(
+                  IntPtr process,
+                  uint desiredAccess,
+                  out SafeAccessTokenHandle token);
+
+              [DllImport("advapi32.dll", SetLastError = true)]
+              private static extern bool SetTokenInformation(
+                  SafeAccessTokenHandle token,
+                  int informationClass,
+                  ref TokenOwner information,
+                  int informationLength);
+
+              public static void SetCurrentUserAsDefaultOwner()
+              {
+                  SafeAccessTokenHandle token;
+                  if (!OpenProcessToken(
+                          GetCurrentProcess(),
+                          TOKEN_ADJUST_DEFAULT,
+                          out token)) {
+                      throw new Win32Exception(
+                          Marshal.GetLastWin32Error(),
+                          "OpenProcessToken(TOKEN_ADJUST_DEFAULT) failed");
+                  }
+
+                  using (token)
+                  using (WindowsIdentity identity = WindowsIdentity.GetCurrent()) {
+                      SecurityIdentifier user = identity.User;
+                      if (user == null) {
+                          throw new InvalidOperationException(
+                              "The current process token has no user SID.");
+                      }
+                      byte[] userBytes = new byte[user.BinaryLength];
+                      user.GetBinaryForm(userBytes, 0);
+                      GCHandle pinnedUser = GCHandle.Alloc(
+                          userBytes,
+                          GCHandleType.Pinned);
+                      try {
+                          TokenOwner owner = new TokenOwner {
+                              Owner = pinnedUser.AddrOfPinnedObject()
+                          };
+                          if (!SetTokenInformation(
+                                  token,
+                                  TOKEN_OWNER_CLASS,
+                                  ref owner,
+                                  Marshal.SizeOf(typeof(TokenOwner)))) {
+                              throw new Win32Exception(
+                                  Marshal.GetLastWin32Error(),
+                                  "SetTokenInformation(TokenOwner) failed");
+                          }
+                      } finally {
+                          pinnedUser.Free();
+                      }
+                  }
+              }
+          }
+          '@
+          [FiroTestTokenOwner]::SetCurrentUserAsDefaultOwner()
+          $identityAfter = [System.Security.Principal.WindowsIdentity]::GetCurrent()
+          try {
+            $tokenOwnerAfter = $identityAfter.Owner
+          } finally {
+            $identityAfter.Dispose()
+          }
+          if (
+            $null -eq $tokenOwnerAfter -or
+            !$tokenOwnerAfter.Equals($currentSid)
+          ) {
+            throw 'Failed to normalize the test process token owner'
+          }
+
+          $inheritance = [System.Security.AccessControl.InheritanceFlags]::ContainerInherit -bor [System.Security.AccessControl.InheritanceFlags]::ObjectInherit
+          $accessRule = [System.Security.AccessControl.FileSystemAccessRule]::new(
+            $currentSid,
+            [System.Security.AccessControl.FileSystemRights]::FullControl,
+            $inheritance,
+            [System.Security.AccessControl.PropagationFlags]::None,
+            [System.Security.AccessControl.AccessControlType]::Allow
+          )
+          $privateAcl = [System.Security.AccessControl.DirectorySecurity]::new()
+          $privateAcl.SetAccessRuleProtection($true, $false)
+          $privateAcl.SetOwner($currentSid)
+          $privateAcl.AddAccessRule($accessRule)
+          Set-Acl -LiteralPath $testTemp -AclObject $privateAcl
+
+          $ownerProbe = Join-Path $testTemp 'child-token-owner-probe'
+          try {
+            & "$env:SystemRoot\System32\cmd.exe" /d /c "mkdir `"$ownerProbe`""
+            if ($LASTEXITCODE -ne 0) {
+              throw "Child token-owner probe failed with exit code $LASTEXITCODE"
+            }
+            $probeOwner = (Get-Acl -LiteralPath $ownerProbe).GetOwner(
+              [System.Security.Principal.SecurityIdentifier]
+            )
+            if (!$probeOwner.Equals($currentSid)) {
+              throw 'The normalized token owner was not inherited by a child process'
+            }
+          } finally {
+            if ([System.IO.Directory]::Exists($ownerProbe)) {
+              [System.IO.Directory]::Delete($ownerProbe, $false)
+            }
+          }
+          Write-Output (
+            '::notice title=Windows test token-owner normalization::before={0}; after=current-user; child-probe=current-user' -f
+              $tokenOwnerBeforeCategory
+          )
+
+          $env:TEMP = $testTemp
+          $env:TMP = $env:TEMP
+          $env:FIRO_TEST_REQUIRE_WIN32_REPARSE = '1'
+          $drive = (Get-Item $env:TEMP).PSDrive.Name
+          if ((Get-Volume -DriveLetter $drive).FileSystem -ne 'NTFS') {
+            throw "SQLite Windows tests require NTFS"
+          }
+
+          function Invoke-FiroTest(
+            [string]$Executable,
+            [string]$Filter
+          ) {
+            & $Executable "--run_test=$Filter" "--catch_system_error=no" "--log_level=test_suite" "--" "DEBUG_LOG_OUT"
+            if ($LASTEXITCODE -ne 0) {
+              throw "$Executable failed for $Filter with exit code $LASTEXITCODE"
+            }
+          }
+
+          Invoke-FiroTest '.\build\bin\test_firo.exe' 'wallet_database_tests/sqlite_win32_*'
+          Invoke-FiroTest '.\build\bin\test_firo.exe' 'wallet_database_factory_preopen_policy,wallet_database_tests'
+          Invoke-FiroTest '.\build-windows-bdb-only\bin\test_firo.exe' 'wallet_database_factory_preopen_policy,wallet_database_tests'
+
   guix-build:
     needs: get-commit-hash
     name: guix-${{ matrix.host }}