Skip to content

Commit e3246fc

Browse files
committed
Update README.md
1 parent b01a0f7 commit e3246fc

1 file changed

Lines changed: 61 additions & 33 deletions

File tree

README.md

Lines changed: 61 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,91 +1,119 @@
11
<a id ="up"></a>
2+
23
<p align="center">
34
<img src="assets/banner.png">
4-
<img src="https://img.shields.io/badge/PyShield-v2.0.1.5-blue?style=for-the-badge&logo=&logoColor=whit">
5+
<img src="https://img.shields.io/badge/PyShield-v3.0.0.0-blue?style=for-the-badge&logo=&logoColor=whit">
56
<img src="https://img.shields.io/badge/Python-FFD43B?style=for-the-badge&logo=python&logoColor=blue">
67
<img src="https://img.shields.io/badge/VSCode-0078D4?style=for-the-badge&logo=visual%20studio%20code&logoColor=white">
7-
<img src="https://img.shields.io/badge/tests-100/100-76B900?style=for-the-badge&logo=&logoColor=whit">
8-
<img src="https://img.shields.io/badge/build-passing-76B900?style=for-the-badge&logo=&logoColor=whit">
9-
<img src="https://img.shields.io/badge/code quality-A-76B900?style=for-the-badge&logo=&logoColor=whit">
8+
<img src="https://img.shields.io/badge/tests-6/6-76B900?style=for-the-badge&logo=&logoColor=whit">
9+
<img src="https://img.shields.io/badge/build win-passing-76B900?style=for-the-badge&logo=&logoColor=whit">
10+
<img src="https://img.shields.io/badge/build linux-passing-76B900?style=for-the-badge&logo=&logoColor=whit">
11+
<img src="https://img.shields.io/badge/build mac-passing-76B900?style=for-the-badge&logo=&logoColor=whit">
12+
<img src="https://img.shields.io/badge/code quality-A+-76B900?style=for-the-badge&logo=&logoColor=whit">
1013
<img src="https://img.shields.io/badge/license-GPL3.0-blue?style=for-the-badge&logo=&logoColor=whit">
1114
</p>
1215

1316
---
17+
1418
### 🛡Py-Shield🛡
15-
Tool/Library for Python used to obfuscate and protect your code from decompilation, reverse debug, etc. Also, can prevent detection by antiviruses.
19+
20+
Tool/Library for Python used to obfuscate and protect your code in static and runtime from decompilation, reverse debug, etc. Also, can prevent detection by antiviruses.
1621

1722
---
23+
1824
### 💻Supported Platforms💻
1925

20-
- Python 3
26+
- Python 3 up to latest
2127
- Windows
22-
- Various Linux distributions
28+
- All Linux distributions
2329
- Mac OS
2430

2531
---
32+
2633
### 🔧Main Features🔧
27-
> **Hash strings**
28-
> - Hashing all strings in piece of code. It replaces all strings with their hash.
29-
> - Protects strings context.
3034

31-
> **Looping obfuscation**
32-
> - Encrypting piece of code using base64 and zlib for N times.
35+
> **Static & Runtime Protection**
36+
>
37+
> - Total advanced static and runtime protection from decompilation, reverse debug, etc.
38+
39+
> **Hash Variables**
40+
>
41+
> - Hash all variables and constants values in fragment of code.
42+
> - Protects variables and constants content.
43+
44+
> **Recursive obfuscation**
45+
>
46+
> - Recurseve encrypt fragment of code using base64 and zlib n times.
3347
> - Best way to decrease/prevent antiviruses detection.
3448
35-
> **AES encryption**
36-
> - Encrypting piece of code using AES 256 encryption algorithm.
37-
> - One of two nice ways to protect code from deobfuscation.
49+
> **Best encryption algorithms**
50+
>
51+
> - Fernet, AES-GCM, ChaCha20, Salsa20
52+
> - Symmetric cipher which offer strong confidentiality, and provide authentication and integrity to protect against tampering.
53+
54+
> **File Integrity Protection**
55+
>
56+
> - Protect files against modification.
57+
> - Advanced file hash/content integrity check and comparison.
3858
39-
> **Fernet encryption**
40-
> - Encrypting piece of code using Fernet encryption algorithm.
41-
> - One of two nice ways to protect code from deobfuscation.
4259
---
4360

