Auth Token 2.0 Verification
Auth token verification (also referred to as "Token Auth") is the process of generating tokens, associating them with an authenticated user session, and then validating the request using these tokens to prevent unauthorized sharing of links to your content.
Are you using Adaptive Media Delivery (AMD)?
Auth Token 2.0 is supported for use with AMD, but Token Authentication via the Segmented Media Protection behavior is the recommended method for this protection. It provides a higher level of security.
Also, you can't use both behaviors in the same rule in your AMD property. You can use them in separate rules that use different Match criteria.
How it works
This behavior generates unique tokens for use as a query string, a cookie, or in a request header. These tokens are used to validate user requests.
Implementation
Review these sections to add this feature to protect your delivery workflow.
1. Enable Token Auth
To start, add the Auth Token 2.0 Verification behavior to the applicable rule in your property, and set the options as necessary:
| Option | Required? | Description |
|---|---|---|
Token Location | ✓ | Select where the token is located in an incoming HTTP request from the client. Your origin server needs to generate this key and includes it in the applicable location (as a Query String, a Cookie or in a Request Header). |
Token Name | ✓ | Input the value that will be used as the "token_name" in the token. You need to ensure that the value you input here is used when the token is generated. |
Encryption key | ✓ | Input a hexadecimal value, comprised of an even number of characters. For example: This is the key value you need to use to generate the token for use with your content. Make note of this value for use later in this process. |
Action | ✓ | Select the desired action to take:
|
Show Advanced Options | You can optionally set this slider to On to reveal more options. | |
Encryption Algorithm | To access this option, set the Show Advanced Options slider to On." This is the algorithm you're using for the HMAC (Hashed Message Authentication Code) to generate the token. This setting needs to match the method chosen in the token generation code.
| |
Escape token inputs | To access this option, set the Show Advanced Options slider to On." Specify whether the token inputs are URL escaped before generating the token. By default, inputs are URL escaped. This setting must match the setting used in your token generation code. | |
Ignore query string | To access this option, set the Show Advanced Options slider to On. Specify whether the query string is included in the URL input into the token. By default, the query string is included. This setting must match the setting used in the token generation code. | |
Transition key | To access this option, set the Show Advanced Options slider to On. Input a second Encryption key to serve as a backup “trusted shared secret.” You either manually input a hexadecimal value, comprised of an even number of characters or auto-generate one using the cycle button ( | |
Salt | To access this option, set the Show Advanced Options slider to On. Input a value to serve as an additional "secret" that will be added to the token generation to strengthen the security of the token. You can either manually input a hexadecimal value, comprised of an even number of characters or auto-generate one using the cycle button ( |
You need to follow 2. Generate the access token and 3. Apply the token before you enable a property configuration on the production network.
2. Generate the token
You need to generate a one-time access token and apply it to content you want to protect. The token is a delimited list of string fields, with an HMAC to prevent tampering with the strings. Each field consists of a value that is verified by Akamai when a request is made. Among other things, fields in the token include:
| String | Description |
|---|---|
token_name | Required—This must be the same value you input for the Token Name setting in the Auth Token 2.0 Verification behavior for your property configuration. |
start_time and end_time | Required—Use these to set a time to live for the token. |
session_id/sessionId | Optional—Include this as a unique identifier for a single access session. Create a session identifier using printable ascii characters and ensure that it's no larger than 36 bytes in size. |
key | Required—The secret used to generate the token. This is the value you set as the Encryption key in the Auth Token 2.0 Verification behavior for your property configuration. (This can also be the Transition key, if applicable, or the Encryption key + Salt/Transition key + Salt if you've set up these optional values in the property.) |
Don't include the IP address field in your tokens to tie the token to a specific IP address, unless all requests will only come from that specific address. This can break delivery in a property if requests come from other IP addresses or if you're using an IPv4+IPv6 dual-stacked environment.
Akamai offers Token Auth software development kits (SDK) that you can use to generate this token. They are available for multiple programming languages, and they account for all required and optional fields.
See the README section on these pages for details on how to use the SDKs.
3. Apply the token
The completed token needs to be attached as a query string parameter, cookie, or request header, to the URL for your target content. You must apply it, based on how you've set the Token Location in the Auth Token 2.0 Verification behavior for this property configuration.
Ideally, you should set up your origin server to dynamically generate these tokens for each client request for the content. This way, the IP address could be included as a parameter, and access to the content would be restricted to that single, authorized user.
Tips and best practices
Token authentication generally requires the use of browser cookies to deliver a signed token as a step in the authorization process. This can affect devices and browsers that don't support cookie use (typically Apple Safari and HLS devices). So, to support this behavior, your end-users can manually enable cookies. Safari end-users must enable cookies. In Safari, set Preferences > Security > Accept Cookies: Always. With this set, no additional interaction is required, and token authorization will work as designed.
Updated about 1 year ago