Pyarmor

https://pyarmor.readthedocs.io/zh/latest/
Admin
Pyarmor is a tool for encrypting and obfuscating Python scripts, providing script protection,...
Tokens:245,976
Snippets:1,450
Trust Score:9.6
Update:4 days ago
Show doc for...
Tokens:
Raw
### Install Pyarmor for Multiple Python Versions

Source: https://pyarmor.readthedocs.io/zh/latest/tutorial/advanced.html

Install Pyarmor for each specific Python version you intend to support.

```bash
$ python3.8 -m pip install pyarmor
$ python3.9 -m pip install pyarmor
```

--------------------------------

### setup.cfg 配置文件

Source: https://pyarmor.readthedocs.io/zh/latest/_sources/how-to/wheel.rst.txt

配置包元数据和选项，注意 package_dir 指向 dist 目录。

```ini
[metadata]
    name = parent.child
    version = attr: parent.child.VERSION

[options]
    package_dir =
        =dist/

    packages =
        parent
        parent.child
        parent.pyarmor_runtime_00xxxx

    include_package_data = True
```

--------------------------------

### Obfuscation Code Mode 2

Source: https://pyarmor.readthedocs.io/zh/latest/reference/man.html

Example of how mode 2 obfuscates attribute access.

```python
obj.attr          ==> getattr(obj, 'xxxx')
obj.attr = value  ==> setattr(obj, 'xxxx', value)
```

--------------------------------

### 构建错误堆栈

Source: https://pyarmor.readthedocs.io/zh/latest/how-to/wheel.html

构建过程中因 setuptools 静态解析加密脚本导致的错误。

```text
* Building sdist...
Traceback (most recent call last):
  File "/usr/lib/python3/dist-packages/setuptools/config/expand.py", line 81, in __getattr__
    return next(
           ^^^^^
StopIteration

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/usr/lib/python3/dist-packages/setuptools/config/expand.py", line 191, in read_attr
    return getattr(StaticModule(module_name, spec), attr_name)
```

--------------------------------

### Register Pyarmor License

Source: https://pyarmor.readthedocs.io/zh/latest/tutorial/advanced.html

Register your Pyarmor license using any one of the installed Python versions.

```bash
$ python3.8 -m pyarmor.cli reg pyarmor-regfile-xxxx.zip
```

--------------------------------

### dist/mypkg/__init.py 中导入运行辅助包的方式

Source: https://pyarmor.readthedocs.io/zh/latest/_sources/reference/man.rst.txt

当使用 --prefix 选项时，dist/mypkg/__init.py 中使用相对导入方式导入运行辅助包。

```python
from .pyarmor_runtime_000000 import __pyarmor__
__pyarmor__(__name__, __file__, b'...')
```

--------------------------------

### Restrict Package Access

Source: https://pyarmor.readthedocs.io/zh/latest/reference/man.html

Example of encrypting a package with the restrict option and testing import failures.

```bash
$ pyarmor gen -i --restrict joker
$ ls dist/
...    joker/
```

```python
import joker
print('import joker should be OK')
from joker import queens
print('import joker.queens should fail')
```

```bash
$ cd dist
$ python foo.py
... import joker should be OK
... RuntimeError: unauthorized use of script
```

--------------------------------

### 构建 Wheel 报错

Source: https://pyarmor.readthedocs.io/zh/latest/_sources/how-to/wheel.rst.txt

尝试构建 Wheel 时遇到的 setuptools 静态解析错误。

```console
$ python -m build --skip-dependency-check --no-isolation
```

```python
* Building sdist...
Traceback (most recent call last):
  File "/usr/lib/python3/dist-packages/setuptools/config/expand.py", line 81, in __getattr__
    return next(
           ^^^^^
StopIteration

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/usr/lib/python3/dist-packages/setuptools/config/expand.py", line 191, in read_attr
    return getattr(StaticModule(module_name, spec), attr_name)
```

--------------------------------

### Bind to Network Interfaces

Source: https://pyarmor.readthedocs.io/zh/latest/reference/man.html

Examples of binding encrypted scripts to specific network interface MAC addresses.

```bash
pyarmor gen -b "*IFMAC:<2a:33:50:46:8f,f0:28:69:c0:24:3a>" foo.py
```

```bash
pyarmor gen -b "eth1/fa:33:50:46:8f:3d" foo.py
```

--------------------------------

### dist/mypkg1/__init.py 中导入运行辅助包的方式

Source: https://pyarmor.readthedocs.io/zh/latest/_sources/reference/man.rst.txt

当使用 --prefix 选项时，dist/mypkg1/__init.py 中使用绝对导入方式导入运行辅助包。

```python
from mypkg.pyarmor_runtime_000000 import __pyarmor__
__pyarmor__(__name__, __file__, b'...')
```

--------------------------------

### 自定义运行辅助包名称配置

Source: https://pyarmor.readthedocs.io/zh/latest/_sources/how-to/wheel.rst.txt

修改 MANIFEST.in 和 setup.cfg 以自定义辅助包名称。

```text
recursive-include dist/parent/child/libruntime *.so
```

