wowza-secure_token 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 804f53ee8a6cd95adeefe35257bd1d6a1373e517
+  data.tar.gz: 73c27aa164cc42269750442ecc77d579603ba717
+SHA512:
+  metadata.gz: a2c182e127be7708a249313a8f4a0461a66231ec89ed3c149efbc0407447315fd18b1e109fbf00c0cd675fed2ca373c97984aefcee105234ee7a0b3471796ed2
+  data.tar.gz: 50839716fffb893020c0912791002e38f4be14953f99eef56a167c309477e77f173ebcb4d14df43a259cd0c5ad2f58a2acc5988e60d344ff5971820f1f743d54

data/LICENSE

@@ -0,0 +1,14 @@
+Copyright 2018 Trustees of Columbia University
+Additional copyright may be held by others, as reflected in CONTRIBUTORS or the commit history.
+
+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,3 @@
+#Wowza::SecureToken
+
+Calculating a secure token prefix for Wowza streaming from parameters.

data/lib/wowza.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# docs TBD
+module Wowza
+  require 'wowza/secure_token'
+end

data/lib/wowza/secure_token.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'digest'
+require 'base64'
+
+module Wowza
+  # docs TBD
+  module SecureToken
+    require 'wowza/secure_token/version'
+    # Wraps a params hash in the sorting and hashing logic necessary
+    # to generate a Wowza secure token
+    class Params
+      # Create the wrapper
+      # required symbol keys for:
+      # - stream
+      # - secret
+      # - client_ip
+      # - prefix
+      # - starttime (Integer)
+      # - endtime (Integer)
+      # - playstart (Integer)
+      # - playduration (Integer)
+      # @param opts [Hash] options used to generate a token url
+      def initialize(opts)
+        @prefix = opts.delete(:prefix)
+        @stream = opts.delete(:stream)
+        @client_ip = opts.delete(:client_ip)
+        @secret = opts.delete(:secret)
+        @params = opts
+      end
+
+      # @return the sorted token string for the wrapped params
+      def to_token
+        query_string = params_to_sorted_query_string(prefix_params(@params).merge(@client_ip => nil, @secret => nil))
+        "#{@stream}?#{query_string}"
+      end
+
+      # @param digest_alg the digest algorithm to be used to hash the params
+      # @return a URL-safe B64 encoded hash
+      def to_token_hash(digest_alg = Digest::SHA256)
+        Base64.urlsafe_encode64(digest_alg.digest(to_token))
+      end
+
+      def to_url_with_token_hash(host, port, stream_type)
+        query_string = params_to_sorted_query_string(prefix_params(@params))
+        case stream_type
+        when 'hls', 'hls-ssl'
+          (stream_type == 'hls' ? 'http' : 'https') + "://#{host}:#{port}/#{@stream}/playlist.m3u8?#{query_string}&#{@prefix}hash=#{self.to_token_hash}"
+        when 'mpeg-dash', 'mpeg-dash-ssl'
+          (stream_type == 'mpeg-dash' ? 'http' : 'https') + "://#{host}:#{port}/#{@stream}/manifest.mpd?#{query_string}&#{@prefix}hash=#{self.to_token_hash}"
+        when 'rtmp', 'rtmps'
+          "#{stream_type}://#{host}:#{port}/#{@stream}?#{query_string}&#{@prefix}hash=#{self.to_token_hash}"
+        else
+          raise "Unsupported stream_type: #{stream_type}"
+        end
+      end
+
+      private
+
+      def params_to_sorted_query_string(prms)
+        prms.sort.map { |p| p[1].to_s == '' ? p[0] : "#{p[0]}=#{p[1]}" }.join('&')
+      end
+
+      def prefix_params(hsh)
+        hsh = hsh.clone
+        hsh.map { |p| ["#{@prefix}#{p[0]}", p[1]] }.to_h
+      end
+    end
+  end
+end

data/lib/wowza/secure_token/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Wowza
+  module SecureToken
+    VERSION = '0.0.1'
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: wowza-secure_token
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Armintor
+- Eric O'Hanlon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.58.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.58.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.20.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.20.1
+description: Generate secure token prefix for wowza requests and allow configurable
+  defaults (e.g., secret).
+email: armintor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/wowza.rb
+- lib/wowza/secure_token.rb
+- lib/wowza/secure_token/version.rb
+homepage: https://github.com/cul/wowza-secure_token
+licenses:
+- APACHE2
+metadata: {}
+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.14
+signing_key: 
+specification_version: 4
+summary: Generate secure token prefix for wowza requests.
+test_files: []