使用encryptpy加密你的Python项目
Python作为动态语言一般是以源码方式进行部署的，这就意味着他人在部署机器上可以直接获取项目代码，可能给作者带来不必要的损失和风险，这就需要对代码进行加密或混淆。常规的几种加密（混淆）方式如下：
- 编译为pyc文件
- 使用打包工具打包
- 使用Cython将Python代码编译为二进制
1和2都很容易被反编译或解包获取源码，而使用Cython将Python代码以extension的方式进行编译可以极大地提高安全性，但是需要一个友好的工具来方便地对整个项目进行加密，encryptpy 就是干这个的。
encryptpy使用Cython将Python代码编译为二进制以达到加密的目的，并且支持通过git-diff来获取两次提交间的差异文件，方便地进行编译。
安装
$ pip install encryptpy
基本用法
Usage: encryptpy [OPTIONS] COMMAND [ARGS]...
Encrypt your Python code
Options:
--config TEXT The config file, ignore if given is invalid [default:
.encryptpy.cfg]
--help Show this message and exit.
Commands:
clean Simply clean `build` and `__pycache__` directory in DIRS
git-diff Compile files between two COMMITS, see `git-diff`: `--name-only`
init Copy src to build-dir and do compile, usually used for the...
run Compile given Python code files
子命令用法可以使用encryptpy <subcommand> --help来查看。
例子
比如当前路径下有一个包名叫package_a，其目录结构如下：
$ tree -a .
.
├── .encryptpy.cfg
└── package_a
├── __init__.py
├── main.py
├── README.md
├── setup.py
└── utils.py
1 directory, 6 files
配置文件 .encryptpy.cfg的内容如下
[encryptpy]
; 将被编译的文件
paths =
package_a
; 编译时忽略的文件，支持正则
ignores =
setup.py
; 用于子命令`init`, 拷贝项目时会忽略的文件，Glob风格
copy_ignores =
*.pyc
*.md
; The build directory
build_dir = build
; 用于子命令`run` and `git-diff`, 编译后是否移除源.py文件
clean_py = 0
以下例子均按照上面.encryptpy.cfg的配置运行。
1. 项目第一次使用，使用init
$ encryptpy init .
查看build目录：
$ tree -a build
build
├── .encryptpy.cfg
└── package_a
├── __init__.cpython-38-x86_64-linux-gnu.so
├── main.cpython-38-x86_64-linux-gnu.so
├── setup.py
└── utils.cpython-38-x86_64-linux-gnu.so
1 directory, 5 files
可以发现init子命令的作用是将当前目录内容拷贝到build目录下（根据配置文件忽略不需拷贝的内容）并执行编译（忽略不需编译的文件）。
2. 使用run
run子命令则是将指定的Python文件编译。
$ encryptpy run package_a/main.py
文件 package_a/main.py 会被重新编译至 package_a/main.cpython-38-x86_64-linux-gnu.so。
3. 使用 git-diff
如果上次部署时项目的tag为0.1，现在需要更新到0.2，只需要更新这两个tag之间变更的文件而不是整个项目，子命令git-diff就是干这个的。
$ encryptpy git-diff 0.1 0.2
标签（或commit，或branch）0.1和0.2之间的差异文件会被编译至对应位置，项目完成更新。
缺陷
主要的缺陷来自于Cython，一些Python语法无法被正确地编译，以下是已知的问题：
-
赋值表达式（海象运算符） :=: Implement PEP 572: Assignment Expressions #2636 -
@dataclass: Implement @dataclass for cdef classes #2903 -
Class method decorators combination: Combining @staticmethod with other decorators is broken #1434 e.g. class C:
@staticmethod
@some_decorator
def f():
pass
但是可以改写为 f = staticmethod(some_decorator(f))。
如果你有一些和上面一样的代码，要么改写要么简单地忽略它们，毕竟对大多数项目来说展示一些代码不影响其安全。
|