vidyo 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ae817738c64a85fac69a735ee08493efe175e1f
+  data.tar.gz: 2f90f19e44635425dfd0095138d19c4e06b383e2
+SHA512:
+  metadata.gz: b9ff996aefcb2a153009bc50db201bdb5c163c2435e7bcf92e900026da238b0f309fb8e3c8008f33b4addebc036355c8942d6eb893b05ac7d605083ac95da086
+  data.tar.gz: e5fdcdadac415f0856263ff4f6ae361a135888ba8450dfb98f9db1a20cc6e87c587b500a52f9853bda67e169ce0a0d8a0cf91460c8df7d1dcd2af8579c611537

data/.gitignore

@@ -0,0 +1,2 @@
+.vscode
+ext/node_modules/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/omarish/vidyo" }
+
+ruby '2.3.1'

data/Gemfile.lock

@@ -0,0 +1,14 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+
+RUBY VERSION
+   ruby 2.3.1p112
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Omar Bohsali
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# vidyo-ruby
+
+Create authentication tokens for [vidyo][1] sessions in Ruby. I found token generation code in javascript, C#, and Python, but could not find anything for Ruby.
+
+Learn more about the Vidyo API here: [Vidyo API Docs][2].
+
+## Install
+
+```bash
+$ bundle
+```
+
+## Usage
+
+```ruby
+token = Vidyo::Token.new(
+  key: 'your_vidyo_developer_key',
+  application_id: 'vidyo_application_id',
+  user_name: 'the user joining the session',
+  expires_in: 3600
+)
+token.serialize
+```
+
+## Tests
+
+```bash
+$ rspec
+```
+
+## Based On
+
+* https://github.com/Vidyo/generateToken-c-sharp
+* https://static.vidyo.io/4.1.17.5/utils/generateToken.py
+
+
+[1]: http://vidyo.io "Vidyo Homepage"
+[2]: https://developer.vidyo.io/documentation/4-1-17-5/getting-started "Vidyo API Docs"

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 "vidyo"
+
+# 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/ext/generateToken.js

