Projects

Encryption

Introduction

When you save projects in QuantConnect Cloud, you can save encrypted versions of your project files instead of the raw, human readable, file content. To use the encryption system, you provide your own encryption key, which your local browser saves to memory. Afterwards, whenever you save your project, your browser uses the local key to encrypt your project files and then only the obfuscated files are pushed to QuantConnect Cloud.

View All Keys

The organization homepage displays the name of all your organization's encryption keys and provides a way to upload more. A MD5 hash of the key is recorded to know which key encoded a project.

The icon means the key is registered in the database but we could not locate it on your computer. This may happen when you login from a new computer. To use this key, click Use Key and upload the key with the pop-up. This process stores a copy of your key in the browser local store so you can decrypt the relevant projects in your organization.

Add Keys

Follow these steps to add an encryption key to your local storage:

  1. Navigate to the Encryption Keys section of your organization homepage.
  2. Click Add Encryption Key.
  3. In the Add Encryption Key window, enter a name for the key and then add the encryption key file.

    4. The encryption key file must be a txt file with at least 32 characters. It’s content can be arbitrary.

  4. Click Add Key.

Delete Keys

Follow these steps to delete an encryption key:

  1. Navigate to the Encryption Keys section of your organization homepage.
  2. Click Delete next to the key you want to delete.
  3. Click Delete.

Add Encryption

Follow these steps to add encryption to your project files:

  1. Open a project or create a new one.
  2. In the Project panel, click Encrypt Project.
  3. If you have added an encryption key before and want to use it for this project, click the key name from the drop-down menu.
  4. If you haven’t added an encryption key before or you want to add a new one, follow these steps:
    1. Click Add Key to Organization from the drop-down menu.
    2. In the Add Encryption Key window, enter a name for the key and then add the encryption key file.

      3. The encryption key file must be a txt file with at least 32 characters. It’s content can be arbitrary.

    3. Click Add Key.
  5. Click Encrypt.

Remove Encryption

To remove encryption from a project, open the project and then, in the Project panel, click the unlock icon next to the name of your encryption key.

Collaboration Support

Encryption isn’t available for projects that have collaborators.

Libraries

Encrypted projects can use libraries encrypted with the same project key or unencrypted libraries. However, you cannot use a library encrypted with a different project encryption key.

To encrypt a library, open its project and set its encryption key.

You can also see our Videos. You can also get in touch with us via Discord.

Did you find this page helpful?

Contribute to the documentation: