Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add protection list to docs #206

Merged
merged 3 commits into from
Sep 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# -- Project information

project = 'BitMono'
copyright = '2023, BitMono'
copyright = '2022-2024, BitMono'
author = 'sunnamed434'

release = '0.1'
Expand Down
8 changes: 8 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,14 @@ Table of Contents:
protections/nonamespaces
protections/billionnops

.. toctree::
:maxdepth: 1
:caption: Protection List
:name: sec-protection-list

protection-list/overview
protection-list/unity


.. toctree::
:maxdepth: 1
Expand Down
8 changes: 8 additions & 0 deletions docs/source/protection-list/overview.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
What is a Protection List?
==========================

A protection list is a collection of stable security features designed to work with a specific framework or runtime environment, such as Unity, Mono, or .NET 8 or lower or higher.

Each list is tailored to the unique characteristics of these platforms, ensuring compatibility and reliable protection, so you don't need to find/test a list that fits your enviroment/runtime, we did it for you.

For sure, after reading through the list you can build a correct protections config that fits you!
55 changes: 55 additions & 0 deletions docs/source/protection-list/unity.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
Unity Protections
=================

This section lists various protections compatible with the `Unity Engine <https://unity.com/>`_.

Unity Runtime is typically based on the .NET Framework 4.*, depending on the Unity version in use. However, it is primarily executed on `Mono <https://github.com/mono/mono>`_, with Unity using its `own fork of Mono <https://github.com/Unity-Technologies/mono>`_ specifically for Unity Runtime.

You can also refer to this list for Mono runtime protections, but be aware that while Unity's Mono fork is similar to the standard Mono runtime, there may be differences that could impact compatibility.

Protection List
---------------

- **StringsEncryption**
Can significantly slow down your application.

- **BitDotNet**
Do not use with Unity versions higher than 2020.*. and instead use BitDecompiler

- **BitMethodDotnet**

- **DotNetHook**

- **CallToCalli**

- **ObjectReturnType**
Unstable.

- **NoNamespaces**
May cause issues if you rely heavily on Reflection.

- **FullRenamer**
May cause issues if you rely heavily on Reflection.

- **AntiDebugBreakpoints**
Unstable.

- **AntiDecompiler**

- **BitDecompiler**

- **BitDateTimeStamp**

- **BitMono**

- **BillionNops**

- **AntiDe4dot**

- **AntiILdasm**

Additional Considerations
-------------------------

- Some of these protections may not be suitable for all Unity versions or Mono runtimes.
- When using optional protections like `NoNamespaces` or `FullRenamer`, ensure to test thoroughly if your application uses extensive Reflection, as they might break functionality.