EdgeAuth-Token-Ruby: Akamai Edge Authorization Token for Ruby

EdgeAuth-Token-Ruby is Akamai Edge 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.

EdgeAuth-Token-Ruby supports Ruby 2.0+.

Installation

To install Akamai Edge Authorization Token for Ruby:

$ gem install akamai-edgeauth

Example

require 'net/http' # Just for this Example
require 'akamai/edgeauth'

ET_HOSTNAME = 'edgeauth.akamaized.net'
ET_ENCRYPTION_KEY = 'YourEncryptionKey' 
DURATION = 500 # seconds

• EA_ENCRYPTION_KEY must be hexadecimal digit string with even-length.
• Don't expose EA_ENCRYPTION_KEY on the public repository.

URL parameter option

path = "/akamai/edgeauth"

# 1) Cookie
et = Akamai::EdgeAuth.new(key: ET_ENCRYPTION_KEY, 
    window_seconds: DURATION, 
    escape_early: true)
token = et.generateURLToken(path)
uri = URI("http://#{ET_HOSTNAME}#{path}")

http = Net::HTTP.new(uri.host)
req = Net::HTTP::Get.new(uri)
req['Cookie'] = "#{et.token_name}=#{token}"
res = http.request(req)
p res # Maybe not 403

# 2) Query string
token = et.generateURLToken(path)
uri = URI("http://#{ET_HOSTNAME}#{path}#{et.token_name}=#{token}")
res = Net::HTTP.get_response(uri)
p res

• 'Escape token input' option in the Property Manager corresponds to 'escape_early' in the code.
  Escape token input (on) == escape_early (true)
  Escape token input (off) == escape_early (false)

• In [Example 2] for Query String, it's only okay for 'Ignore query string' option (on).

• If you want to 'Ignore query string' option (off) using query string as your token, Please contact your Akamai representative.

ACL(Access Control List) parameter option

# 1) Header using *
et = Akamai::EdgeAuth.new(key: ET_ENCRYPTION_KEY, window_seconds: DURATION)
token = et.generateACLToken("/akamai/edgeauth/list/*")
uri = URI("http://#{ET_HOSTNAME}/akamai/edgeauth/list/something")

http = Net::HTTP.new(uri.host)
req = Net::HTTP::Get.new(uri)
req[et.token_name] = token
res = http.request(req)
p res

# 2) Cookie Delimited by '!'
acl = ["/akamai/edgeauth", "/akamai/edgeauth/list/*"]
token = et.generateACLToken(acl)
uri = URI("http://#{ET_HOSTNAME}/akamai/edgeauth/list/something2")
    # or URI("http://#{ET_HOSTNAME}/akamai/edgeauth")

http = Net::HTTP.new(uri.host)
req = Net::HTTP::Get.new(uri)
req['Cookie'] = "#{et.token_name}=#{token}"
res = http.request(req)
p res

• ACL can use the wildcard(*, ?) in the path.
• Don't use '!' in your path because it's ACL Delimiter
• Use 'escape_early=false' as default setting but it doesn't matter turning on/off 'Escape token input' option in the Property Manager

Usage

EdgeAuth Class

class EdgeAuth
    def initialize(token_type: nil, token_name: '__token__', 
                key: nil, algorithm: 'sha256', salt: nil,
                ip: nil, payload: nil, session_id: nil,
                start_time: nil, end_time: nil, window_seconds: nil, 
                field_delimiter: '~', acl_delimiter: '!', 
                escape_early: false, verbose: false)
    end
end

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)
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.
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. [ Default: ! ]
escape_early	Causes strings to be url encoded before being used.
verbose	Print all parameters.

EdgeAuth's Method

def generateURLToken(url)
def generateACLToken(acl)

# Returns the authorization token string.

Parameter	Description
url	Single URL path (String)
acl	Access Control List can use the wildcard(*, ?). It can be String (single path) or Array (multi paths)

Test

"src/test" directory is only for the internal test.

Others

If you use the Segmented Media Protection behavior in AMD(Adaptive Media Delivery) Product, token_name should be 'hdnts'.

License

Copyright 2018 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.