@@ -0,0 +1,123 @@
+//This is a nodejs script, and requires the following npm packages to run:
+//jssha, btoa and command-line-args
+
+//WARNING - Token generation should NEVER be done client side (in a browser for
+//example), because then you are exposing your developer key to customers
+/*jshint esversion: 6 */
+
+jsSHA = require('jssha');
+btoa = require('btoa');
+fs = require('fs');
+const commandLineArgs = require('command-line-args');
+var tokenGenerated = false;
+var vCardFileSpecified = false;
+
+const optionDefinitions = [{
+    name: 'key',
+    type: String
+}, {
+    name: 'appID',
+    type: String
+}, {
+    name: 'userName',
+    type: String
+}, {
+    name: 'vCardFile',
+    type: String
+}, {
+    name: 'expiresInSecs',
+    type: Number
+}, {
+    name: 'expiresAt',
+    type: String,
+    multiple: true
+}, {
+    name: 'help',
+    alias: 'h',
+    type: String
+}];
+
+const options = commandLineArgs(optionDefinitions);
+
+function printHelp() {
+    console.log("\nThis script will generate a provision login token from a developer key" +
+        "\nOptions:" +
+        "\n\t--key           Developer key supplied with the developer account" +
+        "\n\t--appID         ApplicationID supplied with the developer account" +
+        "\n\t--userName      Username to generate a token for" +
+        "\n\t--vCardFile     Path to the XML file containing a vCard for the user" +
+        "\n\t--expiresInSecs Number of seconds the token will be valid can be used instead of expiresAt" +
+        "\n\t--expiresAt     Time at which the token will expire ex: (2055-10-27T10:54:22Z) can be used instead of expiresInSecs" +
+        "\n");
+    process.exit();
+}
+
+if ((typeof options.help !== 'undefined') || (typeof options.key == 'undefined') || (typeof options.appID == 'undefined') || (typeof options.userName == 'undefined')) {
+    printHelp();
+}
+
+if (typeof options.vCardFile !== 'undefined') {
+    vCardFileSpecified = true;
+}
+
+function checkForVCardFileAndGenerateToken(key, appID, userName, expiresInSeconds) {
+    if (vCardFileSpecified) {
+        fs.readFile(options.vCardFile, 'utf8', function(err, data) {
+            if (err) {
+                return console.log("error reading vCard file " + err);
+            }
+            console.log("read in the fillowing vCard: " + data);
+            generateToken(key, appID, userName, expiresInSeconds, data);
+        });
+    } else {
+        generateToken(key, appID, userName, expiresInSeconds, "");
+    }
+}
+
+function generateToken(key, appID, userName, expiresInSeconds, vCard) {
+    var EPOCH_SECONDS = 62167219200;
+    var expires = Math.floor(Date.now() / 1000) + expiresInSeconds + EPOCH_SECONDS;
+    var shaObj = new jsSHA("SHA-384", "TEXT");
+    shaObj.setHMACKey(key, "TEXT");
+    jid = userName + '@' + appID;
+    var body = 'provision' + '\x00' + jid + '\x00' + expires + '\x00' + vCard;
+    shaObj.update(body);
+    var mac = shaObj.getHMAC("HEX");
+    var serialized = body + '\0' + mac;
+    console.log("\nGenerated Token: \n" + btoa(serialized));
+}
+
+//Date is in the format: "October 13, 2014 11:13:00"
+function generateTokenExpiresOnDate(key, appID, userName, date) {
+    var currentDate = new Date(date);
+    var dateInSeconds = Math.floor(currentDate.valueOf() / 1000);
+    var nowInSeconds = Math.floor(Date.now() / 1000);
+    if (dateInSeconds < nowInSeconds) {
+        console.log("Date is before current time, so token will be invalid");
+        expiresInSeconds = 0;
+    } else {
+        expiresInSeconds = dateInSeconds - nowInSeconds;
+        console.log("Expires in seconds: " + expiresInSeconds);
+    }
+    checkForVCardFileAndGenerateToken(key, appID, userName, expiresInSeconds);
+}
+
+console.log("\nGenerating token with the following inputs");
+console.log("Key: " + options.key);
+console.log("appID: " + options.appID);
+console.log("userName: " + options.userName);
+
+if (typeof options.vCardFile !== 'undefined') {
+    console.log("vCardFile: " + options.vCardFile);
+}
+
+if (typeof options.expiresInSecs !== 'undefined') {
+    console.log("expiresInSecs: " + options.expiresInSecs);
+    checkForVCardFileAndGenerateToken(options.key, options.appID, options.userName, options.expiresInSecs);
+
+} else if (typeof options.expiresAt !== 'undefined') {
+    console.log("expiresAt: " + options.expiresAt);
+    generateTokenExpiresOnDate(options.key, options.appID, options.userName, options.expiresAt);
+} else {
+    console.log("Error: Neither expiresInSecs or expiresAt parameters passed in");
+}

data/ext/generateToken.py

