Security
What Wax puts on your PC, what a mod can do, how downloads are checked, and what is not protected.
This page is for a player who wants to know what they install, and for anyone who reviews Wax. It describes Wax 0.2.1 and newer.
In short
- Wax loads mods, and a mod is code. A mod that is switched on can do what any program on your PC can do. Wax does not fence it in.
- No mod starts without you. A mod Wax has not seen before stays switched off until you switch it on.
- Every Wax release and every mod in the catalogue is signed with one key. Your PC checks the signature before an update or a mod from the catalogue is put in.
- Wax does not start with Windows, has no accounts and sends nothing about you to anyone.
- The whole source is public at github.com/bostonstrong567/icarus-wax.
What Wax puts on your PC
Almost everything is inside the game folder, ...\steamapps\common\Icarus\Icarus\Binaries\Win64\. Two
things are not: a registry key for the Add to game button, and a small log file of that button.
| Where | What it is | How to remove it |
|---|---|---|
dwmapi.dll and the ue4ss folder | UE4SS, the script loader Wax runs on, as its own project released it, without the mods it brings (its console and cheat mods among them). The game loads dwmapi.dll from its own folder when it starts, and that file starts UE4SS. | Uninstall Wax.cmd asks whether to remove it. By hand: delete both. |
ue4ss\Mods\Wax | Wax: Lua files in Scripts, pictures in assets, tables in data, two helper files in bin, and, from the full zip or from Wax Setup, Wax-Import.ps1, which handles the Add to game button. The manual zip has no script. | Uninstall Wax.cmd, or Wax Setup.exe when it removes Wax. By hand: delete the folder. |
ue4ss\Mods\Wax\mods | Your mods. None comes with Wax. | Uninstall Wax.cmd asks first. By hand: delete a mod's folder. |
ue4ss\Mods\Wax\saved | The settings of Wax and of your mods. | The same question as for mods. |
ue4ss\Mods\Wax\run | Working files: the log of this session and of the one before, downloads while they are checked, and your answer about the Add to game button. | Goes with the Wax folder. |
The registry key HKEY_CURRENT_USER\Software\Classes\wax | Tells Windows that links starting with wax:// go to Wax. Install Wax.cmd makes it when you say yes. Wax Setup.exe makes it unless you pass --no-links. | Uninstall Wax.cmd removes it, and so does Wax Setup.exe when it removes Wax. By hand: the line below. |
%LOCALAPPDATA%\Wax\import.log | What the Add to game button did: one line with the time, the mod and the outcome for each wax:// link that was opened. It stays on your PC, and it starts again when it passes 256 KB. | Delete the Wax folder in %LOCALAPPDATA%. |
The two helper files are small programs written in C, and their source is in the repository:
bin\waxco.dlllets a Lua task call the game and gives Lua a precise clock. It opens no files and no connections. Source:waxco.c.bin\waxnet.dlldownloads updates and checks signatures. What Wax asks the network for says what it can reach. Source:waxnet.c.
What Wax does not do:
- Nothing starts with Windows. Wax adds no service, no scheduled task and no start-up entry. It runs inside ICARUS and only while the game runs.
- Nothing reports on you. Wax has no accounts, shows no adverts and sends no usage data.
- Nothing else is written outside the game folder, with one exception that does not stay. While
Update Wax.cmdchecks a download, it keeps it in a folder in your temp folder, and deletes that folder afterwards. - The installer runs with your own rights. If Windows does not let your account change the game folder, it says so and stops. It never raises its own rights.
The registry key
The key holds one command. Install Wax.cmd asks before it makes the key, and Enter alone means no. That
command is Windows PowerShell, in a window you can see, running Wax-Import.ps1 from Wax's folder with the
link. Wax Setup.exe makes the key on its own. Its command is that program, with --link and the link. To
leave the key as it is, run Wax Setup.exe --install --no-links.
To look at it, open a Command Prompt and type:
reg query HKCU\Software\Classes\wax /sTo remove it and keep Wax:
reg delete HKCU\Software\Classes\wax /fTo make it later, open a Command Prompt in the folder you extracted the zip to and type:
"Install Wax.cmd" -ModLinks YesWithout the key everything else works. You download a mod as a zip and put it in the mods folder.
Who can change Wax's folder
Steam lets every Windows account on a PC change the files of its games. Wax runs the Lua code in its own folder, so the installer closes that folder to the other accounts.
After an install or an update, ue4ss\Mods\Wax can be changed by the Windows account that ran the installer,
by administrators and by Windows itself. Other accounts can read it and no more. Your mods and settings are
inside it, so they are covered too.
The rest of the game folder stays as Steam made it. See What is not protected.
Copying Wax in by hand changes no permissions.
A mod is code
A mod is Lua that runs inside the game with your rights. It can read and write your files, start programs and use the network, like any program you run. There is no sandbox.
This is what stands between you and a bad mod:
- A person looks at the catalogue. A mod gets onto the Mods page in one of two ways. Its author submits it, automatic checks run, and a person reads the code before it is listed. Or the author of Wax publishes a mod of his own. Every new version goes the same way. Publish a mod has the rules.
- Every listed version is signed. The signature is made on the owner's PC, not on the server. Someone who took over the server, or the site's address, could not make your PC put in a mod. What is signed has the details.
- The button asks first. When a
wax://link is opened, a window on your PC shows the mod's name, version and author, and asks whether to add it. No is the answer if you press Enter. Such a link can be on any web page, which is why the question is asked on your PC and not on the page. The link carries the mod's id and nothing else. The mod itself always comes from the Wax catalogue. - A new mod is switched off. Wax remembers which mods you have seen. A mod it has not seen is listed as new and switched off, however it got into the mods folder: with the button, from a zip, copied by hand or put there by another program. That is so when the game starts as well as while it runs. The mod runs after you flip its Enabled switch on the Mods page of the Wax menu.
- An update is checked like the first copy. A mod from the catalogue is only replaced by files whose signed list is good, and the version before is kept in the mods folder.
What this does not give you:
- A signature says the mod is the one that was listed. It does not say the mod is harmless. A person read it once, and that is not a promise.
- A mod you copy in by hand is checked by nobody. Take such a mod only from someone you trust, or read it
first. A mod is plain text: open the
.luafiles in its folder.
What is signed
There is one signing key. It is an ECDSA key on the curve P-256, used with SHA-256.
The public half, as 128 hex digits:
8b37ac88ea0d9e8a8d239b731f1ba1d12fe163c605f6fe3c3933253e36421a953c5d04fdcb94e3934223e41aeb511593788140a7865c00ab2f6ad67746900d62Its fingerprint is the SHA-256 of those 64 bytes:
3163547c55f74f12ebf7b1d93ab42f42d3a4ecdbb99ae14e04d390f8f11ccf4cThe same fingerprint is in README.txt in the download and in the README of the repository. Compare them.
- The private half is on the owner's PC and nowhere else. It is not on the server and not in the repository.
- The server stores signatures and hands them out. It cannot make one.
- The public half is written into the three things that check a signature:
Wax-Setup.ps1,Wax-Import.ps1andbin\waxnet.dll. No setting, file or parameter changes the key or the address they use.
Four kinds of text are signed. Each starts with a word that says what it is, so a signature for one kind cannot be passed off as another.
| What | The signed text | Where the signature is | What checks it |
|---|---|---|---|
| A Wax release | release <version>, then one line <sha256> <size> <file name> for each file | Wax-<version>.manifest and Wax-<version>.manifest.sig, beside the zip on the release page | Update Wax.cmd, before it installs |
| The zip of one version of a mod | zip <Id> <version>, then one line <sha256> <size> | signature of that version in /api/mods/<Id>, and the X-Wax-Signature header of the download | Add to game, before it unpacks |
| The files of one version of a mod | mod <Id> <version>, then one line <sha256> <size> <path> for each file | signature in /api/mods/<Id>/files/<version> | Wax in the game, before it replaces a mod |
| Wax's own files | wax <version>, then the same lines | signature in /api/wax/files/<version> | Wax in the game, before it updates itself |
The texts are UTF-8 and every line ends with a line feed. Checksums are SHA-256 in small hex letters, sizes
are bytes, and the file lines are sorted. A signature is 64 bytes, r then s, written as base64.
After the signature is found good, the download itself is compared with the text: every file must have the size and the checksum the text gives.
Check a download by hand
Nothing checks the first Wax you download, unless you do. This is how.
From the release page, download three files
into one folder: the zip, and the .manifest and .manifest.sig files with the same version in the name.
Open PowerShell in that folder and paste this.
$zip = Get-Item Wax-*.zip
$version = $zip.BaseName.Substring(4)
$key = '8b37ac88ea0d9e8a8d239b731f1ba1d12fe163c605f6fe3c3933253e36421a953c5d04fdcb94e3934223e41aeb511593788140a7865c00ab2f6ad67746900d62'
$point = [byte[]]($key -split '(..)' -ne '' | ForEach-Object { [Convert]::ToByte($_, 16) })
$sha = [Security.Cryptography.SHA256]::Create()
function Test-WaxSignature([byte[]]$Text, [string]$Signature) {
$blob = [byte[]]((0x45, 0x43, 0x53, 0x31, 32, 0, 0, 0) + $point)
$cng = [Security.Cryptography.CngKey]::Import($blob, [Security.Cryptography.CngKeyBlobFormat]::EccPublicBlob)
$ecdsa = New-Object Security.Cryptography.ECDsaCng $cng
return $ecdsa.VerifyHash($sha.ComputeHash($Text), [Convert]::FromBase64String($Signature.Trim()))
}
$list = [IO.File]::ReadAllBytes((Get-Item "Wax-$version.manifest").FullName)
$signature = Get-Content "Wax-$version.manifest.sig" -Raw
$line = '{0} {1} {2}' -f (Get-FileHash $zip.FullName -Algorithm SHA256).Hash.ToLower(), $zip.Length, $zip.Name
$lines = [Text.Encoding]::UTF8.GetString($list) -split "`n"
'Fingerprint of the key: ' + (($sha.ComputeHash($point) | ForEach-Object { $_.ToString('x2') }) -join '')
'The list carries the signature: ' + (Test-WaxSignature $list $signature)
'The list is for this version: ' + ($lines[0] -ceq "release $version")
'The zip is the one it names: ' + ($lines -ccontains $line)It prints four lines. The fingerprint must be the one on this page, and the other three must say True.
Releases older than 0.2.1 have no such list.
To check the zip of a mod, download it with Download zip on the Mods page. Then paste these lines into the same PowerShell window, with the name of your file in the first line:
$zip = Get-Item 'RecipeBrowser-1.0.0.zip'
$mod = Invoke-RestMethod 'https://wax-icarus.duckdns.org/api/mods/RecipeBrowser'
$entry = $mod.versions | Where-Object { $zip.Name -ceq "$($mod.id)-$($_.version).zip" }
$text = "zip {0} {1}`n{2} {3}`n" -f $mod.id, $entry.version, (Get-FileHash $zip.FullName -Algorithm SHA256).Hash.ToLower(), $zip.Length
'The zip carries the signature: ' + (Test-WaxSignature ([Text.Encoding]::UTF8.GetBytes($text)) $entry.signature)What Wax asks the network for
In the game, one file talks to the network: bin\waxnet.dll. These things are fixed in its code:
- It reaches one address,
wax-icarus.duckdns.org, over HTTPS. - It only fetches. Every request is a
GETfor something under/api/. - It follows no redirect and keeps no cookies.
- It writes only inside
ue4ss\Mods\Wax\run\net.
| When | What is asked | Why |
|---|---|---|
| 20 seconds after the game starts, then every six hours, when a mod from the catalogue is installed | /api/versions, the newest version of every listed mod | To see whether one of your mods has a newer version. Prospector's Codex comes from the catalogue, so this happens in a new install. |
| When one of them has a newer version | The list of that version's files, then each file | To update the mod |
| When you open the Browse page of the Wax menu, and again while it stays open once the list is five minutes old | /api/mods, the list of mods | To show the catalogue in the game |
| With that list | /api/votes/mine, the mods your internet address has voted on | To show your own likes and dislikes, also the ones you cast on this site |
| When you open a mod on that page | /api/mods/<Id> and its pictures | To show what the mod says about itself |
| When you press like or dislike there | A ticket for that one vote, then the vote | To count your vote. The catalogue keeps one vote for each mod and internet address, whether it came from the game or from this site |
| When you press Add on that page and say yes | The list of that version's files, then each file | To add the mod. It stays switched off until you switch it on |
| 30 seconds after the game starts, then every six hours | /api/wax, the newest version of Wax | To see whether Wax has a newer version |
| When it has | The list of that version's files and the list of yours, then the files of the parts that differ | To update Wax. The new version is put in when the game next starts. If it does not start, the version before is put back. |
What is sent with a request:
- The path, which names the mod and the version that is fetched.
Wax/and the version of Wax, as the name of the program that asks.- Your internet address, as with every connection.
Nothing else is sent: nothing about your PC, your Steam account, your saves or what you do in the game. The list of versions is the same for everyone, so asking for it does not say which mods you have.
Switching it off
Updates of one mod. Open the Wax menu (F8), go to Mods, open the mod's card and switch off its Auto Update. Wax then does not replace that mod by itself. It still asks the catalogue which versions are out, so that the card can offer an Update to button. Every mod that came from the catalogue has this switch on its own card.
Asking the catalogue at all. Switch off Look for updates, above the cards. Wax then asks the catalogue nothing: not about your mods and not about itself.
Updates of Wax. Wax has a setting of its own for this, apart from the switches of the mods. It is on until you switch it off, and no control shows it yet. Type this line into the command bar of the Log page and press Enter:
Wax.selfupdate.set_auto(false)Wax then asks nothing about itself and puts in no new version of itself. It remembers this the next time you
play. The same line with true switches it on again. A mod's Auto Update switch does not change it.
Everything. Take waxnet.dll out of ue4ss\Mods\Wax\bin. Without that file Wax in the game cannot use
the network at all. It says once in the log that the helper is missing, and everything else works. Installing
or updating Wax with the installer puts the file back.
Outside the game
Update Wax.cmdasks GitHub for the newest release of Wax, and only when you run it. It downloads fromhttps://github.com/bostonstrong567/icarus-wax/releases/download/and from nowhere else.Wax-Import.ps1runs when you open awax://link. It asks the catalogue for the mod's name, version and author, shows them to you, and downloads the mod after you say yes.- The site loads nothing from other addresses and sets no cookies. It keeps your own votes in your browser, and the catalogue counts a vote once for each internet address.
The bridge and developer mode
Wax watches one folder of its own, run\in, for requests from tools on the same PC. That is how
Wax-Import.ps1 tells a running game that a mod was added.
In a normal install the game takes two commands this way and nothing else:
| Command | What the game does |
|---|---|
ping | Answers that it is there. |
mod-added | Looks at the mods folder again. A mod it has not seen is listed switched off. It shows one notification, and the words of it come from the mod's own files in the game, not from the request. |
It does not run code that arrives in that folder.
Developer mode is for people who write mods. It is on while a file named dev.txt stands in Wax's
folder, beside Scripts:
...\steamapps\common\Icarus\Icarus\Binaries\Win64\ue4ss\Mods\Wax\dev.txtWith that file there, two more things work:
- The game runs Lua that a tool writes into
run\in. The play button of the VS Code extension and the command-line tools in the repository work this way. - The game reads
run\mods.index.lua, a list of mods that are kept in folders outside the game.
Know what you switch on. In developer mode any program that runs as you can run code inside the game by
writing one file. Leave it off unless you write mods. The download never contains dev.txt.
A copy of Wax with dev.txt also does not update itself in the game. Update Wax.cmd still works.
To switch developer mode on, make an empty text file with that name in that folder. To switch it off, delete the file. Start the game again after either.
What is not protected
- A program that already runs as you. It can change the game's files, Wax's files and your mods, and it could do the same harm without Wax. Signatures are checked when something is downloaded, not every time the game starts.
- The game folder outside Wax's own folder.
dwmapi.dll, the rest ofue4ssand the game's own files keep the permissions Steam gave them. On most PCs every Windows account can change them. - Windows does not know the downloads. The zip, the three
.cmdfiles, the scripts and the two helper files carry no Windows code-signing certificate. So Windows may warn you when you runInstall Wax.cmd, and it cannot tell you who made the files. The signature on this page is Wax's own. It tells Wax's tools that an update or a mod is the one the owner released, and Windows knows nothing of it. - Virus scanners may warn about UE4SS. It loads into the game the way a cheat would. Wax adds no such technique of its own.
- The three
.cmdfiles set PowerShell's script rule aside for the one run they start (-ExecutionPolicy Bypass). Without it Windows refuses a script that came out of a downloaded zip. It changes no setting on your PC. Those files are only inWax-<version>.zip.Wax-<version>-manual.ziphas no script.Wax Setup.execopies the files itself and does not start PowerShell. Windows has not signed that program, so it may warn you when you run it. - The site's address is a free dynamic-DNS name.
wax-icarus.duckdns.orgbelongs to the DuckDNS service, not to Wax. Whoever controls that service, or the owner's account there, could point the name at another server. That is why nothing relies on the address for what gets installed: a mod or an update from another server would not carry the signature and would be refused. A false site could still show wrong instructions or a wrong download link. Get Wax itself from the release page on GitHub, and check it by hand if you want to be sure. - One key. Everything rests on the private key staying on the owner's PC. If it were stolen, a new key would need a new release of Wax that you install by hand.
- The first download. Nothing on your PC can check it before Wax is there. The steps above are the way.
Report a security problem
Send it in private at github.com/bostonstrong567/icarus-wax/security/advisories/new. Only the owner of Wax sees a report made there. You need a GitHub account.
For anything that is not a risk to players, an ordinary issue is fine. An issue is public.