4461
### 🏁Quick start🏁
62+
4563
1. Clone repo
46-
```
47-
git clone https://github.com/ByteCorum/Py-Shield.git
48-
```
64+
```
65+
git clone https://github.com/ByteCorum/Py-Shield.git
66+
```
4967
2. Install requirements
5068
```
5169
pip install -r requirements.txt
5270
```
53-
3. More info
71+
3. Usage info
5472
```
5573
py-shield --help
5674
```
5775
4. Example
58-
```
59-
py-shield --mode hashstr;crypt;looping;aes --loops 3 main.py
60-
```
76+
```
77+
py-shield obfuscate --hashdata --aes --chacha --follow-imports main.py
78+
```
6179
5. Output
6280
```
63-
from PyShield.script_67158430 import PyShield
64-
PyShield(__file__, b'x\x9c\x05\xc1I\xa2C0\x00\x00\xd0\x03Y\x18\xf0Q\xc4\\;TEM\r...')
81+
#Obfuscated by Py-Shield 3.0.0.0
82+
from PyShield.script_55958136 import PyShield, _
83+
_(PyShield(b'x\x9c\x05\xc1\xc7\xa2k@\x00\x00\xd0\x0f\xb2P\xa3,\xdeB\...')
6584
```
6685
6. Example legacy
67-
```
68-
py-shield-legacy --loops 3 --mode 2 --file main.py
69-
```
86+
```
87+
py-shield obfuscatelegacy --loops 3 --mode 2 --file code.py
88+
```
7089
7. Output legacy
7190
```
72-
_=lambda __:__import__('zlib').decompress(__import__('cryptography.fernet').fernet.Fernet(((__import__('zlib').decompress(__))[::-1].split(b'/%p@K^(Y#C/_/jUEIakSX%/'))[1]).decrypt(((__import__('zlib').decompress(__))[::-1].split(b'/%p@K^(Y#C/_/jUEIakSX%/'))[0])[::-1]);exec((_)(b'x\x9c\x15\x...')
91+
_=lambda __:__import__('zlib').decompress(__import__('cryptography.fernet').fernet.Fernet(__import__('base64').b64decode(((__import__('zlib').decompress(__))[::-1].split(b'eY3NTTr:S|dD'))[1])).decrypt(((__import__('zlib').decompress(__))[::-1].split(b'eY3NTTr:S|dD'))[0])[::-1]);exec((_x)(b'x\x9c\x15\x97U\xce\x86\...')
7392
```
7493

7594
---
7695

7796
### 📜Additional Info📜
97+
7898
> [!NOTE]
79-
> Obfuscation tool has 2 major versions legacy and global. This repo includes both of them, but we highly recommend you to use the global version, cut it much securer. Anyway, we won't end support of legacy version, so if u have issues, let us know.
99+
> Obfuscation tool has 2 major versions legacy and main. This repo includes both of them, but we highly recommend you to use the main version, cuz it much more secure. Anyway, we won't end support of legacy version, so if u have issues, let us know.
80100
81101
> [!TIP]
82102
> We highly recommend compiling obfuscated script using Nuitka. Use `--follow imports` while obfuscating to tell Nuitka what to import
103+
83104
---
84105

85106
### 📲Contacts
86107

87108
<a href="https://github.com/ByteCorum"><img src="https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white"></a>
88-
<a href="https://discordapp.com/users/798503509522645012"><img src="https://img.shields.io/badge/Discord-003E54?style=for-the-badge&logo=Discord&logoColor=white"></a>
109+
<a href="https://discordapp.com/users/798503509522645012"><img src="https://img.shields.io/badge/Discord-003E54?style=for-the-badge&logo=Discord&logoColor=white"></a>
110+
111+
---
112+
113+
### 💸Support
114+
115+
<a href="https://ko-fi.com/bytecorum"><img src="https://img.shields.io/badge/Ko--fi-F16061?style=for-the-badge&logo=ko-fi&logoColor=white"></a>
116+
89117
---
90118

91119
[⬆go up⬆](#up)

0 commit comments

Comments
 (0)