Fix compatibility hash spoofing when plugins are present. #60

zkxs · 2022-08-17T16:20:15Z

Resolves #58.

This enumerates all loaded assemblies and uses a couple of heuristics to make a very educated guess about which ones are plugins. Those plugins are then used in the compatibility hash calculation.

edit: I'll go into more detail

Enumerate all loaded assemblies using Froox's own [module: Description("POSTX_PROCESSED")] marker to filter to just the PostX processed assemblies
Attempt to correlate the PostX'd assemblies with Neos's Engine.ExtraAssemblies. ExtraAssemblies is a list of the loaded plugins, but it only contains their filenames. No path information.
Do some set theory to check for assemblies we couldn't match to plugins and plugins we couldn't match to assemblies.
- assemblies we couldn't match to plugins aren't a huge deal, and we actually expect a few of these. Specifically, NeosModLoader, FrooxEngine, and BusinessX are all PostX'd assemblies we shouldn't treat as plugins. Anything not in this expected set I warn about.
- plugins we couldn't match to assemblies are a bigger deal, and indicate that my plugin detection code failed. We can't version spoof properly in this case.
Deal with the Unsafe and AdvertiseVersion configs
Make sure I sort the assemblies in the same order Froox does
Spoof the version string and the compatibility hash, but this time respecting plugins

zkxs · 2022-08-17T16:26:40Z

/home/runner/work/NeosModLoader/NeosModLoader/NeosModLoader/AssemblyLoader.cs(51,36): error WHITESPACE: Fix whitespace formatting. Delete 1 characters. [/home/runner/work/NeosModLoader/NeosModLoader/NeosModLoader/NeosModLoader.csproj]
/home/runner/work/NeosModLoader/NeosModLoader/NeosModLoader/Util.cs(77,1): error WHITESPACE: Fix whitespace formatting. Replace 17 characters with '\n\s\s\s\s\s\s\s\s'. [/home/runner/work/NeosModLoader/NeosModLoader/NeosModLoader/NeosModLoader.csproj]
/home/runner/work/NeosModLoader/NeosModLoader/NeosModLoader/Util.cs(78,69): error WHITESPACE: Fix whitespace formatting. Replace 9 characters with '\n\s\s\s\s\s\s\s\s'. [/home/runner/work/NeosModLoader/NeosModLoader/NeosModLoader/NeosModLoader.csproj]

I have no idea what the linter is complaining about. Those line/column targets don't appear valid to me.

edit: LJ fixed this with some dark magic of some sort

zkxs · 2022-08-17T16:27:17Z

Some example logs using a couple of plugins I have lying around.

with unsafe false

11:12:13 AM.760 (  0 FPS)	[DEBUG][NeosModLoader] Found 5 potential plugins: BusinessX.dll, FrooxEngine.dll, NeosDynamicBoneWizard.dll, NeosModLoader.dll, NQuery.dll
11:12:13 AM.768 (  0 FPS)	[DEBUG][NeosModLoader] Found 2 actual plugins: NeosDynamicBoneWizard.dll, NQuery.dll
11:12:13 AM.769 (  0 FPS)	[INFO] [NeosModLoader] Adding NeosModLoader.dll to version string because you have AdvertiseVersion set to true.
11:12:13 AM.771 (  0 FPS)	[DEBUG][NeosModLoader] Changing version string from 2022.1.28.1310+NeosModLoader.dll+NeosDynamicBoneWizard.dll+NQuery.dll to 2022.1.28.1310+NeosModLoader.dll+NeosDynamicBoneWizard.dll+NQuery.dll
11:12:13 AM.930 (  0 FPS)	[DEBUG][NeosModLoader] Vanilla protocol version is 843
11:12:13 AM.931 (  0 FPS)	[DEBUG][NeosModLoader] Changing compatibility hash from kTRVbxu53sCD7StS8J0Ehw== to rmJkVwWyIByK8lE5qvz+eA==
11:12:13 AM.931 (  0 FPS)	[INFO] [NeosModLoader] Compatibility hash spoofing succeeded

with unsafe true

11:13:09 AM.257 (  0 FPS)	[DEBUG][NeosModLoader] Found 5 potential plugins: BusinessX.dll, FrooxEngine.dll, NeosDynamicBoneWizard.dll, NeosModLoader.dll, NQuery.dll
11:13:09 AM.264 (  0 FPS)	[DEBUG][NeosModLoader] Found 2 actual plugins: NeosDynamicBoneWizard.dll, NQuery.dll
11:13:09 AM.265 (  0 FPS)	[WARN] [NeosModLoader] Unsafe mode is enabled! Not that you had a warranty, but now it's DOUBLE void!
11:13:09 AM.265 (  0 FPS)	[INFO] [NeosModLoader] Adding NeosModLoader.dll to version string because you have AdvertiseVersion set to true.
11:13:09 AM.267 (  0 FPS)	[DEBUG][NeosModLoader] Changing version string from 2022.1.28.1310+NeosModLoader.dll+NeosDynamicBoneWizard.dll+NQuery.dll to 2022.1.28.1310+NeosModLoader.dll+NeosDynamicBoneWizard.dll+NQuery.dll
11:13:09 AM.420 (  0 FPS)	[DEBUG][NeosModLoader] Vanilla protocol version is 843
11:13:09 AM.421 (  0 FPS)	[DEBUG][NeosModLoader] Changing compatibility hash from kTRVbxu53sCD7StS8J0Ehw== to jnnkdwkBqGv5+jlf1u/k7A==
11:13:09 AM.421 (  0 FPS)	[INFO] [NeosModLoader] Compatibility hash spoofing succeeded

SQUASH THIS SHIT

…he-version-spoofining

l-2-j · 2022-08-21T19:15:42Z

This sounds like a very hacky way to proceed, especially if we're having to deal with things such as

Make sure I sort the assemblies in the same order Froox does

...But I guess we can't do transpiler magic to just remove NeosModLoader, since the hash is calculated before NML loads?

zkxs · 2022-08-21T19:54:45Z

This sounds like a very hacky way to proceed, especially if we're having to deal with things such as

Make sure I sort the assemblies in the same order Froox does

...But I guess we can't do transpiler magic to just remove NeosModLoader, since the hash is calculated before NML loads?

Correct, the compatibility hash is calculated before NML is loaded, and Neos does not keep a list of loaded plugins I can use to recalculate after the fact. So the real problem here is how to get the list of plugins. I have two ideas for this I've listed in #58 (comment), and this PR uses the idea that, in my opinion, is the lesser of the evils.

The only way to get a non-hacky solution for this would for NML to not be a plugin at all, and to hook into Neos using a more "normal" modloader technique. And at that point we might as well just use a prexisting modloader, like BepinEx.

NeosModLoader/NeosVersionReset.cs

EIA485 · 2022-08-23T05:35:35Z

NeosModLoader/NeosVersionReset.cs

-			bool otherPluginsPresent = extraAssemblies.Count > 1;
-			bool shouldSpoofCompatibility = !otherPluginsPresent || config.Unsafe;
-			bool shouldSpoofVersion = !config.AdvertiseVersion && shouldSpoofCompatibility;
+			// get all PostX'd assemblies. This is useful, as plugins can't NOT be PostX'd.


some plugin authors use external tools to postX their plugins before they are loaded into neos

It's either PostX'd or not, and it doesn't matter if it's been done a month ago or seconds ago by neos.

l-2-j · 2022-08-28T14:07:02Z

NeosModLoader/ModLoader.cs

 	public class ModLoader
 	{
-		internal const string VERSION_CONSTANT = "1.11.3";
+		internal const string VERSION_CONSTANT = "1.12.0";


I think that version bumps should usually just be done by @zkxs directly to the main branch in a commit that also tags it as the v1.12.0 for example.

Yeah, you're probably right. It'd definitely make the commit log easier to read. I'll start doing that in the future.

l-2-j

Can't say I thoroughly reviewed this, but as it seemed okay and can always be changed later on, 👍

EIA485 · 2022-08-28T20:44:01Z

Can't say I thoroughly reviewed this, but as it seemed okay and can always be changed later on, 👍

yep, we can always change it later.

Fix compatibility hash spoofing when plugins are present. Resolves #58.

c9c80fb

SQUASH THIS SHIT

zkxs force-pushed the version-spoof-2-the-version-spoofining branch from 375e40e to c9c80fb Compare August 17, 2022 18:54

zkxs requested review from EIA485 and l-2-j August 17, 2022 19:06

zkxs added 2 commits August 20, 2022 18:46

Merge remote-tracking branch 'upstream/master' into version-spoof-2-t…

3866127

…he-version-spoofining

dotnet format

665b995

zkxs changed the title ~~Fix compatibility hash spoofing when plugins are present. Resolves #58.~~ Fix compatibility hash spoofing when plugins are present. Aug 22, 2022

EIA485 reviewed Aug 23, 2022

View reviewed changes

NeosModLoader/NeosVersionReset.cs Show resolved Hide resolved

EIA485 reviewed Aug 23, 2022

View reviewed changes

Merge branch 'master' into version-spoof-2-the-version-spoofining

911bd8e

l-2-j reviewed Aug 28, 2022

View reviewed changes

l-2-j approved these changes Aug 28, 2022

View reviewed changes

Merge branch 'master' into version-spoof-2-the-version-spoofining

e252f5e

zkxs merged commit f7b9ae2 into master Aug 29, 2022

zkxs deleted the version-spoof-2-the-version-spoofining branch August 29, 2022 00:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix compatibility hash spoofing when plugins are present. #60

Fix compatibility hash spoofing when plugins are present. #60

Uh oh!

zkxs commented Aug 17, 2022 •

edited

Loading

Uh oh!

zkxs commented Aug 17, 2022 •

edited

Loading

Uh oh!

zkxs commented Aug 17, 2022

Uh oh!

l-2-j commented Aug 21, 2022

Uh oh!

zkxs commented Aug 21, 2022

Uh oh!

Uh oh!

EIA485 Aug 23, 2022 •

edited

Loading

Uh oh!

zkxs Aug 23, 2022

Uh oh!

l-2-j Aug 28, 2022

Uh oh!

zkxs Aug 29, 2022

Uh oh!

l-2-j left a comment

Uh oh!

EIA485 commented Aug 28, 2022 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Fix compatibility hash spoofing when plugins are present. #60

Fix compatibility hash spoofing when plugins are present. #60

Uh oh!

Conversation

zkxs commented Aug 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

zkxs commented Aug 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

zkxs commented Aug 17, 2022

Uh oh!

l-2-j commented Aug 21, 2022

Uh oh!

zkxs commented Aug 21, 2022

Uh oh!

Uh oh!

EIA485 Aug 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zkxs Aug 23, 2022

Choose a reason for hiding this comment

Uh oh!

l-2-j Aug 28, 2022

Choose a reason for hiding this comment

Uh oh!

zkxs Aug 29, 2022

Choose a reason for hiding this comment

Uh oh!

l-2-j left a comment

Choose a reason for hiding this comment

Uh oh!

EIA485 commented Aug 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

zkxs commented Aug 17, 2022 •

edited

Loading

zkxs commented Aug 17, 2022 •

edited

Loading

EIA485 Aug 23, 2022 •

edited

Loading

EIA485 commented Aug 28, 2022 •

edited

Loading