@@ -0,0 +1,176 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+import base64
+import binascii
+from datetime import datetime
+import calendar, time
+import hashlib
+import hmac
+import sys
+import getopt
+
+try:
+    from datetime import timezone
+    utc = timezone.utc
+except:
+    # python 2 variant
+    from datetime import timedelta, tzinfo
+    class UTC(tzinfo):
+        ZERO = timedelta(0)
+        """UTC"""
+
+        def utcoffset(self, dt):
+            return self.ZERO
+
+        def tzname(self, dt):
+            return "UTC"
+
+        def dst(self, dt):
+            return self.ZERO
+
+    utc = UTC()
+
+
+def read_file(path):
+    try:
+        f = open(path, "r+b")
+        return f.read()
+    except e:
+        print("Could not read file: %s error %s  ", path, e)
+        exit(3)
+
+def to_bytes(o):
+    return str(o).encode("utf-8")
+
+class Token:
+    def __init__(self, key, appID, userName, vCardFile, expires):
+        self.type    = 'provision'
+        self.key     = key
+        self.jid     = userName + "@" + appID
+        if (vCardFile):
+            self.vCard   = read_file(vCardFile).decode("utf-8").strip()
+        else:
+            self.vCard   = ""
+        self.expires = expires
+
+    def __str__(self):
+        return "Token" + {'type'    : self.type,
+                          'key'     : self.key,
+                          'jid'     : self.jid,
+                          'vCard'   : self.vCard[:10] + "...",
+                          'expires' : self.expires}.__str__()
+
+    def serialize(self):
+        sep = b"\0" # Separator is a NULL character
+        body = to_bytes(self.type) + sep + to_bytes(self.jid) + sep + to_bytes(self.expires) + sep + to_bytes(self.vCard)
+
+        mac = hmac.new(bytearray(self.key, 'utf8'), msg=body, digestmod=hashlib.sha384).digest()
+        ## Uncomment to debug
+        
+        sys.stderr.buffer.write( b"key : " + base64.b64encode(bytearray(self.key, 'utf8')) + b"\n" )
+        
+        print("bodyFull: " + self.type + "_" + self.jid + "_" + str(self.expires) + "_" + self.vCard);
+        
+        sys.stderr.buffer.write(b"bodyString: " + ("%s_%s_%s_%s" % (self.type, self.jid, str(self.expires), self.vCard)).encode("utf-8") + b"\n");
+        
+        sys.stderr.buffer.write( b"body: " + ("%s" % [b for b in body]).encode("utf-8") + b"\n" )
+        
+        sys.stderr.buffer.write( b"mac : " + base64.b64encode(mac) + b"\n" )
+        
+        sys.stderr.flush()
+        ## Combine the body with the hex version of the mac
+        
+        serialized = body + sep + binascii.hexlify(mac)
+        return serialized
+
+def printHelp():
+    print("\nThis script will generate a provision login token from a developer key"
+      "\nOptions:"
+      "\n\t--key           Developer key supplied with the developer account"
+      "\n\t--appID         ApplicationID supplied with the developer account"
+      "\n\t--userName      Username to generate a token for"
+      "\n\t--vCardFile     Path to the XML file containing a vCard for the user"
+      "\n\t--expiresInSecs Number of seconds the token will be valid can be used instead of expiresAt"
+      "\n\t--expiresAt     Time at which the token will expire ex: (2055-10-27T10:54:22Z) can be used instead of expiresInSecs"
+      "\n")
+
+try:
+  opts, args = getopt.getopt(sys.argv[1:], 'h', ['h', 'key=', 'appID=', 'userName=', 'vCardFile=', 'expiresInSecs=', 'expiresAt='])
+except getopt.GetoptError:
+    printHelp()
+    sys.exit(2)
+
+EPOCH_SECONDS = 62167219200
+key           = None
+appID         = None
+userName      = None
+vCardFile     = None
+expiresInSecs = None
+expiresAt     = None
+expires       = 0
+
+for o, a in opts:
+    if ((o == '-h') or (o == "--h")):
+        printHelp()
+        sys.exit(2)
+    if (o == "--key"):
+        print("Setting key           : ", a)
+        key = a
+    if (o == "--appID"):
+        print("Setting appID         : ", a)
+        appID = a
+    if (o == "--userName"):
+        print("Setting userName      : ", a)
+        userName = a
+    if (o == "--vCardFile"):
+        print("Setting vCardFile     : ", a)
+        vCardFile = a
+    if (o == "--expiresInSecs"):
+        print("Setting expiresInSecs : ", a)
+        expiresInSecs = a
+    if (o == "--expiresAt"):
+        print("Setting expiresAt     : ", a)
+        expiresAt = a
+
+if (key == None):
+    print("key not set")
+    printHelp()
+    sys.exit(2)
+if (appID == None):
+    print("appID not set")
+    printHelp()
+    sys.exit(2)
+if (userName == None):
+    print("userName not set")
+    printHelp()
+    sys.exit(2)
+if (vCardFile == None):
+    print("vCardFile not set")
+
+## datetime.timestamp() by default subtracts datetime(1970, 1, 1) from the datetime
+## on which we call it, therefore the number of seconds is smaller
+## by (pseudocode!) seconds("1970-01-01").
+## In Erlang, on the other hand, we get the actual number of seconds,
+## hence we adjust for this difference here.
+## IMPORTANT! A 64bit architecture is assumed! Otherwise, the timestamp
+## might be stored as a 32bit integer, therefore limiting the "capacity"
+## to 2038 (see https://en.wikipedia.org/wiki/Year_2038_problem).
+if (expiresInSecs != None):
+    d = datetime(year=2017, month=11, day=21, hour=11, minute=38, second=7).replace(tzinfo=utc)
+    expires = EPOCH_SECONDS + int(time.mktime(d.timetuple())) + int(expiresInSecs)
+elif (expiresAt != None):
+    d = datetime.strptime(expiresAt, '%Y-%m-%dT%H:%M:%SZ')
+    d = d.replace(tzinfo=utc)
+    expires = EPOCH_SECONDS + int(calendar.timegm(d.timetuple()))
+else:
+    print("expiresInSecs or expiresAt not set")
+    printHelp()
+    sys.exit(2)
+
+
+print("Generating Token...")
+token = Token(key, appID, userName, vCardFile, expires)
+serialized = token.serialize()
+b64 = base64.b64encode(serialized)
+print(b64.decode())

