Encryption Key (2024)

An encryption key must be defined. This service leverages this encryption key to encrypt and decrypt token values.

Key information:

• An encryption key may consist of any combination of alphanumeric characters. All other characters, including spaces, are not valid for encryption keys.
• An encryption key is case-sensitive. In other words, the case of an encryption key affects the encryption and decryption of token values.
• The maximum length of an encryption key is 250 characters.
• It may take up to an hour for changes, such as setting an encryption key or adding directory authentication, to take effect.

• By default, a token value is only specific to an encryption key and not to a folder. This means that it may be possible for a client to use a single token value to gain access to protected content from various folders.

  • Cross-Folder Access: Leverage the Allow URL parameter to ensure that a token may only be used for a specific directory or for a particular file.

To set an encryption key

1. Navigate to the Token Auth page.
2. Set the desired encryption key in the Primary Key option.
3. Click Update.

Best Practices

Ensure token security by following these guidelines when defining an encryption key:

• Set it to a random value.
• Make sure that the encryption key candidate meets or exceeds the recommended length (i.e., 64 characters).

Do not exceed a key length size of 250 characters.

OpenSSL

A standard method for generating random values is to use the OpenSSL tool to perform hexadecimal encoding.

Syntax:

Hexadecimal encoding doubles the specified length. For example, specifying a length of "32" will generate a value containing 64 characters.

Example:

Switching to a New Encryption Key

Tokens may only be decrypted using either the primary or backup encryption key defined on the Token Auth page. If the requested content contains a token generated using an old encryption key, then the request will be denied.

The following factors may prevent you from instantly switching to a new encryption key:

• The amount of time it takes to update all of your links to secured content.
• Cached assets whose links contain old token values.
• The amount of time it takes for a new encryption key to take effect (approximately 1 hour).

As a result of all of these factors, it is recommended to leverage two active encryption keys to ensure uninterrupted access to your content. This procedure requires that the old key be assigned as a backup key when creating a new encryption key. Since the old key is still an active encryption key, links that contain old tokens may still be used to authenticate.

Remove the old encryption key once the following events have taken place:

• The new encryption key has taken effect.
• All of your links have been updated.
• Cached content that leverage an old token is no longer being served.

The above process ensures a smooth transition to a new encryption key.

To change your encryption key (recommended procedure)

1. Navigate to the Token Auth page.
2. From the Token-Based Authentication section, copy the value from the Primary Key option to the Backup Key option.
3. In the Primary Key option, type your new encryption key.

4. Click Update to save your changes.

   It may take up to an hour for your primary key to become active.

5. Generate new tokens using the new primary key.
6. Update all links to content secured by Token-Based Authentication to use the tokens generated in the previous step.
7. Purge the content updated in the previous step.
8. Clear the Backup Key option.

9. Click Update to save your changes.

   It may take up to an hour for your backup key to become deactivated. After which, links that use token values based on the old encryption key will be rejected.

Edgecast CDN