Adds PCK encryption support (using script encryption key for export). #38308

bruvzg · 2020-04-28T18:05:32Z

Adds optional PCK encryption (per file encryption + directory encryption) to export PCK and PCKPacker.
Changes FileAccessEncrypted's encryption mode from ECB to CFB (encryption/decryption is done in the one sequential pass anyway, there's no reason to use ECB).
Adds support for whitebox decryption code instead of hardcoded key. Actual decryption function implementation should be supplied by user. Example generated by https://github.com/balena/aes-whitebox is provided for testing purpose.
Removed, will add it as separate PR if I'll find usable open-source implementation.

Related issue #24716.

core/io/file_access_pack.cpp

core/io/file_access_pack.h

bruvzg · 2020-04-30T15:27:59Z

Changed it to the per-file encryption (file name filter in the export settings + optional directory encryption to hide file names), previous approach was decrypting whole PCK to the memory, every time file in it is opened.

vnen · 2020-05-04T00:27:44Z

I was wondering how this behaves with large PCK files, but with per-file encryption it shouldn't be so bad.

bruvzg · 2020-05-04T20:07:05Z

I was wondering how this behaves with large PCK files, but with per-file encryption it shouldn't be so bad.

With mindless "encrypt everything" approach it's quite slow. Excluding textures (*.stex) from the encryption makes it fast enough even with the white-box decryption (which is significantly slower than release build with default mbedtls AES). With the reasonable filters for hiding sensitive information only, overhead should be negligible.

TisFoolish · 2020-05-05T10:13:41Z

Can the key that is stored in the binary be used to decrypt the pck file (a given), change the content (eg make walls translucent), then re-encrypt modified game data? Encryption is not something I'm that knowledgeable in so sorry if this is a question with what should be an obvious answer.

bruvzg · 2020-05-05T10:28:56Z

Can the key that is stored in the binary be used to decrypt the pck file (a given), change the content (eg make walls translucent), then re-encrypt modified game data? Encryption is not something I'm that knowledgeable in so sorry if this is a question with what should be an obvious answer.

Yes, if get the key out of the binary you can do this. With white-box encryption there is no plain key stored in the binary, it's mixed with random data and code and attacker will need to find and reverse-engineer decryption code, it's still possible but harder to do.

TisFoolish · 2020-05-05T10:47:08Z

Someone in the future is probably going to request something like an option to use public key encryption as a preventative measure against cheaters in multiplayer games. That or do it themselves.

Personally I don't have a use for it as I'm just doing either single player games or small, co-op games.

bruvzg · 2020-05-05T12:55:46Z

Someone in the future is probably going to request something like an option to use public key encryption as a preventative measure against cheaters in multiplayer games. That or do it themselves.

It's always possible to modify binary, and bypass encryption altogether, and it's possible to manipulate decrypted resources in the process or/and GPU memory. Adding asymmetric cryptography probably won't make it any harder.

And relying on encryption as the only multiplayer anti-cheat measure is a bad idea anyway. Proper solution to prevent wall hacks is restricting the information sent by the server - calculate visibility on the server and give only visible opponent data to the clients and so on.

mhilbrunner · 2020-05-05T16:13:37Z

Someone in the future is probably going to request something like an option to use public key encryption as a preventative measure against cheaters in multiplayer games. That or do it themselves.

Personally I don't have a use for it as I'm just doing either single player games or small, co-op games.

That is not how public key encryption works. I guess you could use it to sign your binary or assets, but that doesn't really help against someone simply taking out the check for that.

But I guess that's what bruvzg already outlined in the previous comment, which I somehow missed :P

bruvzg · 2020-09-03T06:52:30Z

core/io/pck_packer.cpp