```ini
[options]
    ...
    packages =
        parent
        parent.child
        parent.child.libruntime
    ...
```

--------------------------------

### Example Python script for RFT renaming

Source: https://pyarmor.readthedocs.io/zh/latest/_sources/topic/rftmode.rst.txt

A sample class used to demonstrate how attribute chains like self.task.x are renamed.

```python
class Sdipmk:

    def __init__(self):
        self.width = 100
        self.height = 200

    def move(self, x, y, absolute=False):
        self.task.x = int(abs(x*65536/self.width)) if absolute else int(x)
        self.task.y = int(abs(y*65536/self.height)) if absolute else int(y)
        return Mouse(MS_MOVE, x, y)
```

--------------------------------

### 适配 Python 动态库路径

Source: https://pyarmor.readthedocs.io/zh/latest/_sources/questions.rst.txt

当系统找不到正确的 Python 动态库时，使用 install_name_tool 进行手动适配。

```bash
$ install_name_tool -change @rpath/lib/libpython3.9.dylib /usr/local/Python.framework/Versions/3.9/Python \
        /path/to/lib/pythonX.Y/site-packages/pyarmor/cli/core/pytransform3.so
```

--------------------------------

### Manual License Check in Loops

Source: https://pyarmor.readthedocs.io/zh/latest/reference/man.html

Example of adding a manual check function within an infinite loop to trigger license verification.

```python
 def pyarmor_check_license():
     pass

 def main():
     while True:
         check_pyarmor_license()
         sleep(0.01)
```

--------------------------------

### 升级管道版许可证

Source: https://pyarmor.readthedocs.io/zh/latest/_sources/how-to/register.rst.txt

升级到 Pyarmor 9.2+ 后，申请并使用新的管道注册文件。

```bash
$ pyarmor reg -C pyarmor-regfile-8000.zip
```

--------------------------------

### Private Mode Script Refactoring

Source: https://pyarmor.readthedocs.io/zh/latest/reference/man.html

Example of moving main logic to a separate module to allow private mode encryption while maintaining execution capability.

```python
def main():
    print('This is main code')

if __name__ == '__main__':
    main()
```

```python
from real_foo import main

if __name__ == '__main__':
    main()
```

--------------------------------

### 配置 foo.py 的函数排除规则

Source: https://pyarmor.readthedocs.io/zh/latest/_sources/topic/bccmode.rst.txt

展示如何通过命令行配置忽略 foo.py 中的特定函数或方法。

```console
$ pyarmor cfg -p foo bcc:excludes = "hello_a"
$ pyarmor cfg -p foo bcc:excludes = "hello_a hello_b"
$ pyarmor cfg -p foo bcc:excludes = "hello_*"

$ pyarmor cfg -p foo bcc:excludes = "Test.hello_a"
$ pyarmor cfg -p foo bcc:excludes = "Test.*"
$ pyarmor cfg -p foo bcc:excludes = "Test.__*__"

$ pyarmor cfg -p foo bcc:excludes = "hello_a Test.hello_a"
```

--------------------------------

### View configuration settings

Source: https://pyarmor.readthedocs.io/zh/latest/reference/man.html

Commands to list all configurations, a specific option, or options matching a pattern.

```bash
$ pyarmor cfg
$ pyarmor cfg obf_module
$ pyarmor cfg obf*
```

--------------------------------

### 拷贝文件到 Docker 容器

Source: https://pyarmor.readthedocs.io/zh/latest/_sources/how-to/register.rst.txt

在 Docker 主机上使用 docker cp 命令将 Pyarmor 安装包和注册文件拷贝到容器中。

```bash
$ docker cp pyarmor-8.4.1.tar.gz 86b180b28a50:/
$ docker cp pyarmor.cli.core-5.4.1-cp311-none-manylinux1_x86_64.whl 86b180b28a50:/
$ docker cp pyarmor-device-regfile-6000.1.zip 86b180b28a50:/
```

--------------------------------

### 验证特殊脚本补丁

Source: https://pyarmor.readthedocs.io/zh/latest/_sources/reference/environments.rst.txt

通过绑定数据加密脚本并运行，验证 bootstrap 函数的逻辑。

```bash
$ pyarmor gen --bind-data 12345 foo.py
$ python dist/foo.py
```

--------------------------------

### 配置 PyInstaller 选项 -w

Source: https://pyarmor.readthedocs.io/zh/latest/topic/repack.html

通过 pack:pyi_options 配置项设置不显示控制台窗口。

```bash
$ pyarmor cfg pack:pyi_options = " -w"
```

--------------------------------

### 使用 onefile 模式打包

Source: https://pyarmor.readthedocs.io/zh/latest/_sources/topic/repack.rst.txt

使用 --pack onefile 命令将项目打包为单个可执行文件。

```console
$ cd project
$ pyarmor gen --pack onefile foo.py
```

--------------------------------

### 使用 CLI 增加 BCC 编译选项

Source: https://pyarmor.readthedocs.io/zh/latest/topic/bccmode.html

在 32 位 Windows 环境下，通过 pyarmor cfg 命令为 BCC 模式添加额外的编译选项。

