-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
executable file
·98 lines (88 loc) · 4.33 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="A tool used to obfuscate python scripts." />
<meta name="Keywords" content="python, obfuscate, obfuscation, obfuscator" />
<title>Pyarmor - Obfuscate Python Scripts</title>
</head>
<body>
<h1 id="pyarmor">Pyarmor</h1>
<p>Pyarmor is a command line tool used to import or run obfuscated python scripts. Only by a few extra files, pyarmor can run and imported obfuscated files as normal python scripts.</p>
<p>Pyarmor just likes an enhancement which let python could run or import obfuscated files.</p>
<h2 id="main-features">Main Features</h2>
<ul>
<li>Run obfuscated script or import obfuscated module</li>
<li>Expire obfuscated files</li>
<li>Bind obfuscated files to harddisk, mac address, ip address etc.</li>
</ul>
<h2 id="obfuscation-mechanism">Obfuscation Mechanism</h2>
<p>Pyarmor obfuscates python scripts by 2 ways:</p>
<ul>
<li><p>First obfuscate byte code of each code object</p></li>
<li><p>Then obfuscate whole code object of python script</p></li>
</ul>
<p>More information refer to <a href="https://github.com/dashingsoft/pyarmor/blob/master/src/mechanism.md">How to obfuscate python scripts</a></p>
<h2 id="support-platforms">Support Platforms</h2>
<ul>
<li><p>Python 2.5, 2.6, 2.7 and Python3</p></li>
<li><p>Prebuilt Platform: win32, win_amd64, linux_i386, linux_x86_64, macosx_intel</p></li>
<li><p>Embeded Platform: Raspberry Pi, Banana Pi, TS-4600 / TS-7600</p></li>
</ul>
<h2 id="quick-start">Quick Start</h2>
<h3 id="installation">Installation</h3>
<p>The simple way is pip</p>
<pre><code> pip install pyarmor</code></pre>
<p>Or get source package from <a href="https://pypi.python.org/pypi/pyarmor">pypi/pyarmor</a></p>
<p>Pyarmor is a command line tool, main script is pyarmor.py. After you get source package, unpack it to any path, then run paramor.py as common python script</p>
<pre><code> python pyarmor.py</code></pre>
<p>If Pyarmor is installed by pip, there is a command will be avaiable in Python script path</p>
<pre><code> pyarmor</code></pre>
<h3 id="basic-usage">Basic Usage</h3>
<p>The following examples show how to obfuscate a python package <strong>pybench</strong>, which locates in the <strong>examples/pybench</strong> in the source of pyarmor.</p>
<p>Obfuscate package <strong>pybench</strong> directly:</p>
<pre><code> python pyarmor.py obfuscate --src examples/pybench --entry pybench.py \
"*.py" "package/*.py"
# Note that quotation mark is required for file patterns, otherwise
# it will be expanded base on current path by shell.
#
# This command will create an extra file .pyarmor_capsule.zip in the
# --src path, and save all the obfuscated scripts to default output
# path "dist" in the current path
#
cd dist
# Check obfuscated script
cat pybench.py
# Run obfuscated script
python pybench.py</code></pre>
<p>Use project to manage obfuscated scripts:</p>
<pre><code> mkdir projects
python pyarmor.py init --src examples/pybench --entry pybench.py \
projects/pybench
# This command will create 2 files: .pyarmor_config, .pyarmor_capsule.zip
# in the project path "projects/pybench"
cd projects/pybench
# And there is a shell script "pyarmor" is created at the same time.
# (In windows, the name is "pyarmor.bat")
#
# Now run command "build" to obfuscated all the scripts
#
./pyarmor build
# Check obfuscated script
cd dist
cat pybench.py
# Run obfuscated script
python pybench.py</code></pre>
<p>There is a webui used to manage project easily. Start it</p>
<pre><code> # For windows
src/webui/manager.bat
# For linux
src/webui/manager.sh
# If Pyarmor is installed by pip
pyarmor-webui</code></pre>
<p>Here is online demo <a href="http://pyarmor.dashingsoft.com">http://pyarmor.dashingsoft.com</a></p>
<p>More information, refer to <a href="https://github.com/dashingsoft/pyarmor">https://github.com/dashingsoft/pyarmor</a></p>
<p>Any question feel free email to <a href="mailto:jondy.zhao@gmail.com">jondy.zhao@gmail.com</a></p>
</body>
</html>