Advanced encryption protecting your python codebase.
SOURCEdefender is the easiest way to obfuscate Python code using AES-256 encryption. AES is a symmetric algorithm which uses the same key for both encryption and decryption (the security of an AES system increases exponentially with key length). There is no impact on the performance of your running application as the decryption process takes place during the import of your module so encrypted code won't run any slower once loaded from a .pye file compared to loading from a .py or .pyc file.
- No end user device license required
- Symmetric AES 256-bit encryption
- Set your own password & salt for encryption
- Enforced an expiration time on encrypted code
- Bundle encrypted files or folders into a single executable binary using PyInstaller
We support the following Operating System & Architecture combinations and hook directly into the import process so there are no cross platform compatibility issues. Encrypted code will run on ANY other target using the same version of Python. For example, files encrypted in Windows using Python 3.10 will run with Python 3.10 on Linux.
|CPU Architecture||Operating System||Python Architecture||Python Versions|
|AMD64||Windows||32-bit||3.7 - 3.12|
|AMD64||Windows||64-bit||3.7 - 3.12|
|x86_64||Linux||64-bit||3.7 - 3.12|
|x86_64||macOS||64-bit||3.7 - 3.12|
|ARM64||macOS||64-bit||3.9 - 3.12|
|AARCH64||Linux||64-bit||3.7 - 3.12|
If you do not see your required combination here, please contact us so we can help find you a solution
The installation of SOURCEdefender will grant you a trial license to encrypt files. This trial license will only allow your script to work for a maximum of 24hrs, after that it won't be usable. This is so you can test our solution is suitable to your needs. If you get stuck then please contact us so we can help.
To distribute encrypt code without limitation, you will need to create an account and setup your payment method. Once you have setup the account, you will be able to retrieve your activation token and use it to authorise your installation:
$ sourcedefender activate --token 470a7f2e76ac11eb94390242ac130002 SOURCEdefender Registration: - Account Status : Active - Email Address : firstname.lastname@example.org - Account ID : bfa41ccd-9738-33c0-83e9-cfa649c05288 - System ID : 42343554645384 - Valid Until : Sun, May 9, 2021 10:59 PM
Without activating your SDK any encrypted code you create will only be usable for a maximum of 24hrs. Access to our dashboard is required (via HTTPS) from your system so we can validate your account status.
If you want to view your activated license status you can use the validate option:
$ sourcedefender validate SOURCEdefender Registration: - Account Status : Active - Email Address : email@example.com - Account ID : bfa41ccd-9738-33c0-83e9-cfa649c05288 - System ID : 42343554645384 - Valid Until : Sun, May 9, 2021 10:59 PM $
If your license is valid, then this command will give the Exit Code (EC) of #0 (zero), otherwise an invalid licence will be indicated by the #EC of 1 (one). You should run this command after any automated build tasks to ensure you haven't created code with an unexpected 24hr limitation.
Due to the way PyPi requires you to upload a new release to change your documentation we have moved our price plan information over to the Dashboard site. If you do not see a price you like, then please email us so we can discuss your situation and requirements.
We are immensely grateful to the following organisation(s):
If you would like to help sponsor future development of this package then please send us an email.
We have worked hard to ensure that the encryption/decryption process is a simple as possible. Here are a few examples of how it works, and how to use the features provided. If you need advice on the process encrypt or import your code, please contact us for assistance.
How do I protect my Python source code?
First, let's have a look at an example of the encryption process:
$ cat /home/ubuntu/helloworld.py print("Hello World!") $
This is a very basic example, but we do not want anyone to get at our source code. We also don't want anyone to run this code after 1 hour so when we encrypt the file we can enforce an expire time of 1 hour from now with the --ttl option and we can delete the plaintext .py file after encryption by adding the --remove option.
The command would look like this:
$ sourcedefender encrypt --remove --ttl=1h /home/ubuntu/helloworld.py SOURCEdefender Processing: /home/ubuntu/helloworld.py $
The '--remove' option deletes the original .py file. Make sure you use this so you don't accidentially distribute the plain-text code. Now the file is encrypted, its contents are as follows:
$ cat /home/ubuntu/helloworld.pye -----BEGIN SOURCEDEFENDER FILE----- GhP6+FOEA;qsm6NrRnXHnlU5E!(pT(E<#t= GhN0L!7UrbN"Am#(8iPPAG;nm-_4d!F9"*7 T1q4VZdj>uLBghNY)[;Ber^L=*a-I[MA.-4 ------END SOURCEDEFENDER FILE------ $
Once a file has been encrypted, its new extension is .pye so our loader can identify encrypted files. All you need to remember is to inlcude sourcedefender as a Python dependency while packaging your project and import the sourcedefender module before you attempt to import and use your encrypted code.
Importing packages & modules
The usual import system can still be used and you can import encrypted code from within encrypted code so you don't need to do anything special with your import statements.
$ cd /home/ubuntu $ ls helloworld.pye $ python3 >>> >>> import sourcedefender >>> import helloworld Hello World! >>> exit() $
Using your own password or salt for encryption
It's easy to use your own encryption password and salt. If you do not set these, we generate unique ones for each file you encrypt. Should you wish to set your own, these can be set from either a command option:
sourcedefender encrypt --password 1234abcd --salt dcba4321 mycode.py
or as an Environment variable:
export SOURCEDEFENDER_PASSWORD="1234abcd" export SOURCEDEFENDER_SALT="dcba4321" sourcedefender encrypt mycode.py
And to import the code you can either set an environment vairaible (as with the encryption process). You can also set these in your code before the import:
$ python3 >>> import sourcedefender >>> from os import environ >>> environ["SOURCEDEFENDER_PASSWORD"] = "1234abcd" >>> environ["SOURCEDEFENDER_SALT"] = "dcba4321" >>> import mycode
The password and salt set is specific to the next import, so if you want different ones for different files, then feel free to encrypt with different values and remember to set 'sourcedefender.password/salt=something' before your import.
Can I still run Python from the command-line?
Yes, you can still run scripts from the command-line, but there are some differences due to the way Python loads command line scripts. For example, you need to ask Python to load the sourcedefender package and then tell it what to import:
$ python3 -m sourcedefender /home/ubuntu/helloworld.pye Hello World! $
However, due to the way Python works - and the fact that we need to run the 'sourcedefender' module first - you won't be able to compare __name__ == "__main__" in the code to see if it is being imported or executed as a script. This means that the usual starting code block will not get executed.
We have just added a new feature where you can download .pye files at runtime. As an example, we have encrypted the following script and made it publically available:
$ cat hello.py def message(): print("hi!") $
To download the file from the Internet you can use the following code example:
$ cat download.py from sourcedefender.tools import getUrl getUrl("https://downloads.sourcedefender.co.uk/hello.pye") from hello import message message() $
We are only able to download a single Python module at a time. Python packages or zip files are not supported.
When executed this will do the following:
$ python3 download.py hi! $
We know this is a simple example and security can be increased by using your own salt/password.
Integrating encrypted code with PyInstaller
PyInstaller scans your plain-text code for import statements so it knows what packages to freeze. This scanning is not possible inside encrypted code so we have created a 'pack' command to help. By default we always enable '--onefile', but any additional 'hidden' libs you may need to include using the '--hidden-import' or '--add-binary' options.
We are unable to guess what parts of your code you want encrypting. If you encrypt all your code, sometimes that stops Python from working. So, with that in mind, please ensure you encrypt your code before using the pack command.
For this example, we have the following project structure:
pyexe.py lib └── helloworld.pye
In our pyexe script we have the following code:
$ cat pyexe.py import helloworld
To ensure that PyInstaller includes our encrypted files, we need to tell it where they are with the --add-binary option. So, for the above project, we could use this command:
sourcedefender encrypt pyexe.py --remove sourcedefender pack pyexe.pye -- --add-binary $(pwd)/lib:.
There is a strange quirk with PyInstaller that we haven't yet found a work-around for. When you include extra args after '--' you need to provide full paths of the source folders otherwise you will get a tmp folder not found error such as this:
Unable to find "/tmp/tmpp9pt6l97/lib" when adding binary and data files.
Integrating encrypted code with Django
You can encrypt your Django project just the same as you can any other Python code. Don't forget to include "import sourcedefender" to your wsgi/asgi(.py) file so that it gets loaded first and can intercept any import requests to find your encrypted code. You should not encrypt the wsgi/asgi files.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. REVERSE ENGINEERING IS STRICTLY PROHIBITED.
Copyright © 2018-2021 SOURCEdefender. All rights reserved.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.