Skip to main content

Akamai Authorization Token for Configuration

Project description

https://img.shields.io/pypi/v/akamai-authtoken.svg https://travis-ci.org/AstinCHOI/Akamai-AuthToken-Python.svg?branch=master http://img.shields.io/:license-apache-blue.svg

Akamai-AuthToken is Akamai Authorization Token in the HTTP Cookie, Query String and Header for a client. You can configure it in the Property Manager at https://control.akamai.com. It’s a behavior which is Auth Token 2.0 Verification.

Akamai-AuthToken supports Python 2.6–2.7 & 3.3–3.6, and runs great on PyPy. (This is Akamai unofficial code)

https://github.com/AstinCHOI/akamai-asset/blob/master/authtoken/authtoken.png?raw=true

Installation

To install Akamai Authorization Token for Python:

$ pip install akamai-authtoken

Example

from akamai.authtoken import AuthToken, AuthTokenError
import requests # just for this example

AA_HOSTNAME = 'auth-token.akamaized.net'
AA_ENCRYPTION_KEY = 'YourEncryptionKey'
DURATION = 500 # seconds
AA_ENCRYPTION_KEY must be hexadecimal digit string with even-length.
Don't expose AA_ENCRYPTION_KEY on the public repository.

URL parameter option

# 1) Cookie
at = AuthToken(key=AA_ENCRYPTION_KEY, window_seconds=DURATION, escape_early=True)
token = at.generateToken(url="/akamai/authtoken")
url = "http://{0}{1}".format(AA_HOSTNAME, "/akamai/authtoken")
response = requests.get(url, cookies={at.token_name: token})
print(response)
# <Response [200, 404 or 5xx]> # if fail, it will be 403

# 2) Query string
at = AuthToken(key=AA_ENCRYPTION_KEY, window_seconds=DURATION, escape_early=True)
token = at.generateToken(acl="/akamai/authtoken")
url = "http://{0}{1}?{2}={3}".format(AA_HOSTNAME, "/akamai/authtoken", at.token_name, token)
response = requests.get(url)
print(response)
It depends on turning on/off 'Escape token input' in the property manager. (on: escape_early=True / off: escape_early=False)
In [Example 2], it's only okay for 'Ignore query string' option on in the property manager.
If you want to 'Ignore query string' off using query string as your token, Please contact your Akamai representative.

ACL(Access Control List) parameter option

# 1) Header using *
at = AuthToken(key=AA_ENCRYPTION_KEY, window_seconds=DURATION)
token = at.generateToken(acl="/akamai/authtoken/list/*")
url = "http://{0}{1}".format(AA_HOSTNAME, "/akamai/authtoken/list/something")
response = requests.get(url, headers={at.token_name: token})
print(response)

# 2) Cookie Delimited by '!'
at = AuthToken(key=AA_ENCRYPTION_KEY, window_seconds=DURATION)
token = at.generateToken(acl="/akamai/authtoken/list!/akamai/authtoken/list/*")
url = "http://{0}{1}".format(AA_HOSTNAME, "/akamai/authtoken/list/something2")
response = requests.get(url, cookies={at.token_name: token})
print(response)
It doesn't matter turning on/off 'Escape token input' in the property manager, but you should keep escape_early=False (Default)

Usage

AuthToken Class

AuthToken(token_type=None, token_name='__token__', key=None, algorithm='sha256',
        salt=None, start_time=None, end_time=None, window_seconds=None,
        field_delimiter='~', acl_delimiter='!', escape_early=False, verbose=False)

#

Parameter

Description

token_type

Select a preset. (Not Supported Yet)

token_name

Parameter name for the new token. [Default: __token__]

key

Secret required to generate the token. It must be hexadecimal digit string with even-length.

algorithm

Algorithm to use to generate the token. (sha1, sha256, or md5) [Default:sha256]

salt

Additional data validated by the token but NOT included in the token body. (It will be deprecated)

start_time

What is the start time? (Use string ‘now’ for the current time)

end_time

When does this token expire? ‘end_time’ overrides ‘window_seconds’

window_seconds

How long is this token valid for?

field_delimiter

Character used to delimit token body fields. [Default: ~]

acl_delimiter

Character used to delimit acl fields. [Default: !]

escape_early

Causes strings to be ‘url’ encoded before being used.

verbose

Print all parameters.

AuthToken’s Method

generateToken(url=None, acl=None, start_time=None, end_time=None,
            window_seconds=None, ip=None, payload=None, session_id=None)

# Returns the authorization token string.

Parameter

Description

url

Single URL path.

acl

Access control list delimited by ! [ie. /*]

start_time

Same as Authtoken’s variables, but they overrides Authtoken’s.

end_time

window_seconds

ip

IP Address to restrict this token to. (Troublesome in many cases (roaming, NAT, etc) so not often used)

payload

Additional text added to the calculated digest.

session_id

The session identifier for single use tokens or other advanced cases.

Command

$ python cms_authtoken.py -k YourEncryptionKey -w 5000 -u /hello/world -x

Use -h or –help option for the detail.

License

Copyright 2017 Akamai Technologies, Inc. All rights reserved.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

akamai-authtoken-0.4.1.tar.gz (7.5 kB view hashes)

Uploaded Source

Built Distribution

akamai_authtoken-0.4.1-py2.py3-none-any.whl (10.2 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page