```bash
pyarmor cfg windows.x86.bcc:cflags += " -DENABLE_BCC_MEMSET"
```

--------------------------------

### 启用 RFT 模式的命令

Source: https://pyarmor.readthedocs.io/zh/latest/_sources/topic/rftmode.rst.txt

使用 pyarmor gen --enable-rft 命令直接启用 RFT 模式，或通过 pyarmor cfg enable_rft=1 配置后使用 pyarmor gen 启用。

```console
$ pyarmor gen --enable-rft foo.py
```

```console
$ pyarmor cfg enable_rft=1
$ pyarmor gen foo.py
```

--------------------------------

### 生成单个可执行文件模式

Source: https://pyarmor.readthedocs.io/zh/latest/tutorial/obfuscation.html

使用 pyarmor gen --pack onefile 生成单个可执行文件。该命令会加密 foo.py 及其同目录下被引用的模块，然后调用 PyInstaller 打包成 dist/foo。注意命令行中的脚本必须未加密。

```bash
$ pyarmor gen --pack onefile foo.py

```

```bash
$ ls dist/foo
$ dist/foo

```

--------------------------------

### 手动修改加密后的脚本

Source: https://pyarmor.readthedocs.io/zh/latest/_sources/how-to/wheel.rst.txt

在加密后的 __init__.py 中手动添加运行时导入以绕过静态解析限制。

```python
from pyarmor_runtime_00xxxx import __pyarmor__
VERSION = '0.0.1'
...
```

--------------------------------

### 配置根目录

Source: https://pyarmor.readthedocs.io/zh/latest/_sources/reference/man.rst.txt

通过 --home 选项修改根目录路径，从而影响全局配置和注册文件的存放位置。

```console
$ pyarmor --home ~/.pyarmor2 ...
```

--------------------------------

### 通过配置文件启用 RFT 模式

Source: https://pyarmor.readthedocs.io/zh/latest/topic/rftmode.html

使用 pyarmor cfg 命令在配置文件中设置 enable_rft，然后生成脚本。

```bash
$ pyarmor cfg enable_rft=1
$ pyarmor gen foo.py
```

--------------------------------

### 升级集团版许可证

Source: https://pyarmor.readthedocs.io/zh/latest/_sources/how-to/register.rst.txt

升级到 Pyarmor 9.2+ 后，更新设备注册文件以使用新版本。

```bash
$ pyarmor reg -g 1 /path/to/pyarmor-regfile-6000.zip
```

--------------------------------

### 使用现有 spec 文件打包加密脚本

Source: https://pyarmor.readthedocs.io/zh/latest/_sources/reference/man.rst.txt

如果已有 foo.spec 并能成功打包未加密脚本，可将其传递给 --pack 来打包加密脚本。Pyarmor 会加密脚本，读取 foo.spec 并创建补丁文件 foo.patched.spec，然后使用该补丁文件打包。注意：此方式不会自动加密其他脚本，所有需要加密的脚本必须在命令行列出。

```shell
$ pyarmor gen --pack foo.spec -r foo.py util.py joker/
$ ls dist/
```

--------------------------------

### 使用只读模式加密整个包

Source: https://pyarmor.readthedocs.io/zh/latest/tutorial/obfuscation.html

在启用只读模式后，使用 --enable-jit 和 --mix-str 选项加密整个包 joker/。

```bash
$ pyarmor gen --enable-jit --mix-str joker/

```

--------------------------------

### 配置 PyInstaller 选项

Source: https://pyarmor.readthedocs.io/zh/latest/_sources/topic/repack.rst.txt

通过 pack:pyi_options 配置项传递 PyInstaller 参数，如隐藏控制台窗口、添加图标或数据文件。

```console
$ pyarmor cfg pack:pyi_options = " -w"
$ pyarmor cfg pack:pyi_options + " -i favion.ico"
$ pyarmor cfg pack:pyi_options + "--add-data joker/config.json:joker"
$ C:/User/test> pyarmor cfg pack:pyi_options + "--add-data joker/config.json;joker"
$ pyarmor cfg pack:pyi_options = " -w  -i favion.ico --add-data joker/config.json:joker"
```

--------------------------------

### 生成单个可执行文件模式

Source: https://pyarmor.readthedocs.io/zh/latest/_sources/tutorial/obfuscation.rst.txt

使用 --pack onefile 将加密脚本及其依赖打包为单个可执行文件。

```bash
$ pyarmor gen --pack onefile foo.py
$ ls dist/foo
$ dist/foo
```

--------------------------------

### 配置只读模式并导出模块

Source: https://pyarmor.readthedocs.io/zh/latest/tutorial/obfuscation.html

启用只读模式，并将需要输出的模块 joker.card 和 joker.__init__ 添加到 exclude_restrict_modules 配置项，然后使用更多选项加密包。

```bash
$ pyarmor cfg readonly_module=1
$ pyarmor cfg exclude_restrict_modules="joker.card joker.__init__"
$ pyarmor gen --enable-jit --mix-str --assert-call --assert-import --restrict joker/

```
Tokens:
Raw