data/lib/vidyo.rb

@@ -0,0 +1,5 @@
+require "vidyo/version"
+require "vidyo/token"
+
+module Vidyo
+end

data/lib/vidyo/token.rb

@@ -0,0 +1,57 @@
+#coding: UTF-8
+require 'digest'
+require 'openssl'
+require 'base64'
+
+def to_bytes(x)
+  x.force_encoding('utf-8').unpack("C*")
+end
+
+module Vidyo
+  class Token
+    def initialize(key:, application_id:, user_name:, expires_in:)
+      @key = key
+      @application_id = application_id
+      @user_name = user_name
+      @expires_in = expires_in
+    end
+
+    def epoch_seconds
+      # Converts 1970-01-01 to seconds since 0 AD.
+      62167219200
+    end
+
+    def expires_at
+      epoch_seconds + Time.now.gmtime.to_i + @expires_in
+    end
+
+    def jid
+      "#{@user_name}@#{@application_id}"
+    end
+
+    def separator
+      [0]
+    end
+
+    def request_type
+      "provision"
+    end
+
+    def body
+      to_bytes(request_type) + separator + to_bytes(jid) + separator + to_bytes(expires_at.to_s) + separator
+    end
+
+    def mac
+      sha384 = OpenSSL::HMAC.new(@key, OpenSSL::Digest.new('sha384'))
+      sha384.update(body.pack("C*"))
+    end
+
+    def unserialized
+      (body + separator).pack("C*") + mac.hexdigest
+    end
+
+    def serialize
+      Base64.strict_encode64(unserialized)
+    end
+  end
+end

data/lib/vidyo/version.rb

@@ -0,0 +1,3 @@
+module Vidyo
+  VERSION = "1.0"
+end

data/vidyo.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "vidyo/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "vidyo"
+  spec.version       = Vidyo::VERSION
+  spec.authors       = ["Omar Bohsali"]
+  spec.email         = ["me@omarish.com"]
+
+  spec.summary       = %q{Create vidyo.io access tokens.}
+  spec.homepage      = "https://github.com/omarish/vidyo"
+  spec.license       = "MIT"
+  spec.metadata = {
+    "documentation_uri" => "https://github.com/omarish/vidyo",
+    "homepage_uri"      => "https://github.com/omarish/vidyo",
+    "source_code_uri"   => "https://github.com/omarish/vidyo"
+  }
+  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.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'rspec-expectations', '~> 3.7', '>= 3.7.0'
+  spec.add_development_dependency "timecop", "~> 0.9.1"
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: vidyo
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Omar Bohsali
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+description: 
+email:
+- me@omarish.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ext/generateToken.js
+- ext/generateToken.py
+- lib/vidyo.rb
+- lib/vidyo/token.rb
+- lib/vidyo/version.rb
+- vidyo.gemspec
+homepage: https://github.com/omarish/vidyo
+licenses:
+- MIT
+metadata:
+  documentation_uri: https://github.com/omarish/vidyo
+  homepage_uri: https://github.com/omarish/vidyo
+  source_code_uri: https://github.com/omarish/vidyo
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Create vidyo.io access tokens.
+test_files: []