+		const int file_num = files.size();
+		if (p_verbose && (file_num > 0)) {
 			if (count % 100 == 0) {
-				printf("%i/%i (%.2f)\r", count, files.size(), float(count) / files.size() * 100);
+				printf("%i/%i (%.2f)\r", count, file_num, float(count) / file_num * 100);


This change was added to suppress MSVC: warning C4723: potential divide by 0 error.

Faless

This is really good work! 🚀 🏅

One thing I noticed, is that the Script export tab is a bit misleading now.
Setting Script Export Mode to Encrypted do not actually encrypt scripts unless *.gd files are included in the filter (which is not the default).
This is partly unrelated to this PR (since it was implemented in modules/gdscript/register_types.cpp and removed in recent GDScript update).

My suggestion is to have the Encryption tab always shown (maybe with an on/off switch) remove the Script tab, and move the Script Export Mode option to Resources with just the option: Text and Compiled (since Encryption will be handled by the dedicated section). This should also potentially allow to encrypt "compiled" gdscript.

What do you think?

Change default encryption mode from ECB to CFB.

bruvzg · 2020-09-05T11:56:24Z

My suggestion is to have the Encryption tab always shown (maybe with an on/off switch) remove the Script tab, and move the Script Export Mode option to Resources with just the option: Text and Compiled (since Encryption will be handled by the dedicated section). This should also potentially allow to encrypt "compiled" gdscript.

Done.

(When "Encrypt exported PCK" is unchecked, the rest of the encryption option are grayed-out).

NHodgesVFX · 2020-09-05T18:05:27Z

I think this will be great to add. Although anything can be broken some licences for 3d models and other assets require that you try to protect the assets.

Faless

Thank is amazing work 🚀 ! Thank you!

akien-mga · 2020-09-07T15:12:06Z

Thanks!

akien-mga · 2020-09-07T15:13:47Z

BTW, one thing I thought about and mentioned to @Faless today is that it could be good UX-wise to validate the encryption key in the configured export template when exporting with encryption enabled.

This could be done e.g. by exporting a temporary project with a simple magic string and see if it can be decoded properly (using OS.execute). Or possibly running a script directly with godot -s, though I think the -s feature might not be exposed to non-tools builds currently.

Xrayez · 2020-09-13T15:45:59Z

Or possibly running a script directly with godot -s, though I think the -s feature might not be exposed to non-tools builds currently.

Should be possible with #41190.

rieniter · 2021-02-23T21:33:24Z

Does this feature still available on godot 3.2.4 ? As I compile this version but still not found it

NHodgesVFX · 2021-02-23T21:34:51Z

Does this feature still available on godot 3.2.4 ? As I compile this version but still not found it

Pretty sure this feature is in godot 4 not 3

bruvzg · 2021-02-23T21:34:57Z

Does this feature still available on godot 3.2.4 ? As I compile this version but still not found it

No, it's for 4.0 only.

Calinou · 2021-06-24T07:33:52Z

With mindless "encrypt everything" approach it's quite slow. Excluding textures (*.stex) from the encryption makes it fast enough even with the white-box decryption (which is significantly slower than release build with default mbedtls AES). With the reasonable filters for hiding sensitive information only, overhead should be negligible.

Should we add *.stex to the encryption exclude filter by default? It's not very useful to encrypt those textures as they can be gathered using tools like RenderDoc or apitrace anyway.

bruvzg · 2021-06-24T07:47:50Z

Should we add *.stex to the encryption exclude filter by default? It's not very useful to encrypt those textures as they can be gathered using tools like RenderDoc or apitrace anyway.

Maybe even default it to the .godot/imported/*.

kienvn · 2021-06-25T07:08:42Z

With mindless "encrypt everything" approach it's quite slow. Excluding textures (*.stex) from the encryption makes it fast enough even with the white-box decryption (which is significantly slower than release build with default mbedtls AES). With the reasonable filters for hiding sensitive information only, overhead should be negligible.

Should we add *.stex to the encryption exclude filter by default? It's not very useful to encrypt those textures as they can be gathered using tools like RenderDoc or apitrace anyway.

We should have option select encrypt whole file data or encrypt 1000 first bytes of file data (textures).

bruvzg added enhancement topic:editor labels Apr 28, 2020

bruvzg requested a review from a team as a code owner April 28, 2020 18:05

bruvzg mentioned this pull request Apr 28, 2020

PCK files include human-readable script code #24716

Closed

bruvzg force-pushed the sad_security_circus branch from 7afffb3 to 174e47e Compare April 29, 2020 12:59

akien-mga reviewed Apr 29, 2020

View reviewed changes

core/io/file_access_pack.cpp Outdated Show resolved Hide resolved

akien-mga reviewed Apr 29, 2020

View reviewed changes

core/io/file_access_pack.h Outdated Show resolved Hide resolved

bruvzg force-pushed the sad_security_circus branch from 174e47e to 7c87f9f Compare April 30, 2020 15:23

bruvzg requested a review from vnen as a code owner April 30, 2020 15:23

bruvzg force-pushed the sad_security_circus branch 3 times, most recently from 8c99b13 to cd178e8 Compare May 1, 2020 11:54

bruvzg requested a review from bojidar-bg as a code owner May 1, 2020 11:54

bruvzg force-pushed the sad_security_circus branch 7 times, most recently from af372b4 to 8b956fd Compare May 3, 2020 11:13

Calinou mentioned this pull request May 3, 2020

Export with embedded pck is broken when changing PE metadata with rcedit #33466

Closed

bruvzg changed the title ~~[WIP] Adds PCK encryption support (using script encryption key for export).~~ Adds PCK encryption support (using script encryption key for export). May 13, 2020

bruvzg force-pushed the sad_security_circus branch from 6550f3d to 1006779 Compare June 23, 2020 07:22

bruvzg mentioned this pull request Jul 27, 2020

Protect Game Resources #19790

Closed

bruvzg force-pushed the sad_security_circus branch 3 times, most recently from 42b4d3e to ede0e6c Compare September 3, 2020 06:22

bruvzg commented Sep 3, 2020

View reviewed changes

bruvzg force-pushed the sad_security_circus branch 2 times, most recently from e150f3f to 392dfda Compare September 4, 2020 05:28

Faless reviewed Sep 5, 2020

View reviewed changes

Adds PCK encryption support (using script encryption key for export).

f043eab

Change default encryption mode from ECB to CFB.

bruvzg force-pushed the sad_security_circus branch from 392dfda to f043eab Compare September 5, 2020 11:54

akien-mga approved these changes Sep 7, 2020

View reviewed changes

Faless approved these changes Sep 7, 2020

View reviewed changes

akien-mga merged commit 3c42d57 into godotengine:master Sep 7, 2020

bruvzg mentioned this pull request Sep 17, 2020

Update encryption key page according to the new PCK encryption feature. godotengine/godot-docs#4026

Merged

Calinou mentioned this pull request Dec 28, 2020

Allow implementing and loading custom PCK file formats godotengine/godot-proposals#2036

Closed

bruvzg deleted the sad_security_circus branch February 23, 2021 21:34

Calinou mentioned this pull request Jun 24, 2021

Provide obfuscators support for C# godotengine/godot-proposals#1407

Open

Calinou mentioned this pull request Sep 16, 2023

Backport PCK encryption to Godot 3.x godotengine/godot-proposals#7696

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds PCK encryption support (using script encryption key for export). #38308

Adds PCK encryption support (using script encryption key for export). #38308

bruvzg commented Apr 28, 2020 •

edited

Loading

bruvzg commented Apr 30, 2020

vnen commented May 4, 2020

bruvzg commented May 4, 2020

TisFoolish commented May 5, 2020

bruvzg commented May 5, 2020

TisFoolish commented May 5, 2020 •

edited

Loading

bruvzg commented May 5, 2020

mhilbrunner commented May 5, 2020 •

edited

Loading

bruvzg Sep 3, 2020

Faless left a comment

bruvzg commented Sep 5, 2020 •

edited

Loading

NHodgesVFX commented Sep 5, 2020

Faless left a comment

akien-mga commented Sep 7, 2020

akien-mga commented Sep 7, 2020

Xrayez commented Sep 13, 2020

rieniter commented Feb 23, 2021

NHodgesVFX commented Feb 23, 2021

bruvzg commented Feb 23, 2021

Calinou commented Jun 24, 2021

bruvzg commented Jun 24, 2021

kienvn commented Jun 25, 2021

Adds PCK encryption support (using script encryption key for export). #38308

Adds PCK encryption support (using script encryption key for export). #38308

Conversation

bruvzg commented Apr 28, 2020 • edited Loading

bruvzg commented Apr 30, 2020

vnen commented May 4, 2020

bruvzg commented May 4, 2020

TisFoolish commented May 5, 2020

bruvzg commented May 5, 2020

TisFoolish commented May 5, 2020 • edited Loading

bruvzg commented May 5, 2020

mhilbrunner commented May 5, 2020 • edited Loading

bruvzg Sep 3, 2020

Choose a reason for hiding this comment

Faless left a comment

Choose a reason for hiding this comment

bruvzg commented Sep 5, 2020 • edited Loading

NHodgesVFX commented Sep 5, 2020

Faless left a comment

Choose a reason for hiding this comment

akien-mga commented Sep 7, 2020

akien-mga commented Sep 7, 2020

Xrayez commented Sep 13, 2020

rieniter commented Feb 23, 2021

NHodgesVFX commented Feb 23, 2021

bruvzg commented Feb 23, 2021

Calinou commented Jun 24, 2021

bruvzg commented Jun 24, 2021

kienvn commented Jun 25, 2021

bruvzg commented Apr 28, 2020 •

edited

Loading

TisFoolish commented May 5, 2020 •

edited

Loading

mhilbrunner commented May 5, 2020 •

edited

Loading

bruvzg commented Sep 5, 2020 •

edited

Loading