akamai-edge_auth 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4eb6c5e2bea17ce0a682ffaf0a215f7db4bba186
+  data.tar.gz: 10584aeb37a3ba4cae5038147b3c5f78f5fd7a12
+SHA512:
+  metadata.gz: e598f0b103f69755b8e00af8e617c016d9d447912e85104f4b8cd19b8433d31b8254da15afbc57a0c76effa8f7e1d9a733c98330a657e4a09d1ea24af461e093
+  data.tar.gz: 17547a958f84bb57bf70ea2f8e5e879e40e6b58d6bfd16605de257b11b34d4116224ef3b8ec222d3c45420e33dd345d1aaeff1d49a6c12b640e9468eb6fbd177

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in edge_auth.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2017 Akamai Technologies http://developer.akamai.com.
+
+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.

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2017 Akamai Technologies http://developer.akamai.com.
+
+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.

data/README.md

@@ -0,0 +1,94 @@
+# EdgeAuth (Akamai Authorization Token)
+
+this gem is authorization token generator for Akamai, you can configure your property at [https://control.akamai.com]
+inspired by [Akamai-AuthToken-Ruby](https://github.com/AstinCHOI/Akamai-AuthToken-Ruby)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'edge_auth'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install edge_auth
+
+## Usage
+
+### Basic Usage
+
+```Ruby
+edge_auth = Akamai::EdgeAuth.new(key: "yourkeyhere")
+token = edge_auth.generate_token(start_time: "now", window_seconds: 30, acl: "/path/whatever")
+```
+
+Your token should look like this by very default options :
+
+```
+hdnts=st=1508777863~exp=1508777893~acl=/path/whatever~hmac=fded4c1133a50942a36cc16a9a94d68e8573d10d144d03860a7c3a3734d13dff
+```
+
+### Initialize
+
+| Parameter | Description |
+|-----------|-------------|
+| token_type| Token type cookies or URL. [ Default: URL] |
+| token_name | Parameter name for the new token. [ Default: hdnts ] |
+| 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 ] |
+| field_delimiter | Character used to delimit token body fields. [ Default: ~ ] |
+| acl_delimiter | Character used to delimit acl. [ Default: ! ] |
+
+### Generate Token
+
+| Parameter | Description |
+|-----------|-------------|
+| start_time | What is the start time? (Use string 'now' for the current time) |
+| end_time | When does this token expire? 'end_time'  |
+| window_seconds | How long is this token valid for? overrides 'end_time' |
+| acl | Generate token for Access Control List [ Example: "/live/*" it will allow all stream under /live/ path ] |
+| url | Generate token for url |
+| escape_early | Causes strings to be 'url' encoded before being used. |
+| 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. |
+| salt | Additional data validated by the token but NOT included in the token body. (It will be deprecated) |
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/sukorenomw/akamai-edgeauth/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sukorenomw/akamai-edgeauth. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+Copyright 2017 Akamai Technologies http://developer.akamai.com.
+
+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.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "akamai/edge_auth"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/edge_auth.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "akamai/edge_auth/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "akamai-edge_auth"
+  spec.version       = Akamai::EdgeAuth::VERSION
+  spec.authors       = ["Sukoreno Mukti"]
+  spec.email         = ["sukorenomw@gmail.com"]
+
+  spec.summary       = %q{Akamai EdgeAuth token generator}
+  spec.description   = %q{Akamai EdgeAuth token generator for TokenAuth setting in Media Live Streaming Packaging or Segmented Media Protection}
+  spec.homepage      = "https://github.com/sukorenomw/akamai_edge_auth"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'timecop', '~> 0'
+end

data/lib/akamai/edge_auth.rb

@@ -0,0 +1,90 @@
+require "akamai/edge_auth/version"
+require "openssl"
+
+module Akamai
+  class EdgeAuth
+    attr_accessor :key, :token_type, :token_name,
+      :algorithm, :field_delimiter, :acl_delimiter
+
+    ALLOWED_ALGORITHM = ['sha256', 'sha1', 'md5']
+
+    def initialize(key: nil, token_type: "URL", token_name: "hdnts",
+                   algorithm: "sha256", field_delimiter: "~", acl_delimiter: "!")
+
+      raise EdgeAuthError, "no key provided" if key.nil? || key.length < 1
+      raise EdgeAuthError, "algorithm must be one of 'sha256', 'sha1' or 'md5'" unless ALLOWED_ALGORITHM.include? algorithm
+
+      @key = key
+      @token_type = token_type
+      @token_name = token_name
+      @algorithm = algorithm
+      @field_delimiter = field_delimiter
+      @acl_delimiter = acl_delimiter
+    end
+
+    def generate_token(start_time: "now", end_time: nil, window_seconds: nil,
+                       acl: nil, url: nil)
+      raise EdgeAuthError, "no end_time or window_seconds is provided" if end_time.nil? && window_seconds.nil?
+      raise EdgeAuthError, "you must provide an ACL or a URL." if (acl.nil? && url.nil?) || (acl && url)
+
+      if start_time.to_s.downcase == "now"
+        start_time = Time.now.getgm.to_i
+      else
+        begin
+          start_time = 0 if start_time < 0
+        rescue
+          raise EdgeAuthError, "start_time must be UNIX timestamps or 'now'"
+        end
+      end
+
+      if end_time
+        begin
+          end_time = 0 if end_time < 0
+        rescue
+          raise EdgeAuthError, "end_time must be UNIX timestamps."
+        end
+      end
+
+      if window_seconds
+        begin
+          end_time = start_time + window_seconds
+        rescue
+          raise EdgeAuthError, "window_seconds must be numeric."
+        end
+      end
+
+      if end_time <= start_time
+        raise EdgeAuthError, "token will have already expired."
+      end
+
+      new_token = Array.new
+
+      new_token.push "st=#{start_time}"
+      new_token.push "exp=#{end_time}"
+
+      new_token.push "acl=#{acl}" unless acl.nil?
+      new_token.push "url=#{url}" unless url.nil?
+
+      hash_code = new_token.clone
+
+      bin_key = Array(key.gsub(/\s/,'')).pack("H*")
+      digest = OpenSSL::Digest.new(algorithm)
+      token_hmac = OpenSSL::HMAC.new(bin_key, digest)
+      token_hmac.update(hash_code.join(field_delimiter))
+
+      new_token.push "hmac=#{token_hmac}"
+
+      "#{@token_name}=#{new_token.join(@field_delimiter)}"
+    end
+
+    def escape_early(string)
+      CGI::escape(string).gsub(/(%..)/) {$1.downcase}
+    end
+  end
+
+  class EdgeAuthError < StandardError
+    def initialize(msg = "StandardError")
+      super
+    end
+  end
+end

data/lib/akamai/edge_auth/version.rb

@@ -0,0 +1,5 @@
+module Akamai
+  class EdgeAuth
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: akamai-edge_auth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sukoreno Mukti
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Akamai EdgeAuth token generator for TokenAuth setting in Media Live Streaming
+  Packaging or Segmented Media Protection
+email:
+- sukorenomw@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- edge_auth.gemspec
+- lib/akamai/edge_auth.rb
+- lib/akamai/edge_auth/version.rb
+homepage: https://github.com/sukorenomw/akamai_edge_auth
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Akamai EdgeAuth token generator
+test_files: []