lishuo/powerfun-unity
1
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
powerfun-unity/Assets/Editor/Beebyte/Obfuscator/Obfuscator_README.txt
lishuo fb75ff5318 代码混淆
2023-04-14 15:51:28 +08:00

822 lines
38 KiB
Plaintext
Raw Blame History

Obfuscator v3.9.9 Copyright (c) 2015-2022 Beebyte Limited. All Rights Reserved
Please see the Obfuscator.pdf document for more detailed guidance.
Usage
=====
The obfuscator is designed to work out of the box. When you build your project it automatically replaces the Assembly-CSharp.dll with an obfuscated version. If you use assembly definitions then these too will be obfuscated by default.
The default settings provide a good level of obfuscation, but it's worth looking at Options to enable or disable extra features (such as string literal obfuscation).
See https://www.youtube.com/watch?v=a5ypXst4OaM for a video example.
Options
=======
From within Unity, select the ObfuscatorOptions asset in the Assets/Editor/Beebyte/Obfuscator directory.
From the Inspector window, you can now see the Obfuscation options available along with descriptions where relevant. The default settings provide a solid configuration that obfuscates the majority of your code, but here you have general control over what is obfuscated.
Code Attributes
===============
Methods often need to be left unobfuscated so that they can be referenced from an external plugin via reflection, or for some other reason. Or maybe you just want a field called "password" to appear as "versionId" when viewed by a decompiler.
You can achieve this by adding Attributes to your code. Have a look at Assets/Editor/Beebyte/Obfuscator/ObfuscatorExample.cs to see how this is done.
The standard System.Reflection.Obfuscation attribute is supported.
The following Beebyte specific attributes are supported:
[SkipRename] - The obfuscator will not rename this class/method/field, but will continue to obfuscate its contents (if relevant).
[Skip] - The obfuscator will not rename this class/method/field, nor will it obfuscate its contents.
[Rename("MyRenameExample")] - The obfuscator will rename this class/method/field to the specified name. Class renames can accept a namespace rename, i.e. [Rename("MyNamespace.MyClass")]
[ReplaceLiteralsWithName] - If the target is obfuscated, then any literals with the exact original name will be converted to use the new obfuscated name. e.g. if method MyMethod is renamed to AAABBB, then any string literals of exactly "MyMethod" anywhere in your code will be adjusted to be "AAABBB" instead.
[ObfuscateLiterals] - Any string literals found within this method will be instructed to be obfuscated. This is a partial replacement to the clunky way of surrounding strings with '^' characters.
[DoNotFake] - Fake code will not be generated for this class/method.
[SuppressLog("MessageCode")] - Prevents specific Obfuscator messages from being printed
Troubleshooting F.A.Q
=====================
Q. After obfuscating, my 3rd party plugin has stopped working! It has scripts that aren't in the Plugins folder.
A. The simplest way to fix this is to look at the plugin's script to see what namespace they use. Then, towards the bottom of the inspector window in ObfuscatorOptions.asset there is an array called "Skip Namespaces". Add the plugin's namespace to this array and the obfuscator will ignore any matching namespaces. Occassionally a plugin will forget to use namespaces for its scripts, in which case you have three choices: Either move them into a Plugins folder, or annotate each class with [Beebyte.Obfuscator.Skip], or add each class name to the "Skip Classes" array.
Q. After obfuscating, my 3rd party plugin has stopped working! It only has scripts in the Plugins folder.
A. The obfuscator won't have touched files that live in the Plugins folder (unless you explicitly asked it to in Options), however it's likely that the plugin at some point required you to create a specifically named class and/or method. You'll need to add a [SkipRename] attribute to the class and/or method you created in your code.
Q. Button clicks don't work anymore!
A. Check your Options and see if you enabled the "Include public mono methods". If you did, then make sure you've added a [SkipRename] attribute to the button click method.
For a more obfuscated approach you could assign button clicks programatically. For example, here the ButtonMethod can be obfuscated:
public Button button;
public void Start()
{
button.onClick.AddListener(ButtonMethod);
}
Q. Animation events don't work anymore!
A. See "Button clicks don't work anymore!". If a method is being typed into the inspector, you should exclude it from Obfuscation.
Q. How do I get string literal encryption to work, my secret field is still showing as plaintext in a decompiler?
A. You need to take the following steps:
- Enable "Obfuscate Literals" in the ObfuscatorOptions asset.
- Either leave the default Unicode to 94 (the ^ character), or change it as required.
- In your code, surround the string with the chosen character, e.g. "secretpass" becomes "^secretpass^";
Alternatively, if the string is within a method you have another option:
- Enable "Obfuscate Literals" in the ObfuscatorOptions asset.
- Decorate the method with [ObfuscateLiterals] (using Beebyte.Obfuscator;)
Q. It's not working for a certain platform.
A. Regardless of the platform, send me an email (support@beebyte.co.uk) with the error and I'll see what I can do, but remember that it's only officially tested for Standalone/Android/iOS/WebGL platforms.
Q. How can we run obfuscation later in the build process?
A. You can control this in the Assets/Editor/Beebyte/Obfuscator/Postbuild.cs script. The PostProcessScene attribute on the Obfuscate method has an index number that you can freely change to enable other scripts to be called first.
Q. Can I obfuscate externally created DLLs?
A. You can. To do this open Assets/Editor/Beebyte/Obfuscator/ObfuscatorMenuExample.cs. Uncomment this file and change the DLL filepath to point to your DLL. Now use the newly created menu option.
Q. How do I obfuscate local variables?
A. Local variable names are not stored anywhere, so there is nothing to obfuscate. A decompiler tries to guess a local variable's name based on the name of its class, or the method that instantiated it.
Q. I'm getting ArgumentException: The Assembly UnityEditor is referenced by obfuscator ('Assets/ThirdParty/Beebyte/Obfuscator/Plugins/obfuscator.dll'). But the dll is not allowed to be included or could not be found.
A. It's important to keep the directory structure of the obfuscator package. Specifically, the correct location should have an "Editor" folder somewhere on its path. Unity treats files within Editor folders differently. Assets/Editor/Beebyte will ensure that the obfuscator can correctly run and that the obfuscator tool itself won't be included in your production builds.
Q. I'm getting an AssemblyResolutionException:Failed to resolve assembly: 'System.Collections, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a' when building for Windows Phone.
A. In the example given in the question, somewhere on your system would be a System.Collections.dll file of version 4.0.0.0. To fix the error, locate this file then add its location to the extraAssemblyDirectories array within Options.
Q. Is is possible to obfuscate certain public MonoBehaviour methods even when I've told it not to obfuscate them by default?
A. Yes, you override this by using the attribute [System.Reflection.Obfuscation(Exclude=false)] on the method.
Q. What can I do to make it more secure?
A. Try enabling obfuscation of public MonoBehaviour methods and obfuscation of MonoBehaviour class names. Enable string obfuscation and add [ObfuscateLiterals] to sensitive methods containing strings you'd prefer people not to see in a decompiler. Refactor your code to use smaller methods. Try using a different unicode starting character - instead of 65 (A) you could use 770 (Vertical text) - just be aware that makes stack traces harder to read.
Q. Something's still not working, how can I get in touch with you?
A. Please email support@beebyte.co.uk giving as much information about the problem as possible.
Notable 3rd Party Plugins (Beebyte is not affiliated with these products or companies)
======================================================================================
See Obfuscator.pdf for more information.
Update History
==============
3.9.9 - 2nd October 2022
* Fixed a runtime crash when reflection is used to access a 'fake code' generated method of an overridden base class when compiled to IL2CPP backend
3.9.8 - 31st May 2022
* Fixed an IDE crash when building development versions on 2021.2 or above
3.9.7 - 25th May 2022
* Fixed an IDE crash when using the Scripts Only Build option
3.9.6 - 19th May 2022
* Fixed a CRITICAL obfuscation bug introduced in Unity 2022.1
* Fixed an IDE crash the second time a build is made in 2022.1
3.9.5 - 18th May 2022
* Fixed a CRITICAL obfuscation bug introduced in Unity 2022.1
* Fixed an IDE crash the second time a build is made in 2022.1
3.9.4 - 7th April 2022
* Reduced the obfuscated DLL size when using String literal obfuscation
3.9.3 - 5th April 2022
* Fixed an issue introduced in 3.9.2. where a class defined within 'Skip Classes' in options may not have its methods skipped
3.9.2 - 6th January 2022
* Fixed method obfuscation within anonymous types
3.9.1 - 28th December 2021
* Fixed an InvalidCastException on build when using Burst
3.9.0 - 9th October 2021
* Reimplementation of string literal obfuscation resulting in faster build and run times
3.8.2 - 26th April 2021
* Fixed a FieldAccessException under rare conditions
3.8.1 - 15th April 2021
* Fixed a Unity 2018 issue when scripts call the CompatibilityBuildPipeline
3.8.0 - 14th April 2021
* [ObfuscateLiterals] can now be applied at the class level for it to apply to the methods and fields within it
* Fixed a Unity 2017.3 compatibility issue
3.7.3 - 30th March 2021
* Fixed the hidden option 'inheritBeebyteAttributes'
3.7.2 - 29th March 2021
* Prevented some AssemblyResolutionExceptions
3.7.1 - 22nd March 2021
* Fixed an IL2CPP NullReferenceException build error with simultaneous assembly obfuscation
3.7.0 - 20th March 2021
* "Extra Assembly Directories" has been replaced by "Referenced Assemblies" that can take either directories or files
* Fixed a build error around method parameters being a nested obfuscated enum type belonging to another simultaneously obfuscated assembly
* Fixed an error around incorrect DLL versions being used for some checks
* Prevented some AssemblyResolutionExceptions
3.6.7 - 16th March 2021
* Fixed an IL2CPP NullReferenceException build error
3.6.6 - 15th March 2021
* Added debug around an object reference exception error
3.6.5 - 10th March 2021
* Fixed an IL2CPP build exception when generating fake code
3.6.4 - 1st March 2021
* Prevented an Obfuscation build exception
3.6.3 - 15th February 2021
* Fixed an obfuscation issue with constructor parameters
* Allow [ObfuscateLiterals] to be applied to constructors
3.6.2 - 17th December 2020
* Fixed obfuscation using optional "Scriptable Build Pipeline" package 1.13.1 and higher when run on Unity versions 2019.2.7 or older
3.6.1 - 19th November 2020
* Fixed an exception when obfuscation of MonoBehaviour class names and 'Create Visual Studio Solution' are both enabled
3.6.0 - 22nd October 2020
* Added hidden option to allow obfuscation of compiler generated fields on Serializable classes
3.5.4 - 23rd September 2020
* Undisclosed fix
3.5.3 - 29th August 2020
* Fixed an issue renaming MonoBehaviour classes when using Generic MonoBehaviour types
* Coroutine anonymous types are now obfuscated by default
3.5.2 - 27th August 2020
* Events on ScriptableObjects are now obfuscated
3.5.1 - 26th August 2020
* Fixed renaming MonoBehaviour classes for MacOS builds (for non Xcode projects)
* Renaming MonoBehaviour classes is no longer applied when creating Xcode project target builds
3.5.0 - 20th August 2020
* The option to rename MonoBehaviour classes for standalone builds only (Windows, Linux, MacOS) has been extended to include 2018.2 onwards
* Obfuscation of explicit interface implementation method names
* Fixed a "Sequence contains no matching element" error that occurs when building to IL2CPP when explicitly forcing obfuscation of an enum
3.4.0 - 27th July 2020
* Added option to rename MonoBehaviour classes for Unity 2020 (this is still an experimental feature!)
* Disable option to rename MonoBehaviour classes for the WebGL build target
* Paths to DLLs are now accepted within the Assemblies and Compiled Assemblies section of options meaning it's not only custom scripts that can now handle external DLLs
* Updated documentation on guidance for compatibility with well known assets. Odin users in particular are encouraged to look at this if using AOT generation to prevent code stripping
3.3.1 - 23rd July 2020
* Fixed an issue with PlayFab's ExecuteCloudScriptRequest not being correctly sent
* Anonymous types are now skipped by default. Set a hidden option of options.obfuscateAnonymousTypes = true to override this if required
* Fixed an issue with [SuppressLog] not being applied to generated fake code
3.3.0 - 17th July 2020
* Added option to rename MonoBehaviour classes for Unity 2019.3 and 2019.4
3.2.1 - 17th June 2020
* Unity reflection methods (such as SendMessage) are now properly detected when the 2nd and 3rd arguments of the reflection calls are complex
* A warning message is now logged should the Obfuscator fail to find the string reference for a Unity reflection method
* A new attribute [SuppressLog] exists that can prevent certain warning messages from being printed
3.2.0 - 15th June 2020
* Faster obfuscation build times for very large projects
3.1.2 - 9th June 2020
* Fixed an issue with Inner/Nested classes and skip namespaces
3.1.1 - 25th May 2020
* Fixed a System.ArgumentNullException on build when obfuscating a string const assigned to be null
3.1.0 - 3rd May 2020
* A build exception is now thrown if the length of the salt used for name translation is too short
* Added a button click that will regenerate the salt
* New option to randomise salt each build
* A new option to include the hash salt must now be enabled for it to appear in the name translation file
* String literals containing only null characters are no longer obfuscated
* Added 'Photon' to the list of namespaces to skip when using fresh settings
3.0.1 - 10th March 2020
* Potentially fixed the 'Copying assembly from '' to '' failed after builds.
3.0.0 - 10th March 2020
* Namespaces whose name start with a skipped namespace no longer assume they should be skipped when skipping recursively (i.e. 'ABC' is no longer skipped when only 'AB' is specified, however AB.X would be skipped).
* Namespaces whose name start with an explicitly obfuscated namespace no longer assume to be obfuscated when obfuscating recursively.
* Classes that are the base class to a Serializable class are now also treated as Serializable.
* Improvements to string literal obfuscation.
* Updated the default options to include the following 'Unity Methods': OnJointBreak2D, OnParticleSystemStopped, OnParticleTrigger, OnParticleUpdateJobScheduled
2.8.1 - 8th January 2020
* Visual Studio no longer reports a FormatException warning when obfuscating.
* Fixed a UI issue with ObfuscatorOptions when 'Use RSA' is unselected.
2.8.0 - 18th November 2019
* Compatibility with the Unity Test Framework for Unity 2019.3 onwards.
2.7.6 - 5th November 2019
* Fixed a pipeline issue affecting Unity 2018.1
2.7.5 - 30th October 2019
* Fixed a CRITICAL obfuscation bug introduced with Unity 2019.2.8 and newer on pipeline builds when enabling the option to obfuscate all assembly definitions.
2.7.4 - 20th October 2019
* Fixed a CRITICAL obfuscation bug introduced with Unity 2019.2.8 and newer on pipeline builds. It is vital to install this version if using the latest versions of Unity.
2.7.3 - 12th October 2019
* Added a Unity incompatibility warning due to a critical bug introduced by recent changes to the Unity build pipeline
2.7.2 - 24th September 2019
* Fixed an issue with calls to StopCoroutine
2.7.1 - 5th September 2019
* Nested classes declared to be skipped via the "Skip Classes" section of options are now correctly skipped when their parents are obfuscated
2.7.0 - 1st September 2019
* Prevented an issue that could lead to the Obfuscator not being run. As a result the build pipeline scripts have been restructured and are more robust
* Removed a warning message about duplicate method names that was only relevant to a legacy option that is no longer available
2.6.0 - 3rd July 2019
* Alternative attribute names can now be specified for the [Rename] attribute
2.5.4 - 30th June 2019
* Fixed a minor issue with nameTranslation.txt
* Added 'LapinerTools' to the default list of namespaces to skip
2.5.3 - 4th June 2019
* Updated the default options to be compatible with Photon Bolt (skipped some namespaces and classes)
2.5.2 - 18th May 2019
* Fixed a namespace incompatiblity issue caused by using an obfuscated assembly within another project that uses Bolt 2.0
2.5.1 - 25th April 2019
* Fixed an IL2CPP build bug when referencing a generic type in another assembly definition as a parameter to a custom attribute.
2.5.0 - 19th April 2019
* Added an option to remove specified custom attributes, defaulting to Unity attributes used to interact with the Unity IDE. If you are obfuscating assets for sale on the Unity Asset Store then please check that menus and Inspector windows still work as intended. If they don't then either remove elements from the new options list or [SkipRename] the methods that are called from the IDE.
2.4.2 - 18th March 2019
* Fixed an error with string obfuscation.
2.4.1 - 17th March 2019
* Fixed a NET 4.x issue (IL2CPP build error) with string obfuscation for some methods (dependant on size).
2.4.0 - 16th March 2019
* Added a toggle to obfuscate development builds (default is true)
* Fixed an exception when referencing a nested class type across multiple assembly definitions
2.3.5 - 28th February 2019
* Added Photon.Pun.PunRPC to the list of alternative RPC annotations (PUN2).
2.3.4 - 17th February 2019
* Fixed a CheckedResolve exception on build.
2.3.3 - 30th January 2019
* Fixed a rare case where an animation would fail to play.
2.3.2 - 5th December 2018
* Adjusted the AssemblySelector.cs to cater for player-only native assemblies as well as future proof it against new base Unity packages being added.
2.3.1 - 27th November 2018
* Fixed an IL2CPP issue brought about from 2.3.0
2.3.0 - 25th November 2018
* Slightly improved obfuscation.
* Fixed a runtime exception that could occur after obfuscating multiple assemblies.
2.2.0 - 13th November 2018
* Optimisation - added option (Misc) to set the progress bar detail which can affect obfuscation time for large projects. By default this is now set to a summary view.
2.1.0 - 8th November 2018
* Added option to allow/disallow 'public' fake code methods from being created.
2.0.11 - 3rd November 2018
* Fixed issues with complex custom attributes.
2.0.10 - 29th October 2018
* Fixed an error about duplicate types in Beebyte.Cecil (ECS related bug).
2.0.9 - 20th October 2018
* Fixed a TypeLoadException for generic instance methods referencing obfuscated types from another assembly.
* Fixed a TypeLoadException for custom attributes that had parameters of arrays of type definitions.
2.0.8 - 14th October 2018
* Fixed a runtime MissingMethodException that could happen after obfuscating multiple assemblies.
2.0.7 - 9th October 2018
* Fixed a TypeLoadException when using named arguments in custom attributes across assembly definitions.
2.0.6 - 28th September 2018
* Fixed a "Mono.Cecil.ResolutionException: Failed to resolve FKENQJFIROA" exception that could happen when obfuscating multiple assembly definitions.
2.0.5 - 27th August 2018
* Added Com.Google to the list of skipped namespaces, for Google Play Games compatibility.
* Added a warning about renaming MonoBehaviour classes in 2018.2, until a fix/workaround can be found.
2.0.4 - 28th May 2018
* Updated default settings for Photon Networking (PUN) to allow WebGL builds to log in, and to allow stronger obfuscation rules to be enabled.
2.0.3 - 23rd May 2018
* Fixed a bug where the Options Inspector window would not save the 'enabled' or 'Obfuscate all assembly definition' checkboxes.
* Relaxed the default options to only obfuscate Assembly-CSharp.dll instead of all assembly definitions. It is recommended to enable it when you're ready to increase obfuscation strength.
2.0.2 - 20th May 2018
* [UWP] Implemented a workaround for a UnityException on build for the UWP build target.
2.0.1 - 13th May 2018
* Fixed "dll was not found" errors for certain assembly definition files.
2.0.0 - 7th May 2018
* New Documentation added in PDF format.
* Assembly Definitions introduced in 2017.3 can now be automated into the build process.
* New options added to automatically obfuscate all assembly definitions.
* 'permanentDLLs' in Config.cs is now defined in the inspector options file under the heading 'compiledAssemblies' (synchronising with Unity's name in the CompilationPipeline).
* 'temporaryDLLs' in Config.cs is now defined in the inspector options file under the heading 'assemblies' (synchronising with Unity's name in the CompilationPipeline).
* extraAssemblyDirectories in Config.cs is now defined in the inspector options file.
* Priority of nested "[System.Reflection.Obfuscation]/[Skip]/[SkipRename]/Skip Namespaces" etc is no longer undefined behaviour - instead priority is awarded to the deepest level.
* Classes annotated with [System.Reflection.Obfuscation(ApplyToMembers=true)] (or [Skip]) will now also skip any nested classes.
* New option to skip literal obfuscation on methods that have been skipped.
* New option to apply literal obfuscation on all methods by default.
* Public nested classes and nested enums are no longer obfuscated if the public checkbox is disabled for class obfuscation.
* Fixed a "Fatal error in Unity CIL Linker" that could occur when running with 'development' enabled build targets.
* Obfuscating MonoBehaviour class names is no longer considered an experimental feature.
1.26.0 - 23rd September 2017
* New options to give other attributes the same effect as Beebyte specific attributes. i.e. you can configure [JsonProperty] to have the additional effect of [SkipRename].
1.25.2 - 16th September 2017
* Added ChartboostSDK to the list of Skipped Namespaces in the default options to fix a problem with delegates not being called.
1.25.1 - 7th September 2017
* Fixed a bug with methods that have the [RuntimeInitializeOnLoadMethod] attribute.
1.25.0 - 24th August 2017
* Reduced the memory footprint within the Editor following obfuscation.
* Extensive refactoring and more tests.
1.24.12 - 2nd August 2017
* Fixed issues with Attributes that take an inner class as a parameter.
1.24.11 - 27th July 2017
* Fixed issues with Attributes that take a class as a parameter.
1.24.10 - 16th July 2017
* Fixed a bug where an enum in a parameter as a default value from a second assembly would cause a failed resolution exception on a CheckedResolve.
1.24.9 - 13th July 2017
* Fixed a bug breaking inheritence checks when generic types were nested within other generic types.
1.24.8 - 22nd June 2017
* Added some exclusion for messages sent to UnityEditor classes.
* Fixed an Object reference exception that could sometimes occur when obfuscating literals.
1.24.7 - 17th June 2017
* Small bug fixes.
1.24.6 - 1st May 2017
* Some Unity reflection calls are now found when using chained and complex arguments.
* Compatibility fixes when linking with newer .NET versions.
1.24.5 - 26th April 2017
* Fixed some errors that occurred when building with the old legacy procedural naming policy.
* The stacktrace for any Obfuscator errors is visible once again.
1.24.4 - 13th April 2017
* Fixed a rare ArgumentException that could happen if two fields in the same class share the same name.
* Improved the build process.
1.24.3 - 8th April 2017
* Optimisation when obfuscating MonoBehaviour class names.
* Hidden option to obfuscate Beebyte attributes. This can help resolve imported types being defined multiple times (external DLLs).
1.24.2 - 17th March 2017
* Fixed a rare TypeLoadException.
* Fixed a "redefinition of parameter" error in IL2CPP when a delegate's parameter names are inferred from default declaration i.e. delegate { .. } instead of an explicit delegate(bool a, bool b) { .. }.
1.24.1 - 12th February 2017
* Fixed a bug where a coroutine invoked by name from a different class would fail to execute if the coroutine is not annotated with [SkipRename] or [ReplaceLiteralsWithName]. This also fixes coroutines launched from within coroutines.
1.24.0 - 27th January 2017
* Multiple DLLs can be simultaneously obfuscated by declaring them within Config.cs. Endpoints in the referenced DLL are updated in the calling DLL. This new feature is experimental and has no interface.
* Fixed a TypeLoadException that happened when a class extending an external class implements a custom interface that declares one of the external methods and where the implementing class doesn't override it.
* Optimisation.
1.23.9 - 13th November 2016
* Optimisation - Method obfuscation is now really quick compared to previous lengthy times seen with some projects that focused heavily on reflection (mostly NGUI).
* Extra information added to the progress bar for method obfusation.
* Forcing obfuscation on serialized fields with [System.Reflection.Obfuscation(Exclude=false)] was sometimes being ignored.
1.23.8 - 3rd November 2016
* Fixed an ArgumentException that could happen when obfuscating literals using the simplified non-RSA algorithm.
1.23.7 - 31st October 2016
* Added hidden option to provide canonical names of attributes to be searched for strings that add to the array of method names to be treated as [ReplaceLiteralsWithName].
* Custom attributes now have their string arguments searched for when considering [ReplaceLiteralsWithName].
* Added option to include fake code method names to the nameTranslation file.
* Added new Attribute to exclude fake code being created from particular methods or classes.
1.23.6 - 14th September 2016
* Fixed a compile NullReferenceException under certain conditions when cryptographic hashes are disabled.
1.23.5 - 4th September 2016
* Fixed IL2CPP compile error that, for some methods, would occur when using both string obfuscation and fake code generation.
* The "Use RSA" setting is no longer transient.
1.23.4 - 25th August 2016
* Fixed IL2CPP compile error that could sometimes happen when fake code generation is enabled.
* Fixed a NullReferenceException with RSA string obfuscation that could consistently appear under certain conditions.
1.23.3 - 12th August 2016
* Fixed a "NotSupportedException: The invoked member is not supported in a dynamic module." exception when using dynamically created libraries.
1.23.2 - 9th August 2016
* Fixed an IL2CPP compile error when fake code tries to clone extern methods.
1.23.1 - 8th August 2016
* Improvements to Fake Code generation.
1.23.0 - 27th July 2016
* Added new hidden options includeParametersOnPublicMethods and includeParametersOnProtectedMethods, set to true by default. Useful if you're giving an API to someone.
* Improved scanning for Unity reflection methods.
* Updated ObfuscatorMenuExample.cs
* Added Photon defaults for when Obfuscating MonoBehaviour class names are enabled.
1.22.1 - 25th July 2016
* Obfuscating MonoBehaviour class names occassionally didn't get reverted due to a Unity editor delegate being reset. A more stable approach is now taken where a temporary translation file is produced, then read back in at the earliest opportunity.
1.22.0.1 - 25th July 2016
* Fixed an issue with 1.22.0 for Unity 5.2+ that expected ObfuscatorOptions to be in a fixed location. It can once again live in a non-standard location.
1.22.0 - 19th July 2016
* Option to strip namespaces.
* Experimental option to obfuscate MonoBehaviour class names.
* Option to supply strings of method names that should have [ReplaceLiteralsWithName] applied.
* Added defaults for UFPS (Preserve Prefixes) and NGUI (Replace Literals).
* ObfuscatorOptions now installs in a temporary location and will ask to overwrite or keep existing settings when next run.
1.21.2 - 16th June 2016
* Fixed missing scripts errors in WebPlayer builds that occured when using Fake Code generation on methods that declare default arguments.
1.21.1 - 15th June 2016
* Fixed extremely long obfuscation times when using fake code generation on huge methods. There is a new option to limit the size of methods to be faked. This should bring obfuscation times back down to seconds from potentially hours.
1.21.0 - 15th June 2016
* Added default settings for Photon networking compatibility.
1.20.0 - 15th June 2016
* Added a progress bar.
1.19.0 - 10th June 2016
* Enum constants can now be skipped by default.
1.18.4 - 2nd June 2016
* Fixed a bug where iOS builds could fail to compile in xcode if using the default String Literal Obfuscation method.
1.18.3 - 1st June 2016
* Using [System.Reflection.Obfuscation(Exclude=false)] on a class will now cause it to be obfuscated even if its namespace is explicity skipped in Options.
1.18.2 - 30th May 2016
* Fixed a bug with string literal obfuscation where a string of length greater than 1/8th the chosen RSA key length would appear garbled.
1.18.1 - 23rd May 2016
* Changed the default Unicode start character to 65 (A) to work around an error with structs in iOS builds for certain unpatched versions of Unity.
* Changed defaults to use hash name generation instead of order based.
1.18.0 - 18th May 2016
* New "Preserve Prefixes" section that can keep part of a name, i.e. OnMessage_Victory() -> OnMessage_yzqor(). This is mostly for the reflection used by the UFPS plugin.
* New option to reverse the line order of the nameTranslation.txt. This is now the default.
* New option to surround every obfuscated name with a specified delimiter.
* Parameter obfuscation is now included in the nameTranslation.txt.
* New hidden option to include a simplified HASHES section in the nameTranslation.txt.
1.17.1 - 6th May 2016
* Fixed an ArgumentOutOfRangeException that could occur when the minimum number of fake methods is set to a large value.
1.17.0 - 5th May 2016
* Optimisation.
* Option to derive obfuscated names from a cryptographically generated hash. This means names will be consistent throughout a project's lifecycle, removing the need to maintain up to date nameTranslation.txt files.
* New attribute [ObfuscateLiterals] for methods that instructs all string literals within it to be obfuscated, without requiring delimiters within the literals.
* New option to toggle whether attributes should be cloned for fake methods.
1.16.2 - 1st April 2016
* ScriptableObject classes are now treated as Serializable by default (i.e. fields and properties are not renamed). This can be overriden by setting options.treatScriptableObjectsAsSerializable to false, or on a case-by-case basis by making use of [System.Reflection.Obfuscation] on each field, or [System.Reflection.Obfuscation(Exclude = false, ApplyToMembers = true)] on the class.
* Fixed a TypeLoadException for methods such as public abstract T Method() where a deriving class creates a method replacing the generic placeholder, i.e. public override int Method().
* Added hidden option for classes to inherit Beebyte attributes Skip and SkipRename that are on an ancestor class. To use, set options.inheritBeebyteAttributes = true prior to obfuscation.
1.16.1 - 23rd March 2016
* Fixed an issue with 1.16.0 where internal methods would not obfuscate.
1.16.0 - 10th March 2016
* New option to obfuscate Unity reflection methods instead of simply skipping them.
* Methods replacing string literals that share the same name now also share the same obfuscated name, so that replaced literals correctly point to their intended method.
* Faster obfuscation time for methods.
* Fixed a TypeLoadException.
* The name translation file now has a consistent order.
1.15.0 - 25th February 2016
* Added option to include skipped classes and namespaces when searching for string literal replacement via [ReplaceLiteralsWithName] or through the RPC option.
* Fixed a bug where classes within skipped namespaces could sometimes have their references broken if they link to obfuscated classes.
1.14.0 - 25th February 2016
* Added option to search SkipNamespaces recursively (this was the default behaviour)
* Added option to restrict obfuscation to user-specified Namespaces.
1.13.1 - 24th February 2016
* Fixed a NullReferenceException that could sometimes (very rarely but consistent) occur during the write process.
* Removed the dependance of the version of Mono.Cecil shipped with Unity by creating a custom library. This is necessary to avoid "The imported type `...` is defined multiple times" errors.
1.13.0 - 23rd February 2016
* Added a master "enabled" option to easily turn obfuscation on/off through scripts or the GUI.
* Add Fake Code is now available for WebPlayer builds.
* Fixed a "UnityException: Failed assemblies stripper" exception that occurs when selecting both fake code and player preference stripping levels.
* Improvements to Fake Code generation.
* Obfuscation times can now be printed with a call to Obfuscator.SetPrintChronology(..).
* Building a project with no C# scripts will no longer cause an error to occur.
1.12.0 - 12th February 2016
* Added finer control to exclude public or protected classes, methods, properties, fields, events from being renamed. This might be useful to keep a DLLs public API unchanged, for it to then be used in another project.
* Fixed a bug in the Options inspector that could revert some changes after an option's array's size is altered.
1.11.0 - 3rd February 2016
* Added an option to specify annotations that should be treated in the same way as [RPC], to cater for third party RPC solutions.
1.10.0 - 28th January 2016
* Previous obfuscation mappings can now be reused.
* Unity Networking compatibility (old & new).
* [RPC] annotated methods are no longer renamed unless an explicit [Rename("newName")] attribute is added, or if an option is enabled.
* A new [ReplaceLiteralsWithName] attribute exists that can be applied to classes, methods, properties, fields, and events. It should be used with caution since it searches every string literal in the entire assembly replacing any instance of the old name with the obfuscated name. This is useful for certain situations such as replacing the parameters in nView.RPC("MyRPCMethod",..) method calls. It may also be useful for reflection, but note that only exact strings are replaced.
1.9.0 - 23rd January 2016
* Added a new option "Skip Classes" that is equivalent to adding [Skip] to a class. It's a good long-term solution for 3rd party assets that place files outside of a Plugin directory in the default namespace.
* Added a way to resolve any future AssemblyResolutionExceptions via the Postscript.cs file without requiring a bespoke fix from Beebyte.
* Fixed a bug in Postscript.cs for Unity 4.7
* Added a workaround for an unusual Unity bug where the strings within the Options asset would sometimes be turned into hexadecimals, most noticable when swapping build targets often.
1.8.4 - 7th January 2016
* Fixed an AssemblyResolutionException for UnityEngine that could sometimes occur.
1.8.3 - 6th January 2016
* Obfuscation attributes can now be applied to Properties.
1.8.2 - 6th January 2016
* Serializable classes now retain their name, field names, and property names without requiring an explicit [Skip].
* Fixed issues using generics that extend from MonoBehaviour.
* Fixed an issue where two identically named methods in a type could cause obfuscation to fail if one is a generic, i.e. A() , A<T>().
* Fixed an issue where fake code generation could sometimes result in a failed obfuscation when generic classes are involved.
1.8.1 - 1st January 2016
* Fixed various issues using generics.
* Fixed an AssemblyResolutionException for UnityEngine.UI when using interfaces from that assembly.
1.8.0 - 29th December 2015
* Properties can now be obfuscated.
1.7.3 - 29th December 2015
* Undocumented fix.
1.7.2 - 28th December 2015
* Fixed a TypeLoadException error.
* Fixed an issue with inheritence.
* Undocumented fix.
1.7.1 - 27th December 2015
* Fixed a TypeLoadException error.
* Fixed a "Script behaviour has a different serialization layout when loading." error.
* Private Fields marked with the [SerializeField] attribute are now preserved by default.
* Classes extending from Unity classes that have MonoBehaviour as an ancestor were not being treated as such (i.e. UIBehaviour).
1.7.0.1 - 14th December 2015
* Unity 5.3 compatibility.
1.7.0 - 11th December 2015
* Improved the "Works first time" experience by searching for reflection methods referenced by certain Unity methods such as StartCoroutine. New option added to disable this feature.
* WebPlayer support (string literal obfuscation, public field obfuscation, fake code are disabled for WebPlayer builds).
* Added an option to strip string literal obfuscation markers from strings when choosing not to use string literal obfuscation.
* ObfuscatorMenuExample.cs added showing how you can Obfuscate other dlls from within Unity.
* Added protection against accidently obfuscating the same dll multiple times.
* Added an advanced option to skip rename of public MonoBehaviour fields.
1.6.1 - 16th November 2015
* First public release
Reference in New Issue View Git Blame Copy Permalink