Failed to get MSI property in UPGRADINGPRODUCTCODE, WIX_UPGRADE_DETECTED

by

Ignoring the debug strings, it’s easier to see that the buffer handling is incorrect. I would suggest also outputting the return values from MsiGetPropertyA() and the value in dwValue to confirm, but here’s what I think is happening (comments refer to dwValue):

char szBuff[1024]; DWORD dwValue = 0;
MsiGetPropertyA(hInstall, "UPGRADINGPRODUCTCODE", szBuff, &dwValue); // passes 0, updated to ?x?
MsiGetPropertyA(hInstall, "WIX_UPGRADE_DETECTED", szBuff, &dwValue); // passes ?x?, updated to ?y?

When requesting UPGRADINGPRODUCTCODE property with a claimed buffer length of zero, the fetch will never succeed as it must always accept at least a null character. Thus this will return ERROR_MORE_DATA and set dwValue to the length excluding a null character (?x?).

Then it will request the value of WIX_UPGRADE_DETECTED with a claimed buffer length of (?x?). If the new length (?y?) is less than the old length (?x?) you’ll get its contents in your buffer; otherwise it will also just query the length of this new property.

Since WIX_UPGRADE_DETECTED contains a list of one or more GUIDs, and UPGRADINGPRODUCTCODE only contains one, and this code never increments dwValue to account for the null, it will only possibly succeed if the latter is ?y? is 0 (empty) and ?x? is non-empty. But note that this second call passed an unverified value as the length of your buffer, this pattern is a buffer overflow waiting to happen.

So fix your buffer handling. The pattern I like to use (below) is similar to what Stein describes, but avoids the second call if I know a good default size for the buffer. In your case, it sounds like you’re happy with the 1024 element buffer, but do consider if you ever need to handle more than 1024 / len(GUID) related upgrade codes.

(My guess is you’re fine. But at least think it through. And even though GUIDs are ASCII so the contents won’t matter, please please please build UNICODE these days…)

WCHAR szBuf[1024];
DWORD cchBuf = 1024; // or _countof(szBuf);
DWORD dwErr = MsiGetPropertyW(hInstall, L"UPGRADINGPRODUCTCODE", szBuf, &cchBuf);
if (dwErr != ERROR_MORE_DATA) {
    // exercise: increment cchBuf for null, adjust buffer, call MsiGetPropertyW again
}
if (dwErr != ERROR_SUCCESS) {
    // per https://learn.microsoft.com/en-us/windows/desktop/msi/custom-action-return-values
    return ERROR_INSTALL_FAILURE;
}

// reset buffer length for next call, in case second property is longer than first
cchBuf = 1024;
dwErr = MsiGetPropertyW(hInstall, L"WIX_UPGRADE_DETECTED", szBuf, &cchBuf);
// : : :

More Related Contents:

  1. Why is it a good idea to limit the use of custom actions in my WiX / MSI setups?
  2. Removing files when uninstalling WiX
  3. How to pass CustomActionData to a CustomAction using WiX?
  4. How to add a WiX custom action that happens only on uninstall (via MSI)?
  5. How to execute conditional custom action on install and modify only?
  6. Interrupt installation when custom action returns error
  7. Change my component GUID in wix?
  8. Adding entries to MSI UpgradeTable to remove related products
  9. What do I do when launching an application triggers repeating, endless Windows Installer self-repair?
  10. How do I avoid triggering MSI self-repair with my WiX / MSI package?
  11. Uninstall from Control Panel is different from Remove from .msi
  12. Microsoft Installer command line string parameter not working?
  13. Run Wix Custom action only during uninstall and not during Major upgrade
  14. How to Explicitly Remove dll During Majorupgrade Using Wix Toolset
  15. File of a new component isn’t installed because there was an old component with the same file
  16. WiX silent install unable to launch built in .EXE: WiX v3
  17. Windows installer deletes versioned file during product upgrade, instead of downgrading it
  18. I screwed up, how can I uninstall my program?
  19. WIX merge c++ runtime
  20. In WiX files, what does Name=”SourceDir” refer to?
  21. Wix Custom Action – session empty and error on deferred action
  22. One file per component or several files per component?
  23. Unselected Feature Being Installed
  24. Wix burn doesn’t allow to remove file
  25. Adventures in Installing a C#/WPF Application (WiX)
  26. Create a .config folder in the user folder
  27. Passing command line args to MSI from WiX bundle
  28. VersionNT MSI property on Windows 10
  29. How to assign path value to Directory in WIX?
  30. Wix per user installer to detect the Visual C++ 2015 Redistributable

Leave a Comment