Skip to content

Security: stixez/Sims4ModTest

SECURITY.md

Security

What Sims 4 Mod Test touches

  • Your Sims 4 user folder: it renames Mods and Tray during a test and renames them back afterwards. Files you add to a test are copied, never moved or changed.
  • Your save files: the main Slot_*.save files are copied to the app's data folder before a test.
  • The app's data folder (%LOCALAPPDATA%\Sims 4 Mod Test on Windows, ~/Library/Application Support/Sims 4 Mod Test on macOS, ~/.local/share/Sims 4 Mod Test on Linux): the state of a running test, save backups and a cache of the game's own resource keys.
  • During a test: a READ ME - Sims 4 Mod Test.txt note in the Sims 4 folder, removed when the test ends.
  • The game's cache files (localthumbcache.package, localsimtexturecache.package, avatarcache.package, the contents of cachestr) go to the Recycle Bin / Trash before and after a test, if that setting is on. The game rebuilds them.
  • errors.log in the app's data folder: unexpected errors, for bug reports. It stays on your computer.
  • The game folder: read only, to start the game and to read package indexes.

Once a day the app asks GitHub's public API whether there is a newer release (api.github.com/repos/stixez/Sims4ModTest/releases/latest). GitHub sees that request like any web request (for example your IP address), but nothing about your files or your game is sent, and nothing is downloaded or installed by itself: you choose whether to open the download. It can be turned off in Settings. Apart from that, and the "Buy me a coffee" page when you click it, the app doesn't go online. It doesn't run anything from the mods it copies.

Files from .zip downloads are written by their file name only, with characters that are special to the file system removed, so a zip can't place files outside the test folder. Members that would unpack to something huge from almost nothing (zip bombs) are skipped, and a download that would unpack to more than 50 GB or 100,000 files is refused. Links inside dropped folders (symlinks, junctions) are not followed. Names read from downloaded Sims are shown as plain text.

Reporting a problem

Please use private vulnerability reporting on GitHub rather than a public issue.

There aren't any published security advisories