Change Logs

Incompatible issues

  • Incompatible of the license.lic

    v6.0.1

    The license file generated by this version doesn’t work with the old obfuscated scripts. There are 2 solutions for this case, still generating the license file with old version pyarmor, or obfuscating the scrips again by new version pyarmor.

    However license.lic generated by old version still works. That is to say, even all the scripts are obfuscated by new version, you need not issue new license file to customers, because the previous license file still works.

  • Incompatible of the obfuscated scripts

    Generally obfuscate part of scripts by new version, then overwrite the old scripts obfuscated by other version, it still works.

    Except the following versions:

    v6.3.0

    The scripts are obfuscated by this version and later, can not mixed with the ones obfuscated by ealier version. All the scripts must be obfuscated again and replace the old runtime files with new ones.

6.6.1 (pre-release)

  • Fix issue (#429): the new license doesn’t work if replace the old license with it in enable-period-mode
  • Fix extension filenames conflict for multiple platforms in super mode
  • Fix issue (#442): the target platforms in the runtime settings is read as a list

6.6.0

6.5.6

  • Rename option --runtime-path to -rpath in command config
  • Fix issue (#403): the obfuscated scripts raise unexpected exception in Python 2.7 (non-super mode)
  • Add new platform centos6.x86_64.11.py27 for Python 2.7 built with UCS2 and platform glibc < 2.14
  • Add new command help to open online documentation in the web browser
  • Fix issue (#408): undefined symbol PyUnicodeUCS2_AsUTF8String in arm platforms for Python 2.7
  • Rename platform name darwin.arm64 to darwin.aarch64
  • Add new platform darwin.aarch64.3, darwin.aarch64.11.py38 and darwin.aarch64.11.py39 to support Apple Silicon
  • In project copy non .py files to output directly if they’re specified in the project manifest
  • Fix issue (#414): repack doesn’t patch the final bundle in some platforms
  • Fix issue (#415): when repacking an executable where the embedded PKG archive contains subdirectories, the repack script fails

6.5.5

6.5.3

  • Refine output message when checking registration information by command pyarmor register
  • Runtime function get_hd_info accepts keyword parameters name to get hardware information of named device
  • Command hdinfo accepts optional parameter name
  • Command licenses could bind obfuscated scripts to named hard disk
  • Print pretty error message if checking license or loading core dynamic library fails when running non-super mode obfuscated scripts
  • Fix issue (#387): exception Function does not end with “):” is raised when obfuscating the scripts

6.5.2

  • The command register also could register any text file only if it includes registration code in one single line
  • Add new option –buy for command register, which used to open shopping cart of PyArmor: pyarmor register –buy

6.5.1

  • Fix issue: it raises exception to register a code by Python 2.7

6.5.0

  • Support super mode for Python3.9
  • Show deprecation warning for –advanced 1 and –advanced 3 if super mode is available, use –advanced 2 and –advanced 4 instead
  • Both registration code and file are supported by the command register

6.4.4

  • Fix issue (#355): the obfuscated script raises DeprecationWarning when getting user data from license file in super mode with Python3.8
  • Fix issue (#357): Python3.9 doesn’t work, the obfuscated scripts raise unknow opcode 53/88 and segmentation fault

6.4.3

  • Fix issue(#337): project can’t be configured with outer license
  • Fix issue(#342): in Windows command pack doesn’t work if the project isn’t in the same drive of entry script

6.4.2

  • Support binding multiple mac addresses in one machine by format <Mac1,Mac2,Mac3…> in Windows and Linux
  • For platform linux.x86_64 and linux.x86, the core libraries of super mode for Python2.7 are linked to usc4, the old ones are linked to ucs2
  • Fix pack command issue: outer license may not work in some cases
  • The platform linux.armv6 supports super mode

6.4.1

  • Fix bug: for big endian platform, it raises RuntimeError: Invalid extension, no data found when obfuscating scripts (#323)
  • Fix bug: when obfuscating some special scripts in super mode, it raises RuntimeError: Patch function “xxx” failed (#326)
  • Fix serial number of hard disk issue in Windows: the last character is missed in some special cases

6.4.0

  • Command obfuscate accepts multiple arguments as entry scripts
  • Fix restrict mode crash issue for Python3.5~3.8 in 32-bit Windows
  • Fix super mode issue: attempted relative import beyond top-level package
  • Improve security of restrict mode
  • For restrict mode 2, do not protect module attributes for performance
  • Add restrict mode 5 to protect globals in functions
  • Refine the documentation of restrict mode: https://pyarmor.readthedocs.io/en/latest/mode.html#restrict-mode
  • Fix platform centos6.x86_64 not found issue (#312)
  • On Linux for command licenses the option –bind-mac supports new format: IfName/MacAddress, for example, eth0/00:28:54:af:28

6.3.7

  • A big improvement for restrict mode: the plain script couldn’t visit any module attribute if this module is obfuscated by restrict mode 2, 3 or 4
  • Add option –runtime for command obfuscate, build
  • In command runtime, deprecate option –super-mode and –vm-mode, use –advanced instead.
  • Fix encoding issue: couldn’t get the right encoding if source encoding is in the second line
  • Refine example scripts

6.3.6

  • Fix pack issue: if pyi-makespec could not be found, it will complain of OSError: [WinError 2] The system cannot find the file specified.
  • Fix PYTHONOPTIMIZE=2 doesn’t work issue
  • Fix super mode issue: auto patch failed if there are multiple lines in function header
  • Fix command register issue: it could not show registration information even if register successfully. It’s introduced in v6.3.5.

6.3.5

  • Fix pack project issue: not all the scripts in the project are re-obfuscated when packing the project again.
  • Clean license.lic in the pyarmor package if option –home isn’t used

6.3.4

  • Fix option –home issue: the file license.lic in this path doesn’t work
  • Improve the security of core dynamic libraries

6.3.3

  • Fix sub-package could not import pytransform when it’s obfuscated by –bootstrap 3 in super mode
  • For Windows platform, add new modes –advanced 3 and –advanced 4 to enable vm protection. Refer to https://pyarmor.readthedocs.io/en/latest/mode.html#vm-mode
  • The default value of option obf-mod is set to 2
  • Add new platform linux.mips64 and linux.mips64el
  • Fix super mode crash issue for linux.armv7 and linux.aarch32

6.3.2

  • Fix super mode crash issue for Python37/38 in Windows
  • Fix command pack issue: the obfuscation option –enable-suffix doesn’t work

6.3.1

  • Fix super mode crash issue for Coroutine functions
  • Fix super mode exception issue
  • Fix restrict mode 3/4 doesn’t work in some cases
  • Fix super mode will complain of insert one redundant line ‘[None, None]’ issue

6.3.0

From this version, only 2 runtime files are required for non-super mode:

  • pytranform.py
  • _pytransform.so/dll/dylib

Most of the algorithm are refined to improve the security.

  • Refine the algorithm to improve security and performance
  • Refine default cross protection code
  • Refine runtime files, remove license.lic and pytransform.key
  • Refine pack command
  • Refine the obfuscating process for cross platforms
  • Refine benchmark command, and new option –advanced Refer to https://pyarmor.readthedocs.io/en/latest/performance.html
  • Add platform musl.mips32 for MIPS32 with musl-libc
  • Add common options –boot for special cross platform obfuscating
  • Rename platform names alpine.* to musl.*

Upgrade notes

The scripts are obfuscated by old version could not work with this version, they must be obfuscated again.

6.2.9

  • Fix cross platform bug: in Windows it may raise exception can’t open file ‘…Scriptspyarmor’: [Errno 2] No such file or directory
  • Fix super mode bug: in some cases super mode will raise exception unknown opcode

6.2.8

  • Fix arch ppc64le could not work issue
  • In pack command, clean build cache automatically before packing the obfuscated scripts

6.2.7

  • Fix a crash issue in Darwin platform
  • Fix super mode issue in Darwin: the obfuscated scripts report “image not found” (#256)
  • Document experiment feature: how to protect data file

6.2.6

  • Fix get_license_info issue: the value of CODE is blank

6.2.5

  • Add option –with-license in the command build
  • Fix pack issue: the option –with-license doesn’t work in super mode
  • If the code object couldn’t be obfuscated in advanced 2 (super mode), fix it automatically by inserting one redundant line [None, None] at the beginning of this code object
  • Ignore case when checking mac address if the license is bind to network card
  • Add key ISSUER in the return value of get_license_info

6.2.4

  • Fix pack issue for Mac in super mode: RuntimeError: unexpected pytransform.so
  • Fix pack issue for windows 32-bit system: the default license doesn’t work in other machines, it complains of License is not for this machine

6.2.3

  • Add common option --home, so PYARMOR_HOME can be set in the command line
  • Fix pack issue: pack command may not work with super mode

6.2.2

  • Fix advanced mode issue: advanced mode 1 doesn’t work in pyenv and some platforms
  • Fix issue(#244): when obfuscating the scripts for cross platform and only one platform specified, the obfuscated scripts raise unexpected protection error.

6.2.1

  • Fix issue(#244): when specify only one platform the obfuscated scripts raise exception:

    [Errno 2] No such file or directory: 'xxx/_pytransform.so'
    
  • Super mode supports windows.x86, linux.x86, linux.aarch64, linux.aarch32, linux.armv7

6.2.0

In this version, super mode is introduced to improve the security. In this mode the structure of PyCode_Type is changed, and byte code or word code is mapped, it’s the highest security level in PyArmor. There is only one runtime file required, that is extension module pytransform, and the form of obfuscated scripts is unique, no so called Bootstrap Code which may make some users confused. All the obfuscated scripts would be like this

from pytransform import pyarmor
pyarmor(__name__, __file__, b'\x0a\x02...', 1)

It’s recommended to enable this mode in suitable cases. Now only the latest Python versions are supported:

  • Python 2.7
  • Python 3.7
  • Python 3.8

It may support Python 3.5, 3.6 later, but Python 3.0~3.4 is out of plan.

  • Add new option –obf-mode, –obf-code, –wrap-mode to command obfuscate
  • Add new value 2 for option –advanced to enable super mode, refer to Using Super Mode
  • Fix multiprocessing issue: ValueError: __mp_main__.__spec__ is None (#232)
  • The command runtime will generate default protection script pytransform_protection.py
  • Add new option –cross-protection to command obfuscate to specify customized protection script
  • The default cross protection code will not be injected the entry script if –no-runtime is specified as obfuscating the scripts. In this case, use option –cross-protection to specify one protection script
  • Change the default capsule location from ~/.pyarmor_capsule.zip to ~/.pyarmor/.pyarmor_capsule.zip
  • Add new functions get_user_data, assert_armored in runtime module pytransform
  • Document how to store runtime file license.lic to any location
  • Remove the trailing dot from harddisk serial number, it may impact the license verified.

6.1.0

  • Add external plugin script assert_armored.py
  • Enhance the command licenses:
    • The final argument could be empty, for example, pyarmor licenses will generate a default license to licenses/pyarmor/license.lic
    • If the output is end with license.lic, it will not append any other path, just save it as it is. For example, pyarmor licenses -O dist/license.lic will save the final output to dist/license.lic
    • Add new option –fixed, and document how to use this option to improve the security
  • In command pack, the default license will be generated with –fixed to improve the security

6.0.2

6.0.1

  • Fix restrict mode 3 bug: the obfuscated script crashes or complains of this error: This function could not be called from the plain script (#219)
  • Fix bug: the obfuscated script raises unknown opcode error when the script is obfuscated by obf_code=2 if there is recursive function call
  • Fix command init and config bug: the entry script is set to . other than empty when passing --entry=""
  • Fix bug: the traceback will print very long line if the obfuscated script raises exception
  • Fix bug: in some special cases the obfuscated scripts which are obfuscated with --enable-suffix still conflict with other obfuscated packages
  • Refine the error message as violating restrict mode
  • The obfuscated script will raise exception RuntimeError other than quit directly when something is wrong Now it will print a pretty traceback to find where is the problem
  • When generating license.lic for the obfuscated scripts, the license version information will be embedded into the license file implicitly
  • Do not transfer exception type to PytransformError as pyarmor initializes failed

Upgrade notes:

The license file generated by this version doesn’t work with the old obfuscated scripts. There are 2 solutions for this case:

  • Still generating the license file with old version pyarmor
  • Or obfuscating the scrips again by new version pyarmor

5.9.8

  • Fix restrict mode 3 bug: the obfuscated function failed if it’s called from generator function even in the obfuscated script.
  • In pack command it will try to use the encoding coding: xxx in the first comment line of .spec file

5.9.7

  • Fix pack issue: it will raise UnicodeDecodeError when the source path includes non-ascii characters(#217)
  • Fix obfuscate issue for Python2: it will raise UnicodeDecodeError when the source path includes non-ascii characters
  • Refine pack command: it will print the output of PyInstaller to the console either

5.9.6

5.9.5

  • Change the plugin search policy, do not support enviorment variable PYARMOR_PLUGIN, but search folder plugins in the pyarmor package path.

  • Add a new path plugins in the package source, there are several common plugins. So it’s easy to check internet time by this way:

    pyarmor obfuscate --plugin check_ntp_time foo.py
    

    Before that both of these lines should be inserted into foo.py:

    # {PyArmor Plugins}
    # PyArmor Plugin: check_ntp_time()
    
  • Fix pack bug: pyi-makespec: error: unrecognized arguments: -y if extra options are passed

  • Document command pack in details: https://pyarmor.readthedocs.io/en/latest/man.html#pack

5.9.4

5.9.3

  • Add new option --enable-period-mode in the command licenses
  • When running the obfuscated scripts it will check license periodly (per hour) if the option --enable-period-mode is set in the license file

5.9.2

  • Fix bug: the command pyarmor runtime –platform alpine.x86_64 raises error (#201)
  • Fix bug: the platform linux.armv6 doesn’t work in Raspberry PI Zero W, rebuild the dynamic library with -march=armv6 -mfloat-abi=hard -marm

5.9.1

  • Python debugger and profile tool could work with the plain python scripts even if the obfuscated packages are imported. Note that the obfuscated scripts still couldn’t be traced.
  • Refine pack command, use pyi-makespec to generate .spec file
  • Fix advanced mode fails in some linux platforms
  • Support platform linux.armv6
  • Fix python38 issue: in the wrap mode the footer block isn’t executed

5.9.0

pyarmor-webui is published as a separated package, it has been removed from source package of pyarmor. Now it’s a full feature webui, and could be installed by pip install pyarmor-webui.

  • Support environment variable PYARMOR_HOME as one extra path to find the license.lic of pyarmor. Now the search order is:

    • In the package path of pyarmor
    • $PYARMOR_HOME/.pyarmor/license.lic
    • $HOME/.pyarmor/license.lic
    • $USERPROFILE/.pyarmor/license.lic (Only for Windows)
  • In command licenses if option output is set, do not append extra path licenses in the final output path

  • In command obfuscate with option –exact, all the scripts list in the command line will be taken as entry script.

  • The last argument in command pack could be a project path or .json file

  • Add new option --name in the command pack

  • Add new project attribute license_file, bootstrap_code

  • Add new option --with-license, --bootstrap in the command config

  • Add new option --bootstrap in the command obfuscate

  • The options --package-runtime doesn’t support 2 and 3, use --bootstrap=2 or --bootstrap=3 instead

  • For command licenses the generated license could be printed to stdout by setting the option --output to stdout

5.8.9

  • Fix cross platform issue for vs2015.x86 and vs2015.x86_64
  • In command config add option --advanced as alias of --advanced-mode

5.8.8

  • Fix issue: the obfuscated scripts will crash when importing the packages obfuscated with advanced mode by other registered pyarmor

5.8.7

In this version, the scripts could be obfuscated with option --enable-suffix, then the name of the runtime package and builtin functions will be unique. By this way the scripts obfuscated by different capsule could run in the same Python interpreter.

For example, the bootstrap code may like this with suffix _vax_000001:

from pytransform_vax_000001 import pyarmor_runtime
pyarmor_runtime(suffix="_vax_000001")

Refer to https://pyarmor.readthedocs.io/en/latest/advanced.html#obfuscating-package-no-conflict-with-others

  • Add option --enable-suffix in the commands obfuscate, config and runtime
  • Add option --with-license in the command pack
  • Fix issue: the executable file made by pack raises protection fault exception on MacOSX

5.8.6

  • Raise exception other than sys.exit(1) when pyarmor_runtime fails
  • Refine cross protection code to improve the security
  • Fix issue: advanced mode fails in some MacOSX machines with python2.7

5.8.5

  • Add platform data file index.json to source package
  • Refine core library for platform MacOSX

5.8.4

  • Fix issue: advanced mode doesn’t work in some MacOSX machines.
  • Fix issue: can’t get the serial number of SSD harddisk in MacOSX platform

5.8.3

  • Fix issue: the _pytransform.dll for windows.x86_64 is not latest

5.8.2

  • Fix issue: the option --exclude in command obfuscate could not exclude .py files
  • Refine command pack

5.8.1

  • Fix issue: check license failed if there is no environment variable HOME in linux platform
  • Add new value 3 for option --package-runtime, the bootstrap code will always use relative import with an extra leading dot
  • The command runtime also generates bootstrap script pytransform_bootstrap.py
  • Add option --inside in command runtime to generate bootstrap package pytransform_bootstrap
  • Document how to run unittest of obfuscated scripts, refer to https://pyarmor.readthedocs.io/en/latest/advanced.html#run-unittest-of-obfuscated-scripts

5.8.0

  • Move the license file of pyarmor from the install path of pyarmor package to user home path ~/.pyarmor
  • Refine error messages so that the users could solve most of problems by the hints.
  • Refine command pack, use hook hook-pytransform.py to add the runtime files.
  • The command pack supports customized spec file, refer to https://pyarmor.readthedocs.io/en/latest/advanced.html#bundle-obfuscated-scripts-with-customized-spec-file
  • In runtime module pytransform, the functions may raise Exception instead of PytransformError in some cases.
  • In command register, add option --legency to store license.lic in the traditional way
  • Fix platform name issue: in some linux platforms the platform name may not be right

5.7.10

  • Fix new linux platform centos6.x86_64 issue: raise TypeError when run pyarmor twice.

5.7.9

  • Support new linux platform centos6.x86_64, arch is x86_64, glibc < 2.14
  • Do not print traceback if no option --debug specified as running pyarmor

5.7.8

  • When the obfuscated scripts raise exception, eliminate the very long line from traceback to make it clear

5.7.7

  • Fix issue: pyarmor load _pytransform.dll faild by 32-bit Python in 64-bit Windows.

5.7.6

  • Add option --update for command download to update all the downloaded dynamic libraries automatically
  • Fix issue: the obfuscated script raises unexpected exception when the license is expired

5.7.5

5.7.4

  • Fix issue: command obfuscate fails if the option --src is specifed

5.7.3

  • Refine pytransform to handle error message of core library
  • Refine command online help message
  • Sort the scripts being to obfuscated to fix some random errors (#143)
  • Raise exception other than call sys.exit if pyarmor is called from another Python script directly
  • In the function get_license_info of module pytransform
    • Change the value to None if there is no corresponding information
    • Change the key name expired to upper case EXPIRED

5.7.2

  • Fix plugin codec issue (#138): ‘gbk’ codec can’t decode byte 0x82 in position 590: illegal multibyte sequence
  • Project src may be relative path base on project path
  • Refine plugin and document it in details: https://pyarmor.readthedocs.io/en/v5.7.2/how-to-do.html#how-to-deal-with-plugins
  • Add common option --debug for pyarmor to show more information in the console
  • Project commands, for examples build, cofig, the last argument supports any valid project configuration file

5.7.1

  • Add command runtime to generate runtime package separately
  • Add the first character as alias for command obfuscate, licenses, pack, init, config, build
  • Fix cross platform obfuscating scripts don’t work issue (#136). This bug should be exists from v5.6.0 to v5.7.0 Related target platforms armv5, android.aarch64, ppc64le, ios.arm64, freebsd, alpine, alpine.arm, poky-i586

5.7.0

There are 2 major changes in this version:

  1. The runtime files are saved in the separated folder pytransform as package:

    dist/
        obf_foo.py
    
        pytransform/
            __init__.py
            license.lic
            pytransform.key
            ...
    

Upgrade notes:

  • If you have generated new runtime file “license.lic”, it should be copied to dist/pytransform other than dist/

  • If you’d like to save the runtime files in the same folder with obfuscated scripts as before, obfuscating the scripts with option package-runtime like this:

    pyarmor obfuscate --package-runtime=0 foo.py
    pyarmor build --package-runtime=0
    
  1. The bootstrap code must be in the obfuscated scripts, and it must be entry script as obfuscating.

Upgrade notes:

  • If you have inserted bootstrap code into the obfuscated script dist/foo.py which is obfuscated but not as entry script manually. Do it by this command after v5.7.0:

    pyarmor obfuscate --no-runtime --exact foo.py
    
  • If you need insert bootstrap code into plain script, first obfuscate an empty script like this:

    echo "" > pytransform_bootstrap.py
    pyarmor obfuscate --no-runtime --exact pytransform_bootstrap.py
    

    Then import pytransform_bootstrap in the plain script.

Other changes:

  • Change default value of project attribute package_runtime from 0 to 1
  • Change default value of option --package-runtime from 0 to 1 in command obfuscate
  • Add option --no-runtime for command obfuscate
  • Add optioin --disable-restrict-mode for command licenses

5.6.8

  • Add option --package-runtime in command obfuscate, config and build
  • Add attribute package_runtime for project
  • Refine default cross protection code
  • Remove deprecated flag for option --src in command obfuscate
  • Fix help message errors in command obfuscate

5.6.7

  • Fix issue (#129): “Invalid input packet” on raspberry pi (armv7)
  • Add new obfuscation mode: obf_code == 2

5.6.6

  • Remove unused exported symbols from core libraries

5.6.5

  • Fix win32 issue: verify license failed in some cases
  • Refine core library to improve security

5.6.4

  • Fix segmentation fault issue for Python 3.8

5.6.3

  • Add option -x in command licenses to save extra data in the license file. It’s mainly used to extend license type.

5.6.2

  • Fix pyarmor-webui start issue in some cases: can’t import name ‘_project’

5.6.1

  • The command download will check the version of dynamic library to be sure it works with the current PyArmor.

5.6.0

In this version, new private capsule, which use 2048 bits RSA key to improve security for obfucated scripts, is introduced for purchased users. All the trial versions still use one same public capsule which use 1024 bits RSA keys. After purchasing PyArmor, a keyfile which includes license key and private capsule will be sent to customer by email.

For the previous purchased user, the old private capsules which are generated implicitly by PyArmor after registered PyArmor still work, but maybe not supported later. Contact jondy.zhao@gmail.com if you’d like to use new private capsule.

The other changes:

  • Command register are refined according to new private capsule

Upgrade Note for Previous Users

There are 2 solutions:

  1. Still use old license code.

It’s recommanded that you have generated some customized “license.lic” for the obfuscated scrips and these “license.lic” files have been issued to your customers. If use new key file, all the previous “license.lic” does not work, you need generate new one and resend to your customers.

Actually the command pip install –upgrade pyarmor does not overwrite the purchased license code, you need not run command pyarmor register again. It should still work, you can check it by run pyarmor -v.

Or in any machine in which old version pyarmor is running, compress the following 2 files to one archive “pyarmor-regfile.zip”:

  • license.lic, which locates in the installed path of pyarmor
  • .pyarmor_capsule.zip, which locates in the user HOME path

Then register this keyfile in the new version of pyarmor

pyarmor register pyarmor-regfile.zip
  1. Use new key file.

It’s recommanded that you have not yet issued any customized “license.lic” to your customers.

Forward the purchased email received from MyCommerce to jondy.zhao@gmail.com, and the new key file will be sent to the registration email. If pyarmor license is purchased after 2017-10-10, no fee for this upgrading. Before 2017-10-10, please purchase a new license for latest pyarmor.

5.5.7

  • Fix webui bug: raise “name ‘output’ is not defined” as running packer

5.5.6

  • Add new restrict mode 2, 3 and 4 to improve security of the obfuscated scripts, refer to Restrict Mode
  • In command obfuscate, option --restrict supports new value 2, 3 and 4
  • In command config, option --disable-restrict-mode is deprecrated
  • In command config, add new option --restrict
  • In command obfuscate the last argument could be a directory

5.5.5

  • Win32 issue: the obfuscated scripts will print extra message.

5.5.4

  • Fix issue: the output path isn’t correct when building a package with multiple entries
  • Fix issue: the obfuscated scripts raise SystemError “unknown opcode” if advanced mode is enabled in some MacOS machines

5.5.3

  • Fix issue: it will raise error “Invalid input packet” to import 2 independent obfuscated packages in 64-bit Windows.

5.5.2

  • Fix bug of command pack: the obfuscated modules aren’t packed into the bundle if there is an attribute _code_cache in the a.pure

5.5.1

  • Fix bug: it could not obfuscate more than 32 functions in advanced mode even pyarmor isn’t trial version.
  • In command licenses, the output path of generated license file is truncated if the registration code is too long, and all the invalid characters for path are removed.

5.5.0

  • Fix issue: Warning: code object xxxx isn’t wrapped (#59)
  • Refine command download, fix some users could not download library file from pyarmor.dashingsoft.com
  • Introduce advanced mode for x86/x64 arch, it has some limitations in trial version
  • Add option --advanced for command obfuscate
  • Add new property advanced_mode for project

A new feature Advanced Mode is introduced in this version. In this mode the structure of PyCode_Type is changed a little to improve the security. And a hook also is injected into Python interpreter so that the modified code objects could run normally. Besides if some core Python C APIs are changed unexpectedly, the obfuscated scripts in advanced mode won’t work. Because this feature is highly depended on the machine instruction set, it’s only available for x86/x64 arch now. And pyarmor maybe makes mistake if Python interpreter is compiled by old gcc or some other C compiles. It’s welcome to report the issue if Python interpreter doesn’t work in advanced mode.

Take this into account, the advanced mode is disabled by default. In order to enable it, pass option --advanced to command obfuscate. But in next minor version, this mode may be enable by default.

Upgrade Notes:

Before upgrading, please estimate Python interpreter in product environments to be sure it works in advanced mode. Here is the guide

https://github.com/dashingsoft/pyarmor-core/tree/v5.3.0/tests/advanced_mode/README.md

It is recommended to upgrade in the next minor version.

5.4.6

5.4.5

  • Enhancement: In Linux support to get the serial number of NVME harddisk
  • Fix issue: After run command register, pyarmor could not generate capsule if there is license.lic in the current path

5.4.4

  • Fix issue: In Linux could not get the serial number of SCSI harddisk
  • Fix issuse: In Windows the serial number is not right if the leading character is alpha number

5.4.3

5.4.2

  • Option --exclude can use multiple times in command obfuscate
  • Exclude build path automatically in command pack

5.4.1

  • New feature: do not obfuscate functions which name starts with lambda_
  • Fix issue: it will raise Protection Fault as packing obfuscated scripts to one file

5.4.0

  • Do not obfuscate lambda functions by default
  • Fix issue: local variable platname referenced before assignment

5.3.13

  • Add option --url for command download

5.3.12

  • Add integrity checks for the downloaded binaries (#85)

5.3.11

  • Fix issue: get wrong harddisk’s serial number for some special cases in Windows

5.3.10

  • Query harddisk’s serial number without administrator in Windows

5.3.9

  • Remove the leading and trailing whitespace of harddisk’s serial number

5.3.8

  • Fix non-ascii path issue in Windows

5.3.7

  • Fix bug: the bootstrap code isn’t inserted correctly if the path of entry script is absolute path.

5.3.6

5.3.5

  • The bootstrap code could run many times in same Python interpreter.
  • Remove extra . from the bootstrap code of __init__.py as building project without runtime files.

5.3.4

  • Add command download used to download platform-dependent dynamic libraries
  • Keep shell line for obfuscated entry scripts if there is first line starts with #!
  • Fix issue: if entry script is not in the src path, bootstrap code will not be inserted.

5.3.3

5.3.2

  • Fix bug: if there is only one comment line in the script it will raise IndexError as obfuscating this script.

5.3.1

5.3.0

  • In the trial version of PyArmor, it will raise error as obfuscating the code object which size is greater than 32768 bytes.
  • Add option --plugin in command obfuscate
  • Add property plugins for Project, and add option --plugin in command config
  • Change default build path for command pack, and do not remove it after command finished.

5.2.9

  • Fix segmentation fault issue for python3.5 and before: run too big obfuscated code object (>65536 bytes) will crash (#67)
  • Fix issue: missing bootstrap code for command pack (#68)
  • Fix issue: the output script is same as original script if obfuscating scripts with option --exact

5.2.8

  • Fix issue: pyarmor -v complains not enough arguments for format string

5.2.7

  • In command obfuscate add new options --exclude, --exact, --no-bootstrap, --no-cross-protection.
  • In command obfuscate deprecate the options --src, --entry, --cross-protection.
  • In command licenses deprecate the option --bind-file.

5.2.6

  • Fix issue: raise codec exception as obfuscating the script of utf-8 with BOM
  • Change the default path to user home for command capsule
  • Disable restrict mode by default as obfuscating special script __init__.py
  • Refine log message

5.2.5

  • Fix issue: raise IndexError if output path is ‘.’ as building project
  • For Python3 convert error message from bytes to string as checking license failed
  • Refine version information

5.2.4

  • Fix arm64 issue: verify rsa key failed when running the obufscated scripts(#63)
  • Support ios (arm64) and ppc64le for linux

5.2.3

  • Refine error message when checking license failed
  • Fix issue: protection code raises ImportError in the package file __init.py__

5.2.2

  • Improve the security of dynamic library.

5.2.1

  • Fix issue: in restrict mode the bootstrap code in __init__.py will raise exception.
  • Add option --cross-protection in command obfuscate

5.2.0

  • Use global capsule as default capsule for project, other than creating new one for each project
  • Add option --obf-code, --obf-mod, --wrap-mode, --cross-protection in command config
  • Add new attributes for project: obf_code, obf_mod, wrap_mode, cross_protection
  • Deprecrated project attributes obf_code_mode, obf_module_mode, use obf_code, obf_mod, wrap_mode instead
  • Change the behaviours of restrict mode, refer to https://pyarmor.readthedocs.io/en/latest/advanced.html#restrict-mode
  • Change option --restrict in command obfuscate and licenses
  • Remove option --no-restrict in command obfuscate
  • Remove option --clone in command init

5.1.2

  • Improve the security of PyArmor self

5.1.1

  • Refine the procedure of encrypt script
  • Reform module pytransform.py
  • Fix issue: it will raise exception if no entry script when obfuscating scripts
  • Fix issue: ‘gbk’ codec can’t decode byte 0xa1 in position 28 (#51)
  • Add option --upgrade for command capsule
  • Merge runtime files pyshield.key, pyshield.lic and product.key into pytransform.key

Upgrade notes

The capsule created in this version will include a new file pytransform.key which is a replacement for 3 old runtime files: pyshield.key, pyshield.lic and product.key.

The old capsule which created in the earlier version still works, it stills use the old runtime files. But it’s recommended to upgrade the old capsule to new version. Just run this command:

pyarmor capsule --upgrade

All the license files generated for obfuscated scripts by old capsule still work, but all the scripts need to be obfuscated again to take new capsule effects.

5.1.0

  • Add extra code to protect dynamic library _pytransform when obfuscating entry script
  • Fix compling error when obfuscating scripts in windows for Python 26/30/31 (newline issue)

5.0.5

5.0.4

  • Fix get_expired_days issue, remove decorator dllmethod
  • Refine output message of pyarmor -v

5.0.3

  • Add option -q, --silent, suppress all normal output when running any PyArmor command
  • Refine runtime error message, make it clear and more helpful
  • Add new function get_hd_info in module pytransform to get hardware information
  • Remove function get_hd_sn from module pytransform, use get_hd_info instead
  • Remove useless function version_info, get_trial_days from module pytransform
  • Remove attribute lib_filename from module pytransform, use _pytransform._name instead
  • Add document https://pyarmor.readthedocs.io/en/latest/pytransform.html
  • Refine document https://pyarmor.readthedocs.io/en/latest/security.html

5.0.2

5.0.1

Thanks to GNU lightning, from this version, the core routines are protected by JIT technicals. That is to say, there is no binary code in static file for core routines, they’re generated in runtime.

Besides, the pre-built dynamic library for linux arm32/64 are packed into the source package.

Fixed issues:

  • The module multiprocessing starts new process failed in obfuscated script:

    AttributeError: ‘__main__’ object has no attribute ‘f’

4.6.3

  • Fix backslash issue when running pack command with PyInstaller
  • When PyArmor fails, if sys.flags.debug is not set, only print error message, no traceback printed

4.6.2

  • Add option --options for command pack
  • For Python 3, there is no new line in the output when pack command fails

4.6.1

  • Fix license issue in 64-bit embedded platform

4.6.0

  • Fix crash issue for special code object in Python 3.6

4.5.5

  • Fix stack overflow issue

4.5.4

  • Refine platform name to search dynamic library _pytransform

4.5.3

  • Print the exact message when checking license failed to run obfuscated scripts.

4.5.2

4.5.1

  • Fix #41: can not find dynamic library _pytransform

4.5.0

  • Add anti-debug code for dynamic library _pytransform

4.4.2

  • Change default capsule to user home other than the source path of pyarmor

4.4.2

This patch mainly changes webui, make it simple more:

  • WebUI : remove source field in tab Obfuscate, and remove ipv4 field in tab Licenses
  • WebUI Packer: remove setup script, add output path, only support PyInstaller

4.4.1

  • Support Py2Installer by a simple way
  • For command obfuscate, get default src and entry from first argument, --src is not required.
  • Set no restrict mode as default for new project and command obfuscate, licenses

4.4.0

  • Pack obfuscated scripts by command pack

In this version, introduces a new command pack used to pack obfuscated scripts with py2exe and cx_Freeze. Once the setup script of py2exe or cx_Freeze can bundle clear python scripts, pack could pack obfuscated scripts by single command: pyarmor pack –type cx_Freeze /path/to/src/main.py

  • Pack obfuscated scripts by WebUI packer

WebUI is well reformed, simple and easy to use.

http://pyarmor.dashingsoft.com/demo/index.html

4.3.4

  • Fix start pyarmor issue for pip install in Python 2

4.3.3

  • Fix issue: missing file in wheel

4.3.2

  • Fix pip install issue in MacOS
  • Refine sample scripts to make workaround for py2exe/cx_Freeze simple

4.3.1

  • Fix typos in examples
  • Fix bugs in sample scripts

4.3.0

In this version, there are three significant changes:

[Simplified WebUI](http://pyarmor.dashingsoft.com/demo/index.html) [Clear Examples](src/examples/README.md), quickly understand the most features of Pyarmor [Sample Shell Scripts](src/examples), template scripts to obfuscate python source files

  • Simply webui, easy to use, only input one filed to obfuscate python scripts
  • The runtime files will be always saved in the same path with obfuscated scripts
  • Add shell scripts obfuscate-app, obfuscate-pkg, build-with-project, build-for-2exe in src/examples, so that users can quickly obfuscate their python scripts by these template scripts.
  • If entry script is __init__.py, change the first line of bootstrap code from pytransform import pyarmor runtime to from .pytransform import pyarmor runtime
  • Rewrite examples/README.md, make it clear and easy to understand
  • Do not generate entry scripts if only runtime files are generated
  • Remove choice package for option --type in command init, only pkg reserved.

4.2.3

  • Fix pyarmor-webui can not start issue
  • Fix runtime-path issue in webui
  • Rename platform name macosx_intel to macosx_x86_64 (#36)

4.2.2

  • Fix webui import error.

4.2.1

  • Add option --recursive for command obfuscate

4.1.4

  • Rewrite project long description.

4.1.3

  • Fix Python3 issue for get_license_info

4.1.2

  • Add function get_license_info in pytransform.py to show license information

4.1.1

  • Fix import main from pyarmor issue

4.0.3

  • Add command capsule
  • Find default capsule in the current path other than --src in command obfuscate
  • Fix pip install issue #30

4.0.2

  • Rename pyarmor.py to pyarmor-depreted.py
  • Rename pyarmor2.py to pyarmor.py
  • Add option --capsule, -disable-restrict-mode and --output for command licenses

4.0.1

  • Add option --capsule for command init, config and obfuscate
  • Deprecate option --clone for command init, use --capsule instead
  • Fix sys.settrace and sys.setprofile issues for auto-wrap mode

3.9.9

  • Fix segmentation fault issues for asyncio, typing modules

3.9.8

  • Add documentation for examples (examples/README.md)

3.9.7

  • Fix windows 10 issue: access violation reading 0x000001ED00000000

3.9.6

  • Fix the generated license bind to fixed machine in webui is not correct
  • Fix extra output path issue in webui

3.9.5

  • Show registration code when printing version information

3.9.4

  • Rewrite long description of package in pypi

3.9.3

  • Fix issue: __file__ is not really path in main code of module when import obfuscated module

3.9.2

  • Replace option --disable-restrict-mode with --no-restrict in command obfuscate
  • Add option --title in command config
  • Change the output path of entry scripts when entry scripts belong to package
  • Refine document user-guide.md and mechanism.md

3.9.1

  • Add option --type for command init
  • Refine document user-guide.md and mechanism.md

3.9.0

This version introduces a new way auto-wrap to protect python code when it’s imported by outer scripts.

Refer to [Mechanism Without Restrict Mode](src/mechanism.md#mechanism-without-restrict-mode)

  • Add new mode wrap for --obf-code-mode
  • Remove func.__refcalls__ in __wraparmor__
  • Add new project attribute is_package
  • Add option --is-package in command config
  • Add option --disable-restrict-mode in command obfuscate
  • Reset build_time when project configuration is changed
  • Change output path when is_package is set in command build
  • Change default value of project when find __init__.py in comand init
  • Project attribute entry supports absolute path

3.8.10

  • Fix shared code object issue in __wraparmor__

3.8.9

  • Clear frame as long as tb is not Py_None when call __wraparmor__
  • Generator will not be obfucated in __wraparmor__

3.8.8

  • Fix bug: the frame.f_locals still can be accessed in callback function

3.8.7

  • The frame.f_locals of wrapper and wrapped function will return an empty dictionary once __wraparmor__ is called.

3.8.6

  • The frame.f_locals of wrapper and wrapped function return an empty dictionary, all the other frames still return original value.

3.8.5

  • The frame.f_locals of all frames will always return an empty dictionary to protect runtime data.
  • Add extra argument tb when call __wraparmor__ in decorator wraparmor, pass None if no exception.

3.8.4

  • Do not touch frame.f_locals when raise exception, let decorator wraparmor to control everything.

3.8.3

  • Fix issue: option --disable-restrict-mode doesn’t work in command licenses
  • Remove freevar func from frame.f_locals when raise exception in decorator wraparmor

3.8.2

  • Change module filename to <frozen modname> in traceback, set attribute __file__ to real filename when running obfuscated scripts.

3.8.1

  • Try to access original func_code out of decorator wraparmor is forbidden.

3.8.0

  • Add option --output for command build, it will override the value in project configuration file.
  • Fix issue: defalut project output path isn’t relative to project path.
  • Remove extra file “product.key” after obfuscating scripts.

3.7.5

  • Remove dotted name from filename in traceback, if it’s not a package.

3.7.4

  • Strip __init__ from filename in traceback, replace it with package name.

3.7.3

  • Remove brackets from filename in traceback, and add dotted prefix.

3.7.2

  • Change filename in traceback to <frozen [modname]>, other than original filename

3.7.1

  • Fix issue #12: module attribute __file__ is filename in build machine other than filename in target machine.
  • Builtins function __wraparmor__ only can be used in the decorator wraparmor

3.7.0

  • Fix issue #11: use decorator “wraparmor” to obfuscate func_code as soon as function returns.
  • Document usage of decorator “wraparmor”, refer to src/user-guide.md#use-decorator-to-protect-code-objects-when-disable-restrict-mode

3.6.2

  • Fix issue #8 (Linux): option –manifest broken in shell script

3.6.1

  • Add option “Restrict Mode” in web ui
  • Document restrict mode in details (user-guide.md)

3.6.0

  • Introduce restrict mode to avoid obfuscated scripts observed from no obfuscated scripts
  • Add option –disable-restrict-mode for command “config”

3.5.1

  • Support pip install pyarmor

3.5.0

  • Fix Python3.6 issue: can not run obfuscated scripts, because it uses a 16-bit wordcode instead of bytecode
  • Fix Python3.7 issue: it adds a flag in pyc header
  • Fix option –obf-module-mode=none failed
  • Add option –clone for command “init”
  • Generate runtime files to separate path “runtimes” when project runtime-path is set
  • Add advanced usages in user-guide

3.4.3

  • Fix issue: raise exception when project entry isn’t obfuscated

3.4.2

  • Add webui to manage project

3.4.1

  • Fix README.rst format error.
  • Add title attribute to project
  • Print new command help when option is -h, –help

3.4.0

Pyarmor v3.4 introduces a group new commands. For a simple package, use command obfuscate to obfuscate scripts directly. For complicated package, use Project to manage obfuscated scripts.

Project includes 2 files, one configure file and one project capsule. Use manifest template string, same as MANIFEST.in of Python Distutils, to specify the files to be obfuscated.

To create a project, use command init, use command info to show project information. config to update project settings, and build to obfuscate the scripts in the project.

Other commands, benchmark to metric performance, hdinfo to show hardware information, so that command licenses can generate license bind to fixed machine.

All the old commands capsule, encrypt, license are deprecated, and will be removed from v4.

A new document [src/user-guide.md](src/user-guide.md) is written for this new version.

3.3.1

  • Remove unused files in distribute package

3.3.0

In this version, new obfuscate mode 7 and 8 are introduced. The main difference is that obfuscated script now is a normal python file (.py) other than compiled script (.pyc), so it can be used as common way.

Refer to https://github.com/dashingsoft/pyarmor/blob/v3.3.0/src/mechanism.md

  • Introduce new mode: 7, 8
  • Change default mode from 3 to 8
  • Change benchmark.py to test new mode
  • Update webapp and tutorial
  • Update usage
  • Fix issue of py2exe, now py2exe can work with python scripts obfuscated by pyarmor
  • Fix issue of odoo, now odoo can load python modules obfuscated by pyarmor

3.2.1

  • Fix issue: the traceback of an exception contains the name “<pytransform>” instead of the correct module name
  • Fix issue: All the constant, co_names include function name, variable name etc still are in clear text. Refer to https://github.com/dashingsoft/pyarmor/issues/5

3.2.0

From this version, a new obfuscation mode is introduced. By this way, no import hooker, no setprofile, no settrace required. The performance of running or importing obfuscation python scripts has been remarkably improved. It’s significant for Pyarmor.

  • Use this new mode as default way to obfuscate python scripts.
  • Add new script “benchmark.py” to check performance in target machine: python benchmark.py
  • Change option “–bind-disk” in command “license”, now it must be have a value

3.1.7

  • Add option “–bind-mac”, “–bind-ip”, “–bind-domain” for command “license”
  • Command “hdinfo” show more information(serial number of hdd, mac address, ip address, domain name)
  • Fix the issue of dev name of hdd for Banana Pi

3.1.6

  • Fix serial number of harddisk doesn’t work in mac osx.

3.1.5

  • Support MACOS

3.1.4

  • Fix issue: load _pytransfrom failed in linux x86_64 by subprocess.Popen
  • Fix typo in error messge when load _pytransfrom failed.

3.1.3

A web gui interface is introduced as Pyarmor WebApp, and support MANIFEST.in

  • In encrypt command, save encrypted scripts with same file structure of source.
  • Add a web gui interface for pyarmor.
  • Support MANIFEST.in to list files for command encrypt
  • Add option –manifest, file list will be written here
  • DO NOT support absolute path in file list for command encrypt
  • Option –main support format “NAME:ALIAS.py”

3.1.2

  • Refine decrypted mechanism to improve performance
  • Fix unknown opcode problem in recursion call
  • Fix wrapper scripts generated by -m in command ‘encrypt’ doesn’t work
  • Raise ImportError other than PytransformError when import encrypted module failed

3.1.1

In this version, introduce 2 extra encrypt modes to improve performance of encrypted scripts.

  • Fix issue when import encrypted package
  • Add encrypted mode 2 and 3 to improve performance
  • Refine module pyimcore to improve performance

3.0.1

It’s a milestone for Pyarmor, from this version, use ctypes import dynamic library of core functions, other than by python extensions which need to be built with every python version.

Besides, in this version, a big change which make Pyarmor could avoid soure script got by c debugger.

  • Use ctypes load core library other than python extentions which need built for each python version.
  • “__main__” block not running in encrypted script.
  • Avoid source code got by c debugger.
  • Change default outoupt path to “build” in command “encrypt”
  • Change option “–bind” to “–bind-disk” in command “license”
  • Document usages in details

2.6.1

  • Fix encrypted scripts don’t work in multi-thread framework (Django).

2.5.5

  • Add option ‘-i’ for command ‘encrypt’ so that the encrypted scripts will be saved in the original path.

2.5.4

  • Verbose tracelog when checking license in trace mode.
  • In license command, change default output filename to “license.lic.txt”.
  • Read bind file when generate license in binary mode other than text mode.

2.5.3

  • Fix problem when script has line “from __future__ import with_statement”
  • Fix error when running pyarmor by 32bit python on the 64bits Windows.
  • (Experimental)Support darwin_15-x86_64 platform by adding extensions/pytransform-2.3.3.darwin_15.x86_64-py2.7.so

2.5.2

  • License file can mix expire-date with fix file or fix key.
  • Fix log error: not enough arguments for format string

2.5.1

  • License file can bind to ssh private key file or any other fixed file.

2.4.1

  • Change default extension “.pyx” to “.pye”, because it confilcted with CPython.
  • Custom the extension of encrypted scripts by os environment variable: PYARMOR_EXTRA_CHAR
  • Block the hole by which to get bytescode of functions.

2.3.4

  • The trial license will never be expired (But in trial version, the key used to encrypt scripts is fixed).

2.3.3

  • Refine the document

2.3.2

  • Fix error data in examples of wizard

2.3.1

  • Implement Run function in the GUI wizard
  • Make license works in trial version

2.2.1

  • Add a GUI wizard
  • Add examples to show how to use pyarmor

2.1.2

  • Fix syntax-error when run/import encrypted scripts in linux x86_64

2.1.1

  • Support armv6

2.0.1

  • Add option ‘–path’ for command ‘encrypt’
  • Support script list in the file for command ‘encrypt’
  • Fix issue to encrypt an empty file result in pytransform crash

1.7.7

  • Add option ‘–expired-date’ for command ‘license’
  • Fix undefined ‘tfm_desc’ for arm-linux
  • Enhance security level of scripts

1.7.6

  • Print exactaly message when pyarmor couldn’t load extension “pytransform”
  • Fix problem “version ‘GLIBC_2.14’ not found”
  • Generate “license.lic” which could be bind to fixed machine.

1.7.5

  • Add missing extensions for linux x86_64.

1.7.4

  • Add command “licene” to generate more “license.lic” by project capsule.

1.7.3

  • Add information for using registration code

1.7.2

  • Add option –with-extension to support cross-platform publish.
  • Implement command “capsule” and add option –with-capsule so that we can encrypt scripts with same capsule.
  • Remove command “convert” and option “-K/–key”

1.7.1

  • Encrypt pyshield.lic when distributing source code.

1.7.0

  • Enhance encrypt algorithm to protect source code.
  • Developer can use custom key/iv to encrypt source code
  • Compiled scripts (.pyc, .pyo) could be encrypted by pyshield
  • Extension modules (.dll, .so, .pyd) could be encrypted by pyshield